Rename Index::addFromArray + get index Fields as object (stats)

MacFJA · MacFJA · commit 2020e753afe7 · 2021-01-09T19:10:10.000+01:00
diff --git a/.phan/config.php b/.phan/config.php
@@ -337,6 +337,7 @@
     'directory_list' => [
         'src',
         'vendor/predis/predis',
+        'vendor/sgh/comparable/src'
     ],
 
     // A list of individual files to include in analysis
diff --git a/composer.json b/composer.json
@@ -17,7 +17,8 @@
     ],
     "require": {
         "php": ">= 7.1",
-        "predis/predis": "^1.1"
+        "predis/predis": "^1.1",
+        "sgh/comparable": "^1.1"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^2.16",
diff --git a/phpstan.neon b/phpstan.neon
@@ -1,4 +1,6 @@
 parameters:
 	ignoreErrors:
 		- '#type has no value type specified in iterable type Predis\\Client#'
-		- '#with no value type specified in iterable type Predis\\Client#'
+		- '#with no value type specified in iterable type Predis\\Client#'
+		- message: '#MacFJA\\RedisSearch\\Index\\Builder\\\w+ constructor expects [\w\|]+, bool\|float\|int\|string\|null given#'
+		  path: src/Index/InfoResult.php
diff --git a/src/Helper/DataHelper.php b/src/Helper/DataHelper.php
@@ -32,11 +32,13 @@
 use function is_string;
 use MacFJA\RedisSearch\Index\Exception\IndexNotFoundException;
 use RuntimeException;
+use function settype;
 use function sprintf;
 use function sscanf;
 use function strpos;
 use function strtolower;
 use Throwable;
+use UnexpectedValueException;
 
 class DataHelper
 {
@@ -79,20 +81,7 @@ public static function assert(bool $condition, $exception = null, int $deep = 1)
      */
     public static function assertArrayOf(array $array, string $type, $exception = null): void
     {
-        switch ($type) {
-            case 'int':
-                $type = 'integer';
-
-                break;
-            case 'bool':
-                $type = 'boolean';
-
-                break;
-            case 'float':
-                $type = 'double';
-
-                break;
-        }
+        $type = self::getPhpType($type);
         foreach ($array as $item) {
             if (in_array($type, ['string', 'boolean', 'integer', 'double'], true)) {
                 self::assert(gettype($item) === $type, $exception, 2);
@@ -120,4 +109,40 @@ public static function handleRawResult($result): void
             throw new IndexNotFoundException();
         }
     }
+
+    /**
+     * @param null|bool|float|int|string $raw
+     *
+     * @return null|bool|float|int|string
+     */
+    public static function nullOrCast($raw, string $cast)
+    {
+        if (is_scalar($raw)) {
+            settype($raw, self::getPhpType($cast, true));
+        }
+
+        return $raw;
+    }
+
+    private static function getPhpType(string $type, bool $exceptionOnUnknown = false): string
+    {
+        switch ($type) {
+            case 'int':
+            case 'integer':
+                return 'integer';
+            case 'bool':
+            case 'boolean':
+                return 'boolean';
+            case 'float':
+            case 'double':
+                return 'double';
+            case 'string':
+                return 'string';
+        }
+        if (true === $exceptionOnUnknown) {
+            throw new UnexpectedValueException(sprintf('The type "%s" is unknown', $type));
+        }
+
+        return $type;
+    }
 }
diff --git a/src/Helper/RedisHelper.php b/src/Helper/RedisHelper.php
@@ -27,6 +27,7 @@
 use function array_filter;
 use function array_keys;
 use function array_merge;
+use function array_shift;
 use function assert;
 use function count;
 use function is_array;
@@ -119,4 +120,19 @@ public static function getPairs(array $notKeyedArray): array
 
         return $keyed;
     }
+
+    /**
+     * @param array<float|int|string> $notKeyedArray
+     */
+    public static function getValue(array $notKeyedArray, string $key): ?string
+    {
+        while (count($notKeyedArray) > 0) {
+            $shifted = array_shift($notKeyedArray);
+            if ($shifted === $key && count($notKeyedArray) > 0) {
+                return (string) array_shift($notKeyedArray);
+            }
+        }
+
+        return null;
+    }
 }
