Fix parameters order + Aggregation's SortBy option + more UT

Author: MacFJA

.phan/config.php

@@ -260,9 +260,7 @@
     //
     // This is useful for excluding hopelessly unanalyzable
     // files that can't be removed for whatever reason.
-    'exclude_file_list' => [
-        'src/Kernel.php'
-    ],
+    'exclude_file_list' => [],
 
     // A directory list that defines files that will be excluded
     // from static analysis, but whose class and method
@@ -277,7 +275,6 @@
     //       to `exclude_analysis_directory_list`.
     'exclude_analysis_directory_list' => [
         'vendor/',
-        'src/DataFixtures/',
     ],
 
     // Enable this to enable checks of require/include statements referring to valid paths.

.php_cs

@@ -270,5 +270,6 @@ return PhpCsFixer\Config::create()
         ->exclude('vendor')
         ->in(__DIR__.'/src')
         ->in(__DIR__.'/alias')
+        ->in(__DIR__.'/tests')
     )
     ;

CHANGELOG.md

@@ -11,18 +11,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Shorthand for Reducer functions
 - Add **Deprecated** section in `CHANGELOG.md`
 - Add Redis pipeline support
+- Prefix properties name with `@` in Aggregation's SortBy (keep BC)
+- Add more unit tests (Aggregation options, Field creation)
 
 ### Changed
 
 - Allow `GROUPBY` with no properties
 - Allow `GROUPBY` with no reducers
 - (dev) Replace `php-parallel-lint` lib.
