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

apply zend coding standard

Author: samsonasik

.gitattributes

@@ -3,4 +3,5 @@
 /.travis.yml export-ignore
 /.coveralls.yml export-ignore
 /spec/ export-ignore
-/CONTRIBUTING.md export-ignore
+/CONTRIBUTING.md export-ignore
+/phpcs.xml export-ignore

.travis.yml

@@ -12,6 +12,7 @@ before_script:
   - composer dump-autoload -o
 
 script:
+  - composer cs-check
   - bin/phpstan analyse src/ --level=max
   - bin/kahlan --coverage=4 --reporter=verbose --clover=build/logs/clover.xml
   - bin/php-coveralls -v --exclude-no-stmt

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

@@ -38,6 +38,7 @@
         "php-coveralls/php-coveralls": "^2.1",
         "phpstan/phpstan": "^0.10.8",
         "phpstan/phpstan-webmozart-assert": "^0.10.0",
+        "zendframework/zend-coding-standard": "^1.0",
         "zendframework/zend-expressive": "^3.0",
         "zendframework/zend-mvc": "^3.0"
     },
@@ -59,5 +60,9 @@
         "psr-4": {
             "ForceHttpsModule\\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/HttpsTrait.php

@@ -55,10 +55,9 @@ private function isGoingToBeForcedToHttps($match = null) : bool
      * Check if Setup Strict-Transport-Security need to be skipped.
      *
      * @param RouteMatch|RouteResult|null $match
-     * @param Response|ResponseInterface  $response
      *
      */
-    private function isSkippedHttpStrictTransportSecurity(string $uriScheme, $match = null, $response) : bool
+    private function isSkippedHttpStrictTransportSecurity(string $uriScheme, $match = null) : bool
     {
         return ! $this->isSchemeHttps($uriScheme) ||
             ! $this->isGoingToBeForcedToHttps($match) ||

src/Listener/ForceHttps.php

@@ -36,15 +36,21 @@ public function attach(EventManagerInterface $events, $priority = 1) : void
         $this->listeners[] = $events->attach(MvcEvent::EVENT_DISPATCH_ERROR, [$this, 'forceHttpsScheme'], 1000);
     }
 
-    private function setHttpStrictTransportSecurity(string $uriScheme, RouteMatch $match = null, Response $response) : Response
-    {
-        if ($this->isSkippedHttpStrictTransportSecurity($uriScheme, $match, $response)) {
+    private function setHttpStrictTransportSecurity(
+        string     $uriScheme,
+        Response   $response,
+        RouteMatch $match = null
+    ) : Response {
+        if ($this->isSkippedHttpStrictTransportSecurity($uriScheme, $match)) {
             return $response;
         }
 
         if ($this->config['strict_transport_security']['enable'] === true) {
             $response->getHeaders()
-                     ->addHeaderLine('Strict-Transport-Security: ' . $this->config['strict_transport_security']['value']);
+                     ->addHeaderLine(sprintf(
+                         'Strict-Transport-Security: %s',
+                         $this->config['strict_transport_security']['value']
+                     ));
             return $response;
         }
 
@@ -70,7 +76,7 @@ public function forceHttpsScheme(MvcEvent $e) : void
 
         /** @var RouteMatch|null $routeMatch */
         $routeMatch = $e->getRouteMatch();
-        $response   = $this->setHttpStrictTransportSecurity($uriScheme, $routeMatch, $response);
+        $response   = $this->setHttpStrictTransportSecurity($uriScheme, $response, $routeMatch);
         if (! $this->isGoingToBeForcedToHttps($routeMatch)) {
             return;
         }

src/Middleware/ForceHttps.php

@@ -28,14 +28,20 @@ public function __construct(array $config, RouterInterface $router)
         $this->router = $router;
     }
 
-    private function setHttpStrictTransportSecurity($uriScheme, RouteResult $match, ResponseInterface $response) : ResponseInterface
-    {
-        if ($this->isSkippedHttpStrictTransportSecurity($uriScheme, $match, $response)) {
+    private function setHttpStrictTransportSecurity(
+        string            $uriScheme,
+        ResponseInterface $response,
+        RouteResult       $match
+    ) : ResponseInterface {
+        if ($this->isSkippedHttpStrictTransportSecurity($uriScheme, $match)) {
             return $response;
         }
 
         if ($this->config['strict_transport_security']['enable'] === true) {
-            return $response->withHeader('Strict-Transport-Security', $this->config['strict_transport_security']['value']);
+            return $response->withHeader(
+                'Strict-Transport-Security',
+                $this->config['strict_transport_security']['value']
+            );
         }
 
         return $response->withHeader('Strict-Transport-Security', 'max-age=0');
@@ -53,7 +59,7 @@ public function process(ServerRequestInterface $request, RequestHandlerInterface
         $uri       = $request->getUri();
         $uriScheme = $uri->getScheme();
 
-        $response = $this->setHttpStrictTransportSecurity($uriScheme, $match, $response);
+        $response = $this->setHttpStrictTransportSecurity($uriScheme, $response, $match);
         if (! $this->isGoingToBeForcedToHttps($match)) {
             return $response;
         }