Merge pull request #13 from TheDragonCode/laravel-9

Laravel 9 support

Author: Andrey Helldar

.github/workflows/laravel-9.yml

@@ -0,0 +1,32 @@
+name: "Laravel 9"
+on: [ push ]
+
+jobs:
+    build:
+        runs-on: ubuntu-latest
+
+        strategy:
+            fail-fast: true
+            matrix:
+                php: [ "8.0", "8.1" ]
+                laravel: [ "9.0" ]
+
+        name: Laravel ${{ matrix.laravel }}, PHP ${{ matrix.php }}
+
+        steps:
+            -   name: Checkout code
+                uses: actions/checkout@v2
+
+            -   name: Setup PHP
+                uses: shivammathur/setup-php@v2
+                with:
+                    php-version: ${{ matrix.php }}
+                    extensions: curl, mbstring, zip, pcntl, pdo, pdo_sqlite, iconv
+                    coverage: none
+
+            -   name: Install dependencies
+                run: |
+                    composer require laravel/framework:^${{ matrix.laravel }}
+                    composer update --prefer-stable --prefer-dist --no-progress --no-interaction
+            -   name: Execute tests
+                run: sudo vendor/bin/phpunit

composer.json

@@ -25,16 +25,16 @@
     },
     "require": {
         "php": "^7.3 || ^8.0",
-        "dragon-code/contracts": "^2.9",
-        "illuminate/console": "^6.0 || ^7.0 || ^8.0",
-        "illuminate/database": "^6.0 || ^7.0 || ^8.0",
-        "illuminate/support": "^6.0 || ^7.0 || ^8.0",
-        "symfony/console": "^4.3 || ^5.0"
+        "dragon-code/contracts": "^2.15",
+        "dragon-code/laravel-support": "^3.2",
+        "illuminate/console": "^6.0 || ^7.0 || ^8.0 || ^9.0",
+        "illuminate/database": "^6.0 || ^7.0 || ^8.0 || ^9.0",
+        "illuminate/support": "^6.0 || ^7.0 || ^8.0 || ^9.0",
+        "symfony/console": "^4.3 || ^5.0 || ^6.0"
     },
     "require-dev": {
-        "dragon-code/laravel-support": "^3.1",
         "mockery/mockery": "^1.3.1",
-        "orchestra/testbench": "^4.0 || ^5.0 || ^6.0",
+        "orchestra/testbench": "^4.0 || ^5.0 || ^6.0 || ^7.0",
         "phpunit/phpunit": "^8.0 || ^9.0",
         "ramsey/uuid": "^3.7 || ^4.0"
     },

resources/stubs/action-9.x.stub

@@ -0,0 +1,25 @@
+<?php
+
+use DragonCode\LaravelActions\Support\Actionable;
+
+return new class extends Actionable {
+    /**
+     * Run the actions.
+     *
+     * @return void
+     */
+    public function up(): void
+    {
+        //
+    }
+
+    /**
+     * Reverse the actions.
+     *
+     * @return void
+     */
+    public function down(): void
+    {
+        //
+    }
+};

resources/stubs/action.stub renamed to resources/stubs/action-prev.stub

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DragonCode\LaravelActions\Concerns;
+
+use DragonCode\LaravelSupport\Facades\AppVersion;
+
+trait Versionable
+{
+    protected function isLatestApp(): bool
+    {
+        return AppVersion::is9x();
+    }
+
+    protected function isPrevApp(): bool
+    {
+        return ! $this->isLatestApp();
+    }
+}

src/Concerns/Versionable.php

@@ -2,6 +2,7 @@
 
 namespace DragonCode\LaravelActions\Support;
 
+use DragonCode\LaravelSupport\Facades\AppVersion;
 use Illuminate\Database\Migrations\MigrationCreator as BaseMigrationCreator;
 use Illuminate\Filesystem\Filesystem;
 
@@ -28,10 +29,12 @@ public function stubPath()
         return realpath($this->customStubPath);
     }
 
-    protected function getStub($table, $create)
+    protected function getStub($table, $create): string
     {
-        $stub = $this->stubPath() . '/action.stub';
+        $stub = AppVersion::is9x() ? '/action-9.x.stub' : '/action-prev.stub';
 
-        return $this->files->get($stub);
+        return $this->files->get(
+            $this->stubPath() . $stub
+        );
     }
 }

src/Support/MigrationCreator.php

@@ -4,13 +4,15 @@
 
 use DragonCode\Contracts\LaravelActions\Actionable as ActionableContract;
 use DragonCode\LaravelActions\Concerns\Infoable;
