Added Psalm static analyzer

Author: acelot

.github/workflows/pipeline.yml

@@ -9,7 +9,7 @@ jobs:
       fail-fast: false
       matrix:
         operating-system: [ubuntu-latest]
-        php-versions: ['8.0', '8.1', '8.2']
+        php-versions: ['8.0', '8.1', '8.2', '8.3', '8.4']
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -49,7 +49,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: 8.0
+          php-version: 8.4
           tools: phpunit-bridge
           extensions: mbstring, json
           coverage: xdebug

README.md

@@ -50,8 +50,11 @@ $result = a::marshalArray(
         a::toInt()
     )),
     a::toKey('fullname', a::pipe(
-        a::get('[name]'),
-        a::call(fn($v) => $v['firstname'] . ' ' . $v['lastname'])
+        a::marshalNestedArray(
+            a::toKey(0, a::get('[name][firstname]')),
+            a::toKey(1, a::get('[name][lastname]')),
+        ),
+        a::joinArray(' ')
     )),
     a::toKey('skills', a::pipe(
         a::get('[skills]'),

composer.json

@@ -24,7 +24,8 @@
     "nikic/php-parser": "^4.15",
     "friendsofphp/php-cs-fixer": "^3.13",
     "respect/validation": "^2",
-    "giggsey/libphonenumber-for-php": "*"
+    "giggsey/libphonenumber-for-php": "*",
+    "vimeo/psalm": "^5.26"
   },
   "suggest": {
     "respect/validation": "Enables respect-validation integration"
@@ -43,6 +44,7 @@
   },
   "bin": ["bin/generate-static-api"],
   "scripts": {
+    "psalm": "psalm",
     "test": "phpunit",
     "generate-static-api": "generate-static-api",
     "php-cs-fixer": "php-cs-fixer"

psalm.xml

@@ -0,0 +1,18 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="1"
+    resolveFromConfigFile="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"
+    findUnusedBaselineEntry="true"
+    findUnusedCode="false"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <file name="src/Automapper.php" />
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>

src/Api/Helpers.php

@@ -15,17 +15,18 @@ final class Helpers
 {
     public function joinArray(string $separator = ''): Pipeline
     {
+        /** @psalm-suppress MixedArgumentTypeCoercion */
         return new Pipeline(
             new AssertType(AssertType::ARRAY),
-            new Call(fn($value) => implode($separator, $value))
+            new Call(fn(array $value) => implode($separator, $value))
         );
     }
 
     public function sortArray(bool $descending = false, int $options = SORT_REGULAR): Pipeline
     {
         return new Pipeline(
             new AssertType(AssertType::ARRAY),
-            new Call(function ($value) use ($descending, $options) {
+            new Call(function (array $value) use ($descending, $options) {
                 if ($descending) {
                     rsort($value, $options);
                 } else {
@@ -41,7 +42,7 @@ public function uniqueArray(bool $keepKeys = false, int $options = SORT_STRING):
     {
         return new Pipeline(
             new AssertType(AssertType::ARRAY),
-            new Call(function ($value) use ($keepKeys, $options) {
+            new Call(function (array $value) use ($keepKeys, $options) {
                 $items = array_unique($value, $options);
 
                 return $keepKeys ? $items : array_values($items);
@@ -51,12 +52,12 @@ public function uniqueArray(bool $keepKeys = false, int $options = SORT_STRING):
 
     public function ifNotFound(ProcessorInterface $true, ?ProcessorInterface $false = null): Condition
     {
-        return new Condition(fn($value) => $value instanceof NotFoundValue, $true, $false ?? new Pass());
+        return new Condition(fn(mixed $value) => $value instanceof NotFoundValue, $true, $false ?? new Pass());
     }
 
     public function ifEmpty(ProcessorInterface $true, ?ProcessorInterface $false = null): Condition
     {
-        return new Condition(fn($value) => empty($value), $true, $false ?? new Pass());
+        return new Condition(fn(mixed $value) => empty($value), $true, $false ?? new Pass());
     }
 
     public function ifNull(ProcessorInterface $true, ?ProcessorInterface $false = null): Condition
@@ -66,27 +67,31 @@ public function ifNull(ProcessorInterface $true, ?ProcessorInterface $false = nu
 
     public function ifEqual(mixed $to, ProcessorInterface $true, ?ProcessorInterface $false = null, bool $strict = true): Condition
     {
-        return new Condition(fn($value) => $strict ? $value === $to : $value == $to, $true, $false ?? new Pass());
+        return new Condition(fn(mixed $value) => $strict ? $value === $to : $value == $to, $true, $false ?? new Pass());
     }
 
     public function ifNotEqual(mixed $to, ProcessorInterface $true, ?ProcessorInterface $false = null, bool $strict = true): Condition
     {
-        return $this->ifEqual($to, $false, $true, $strict);
+        return new Condition(fn(mixed $value) => $strict ? $value !== $to : $value != $to, $true, $false ?? new Pass());
     }
 
+    /**
+     * @param non-empty-string $separator
+     * @return Pipeline
+     */
     public function explodeString(string $separator): Pipeline
     {
         return new Pipeline(
             new AssertType(AssertType::STRING),
-            new Call(fn($value) => explode($separator, $value))
+            new Call(fn(string $value) => explode($separator, $value))
         );
     }
 
     public function trimString(string $characters = " \t\n\r\0\x0B"): Pipeline
     {
         return new Pipeline(
             new AssertType(AssertType::STRING),
-            new Call(fn($value) => trim($value, $characters))
+            new Call(fn(string $value) => trim($value, $characters))
         );
     }
 
@@ -99,15 +104,15 @@ public function toFloat(): Pipeline
     {
         return new Pipeline(
             new AssertType(AssertType::NULL, AssertType::SCALAR),
-            new Call(fn($value) => is_null($value) ? 0.0 : floatval($value))
+            new Call(fn(mixed $value) => is_null($value) ? 0.0 : floatval($value))
         );
     }
 
     public function toInt(): Pipeline
     {
         return new Pipeline(
             new AssertType(AssertType::NULL, AssertType::SCALAR),
-            new Call(fn($value) => is_null($value) ? 0 : intval($value))
+            new Call(fn(mixed $value) => is_null($value) ? 0 : intval($value))
         );
     }
 
@@ -121,7 +126,7 @@ public function toString(): Pipeline
 
     public function toArray(): Call
     {
-        return new Call(function ($value) {
+        return new Call(function (mixed $value) {
             if ($value instanceof Traversable) {
                 return iterator_to_array($value);
             }

src/Api/Main.php

@@ -36,6 +36,7 @@ public function marshalArray(ContextInterface $context, mixed $source, ToArrayKe
         $mapper = $this->mapperFactory->create($context, ...$fields);
         $mapper->map($source, $target);
 
+        /** @var array<array-key, mixed> $target */
         return $target;
     }
 
@@ -46,6 +47,7 @@ public function marshalObject(ContextInterface $context, mixed $source, ObjectFi
         $mapper = $this->mapperFactory->create($context, ...$fields);
         $mapper->map($source, $target);
 
+        /** @var \stdClass $target */
         return $target;
     }
 }

src/Api/Processors.php

@@ -2,6 +2,7 @@
 
 namespace Acelot\AutoMapper\Api;
 
+use Acelot\AutoMapper\ContextInterface;
 use Acelot\AutoMapper\ExtractorResolver;
 use Acelot\AutoMapper\Field\ToArrayKey;
 use Acelot\AutoMapper\Field\ToObjectProp;
@@ -43,21 +44,41 @@ public function callCtx(callable $callable): CallWithContext
         return new CallWithContext($callable);
     }
 
+    /**
+     * @param callable(mixed): bool $condition
+     * @param ProcessorInterface $true
+     * @param ProcessorInterface|null $false
+     * @return Condition
+     */
     public function condition(callable $condition, ProcessorInterface  $true, ?ProcessorInterface $false = null): Condition
     {
         return new Condition($condition, $true, $false ?? new Pass());
     }
 
+    /**
+     * @param callable(ContextInterface, mixed): bool $condition
+     * @param ProcessorInterface $true
+     * @param ProcessorInterface|null $false
+     * @return ConditionWithContext
+     */
     public function conditionCtx(callable $condition, ProcessorInterface $true, ?ProcessorInterface $false = null): ConditionWithContext
     {
         return new ConditionWithContext($condition, $true, $false ?? new Pass());
     }
 
+    /**
+     * @param callable(mixed, int|string): bool $predicate
+     * @return Find
+     */
     public function find(callable $predicate): Find
     {
         return new Find($predicate);
     }
 
+    /**
+     * @param callable(ContextInterface, mixed, int|string): bool $predicate
+     * @return FindWithContext
+     */
     public function findCtx(callable $predicate): FindWithContext
     {
         return new FindWithContext($predicate);

src/Context/Context.php

@@ -8,7 +8,7 @@
 final class Context implements ContextInterface
 {
     /**
-     * @var array<int|string, mixed> $items
+     * @param array<int|string, mixed> $items
      */
     public function __construct(
         private array $items = []

src/Exception/UnknownPartException.php

@@ -9,13 +9,13 @@
 final class UnknownPartException extends LogicException implements MapperExceptionInterface
 {
     public function __construct(
-        private PartInterface $part
+        private PartInterface|string $part
     )
     {
-        parent::__construct(sprintf('Unknown part `%s`', $part::class));
+        parent::__construct(sprintf('Unknown part `%s`', is_string($part) ? $part : $part::class));
     }
 
-    public function getPart(): PartInterface
+    public function getPart(): PartInterface|string
     {
         return $this->part;
     }

src/Extractor/FromArrayKey.php

@@ -4,13 +4,22 @@
 
 use Acelot\AutoMapper\ExtractorInterface;
 
+/**
+ * @implements ExtractorInterface<array|string>
+ */
 final class FromArrayKey implements ExtractorInterface
 {
+    /**
+     * @param array-key $key
+     */
     public function __construct(
-        private int|string $key
+        private mixed $key
     ) {}
 
-    public function getKey(): string
+    /**
+     * @return array-key
+     */
+    public function getKey(): mixed
     {
         return $this->key;
     }
@@ -25,6 +34,6 @@ public function isExtractable(mixed $source): bool
 
     public function extract(mixed $source): mixed
     {
-        return $source[$this->key];
+        return is_string($source) ? $source[(int) $this->key] : $source[$this->key];
     }
 }