Merge pull request #34 from MacFJA/update-tools

Update dev tools version (PHP-CS-Fixer + PHPStan)

Author: MacFJA

.php-cs-fixer.dist.php

@@ -1,10 +1,32 @@
 <?php
+
+declare(strict_types=1);
+
 /*
+ * Copyright MacFJA
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+ * documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+ * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+ * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * ----------
+ *
  * This document has been generated with
  * https://mlocati.github.io/php-cs-fixer-configurator/#version:3.0.0|configurator
  * you can change this configuration by importing this file.
  */
+
 $config = new PhpCsFixer\Config();
+
 return $config
     ->setRiskyAllowed(true)
     ->setRules([
@@ -17,15 +39,15 @@
         '@PhpCsFixer' => true,
         'combine_nested_dirname' => true,
         'dir_constant' => true,
-        'global_namespace_import' => ['import_functions'=>true],
-        'header_comment' => ['comment_type'=>'comment','header'=>"Copyright MacFJA\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated\ndocumentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the\nrights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the\nSoftware.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE\nWARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR\nOTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",'location'=>'after_declare_strict'],
+        'global_namespace_import' => ['import_functions' => true],
+        'header_comment' => ['comment_type' => 'comment', 'header' => "Copyright MacFJA\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated\ndocumentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the\nrights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the\nSoftware.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE\nWARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR\nOTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.", 'location' => 'after_declare_strict'],
         'implode_call' => true,
         'logical_operators' => true,
         'modernize_types_casting' => true,
         'native_function_invocation' => true,
-        'no_alias_functions' => ['sets'=>['@all']],
+        'no_alias_functions' => ['sets' => ['@all']],
         'no_php4_constructor' => true,
-        'no_superfluous_phpdoc_tags' => ['allow_mixed'=>true,'remove_inheritdoc'=>true],
+        'no_superfluous_phpdoc_tags' => ['allow_mixed' => true, 'remove_inheritdoc' => true],
         'no_unreachable_default_argument_value' => true,
         'no_useless_sprintf' => true,
         'php_unit_dedicate_assert' => true,
@@ -43,9 +65,10 @@
         'ternary_to_elvis_operator' => true,
         'void_return' => true,
     ])
-    ->setFinder(PhpCsFixer\Finder::create()
-        ->exclude('vendor')
-        ->in(__DIR__.'/src')
-        ->in(__DIR__.'/tests')
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->exclude('vendor')
+            ->in(__DIR__.'/src')
+            ->in(__DIR__.'/tests')
     )
-    ;
+    ;

.unused.dist.php

@@ -1,24 +1,20 @@
 
 <?php
 
-$projectPath = __DIR__ . '/';
+$projectPath = __DIR__.'/';
 
 $scanDirectories = [
-    $projectPath . '/src/',
-    $projectPath . '/tests/',
+    $projectPath.'/src/',
+    $projectPath.'/tests/',
 ];
 
 return [
-    /**
-     * Required params
-     **/
-    'composerJsonPath' => $projectPath . '/composer.json',
-    'vendorPath' => $projectPath . '/vendor/',
+    // Required params
+    'composerJsonPath' => $projectPath.'/composer.json',
+    'vendorPath' => $projectPath.'/vendor/',
     'scanDirectories' => $scanDirectories,
 
-    /**
-     * Optional params
-     **/
+    // Optional params
     'skipPackages' => [
         'phpmd/phpmd', // QA tool
         'vimeo/psalm', // QA tool
@@ -28,10 +24,10 @@
         'enlightn/security-checker', // QA tool
         'php-parallel-lint/php-parallel-lint', // QA tool
         'sebastian/phpcpd', // QA tool
-        'ukko/phpredis-phpdoc' // Stubs
+        'ukko/phpredis-phpdoc', // Stubs
     ],
     'excludeDirectories' => [],
     'scanFiles' => [],
     'extensions' => ['*.php'],
-    'requireDev' => true
-];
+    'requireDev' => true,
+];

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased v2.x]
 
