lodash-php · pierredup · Dec 12, 2023 · Dec 12, 2023
diff --git a/.github/workflows/cs.yml b/.github/workflows/cs.yml
@@ -16,7 +16,7 @@ jobs:
             - name: Setup PHP
               uses: shivammathur/setup-php@v2
               with:
-                  php-version: 7.4
+                  php-version: 8.2
                   tools: composer
 
             - name: Get composer cache directory
@@ -33,5 +33,5 @@ jobs:
             - name: Install dependencies
               run: composer install --prefer-dist
 
-            - name: PHP-CS-Fixer
-              run: vendor/bin/php-cs-fixer fix --dry-run -v
+            - name: ECS
+              run: vendor/bin/ecs
diff --git a/.php-version b/.php-version
@@ -1 +1 @@
-7.4
+7.1
diff --git a/bin/compile b/bin/compile
@@ -5,8 +5,6 @@
 
 declare(strict_types=1);
 
-require_once dirname(__DIR__).'/vendor/autoload.php';
-
 function getCode(SplFileInfo $file): string
 {
     $code = php_strip_whitespace($file->getRealPath());

diff --git a/composer.json b/composer.json
@@ -28,10 +28,10 @@
         "symfony/property-access": "^2.7 | ^3.0 | ^4.0 | ^5.0"
     },
     "require-dev": {
-        "phpdocumentor/reflection-docblock": "*",
+        "phpdocumentor/reflection-docblock": "^4.3 || 5.2",
         "phpstan/phpdoc-parser": "*",
         "phpunit/phpunit": "^7.3 || ^8.4",
-        "phpstan/phpstan": "^0.12",
-        "friendsofphp/php-cs-fixer": "^2.12"
+        "phpstan/phpstan": "*",
+        "symplify/easy-coding-standard": ">=10.0,<= 13.0"
     }
 }
diff --git a/ecs.php b/ecs.php
@@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the SolidWorx Lodash-PHP project.
+ *
+ * @author     Pierre du Plessis <open-source@solidworx.co>
+ * @copyright  Copyright (c) 2017
+ */
+
+use PhpCsFixer\Fixer\Casing\MagicConstantCasingFixer;
+use PhpCsFixer\Fixer\ClassNotation\ClassDefinitionFixer;
+use PhpCsFixer\Fixer\ClassNotation\SelfAccessorFixer;
+use PhpCsFixer\Fixer\ClassNotation\SingleClassElementPerStatementFixer;
+use PhpCsFixer\Fixer\Comment\HeaderCommentFixer;
+use PhpCsFixer\Fixer\ControlStructure\NoUselessElseFixer;
+use PhpCsFixer\Fixer\FunctionNotation\VoidReturnFixer;
+use PhpCsFixer\Fixer\Import\OrderedImportsFixer;
+use PhpCsFixer\Fixer\LanguageConstruct\ExplicitIndirectVariableFixer;
+use PhpCsFixer\Fixer\LanguageConstruct\FunctionToConstantFixer;
+use PhpCsFixer\Fixer\Operator\NewWithBracesFixer;
+use PhpCsFixer\Fixer\Operator\StandardizeIncrementFixer;
+use PhpCsFixer\Fixer\PhpUnit\PhpUnitMethodCasingFixer;
+use PhpCsFixer\Fixer\StringNotation\ExplicitStringVariableFixer;
+use PhpCsFixer\Fixer\StringNotation\SingleQuoteFixer;
+use Symplify\EasyCodingStandard\Config\ECSConfig;
+use Symplify\EasyCodingStandard\ValueObject\Set\SetList;
+
+return static function (ECSConfig $ecsConfig): void {
+    $ecsConfig->paths([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+        __FILE__,
+    ]);
+
+    $ecsConfig->sets([
+        SetList::PSR_12,
+        SetList::SPACES,
+        SetList::DOCBLOCK,
+        SetList::COMMENTS,
+        SetList::PHPUNIT,
+        SetList::NAMESPACES,
+        SetList::CLEAN_CODE,
+    ]);
+
+    $ecsConfig->rules([
+        PhpUnitMethodCasingFixer::class,
+        FunctionToConstantFixer::class,
+        ExplicitStringVariableFixer::class,
+        ExplicitIndirectVariableFixer::class,
+        NewWithBracesFixer::class,
+        StandardizeIncrementFixer::class,
+        SelfAccessorFixer::class,
+        MagicConstantCasingFixer::class,
+        NoUselessElseFixer::class,
+        SingleQuoteFixer::class,
+        // VoidReturnFixer::class,
+    ]);
+
+    $header = <<<'EOF'
+This file is part of the SolidWorx Lodash-PHP project.
+
+@author     Pierre du Plessis <open-source@solidworx.co>
+@copyright  Copyright (c) 2017
+EOF;
+
+    $ecsConfig->ruleWithConfiguration(SingleClassElementPerStatementFixer::class, ['elements' => ['const', 'property']]);
+    $ecsConfig->ruleWithConfiguration(ClassDefinitionFixer::class, ['single_line' => \true]);
+    $ecsConfig->ruleWithConfiguration(OrderedImportsFixer::class, ['imports_order' => ['const', 'class', 'function']]);
+    $ecsConfig->ruleWithConfiguration(HeaderCommentFixer::class, [
+        'comment_type' => 'comment',
+        'header' => \trim($header),
+        'location' => 'after_declare_strict',
+        'separate' => 'both',
+    ]);
+};
diff --git a/src/Array/differenceBy.php b/src/Array/differenceBy.php
@@ -26,7 +26,6 @@
  *
  * @param array    $array    The array to inspect.
  * @param array<int, mixed> ...$values  The values to exclude.
