Replace PHP-CS-Fixer with PHP_CodeSniffer

I have recently created "respect/coding-standard" with the
PHP_CodeSniffer rules that I intend to use in all components that I
maintain.

The reason for changing to PHP_CodeSniffer is that I have had broken
builds after some minor or patch update of PHP-CS-Fixer.

This commit will replace all configurations of PHP-CS-Fixer and replace
with PHP_CodeSniffer. It will also execute PHP_CodeSniffer on
Travis builds.

Signed-off-by: Henrique Moody <[email protected]>

Author: henriquemoody

.gitattributes

@@ -1,3 +1,4 @@
 /.* export-ignore
+/phpcs.xml.dist export-ignore
 /phpunit.xml.dist export-ignore
 /tests export-ignore

.gitignore

@@ -1,6 +1,5 @@
-.php_cs.cache
-.couscous/
+.phpcs.cache
 composer.lock
-Makefile
+phpcs.xml
 phpunit.xml
 vendor/

.php_cs.cache

@@ -0,0 +1 @@
+{"php":"7.2.3","version":"2.11.0:v2.11.0#2ac8defbe07599b79005cca764bfffe7aeac0bf2","rules":{"binary_operator_spaces":true,"blank_line_after_opening_tag":true,"blank_line_before_statement":{"statements":["return"]},"braces":{"allow_single_line_closure":true},"cast_spaces":true,"class_attributes_separation":{"elements":["method"]},"class_definition":{"singleLine":true},"concat_space":{"spacing":"none"},"declare_equal_normalize":true,"function_typehint_space":true,"include":true,"increment_style":true,"lowercase_cast":true,"magic_constant_casing":true,"method_argument_space":true,"native_function_casing":true,"new_with_braces":true,"no_blank_lines_after_class_opening":true,"no_blank_lines_after_phpdoc":true,"no_empty_comment":true,"no_empty_phpdoc":true,"no_empty_statement":true,"no_extra_blank_lines":{"tokens":["curly_brace_block","extra","parenthesis_brace_block","square_brace_block","throw","use"]},"no_leading_import_slash":true,"no_leading_namespace_whitespace":true,"no_mixed_echo_print":{"use":"echo"},"no_multiline_whitespace_around_double_arrow":true,"no_short_bool_cast":true,"no_singleline_whitespace_before_semicolons":true,"no_spaces_around_offset":true,"no_trailing_comma_in_list_call":true,"no_trailing_comma_in_singleline_array":true,"no_unneeded_control_parentheses":true,"no_unneeded_curly_braces":true,"no_unneeded_final_method":true,"no_unused_imports":true,"no_whitespace_before_comma_in_array":true,"no_whitespace_in_blank_line":true,"normalize_index_brace":true,"object_operator_without_whitespace":true,"php_unit_fqcn_annotation":true,"phpdoc_annotation_without_dot":true,"phpdoc_indent":true,"phpdoc_inline_tag":true,"phpdoc_no_access":true,"phpdoc_no_alias_tag":true,"phpdoc_no_empty_return":true,"phpdoc_no_package":true,"phpdoc_no_useless_inheritdoc":true,"phpdoc_return_self_reference":true,"phpdoc_scalar":true,"phpdoc_separation":true,"phpdoc_single_line_var_spacing":true,"phpdoc_to_comment":true,"phpdoc_trim":true,"phpdoc_types":true,"phpdoc_var_without_name":true,"protected_to_private":true,"return_type_declaration":true,"semicolon_after_instruction":true,"short_scalar_cast":true,"single_blank_line_before_namespace":true,"single_class_element_per_statement":true,"single_line_comment_style":{"comment_types":["hash"]},"single_quote":true,"space_after_semicolon":{"remove_in_empty_for_expressions":true},"standardize_increment":true,"standardize_not_equals":true,"ternary_operator_spaces":true,"trailing_comma_in_multiline_array":true,"trim_array_spaces":true,"unary_operator_spaces":true,"whitespace_after_comma_in_array":true,"yoda_style":true,"blank_line_after_namespace":true,"elseif":true,"function_declaration":true,"indentation_type":true,"line_ending":true,"lowercase_constants":true,"lowercase_keywords":true,"no_break_comment":true,"no_closing_tag":true,"no_spaces_after_function_name":true,"no_spaces_inside_parenthesis":true,"no_trailing_whitespace":true,"no_trailing_whitespace_in_comment":true,"single_blank_line_at_eof":true,"single_import_per_statement":true,"single_line_after_imports":true,"switch_case_semicolon_to_colon":true,"switch_case_space":true,"visibility_required":true,"encoding":true,"full_opening_tag":true,"void_return":true,"declare_strict_types":true,"non_printable_character":{"use_escape_sequences_in_strings":true},"random_api_migration":{"replacements":{"mt_rand":"random_int","rand":"random_int"}},"pow_to_exponentiation":true,"mb_str_functions":true,"no_multiline_whitespace_before_semicolons":true,"no_useless_else":true,"no_useless_return":true,"ordered_imports":true,"phpdoc_order":true,"array_syntax":{"syntax":"short"},"no_short_echo_tag":true},"hashes":{"src\/Stringifier.php":3208716286,"src\/Quoters\/CodeQuoter.php":1533189238,"src\/Quoter.php":2980616127,"src\/stringify.php":931297305,"src\/Stringifiers\/ObjectStringifier.php":769132450,"src\/Stringifiers\/JsonSerializableStringifier.php":889559733,"src\/Stringifiers\/NullStringifier.php":777503971,"src\/Stringifiers\/InfiniteStringifier.php":3702196378,"src\/Stringifiers\/BoolStringifier.php":2848167023,"src\/Stringifiers\/JsonParsableStringifier.php":2925421316,"src\/Stringifiers\/ArrayStringifier.php":2223781617,"src\/Stringifiers\/TraversableStringifier.php":2583157109,"src\/Stringifiers\/NanStringifier.php":1132847196,"src\/Stringifiers\/ResourceStringifier.php":2818690467,"src\/Stringifiers\/StringableObjectStringifier.php":1468810915,"src\/Stringifiers\/DateTimeStringifier.php":941725598,"src\/Stringifiers\/ThrowableStringifier.php":3465475836,"src\/Stringifiers\/ClusterStringifier.php":1603447365,"tests\/unit\/Quoters\/CodeQuoterTest.php":2890101821,"tests\/unit\/Stringifiers\/ClusterStringifierTest.php":1589093609,"tests\/unit\/Stringifiers\/StringableObjectStringifierTest.php":3246015514,"tests\/unit\/Stringifiers\/JsonSerializableStringifierTest.php":2860077306,"tests\/unit\/Stringifiers\/NullStringifierTest.php":1668298499,"tests\/unit\/Stringifiers\/BoolStringifierTest.php":2367954854,"tests\/unit\/Stringifiers\/ArrayStringifierTest.php":1713816966,"tests\/unit\/Stringifiers\/ResourceStringifierTest.php":3256501379,"tests\/unit\/Stringifiers\/DateTimeStringifierTest.php":218461015,"tests\/unit\/Stringifiers\/ThrowableStringifierTest.php":1587675716,"tests\/unit\/Stringifiers\/InfiniteStringifierTest.php":1579464589,"tests\/unit\/Stringifiers\/ObjectStringifierTest.php":757101255,"tests\/unit\/Stringifiers\/NanStringifierTest.php":2937436759,"tests\/unit\/Stringifiers\/TraversableStringifierTest.php":1039981065,"tests\/unit\/Stringifiers\/JsonParsableStringifierTest.php":1198212455,"tests\/integration\/stringify-array.phpt":2838177671,"tests\/integration\/stringify-object-stringable.phpt":3555699116,"tests\/integration\/stringify-null.phpt":999007070,"tests\/integration\/stringify-object.phpt":1045480538,"tests\/integration\/stringify-string.phpt":3120180057,"tests\/integration\/stringify-int.phpt":1947617993,"tests\/integration\/stringify-object-traversable.phpt":1775818702,"tests\/integration\/stringify-object-throwable.phpt":3012592631,"tests\/integration\/stringify-object-jsonSerializable.phpt":4118407949,"tests\/integration\/stringify-float.phpt":3566366260,"tests\/integration\/stringify-object-dateTime.phpt":3654860991,"tests\/integration\/stringify-resource.phpt":3835353175,"tests\/integration\/stringify-bool.phpt":4123311986,"\/tests\/unit\/Quoters\/CodeQuoterTest.php":2890101821,"\/tests\/unit\/Stringifiers\/ClusterStringifierTest.php":1589093609,"\/tests\/unit\/Stringifiers\/StringableObjectStringifierTest.php":3246015514,"\/tests\/unit\/Stringifiers\/JsonSerializableStringifierTest.php":2860077306,"\/tests\/unit\/Stringifiers\/NullStringifierTest.php":1668298499,"\/tests\/unit\/Stringifiers\/BoolStringifierTest.php":2367954854,"\/tests\/unit\/Stringifiers\/ArrayStringifierTest.php":1713816966,"\/tests\/unit\/Stringifiers\/ResourceStringifierTest.php":3256501379,"\/tests\/unit\/Stringifiers\/DateTimeStringifierTest.php":218461015,"\/tests\/unit\/Stringifiers\/ThrowableStringifierTest.php":1587675716,"\/tests\/unit\/Stringifiers\/InfiniteStringifierTest.php":1579464589,"\/tests\/unit\/Stringifiers\/ObjectStringifierTest.php":757101255,"\/tests\/unit\/Stringifiers\/NanStringifierTest.php":2937436759,"\/tests\/unit\/Stringifiers\/TraversableStringifierTest.php":1039981065,"\/tests\/unit\/Stringifiers\/JsonParsableStringifierTest.php":1198212455,"\/tests\/integration\/stringify-array.phpt":2838177671,"\/tests\/integration\/stringify-object-stringable.phpt":3555699116,"\/tests\/integration\/stringify-null.phpt":999007070,"\/tests\/integration\/stringify-object.phpt":1045480538,"\/tests\/integration\/stringify-string.phpt":3120180057,"\/tests\/integration\/stringify-int.phpt":1947617993,"\/tests\/integration\/stringify-object-traversable.phpt":1775818702,"\/tests\/integration\/stringify-object-throwable.phpt":3012592631,"\/tests\/integration\/stringify-object-jsonSerializable.phpt":4118407949,"\/tests\/integration\/stringify-float.phpt":3566366260,"\/tests\/integration\/stringify-object-dateTime.phpt":3654860991,"\/tests\/integration\/stringify-resource.phpt":3835353175,"\/tests\/integration\/stringify-bool.phpt":4123311986,"\/src\/Stringifier.php":3208716286,"\/src\/Quoters\/CodeQuoter.php":1533189238,"\/src\/Quoter.php":2980616127,"\/src\/stringify.php":931297305,"\/src\/Stringifiers\/ObjectStringifier.php":769132450,"\/src\/Stringifiers\/JsonSerializableStringifier.php":889559733,"\/src\/Stringifiers\/NullStringifier.php":777503971,"\/src\/Stringifiers\/InfiniteStringifier.php":3702196378,"\/src\/Stringifiers\/BoolStringifier.php":2848167023,"\/src\/Stringifiers\/JsonParsableStringifier.php":2925421316,"\/src\/Stringifiers\/ArrayStringifier.php":2223781617,"\/src\/Stringifiers\/TraversableStringifier.php":2583157109,"\/src\/Stringifiers\/NanStringifier.php":1132847196,"\/src\/Stringifiers\/ResourceStringifier.php":2818690467,"\/src\/Stringifiers\/StringableObjectStringifier.php":1468810915,"\/src\/Stringifiers\/DateTimeStringifier.php":941725598,"\/src\/Stringifiers\/ThrowableStringifier.php":3465475836,"\/src\/Stringifiers\/ClusterStringifier.php":1603447365}}

