Merge pull request #66 from samsonasik/apply-zend-coding-standard

Apply zend coding standard

Author: samsonasik

.gitattributes

@@ -6,4 +6,5 @@
 /phpstan.neon export-ignore
 /spec/ export-ignore
 /CONTRIBUTING.md export-ignore
-/kahlan-config.php export-ignore
+/kahlan-config.php export-ignore
+/phpcs.xml export-ignore

.travis.yml

@@ -17,6 +17,7 @@ before_script:
   - composer dump-autoload -o
 
 script:
+  - composer cs-check
   - if [[ $TRAVIS_PHP_VERSION = 7.1 ]]; then bin/phpstan analyse src/ --level=max -c phpstan.neon; fi
   - if [[ $TRAVIS_PHP_VERSION != "nightly" ]]; then bin/kahlan --coverage=4 --reporter=verbose --clover=build/logs/clover.xml; fi
   - if [[ $TRAVIS_PHP_VERSION = "nightly" ]]; then bin/kahlan; fi

CONTRIBUTING.md

@@ -3,7 +3,7 @@ CONTRIBUTING
 To contribute, you can send pull requests with :
 
 - Typo fix.
-- Use PSR-2 Coding Standard.
+- Use [Zend Coding Standard](https://github.com/zendframework/zend-coding-standard).
 - patch(es) need new/updated test(s).
 - new feature(s) need test(s).
 

composer.json

@@ -67,6 +67,7 @@
         "phpstan/phpstan-webmozart-assert": "^0.10.0",
         "pimple/pimple": "^3.2",
         "symfony/dependency-injection": "^4.0",
+        "zendframework/zend-coding-standard": "^1.0",
         "zendframework/zend-expressive": "^3.0",
         "zendframework/zend-expressive-zendviewrenderer": "^2.0",
         "zendframework/zend-mvc": "^3.0",
@@ -100,5 +101,9 @@
         "psr-4": {
             "ErrorHeroModule\\Spec\\": "spec/"
         }
+    },
+    "scripts": {
+        "cs-check": "phpcs",
+        "cs-fix": "phpcbf"
     }
 }

phpcs.xml

@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+<ruleset name="Zend Framework Coding Standard">
+    <rule ref="./vendor/zendframework/zend-coding-standard/ruleset.xml"/>
+
+    <!-- Paths to check -->
+    <file>src</file>
+</ruleset>

src/Controller/ErrorPreviewController.php

@@ -26,6 +26,7 @@ public function noticeAction()
 
     public function fatalAction()
     {
-        $y = new class implements \stdClass {};
+        $y = new class implements \stdClass {
+        };
     }
 }

src/Handler/Logging.php

@@ -75,13 +75,22 @@ public function __construct(
     /**
      * @throws RuntimeException when cannot connect to DB in the first place
      */
-    private function isExists(string $errorFile, int $errorLine, string $errorMessage, string $url, string $errorType) : bool
-    {
+    private function isExists(
+        string $errorFile,
+        int    $errorLine,
+        string $errorMessage,
+        string $url,
+        string $errorType
+    ) : bool {
         $writers = $this->logger->getWriters()->toArray();
         foreach ($writers as $writer) {
             if ($writer instanceof Db) {
                 try {
-                    $handlerWriterDb = new Writer\Checker\Db($writer, $this->configLoggingSettings, $this->logWritersConfig);
+                    $handlerWriterDb = new Writer\Checker\Db(
+                        $writer,
+                        $this->configLoggingSettings,
+                        $this->logWritersConfig
+                    );
                     if ($handlerWriterDb->isExists($errorFile, $errorLine, $errorMessage, $url, $errorType)) {
                         return true;
                     }
@@ -212,14 +221,13 @@ public function handleErrorException(Throwable $t, RequestInterface $request) :
         $serverUrl              = $extra['server_url'];
 
         try {
-            if (
-                $this->isExists(
-                    $collectedExceptionData['errorFile'],
-                    $collectedExceptionData['errorLine'],
-                    $collectedExceptionData['errorMessage'],
-                    $extra['url'],
-                    $collectedExceptionData['errorType']
-                )
+            if ($this->isExists(
+                $collectedExceptionData['errorFile'],
+                $collectedExceptionData['errorLine'],
+                $collectedExceptionData['errorMessage'],
+                $extra['url'],
+                $collectedExceptionData['errorType']
+            )
             ) {
                 return;
             }
@@ -232,6 +240,11 @@ public function handleErrorException(Throwable $t, RequestInterface $request) :
             unset($extra['server_url']);
         }
 
-        $this->sendMail($collectedExceptionData['priority'], $collectedExceptionData['errorMessage'], $extra, '['.$serverUrl.'] '.$collectedExceptionData['errorType'].' has thrown');
+        $this->sendMail(
+            $collectedExceptionData['priority'],
+            $collectedExceptionData['errorMessage'],
+            $extra,
+            '[' . $serverUrl . '] ' . $collectedExceptionData['errorType'] . ' has thrown'
+        );
     }
 }

src/Handler/LoggingFactory.php

@@ -12,8 +12,8 @@
 class LoggingFactory
 {
     /**
-     * @throws RuntimeException when mail config is enabled but mail-message config is not a service instance of Message
-     * @throws RuntimeException when mail config is enabled but mail-transport config is not a service instance of TransportInterface
+     * @throws RuntimeException when mail config is enabled
+     * but mail-message and/or mail-transport config is not a service instance of Message
      */
     public function __invoke(ContainerInterface $container) : Logging
     {
@@ -30,12 +30,18 @@ public function __invoke(ContainerInterface $container) : Logging
         if ($mailConfig['enable'] === true) {
             $mailMessageService   = $container->get($mailConfig['mail-message']);
             if (! $mailMessageService instanceof Message) {
-                throw new RuntimeException('You are enabling email log writer, your "mail-message" config must be instanceof '.Message::class);
+                throw new RuntimeException(sprintf(
+                    'You are enabling email log writer, your "mail-message" config must be instanceof %s',
+                    Message::class
+                ));
             }
 
             $mailMessageTransport = $container->get($mailConfig['mail-transport']);
             if (! $mailMessageTransport instanceof TransportInterface) {
-                throw new RuntimeException('You are enabling email log writer, your "mail-transport" config must implements '.TransportInterface::class);
+                throw new RuntimeException(sprintf(
+                    'You are enabling email log writer, your "mail-transport" config must implements %s',
+                    TransportInterface::class
+                ));
             }
         }
 

src/Handler/Writer/Checker/Db.php

@@ -36,8 +36,13 @@ public function __construct(
         $this->logWritersConfig      = $logWritersConfig;
     }
 
-    public function isExists(string $errorFile, int $errorLine, string $errorMessage, string $errorUrl, string $errorType) : bool
-    {
+    public function isExists(
+        string $errorFile,
+        int    $errorLine,
+        string $errorMessage,
+        string $errorUrl,
+        string $errorType
+    ) : bool {
         // db definition
         $db = Closure::bind(function ($dbWriter) {
             return $dbWriter->db;

src/HeroFunction.php

@@ -11,4 +11,4 @@ function detectMessageContentType(string $message) : string
     return (new JsonParser())->lint($message) === null
         ? 'application/problem+json'
         : ((\strip_tags($message) === $message) ? 'text/plain' : 'text/html');
-}
+}