Merge pull request #26 from dotkernel/issue-25

Issue #25: Fix Handler naming pattern for non-API projects

Author: arhimede

docs/book/v1/component/module.md

@@ -351,7 +351,7 @@ Next steps:
   composer dump
 - generate Doctrine migration:
   php ./vendor/bin/doctrine-migrations diff
-- Run through each new file, verify their content and start adding logic to them.
+- Review each new file, verify their contents and start adding logic to them.
 ```
 
 where `<ProjectType>` is the project type (**API**, **Admin**, **Frontend**, **Light** or **Queue**) and `<ModuleName>` is the name of the Module.

src/FileSystem.php

@@ -212,7 +212,7 @@ public function getCreateResourceHandler(string $name): File
         return new File(
             new Directory($name, sprintf('%s/src/%s/src/Handler', $this->context->getProjectPath(), $this->moduleName)),
             sprintf('%s\\%s\\Handler\\%s', $this->context->getRootNamespace(), $this->moduleName, $name),
-            sprintf('Get%sCreateFormHandler', $name),
+            sprintf('GetCreate%sFormHandler', $name),
         );
     }
 
@@ -221,7 +221,7 @@ public function getDeleteResourceHandler(string $name): File
         return new File(
             new Directory($name, sprintf('%s/src/%s/src/Handler', $this->context->getProjectPath(), $this->moduleName)),
             sprintf('%s\\%s\\Handler\\%s', $this->context->getRootNamespace(), $this->moduleName, $name),
-            sprintf('Get%sDeleteFormHandler', $name),
+            sprintf('GetDelete%sFormHandler', $name),
         );
     }
 
@@ -230,7 +230,7 @@ public function getEditResourceHandler(string $name): File
         return new File(
             new Directory($name, sprintf('%s/src/%s/src/Handler', $this->context->getProjectPath(), $this->moduleName)),
             sprintf('%s\\%s\\Handler\\%s', $this->context->getRootNamespace(), $this->moduleName, $name),
-            sprintf('Get%sEditFormHandler', $name),
+            sprintf('GetEdit%sFormHandler', $name),
         );
     }
 
@@ -239,7 +239,7 @@ public function getListResourcesHandler(string $name): File
         return new File(
             new Directory($name, sprintf('%s/src/%s/src/Handler', $this->context->getProjectPath(), $this->moduleName)),
             sprintf('%s\\%s\\Handler\\%s', $this->context->getRootNamespace(), $this->moduleName, $name),
-            sprintf('Get%sListHandler', $name),
+            sprintf('GetList%sHandler', $name),
         );
     }
 
@@ -248,7 +248,7 @@ public function getViewResourceHandler(string $name): File
         return new File(
             new Directory($name, sprintf('%s/src/%s/src/Handler', $this->context->getProjectPath(), $this->moduleName)),
             sprintf('%s\\%s\\Handler\\%s', $this->context->getRootNamespace(), $this->moduleName, $name),
-            sprintf('Get%sViewHandler', $name),
+            sprintf('GetView%sHandler', $name),
         );
     }
 
@@ -257,7 +257,7 @@ public function postCreateResourceHandler(string $name): File
         return new File(
             new Directory($name, sprintf('%s/src/%s/src/Handler', $this->context->getProjectPath(), $this->moduleName)),
             sprintf('%s\\%s\\Handler\\%s', $this->context->getRootNamespace(), $this->moduleName, $name),
-            sprintf('Post%sCreateHandler', $name),
+            sprintf('PostCreate%sHandler', $name),
         );
     }
 
@@ -266,7 +266,7 @@ public function postDeleteResourceHandler(string $name): File
         return new File(
             new Directory($name, sprintf('%s/src/%s/src/Handler', $this->context->getProjectPath(), $this->moduleName)),
             sprintf('%s\\%s\\Handler\\%s', $this->context->getRootNamespace(), $this->moduleName, $name),
-            sprintf('Post%sDeleteHandler', $name),
+            sprintf('PostDelete%sHandler', $name),
         );
     }
 
@@ -275,7 +275,7 @@ public function postEditResourceHandler(string $name): File
         return new File(
             new Directory($name, sprintf('%s/src/%s/src/Handler', $this->context->getProjectPath(), $this->moduleName)),
             sprintf('%s\\%s\\Handler\\%s', $this->context->getRootNamespace(), $this->moduleName, $name),
-            sprintf('Post%sEditHandler', $name),
+            sprintf('PostEdit%sHandler', $name),
         );
     }
 

src/Message.php

@@ -166,7 +166,7 @@ public static function checkFiles(): self
     {
         return new self(
             ColorEnum::colorize(
-                'Run through each new file, verify their content and start adding logic to them.',
+                'Review each new file, verify their contents and start adding logic to them.',
                 ColorEnum::ForegroundBrightRed
             ),
             self::CHECK_FILES

test/MessageTest.php

@@ -140,7 +140,7 @@ public function testWillParseCheckFilesMessage(): void
         $message = Message::checkFiles();
 
         $expected = <<<EXP
-\033[91mRun through each new file, verify their content and start adding logic to them.\033[0m
+\033[91mReview each new file, verify their contents and start adding logic to them.\033[0m
 EXP;
 
         $this->assertSame($expected, (string) $message);

test/Type/HandlerTest.php

@@ -1081,7 +1081,7 @@ private function dataProviderGetListResourceHandler(): string
 
 {$uses}
 
-class GetBookStoreListHandler implements RequestHandlerInterface
+class GetListBookStoreHandler implements RequestHandlerInterface
 {
     #[Inject(
         BookStoreServiceInterface::class,
@@ -1135,7 +1135,7 @@ private function dataProviderGetViewResourceHandler(): string
 
 {$uses}
 
-class GetBookStoreViewHandler implements RequestHandlerInterface
+class GetViewBookStoreHandler implements RequestHandlerInterface
 {
     #[Inject(
         BookStoreServiceInterface::class,
@@ -1196,7 +1196,7 @@ private function dataProviderGetCreateResourceHandler(): string
 
 {$uses}
 
-class GetBookStoreCreateFormHandler implements RequestHandlerInterface
+class GetCreateBookStoreFormHandler implements RequestHandlerInterface
 {
     #[Inject(
         RouterInterface::class,
@@ -1261,7 +1261,7 @@ private function dataProviderPostCreateResourceHandler(): string
 
 {$uses}
 
-class PostBookStoreCreateHandler implements RequestHandlerInterface
+class PostCreateBookStoreHandler implements RequestHandlerInterface
 {
     #[Inject(
         BookStoreServiceInterface::class,
@@ -1369,7 +1369,7 @@ private function dataProviderGetDeleteResourceHandler(): string
 
 {$uses}
 
-class GetBookStoreDeleteFormHandler implements RequestHandlerInterface
+class GetDeleteBookStoreFormHandler implements RequestHandlerInterface
 {
     #[Inject(
         BookStoreServiceInterface::class,
@@ -1449,7 +1449,7 @@ private function dataProviderPostDeleteResourceHandler(): string
 
 {$uses}
 
-class PostBookStoreDeleteHandler implements RequestHandlerInterface
+class PostDeleteBookStoreHandler implements RequestHandlerInterface
 {
     #[Inject(
         BookStoreServiceInterface::class,
@@ -1551,7 +1551,7 @@ private function dataProviderGetEditResourceHandler(): string
 
 {$uses}
 
-class GetBookStoreEditFormHandler implements RequestHandlerInterface
+class GetEditBookStoreFormHandler implements RequestHandlerInterface
 {
     #[Inject(
         BookStoreServiceInterface::class,
@@ -1637,7 +1637,7 @@ private function dataProviderPostEditResourceHandler(): string
 
 {$uses}
 
-class PostBookStoreEditHandler implements RequestHandlerInterface
+class PostEditBookStoreHandler implements RequestHandlerInterface
 {
     #[Inject(
         BookStoreServiceInterface::class,

test/Type/ModuleTest.php

@@ -1116,7 +1116,7 @@ private function dataProviderWhenProjectTypeIsApiAndUsesCore(): string
 \033[93m  composer dump\033[0m
 - generate Doctrine migration:
 \033[93m  php ./vendor/bin/doctrine-migrations diff\033[0m
-- \033[91mRun through each new file, verify their content and start adding logic to them.\033[0m
+- \033[91mReview each new file, verify their contents and start adding logic to them.\033[0m
 
 BODY;
         // phpcs:enable Generic.Files.LineLength.TooLong
@@ -1177,7 +1177,7 @@ private function dataProviderWhenProjectTypeIsApiAndDoesNotUseCore(): string
 \033[93m  composer dump\033[0m
 - generate Doctrine migration:
 \033[93m  php ./vendor/bin/doctrine-migrations diff\033[0m
-- \033[91mRun through each new file, verify their content and start adding logic to them.\033[0m
+- \033[91mReview each new file, verify their contents and start adding logic to them.\033[0m
 
 BODY;
         // phpcs:enable Generic.Files.LineLength.TooLong
@@ -1201,27 +1201,27 @@ private function dataProviderWhenProjectTypeIsNotApiAndUsesCore(): string
 Create middleware? [Y(es)/n(o)]: \033[92mCreated Middleware: vfs://root/src/BookStore/src/Middleware/BookStoreMiddleware.php\033[0m
 
 Create handler? [Y(es)/n(o)]: 
-Allow listing BookStores? [Y(es)/n(o)]: \033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/GetBookStoreListHandler.php\033[0m
+Allow listing BookStores? [Y(es)/n(o)]: \033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/GetListBookStoreHandler.php\033[0m
 \033[92mCreated template file: vfs://root/src/BookStore/templates/book-store/book-store-list.html.twig\033[0m
 
-Allow viewing BookStores? [Y(es)/n(o)]: \033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/GetBookStoreViewHandler.php\033[0m
+Allow viewing BookStores? [Y(es)/n(o)]: \033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/GetViewBookStoreHandler.php\033[0m
 \033[92mCreated template file: vfs://root/src/BookStore/templates/book-store/book-store-view.html.twig\033[0m
 
-Allow creating BookStores? [Y(es)/n(o)]: \033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/GetBookStoreCreateFormHandler.php\033[0m
-\033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/PostBookStoreCreateHandler.php\033[0m
+Allow creating BookStores? [Y(es)/n(o)]: \033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/GetCreateBookStoreFormHandler.php\033[0m
+\033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/PostCreateBookStoreHandler.php\033[0m
 \033[92mCreated Form: vfs://root/src/BookStore/src/Form/CreateBookStoreForm.php\033[0m
 \033[92mCreated InputFilter: vfs://root/src/BookStore/src/InputFilter/CreateBookStoreInputFilter.php\033[0m
 \033[92mCreated template file: vfs://root/src/BookStore/templates/book-store/book-store-create-form.html.twig\033[0m
 
-Allow deleting BookStores? [Y(es)/n(o)]: \033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/GetBookStoreDeleteFormHandler.php\033[0m
-\033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/PostBookStoreDeleteHandler.php\033[0m
+Allow deleting BookStores? [Y(es)/n(o)]: \033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/GetDeleteBookStoreFormHandler.php\033[0m
+\033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/PostDeleteBookStoreHandler.php\033[0m
 \033[92mCreated Form: vfs://root/src/BookStore/src/Form/DeleteBookStoreForm.php\033[0m
 \033[92mCreated InputFilter: vfs://root/src/BookStore/src/InputFilter/DeleteBookStoreInputFilter.php\033[0m
 \033[92mCreated Input: vfs://root/src/BookStore/src/InputFilter/Input/ConfirmDeleteBookStoreInput.php\033[0m
 \033[92mCreated template file: vfs://root/src/BookStore/templates/book-store/book-store-delete-form.html.twig\033[0m
 
-Allow editing BookStores? [Y(es)/n(o)]: \033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/GetBookStoreEditFormHandler.php\033[0m
-\033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/PostBookStoreEditHandler.php\033[0m
+Allow editing BookStores? [Y(es)/n(o)]: \033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/GetEditBookStoreFormHandler.php\033[0m
+\033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/PostEditBookStoreHandler.php\033[0m
 \033[92mCreated Form: vfs://root/src/BookStore/src/Form/EditBookStoreForm.php\033[0m
 \033[92mCreated InputFilter: vfs://root/src/BookStore/src/InputFilter/EditBookStoreInputFilter.php\033[0m
 \033[92mCreated template file: vfs://root/src/BookStore/templates/book-store/book-store-edit-form.html.twig\033[0m
@@ -1251,7 +1251,7 @@ private function dataProviderWhenProjectTypeIsNotApiAndUsesCore(): string
 \033[93m  composer dump\033[0m
 - generate Doctrine migration:
 \033[93m  php ./vendor/bin/doctrine-migrations diff\033[0m
-- \033[91mRun through each new file, verify their content and start adding logic to them.\033[0m
+- \033[91mReview each new file, verify their contents and start adding logic to them.\033[0m
 
 BODY;
         // phpcs:enable Generic.Files.LineLength.TooLong
@@ -1275,27 +1275,27 @@ private function dataProviderWhenProjectTypeIsNotApiAndDoesNotUseCore(): string
 Create middleware? [Y(es)/n(o)]: \033[92mCreated Middleware: vfs://root/src/BookStore/src/Middleware/BookStoreMiddleware.php\033[0m
 
 Create handler? [Y(es)/n(o)]: 
-Allow listing BookStores? [Y(es)/n(o)]: \033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/GetBookStoreListHandler.php\033[0m
+Allow listing BookStores? [Y(es)/n(o)]: \033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/GetListBookStoreHandler.php\033[0m
 \033[92mCreated template file: vfs://root/src/BookStore/templates/book-store/book-store-list.html.twig\033[0m
 
-Allow viewing BookStores? [Y(es)/n(o)]: \033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/GetBookStoreViewHandler.php\033[0m
+Allow viewing BookStores? [Y(es)/n(o)]: \033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/GetViewBookStoreHandler.php\033[0m
 \033[92mCreated template file: vfs://root/src/BookStore/templates/book-store/book-store-view.html.twig\033[0m
 
-Allow creating BookStores? [Y(es)/n(o)]: \033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/GetBookStoreCreateFormHandler.php\033[0m
-\033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/PostBookStoreCreateHandler.php\033[0m
+Allow creating BookStores? [Y(es)/n(o)]: \033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/GetCreateBookStoreFormHandler.php\033[0m
+\033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/PostCreateBookStoreHandler.php\033[0m
 \033[92mCreated Form: vfs://root/src/BookStore/src/Form/CreateBookStoreForm.php\033[0m
 \033[92mCreated InputFilter: vfs://root/src/BookStore/src/InputFilter/CreateBookStoreInputFilter.php\033[0m
 \033[92mCreated template file: vfs://root/src/BookStore/templates/book-store/book-store-create-form.html.twig\033[0m
 
-Allow deleting BookStores? [Y(es)/n(o)]: \033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/GetBookStoreDeleteFormHandler.php\033[0m
-\033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/PostBookStoreDeleteHandler.php\033[0m
+Allow deleting BookStores? [Y(es)/n(o)]: \033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/GetDeleteBookStoreFormHandler.php\033[0m
+\033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/PostDeleteBookStoreHandler.php\033[0m
 \033[92mCreated Form: vfs://root/src/BookStore/src/Form/DeleteBookStoreForm.php\033[0m
 \033[92mCreated InputFilter: vfs://root/src/BookStore/src/InputFilter/DeleteBookStoreInputFilter.php\033[0m
 \033[92mCreated Input: vfs://root/src/BookStore/src/InputFilter/Input/ConfirmDeleteBookStoreInput.php\033[0m
 \033[92mCreated template file: vfs://root/src/BookStore/templates/book-store/book-store-delete-form.html.twig\033[0m
 
-Allow editing BookStores? [Y(es)/n(o)]: \033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/GetBookStoreEditFormHandler.php\033[0m
-\033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/PostBookStoreEditHandler.php\033[0m
+Allow editing BookStores? [Y(es)/n(o)]: \033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/GetEditBookStoreFormHandler.php\033[0m
+\033[92mCreated Handler: vfs://root/src/BookStore/src/Handler/BookStore/PostEditBookStoreHandler.php\033[0m
 \033[92mCreated Form: vfs://root/src/BookStore/src/Form/EditBookStoreForm.php\033[0m
 \033[92mCreated InputFilter: vfs://root/src/BookStore/src/InputFilter/EditBookStoreInputFilter.php\033[0m
 \033[92mCreated template file: vfs://root/src/BookStore/templates/book-store/book-store-edit-form.html.twig\033[0m
@@ -1320,7 +1320,7 @@ private function dataProviderWhenProjectTypeIsNotApiAndDoesNotUseCore(): string
 \033[93m  composer dump\033[0m
 - generate Doctrine migration:
 \033[93m  php ./vendor/bin/doctrine-migrations diff\033[0m
-- \033[91mRun through each new file, verify their content and start adding logic to them.\033[0m
+- \033[91mReview each new file, verify their contents and start adding logic to them.\033[0m
 
 BODY;
         // phpcs:enable Generic.Files.LineLength.TooLong

test/Type/RoutesDelegatorTest.php

@@ -129,14 +129,14 @@ public static function dataProvider(): array
 
 namespace Admin\ModuleName;
 
-use Admin\ModuleName\Handler\BookStore\GetBookStoreCreateFormHandler;
-use Admin\ModuleName\Handler\BookStore\GetBookStoreDeleteFormHandler;
-use Admin\ModuleName\Handler\BookStore\GetBookStoreEditFormHandler;
-use Admin\ModuleName\Handler\BookStore\GetBookStoreListHandler;
-use Admin\ModuleName\Handler\BookStore\GetBookStoreViewHandler;
-use Admin\ModuleName\Handler\BookStore\PostBookStoreCreateHandler;
-use Admin\ModuleName\Handler\BookStore\PostBookStoreDeleteHandler;
-use Admin\ModuleName\Handler\BookStore\PostBookStoreEditHandler;
+use Admin\ModuleName\Handler\BookStore\GetCreateBookStoreFormHandler;
+use Admin\ModuleName\Handler\BookStore\GetDeleteBookStoreFormHandler;
+use Admin\ModuleName\Handler\BookStore\GetEditBookStoreFormHandler;
+use Admin\ModuleName\Handler\BookStore\GetListBookStoreHandler;
+use Admin\ModuleName\Handler\BookStore\GetViewBookStoreHandler;
+use Admin\ModuleName\Handler\BookStore\PostCreateBookStoreHandler;
+use Admin\ModuleName\Handler\BookStore\PostDeleteBookStoreHandler;
+use Admin\ModuleName\Handler\BookStore\PostEditBookStoreHandler;
 use Core\App\ConfigProvider;
 use Dot\Router\RouteCollectorInterface;
 use Mezzio\Application;
@@ -161,14 +161,14 @@ public function __invoke(
         \$routeCollector = \$container->get(RouteCollectorInterface::class);
 
         \$routeCollector
-            ->get('/create-book-store', GetBookStoreCreateFormHandler::class, 'book-store::create-book-store-form')
-            ->post('/create-book-store', PostBookStoreCreateHandler::class, 'book-store::create-book-store')
-            ->get('/delete-book-store/' . \$uuid, GetBookStoreDeleteFormHandler::class, 'book-store::delete-book-store-form')
-            ->post('/delete-book-store/' . \$uuid, PostBookStoreDeleteHandler::class, 'book-store::delete-book-store')
-            ->get('/edit-book-store/' . \$uuid, GetBookStoreEditFormHandler::class, 'book-store::edit-book-store-form')
-            ->post('/edit-book-store/' . \$uuid, PostBookStoreEditHandler::class, 'book-store::edit-book-store')
-            ->get('/list-book-store', GetBookStoreListHandler::class, 'book-store::list-book-store')
-            ->get('/view-book-store/' . \$uuid, GetBookStoreViewHandler::class, 'book-store::view-book-store-form');
+            ->get('/create-book-store', GetCreateBookStoreFormHandler::class, 'book-store::create-book-store-form')
+            ->post('/create-book-store', PostCreateBookStoreHandler::class, 'book-store::create-book-store')
+            ->get('/delete-book-store/' . \$uuid, GetDeleteBookStoreFormHandler::class, 'book-store::delete-book-store-form')
+            ->post('/delete-book-store/' . \$uuid, PostDeleteBookStoreHandler::class, 'book-store::delete-book-store')
+            ->get('/edit-book-store/' . \$uuid, GetEditBookStoreFormHandler::class, 'book-store::edit-book-store-form')
+            ->post('/edit-book-store/' . \$uuid, PostEditBookStoreHandler::class, 'book-store::edit-book-store')
+            ->get('/list-book-store', GetListBookStoreHandler::class, 'book-store::list-book-store')
+            ->get('/view-book-store/' . \$uuid, GetViewBookStoreHandler::class, 'book-store::view-book-store-form');
 
         return \$callback();
     }