Tuning of php-cs-fixer configuration (#12)

facile-it · Apr 5, 2021 · 91366ea · 91366ea
1 parent 58888b1
commit 91366ea
Show file tree

Hide file tree

Showing 43 changed files with 150 additions and 150 deletions.
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -1,6 +1,10 @@
 name: CI
 
-on: [pull_request, push]
+on:
+  pull_request: ~
+  push:
+    branches:
+      - master
 
 jobs:
   tests:

diff --git a/.github/workflows/static-analysis.yaml b/.github/workflows/static-analysis.yaml
@@ -1,6 +1,10 @@
 name: Static analysis
 
-on: [pull_request, push]
+on:
+  pull_request: ~
+  push:
+    branches:
+      - master
 
 jobs:
   job:
@@ -10,7 +14,7 @@ jobs:
           - description: Validate composer.json
             script: composer validate
           - description: Code style
-            script: make cs-fix
+            script: make cs-check
           - description: PSalm
             script: make psalm
           - description: Type assertions

diff --git a/.php_cs b/.php_cs
@@ -0,0 +1,29 @@
+<?php
+
+$rulesProvider = new Facile\CodingStandards\Rules\CompositeRulesProvider([
+    new Facile\CodingStandards\Rules\DefaultRulesProvider(),
+    new Facile\CodingStandards\Rules\RiskyRulesProvider(),
+    new Facile\CodingStandards\Rules\ArrayRulesProvider([
+        'class_attributes_separation' => false,
+        'declare_strict_types' => true,
+        'indentation_type' => true,
+        'phpdoc_to_comment' => false,
+        'phpdoc_trim_consecutive_blank_line_separation' => true,
+        'phpdoc_align' => true,
+        'nullable_type_declaration_for_default_null_value' => true,
+        'lambda_not_used_import' => true,
+        'phpdoc_add_missing_param_annotation' => true
+    ]),
+]);
+
+$finder = PhpCsFixer\Finder::create();
+$autoloadPathProvider = new Facile\CodingStandards\AutoloadPathProvider();
+$finder->in($autoloadPathProvider->getPaths());
+
+$config = new PhpCsFixer\Config();
+$config->setRules($rulesProvider->getRules());
+$config->setRiskyAllowed(true);
+$config->setUsingCache(false);
+$config->setFinder($finder);
+
+return $config;
diff --git a/.php_cs.dist b/.php_cs.dist
diff --git a/src/Codecs.php b/src/Codecs.php
@@ -117,8 +117,8 @@ public static function associativeArray(array $props): Codec
      * @template T
      *
      * @param non-empty-array<string, Codec> $props
-     * @param callable(...mixed):T $factory
-     * @param class-string<T> $fqcn
+     * @param callable(...mixed):T           $factory
+     * @param class-string<T>                $fqcn
      *
      * @return Codec<T, mixed, T>
      */
@@ -145,19 +145,19 @@ public static function classFromArray(
      * @template E
      * @template OE
      *
-     * @param Codec<A, IA, mixed> $a
-     * @param Codec<B, A, OB> $b
+     * @param Codec<A, IA, mixed>    $a
+     * @param Codec<B, A, OB>        $b
      * @param Codec<C, B, OC> | null $c
      * @param Codec<D, C, OD> | null $d
      * @param Codec<E, D, OE> | null $e
      *
      * // TODO must add type assertions
      *
      * @return (func_num_args() is 2 ? Codec<B, IA, OB>
-     *   : (func_num_args() is 3 ? Codec<C, IA, OC>
-     *   : (func_num_args() is 4 ? Codec<D, IA, OD>
-     *   : (func_num_args() is 5 ? Codec<E, IA, OC> : Codec)
-     * )))
+     *                          : (func_num_args() is 3 ? Codec<C, IA, OC>
+     *                          : (func_num_args() is 4 ? Codec<D, IA, OD>
+     *                          : (func_num_args() is 5 ? Codec<E, IA, OC> : Codec)
+     *                          )))
      */
     public static function pipe(
         Codec $a,
@@ -185,7 +185,7 @@ public static function pipe(
     public static function union(Codec $a, Codec $b, Codec ...$others): Codec
     {
         // Order is not important, unions should be commutatives
-        return array_reduce(
+        return \array_reduce(
             $others,
             static function (Codec $carry, Codec $current): Codec {
                 return new UnionType($current, $carry);

diff --git a/src/Internal/Arrays/ListRefiner.php b/src/Internal/Arrays/ListRefiner.php
@@ -25,7 +25,7 @@ public function __construct(Refiner $item)
 
     public function is($u): bool
     {
-        if (! is_array($u)) {
+        if (! \is_array($u)) {
             return false;
         }
 

diff --git a/src/Internal/Arrays/ListType.php b/src/Internal/Arrays/ListType.php
@@ -36,7 +36,7 @@ public function __construct(Codec $itemCodec)
 
     public function validate($i, Context $context): Validation
     {
-        if (! is_array($i)) {
+        if (! \is_array($i)) {
             return Validation::failure(
                 $i,
                 $context->appendEntries(

diff --git a/src/Internal/Arrays/MapRefiner.php b/src/Internal/Arrays/MapRefiner.php
@@ -17,6 +17,6 @@ class MapRefiner implements Refiner
      */
     public function is($u): bool
     {
-        return is_array($u);
+        return \is_array($u);
     }
 }
diff --git a/src/Internal/Combinators/ClassFromArray.php b/src/Internal/Combinators/ClassFromArray.php
@@ -30,16 +30,16 @@ class ClassFromArray extends Type
 
     /**
      * @param non-empty-array<array-key, Codec> $props
-     * @param callable(...mixed):T $builder
-     * @param class-string<T> $fqcn
+     * @param callable(...mixed):T              $builder
+     * @param class-string<T>                   $fqcn
      */
     public function __construct(
         array $props,
         callable $builder,
         string $fqcn
     ) {
         parent::__construct(
-            sprintf('%s(%s)', $fqcn, nameFromProps($props)),
+            \sprintf('%s(%s)', $fqcn, nameFromProps($props)),
             new InstanceOfRefiner($fqcn),
             Encode::identity()
         );
@@ -53,9 +53,9 @@ public function validate($i, Context $context): Validation
         $validations = [];
 
         foreach ($this->props as $k => $codec) {
-            $keyName = is_string($k) ? $k : sprintf('[%d]', $k);
+            $keyName = \is_string($k) ? $k : \sprintf('[%d]', $k);
             /** @var mixed $value */
-            $value = array_key_exists($k, $i) ? $i[$k] : new Undefined();
+            $value = \array_key_exists($k, $i) ? $i[$k] : new Undefined();
 
             $validations[] = $codec->validate($value, $context->appendEntries(new ContextEntry($keyName, $codec, $value)));
         }

diff --git a/src/Internal/Combinators/ComposeType.php b/src/Internal/Combinators/ComposeType.php
@@ -31,7 +31,7 @@ class ComposeType extends Type
 
     /**
      * @param Codec<A, IA, OA> $a
-     * @param Codec<B, A, OB> $b
+     * @param Codec<B, A, OB>  $b
      */
     public function __construct(
         Codec $a,

diff --git a/src/Internal/Combinators/UnionType.php b/src/Internal/Combinators/UnionType.php
@@ -31,7 +31,7 @@ public function __construct(
         Codec $a,
         Codec $b
     ) {
-        $name = sprintf(
+        $name = \sprintf(
             '%s | %s',
             $a->getName(),
             $b->getName()

diff --git a/src/Internal/Experimental/AssociativeArrayRefiner.php b/src/Internal/Experimental/AssociativeArrayRefiner.php
@@ -24,7 +24,7 @@ public function __construct(array $props)
 
     public function is($u): bool
     {
-        if (! is_array($u)) {
+        if (! \is_array($u)) {
             return false;
         }
 

diff --git a/src/Internal/PreconditionFailureExcepion.php b/src/Internal/PreconditionFailureExcepion.php
@@ -12,7 +12,7 @@ class PreconditionFailureExcepion extends \LogicException
     public static function create(string $expectedType, $given): self
     {
         return new self(
-            sprintf(
+            \sprintf(
                 'Bad codec composition: expecting input to be of type "%s", given "%s"',
                 $expectedType,
                 typeof($given)

diff --git a/src/Internal/Primitives/BoolRefiner.php b/src/Internal/Primitives/BoolRefiner.php
@@ -13,6 +13,6 @@ class BoolRefiner implements Refiner
 {
     public function is($u): bool
     {
-        return is_bool($u);
+        return \is_bool($u);
     }
 }
diff --git a/src/Internal/Primitives/FloatRefiner.php b/src/Internal/Primitives/FloatRefiner.php
@@ -13,6 +13,6 @@ class FloatRefiner implements Refiner
 {
     public function is($u): bool
     {
-        return is_float($u);
+        return \is_float($u);
     }
 }
diff --git a/src/Internal/Primitives/InstanceOfRefiner.php b/src/Internal/Primitives/InstanceOfRefiner.php
@@ -29,6 +29,6 @@ public function __construct(string $fqcn)
      */
     public function is($u): bool
     {
-        return is_a($u, $this->fqcn);
+        return \is_a($u, $this->fqcn);
     }
 }
diff --git a/src/Internal/Primitives/IntRefiner.php b/src/Internal/Primitives/IntRefiner.php
@@ -13,6 +13,6 @@ class IntRefiner implements Refiner
 {
     public function is($u): bool
     {
-        return is_int($u);
+        return \is_int($u);
     }
 }
diff --git a/src/Internal/Primitives/LiteralType.php b/src/Internal/Primitives/LiteralType.php
@@ -39,11 +39,11 @@ public function validate($i, Context $context): Validation
      */
     private static function literalName($x): string
     {
-        if (is_string($x)) {
+        if (\is_string($x)) {
             return "'$x'";
         }
 
-        if (is_bool($x)) {
+        if (\is_bool($x)) {
             return $x ? 'true' : 'false';
         }
 

diff --git a/src/Internal/Primitives/StringRefiner.php b/src/Internal/Primitives/StringRefiner.php
@@ -13,6 +13,6 @@ class StringRefiner implements Refiner
 {
     public function is($u): bool
     {
-        return is_string($u);
+        return \is_string($u);
     }
 }
diff --git a/src/Internal/Type.php b/src/Internal/Type.php
@@ -27,7 +27,7 @@ abstract class Type implements Codec
     private $refine;
 
     /**
-     * @param Refiner<A> $refine
+     * @param Refiner<A>   $refine
      * @param Encode<A, O> $encode
      */
     public function __construct(

diff --git a/src/Internal/Useful/DateTimeFromIsoStringType.php b/src/Internal/Useful/DateTimeFromIsoStringType.php
@@ -26,7 +26,7 @@ public function __construct()
 
     public function validate($i, Context $context): Validation
     {
-        $r = \DateTime::createFromFormat(DATE_ATOM, $i);
+        $r = \DateTime::createFromFormat(\DATE_ATOM, $i);
 
         if ($r === false) {
             return Validation::failure($i, $context);

diff --git a/src/Internal/Useful/IntFromStringType.php b/src/Internal/Useful/IntFromStringType.php
@@ -23,14 +23,14 @@ public function __construct()
 
     public function validate($i, Context $context): Validation
     {
-        return is_numeric($i)
+        return \is_numeric($i)
             ? Validation::success((int) $i)
             : Validation::failure($i, $context);
     }
 
     public function forceCheckPrecondition($i)
     {
-        if (! is_string($i)) {
+        if (! \is_string($i)) {
             throw PreconditionFailureExcepion::create('string', $i);
         }
 

diff --git a/src/Internal/Useful/RegexType.php b/src/Internal/Useful/RegexType.php
@@ -22,7 +22,7 @@ class RegexType extends Type
     public function __construct(string $regex)
     {
         parent::__construct(
-            sprintf('regex(%s)', $regex),
+            \sprintf('regex(%s)', $regex),
             new MapRefiner(),
             Encode::identity()
         );
@@ -32,7 +32,7 @@ public function __construct(string $regex)
     public function validate($i, Context $context): Validation
     {
         $matches = [];
-        if (preg_match($this->regex, $i, $matches) === false) {
+        if (\preg_match($this->regex, $i, $matches) === false) {
             return Validation::failure($i, $context);
         }
 
@@ -47,7 +47,7 @@ public function validate($i, Context $context): Validation
      */
     public function forceCheckPrecondition($i)
     {
-        if (! is_string($i)) {
+        if (! \is_string($i)) {
             throw PreconditionFailureExcepion::create('string', $i);
         }
 

diff --git a/src/Internal/utils.php b/src/Internal/utils.php
@@ -11,20 +11,20 @@
  */
 function nameFromProps(array $props): string
 {
-    return sprintf(
+    return \sprintf(
         '{%s}',
-        implode(
+        \implode(
             ', ',
-            array_map(
+            \array_map(
                 static function (Codec $t, $k): string {
-                    return sprintf(
+                    return \sprintf(
                         '%s: %s',
-                        is_string($k) ? $k : sprintf('[%d]', $k),
+                        \is_string($k) ? $k : \sprintf('[%d]', $k),
                         $t->getName()
                     );
                 },
                 $props,
-                array_keys($props)
+                \array_keys($props)
             )
         )
     );
@@ -35,9 +35,9 @@ static function (Codec $t, $k): string {
  */
 function typeof($x): string
 {
-    if (is_object($x)) {
-        return get_class($x);
+    if (\is_object($x)) {
+        return \get_class($x);
     }
 
-    return gettype($x);
+    return \gettype($x);
 }