Merge pull request #220 from CasperLaiTW/criteria-generator

Criteria command (make:criteria)

README.md

@@ -202,6 +202,7 @@ You must first configure the storage location of the repository files. By defaul
             'validators'   => 'Validators',
             'controllers'  => 'Http/Controllers',
             'provider'     => 'RepositoryServiceProvider',
+            'criteria'     => 'Criteria',
         ]
     ]
 ```
@@ -231,6 +232,7 @@ Additionally, you may wish to customize where your generated classes end up bein
             'validators'   => 'Validators',
             'controllers'  => 'Http/Controllers',
             'provider'     => 'RepositoryServiceProvider',
+            'criteria'     => 'Criteria',
         ]
     ]
 ```
@@ -415,6 +417,12 @@ $this->repository->delete($id)
 
 ### Create a Criteria
 
+#### Using the command
+
+```terminal
+php artisan make:criteria My
+```
+
 Criteria are a way to change the repository of the query by applying specific conditions according to your needs. You can add multiple Criteria in your repository.
 
 ```php

src/Prettus/Repository/Generators/Commands/CriteriaCommand.php

@@ -0,0 +1,87 @@
+<?php
+
+namespace Prettus\Repository\Generators\Commands;
+
+use Illuminate\Console\Command;
+use Prettus\Repository\Generators\CriteriaGenerator;
+use Prettus\Repository\Generators\FileAlreadyExistsException;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputOption;
+
+class CriteriaCommand extends Command
+{
+    /**
+     * The name of command.
+     *
+     * @var string
+     */
+    protected $name = 'make:criteria';
+
+    /**
+     * The description of command.
+     *
+     * @var string
+     */
+    protected $description = 'Create a new criteria.';
+
+    /**
+     * The type of class being generated.
+     *
+     * @var string
+     */
+    protected $type = 'Criteria';
+    /**
+     * Execute the command.
+     *
+     * @return void
+     */
+    public function fire()
+    {
+        try {
+            (new CriteriaGenerator([
+                'name' => $this->argument('name'),
+                'force' => $this->option('force'),
+            ]))->run();
+
+            $this->info("Criteria created successfully.");
+        } catch (FileAlreadyExistsException $ex) {
+            $this->error($this->type . ' already exists!');
+            return false;
+        }
+    }
+
+    /**
+     * The array of command arguments.
+     *
+     * @return array
+     */
+    public function getArguments()
+    {
+        return [
+            [
+                'name',
+                InputArgument::REQUIRED,
+                'The name of class being generated.',
+                null
+            ],
+        ];
+    }
+
+    /**
+     * The array of command options.
+     *
+     * @return array
+     */
+    public function getOptions()
+    {
+        return [
+            [
+                'force',
+                'f',
+                InputOption::VALUE_NONE,
+                'Force the creation if file already exists.',
+                null
+            ],
+        ];
+    }
+}

src/Prettus/Repository/Generators/CriteriaGenerator.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace Prettus\Repository\Generators;
+
+/**
+ * Class CriteriaGenerator
+ * @package Prettus\Repository\Generators
+ */
+class CriteriaGenerator extends Generator
+{
+    /**
+     * Get stub name.
+     *
+     * @var string
+     */
+    protected $stub = 'criteria/criteria';
+
+    /**
+     * Get root namespace.
+     *
+     * @return string
+     */
+    public function getRootNamespace()
+    {
+        return parent::getRootNamespace() . parent::getConfigGeneratorClassPath($this->getPathConfigNode());
+    }
+
+    /**
+     * Get generator path config node.
+     * @return string
+     */
+    public function getPathConfigNode()
+    {
+        return 'criteria';
+    }
+
+    /**
+     * Get destination path for generated file.
+     *
+     * @return string
+     */
+    public function getPath()
+    {
+        return $this->getBasePath() . '/' . parent::getConfigGeneratorClassPath($this->getPathConfigNode(), true) . '/' . $this->getName() . 'Criteria.php';
+    }
+
+    /**
+     * Get base path of destination file.
+     *
+     * @return string
+     */
+    public function getBasePath()
+    {
+        return config('repository.generator.basePath', app_path());
+    }
+}

src/Prettus/Repository/Generators/Generator.php

@@ -205,6 +205,9 @@ public function getConfigGeneratorClassPath($class, $directoryPath = false)
             case ('provider' === $class):
                 $path = config('repository.generator.paths.provider', 'RepositoryServiceProvider');
                 break;
+            case ('criteria' === $class):
+                $path = config('repository.generator.paths.criteria', 'Criteria');
+                break;
             default:
                 $path = '';
         }

src/Prettus/Repository/Generators/Stubs/criteria/criteria.stub

@@ -0,0 +1,26 @@
+<?php
+
+$NAMESPACE$
+
+use Prettus\Repository\Contracts\CriteriaInterface;
+use Prettus\Repository\Contracts\RepositoryInterface;
+
+/**
+ * Class $CLASS$Criteria
+ * @package $NAMESPACE$
+ */
+class $CLASS$Criteria implements CriteriaInterface
+{
+    /**
+     * Apply criteria in query repository
+     *
+     * @param                     $model
+     * @param RepositoryInterface $repository
+     *
+     * @return mixed
+     */
+    public function apply($model, RepositoryInterface $repository)
+    {
+        return $model;
+    }
+}

src/Prettus/Repository/Providers/RepositoryServiceProvider.php

@@ -48,6 +48,7 @@ public function register()
         $this->commands('Prettus\Repository\Generators\Commands\ValidatorCommand');
         $this->commands('Prettus\Repository\Generators\Commands\ControllerCommand');
         $this->commands('Prettus\Repository\Generators\Commands\BindingsCommand');
+        $this->commands('Prettus\Repository\Generators\Commands\CriteriaCommand');
         $this->app->register('Prettus\Repository\Providers\EventServiceProvider');
     }
 

src/resources/config/repository.php

@@ -230,6 +230,7 @@
             'validators'   => 'Validators',
             'controllers'  => 'Http/Controllers',
             'provider'     => 'RepositoryServiceProvider',
+            'criteria'     => 'Criteria',
         ]
     ]
 ];