+- (dev) Add Php-Cs-Fixer on `tests/`
+- (dev) Improve Makefile
 
 ### Fixed
 
 - Fix namespace of tests
 - Aggregation result can now be an array
 - Fix Index builder options not preserved ([PR#3])
+- Aggregation SortBy allow 0 (not limit) as value for Max
+- Fix helper removing _"nullish"_ values (`array_filter` is too lax by default)
+- Fix order in fields creation not being correct
 
 ### Deprecated
 

Makefile

@@ -1,7 +1,6 @@
 .PHONY: analyze fix-code test coverage
 
 analyze: | vendor
-	$(COMPOSER) install --optimize-autoloader --no-suggest --prefer-dist
 	$(COMPOSER) exec -v parallel-lint -- src
 	$(COMPOSER) exec -v php-cs-fixer -- fix --dry-run
 	$(COMPOSER) exec -v unused_scanner -- .unused.php
@@ -13,8 +12,7 @@ analyze: | vendor
 	$(COMPOSER) exec -v psalm -- --show-info=true src
 	$(COMPOSER) exec -v phan -- --allow-polyfill-parser --color --color-scheme=light --output-mode=text
 
-fix-code: | vendor
-	$(COMPOSER) install --optimize-autoloader --no-suggest --prefer-dist
+fix-code: |vendor
 	$(COMPOSER) normalize
 	$(COMPOSER) exec -v php-cs-fixer -- fix
 	@#$(COMPOSER) exec -v psalm -- --alter --issues=all src
@@ -23,14 +21,12 @@ test: | vendor
 	$(COMPOSER) exec -v phpunit
 
 coverage: | vendor
+	@if [ -z "`php -v | grep -i 'xdebug'`" ]; then echo "You need to install Xdebug in order to do this action"; exit 1; fi
 	$(COMPOSER) exec -v phpunit -- --coverage-text --color
 
-vendor:
-ifneq (prod,${BUILD_MODE})
-	$(COMPOSER) install --optimize-autoloader
-else
-	APP_ENV=prod $(COMPOSER) install --optimize-autoloader --no-dev --no-suggest --prefer-dist
-endif
+vendor: composer.json
+	$(COMPOSER) install --optimize-autoloader --no-suggest --prefer-dist
+	touch vendor
 
 composer.phar:
 	php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"

src/Aggregate/Exception/NotEnoughPropertiesException.php

@@ -24,7 +24,11 @@
 use OutOfRangeException;
 use Throwable;
 
-/** @deprecated This exception is never used. */
+/**
+ * @codeCoverageIgnore
+ *
+ * @deprecated This exception is never used.
+ */
 class NotEnoughPropertiesException extends OutOfRangeException
 {
     public function __construct(string $message = 'You must have at least one property', int $code = 0, ?Throwable $previous = null)

src/Aggregate/Exception/NotEnoughReducersException.php

@@ -24,7 +24,11 @@
 use OutOfRangeException;
 use Throwable;
 
-/** @deprecated This exception is never used. */
+/**
+ * @codeCoverageIgnore
+ *
+ * @deprecated This exception is never used.
+ */
 class NotEnoughReducersException extends OutOfRangeException
 {
     public function __construct(string $message = 'You must have at least one reducer', int $code = 0, ?Throwable $previous = null)

src/Aggregate/SortBy.php

@@ -30,6 +30,7 @@
 use MacFJA\RediSearch\Helper\DataHelper;
 use MacFJA\RediSearch\Helper\RedisHelper;
 use OutOfRangeException;
+use function strpos;
 use Throwable;
 
 class SortBy implements \MacFJA\RediSearch\PartialQuery
@@ -66,7 +67,7 @@ public function __construct(array $properties, ?int $max = null)
             new UnknownSortDirectionException(array_diff($allValues, ['ASC', 'DESC']))
 
         );
-        DataHelper::assert(null === $max || $max > 0, new OutOfRangeException('MAX such by greater than 0'));
+        DataHelper::assert(null === $max || $max >= 0, new OutOfRangeException('MAX such by greater or equals to 0'));
         $this->properties = $properties;
         $this->max = $max;
     }
@@ -75,6 +76,9 @@ public function getQueryParts(): array
     {
         $query = ['SORTBY', count($this->properties) * 2];
         foreach ($this->properties as $property => $direction) {
+            if (!(0 === strpos($property, '@'))) {
+                $property = '@'.$property;
+            }
             $query[] = $property;
             $query[] = $direction;
         }

src/Helper/RedisHelper.php

@@ -47,7 +47,7 @@ class RedisHelper
      */
     public static function buildQueryBoolean(array $query, array $data): array
     {
-        return array_merge($query, array_keys(array_filter($data, function ($item) {
+        return array_merge($query, array_keys(array_filter($data, function (bool $item): bool {
             return $item;
         })));
     }
@@ -65,6 +65,9 @@ public static function buildQueryBoolean(array $query, array $data): array
     public static function buildQueryList(array $query, array $data, bool $allowEmpty = false): array
     {
         foreach ($data as $queryWord => $list) {
+            if (!is_array($list)) {
+                continue;
+            }
             if (true === $allowEmpty || count($list) > 0) {
                 $query[] = $queryWord;
                 $query[] = count($list);
@@ -80,10 +83,15 @@ public static function buildQueryList(array $query, array $data, bool $allowEmpt
      * @param array<string, null|mixed> $data
      *
      * @return array<float|int|string>
+     *
+     * @phan-suppress PhanPartialTypeMismatchReturn
      */
     public static function buildQueryNotNull($query, array $data): array
     {
-        foreach (array_filter($data) as $queryWord => $value) {
+        $notNullValues = array_filter($data, function ($value): bool {
+            return !(null === $value);
+        });
+        foreach ($notNullValues as $queryWord => $value) {
             $query[] = $queryWord;
             $query[] = $value;
         }
@@ -101,6 +109,9 @@ public static function buildQueryPartial(array $query, array $partials): array
     {
         /** @var PartialQuery $partial */
         foreach (array_filter($partials) as $partial) {
+            if (!$partial instanceof PartialQuery) {
+                continue;
+            }
             $query = array_merge($query, $partial->getQueryParts());
         }
 

src/Index/Builder/AbstractField.php

@@ -21,6 +21,7 @@
 
 namespace MacFJA\RediSearch\Index\Builder;
 
+use function array_merge;
 use function implode;
 use MacFJA\RediSearch\Helper\RedisHelper;
 use SGH\Comparable\ComparatorException;
@@ -80,7 +81,10 @@ public function getName(): string
 
     public function getQueryParts(): array
     {
-        $query = [$this->name, $this->getType()];
+        $query = array_merge(
+            [$this->name, $this->getType()],
+            $this->getAdditionalQueryParts()
+        );
 
         return RedisHelper::buildQueryBoolean($query, [
             'SORTABLE' => $this->sortable,
@@ -96,4 +100,12 @@ public function compareTo($object)
 
         return implode(' ', $object->getQueryParts()) <=> implode(' ', $this->getQueryParts());
     }
+
+    /**
+     * @return array<float|int|string>
+     */
+    protected function getAdditionalQueryParts(): array
+    {
+        return [];
+    }
 }

src/Index/Builder/TagField.php

@@ -51,11 +51,9 @@ public function getSeparator(): ?string
         return $this->separator;
     }
 
-    public function getQueryParts(): array
+    protected function getAdditionalQueryParts(): array
     {
-        $query = parent::getQueryParts();
-
-        return RedisHelper::buildQueryNotNull($query, [
+        return RedisHelper::buildQueryNotNull([], [
             'SEPARATOR' => $this->separator,
         ]);
     }