Merge pull request #12 from kirschbaum-development/testing

Testing

.gitignore

@@ -4,5 +4,6 @@ composer.phar
 composer.lock
 phpunit.xml
 .phpunit.result.cache
+.phpunit.cache
 .DS_Store
-Thumbs.db
+Thumbs.db

composer.json

@@ -18,18 +18,27 @@
     "require": {
         "php": "^8.1",
         "illuminate/filesystem": ">=10.0",
-        "illuminate/support": ">=10.0"
+        "illuminate/support": ">=10.0",
+        "symfony/filesystem": "^7.1"
     },
     "require-dev": {
         "laravel/framework": ">=10.0",
-        "laravel/pint": "^1.18"
+        "laravel/pint": "^1.18",
+        "orchestra/testbench": "^9.5",
+        "pestphp/pest": "^3.2",
+        "pestphp/pest-plugin-laravel": "^3.0"
     },
-    "autoload": {
+    "autoload-dev": {
         "psr-4": {
-            "Kirschbaum\\Paragon\\": "src/"
+            "App\\": "vendor/orchestra/testbench-core/laravel/app",
+            "Kirschbaum\\Paragon\\": "src/",
+            "Kirschbaum\\Paragon\\Tests\\": "tests"
         }
     },
     "scripts": {
+        "pest": [
+            "./vendor/bin/pest"
+        ],
         "pint": [
             "./vendor/bin/pint"
         ],
@@ -38,7 +47,10 @@
         ]
     },
     "config": {
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "pestphp/pest-plugin": true
+        }
     },
     "minimum-stability": "dev",
     "prefer-stable": true,

config/paragon.php

@@ -5,7 +5,8 @@
         'abstract-class' => 'Enum',
 
         'paths' => [
-            'php' => app_path(),
+            'php' => '',
+            'ignore' => [],
             'generated' => 'js/enums',
             'methods' => 'js/vendors/paragon/enums',
         ],

src/Commands/GenerateEnumsCommand.php

@@ -3,10 +3,14 @@
 namespace Kirschbaum\Paragon\Commands;
 
 use Illuminate\Console\Command;
+use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
+use Illuminate\Support\Str;
 use Kirschbaum\Paragon\Concerns\DiscoverEnums;
+use Kirschbaum\Paragon\Concerns\IgnoreParagon;
 use Kirschbaum\Paragon\Generators\AbstractEnumGenerator;
 use Kirschbaum\Paragon\Generators\EnumGenerator;
+use ReflectionEnum;
 use Symfony\Component\Console\Attribute\AsCommand;
 
 #[AsCommand(name: 'paragon:generate-enums', description: 'Generate Typescript versions of existing PHP enums')]
@@ -35,7 +39,17 @@ public function handle(): int
      */
     protected function enums(): Collection
     {
-        return DiscoverEnums::within(config('paragon.enums.paths.php'))
+        return DiscoverEnums::within(app_path(config('paragon.enums.paths.php')))
+            ->reject(function ($enum) {
+                $reflector = new ReflectionEnum($enum);
+
+                $paths = Arr::map(Arr::wrap(config('paragon.enums.paths.ignore')), function ($path) {
+                    return Str::finish(app_path($path), '/');
+                });
+
+                return $reflector->getAttributes(IgnoreParagon::class)
+                    || Str::startsWith($reflector->getFileName(), $paths);
+            })
             ->values();
     }
 }

src/Commands/MakeEnumMethodCommand.php