+use DragonCode\LaravelActions\Concerns\Versionable;
 use Illuminate\Database\Migrations\Migrator as BaseMigrator;
 use Illuminate\Support\Facades\DB;
 use Throwable;
 
 class Migrator extends BaseMigrator
 {
     use Infoable;
+    use Versionable;
 
     public function usingConnection($name, callable $callback)
     {
@@ -29,15 +31,23 @@ public function usingConnection($name, callable $callback)
      * @param  string  $file
      * @param  int  $batch
      * @param  bool  $pretend
+     *
+     * @throws \Throwable
      */
     protected function runUp($file, $batch, $pretend)
     {
         // First we will resolve a "real" instance of the migration class from this
         // migration file name. Once we have the instances we can run the actual
         // command such as "up" or "down", or we can just simulate the action.
-        $migration = $this->resolve(
-            $name = $this->getMigrationName($file)
-        );
+        if ($this->isLatestApp()) {
+            $migration = $this->resolvePath($file);
+
+            $name = $this->getMigrationName($file);
+        } else {
+            $migration = $this->resolve(
+                $name = $this->getMigrationName($file)
+            );
+        }
 
         if (! $this->allowEnvironment($migration)) {
             $this->note("<info>Migrate:</info>  {$name} was skipped on this environment");
@@ -80,9 +90,15 @@ protected function runUp($file, $batch, $pretend)
      */
     protected function runDown($file, $migration, $pretend)
     {
-        $instance = $this->resolve(
-            $name = $this->getMigrationName($file)
-        );
+        if ($this->isLatestApp()) {
+            $instance = $this->resolvePath($file);
+
+            $name = $this->getMigrationName($file);
+        } else {
+            $instance = $this->resolve(
+                $name = $this->getMigrationName($file)
+            );
+        }
 
         if (! $this->allowEnvironment($instance)) {
             $this->note("<info>Rolling back:</info>  {$name} was skipped on this environment");
@@ -119,23 +135,23 @@ protected function runMigration($migration, $method)
     /**
      * Whether it is necessary to record information about the execution in the database.
      *
-     * @param  object  $migration
+     * @param  \DragonCode\Contracts\LaravelActions\Actionable|object  $migration
      *
      * @return bool
      */
-    protected function allowLogging($migration): bool
+    protected function allowLogging(ActionableContract $migration): bool
     {
         return $migration->isOnce();
     }
 
     /**
      * Whether the action needs to be executed in the current environment.
      *
-     * @param  object  $migration
+     * @param  \DragonCode\Contracts\LaravelActions\Actionable|object  $migration
      *
      * @return bool
      */
-    protected function allowEnvironment($migration): bool
+    protected function allowEnvironment(ActionableContract $migration): bool
     {
         $environment = config('app.env', 'production');
 
@@ -165,7 +181,7 @@ protected function allowEnvironment($migration): bool
      *
      * @return bool
      */
-    protected function enabledTransactions($migration): bool
+    protected function enabledTransactions(ActionableContract $migration): bool
     {
         return $migration->enabledTransactions();
     }
@@ -177,7 +193,7 @@ protected function enabledTransactions($migration): bool
      *
      * @return int
      */
-    protected function transactionAttempts($migration): int
+    protected function transactionAttempts(ActionableContract $migration): int
     {
         $value = $migration->transactionAttempts();
 

src/Support/Migrator.php

@@ -13,7 +13,7 @@ public function testCreateAction()
 
         $filename = date('Y_m_d_His') . '_foo_example.php';
 
-        $path = database_path('actions/' . $filename);
+        $path = $this->targetDirectory($filename);
 
         $this->assertFileDoesNotExist($path);
 
@@ -22,8 +22,14 @@ public function testCreateAction()
         $this->assertFileExists($path);
     }
 
-    public function testAlreadyExists()
+    public function testDuplicateOnPrev()
     {
+        if ($this->isLatestApp()) {
+            $this->assertTrue(true);
+
+            return;
+        }
+
         $this->expectException(InvalidArgumentException::class);
         $this->expectExceptionMessage('A BarExample class already exists.');
 
@@ -32,4 +38,24 @@ public function testAlreadyExists()
         $this->artisan('make:migration:action', compact('name'))->run();
         $this->artisan('make:migration:action', compact('name'))->run();
     }
+
+    public function testDuplicateOnLatest()
+    {
+        if ($this->isPrevApp()) {
+            $this->assertTrue(true);
+
+            return;
+        }
+
+        $name = 'BarExample';
+
+        $time1 = date('Y_m_d_His');
+        $this->artisan('make:migration:action', compact('name'))->run();
+
+        $time2 = date('Y_m_d_His');
+        $this->artisan('make:migration:action', compact('name'))->run();
+
+        $this->assertFileExists($this->targetDirectory($time1 . '_bar_example.php'));
+        $this->assertFileExists($this->targetDirectory($time2 . '_bar_example.php'));
+    }
 }

tests/Commands/CreatorTest.php

@@ -2,6 +2,7 @@
 
 namespace Tests\Commands;
 
+use DragonCode\LaravelSupport\Facades\AppVersion;
 use Tests\TestCase;
 
 class MakeTest extends TestCase
@@ -20,9 +21,10 @@ public function testMakingFiles()
 
         $this->assertFileExists($path);
 
-        $this->assertEquals(
-            file_get_contents(__DIR__ . '/../fixtures/stubs/make_example.stub'),
-            file_get_contents($path)
-        );
+        $expected = AppVersion::is9x()
+            ? __DIR__ . '/../fixtures/app/9.x/stubs/make_example.stub'
+            : __DIR__ . '/../fixtures/app/prev/stubs/make_example.stub';
+
+        $this->assertEquals(file_get_contents($expected), file_get_contents($path));
     }
 }

tests/Commands/MakeTest.php

@@ -2,10 +2,14 @@
 
 namespace Tests\Concerns;
 
+use DragonCode\LaravelSupport\Facades\AppVersion;
+
 trait Actionable
 {
     protected function getMigrationPath(): string
     {
-        return __DIR__ . '/../fixtures/actions';
+        return AppVersion::is9x()
+            ? __DIR__ . '/../fixtures/app/9.x/actions'
+            : __DIR__ . '/../fixtures/app/prev/actions';
     }
 }