diff --git a/src/Index.php b/src/Index.php
@@ -31,6 +31,7 @@
 use MacFJA\RedisSearch\Index\InfoResult;
 use Predis\Client;
 use Throwable;
+use function trigger_error;
 use function uniqid;
 
 class Index
@@ -54,8 +55,23 @@ public function __construct(string $indexKey, Client $redis)
      * @param array<string,float|int|string> $properties
      *
      * @throws Throwable
+     *
+     * @deprecated Use `addDocumentFromArray` instead
+     * @see Index::addDocumentFromArray()
      */
     public function addFromArray(array $properties, ?string $hash = null): string
+    {
+        trigger_error('The method '.__METHOD__.' is deprecated. Use \MacFJA\RedisSearch\Index::addDocumentFromArray instead.', \E_USER_DEPRECATED);
+
+        return $this->addDocumentFromArray($properties, $hash);
+    }
+
+    /**
+     * @param array<string,float|int|string> $properties
+     *
+     * @throws Throwable
+     */
+    public function addDocumentFromArray(array $properties, ?string $hash = null): string
     {
         DataHelper::assertArrayOf(array_keys($properties), 'string');
         DataHelper::assertArrayOf($properties, 'scalar');
diff --git a/src/Index/Builder/AbstractField.php b/src/Index/Builder/AbstractField.php
@@ -21,7 +21,9 @@
 
 namespace MacFJA\RedisSearch\Index\Builder;
 
+use function implode;
 use MacFJA\RedisSearch\Helper\RedisHelper;
+use SGH\Comparable\ComparatorException;
 
 abstract class AbstractField implements Field
 {
@@ -88,4 +90,13 @@ public function getQueryParts(): array
             'NOINDEX' => $this->noIndex,
         ]);
     }
+
+    public function compareTo($object)
+    {
+        if (!($object instanceof Field)) {
+            throw new ComparatorException();
+        }
+
+        return implode(' ', $object->getQueryParts()) <=> implode(' ', $this->getQueryParts());
+    }
 }
diff --git a/src/Index/Builder/Field.php b/src/Index/Builder/Field.php
@@ -22,8 +22,9 @@
 namespace MacFJA\RedisSearch\Index\Builder;
 
 use MacFJA\RedisSearch\PartialQuery;
+use SGH\Comparable\Comparable;
 
