Apply Woohoo Labs. Coding Standard

woohoolabs · Dec 21, 2018 · 49f7387 · 49f7387
1 parent 3bafdd7
commit 49f7387
Show file tree

Hide file tree

Showing 12 changed files with 34 additions and 44 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -6,6 +6,7 @@
 .editorconfig export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore
+.phpcs-cache export-ignore
 .scrutinizer.yml export-ignore
 .travis.yml export-ignore
 phpcs.xml export-ignore

diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 vendor/
+.phpcs-cache
 composer.lock
 phpunit.xml
diff --git a/.prettyci.composer.json b/.prettyci.composer.json
@@ -0,0 +1,5 @@
+{
+    "require-dev": {
+        "woohoolabs/coding-standard": "dev-master as 1.0.0"
+    }
+}
diff --git a/.styleci.yml b/.styleci.yml
diff --git a/Makefile b/Makefile
@@ -21,15 +21,7 @@ test:
 	docker-compose up
 
 cs:
-	docker-compose run php /var/www/vendor/bin/phpcs \
-	    --standard=/var/www/phpcs.xml \
-	    --encoding=UTF-8 \
-	    --report-full \
-	    --extensions=php \
-	   /var/www/src/ /var/www/tests/
+	docker-compose run --rm php /var/www/vendor/bin/phpcs --standard=/var/www/phpcs.xml
 
 cs-fix:
-	docker-compose run php /var/www/vendor/bin/phpcbf \
-	    --standard=/var/www/phpcs.xml \
-	    --extensions=php \
-	   /var/www/src/ /var/www/tests/
+	docker-compose run --rm php /var/www/vendor/bin/phpcbf --standard=/var/www/phpcs.xml
diff --git a/composer.json b/composer.json
@@ -25,7 +25,8 @@
         "justinrainbow/json-schema": "^5.2.0",
         "phpunit/phpunit": "^7.0.0",
         "seld/jsonlint": "^1.4.0",
-        "squizlabs/php_codesniffer": "^3.3.0",
+        "squizlabs/php_codesniffer": "^3.4.0",
+        "woohoolabs/coding-standard": "dev-master as 1.0.0",
         "zendframework/zend-diactoros": "^2.0.0"
     },
     "autoload": {

diff --git a/phpcs.xml b/phpcs.xml
@@ -1,23 +1,21 @@
 <?xml version="1.0"?>
-<ruleset name="Woohoo Labs. Coding Standard">
-    <description>Woohoo Labs. Coding Standard</description>
+<ruleset name="Yin-Middleware" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd">
+    <description>PHP Coding Standards for Yin-Middleware</description>
 
-    <!-- Options -->
-    <arg value="p"/>
-    <arg name="colors"/>
+    <arg name="basepath" value="."/>
+    <arg name="cache" value=".phpcs-cache"/>
+    <arg name="colors" />
+    <arg name="encoding" value="UTF-8"/>
+    <arg name="extensions" value="php"/>
+    <arg name="parallel" value="80"/>
+    <arg name="report" value="code"/>
+    <arg name="report-width" value="160"/>
 
-    <!-- Rules -->
-    <rule ref="PSR12"/>
-    <rule ref="Generic.Arrays.DisallowLongArraySyntax"/>
-    <rule ref="Generic.Files.LineLength">
-        <properties>
-            <property name="lineLimit" value="150"/>
-            <property name="absoluteLineLimit" value="160"/>
-        </properties>
-    </rule>
+    <!-- Show progress of the run -->
+    <arg value="nps"/>
 
-    <!-- Paths -->
-    <file>examples</file>
-    <file>src</file>
-    <file>tests</file>
+    <file>src/</file>
+    <file>tests/</file>
+
+    <rule ref="WoohooLabs"/>
 </ruleset>
diff --git a/src/Middleware/JsonApiDispatcherMiddleware.php b/src/Middleware/JsonApiDispatcherMiddleware.php
@@ -15,6 +15,9 @@
 use WoohooLabs\Yin\JsonApi\Serializer\JsonSerializer;
 use WoohooLabs\Yin\JsonApi\Serializer\SerializerInterface;
 use WoohooLabs\YinMiddleware\Exception\JsonApiRequestException;
+use function is_array;
+use function is_callable;
+use function is_string;
 
 class JsonApiDispatcherMiddleware implements MiddlewareInterface
 {

diff --git a/src/Middleware/JsonApiResponseValidatorMiddleware.php b/src/Middleware/JsonApiResponseValidatorMiddleware.php
@@ -22,7 +22,7 @@ class JsonApiResponseValidatorMiddleware extends JsonApiMessageValidator impleme
 
     public function __construct(
         ?ExceptionFactoryInterface $exceptionFactory = null,
-        SerializerInterface $serializer = null,
+        ?SerializerInterface $serializer = null,
         bool $includeOriginalMessageInResponse = true,
         bool $lintBody = true,
         bool $validateBody = true

diff --git a/tests/Middleware/JsonApiErrorHandlerMiddlewareTest.php b/tests/Middleware/JsonApiErrorHandlerMiddlewareTest.php
@@ -14,6 +14,7 @@
 use WoohooLabs\YinMiddleware\Tests\Utils\DummyException;
 use Zend\Diactoros\Response;
 use Zend\Diactoros\ServerRequest;
+use function json_decode;
 
 class JsonApiErrorHandlerMiddlewareTest extends TestCase
 {

diff --git a/tests/Utils/DummyException.php b/tests/Utils/DummyException.php
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 namespace WoohooLabs\YinMiddleware\Tests\Utils;
 

diff --git a/tests/Utils/FakeController.php b/tests/Utils/FakeController.php
@@ -1,4 +1,5 @@
 <?php
+declare(strict_types=1);
 
 namespace WoohooLabs\YinMiddleware\Tests\Utils;