Merge pull request #117 from ivebe/sanitize-class-name

Sanitize class name

Closes #116

.gitignore

@@ -2,6 +2,7 @@
 .DS_Store
 /vendor
 /composer.lock
+.phpunit.result.cache
 # exclude everything
 resources/views/templates/*
 resources/views/draft/*

src/MailEclipse.php

@@ -419,7 +419,14 @@ public static function getMailableTemplateData($mailableName)
 
     public static function generateMailable($request = null)
     {
-        $name = ucwords(Str::camel(preg_replace('/\s+/', '_', $request->input('name'))));
+        $name = self::generateClassName($request->input('name'));
+
+        if ($name === false) {
+            return response()->json([
+                'status' => 'error',
+                'message' => 'Wrong name format.',
+            ]);
+        }
 
         if (! self::getMailable('name', $name)->isEmpty() && ! $request->has('force')) {
             // return redirect()->route('createMailable')->with('error', 'mailable already exists! to overide it enable force option.');
@@ -827,4 +834,41 @@ public static function renderPreview($simpleview, $view, $template = false, $ins
             return $error;
         }
     }
+
+    /**
+     * Class name has to satisfy those rules.
+     *
+     * https://www.php.net/manual/en/language.oop5.basic.php#language.oop5.basic.class
+     * https://www.php.net/manual/en/reserved.keywords.php
+     *
+     * @param $input
+     * @return string|false class name or false on failure
+     */
+    public static function generateClassName($input)
+    {
+        $suffix = 'Mail';
+
+        if (strtolower($input) === strtolower($suffix)) {
+            return false;
+        }
+
+        // Avoid MailMail as a class name suffix
+        if (substr_compare(strtolower($input), 'mail', -4) === 0) {
+            $suffix = '';
+        }
+
+        /**
+         * - Suffix is needed to avoid usage of reserved word.
+         * - Str::slug will remove all forbidden characters.
+         */
+        $name = ucwords(Str::camel(Str::slug($input, '_'))).$suffix;
+
+        if (! preg_match('/^[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*$/', $name) ||
+            substr_compare($name, $suffix, -strlen($suffix), strlen($suffix), true) !== 0
+        ) {
+            return false;
+        }
+
+        return $name;
+    }
 }

tests/Unit/ClassNameTest.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Tests\Unit;
+
+use PHPUnit\Framework\TestCase;
+use Qoraiche\MailEclipse\MailEclipse;
+
+class ClassNameTest extends TestCase
+{
+    public function testValidClassName()
+    {
+        $expectedMap = [
+            'mail' => false,
+            '1 Number' => false,
+            'Number 1' => 'Number1Mail',
+            'Welcome #1 User' => 'Welcome1UserMail',
+            'Welcome User' => 'WelcomeUserMail',
+            'null' => 'NullMail',
+            '_null' => 'NullMail',
+            '#null' => 'NullMail',
+            'CustomerMail' => 'Customermail',
+            'Customermail' => 'Customermail',
+            'Customer Mail' => 'CustomerMail',
+            'customer mail' => 'CustomerMail',
+        ];
+
+        foreach ($expectedMap as $input => $expected) {
+            $className = MailEclipse::generateClassName($input);
+            $this->assertEquals($expected, $className);
+        }
+    }
+}