+### Changed
+
+- (dev) Update version and rules of PHP-CS-Fixer and PHPStan
+
 ## [2.1.1]
 
 ### Fixed

Makefile

@@ -2,7 +2,7 @@
 
 analyze: | vendor
 	$(COMPOSER) exec -v parallel-lint -- src
-	$(COMPOSER) exec -v php-cs-fixer -- fix --dry-run
+	$(COMPOSER) exec -v php-cs-fixer -- fix --dry-run -v
 	$(COMPOSER) exec -v unused_scanner -- .unused.dist.php
 	$(COMPOSER) exec -v security-checker -- security:check
 	$(COMPOSER) exec -v phpcpd -- --fuzzy src
@@ -13,7 +13,7 @@ analyze: | vendor
 
 fix-code: | vendor
 	$(COMPOSER) normalize
-	$(COMPOSER) exec -v php-cs-fixer -- fix
+	$(COMPOSER) exec -v php-cs-fixer -- fix -v
 
 test: | vendor
 	$(COMPOSER) exec -v phpunit
@@ -55,4 +55,4 @@ ifneq ($(shell command -v composer > /dev/null ; echo $$?), 0)
   COMPOSER=php composer.phar
 else
   COMPOSER=composer
-endif
+endif

composer.json

@@ -1,20 +1,24 @@
 {
     "name": "macfja/redisearch",
-    "type": "library",
     "description": "PHP Client for RediSearch",
+    "license": "MIT",
+    "type": "library",
     "keywords": [
         "Redis",
         "RediSearch",
         "Search Engine",
         "Suggestion"
     ],
     "readme": "README.md",
-    "license": "MIT",
     "authors": [
         {
             "name": "MacFJA"
         }
     ],
+    "support": {
+        "issues": "https://github.com/MacFJA/php-redisearch/issues",
+        "source": "https://github.com/MacFJA/php-redisearch"
+    },
     "require": {
         "php": "^7.2 || ^8.0",
         "ext-intl": "*",
@@ -55,12 +59,6 @@
         "ptrofimov/tinyredisclient": "To use TinyRedisClient implementation",
         "redisent/redisent": "To use Redisent implementation"
     },
-    "config": {
-        "allow-plugins": {
-            "composer/package-versions-deprecated": true,
-            "ergebnis/composer-normalize": true
-        }
-    },
     "autoload": {
         "psr-4": {
             "MacFJA\\RediSearch\\": "src/"
@@ -71,8 +69,10 @@
             "MacFJA\\RediSearch\\tests\\": "tests/"
         }
     },
-    "support": {
-        "issues": "https://github.com/MacFJA/php-redisearch/issues",
-        "source": "https://github.com/MacFJA/php-redisearch"
+    "config": {
+        "allow-plugins": {
+            "composer/package-versions-deprecated": true,
+            "ergebnis/composer-normalize": true
+        }
     }
 }

src/Index.php

@@ -44,10 +44,13 @@ class Index
 {
     /** @var Client */
     private $client;
+
     /** @var InfoResponse */
     private $info;
+
     /** @var string */
     private $index;
+
     /** @var string */
     private $version;
 

src/IndexBuilder.php

@@ -97,40 +97,58 @@ class IndexBuilder
     use AddFieldOptionTrait;
 
     private const IS_ARRAY = ['prefixes', 'stopWords', 'fields'];
+
     /** @var null|string */
     private $index;
+
     /** @var null|string */
     private $structure;
+
     /** @var array<string> */
     private $prefixes = [];
+
     /** @var null|string */
     private $filter;
+
     /** @var null|string */
     private $defaultLanguage;
+
     /** @var null|string */
     private $languageField;
+
     /** @var null|float */
     private $defaultScore;
+
     /** @var null|string */
     private $scoreField;
+
     /** @var null|string */
     private $payloadField;
+
     /** @var bool */
     private $maxTextFields = false;
+
     /** @var null|int */
     private $temporary;
+
     /** @var bool */
     private $noOffsets = false;
+
     /** @var bool */
     private $noHighLight = false;
+
     /** @var bool */
     private $noFields = false;
+
     /** @var bool */
     private $noFrequencies = false;
+
     /** @var bool */
     private $skipInitialScan = false;
+
     /** @var null|array<string> */
     private $stopWords;
+
     /** @var array<CreateCommandFieldOption> */
     private $fields = [];
 

src/Query/Builder/EncapsulationGroup.php

@@ -25,10 +25,13 @@ class EncapsulationGroup implements QueryElement, QueryElementDecorator
 {
     /** @var string */
     private $open;
+
     /** @var string */
     private $close;
+
     /** @var bool */
     private $omitIfNoSpace;
+
     /** @var QueryElement */
     private $element;
 

src/Query/Builder/FieldFacet.php

@@ -29,6 +29,7 @@ class FieldFacet implements QueryElement
 {
     /** @var array<string> */
     private $fields;
+
     /** @var QueryElement */
     private $element;
 

src/Query/Builder/Fuzzy.php

@@ -28,6 +28,7 @@ class Fuzzy implements QueryElement
 {
     /** @var string */
     private $word;
+
     /** @var int */
     private $distance;
 

src/Redis/Client.php

@@ -43,8 +43,6 @@ public function execute(Command $command);
     public function executeRaw(...$args);
 
     /**
-     * @param Command ...$commands
-     *
      * @return array<mixed>
      */
     public function pipeline(Command ...$commands): array;

src/Redis/Client/AbstractClient.php

@@ -41,8 +41,6 @@ public function pipeline(Command ...$commands): array
     }
 
     /**
-     * @param Command ...$commands
-     *
      * @return array<mixed>
      */
     abstract protected function doPipeline(Command ...$commands): array;

src/Redis/Client/ClientFacade.php

@@ -53,9 +53,6 @@ public function getClient($redis): Client
     {
         /** @var Client $factory */
         foreach ($this->factories as $factory) {
-            if (!is_subclass_of($factory, Client::class)) {
-                continue;
-            }
             if ($factory::supports($redis)) {
                 return $factory::make($redis);
             }

src/Redis/Command/AbstractCommand.php

@@ -34,10 +34,12 @@ abstract class AbstractCommand implements Command
 {
     public const MAX_IMPLEMENTED_VERSION = '2.0.12';
     public const MIN_IMPLEMENTED_VERSION = '2.0.0';
+
     /**
      * @var array<array<CommandOption>|CommandOption|mixed>
      */
     protected $options;
+
     /** @var string */
     private $rediSearchVersion;
 

src/Redis/Command/AggregateCommand/GroupByOption.php

@@ -31,6 +31,7 @@ class GroupByOption extends AbstractCommandOption
 
     /** @var array<ReduceOption> */
     private $reducers = [];
+
     /** @var array<string> */
     private $fields;
 

src/Redis/Command/AggregateCommand/SortByOption.php

@@ -29,8 +29,10 @@
 class SortByOption extends AbstractCommandOption
 {
     use PrefixFieldName;
+
     /** @var array<string,null|string> */
     private $fields = [];
+
     /** @var null|int */
     private $max;
 

src/Redis/Command/CreateCommand/JSONFieldOption.php

@@ -27,6 +27,7 @@ class JSONFieldOption extends AbstractCommandOption implements CreateCommandJSON
 {
     /** @var CreateCommandFieldOption */
     private $decorated;
+
     /** @var string */
     private $path;
 

src/Redis/Command/Option/AbstractCommandOption.php

@@ -22,6 +22,7 @@
 namespace MacFJA\RediSearch\Redis\Command\Option;
 
 use Composer\Semver\Semver;
+use function is_scalar;
 use UnexpectedValueException;
 
 abstract class AbstractCommandOption implements CommandOption

src/Redis/Command/Option/FlagOption.php

@@ -25,6 +25,7 @@ class FlagOption extends AbstractCommandOption
 {
     /** @var string */
     private $name;
+
     /** @var bool */
     private $active;