feat(L8): update resources to be compatible with L8 [WIP] (#32)

* feat(upgrade): add support for L8 * feat(upgrade): add support for L8 * feat(factories): update factory generator * Apply fixes from StyleCI (#31) * feat(routes): update routes generator * Apply fixes from StyleCI (#33) * feat(models): update models generator * Apply fixes from StyleCI (#34) * feat(seeds): update seeders generator * Apply fixes from StyleCI (#35) * feat(docs): update docs * Apply fixes from StyleCI (#36) * feat(config): update config seed path * fix: tests Co-authored-by: Tiago Sousa <[email protected]>
tiagomichaelsousa · Sep 29, 2020 · 965c4b7 · 965c4b7
1 parent 62155f4
commit 965c4b7
Show file tree

Hide file tree

Showing 13 changed files with 149 additions and 132 deletions.
diff --git a/README.md b/README.md
@@ -20,6 +20,13 @@
 
 Laravel Resources is a speed-up development package that allows you to create a boilerplate for Laravel apps with a default API structure.
 
+## Versions
+
+| Laravel | Laravel Resources |
+| ------- | ----------------- |
+| 7.x     | v1.7              |
+| 8.x     | v2.x              |
+
 ## Installation
 
 Via Composer
@@ -46,9 +53,9 @@ $ php artisan vendor:publish --provider="tiagomichaelsousa\LaravelResources\Lara
 
 **Notes:**
 
-- This package is fully configurable. You can change all the namespaces for the resources that will be created in the config file.
-- Don't forget to edit the request file in order to add your default validation for the model.
-- Don't forget to edit the policy file in order to fulfill your app business logic.
+-   This package is fully configurable. You can change all the namespaces for the resources that will be created in the config file.
+-   Don't forget to edit the request file in order to add your default validation for the model.
+-   Don't forget to edit the policy file in order to fulfill your app business logic.
 
 ## Change log
 
@@ -76,8 +83,8 @@ If you discover any security related issues, please email the [author](mailto:ti
 
 ## Credits
 
-- [@tiagomichaelsousa][link-author]
-- [All Contributors][link-contributors]
+-   [@tiagomichaelsousa][link-author]
+-   [All Contributors][link-contributors]
 
 ## License
 
@@ -116,6 +123,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 
 <!-- markdownlint-enable -->
 <!-- prettier-ignore-end -->
+
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
 This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
diff --git a/composer.json b/composer.json
@@ -1,56 +1,56 @@
 {
-  "name": "tiagomichaelsousa/laravelresources",
-  "description": "Laravel Resources is a speed-up development package that allows you to create a boilerplate for Laravel apps with a default API structure.",
-  "license": "MIT",
-  "authors": [
-    {
-      "name": "tiagomichaelsousa",
-      "email": "[email protected]",
-      "homepage": "https://github.com/tiagomichaelsousa",
-      "role": "Developer"
-    }
-  ],
-  "homepage": "https://github.com/tiagomichaelsousa/laravelresources",
-  "keywords": [
-    "Laravel",
-    "LaravelResources",
-    "laravelresources",
-    "laravel-resources"
-  ],
-  "require": {
-    "illuminate/support": "^7.0|^8.0"
-  },
-  "require-dev": {
-    "phpunit/phpunit": "^8.5|^9.0",
-    "mockery/mockery": "^1.3.1",
-    "orchestra/testbench": "^5.0|^6.0",
-    "sempro/phpunit-pretty-print": "^1.0"
-  },
-  "autoload": {
-    "files": [
-      "src/Helpers/helpers.php"
+    "name": "tiagomichaelsousa/laravelresources",
+    "description": "Laravel Resources is a speed-up development package that allows you to create a boilerplate for Laravel apps with a default API structure.",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "tiagomichaelsousa",
+            "email": "[email protected]",
+            "homepage": "https://github.com/tiagomichaelsousa",
+            "role": "Developer"
+        }
     ],
-    "psr-4": {
-      "tiagomichaelsousa\\LaravelResources\\": "src/"
-    }
-  },
-  "autoload-dev": {
-    "psr-4": {
-      "tiagomichaelsousa\\LaravelResources\\Tests\\": "tests"
-    }
-  },
-  "scripts": {
-    "test": "vendor/bin/phpunit",
-    "test-report": "vendor/bin/phpunit --coverage-html report"
-  },
-  "extra": {
-    "laravel": {
-      "providers": [
-        "tiagomichaelsousa\\LaravelResources\\LaravelResourcesServiceProvider"
-      ],
-      "aliases": {
-        "LaravelResources": "tiagomichaelsousa\\LaravelResources\\Facades\\LaravelResources"
-      }
+    "homepage": "https://github.com/tiagomichaelsousa/laravelresources",
+    "keywords": [
+        "Laravel",
+        "LaravelResources",
+        "laravelresources",
+        "laravel-resources"
+    ],
+    "require": {
+        "illuminate/support": "^7.0|^8.0"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^8.5|^9.0",
+        "mockery/mockery": "^1.3.1",
+        "orchestra/testbench": "^5.0|^6.0",
+        "sempro/phpunit-pretty-print": "^1.0"
+    },
+    "autoload": {
+        "files": [
+            "src/Helpers/helpers.php"
+        ],
+        "psr-4": {
+            "tiagomichaelsousa\\LaravelResources\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "tiagomichaelsousa\\LaravelResources\\Tests\\": "tests"
+        }
+    },
+    "scripts": {
+        "test": "vendor/bin/phpunit",
+        "test-report": "vendor/bin/phpunit --coverage-html report"
+    },
+    "extra": {
+        "laravel": {
+            "providers": [
+                "tiagomichaelsousa\\LaravelResources\\LaravelResourcesServiceProvider"
+            ],
+            "aliases": {
+                "LaravelResources": "tiagomichaelsousa\\LaravelResources\\Facades\\LaravelResources"
+            }
+        }
     }
-  }
 }
diff --git a/config/laravel-resources.php b/config/laravel-resources.php
@@ -87,7 +87,7 @@
     |
     */
     'models' => [
-        'namespace' => 'App',
+        'namespace' => 'App\Models',
     ],
 
     /*
@@ -116,6 +116,6 @@
     'database' => [
         'migrations' => 'database/migrations',
         'factories' => 'database/factories',
-        'seeds' => 'database/seeds',
+        'seeds' => 'database/seeders',
     ],
 ];
diff --git a/phpunit.xml b/phpunit.xml
@@ -1,22 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit bootstrap="vendor/autoload.php"
-         backupGlobals="false"
-         backupStaticAttributes="false"
-         colors="true"
-         verbose="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false">
-    <testsuites>
-        <testsuite name="Laravel Resources Test Suite">
-            <directory>tests/</directory>
-        </testsuite>
-    </testsuites>
-    <filter>
-        <whitelist>
-            <directory>src/</directory>
-        </whitelist>
-    </filter>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" backupStaticAttributes="false" colors="true" verbose="true" convertErrorsToExceptions="true" convertNoticesToExceptions="true" convertWarningsToExceptions="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
+  <coverage>
+    <include>
+      <directory>src/</directory>
+    </include>
+  </coverage>
+  <testsuites>
+    <testsuite name="Laravel Resources Test Suite">
+      <directory>tests/</directory>
+    </testsuite>
+  </testsuites>
 </phpunit>
diff --git a/src/Commands/ResourceCommand.php b/src/Commands/ResourceCommand.php
@@ -107,13 +107,13 @@ private function createResources()
 
         $bar->finish();
         $this->line('');
-        $this->line('');
-
-        exec('composer dumpautoload');
 
         $this->line('');
 
         $this->info('🚀 Resources created successfully 🚀');
+        $this->line('');
+
+        exec('composer dumpautoload');
     }
 
     /**

diff --git a/src/Generators/FactoryGenerator.php b/src/Generators/FactoryGenerator.php
@@ -26,6 +26,7 @@ public function replacements()
         return array_merge([
             '{{MODEL_NAMESPACE}}' => config('laravel-resources.models.namespace'),
             '{{MODEL_NAME}}' => $this->model,
+            '{{CLASS_NAME}}' => $this->className(),
         ]);
     }
 

diff --git a/src/Generators/RouteGenerator.php b/src/Generators/RouteGenerator.php
@@ -28,7 +28,7 @@ public function replacements()
         return array_merge([
             '{{MODEL_NAME}}' => $this->model,
             '{{MODEL_VARIABLE}}' => lcfirst($this->model),
-            '{{CONTROLLER_NAME}}' => create_class_name($this->model, 'ControllerGenerator'),
+            '{{CONTROLLER_NAME}}' => $this->generateControllerName(),
             '{{ROUTE_NAME}}' => Str::plural(Str::kebab($this->model)),
         ]);
     }
@@ -83,6 +83,21 @@ public function handle()
 
         $this->directoryExists($directory);
 
-        file_put_contents($path, [$stub, PHP_EOL], FILE_APPEND);
+        $controllerNamespace = config('laravel-resources.controllers.namespace');
+        $controllerImport = "use {$controllerNamespace}\\{$this->generateControllerName()}";
+        $content = str_replace("<?php\n", "<?php\n\n$controllerImport;", file_get_contents($path));
+        file_put_contents($path, $content);
+
+        file_put_contents($path, [$stub, PHP_EOL], FILE_APPEND | FILE_USE_INCLUDE_PATH);
+    }
+
+    /**
+     * Generates the controller name.
+     *
+     * @return string
+     */
+    private function generateControllerName()
+    {
+        return create_class_name($this->model, 'ControllerGenerator');
     }
 }
diff --git a/src/stubs/factories/factory.stub b/src/stubs/factories/factory.stub
@@ -1,23 +1,28 @@
 <?php
 
-/** @var \Illuminate\Database\Eloquent\Factory $factory */
+namespace Database\Factories;
 
 use {{MODEL_NAMESPACE}}\{{MODEL_NAME}};
-use Faker\Generator as Faker;
+use Illuminate\Database\Eloquent\Factories\Factory;
 
-/*
-|--------------------------------------------------------------------------
-| Model Factories
-|--------------------------------------------------------------------------
-|
-| This directory should contain each of the model factory definitions for
-| your application. Factories provide a convenient way to generate new
-| model instances for testing / seeding your application's database.
-|
-*/
+class {{CLASS_NAME}} extends Factory
+{
+    /**
+     * The name of the factory's corresponding model.
+     *
+     * @var string
+     */
+    protected $model = {{MODEL_NAME}}::class;
 
-$factory->define({{MODEL_NAME}}::class, function (Faker $faker) {
-    return [
-        'name' => $faker->name,
-    ];
-});
+    /**
+     * Define the model's default state.
+     *
+     * @return array
+     */
+    public function definition()
+    {
+        return [
+           'name' => $this->faker->name,
+        ];
+    }
+}
diff --git a/src/stubs/models/model.stub b/src/stubs/models/model.stub
@@ -3,9 +3,11 @@
 namespace {{NAMESPACE}};
 
 use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
 
 class {{CLASS_NAME}} extends Model
 {
+    use HasFactory;
 
     /**
      * The attributes that are mass assignable.

diff --git a/src/stubs/routes/api.routes.stub b/src/stubs/routes/api.routes.stub
@@ -4,9 +4,9 @@
 |--------------------------------------------------------------------------
  */
 Route::name('{{ROUTE_NAME}}.')->prefix('{{ROUTE_NAME}}')->group(function () {
-    Route::get('/', '{{CONTROLLER_NAME}}@index')->name('index');
-    Route::post('/', '{{CONTROLLER_NAME}}@store')->name('create');
-    Route::get('/{{{MODEL_VARIABLE}}}', '{{CONTROLLER_NAME}}@show')->name('show');
-    Route::patch('/{{{MODEL_VARIABLE}}}', '{{CONTROLLER_NAME}}@update')->name('update');
-    Route::delete('/{{{MODEL_VARIABLE}}}', '{{CONTROLLER_NAME}}@destroy')->name('destroy');
+    Route::get('/', [{{CONTROLLER_NAME}}::class, 'index'])->name('index');
+    Route::post('/', [{{CONTROLLER_NAME}}::class, 'store'])->name('create');
+    Route::get('/{{{MODEL_VARIABLE}}}', [{{CONTROLLER_NAME}}::class, 'show'])->name('show');
+    Route::patch('/{{{MODEL_VARIABLE}}}', [{{CONTROLLER_NAME}}::class, 'update'])->name('update');
+    Route::delete('/{{{MODEL_VARIABLE}}}', [{{CONTROLLER_NAME}}::class, 'destroy'])->name('destroy');
 });
diff --git a/src/stubs/seeds/seed.stub b/src/stubs/seeds/seed.stub
@@ -1,5 +1,7 @@
 <?php
 
+namespace Database\Seeders;
+
 use {{MODEL_NAMESPACE}}\{{MODEL_NAME}};
 use Illuminate\Database\Seeder;
 
@@ -22,7 +24,7 @@ class {{CLASS_NAME}} extends Seeder
         $bar = $this->command->getOutput()->createProgressBar($this->numberOf{{MODEL_PLURAL}});
 
         for ($i = 0; $i < $this->numberOf{{MODEL_PLURAL}}; ++$i) {
-            factory({{MODEL_NAME}}::class)->create();
+            {{MODEL_NAME}}::factory()->create();
             $bar->advance();
         }