Merge pull request #2 from webfactor/2.0

2.0

Author: tswonke

CHANGELOG.md

@@ -21,6 +21,19 @@ Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) princip
 ### Security
 - Nothing
 
+## 2.0.0 - 2018-03-23
+
+### Added
+- `LanguageService` generates models.php translation file (if not exists) and fill singular/plural translation
+- `OpenIdeService` opens all generated file with PhpStorm if command is called with `--ide={ide}`
+- `RouteService` adds Backpack Crud route to admin.php
+
+### Changed
+
+- `BackpackCrudModelService` will fill `$fillable` in Model automatically from scheme (if given)
+- `BackpackCrudRequestService` will fill `rules()` in Request automatically from scheme (if given)
+- `BackpackCrudControllerService` will add CrudFields and CrudColumns in Controller automatically from scheme (if given) - very rudimentary for now, more functionality planned
+
 ## 1.2.0 - 2018-03-18
 
 ### Added

README.md

@@ -8,37 +8,71 @@
 [![Quality Score][ico-code-quality]][link-code-quality]
 [![Total Downloads][ico-downloads]][link-downloads]
 
+This is a package developed by us for internal use. It is supposed to help us during development and save plenty of time by automating many steps while creating typical CRUD entities with [Laravel Backpack](https://laravel-backpack.readme.io/docs). You can write your own Services (they have to implement `Webfactor\Laravel\Generators\Contracts\ServiceInterface`) and register them in the `generators.php` config file, or use this package as an inspiration for your own implementation.
+
 ## Install
 
-Via Composer
+### Via Composer
+
+This package is indended to be used only for development, not for production. Because of that we recommend to use `require-dev`:
 
 ``` bash
-$ composer require webfactor/laravel-generators
+composer require-dev webfactor/laravel-generators
 ```
 
 ## Usage
 
 ``` bash
-php artisan make:entity {entity_name}
+php artisan make:entity {entity_name} {--schema=} {--ide=}
 ```
 
-Use *singular* for entity. This will automatically create (while respecting naming conventions):
+`--schema` currently uses syntax from [Laravel 5 Extended Generators](https://github.com/laracasts/Laravel-5-Generators-Extended)
+
+Use *singular* for entity. This will automatically create (while respecting our internal naming conventions):
 
 * Migration
 * Factory
 * Seeder
-* Backpack CRUD (Model, Controller, Request)
+* Backpack CRUD (modified Backpack Generator):
+  * Model (incl. `$fillable`)
+  * Request (incl. `rules()`)
+  * Controller (incl. CrudColumns and CrudFields, basic for now)
+* Language File
+* Route to Backpack CRUD in admin.php
 
-## Change log
+### Open files in IDE
 
-Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+With `{--ide=}` option you can define your preferred IDE to open all automatically generated files. This package comes with an implementation for PhpStorm (`Webfactor\Laravel\Generators\RecipesPhpStormOpener`) which is defined in `generators.php`. The keys in the `ides`-Array are possible values for the command option. You can add other IDE-Opener classes, they have to implement `Webfactor\Laravel\Generators\Contracts\OpenInIdeInterface`.`
 
-## Testing
+In your service class you have to define the path to the file generated by this service. Then add `$this->addLatestFileToIdeStack();` and all files of the stack will be opened by `Webfactor\Laravel\Generators\Services\OpenIdeService` (should be placed at the end of the `services`-array in `generators.php)
 
-``` bash
-$ composer test
+Example:
+
+```php
+<?php
+
+class ExampleService extends ServiceAbstract implements ServiceInterface
+{
+    protected $relativeToBasePath = 'path/to/file';
+
+    public function call()
+    {
+        // do some magic
+
+        // searches for latest file (using modified date) in given directory and adds it to the stack
+        $this->addLatestFileToIdeStack();
+    }
+}
 ```
 
+## Adaption
+
+Feel free to write your own Services that fit your purposes!
+
+## Change log
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
 ## Contributing
 
 Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.

composer.json

@@ -48,7 +48,7 @@
             ]
         },
         "branch-alias": {
-            "dev-master": "1.0-dev"
+            "dev-master": "2.0-dev"
         }
     },
     "config": {

config/generators.php

@@ -6,11 +6,22 @@
      * have to implement Webfactor\Laravel\Generators\Contracts\MakeServiceInterface.
      */
     'services' => [
-        Webfactor\Laravel\Generators\Services\MakeBackpackCrudModelService::class,
-        Webfactor\Laravel\Generators\Services\MakeBackpackCrudControllerService::class,
-        Webfactor\Laravel\Generators\Services\MakeBackpackCrudRequestService::class,
-        Webfactor\Laravel\Generators\Services\MakeMigrationService::class,
-        Webfactor\Laravel\Generators\Services\MakeFactoryService::class,
-        Webfactor\Laravel\Generators\Services\MakeSeederService::class,
+        Webfactor\Laravel\Generators\Services\MigrationService::class,
+        Webfactor\Laravel\Generators\Services\LanguageService::class,
+        Webfactor\Laravel\Generators\Services\BackpackCrudModelService::class,
+        Webfactor\Laravel\Generators\Services\BackpackCrudControllerService::class,
+        Webfactor\Laravel\Generators\Services\BackpackCrudRequestService::class,
+        Webfactor\Laravel\Generators\Services\FactoryService::class,
+        Webfactor\Laravel\Generators\Services\SeederService::class,
+        Webfactor\Laravel\Generators\Services\RouteService::class,
+        Webfactor\Laravel\Generators\Services\OpenIdeService::class,
+    ],
+
+    /*
+     * Recipe classes for opening all generated files directly in IDE if the option --ide={key}
+     * is used. Have to implement Webfactor\Laravel\Generators\Contracts\OpenIdeInterface.
+     */
+    'ides'     => [
+        'pstorm' => Webfactor\Laravel\Generators\Recipes\PhpStormOpener::class,
     ],
 ];

src/Commands/MakeBackpackCrudController.php

@@ -83,6 +83,7 @@ protected function replaceNameStrings(&$stub, $name)
         $table = str_plural(ltrim(strtolower(preg_replace('/[A-Z]/', '_$0', str_replace($this->getNamespace($name).'\\', '', $name))), '_'));
 
         $stub = str_replace('DummyTable', $table, $stub);
+        $stub = str_replace('dummy_name', snake_case($this->argument('name')), $stub);
         $stub = str_replace('dummy_class', strtolower(str_replace($this->getNamespace($name).'\\', '', $name)), $stub);
 
         return $this;
@@ -99,7 +100,9 @@ protected function buildClass($name)
     {
         $stub = $this->files->get($this->getStub());
 
-        return $this->replaceNamespace($stub, $name)->replaceNameStrings($stub, $name)->replaceClass($stub, $name);
+        return $this->replaceNamespace($stub, $name)
+            ->replaceNameStrings($stub, $name)
+            ->replaceClass($stub, $name);
     }
 
     /**

src/Commands/MakeEntity.php

@@ -3,39 +3,69 @@
 namespace Webfactor\Laravel\Generators\Commands;
 
 use Illuminate\Console\Command;
+use Symfony\Component\Finder\SplFileInfo;
 use Webfactor\Laravel\Generators\MakeServices;
+use Webfactor\Laravel\Generators\Schemas\MigrationSchema;
 
 class MakeEntity extends Command
 {
+    /**
+     * Paths to files which should automatically be opened in IDE if the
+     * option --ide is set (and IDE capable).
+     *
+     * @var array
+     */
+    public $filesToBeOpened = [];
+
+    /**
+     * The name of the entity being created.
+     *
+     * @var string
+     */
+    public $entity;
+
+    /**
+     * The migration schema object.
+     *
+     * @var MigrationSchema
+     */
+    public $schema;
+
     /**
      * The name and signature of the console command.
      *
      * @var string
      */
-    protected $signature = 'make:entity {entity} {--schema=}';
+    protected $signature = 'make:entity {entity} {--schema="name:string"} {--migrate} {--ide=}';
+
     /**
      * The console command description.
      *
      * @var string
      */
     protected $description = 'Make Entity';
+
     /**
-     * Create a new command instance.
+     * Execute the console command.
      *
-     * @return void
+     * @return mixed
      */
-    public function __construct()
+    public function handle()
     {
-        parent::__construct();
+        $this->entity = $this->argument('entity');
+        $this->schema = new MigrationSchema($this->option('schema'));
+
+        (new MakeServices($this))->call();
     }
 
     /**
-     * Execute the console command.
+     * Adds file to $filesToBeOpened stack.
      *
-     * @return mixed
+     * @param $file
+     * @return void
      */
-    public function handle()
+    public function addFile(SplFileInfo $file): void
     {
-        (new MakeServices($this))->call();
+        array_push($this->filesToBeOpened, $file);
     }
 }

src/Contracts/MakeServiceAbstract.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace Webfactor\Laravel\Generators\Contracts;
+
+use Webfactor\Laravel\Generators\Commands\MakeEntity;
+
+abstract class OpenInIdeAbstract
+{
+    protected $files;
+
+    public function __construct(array $files)
+    {
+        $this->files = $files;
+    }
+}

src/Contracts/OpenInIdeAbstract.php

@@ -2,7 +2,7 @@
 
 namespace Webfactor\Laravel\Generators\Contracts;
 
-interface MakeServiceInterface
+interface OpenInIdeInterface
 {
-    public function make();
+    public function open();
 }

src/Contracts/MakeServiceInterface.php renamed to src/Contracts/OpenInIdeInterface.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace Webfactor\Laravel\Generators\Contracts;
+
+use Illuminate\Filesystem\Filesystem;
+use Symfony\Component\Finder\SplFileInfo;
+use Webfactor\Laravel\Generators\Commands\MakeEntity;
+
+abstract class ServiceAbstract
+{
+    protected $command;
+
+    protected $filesystem;
+
+    protected $relativeToBasePath;
+
+    public function __construct(MakeEntity $command)
+    {
+        $this->command = $command;
+        $this->filesystem = new Filesystem();
+    }
+
+    protected function addLatestFileToIdeStack()
+    {
+        $this->command->addFile($this->latestCreatedFileIn(base_path($this->relativeToBasePath)));
+    }
+
+    /**
+     * Returns the latest created File in given Path to use it for $filesToBeOpened stack
+     *
+     * @param string $path
+     *
+     * @return SplFileInfo
+     */
+    protected function latestCreatedFileIn(string $path): SplFileInfo
+    {
+        $sortedByMTime = array_sort($this->filesystem->files($path), function ($file) {
+            return $file->getMTime();
+        });
+
+        return end($sortedByMTime);
+    }
+}