-interface Field extends PartialQuery
+interface Field extends PartialQuery, Comparable
 {
     public const TYPE_TEXT = 'TEXT';
 
diff --git a/src/Index/InfoResult.php b/src/Index/InfoResult.php
@@ -21,7 +21,18 @@
 
 namespace MacFJA\RedisSearch\Index;
 
+use function array_map;
+use function array_shift;
+use function in_array;
 use MacFJA\RedisSearch\Helper\DataHelper;
+use MacFJA\RedisSearch\Helper\RedisHelper;
+use MacFJA\RedisSearch\Index\Builder\Field;
+use MacFJA\RedisSearch\Index\Builder\GeoField;
+use MacFJA\RedisSearch\Index\Builder\NumericField;
+use MacFJA\RedisSearch\Index\Builder\TagField;
+use MacFJA\RedisSearch\Index\Builder\TextField;
+use function sprintf;
+use UnexpectedValueException;
 
 class InfoResult
 {
@@ -127,6 +138,51 @@ public function getFields(): array
         return $this->fields;
     }
 
+    /**
+     * @return array<Field>
+     */
+    public function getFieldsAsObject(): array
+    {
+        return array_map(function (array $field): Field {
+            $name = (string) array_shift($field);
+            array_shift($field); // type
+            $type = (string) array_shift($field);
+
+            switch ($type) {
+                case 'GEO':
+                    return new GeoField(
+                        $name,
+                        in_array('NOINDEX', $field, true)
+                    );
+                case 'NUMERIC':
+                    return new NumericField(
+                        $name,
+                        in_array('SORTABLE', $field, true),
+                        in_array('NOINDEX', $field, true)
+                    );
+                case 'TAG':
+                    return new TagField(
+                        $name,
+                        RedisHelper::getValue($field, 'SEPARATOR'),
+                        in_array('SORTABLE', $field, true),
+                        in_array('NOINDEX', $field, true)
+                    );
+                case 'TEXT':
+                    return new TextField(
+                        $name,
+                        in_array('NOSTEM', $field, true),
+                        /** @phan-suppress-next-line PhanPartialTypeMismatchArgument */
+                        DataHelper::nullOrCast(RedisHelper::getValue($field, 'WEIGHT'), 'float'),
+                        RedisHelper::getValue($field, 'PHONETIC'),
+                        in_array('SORTABLE', $field, true),
+                        in_array('NOINDEX', $field, true)
+                    );
+                default:
+                    throw new UnexpectedValueException(sprintf('Unknown field type "%s" for field "%s"', $type, $name));
+            }
+        }, $this->fields);
+    }
+
     public function getDocumentCount(): int
     {
         return $this->documentCount;
diff --git a/src/Suggestions.php b/src/Suggestions.php
@@ -34,13 +34,16 @@
 use MacFJA\RedisSearch\Suggestion\Result;
 use Predis\Client;
 
+/**
+ * @property-read int $length
+ */
 class Suggestions
 {
     /** @var string */
     private $dictionaryKey;
 
-    /** @var int */
-    private $length = 0;
+    /** @var ?int */
+    private $length;
 
     /** @var Client */
     private $redis;
@@ -60,7 +63,7 @@ public function __construct(string $dictionaryKey, Client $redis)
     public function __get(string $name)
     {
         if ('length' === $name) {
-            return $this->length;
+            return $this->length ?? $this->length();
         }
 
         return;
@@ -76,6 +79,7 @@ public function add(string $suggestion, float $score, bool $increment = false, ?
         $command = ['FT.SUGADD', $this->dictionaryKey, $suggestion, $score];
         $command = RedisHelper::buildQueryBoolean($command, ['INCR' => $increment]);
         $command = RedisHelper::buildQueryNotNull($command, ['PAYLOAD' => $payload]);
+        /** @phan-suppress-next-line PhanAccessReadOnlyMagicProperty */
         $this->length = $this->redis->executeRaw($command);
     }
 
@@ -105,13 +109,15 @@ public function get(string $prefix, bool $fuzzy = false, bool $withScores = fals
     public function delete(string $suggestion): bool
     {
         $removed = (int) $this->redis->executeRaw(['FT.SUGDEL', $this->dictionaryKey, $suggestion]);
+        /** @phan-suppress-next-line PhanAccessReadOnlyMagicProperty */
         $this->length -= $removed;
 
         return 1 === $removed;
     }
 
     public function length(): int
     {
+        /** @phan-suppress-next-line PhanAccessReadOnlyMagicProperty */
         $this->length = (int) $this->redis->executeRaw(['FT.SUGLEN', $this->dictionaryKey]);
 
         return $this->length;

Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,9 @@`
`22`	`22`	`namespace MacFJA\RedisSearch\Index\Builder;`
`23`	`23`
`24`	`24`	`use MacFJA\RedisSearch\PartialQuery;`
	`25`	`+use SGH\Comparable\Comparable;`
`25`	`26`
`26`		`-interface Field extends PartialQuery`
	`27`	`+interface Field extends PartialQuery, Comparable`
`27`	`28`	`{`
`28`	`29`	`public const TYPE_TEXT = 'TEXT';`
`29`	`30`