Merge pull request #2 from Jeckel-Lab/feature/fix-psalm-error

Fix psalm errors

.github/workflows/validate.yml

@@ -62,3 +62,5 @@ jobs:
         run: composer install $COMPOSER_FLAGS --no-interaction --prefer-dist --dev
       - name: Psalm
         run: ./vendor/bin/psalm
+      - name: PHPStan
+        run: ./vendor/bin/phpstan

.gitignore

@@ -1,3 +1,4 @@
+/.idea/
 /vendor/
 /composer.lock
-/.phpcs-cache
+/.phpcs-cache

composer.json

@@ -11,7 +11,8 @@
         "vimeo/psalm": "^4.3",
         "squizlabs/php_codesniffer": "^3.5",
         "phpmd/phpmd": "^2.8",
-        "phpro/grumphp": "^0.19 || ^1.2.0"
+        "phpro/grumphp": "^0.19 || ^1.2.0",
+        "phpstan/phpstan": "^0.12.91"
     },
     "suggest": {
         "vimeo/psalm": "Using psalm with this 'contract' will enable immutability and strong typing verification"

grumphp.yml

@@ -13,3 +13,6 @@ grumphp:
       threads: 1
       triggered_by: ['php']
       show_info: true
+    phpstan:
+      configuration: phpstan.neon
+      use_grumphp_paths: true

phpstan.neon

@@ -0,0 +1,6 @@
+parameters:
+	checkGenericClassInNonGenericObjectType: false
+	level: 8
+	paths:
+		- src
+

ruleset.xml

@@ -7,18 +7,21 @@
          xsi:noNamespaceSchemaLocation="
                      http://pmd.sf.net/ruleset_xml_schema.xsd">
     <description>
-        My custom rule set that checks my code...
+        Jeckel-Lab/Identity-Contract PHPMD RuleSet
     </description>
 
-    <rule ref="rulesets/cleancode.xml">
-        <exclude name="IfStatementAssignment" />
-        <exclude name="StaticAccess" />
-    </rule>
-
+    <rule ref="rulesets/cleancode.xml" />
     <rule ref="rulesets/codesize.xml" />
     <rule ref="rulesets/design.xml" />
     <rule ref="rulesets/naming.xml">
         <exclude name="ShortVariable" />
     </rule>
     <rule ref="rulesets/unusedcode.xml" />
+    <rule ref="rulesets/naming.xml/ShortVariable">
+        <properties>
+            <property name="exceptions">
+                <value>id</value>
+            </property>
+        </properties>
+    </rule>
 </ruleset>

src/IdentityAbstract.php

@@ -32,6 +32,7 @@ abstract class IdentityAbstract implements Equality, Identity
      */
     final public function __construct($id)
     {
+        /** @psalm-suppress UnusedMethodCall */
         $this->validate($id);
 
         $this->id = $id;
@@ -68,14 +69,15 @@ public function jsonSerialize()
     }
 
     /**
-     * @param mixed $id
+     * @param mixed $object
      * @return bool
      */
-    public function equals($id): bool
+    public function equals($object): bool
     {
-        return is_object($id)
-            && \get_class($this) === \get_class($id)
-            && $this->id === $id->id;
+        return is_object($object)
+            && $object instanceof self
+            && \get_class($this) === \get_class($object)
+            && $this->id === $object->id;
     }
 
     /**