Merge pull request #88 from samsonasik/v5

[Version 5] Remove laminas-mvc-console support, add support laminas-cli

Author: samsonasik

.github/workflows/ci_build.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        php-versions: ['8.0', '8.1']
+        php-versions: ['8.1']
     steps:
       - name: Setup PHP Action
         uses: shivammathur/setup-php@v2
@@ -38,7 +38,7 @@ jobs:
         run: "composer cs-check"
       - name: "Code analyze"
         run: |
-          bin/phpstan analyse src/ --level=max -c phpstan.neon
+          composer phpstan
           bin/rector process --dry-run
       - name: "Run test suite"
         run: |

README.md

@@ -7,13 +7,9 @@ ErrorHeroModule
 [![PHPStan](https://img.shields.io/badge/style-level%20max-brightgreen.svg?style=flat-square&label=phpstan)](https://github.com/phpstan/phpstan)
 [![Downloads](https://poser.pugx.org/samsonasik/error-hero-module/downloads)](https://packagist.org/packages/samsonasik/error-hero-module)
 
-> This is README for version ^4.0 which only support Laminas Mvc version 3 and Mezzio version 3 with php ^8.0.
+> This is README for version ^5.0 which only support Laminas Mvc version 3 and Mezzio version 3 with php ^8.1.
 
-> For version ^3.0, you can read at [version 3 readme](https://github.com/samsonasik/ErrorHeroModule/tree/3.x.x) which only support Laminas Mvc version 3 and Mezzio version 3 with php ^7.1.
-
-> For version ^2.0, you can read at [version 2 readme](https://github.com/samsonasik/ErrorHeroModule/tree/2.x.x) which only support ZF3 and ZF Expressive version 3 with php ^7.1.
-
-> For version 1, you can read at [version 1 readme](https://github.com/samsonasik/ErrorHeroModule/tree/1.x.x) which still support ZF2 and ZF Expressive version 1 and 2 with php ^5.6|^7.0 support.
+> For version ^4.0, you can read at [version 4 readme](https://github.com/samsonasik/ErrorHeroModule/tree/4.x.x) which only support Laminas Mvc version 3 and Mezzio version 3 with php ^8.0.
 
 Introduction
 ------------
@@ -351,29 +347,50 @@ You will get the following page if display_errors config is 0:
 
 ![error preview in web](https://cloud.githubusercontent.com/assets/459648/21668589/d4fdadac-d335-11e6-95aa-5a8cfa3f8e4b.png)
 
-> For production env, you can disable error-preview sample page with set `['error-hero-module']['enable-error-preview-page']` to false.
-
 _**Console Access**_
 
-> If you use laminas-mvc v3, you need to have `laminas/laminas-mvc-console` in your vendor, if you don't have, you can install it via command:
+> You can use this module in `laminas-cli`, you can install:
 
 > ```sh
-> composer require laminas/laminas-mvc-console --sort-packages
+> composer require laminas/laminas-cli --sort-packages
 > ```
 
-| Command                                    | Preview For   |
-|--------------------------------------------|---------------|
-| php public/index.php error-preview         | Exception     |
-| php public/index.php error-preview error   | Error         |
-| php public/index.php error-preview warning | PHP E_WARNING |
+then you can see the error-preview console:
+
+| Command                                            | Preview For   |
+|----------------------------------------------------|---------------|
+| vendor/bin/laminas errorheromodule:preview         | Exception     |
+| vendor/bin/laminas errorheromodule:preview error   | Error         |
+| vendor/bin/laminas errorheromodule:preview warning | PHP E_WARNING |
+| vendor/bin/laminas errorheromodule:preview fatal   | PHP Fatal     |
 
 You will get the following page if display_errors config is 0:
 
-![error preview in console](https://cloud.githubusercontent.com/assets/459648/21669141/8e7690f0-d33b-11e6-99c7-eed4f1ab7edb.png)
+![error preview in console](https://user-images.githubusercontent.com/459648/206882602-5f2e5ab0-86d6-4694-9a3c-c7b8896596fa.png))
 
-> For production env, you can disable error-preview sample page with set `['error-hero-module']['enable-error-preview-page']` to false.
+You can use the error handling in your console application, by extends `BaseLoggingCommand`, like below:
+
+```php
+namespace Application\Command;
 
-> For Mezzio, there is no default console implementation, so, if you want to apply it in your console in Mezzio, you may need to custom implementation error handler that utilize `ErrorHeroModule\Handler\Logging` service (see detailed usage at `ErrorHeroModule\Middleware\Mezzio` class)
+use ErrorHeroModule\Command\BaseLoggingCommand;
+use Exception;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+
+final class HelloWorld extends BaseLoggingCommand
+{
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        throw new Exception('some exception logged to DB');
+    }
+}
+```
+
+and register to your services like in the [documentation](https://docs.laminas.dev/laminas-cli/intro/).
+
+> For production env, you can disable error-preview sample page with set `['error-hero-module']['enable-error-preview-page']` to false.
 
 Contributing
 ------------

composer.json

@@ -36,46 +36,45 @@
         }
     ],
     "require": {
-        "php": "^8.0",
-        "laminas/laminas-db": "^2.12",
-        "laminas/laminas-diactoros": "^2.5",
-        "laminas/laminas-log": "^2.13",
-        "laminas/laminas-mail": "^2.13",
-        "laminas/laminas-psr7bridge": "^1.3",
-        "laminas/laminas-text": "^2.8",
-        "laminas/laminas-uri": "^2.8",
-        "psr/container": "^1.0 || 2.0",
-        "seld/jsonlint": "^1.8",
-        "webmozart/assert": "^1.9.1"
+        "php": "^8.1",
+        "laminas/laminas-db": "^2.15",
+        "laminas/laminas-diactoros": "^2.14",
+        "laminas/laminas-log": "^2.15.2",
+        "laminas/laminas-mail": "^2.17",
+        "laminas/laminas-psr7bridge": "^1.6",
+        "laminas/laminas-uri": "^2.9.1",
+        "psr/container": "^1.1.2 || 2.0",
+        "seld/jsonlint": "^1.9",
+        "webmozart/assert": "^1.11"
     },
     "conflict": {
         "doctrine/dbal": "<3.0",
         "doctrine/doctrine-orm-module": "<4.1",
         "laminas/laminas-mvc": "<3.2 >=4.0",
         "laminas/laminas-servicemanager": "<3.10",
-        "mezzio/mezzio": "<3.3 >=4.0"
+        "mezzio/mezzio": "<3.3 >=4.0",
+        "laminas/laminas-mvc-console": "*"
     },
     "require-dev": {
-        "aura/di": "^3.4 || ^4.0",
-        "doctrine/dbal": "^3.0",
-        "doctrine/doctrine-orm-module": "^4.1",
-        "kahlan/kahlan": "^5.2.0",
-        "laminas/laminas-coding-standard": "^2.1.1",
-        "laminas/laminas-form": "^2.16 || ^3.0",
-        "laminas/laminas-mvc": "^3.2",
-        "laminas/laminas-mvc-console": "^1.1",
-        "laminas/laminas-servicemanager": "^3.10",
-        "mezzio/mezzio": "^3.3",
-        "mezzio/mezzio-laminasviewrenderer": "^2.3",
-        "php-coveralls/php-coveralls": "^2.4",
-        "phpstan/phpstan": "^1.6.7",
-        "phpstan/phpstan-webmozart-assert": "^1.0",
-        "pimple/pimple": "^3.2",
+        "aura/di": "^3.4 || ^4.2.1",
+        "doctrine/dbal": "^3.4",
+        "doctrine/doctrine-orm-module": "^4.2.1",
+        "kahlan/kahlan": "^5.2.1",
+        "laminas/laminas-cli": "^1.5",
+        "laminas/laminas-coding-standard": "^2.3",
+        "laminas/laminas-form": "^2.16 || ^3.4.1",
+        "laminas/laminas-mvc": "^3.3.3",
+        "laminas/laminas-servicemanager": "^3.16",
+        "mezzio/mezzio": "^3.11",
+        "mezzio/mezzio-laminasviewrenderer": "^2.6",
+        "php-coveralls/php-coveralls": "^2.5.2",
+        "phpstan/phpstan": "^1.8.2",
+        "phpstan/phpstan-webmozart-assert": "^1.2",
+        "pimple/pimple": "^3.5",
         "rector/rector": "dev-main",
-        "symfony/dependency-injection": "^5.0"
+        "symfony/dependency-injection": "^5.4.11"
     },
     "suggest": {
-        "laminas/laminas-mvc-console": "^1.1 for laminas-mvc ^3.0 usage to be able to use Console Controller",
         "mezzio/mezzio-laminasviewrenderer": "^2.0 to be able to use laminas-view template engine in mezzio ^3.0",
         "mezzio/mezzio-platesrenderer": "^2.0 to be able to use plates template engine in mezzio ^3.0",
         "mezzio/mezzio-twigrenderer": "^2.0 to be able to use twig template engine in mezzio ^3.0"
@@ -114,6 +113,7 @@
     "prefer-stable": true,
     "scripts": {
         "cs-check": "phpcs",
-        "cs-fix": "phpcbf"
+        "cs-fix": "phpcbf",
+        "phpstan": "phpstan analyse src/ --level=max -c phpstan.neon"
     }
 }

config/error-hero-module.local.php.dist

@@ -1,5 +1,6 @@
 <?php
 
+use App\Exception\MyException;
 use Laminas\Db\Adapter\AdapterInterface;
 
 return [
@@ -68,13 +69,13 @@ return [
             'exclude-exceptions' => [
 
                 // can be an Exception class or class extends Exception class
-                \App\Exception\MyException::class,
+                MyException::class,
 
                 // can be specific exception with specific message
-                [\RuntimeException::class, 'specific exception message'],
+                [RuntimeException::class, 'specific exception message'],
 
                 // or specific Error class with specific message
-                [\Error::class, 'specific error message'],
+                [Error::class, 'specific error message'],
 
             ],
 

config/mezzio-error-hero-module.local.php.dist

@@ -2,8 +2,20 @@
 
 namespace ErrorHeroModule;
 
+use App\Exception\MyException;
+use RuntimeException;
+use Error;
+use ErrorHeroModule\Command\BaseLoggingCommandInitializer;
+use ErrorHeroModule\Middleware\Mezzio;
+use ErrorHeroModule\Middleware\MezzioFactory;
+use ErrorHeroModule\ErrorHeroModule\Middleware\Routed\Preview\ErrorPreviewAction;
+use ErrorHeroModule\Handler\Logging;
+use ErrorHeroModule\Handler\LoggingFactory;
+use ErrorHeroModule\Command\BaseLoggingCommand;
+use ErrorHeroModule\Command\Preview\ErrorPreviewConsoleCommand;
 use Laminas\Db\Adapter\AdapterInterface;
 use Laminas\Log;
+use Laminas\Log\LoggerAbstractServiceFactory;
 use Laminas\ServiceManager\Factory\InvokableFactory;
 
 return [
@@ -64,13 +76,13 @@ return [
             'exclude-exceptions' => [
 
                 // can be an Exception class or class extends Exception class
-                \App\Exception\MyException::class,
+                MyException::class,
 
                 // can be specific exception with specific message
-                [\RuntimeException::class, 'specific exception message'],
+                [RuntimeException::class, 'specific exception message'],
 
                 // or specific Error class with specific message
-                [\Error::class, 'specific error message'],
+                [Error::class, 'specific error message'],
 
             ],
 
@@ -141,20 +153,31 @@ json
 
     'dependencies' => [
         'abstract_factories' => [
-            Log\LoggerAbstractServiceFactory::class,
+            LoggerAbstractServiceFactory::class,
         ],
         'factories' => [
-            Middleware\Mezzio::class => Middleware\MezzioFactory::class,
-            ErrorHeroModule\Middleware\Routed\Preview\ErrorPreviewAction::class => InvokableFactory::class,
+            Mezzio::class => MezzioFactory::class,
+            ErrorPreviewAction::class => InvokableFactory::class,
 
-            Handler\Logging::class => Handler\LoggingFactory::class,
+            Logging::class => LoggingFactory::class,
+
+            ErrorPreviewConsoleCommand::class => InvokableFactory::class,
+        ],
+        'initializers' => [
+            BaseLoggingCommandInitializer::class,
+        ],
+    ],
+
+    'laminas-cli' => [
+        'commands' => [
+            'errorheromodule:preview' => ErrorPreviewConsoleCommand::class,
         ],
     ],
 
     'templates' =>[
         'paths' => [
             'error-hero-module'    => [
-                realpath( dirname(dirname(__DIR__) ) . '/vendor/samsonasik/error-hero-module/view/error-hero-module' ),
+                realpath( dirname(__DIR__, 2) . '/vendor/samsonasik/error-hero-module/view/error-hero-module' ),
             ],
         ],
     ],

config/module.config.php

@@ -2,8 +2,9 @@
 
 namespace ErrorHeroModule;
 
+use ErrorHeroModule\Command\BaseLoggingCommandInitializer;
+use ErrorHeroModule\Command\Preview\ErrorPreviewConsoleCommand;
 use ErrorHeroModule\Controller\ErrorPreviewController;
-use ErrorHeroModule\Controller\ErrorPreviewConsoleController;
 use Laminas\Log\LoggerAbstractServiceFactory;
 use ErrorHeroModule\Listener\Mvc;
 use ErrorHeroModule\Listener\MvcFactory;
@@ -16,7 +17,6 @@
     'controllers' => [
         'factories' => [
             ErrorPreviewController::class           => InvokableFactory::class,
-            ErrorPreviewConsoleController::class    => InvokableFactory::class,
         ],
     ],
 
@@ -37,36 +37,30 @@
         ],
     ],
 
-    'console' => [
-        'router' => [
-            'routes' => [
-                'error-preview-console' => [
-                    'options' => [
-                        'route'    => 'error-preview [<action>]',
-                        'defaults' => [
-                            'controller' => ErrorPreviewConsoleController::class,
-                            'action'     => 'exception'
-                        ],
-                    ],
-                ],
-            ],
-        ],
-    ],
-
     'service_manager' => [
         'abstract_factories' => [
             LoggerAbstractServiceFactory::class,
         ],
         'factories' => [
             Mvc::class    => MvcFactory::class,
             Logging::class => LoggingFactory::class,
+            ErrorPreviewConsoleCommand::class => InvokableFactory::class,
+        ],
+        'initializers' => [
+            BaseLoggingCommandInitializer::class,
         ],
     ],
 
     'listeners' => [
         Mvc::class,
     ],
 
+    'laminas-cli' => [
+        'commands' => [
+            'errorheromodule:preview' => ErrorPreviewConsoleCommand::class,
+        ],
+    ],
+
     'view_manager' => [
         'template_map' => [
            'error-hero-module/error-default' => __DIR__.'/../view/error-hero-module/error-default.phtml',

kahlan-config.php

@@ -5,7 +5,6 @@
 use Kahlan\Reporter\Coverage\Driver\Xdebug;
 
 // autoload hack
-file_put_contents('vendor/laminas/laminas-zendframework-bridge/src/autoload.php', '');
 class_alias(Laminas\ServiceManager\AbstractPluginManager::class, Zend\ServiceManager\AbstractPluginManager::class);
 
 Filters::apply($this, 'coverage', function($next) {
@@ -19,8 +18,13 @@ class_alias(Laminas\ServiceManager\AbstractPluginManager::class, Zend\ServiceMan
         'driver'    => new Xdebug(),
         'path'      => $this->commandLine()->get('src'),
         'exclude'   => [
-            'src/Controller/ErrorPreviewConsoleController.php',
+            // laminas-cli preview console command
+            'src/Command/Preview/ErrorPreviewConsoleCommand.php',
+
+            // laminas-mvc preview page
             'src/Controller/ErrorPreviewController.php',
+
+            // mezzio preview page
             'src/Middleware/Routed/Preview/ErrorPreviewAction.php',
         ],
         'colors'    => ! $this->commandLine()->get('no-colors')

phpstan.neon

@@ -3,12 +3,14 @@ includes:
 
 parameters:
 	excludePaths:
-		- src/Controller/ErrorPreviewConsoleController.php
+		- src/Command/Preview/ErrorPreviewConsoleCommand.php
 		- src/Controller/ErrorPreviewController.php
 		- src/Middleware/Routed/Preview/ErrorPreviewAction.php
 	checkMissingIterableValueType: false
 	reportUnmatchedIgnoredErrors: false
 	treatPhpDocTypesAsCertain: false
+	checkGenericClassInNonGenericObjectType: false
 	ignoreErrors:
 		- '#function set_error_handler expects (callable(int, string, string, int, array): bool)*#'
 		- '#Invalid type object to throw#'
+		- '#Cannot call method getBody\(\) on int#'