Merge pull request #16 from simPod/coding-standard

Add Doctrine Coding standard

Author: bpolaszek

.github/workflows/coding-standards.yml

@@ -0,0 +1,34 @@
+name: "Coding Standards"
+
+on:
+  pull_request:
+  push:
+    branches:
+      - "master"
+
+jobs:
+  coding-standards:
+    name: "Coding Standards"
+    runs-on: "ubuntu-20.04"
+
+    strategy:
+      matrix:
+        php-version:
+          - "7.3"
+
+    steps:
+      - name: "Checkout"
+        uses: "actions/checkout@v2"
+
+      - name: "Install PHP"
+        uses: "shivammathur/setup-php@v2"
+        with:
+          coverage: "none"
+          php-version: "${{ matrix.php-version }}"
+          tools: "cs2pr"
+
+      - name: "Install dependencies with Composer"
+        uses: "ramsey/composer-install@v1"
+
+      - name: "Run PHP_CodeSniffer"
+        run: "vendor/bin/phpcs -q --no-colors --report=checkstyle | cs2pr"

.gitignore

@@ -1,4 +1,5 @@
-/vendor
-
+/.phpcs-cache
 /composer.lock
+/phpcs.xml
 /phpunit.xml
+/vendor/

composer.json

@@ -10,6 +10,9 @@
         "files": ["src/iterable-functions.php"]
     },
     "autoload-dev": {
+        "psr-4": {
+            "BenTools\\IterableFunctions\\Tests\\": "tests"
+        },
         "files": [
             "vendor/symfony/var-dumper/Resources/functions/dump.php"
         ]
@@ -18,8 +21,8 @@
         "php": "^7.3 || ^8.0"
     },
     "require-dev": {
+        "doctrine/coding-standard": "^8.2",
         "phpunit/phpunit": "^9",
-        "squizlabs/php_codesniffer": "^2.0|^3.4",
         "symfony/var-dumper": "^5.2"
     },
     "config": {

phpcs.xml.dist

@@ -0,0 +1,24 @@
+<?xml version="1.0"?>
+<ruleset
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd"
+>
+    <arg name="basepath" value="." />
+    <arg name="extensions" value="php" />
+    <arg name="parallel" value="80" />
+    <arg name="cache" value=".phpcs-cache" />
+    <arg name="colors" />
+
+    <!-- Ignore warnings, show progress of the run and show sniff names -->
+    <arg value="nps" />
+
+    <rule ref="Doctrine">
+        <exclude name="SlevomatCodingStandard.TypeHints.PropertyTypeHint.MissingNativeTypeHint" />
+
+        <exclude name="Generic.Formatting.MultipleStatementAlignment"/>
+        <exclude name="Squiz.Commenting.FunctionComment.SpacingAfterParamType"/>
+    </rule>
+
+    <file>src/</file>
+    <file>tests/</file>
+</ruleset>

src/IterableObject.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace BenTools\IterableFunctions;
 
 use EmptyIterator;
@@ -11,21 +13,18 @@
  */
 final class IterableObject implements IteratorAggregate
 {
-    /**
-     * @var iterable|array|Traversable
-     */
+    /** @var iterable<mixed> */
     private $iterable;
 
-    /**
-     * @var callable
-     */
+    /** @var callable */
     private $filterFn;
 
-    /**
-     * @var callable
-     */
+    /** @var callable */
     private $mapFn;
 
+    /**
+     * @param iterable<mixed>|null $iterable
+     */
     public function __construct(?iterable $iterable = null, ?callable $filter = null, ?callable $map = null)
     {
         $this->iterable = $iterable ?? new EmptyIterator();
@@ -43,27 +42,35 @@ public function map(callable $map): self
         return new self($this->iterable, $this->filterFn, $map);
     }
 
+    /**
+     * @return Traversable<mixed>
+     */
     public function getIterator(): Traversable
     {
         $iterable = $this->iterable;
-        if (null !== $this->filterFn) {
+        if ($this->filterFn !== null) {
             $iterable = iterable_filter($iterable, $this->filterFn);
         }
-        if (null !== $this->mapFn) {
+
+        if ($this->mapFn !== null) {
             $iterable = iterable_map($iterable, $this->mapFn);
         }
+
         return iterable_to_traversable($iterable);
     }
 
+    /** @return array<mixed> */
     public function asArray(): array
     {
         $iterable = $this->iterable;
-        if (null !== $this->filterFn) {
+        if ($this->filterFn !== null) {
             $iterable = iterable_filter($iterable, $this->filterFn);
         }
-        if (null !== $this->mapFn) {
+
+        if ($this->mapFn !== null) {
             $iterable = iterable_map($iterable, $this->mapFn);
         }
+
         return iterable_to_array($iterable);
     }
 }

src/iterable-functions.php

@@ -1,18 +1,25 @@
 <?php
 
-namespace BenTools\IterableFunctions;
+declare(strict_types=1);
 
+namespace BenTools\IterableFunctions;
 
 use ArrayIterator;
 use CallbackFilterIterator;
 use IteratorIterator;
 use Traversable;
 
+use function array_filter;
+use function array_map;
+use function array_values;
+use function iterator_to_array;
+
 /**
  * Maps a callable to an iterable.
  *
- * @param array|Traversable $iterable
- * @return array|ArrayIterator
+ * @param iterable<mixed> $iterable
+ *
+ * @return iterable<mixed>
  */
 function iterable_map(iterable $iterable, callable $map): iterable
 {
@@ -23,27 +30,29 @@ function iterable_map(iterable $iterable, callable $map): iterable
     return array_map($map, $iterable);
 }
 
-
 /**
  * Copy the iterable into an array. If the iterable is already an array, return it.
  *
- * @param array|Traversable $iterable
- * @param bool $use_keys [optional] Whether to use the iterator element keys as index.
- * @return array
+ * @param iterable<mixed> $iterable
+ * @param bool $preserveKeys [optional] Whether to use the iterator element keys as index.
+ *
+ * @return array<mixed>
  */
-function iterable_to_array(iterable $iterable, bool $use_keys = true): array
+function iterable_to_array(iterable $iterable, bool $preserveKeys = true): array
 {
     if ($iterable instanceof Traversable) {
-        return iterator_to_array($iterable, $use_keys);
+        return iterator_to_array($iterable, $preserveKeys);
     }
 
-    return $use_keys ? $iterable : array_values($iterable);
+    return $preserveKeys ? $iterable : array_values($iterable);
 }
 
 /**
- * If the iterable is not intance of Traversable, it is an array => convert it to an ArrayIterator.
+ * If the iterable is not instance of Traversable, it is an array => convert it to an ArrayIterator.
+ *
+ * @param iterable<mixed> $iterable
  *
- * @param array|Traversable $iterable
+ * @return Traversable<mixed>
  */
 function iterable_to_traversable(iterable $iterable): Traversable
 {
@@ -54,16 +63,16 @@ function iterable_to_traversable(iterable $iterable): Traversable
     return new ArrayIterator($iterable);
 }
 
-
 /**
  * Filters an iterable.
  *
- * @param array|Traversable $iterable
- * @return array|CallbackFilterIterator
+ * @param iterable<mixed> $iterable
+ *
+ * @return array<mixed>|CallbackFilterIterator
  */
 function iterable_filter(iterable $iterable, ?callable $filter = null)
 {
-    if (null === $filter) {
+    if ($filter === null) {
         $filter = static function ($value) {
             return (bool) $value;
         };
@@ -76,21 +85,19 @@ function iterable_filter(iterable $iterable, ?callable $filter = null)
     return array_filter($iterable, $filter);
 }
 
-
 /**
  * Reduces an iterable.
  *
  * @param iterable<mixed> $iterable
  * @param callable(mixed, mixed) $reduce
+ *
  * @return mixed
  *
  * @psalm-template TValue
  * @psalm-template TResult
- *
  * @psalm-param iterable<TValue> $iterable
  * @psalm-param callable(TResult|null, TValue) $reduce
  * @psalm-param TResult|null $initial
- *
  * @psalm-return TResult|null
  */
 function iterable_reduce(iterable $iterable, callable $reduce, $initial = null)
@@ -102,6 +109,9 @@ function iterable_reduce(iterable $iterable, callable $reduce, $initial = null)
     return $initial;
 }
 
+/**
+ * @param iterable<mixed> $iterable
+ */
 function iterable(iterable $iterable, ?callable $filter = null, ?callable $map = null): IterableObject
 {
     return new IterableObject($iterable, $filter, $map);

tests/IterableFilterTest.php

@@ -1,6 +1,12 @@
 <?php
 
+declare(strict_types=1);
+
+namespace BenTools\IterableFunctions\Tests;
+
 use PHPUnit\Framework\TestCase;
+use SplFixedArray;
+
 use function BenTools\IterableFunctions\iterable_filter;
 use function BenTools\IterableFunctions\iterable_to_array;
 
@@ -10,7 +16,7 @@ public function testArrayFilter(): void
     {
         $iterable = ['foo', 'bar'];
         $filter = static function ($input) {
-            return 'bar' === $input;
+            return $input === 'bar';
         };
         $this->assertEquals([1 => 'bar'], iterable_to_array(iterable_filter($iterable, $filter)));
     }
@@ -19,7 +25,7 @@ public function testTraversableFilter(): void
     {
         $iterable = SplFixedArray::fromArray(['foo', 'bar']);
         $filter = static function ($input) {
-            return 'bar' === $input;
+            return $input === 'bar';
         };
         $this->assertEquals([1 => 'bar'], iterable_to_array(iterable_filter($iterable, $filter)));
     }

tests/IterableMapTest.php

@@ -1,6 +1,12 @@
 <?php
 
+declare(strict_types=1);
+
+namespace BenTools\IterableFunctions\Tests;
+
 use PHPUnit\Framework\TestCase;
+use SplFixedArray;
+
 use function BenTools\IterableFunctions\iterable_map;
 use function BenTools\IterableFunctions\iterable_to_array;