Update coding standard (#9)

Author: dantleech

.github/workflows/ci.yml

@@ -43,7 +43,7 @@ jobs:
 
             -
                 name: "Run friendsofphp/php-cs-fixer"
-                run: "vendor/bin/php-cs-fixer fix --dry-run --diff --verbose"
+                run: "vendor/bin/php-cs-fixer fix --dry-run --diff --verbose --allow-risky=yes"
     phpstan:
         name: "PHPStan (${{ matrix.php-version }})"
 

.php_cs.dist

@@ -4,7 +4,7 @@ $finder = PhpCsFixer\Finder::create()
     ->in('lib')
     ->in('tests')
     ->exclude([
-        'tests/Workspace'
+        'tests/Workspace',
     ])
 ;
 
@@ -13,6 +13,11 @@ return PhpCsFixer\Config::create()
         '@PSR2' => true,
         'no_unused_imports' => true,
         'array_syntax' => ['syntax' => 'short'],
+        'void_return' => true,
+        'ordered_class_elements' => true,
+        'single_quote' => true,
+        'heredoc_indentation' => true,
+        'global_namespace_import' => true,
     ])
     ->setFinder($finder)
 ;

lib/Definitions.php

@@ -27,11 +27,6 @@ public function __construct(array $definitions)
         }
     }
 
-    private function add(Definition $definition): void
-    {
-        $this->definitions[$definition->name()] = $definition;
-    }
-
     /**
      * @return Iterator<Definition>
      */
@@ -51,4 +46,9 @@ public function get(string $name): Definition
 
         return $this->definitions[$name];
     }
+
+    private function add(Definition $definition): void
+    {
+        $this->definitions[$definition->name()] = $definition;
+    }
 }

lib/Resolver.php

@@ -171,15 +171,6 @@ public function merge(Resolver $schema): Resolver
         return $this;
     }
 
-    /**
-     * @return array<string>
-     */
-    private function resolveAllowedKeys(): array
-    {
-        $allowedKeys = array_merge(array_keys($this->defaults), $this->required);
-        return $allowedKeys;
-    }
-
     public function definitions(): Definitions
     {
         $definitions = [];
@@ -196,4 +187,13 @@ public function definitions(): Definitions
 
         return new Definitions($definitions);
     }
+
+    /**
+     * @return array<string>
+     */
+    private function resolveAllowedKeys(): array
+    {
+        $allowedKeys = array_merge(array_keys($this->defaults), $this->required);
+        return $allowedKeys;
+    }
 }

phpstan-baseline.neon

@@ -0,0 +1,7 @@
+parameters:
+	ignoreErrors:
+		-
+			message: "#^Method Phpactor\\\\MapResolver\\\\Resolver\\:\\:resolveDescriptions\\(\\) should return array\\<string, string\\> but returns array\\<int\\|string, string\\|false\\|null\\>\\.$#"
+			count: 1
+			path: lib/Resolver.php
+

phpstan.neon

@@ -3,3 +3,5 @@ parameters:
     inferPrivatePropertyTypeFromConstructor: true
     paths:
         - lib
+includes:
+    - phpstan-baseline.neon

tests/Unit/ResolverTest.php

@@ -10,7 +10,7 @@
 
 class ResolverTest extends TestCase
 {
-    public function testSetsDefaults()
+    public function testSetsDefaults(): void
     {
         $resolver = new Resolver();
         $resolver->setDefaults([
@@ -20,7 +20,7 @@ public function testSetsDefaults()
         $this->assertEquals(['one' => 1, 'two' => 2], $resolver->resolve([]));
     }
 
-    public function testThrowsExceptionOnUnknownKey()
+    public function testThrowsExceptionOnUnknownKey(): void
     {
         $this->expectException(InvalidMap::class);
         $this->expectExceptionMessage('Key(s) "three" are not known');
@@ -33,7 +33,7 @@ public function testThrowsExceptionOnUnknownKey()
         $resolver->resolve(['three' => 3]);
     }
 
-    public function testMergesDefaults()
+    public function testMergesDefaults(): void
     {
         $resolver = new Resolver();
         $resolver->setDefaults([
@@ -43,7 +43,7 @@ public function testMergesDefaults()
         $this->assertEquals(['one' => 5, 'two' => 2], $resolver->resolve(['one' => 5]));
     }
 
-    public function testSettingDefaultsMultipleTimesMerges()
+    public function testSettingDefaultsMultipleTimesMerges(): void
     {
         $resolver = new Resolver();
         $resolver->setDefaults([
@@ -56,7 +56,7 @@ public function testSettingDefaultsMultipleTimesMerges()
         $this->assertEquals(['one' => 3, 'two' => 2], $resolver->resolve([]));
     }
 
-    public function testThrowsExceptionOnMissingRequiredKeys()
+    public function testThrowsExceptionOnMissingRequiredKeys(): void
     {
         $this->expectException(InvalidMap::class);
         $this->expectExceptionMessage('Key(s) "one" are required');
@@ -69,7 +69,7 @@ public function testThrowsExceptionOnMissingRequiredKeys()
         $resolver->resolve(['two' => 3]);
     }
 
-    public function testCallingRequiredMultipleTimesMergesRequiredKeys()
+    public function testCallingRequiredMultipleTimesMergesRequiredKeys(): void
     {
         $resolver = new Resolver();
         $resolver->setRequired(['one']);
@@ -78,7 +78,7 @@ public function testCallingRequiredMultipleTimesMergesRequiredKeys()
         $this->assertEquals(['one' => 1, 'two' => 3], $result);
     }
 
-    public function testThrowsExceptionOnInvalidType()
+    public function testThrowsExceptionOnInvalidType(): void
     {
         $this->expectException(InvalidMap::class);
         $this->expectExceptionMessage('Type for "one" expected to be "string", got "stdClass"');
@@ -91,7 +91,7 @@ public function testThrowsExceptionOnInvalidType()
         $resolver->resolve(['one' => new stdClass]);
     }
 
-    public function testCallback()
+    public function testCallback(): void
     {
         $resolver = new Resolver();
         $resolver->setDefaults([
@@ -106,7 +106,7 @@ public function testCallback()
         $this->assertEquals('hello', $config['bar']);
     }
 
-    public function testThrowsExceptionOnUnknownDescriptions()
+    public function testThrowsExceptionOnUnknownDescriptions(): void
     {
         $this->expectException(InvalidMap::class);
         $this->expectExceptionMessage('Description(s) for key(s) "four" are not known');
@@ -122,7 +122,7 @@ public function testThrowsExceptionOnUnknownDescriptions()
         $resolver->resolve(['two' => 3]);
     }
 
-    public function testResolvesDescriptions()
+    public function testResolvesDescriptions(): void
     {
         $resolver = new Resolver();
         $resolver->setDefaults([