@@ -14,14 +14,6 @@
 #[AsCommand(name: 'paragon:enum-method', description: 'Create a new typescript enum method')]
 class MakeEnumMethodCommand extends GeneratorCommand
 {
-    /**
-     * Get the stub file for the generator.
-     */
-    protected function getStub(): string
-    {
-        return __DIR__ . '/../../stubs/method.stub';
-    }
-
     /**
      * Execute the console command.
      *
@@ -39,6 +31,14 @@ public function handle(): int
         return self::SUCCESS;
     }
 
+    /**
+     * Get the stub file for the generator.
+     */
+    protected function getStub(): string
+    {
+        return __DIR__ . '/../../stubs/method.stub';
+    }
+
     /**
      * Get the console command arguments.
      */

src/Concerns/IgnoreParagon.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Kirschbaum\Paragon\Concerns;
+
+use Attribute;
+
+#[Attribute(Attribute::TARGET_CLASS | Attribute::TARGET_METHOD)]
+class IgnoreParagon {}

src/Generators/AbstractEnumGenerator.php

@@ -5,6 +5,7 @@
 use Illuminate\Contracts\Filesystem\Filesystem;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Storage;
+use Symfony\Component\Filesystem\Filesystem as FileUtility;
 use Symfony\Component\Finder\Exception\DirectoryNotFoundException;
 use Symfony\Component\Finder\Finder;
 
@@ -41,7 +42,7 @@ protected function contents(): string
     /**
      * Get the path to the stubs.
      */
-    public function stubPath(): string
+    protected function stubPath(): string
     {
         return __DIR__ . '/../../stubs/abstract-enum.stub';
     }
@@ -61,19 +62,16 @@ protected function imports(): Collection
 
         return collect($files)
             ->mapWithKeys(function ($file) {
-                $abstractPath = collect(explode('/', config('paragon.enums.paths.generated')));
-                $relativeFilePath = str($file->getPath())
-                    ->after(resource_path())
-                    ->replace('\\', '/')
-                    ->ltrim('/')
-                    ->explode('/')
-                    ->map(fn ($directory, $index) => data_get($abstractPath, $index) === $directory ? '..' : $directory)
-                    ->filter()
-                    ->join('/');
+                $filesystem = new FileUtility();
+
+                $relativeFilePath = $filesystem->makePathRelative(
+                    $file->getPath(),
+                    resource_path(config('paragon.enums.paths.generated'))
+                );
 
                 $name = (string) str($file->getFileName())->before('.');
 
-                return [$name => "import {$name} from '{$relativeFilePath}/{$file->getFilename()}';" . PHP_EOL];
+                return [$name => "import {$name} from '{$relativeFilePath}{$file->getFilename()}';" . PHP_EOL];
             })
             ->sort();
     }

src/Generators/EnumGenerator.php

@@ -7,7 +7,7 @@
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Storage;
 use Illuminate\Support\Fluent;
-use Kirschbaum\Paragon\Concerns\IgnoreWhenGeneratingTypescript;
+use Kirschbaum\Paragon\Concerns\IgnoreParagon;
 use ReflectionEnum;
 use ReflectionException;
 use ReflectionMethod;
@@ -75,7 +75,7 @@ protected function contents(): string
     /**
      * Get the path to the stubs.
      */
-    public function stubPath(): string
+    protected function stubPath(): string
     {
         return __DIR__ . '/../../stubs/enum.stub';
     }
@@ -129,7 +129,7 @@ protected function methods(): Collection
     {
         return collect($this->reflector->getMethods(ReflectionMethod::IS_PUBLIC))
             ->reject(function (ReflectionMethod $method) {
-                return $method->isStatic() || $method->getAttributes(IgnoreWhenGeneratingTypescript::class);
+                return $method->isStatic() || $method->getAttributes(IgnoreParagon::class);
             })
             ->sortBy(fn (ReflectionMethod $method) => $method->getName());
     }

tests/Architecture/AttributesTest.php

@@ -0,0 +1,9 @@
+<?php
+
+use Kirschbaum\Paragon\Concerns\IgnoreParagon;
+
+arch()->expect(IgnoreParagon::class)
+    ->toExtendNothing();
+
+arch()->expect(IgnoreParagon::class)
+    ->toHaveAttribute(Attribute::class);

tests/Architecture/CommandsTest.php

@@ -0,0 +1,16 @@
+<?php
+
+use Symfony\Component\Console\Attribute\AsCommand;
+
+arch()->expect('Kirschbaum\Paragon\Commands')
+    ->classes()
+    ->toHaveSuffix('Command');
+
+arch()->expect('Kirschbaum\Paragon\Commands')
+    ->toHaveAttribute(AsCommand::class);
+
+arch()->expect('Kirschbaum\Paragon\Commands')
+    ->not->toHavePrivateMethodsBesides(['__construct', 'handle']);
+
+arch()->expect('Kirschbaum\Paragon\Commands')
+    ->not->toHavePublicMethodsBesides(['__construct', 'handle']);

