Features for the 3.x (#160)

* Valid codes

* Generator 
 
* Add Stub Command
 
* Index Query 

* With relationships

* Field tests
 
* Mergeable repositories 

* Default callback. Default resolver. Computed attributes.

* Performance

* Show fields works

Author: binaryk

composer.json

@@ -20,7 +20,8 @@
     "require": {
         "php": "^7.4",
         "ext-json": "*",
-        "illuminate/support": "^6.0|^7.0"
+        "illuminate/support": "^6.0|^7.0",
+        "doctrine/dbal": "^2.10"
     },
     "require-dev": {
         "mockery/mockery": "^1.3",

config/config.php

@@ -41,7 +41,7 @@
     |
     */
 
-    'base' => '/restify-api',
+    'base' => '/api/restify',
 
     /*
     |--------------------------------------------------------------------------

phpunit.xml

@@ -0,0 +1,36 @@
+<?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="true">
+    <testsuites>
+        <testsuite name="Test Suite">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+    <filter>
+        <whitelist>
+            <directory suffix=".php">src/</directory>
+            <exclude>
+                <directory suffix="CheckPassport.php">src/Commands</directory>
+            </exclude>
+        </whitelist>
+    </filter>
+<!--    <logging>-->
+<!--        <log type="tap" target="build/report.tap"/>-->
+<!--        <log type="junit" target="build/report.junit.xml"/>-->
+<!--        <log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>-->
+<!--        <log type="coverage-text" target="build/coverage.txt"/>-->
+<!--        <log type="coverage-clover" target="build/logs/clover.xml"/>-->
+<!--    </logging>-->
+    <php>
+        <env name="APP_KEY" value="base64:la8jDWcqBHfGO6PR+OA9FAZqdi0XQKuhnzqc5tUATZs="/>
+        <env name="MAIL_DRIVER" value="log"/>
+    </php>
+</phpunit>

routes/api.php

@@ -1,8 +1,14 @@
 <?php
 
-Route::get('/{repository}', 'RepositoryIndexController@handle');
-Route::post('/{repository}', 'RepositoryStoreController@handle');
-Route::get('/{repository}/{repositoryId}', 'RepositoryShowController@handle');
-Route::patch('/{repository}/{repositoryId}', 'RepositoryUpdateController@handle');
-Route::put('/{repository}/{repositoryId}', 'RepositoryUpdateController@handle');
-Route::delete('/{repository}/{repositoryId}', 'RepositoryDestroyController@handle');
+use Binaryk\LaravelRestify\Http\Controllers\RepositoryDestroyController;
+use Binaryk\LaravelRestify\Http\Controllers\RepositoryIndexController;
+use Binaryk\LaravelRestify\Http\Controllers\RepositoryShowController;
+use Binaryk\LaravelRestify\Http\Controllers\RepositoryStoreController;
+use Binaryk\LaravelRestify\Http\Controllers\RepositoryUpdateController;
+
+Route::get('/{repository}', '\\'.RepositoryIndexController::class);
+Route::post('/{repository}', '\\'.RepositoryStoreController::class);
+Route::get('/{repository}/{repositoryId}', '\\'.RepositoryShowController::class);
+Route::patch('/{repository}/{repositoryId}', '\\'.RepositoryUpdateController::class);
+Route::put('/{repository}/{repositoryId}', '\\'.RepositoryUpdateController::class);
+Route::delete('/{repository}/{repositoryId}', '\\'.RepositoryDestroyController::class);

src/Commands/BaseRepositoryCommand.php

@@ -6,60 +6,24 @@
 
 class BaseRepositoryCommand extends GeneratorCommand
 {
-    /**
-     * The console command name.
-     *
-     * @var string
-     */
     protected $name = 'restify:base-repository';
 
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
     protected $description = 'Create a new base repository class';
 
-    /**
-     * Indicates whether the command should be shown in the Artisan command list.
-     *
-     * @var bool
-     */
     protected $hidden = true;
 
-    /**
-     * The type of class being generated.
-     *
-     * @var string
-     */
     protected $type = 'Repository';
 
-    /**
-     * Execute the console command.
-     *
-     * @return bool|null
-     */
     public function handle()
     {
         parent::handle();
     }
 
-    /**
-     * Get the stub file for the generator.
-     *
-     * @return string
-     */
     protected function getStub()
     {
         return __DIR__.'/stubs/base-repository.stub';
     }
 
-    /**
-     * Get the default namespace for the class.
-     *
-     * @param  string  $rootNamespace
-     * @return string
-     */
     protected function getDefaultNamespace($rootNamespace)
     {
         return $rootNamespace.'\Restify';

src/Commands/PolicyCommand.php

@@ -6,90 +6,66 @@
 use Illuminate\Support\Str;
 use Symfony\Component\Console\Input\InputOption;
 
-/**
- * @author Eduard Lupacescu <[email protected]>
- */
 class PolicyCommand extends GeneratorCommand
 {
-    /**
-     * The console command name.
-     *
-     * @var string
-     */
     protected $name = 'restify:policy';
 
-    /**
-     * The console command description.
-     *
-     * @var string
-     */
     protected $description = 'Create a new policy for a specific model.';
 
-    /**
-     * The type of class being generated.
-     *
-     * @var string
-     */
-    protected $type = 'Policy';
-
-    /**
-     * Execute the console command.
-     *
-     * @return bool|null
-     * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
-     */
     public function handle()
     {
-        parent::handle();
+        if (parent::handle() === false && ! $this->option('force')) {
+            return false;
+        }
     }
 
-    /**
-     * Build the class with the given name.
-     *
-     * @param  string  $name
-     * @return string
-     * @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
-     */
     protected function buildClass($name)
     {
-        $namespacedModel = null;
-        $model = $this->option('model');
+        $class = $this->replaceModel(parent::buildClass($name));
 
-        if (is_null($model)) {
-            $model = $this->argument('name');
-        }
+        $class = $this->replaceQualifiedModel($class);
 
-        if ($model && ! Str::startsWith($model, [$this->laravel->getNamespace(), '\\'])) {
-            $namespacedModel = $this->laravel->getNamespace().$model;
-        }
+        return $class;
+    }
 
-        $name .= 'Policy';
+    protected function replaceClass($stub, $name)
+    {
+        $class = str_replace($this->getNamespace($name).'\\', '', $this->guessPolicyName());
 
-        $rendered = str_replace(
-            'UseDummyModel', $namespacedModel ?? $model, parent::buildClass($name)
-        );
+        return str_replace(['{{ class }}', '{{class}}'], $class, $stub);
+    }
 
-        $rendered = str_replace(
-            'DummyModel', $model, $rendered
-        );
+    protected function replaceModel($stub)
+    {
+        return str_replace(['{{ model }}', '{{model}}'], class_basename($this->guessQualifiedModel()), $stub);
+    }
+
+    protected function replaceQualifiedModel($stub)
+    {
+        return str_replace('{{ modelQualified }}', $this->guessQualifiedModel(), $stub);
+    }
+
+    protected function guessQualifiedModel(): string
+    {
+        $model = Str::singular(class_basename(Str::beforeLast($this->getNameInput(), 'Policy')));
 
-        return $rendered;
+        return str_replace('/', '\\', $this->rootNamespace().'Models/'.$model);
     }
 
-    public function nameWithEnd()
+    protected function guessPolicyName()
     {
-        $model = $this->option('model');
+        $name = $this->getNameInput();
 
-        if (is_null($model)) {
-            $model = $this->argument('name');
+        if (false === Str::endsWith($name, 'Policy')) {
+            $name .= 'Policy';
         }
 
-        return $model.'Policy';
+        return $name;
     }
 
     protected function getPath($name)
     {
-        return $this->laravel['path'].'/Policies/'.$this->nameWithEnd().'.php';
+        return $this->laravel['path'].'/Policies/'.$this->guessPolicyName().'.php';
     }
 
     /**
@@ -105,12 +81,12 @@ protected function getStub()
     /**
      * Get the default namespace for the class.
      *
-     * @param  string  $rootNamespace
+     * @param string $rootNamespace
      * @return string
      */
     protected function getDefaultNamespace($rootNamespace)
     {
-        return $rootNamespace.'\Restify';
+        return $rootNamespace.'\Policies';
     }
 
     /**
@@ -122,6 +98,7 @@ protected function getOptions()
     {
         return [
             ['model', 'm', InputOption::VALUE_REQUIRED, 'The model class being protected.'],
+            ['force', null, InputOption::VALUE_NONE, 'Create the class even if the model already exists.'],
         ];
     }
 }