Merge pull request #276 from netglue/psalm-defaults

Apply future Psalm defaults
netglue · May 16, 2023 · 350c51c · 350c51c
2 parents e165fc3 + be39798
commit 350c51c
Show file tree

Hide file tree

Showing 11 changed files with 58 additions and 63 deletions.
diff --git a/phpcs.xml b/phpcs.xml
@@ -24,4 +24,9 @@
     <rule ref="Generic.Files.LineLength.TooLong">
         <exclude-pattern>/test/</exclude-pattern>
     </rule>
+
+    <!-- PHP 4 Constructors are not possible on PHP 8+ -->
+    <rule ref="Generic.NamingConventions.ConstructorName.OldStyle">
+        <severity>0</severity>
+    </rule>
 </ruleset>
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1,32 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="5.4.0@62db5d4f6a7ae0a20f7cc5a4952d730272fc0863">
-  <file src="test/Smoke/TestCase.php">
-    <RedundantCondition occurrences="6">
-      <code>assert(is_array($configured))</code>
-      <code>assert(is_array($spec))</code>
-      <code>is_array($configured)</code>
-      <code>is_array($spec)</code>
-      <code>is_string($spec['url'])</code>
-      <code>isset($spec['url']) &amp;&amp; is_string($spec['url'])</code>
-    </RedundantCondition>
-    <TypeDoesNotContainType occurrences="4">
-      <code>is_array($content)</code>
-      <code>is_string($spec['token'])</code>
-      <code>isset($spec['token'])</code>
-      <code>isset($spec['token']) &amp;&amp; is_string($spec['token'])</code>
-    </TypeDoesNotContainType>
-    <UnusedPsalmSuppress occurrences="1">
-      <code>MissingFile</code>
-    </UnusedPsalmSuppress>
-  </file>
-  <file src="test/Unit/QueryTest.php">
-    <InvalidReturnStatement occurrences="2">
-      <code>$queries</code>
-      <code>$queries</code>
-    </InvalidReturnStatement>
-    <InvalidReturnType occurrences="2">
-      <code>array&lt;string, array{0: Query, 1: string}&gt;</code>
-      <code>array&lt;string, array{0: Query, 1: string}&gt;</code>
-    </InvalidReturnType>
+<files psalm-version="5.11.0@c9b192ab8400fdaf04b2b13d110575adc879aa90">
+  <file src="src/ResultSet/ResultSetFactory.php">
+    <PossiblyUnusedMethod>
+      <code>withHttpResponse</code>
+    </PossiblyUnusedMethod>
   </file>
 </files>
diff --git a/psalm.xml b/psalm.xml
@@ -2,31 +2,21 @@
 <psalm
         errorLevel="1"
         memoizeMethodCallResults="true"
-        findUnusedPsalmSuppress="true"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xmlns="https://getpsalm.org/schema/config"
-        xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd" errorBaseline="psalm-baseline.xml">
+        xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+        errorBaseline="psalm-baseline.xml"
+        findUnusedPsalmSuppress="true"
+        findUnusedCode="true"
+        findUnusedBaselineEntry="true"
+>
     <projectFiles>
         <directory name="src"/>
         <directory name="test"/>
         <ignoreFiles>
             <directory name="vendor"/>
         </ignoreFiles>
     </projectFiles>
-
-    <issueHandlers>
-        <InternalMethod>
-            <errorLevel type="suppress">
-                <referencedMethod name="PHPUnit\Framework\MockObject\Builder\InvocationMocker::method"/>
-            </errorLevel>
-            <errorLevel type="suppress">
-                <referencedMethod name="PHPUnit\Framework\MockObject\Builder\InvocationMocker::willReturn"/>
-            </errorLevel>
-            <errorLevel type="suppress">
-                <referencedMethod name="PHPUnit\Framework\MockObject\Builder\InvocationMocker::with"/>
-            </errorLevel>
-        </InternalMethod>
-    </issueHandlers>
     <plugins>
         <pluginClass class="Psalm\PhpUnitPlugin\Plugin"/>
     </plugins>

diff --git a/src/Api.php b/src/Api.php
@@ -114,7 +114,6 @@ public static function get(
 
     /**
      * phpcs:disable Generic.Files.LineLength.TooLong, Squiz.Commenting.FunctionComment.SpacingAfterParamType
-     * @param T|null $instance
      * @param class-string<ClientInterface>|class-string<RequestFactoryInterface>|class-string<UriFactoryInterface> $type
      *
      * @template T of object

diff --git a/src/Document/Fragment/Factory.php b/src/Document/Fragment/Factory.php
@@ -29,10 +29,6 @@ final class Factory
 {
     use DataAssertionBehaviour;
 
-    public function __construct()
-    {
-    }
-
     public function __invoke(mixed $data): Fragment
     {
         return self::factory($data);

diff --git a/test/Smoke/TestCase.php b/test/Smoke/TestCase.php
@@ -64,7 +64,6 @@ protected static function compileEndPoints(): array
             return $endpoints;
         }
 
-        /** @psalm-suppress MissingFile */
         $content = require $configPath;
         if (! is_array($content)) {
             return $endpoints;

diff --git a/test/Unit/JsonTest.php b/test/Unit/JsonTest.php
@@ -95,4 +95,10 @@ public function testThatThePayloadIsPreservedByTheException(): void
             );
         }
     }