tests/Architecture/DiscoveryTest.php

@@ -0,0 +1,12 @@
+<?php
+
+use Kirschbaum\Paragon\Concerns\DiscoverEnums;
+
+arch()->expect(DiscoverEnums::class)
+    ->toExtendNothing();
+
+arch()->expect(DiscoverEnums::class)
+    ->not->toHavePrivateMethodsBesides(['within']);
+
+arch()->expect(DiscoverEnums::class)
+    ->not->toHavePublicMethodsBesides(['within']);

tests/Architecture/GeneratorsTest.php

@@ -0,0 +1,17 @@
+<?php
+
+arch()->expect('Kirschbaum\Paragon\Generators')
+    ->classes()
+    ->toHaveSuffix('Generator');
+
+arch()->expect('Kirschbaum\Paragon\Generators')
+    ->toExtendNothing();
+
+arch()->expect('Kirschbaum\Paragon\Generators')
+    ->toBeInvokable();
+
+arch()->expect('Kirschbaum\Paragon\Generators')
+    ->not->toHavePrivateMethodsBesides(['__construct', '__invoke']);
+
+arch()->expect('Kirschbaum\Paragon\Generators')
+    ->not->toHavePublicMethodsBesides(['__construct', '__invoke']);

tests/Architecture/PresetTest.php

@@ -0,0 +1,29 @@
+<?php
+
+arch()->preset()->php();
+
+// Security without the md5 method as we need it for caching.
+arch()
+    ->expect([
+        'array_rand',
+        'assert',
+        'create_function',
+        'dl',
+        'eval',
+        'exec',
+        'extract',
+        'mb_parse_str',
+        'mt_rand',
+        'parse_str',
+        'passthru',
+        'rand',
+        'sha1',
+        'shell_exec',
+        'shuffle',
+        'str_shuffle',
+        'system',
+        'tempnam',
+        'uniqid',
+        'unserialize',
+    ])
+    ->not->toBeUsed();

tests/Fixtures/Ignore.php

@@ -0,0 +1,11 @@
+<?php
+
+namespace App\Enums;
+
+use Kirschbaum\Paragon\Concerns\IgnoreParagon;
+
+#[IgnoreParagon]
+enum Ignore: string
+{
+    case Ignore = 'ignore';
+}

tests/Fixtures/Ignore/Ignore.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace App\Enums\Ignore;
+
+enum Ignore
+{
+    case Ignore;
+}

tests/Fixtures/IntegerBacked.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace App\Enums;
+
+enum IntegerBacked: int
+{
+    case Active = 1;
+    case Inactive = 0;
+
+    public function label(): string
+    {
+        return 'label';
+    }
+}

tests/Fixtures/Nested/Nested.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace App\Enums\Nested;
+
+enum Nested
+{
+    case Nested;
+}

tests/Fixtures/NonBacked.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace App\Enums;
+
+enum NonBacked
+{
+    case Active;
+    case Inactive;
+
+    public function label(): string
+    {
+        return 'label';
+    }
+}

tests/Fixtures/StringBacked.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace App\Enums;
+
+use Kirschbaum\Paragon\Concerns\IgnoreParagon;
+
+enum StringBacked: string
+{
+    case Active = 'active';
+    case Inactive = 'inactive';
+
+    public function label(): string
+    {
+        return 'label';
+    }
+
+    #[IgnoreParagon]
+    public function ignore(): string
+    {
+        return 'ignore';
+    }
+
+    public static function ignoreStatic(): string
+    {
+        return 'ignore';
+    }
+}

tests/Pest.php

@@ -0,0 +1,5 @@
+<?php
+
+use Kirschbaum\Paragon\Tests\TestCase;
+
+uses(TestCase::class)->in(__DIR__);