.travis.yml

@@ -39,3 +39,7 @@ jobs:
     - stage: Quality assurance
       env: DOCHEADER
       script: vendor/bin/docheader check src/ tests/
+
+    - stage: Quality assurance
+      env: CODE_STANDARD
+      script: vendor/bin/phpcs

composer.json

@@ -15,13 +15,15 @@
         "php": ">=7.1"
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": "^2.8",
         "malukenho/docheader": "^0.1.7",
-        "phpunit/phpunit": "^6.4"
+        "phpunit/phpunit": "^6.4",
+        "respect/coding-standard": "^1.0",
+        "squizlabs/php_codesniffer": "^3.4"
     },
     "autoload": {
         "psr-4": {
-            "Respect\\Stringifier\\": "src/"
+            "Respect\\Stringifier\\": "src/",
+            "Respect\\Stringifier\\Test\\": "tests/src/"
         },
         "files": [
             "src/stringify.php"
@@ -32,5 +34,8 @@
         "test": "vendor/bin/phpunit",
         "test-unit": "vendor/bin/phpunit --testsuite=unit",
         "test-integration": "vendor/bin/phpunit --testsuite=integration"
+    },
+    "config": {
+        "sort-packages": true
     }
 }

phpcs.xml.dist

@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd" >
+
+    <arg name="basepath" value="." />
+    <arg name="cache" value=".phpcs.cache" />
+    <arg name="colors" />
+    <arg name="extensions" value="php,phpt" />
+    <arg value="p" />
+    <arg value="s" />
+
+    <file>src/</file>
+    <file>tests/</file>
+
+    <rule ref="Respect" />
+</ruleset>

