Merge pull request #212 from MarcinOrlowski/dev

Improved Github Actions

Author: MarcinOrlowski

.github/workflows/coding-standards.yml

@@ -17,9 +17,6 @@ on:
   push:
     branches:
     - "master"
-  pull_request:
-    branches:
-    - "master"
     - "dev"
 
 jobs:
@@ -50,10 +47,6 @@ jobs:
           php_version: "${{ matrix.php }}"
           dev: yes
 
-      - name: "Checking coding standards for 'src/'..."
-        shell: bash
-        run: vendor/bin/phpcs -s --basepath="$(pwd)" --standard="vendor/marcin-orlowski/coding-standard/coding-standard/MarcinOrlowski/" "src/"
-
-      - name: "Checking coding standards for 'tests/'..."
+      - name: "Checking Coding Standards..."
         shell: bash
-        run: vendor/bin/phpcs -s --basepath="$(pwd)" --standard="vendor/marcin-orlowski/coding-standard/coding-standard/MarcinOrlowski/" "tests/"
+        run: vendor/bin/phpcs

.scrutinizer.yml

@@ -56,11 +56,11 @@ Development branch:
  * [Easy to use](docs/examples.md#usage-examples),
  * [Stable and production ready](https://travis-ci.org/MarcinOrlowski/laravel-api-response-builder),
  * [On-the-fly data object conversion](docs/conversion.md),
- * API chaining support,
+ * [API chaining support](docs/docs.md#code-ranges),
  * [Localization support](docs/docs.md#messages-and-localization),
  * Provides traits to help [unit test your API code](docs/testing.md),
  * Comes with [exception handler helper](docs/exceptions.md) to ensure your API stays consumable even in case of unexpected,
- * No additional dependencies.
+ * [No additional dependencies](src/composer.json).
 
 
 ## License ##

README.md

@@ -10,6 +10,9 @@
  * @copyright 2016-2021 Marcin Orlowski
  * @license   http://www.opensource.org/licenses/mit-license.php MIT
  * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
+ *
+ * @noinspection PhpCSValidationInspection
+ * phpcs:disable Squiz.PHP.CommentedOutCode.Found
  */
 
 return [

config/response_builder.php

@@ -0,0 +1,31 @@
+<?xml version="1.0"?>
+<!--
+ * Laravel API Response Builder - PHP Code Sniffer config file
+ *
+ * @author    Marcin Orlowski <mail (#) marcinOrlowski (.) com>
+ * @copyright 2016-2021 Marcin Orlowski
+ * @license   http://www.opensource.org/licenses/mit-license.php MIT
+ * @link      https://github.com/MarcinOrlowski/laravel-api-response-builder
+ *
+ -->
+<ruleset name="Custom Standard" namespace="MyProject\CS\Standard">
+
+    <!-- what to sniff -->
+    <file>src/</file>
+    <file>tests/</file>
+    <file>config/</file>
+
+    <!-- let's make shown paths relative -->
+    <arg name="basepath" value="."/>
+
+    <arg name="report" value="full"/>
+
+    <!-- Include full Sniff name in report (like -s) -->
+    <arg value="s"/>
+
+    <autoload>vendor/autoload.php</autoload>
+
+    <!-- import rules from MarcinOrlowski/coding-standard package -->
+    <rule ref="vendor/marcin-orlowski/coding-standard/coding-standard/MarcinOrlowski/"/>
+
+</ruleset>

phpcs.xml

@@ -34,7 +34,7 @@ final class ArrayableConverter implements ConverterContract
 	 *
 	 * phpcs:disable Generic.CodeAnalysis.UnusedFunctionParameter.FoundInImplementedInterfaceAfterLastUsed
 	 */
-	public function convert(object $obj, /** @scrutinizer ignore-unused */ array $config): array
+	public function convert(object $obj, array $config): array
 	{
 		Validator::assertInstanceOf('obj', $obj, Arrayable::class);
 

src/Converters/ArrayableConverter.php

@@ -34,7 +34,7 @@ final class JsonSerializableConverter implements ConverterContract
 	 *
 	 * @return array
 	 */
-	public function convert(object $obj, /** @scrutinizer ignore-unused */ array $config): array
+	public function convert(object $obj, array $config): array
 	{
 		Validator::assertInstanceOf('obj', $obj, \JsonSerializable::class);
 

src/Converters/JsonSerializableConverter.php

@@ -36,7 +36,7 @@ final class ToArrayConverter implements ConverterContract
 	 *
 	 * phpcs:disable Generic.CodeAnalysis.UnusedFunctionParameter.FoundInImplementedInterfaceAfterLastUsed
 	 */
-    public function convert(object $obj, /** @scrutinizer ignore-unused */ array $config): array
+    public function convert(object $obj, array $config): array
     {
         Validator::assertIsObject('obj', $obj);
 

src/Converters/ToArrayConverter.php

@@ -52,7 +52,7 @@ class ExceptionHandlerHelper
 	 * @noinspection PhpUnusedParameterInspection
 	 * phpcs:disable Generic.CodeAnalysis.UnusedFunctionParameter.FoundBeforeLastUsed
 	 */
-	public static function render(/** @scrutinizer ignore-unused */ $request, \Throwable $ex): HttpResponse
+	public static function render($request, \Throwable $ex): HttpResponse
 	{
 		$result = null;
 
@@ -197,7 +197,7 @@ protected static function getErrorMessageForException(\Throwable $ex, int $http_
 	 * @noinspection PhpMissingParamTypeInspection
 	 * phpcs:disable Generic.CodeAnalysis.UnusedFunctionParameter.FoundBeforeLastUsed
 	 */
-	protected function unauthenticated(/** @scrutinizer ignore-unused */ $request,
+	protected function unauthenticated($request,
 	                                                                     AuthException $exception): HttpResponse
 	{
 		$cfg = self::getExceptionHandlerConfig();

src/ExceptionHandlerHelper.php

@@ -35,7 +35,7 @@ final class DefaultExceptionHandler implements ExceptionHandlerContract
 	 *
 	 * phpcs:disable Generic.CodeAnalysis.UnusedFunctionParameter.FoundInImplementedInterfaceAfterLastUsed
 	 */
-	public function handle(array $user_config, /** @scrutinizer ignore-unused */ \Throwable $ex): ?array
+	public function handle(array $user_config, \Throwable $ex): ?array
 	{
 		/** @noinspection PhpUnhandledExceptionInspection */
 		$defaults = [