Merge pull request #25 from dereuromark/master

burzum · web-flow · commit 9ea90c993b6b · 2020-05-25T12:35:14.000+02:00
Add bake task for services.
diff --git a/composer.json b/composer.json
@@ -14,7 +14,7 @@
         }
     ],
     "require": {
-        "php": ">=7.0",
+        "php": ">=7.2",
         "cakephp/cakephp": "^4.0"
     },
     "require-dev": {
diff --git a/docs/Bake.md b/docs/Bake.md
@@ -0,0 +1,15 @@
+# Bake
+
+## Bake your Service
+
+Once the plugin is loaded, you can bake your service using:
+```
+bin/cake bake service MyFooBar
+```
+This would create a service class `src/Service/MyFooBarService.php`.
+
+You can also bake inside sub namespaces (subfolders):
+```
+bin/cake bake service My/Foo/Bar
+```
+This would create a service class `src/Service/My/Foo/BarService.php`.
diff --git a/src/Annotator/ClassAnnotatorTask/ServiceAwareClassAnnotatorTask.php b/src/Annotator/ClassAnnotatorTask/ServiceAwareClassAnnotatorTask.php
@@ -1,5 +1,5 @@
 <?php
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Burzum\CakeServiceLayer\Annotator\ClassAnnotatorTask;
 
diff --git a/src/Command/BakeServiceCommand.php b/src/Command/BakeServiceCommand.php
@@ -0,0 +1,114 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ * @link          http://cakephp.org CakePHP(tm) Project
+ * @license       http://www.opensource.org/licenses/mit-license.php MIT License
+ */
+namespace Burzum\CakeServiceLayer\Command;
+
+use Bake\Command\SimpleBakeCommand;
+use Cake\Console\Arguments;
+use Cake\Console\ConsoleIo;
+use Cake\Core\Configure;
+
+/**
+ * Command class for generating migration snapshot files.
+ */
+class BakeServiceCommand extends SimpleBakeCommand
+{
+    /**
+     * Task name used in path generation.
+     *
+     * @var string
+     */
+    public $pathFragment = 'Service/';
+
+    /**
+     * @var string
+     */
+    protected $_name;
+
+    /**
+     * @inheritDoc
+     */
+    public static function defaultName(): string
+    {
+        return 'bake service';
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function bake(string $name, Arguments $args, ConsoleIo $io): void
+    {
+        $this->_name = $name;
+
+        parent::bake($name, $args, $io);
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function template(): string
+    {
+        return 'Burzum/CakeServiceLayer.Service/service';
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function templateData(Arguments $arguments): array
+    {
+        $name = $this->_name;
+        $namespace = Configure::read('App.namespace');
+        $pluginPath = '';
+        if ($this->plugin) {
+            $namespace = $this->_pluginNamespace($this->plugin);
+            $pluginPath = $this->plugin . '.';
+        }
+
+        $namespace .= '\\Service';
+
+        $namespacePart = null;
+        if (strpos($name, '/') !== false) {
+            $parts = explode('/', $name);
+            $name = array_pop($parts);
+            $namespacePart = implode('\\', $parts);
+        }
+        if ($namespacePart) {
+            $namespace .= '\\' . $namespacePart;
+        }
+
+        return [
+            'plugin' => $this->plugin,
+            'pluginPath' => $pluginPath,
+            'namespace' => $namespace,
+            'name' => $name,
+        ];
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function name(): string
+    {
+        return 'service';
+    }
+
+    /**
+     * @inheritDoc
+     */
+    public function fileName(string $name): string
+    {
+        return $name . 'Service.php';
+    }
+}
diff --git a/src/DomainModel/DomainModelAwareTrait.php b/src/DomainModel/DomainModelAwareTrait.php
@@ -11,7 +11,7 @@
  * @since         1.0.0
  * @license       https://opensource.org/licenses/mit-license.php MIT License
  */
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Burzum\CakeServiceLayer\DomainModel;
 
diff --git a/src/DomainModel/DomainModelLocator.php b/src/DomainModel/DomainModelLocator.php
@@ -11,7 +11,7 @@
  * @since         1.0.0
  * @license       https://opensource.org/licenses/mit-license.php MIT License
  */
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Burzum\CakeServiceLayer\DomainModel;
 
@@ -77,7 +77,7 @@ protected function _throwMissingClassError(string $class, ?string $plugin): void
     protected function _create($class, $alias, $config)
     {
         if (empty($config)) {
-            return new $class;
+            return new $class();
         }
 
         return new $class(...$config);
diff --git a/src/Generator/Task/ServiceTask.php b/src/Generator/Task/ServiceTask.php
@@ -10,7 +10,7 @@
  * @since         1.0.0
  * @license       https://opensource.org/licenses/mit-license.php MIT License
  */
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Burzum\CakeServiceLayer\Generator\Task;
 
diff --git a/src/Plugin.php b/src/Plugin.php
@@ -0,0 +1,55 @@
+<?php
+declare(strict_types=1);
+
+/**
+ * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ * @link          http://cakephp.org CakePHP(tm) Project
+ * @license       http://www.opensource.org/licenses/mit-license.php MIT License
+ */
+namespace Burzum\CakeServiceLayer;
+
+use Cake\Console\CommandCollection;
+use Cake\Core\BasePlugin;
+
+/**
+ * Plugin class for Burzum/CakeServiceLayer
+ */
+class Plugin extends BasePlugin
+{
+    /**
+     * @var string
+     */
+    protected $name = 'Burzum/CakeServiceLayer';
+
+    /**
+     * @var bool
+     */
+    protected $routesEnabled = false;
+
+    /**
+     * @var bool
+     */
+    protected $middlewareEnabled = false;
+
+    /**
+     * Add migrations commands.
+     *
+     * @param \Cake\Console\CommandCollection $collection The command collection to update
+     * @return \Cake\Console\CommandCollection
+     */
+    public function console(CommandCollection $collection): CommandCollection
+    {
+        if (class_exists('Bake\Command\SimpleBakeCommand')) {
+            $commands = $collection->discoverPlugin($this->getName());
+
+            return $collection->addMany($commands);
+        }
+
+        return $collection;
+    }
+}
diff --git a/src/Service/PaginationService.php b/src/Service/PaginationService.php
@@ -11,7 +11,7 @@
  * @since         1.0.0
  * @license       https://opensource.org/licenses/mit-license.php MIT License
  */
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Burzum\CakeServiceLayer\Service;
 
diff --git a/src/Service/ServiceAwareTrait.php b/src/Service/ServiceAwareTrait.php
@@ -11,7 +11,7 @@
  * @since         1.0.0
  * @license       https://opensource.org/licenses/mit-license.php MIT License
  */
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Burzum\CakeServiceLayer\Service;
 
diff --git a/src/Service/ServiceLocator.php b/src/Service/ServiceLocator.php
@@ -11,7 +11,7 @@
  * @since         1.0.0
  * @license       https://opensource.org/licenses/mit-license.php MIT License
  */
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Burzum\CakeServiceLayer\Service;
 
@@ -32,7 +32,7 @@ class ServiceLocator extends ObjectRegistry
      * @param string $class The class to resolve.
      * @return string|null The resolved name or null for failure.
      */
-    protected function _resolveClassName(string$class): ?string
+    protected function _resolveClassName(string $class): ?string
     {
         return App::className($class, 'Service', 'Service') ?: null;
     }
diff --git a/src/Service/ServicePaginatorTrait.php b/src/Service/ServicePaginatorTrait.php
@@ -11,7 +11,7 @@
  * @since         1.0.0
  * @license       https://opensource.org/licenses/mit-license.php MIT License
  */
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Burzum\CakeServiceLayer\Service;
 
diff --git a/templates/bake/Service/service.twig b/templates/bake/Service/service.twig
@@ -0,0 +1,8 @@
+<?php
+declare(strict_types=1);
+
+namespace {{ namespace }};
+
+class {{ name }}Service
+{
+}
diff --git a/tests/TestCase/DomainModel/DomainModelLocatorTest.php b/tests/TestCase/DomainModel/DomainModelLocatorTest.php
@@ -11,7 +11,7 @@
  * @since         1.0.0
  * @license       https://opensource.org/licenses/mit-license.php MIT License
  */
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Burzum\CakeServiceLayer\Service;
 
diff --git a/tests/TestCase/Generator/Task/ServiceTaskTest.php b/tests/TestCase/Generator/Task/ServiceTaskTest.php
@@ -11,7 +11,7 @@
  * @since         1.0.0
  * @license       https://opensource.org/licenses/mit-license.php MIT License
  */
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Burzum\CakeServiceLayer\Test\TestCase\Generator\Task;
 
diff --git a/tests/TestCase/Service/PaginationServiceTest.php b/tests/TestCase/Service/PaginationServiceTest.php
@@ -11,7 +11,7 @@
  * @since         1.0.0
  * @license       https://opensource.org/licenses/mit-license.php MIT License
  */
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Burzum\CakeServiceLayer\Service;
 
@@ -31,7 +31,7 @@ class PaginationServiceTest extends TestCase
      * @var array
      */
     public $fixtures = [
-        'core.Articles'
+        'core.Articles',
     ];
 
     /**
@@ -69,8 +69,8 @@ public function testPaginate()
                 'completeSort' => [],
                 'start' => 1,
                 'end' => 3,
-                'requestedPage' => 1
-            ]
+                'requestedPage' => 1,
+            ],
         ];
 
         $this->assertIsArray($params);
diff --git a/tests/TestCase/Service/ServiceLocatorTest.php b/tests/TestCase/Service/ServiceLocatorTest.php
@@ -11,7 +11,7 @@
  * @since         1.0.0
  * @license       https://opensource.org/licenses/mit-license.php MIT License
  */
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Burzum\CakeServiceLayer\Service;
 
@@ -84,7 +84,7 @@ public function testPassingClassName()
     {
         $locator = new ServiceLocator();
         $locator->load('Existing', [
-            'className' => TestService::class
+            'className' => TestService::class,
         ]);
 
         $this->assertInstanceOf(TestService::class, $locator->get('Existing'));
diff --git a/tests/TestCase/Service/ServicePaginatorTraitTest.php b/tests/TestCase/Service/ServicePaginatorTraitTest.php
@@ -11,7 +11,7 @@
  * @since         1.0.0
  * @license       https://opensource.org/licenses/mit-license.php MIT License
  */
-declare(strict_types = 1);
+declare(strict_types=1);
 
 namespace Burzum\CakeServiceLayer\Service;
 
@@ -31,7 +31,7 @@ class ServicePaginatorTraitTest extends TestCase
      * @var array
      */
     public $fixtures = [
-        'core.Articles'
+        'core.Articles',
     ];
 
     /**
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
diff --git a/tests/test_app/src/DomainModel/Article.php b/tests/test_app/src/DomainModel/Article.php
diff --git a/tests/test_app/src/Model/Table/ArticlesTable.php b/tests/test_app/src/Model/Table/ArticlesTable.php
diff --git a/tests/test_app/src/Service/ArticlesService.php b/tests/test_app/src/Service/ArticlesService.php
diff --git a/tests/test_app/src/Service/Sub/Folder/NestedService.php b/tests/test_app/src/Service/Sub/Folder/NestedService.php
diff --git a/tests/test_app/src/Service/TestService.php b/tests/test_app/src/Service/TestService.php

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`}`
`15`	`15`	`],`
`16`	`16`	`"require": {`
`17`		`- "php": ">=7.0",`
	`17`	`+ "php": ">=7.2",`
`18`	`18`	`"cakephp/cakephp": "^4.0"`
`19`	`19`	`},`
`20`	`20`	`"require-dev": {`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`* @since 1.0.0`
`12`	`12`	`* @license https://opensource.org/licenses/mit-license.php MIT License`
`13`	`13`	`*/`
`14`		`-declare(strict_types = 1);`
	`14`	`+declare(strict_types=1);`
`15`	`15`
`16`	`16`	`namespace Burzum\CakeServiceLayer\DomainModel;`
`17`	`17`
`@@ -77,7 +77,7 @@ protected function _throwMissingClassError(string $class, ?string $plugin): void`
`77`	`77`	`protected function _create($class, $alias, $config)`
`78`	`78`	`{`
`79`	`79`	`if (empty($config)) {`
`80`		`- return new $class;`
	`80`	`+ return new $class();`
`81`	`81`	`}`
`82`	`82`
`83`	`83`	`return new $class(...$config);`