+
+    public function testSuccessfulDecode(): void
+    {
+        $value = Json::decode('{"foo":"bar"}', true);
+        self::assertSame(['foo' => 'bar'], $value);
+    }
 }
diff --git a/test/Unit/PredicateTest.php b/test/Unit/PredicateTest.php
@@ -328,6 +328,7 @@ public function testPredicatesCanBeCastToString(string $fragment, string|int|flo
     /**
      * @param scalar|list<scalar> $value
      *
+     * @psalm-suppress PossiblyUnusedParam
      * @dataProvider atProvider
      */
     public function testSetState(string $fragment, string|int|float|bool|array $value, string $expect): void

diff --git a/test/Unit/QueryTest.php b/test/Unit/QueryTest.php
@@ -69,12 +69,20 @@ public static function queryProvider(): array
     /** @return array<string, array{0: Query, 1: string}> */
     public static function defaultUrlProvider(): array
     {
-        $queries = self::queryProvider();
-        $queries['Standard Form'][1] = 'https://example.com/api/v2?page=1&pageSize=20';
-        $queries['Collection'][1] = sprintf('https://example.com?q=%s&page=1&pageSize=20', urlencode('[[:d = any(document.type, ["doc-type"])]]'));
-        $queries['With Query'][1] = 'https://example.com/?term=something&page=1&pageSize=20';
-
-        return $queries;
+        return [
+            'Standard Form' => [
+                new Query(FormSpec::factory('everything', self::formData()->everything)),
+                'https://example.com/api/v2?page=1&pageSize=20',
+            ],
+            'With Query' => [
+                new Query(FormSpec::factory('withQuery', self::formData()->withQuery)),
+                'https://example.com/?term=something&page=1&pageSize=20',
+            ],
+            'Collection' => [
+                new Query(FormSpec::factory('collection', self::formData()->collection)),
+                sprintf('https://example.com?q=%s&page=1&pageSize=20', urlencode('[[:d = any(document.type, ["doc-type"])]]')),
+            ],
+        ];
     }
 
     /** @dataProvider defaultUrlProvider */
@@ -86,12 +94,20 @@ public function testDefaultUrl(Query $query, string $expectedUrl): void
     /** @return array<string, array{0: Query, 1: string}> */
     public static function queryUrlProvider(): array
     {
-        $queries = self::queryProvider();
-        $queries['Standard Form'][1] = 'https://example.com/api/v2?page=1&pageSize=20&q=foo';
-        $queries['Collection'][1] = sprintf('https://example.com?q=%s&q=foo&page=1&pageSize=20', urlencode('[[:d = any(document.type, ["doc-type"])]]'));
-        $queries['With Query'][1] = 'https://example.com/?term=something&page=1&pageSize=20&q=foo';
-
-        return $queries;
+        return [
+            'Standard Form' => [
+                new Query(FormSpec::factory('everything', self::formData()->everything)),
+                'https://example.com/api/v2?page=1&pageSize=20&q=foo',
+            ],
+            'With Query' => [
+                new Query(FormSpec::factory('withQuery', self::formData()->withQuery)),
+                'https://example.com/?term=something&page=1&pageSize=20&q=foo',
+            ],
+            'Collection' => [
+                new Query(FormSpec::factory('collection', self::formData()->collection)),
+                sprintf('https://example.com?q=%s&q=foo&page=1&pageSize=20', urlencode('[[:d = any(document.type, ["doc-type"])]]')),
+            ],
+        ];
     }
 
     /** @dataProvider queryUrlProvider */

diff --git a/test/Unit/Value/FormSpecTest.php b/test/Unit/Value/FormSpecTest.php
@@ -38,6 +38,8 @@ protected function setUp(): void
 
     public function testBasicAccessors(): void
     {
+        $this->assertEquals('My Form', $this->form->name());
+        $this->assertEquals('something', $this->form->rel());
         $this->assertEquals('GET', $this->form->method());
         $this->assertEquals('https://example.com', $this->form->action());
         $this->assertEquals('whatever', $this->form->encType());

diff --git a/test/Unit/Value/TypeTest.php b/test/Unit/Value/TypeTest.php
@@ -22,6 +22,11 @@ public function testNewInstance(): void
 
     public function testJsonEncode(): void
     {
+        self::assertEquals(
+            ['baz' => 'bat'],
+            Type::new('baz', 'bat')->jsonSerialize(),
+        );
+
         self::assertEquals(
             '{"foo":"bar"}',
             json_encode(Type::new('foo', 'bar'), JSON_THROW_ON_ERROR),