src/Quoter.php

@@ -21,7 +21,6 @@ interface Quoter
      * @param string $string The string to add quotes to
      * @param int $depth The current depth
      *
-     * @return string
      */
     public function quote(string $string, int $depth): string;
 }

src/Quoters/CodeQuoter.php

@@ -14,6 +14,7 @@
 namespace Respect\Stringifier\Quoters;
 
 use Respect\Stringifier\Quoter;
+use function sprintf;
 
 /**
  * Add "`" quotes around a string depending on its level.
@@ -27,7 +28,7 @@ final class CodeQuoter implements Quoter
      */
     public function quote(string $string, int $depth): string
     {
-        if (0 === $depth) {
+        if ($depth === 0) {
             return sprintf('`%s`', $string);
         }
 

src/Stringifiers/ArrayStringifier.php

@@ -16,8 +16,10 @@
 use Respect\Stringifier\Quoter;
 use Respect\Stringifier\Stringifier;
 use function array_keys;
+use function count;
 use function implode;
 use function is_array;
+use function range;
 use function sprintf;
 
 /**
@@ -47,14 +49,6 @@ final class ArrayStringifier implements Stringifier
      */
     private $itemsLimit;
 
-    /**
-     * Initializes the stringifier.
-     *
-     * @param Stringifier $stringifier
-     * @param Quoter $quoter
-     * @param int $maximumDepth
-     * @param int $itemsLimit
-     */
     public function __construct(Stringifier $stringifier, Quoter $quoter, int $maximumDepth, int $itemsLimit)
     {
         $this->stringifier = $stringifier;
@@ -90,7 +84,7 @@ public function stringify($raw, int $depth): ?string
             }
 
             $items[$itemsCount] = '';
-            if (false === $isSequential) {
+            if ($isSequential === false) {
                 $items[$itemsCount] .= sprintf('%s: ', $this->stringifier->stringify($key, $depth + 1));
             }
             $items[$itemsCount] .= $this->stringifier->stringify($value, $depth + 1);
@@ -100,11 +94,7 @@ public function stringify($raw, int $depth): ?string
     }
 
     /**
-     * Returns whether the array is sequential or not.
-     *
-     * @param array $array
-     *
-     * @return bool
+     * @param mixed[] $array
      */
     private function isSequential(array $array): bool
     {

src/Stringifiers/BoolStringifier.php

@@ -29,11 +29,6 @@ final class BoolStringifier implements Stringifier
      */
     private $quoter;
 
-    /**
-     * Initializes the stringifier.
-     *
-     * @param Quoter $quoter
-     */
     public function __construct(Quoter $quoter)
     {
         $this->quoter = $quoter;