- * @param callable $iteratee The iteratee invoked per element.
  *
  * @return array Returns the new array of filtered values.
  *
@@ -38,11 +37,11 @@
  */
 function differenceBy(array $array, ...$values): array
 {
-    if (!$array) {
+    if (! $array) {
         return [];
     }
 
-    if (!\is_callable(\end($values))) {
+    if (! \is_callable(\end($values))) {
         return difference($array, ...$values);
     }
 

diff --git a/src/Array/differenceWith.php b/src/Array/differenceWith.php
@@ -25,7 +25,6 @@
  *
  * @param array<int, mixed>    $array      The array to inspect.
  * @param array    ...$values  The values to exclude.
- * @param callable $comparator The comparator invoked per element.
  *
  * @return array Returns the new array of filtered values.
  *
@@ -41,11 +40,11 @@
  */
 function differenceWith(array $array, ...$values): array
 {
-    if (!$array) {
+    if (! $array) {
         return [];
     }
 
-    if (!\is_callable(\end($values))) {
+    if (! \is_callable(\end($values))) {
         return difference($array, ...$values);
     }
 

diff --git a/src/Array/findIndex.php b/src/Array/findIndex.php
@@ -50,7 +50,7 @@
 function findIndex(array $array, $predicate, int $fromIndex = null): int
 {
     $length = \count($array);
-    if (!$length) {
+    if (! $length) {
         return -1;
     }
 

diff --git a/src/Array/fromPairs.php b/src/Array/fromPairs.php
@@ -32,7 +32,7 @@
  */
 function fromPairs(array $pairs): \stdClass
 {
-    if (!\count($pairs)) {
+    if (! \count($pairs)) {
         return new \stdClass();
     }
 

diff --git a/src/Array/indexOf.php b/src/Array/indexOf.php
@@ -45,7 +45,7 @@ function indexOf(array $array, $value, int $fromIndex = null): int
             $array = \array_reverse($array, false);
             $inc = false;
         }
-    };
+    }
 
     foreach ($array as $v) {
         if (isEqual($value, $v)) {

diff --git a/src/Array/intersection.php b/src/Array/intersection.php
@@ -19,8 +19,6 @@
  *
  * @category Array
  *
- * @param array ...$arrays
- *
  * @return array the new array of intersecting values.
  *
  * @example

diff --git a/src/Array/intersectionBy.php b/src/Array/intersectionBy.php
@@ -24,7 +24,6 @@
  * @category Array
  *
  * @param array<int, mixed>  ...$arrays
- * @param callable $iteratee The iteratee invoked per element.
  *
  * @return array the new array of intersecting values.
  * @example

diff --git a/src/Array/intersectionWith.php b/src/Array/intersectionWith.php
@@ -22,7 +22,6 @@
  * @category Array
  *
  * @param array    ...$arrays
- * @param callable $comparator The comparator invoked per element.
  *
  * @return array the new array of intersecting values.
  *
@@ -40,7 +39,7 @@ function intersectionWith(...$arrays /*, callable $comparator = null*/): array
     $copy = $arrays;
     $comparator = \array_pop($arrays);
 
-    if (!\is_callable($comparator)) {
+    if (! \is_callable($comparator)) {
         $arrays = $copy;
         $comparator = null;
     }

diff --git a/src/Array/lastIndexOf.php b/src/Array/lastIndexOf.php
@@ -39,7 +39,7 @@ function lastIndexOf(array $array, $value, int $fromIndex = null): int
     if (null !== $fromIndex) {
         $index = $fromIndex > 0 ? $fromIndex : \count($array) - 1;
         $array = \array_slice($array, 0, -$fromIndex + 1);
-    };
+    }
 
     foreach (\array_reverse($array, false) as $v) {
         if (isEqual($value, $v)) {

diff --git a/src/Array/pull.php b/src/Array/pull.php
@@ -24,8 +24,6 @@
  * @param array $array The array to modify.
  * @param array<int, string> $values The values to remove.
  *
- * @return array
- *
  * @example
  * <code>
  * $array = ['a', 'b', 'c', 'a', 'b', 'c']
@@ -38,7 +36,7 @@
 function pull(array &$array, ...$values): array
 {
     $array = \array_filter($array, function ($val) use ($values) {
-        return !\in_array($val, $values, true);
+        return ! \in_array($val, $values, true);
     });
 
     $array = \array_values($array); // Re-index array

diff --git a/src/Array/pullAt.php b/src/Array/pullAt.php
@@ -47,7 +47,7 @@ function pullAt(array &$array, $indexes): array
             $pulled[] = $val;
         }
 
-        return !$inArray;
+        return ! $inArray;
     }, \ARRAY_FILTER_USE_BOTH);
 
     $array = \array_values($array);

diff --git a/src/Array/remove.php b/src/Array/remove.php
@@ -47,7 +47,7 @@ function remove(array &$array, callable $predicate): array
             $resultArray[] = $val;
         }
 
-        return !$result;
+        return ! $result;
     }, \ARRAY_FILTER_USE_BOTH);
 
     $array = \array_values($array); // Re-index array

diff --git a/src/Array/unionBy.php b/src/Array/unionBy.php
@@ -25,7 +25,6 @@
  * @category Array
  *
  * @param array<int, mixed>    ...$arrays The arrays to inspect.
- * @param callable $iteratee  The iteratee invoked per element.
  *
  * @return array the new array of combined values.
  *

diff --git a/src/Array/unionWith.php b/src/Array/unionWith.php
@@ -23,7 +23,6 @@
  * @category Array
  *
  * @param array<int, mixed>    ...$arrays  The arrays to inspect.
- * @param callable $comparator The comparator invoked per element.
  *
  * @return array the new array of combined values.
  *
@@ -38,13 +37,13 @@
  * // => [['x' => 1, 'y' => 2], ['x' => 2, 'y' => 1], ['x' => 1, 'y' => 1]]
  * </code>
  */
-function unionWith(... $arrays): array
+function unionWith(...$arrays): array
 {
     /** @var callable $comparator */
     $comparator = \array_pop($arrays);
 
-    if (!\is_callable($comparator)) {
-        throw new \InvalidArgumentException(__FUNCTION__.' expects the last value passed to be callable');
+    if (! \is_callable($comparator)) {
+        throw new \InvalidArgumentException(__FUNCTION__ . ' expects the last value passed to be callable');
     }
 
     return baseUniq(baseFlatten($arrays, 1, '\is_array', true), null, $comparator);

diff --git a/src/Array/unzip.php b/src/Array/unzip.php
@@ -36,7 +36,7 @@
  */
 function unzip(array $array): array
 {
-    if (!\count($array)) {
+    if (! \count($array)) {
         return [];
     }
 

diff --git a/src/Array/unzipWith.php b/src/Array/unzipWith.php
@@ -36,12 +36,12 @@
  */
 function unzipWith(array $array, ?callable $iteratee = null): array
 {
-    if (!\count($array)) {
+    if (! \count($array)) {
         return [];
     }
 
     $result = unzip($array);
-    if (!is_callable($iteratee)) {
+    if (! is_callable($iteratee)) {
         return $result;
     }
 

diff --git a/src/Array/zipObject.php b/src/Array/zipObject.php
@@ -34,7 +34,7 @@
  */
 function zipObject(array $props = [], array $values = [])
 {
-    $result = new \stdClass;
+    $result = new \stdClass();
     $index = -1;
     $length = \count($props);
     $props = \array_values($props);

diff --git a/src/Array/zipObjectDeep.php b/src/Array/zipObjectDeep.php
@@ -44,7 +44,7 @@
  */
 function zipObjectDeep(array $props = [], array $values = []): \stdClass
 {
-    $result = new \stdClass;
+    $result = new \stdClass();
     $index = -1;
     $length = \count($props);
     $props = \array_values($props);

diff --git a/src/Array/zipWith.php b/src/Array/zipWith.php
@@ -19,7 +19,6 @@
  * @category Array
  *
  * @param array<int, array|callable>  ...$arrays   The arrays to process.
- * @param callable $iteratee The function to combine grouped values.
  *
  * @return array the new array of grouped elements.
  *

diff --git a/src/CacheInterface.php b/src/CacheInterface.php
@@ -6,14 +6,14 @@
  * This file is part of the SolidWorx Lodash-PHP project.
  *
  * @author     Pierre du Plessis <open-source@solidworx.co>
- * @copyright  Copyright (c) 2018
+ * @copyright  Copyright (c) 2017
  */
 
 namespace _;
 
 interface CacheInterface
 {
-    public function set($key, $value): CacheInterface;
+    public function set($key, $value): self;
 
     public function get($key);
 

diff --git a/src/Collection/countBy.php b/src/Collection/countBy.php
@@ -38,7 +38,7 @@
 function countBy(iterable $collection, callable $iteratee): array
 {
     return createAggregator(function ($result, $key, $value) {
-        if (!isset($result[$value])) {
+        if (! isset($result[$value])) {
             $result[$value] = 0;
         }
 

diff --git a/src/Collection/every.php b/src/Collection/every.php
@@ -58,7 +58,7 @@ function every(iterable $collection, $predicate): bool
     $iteratee = baseIteratee($predicate);
 
     foreach ($collection as $key => $value) {
-        if (!$iteratee($value, $key, $collection)) {
+        if (! $iteratee($value, $key, $collection)) {
             return false;
         }
     }

diff --git a/src/Collection/groupBy.php b/src/Collection/groupBy.php
@@ -38,7 +38,7 @@
 function groupBy(iterable $collection, $iteratee): array
 {
     return createAggregator(function ($result, $value, $key) {
-        if (!isset($result[$key])) {
+        if (! isset($result[$key])) {
             $result[$key] = [];
         }