Improve annotations and code quality

Author: alessandro

src/AggregationRule.php

@@ -5,7 +5,8 @@
 
 use Palicao\PhpRedisTimeSeries\Exception\InvalidAggregationException;
 
-class AggregationRule
+/** @psalm-immutable */
+final class AggregationRule
 {
     public const AGG_AVG = 'AVG';
     public const AGG_SUM = 'SUM';

src/DateTimeUtils.php

@@ -7,7 +7,7 @@
 use DateTimeInterface;
 use Palicao\PhpRedisTimeSeries\Exception\TimestampParsingException;
 
-class DateTimeUtils
+final class DateTimeUtils
 {
     public static function dateTimeFromTimestampWithMs(int $timestamp) : DateTimeInterface
     {

src/Exception/InvalidAggregationException.php

@@ -5,6 +5,6 @@
 
 use RuntimeException;
 
-class InvalidAggregationException extends RuntimeException
+final class InvalidAggregationException extends RuntimeException
 {
 }

src/Exception/InvalidFilterOperationException.php

@@ -5,6 +5,6 @@
 
 use InvalidArgumentException;
 
-class InvalidFilterOperationException extends InvalidArgumentException
+final class InvalidFilterOperationException extends InvalidArgumentException
 {
 }

src/Exception/RedisClientException.php

@@ -5,6 +5,6 @@
 
 use RuntimeException;
 
-class RedisClientException extends RuntimeException
+final class RedisClientException extends RuntimeException
 {
 }

src/Exception/TimestampParsingException.php

@@ -5,6 +5,6 @@
 
 use InvalidArgumentException;
 
-class TimestampParsingException extends InvalidArgumentException
+final class TimestampParsingException extends InvalidArgumentException
 {
 }

src/Filter.php

@@ -5,7 +5,7 @@
 
 use Palicao\PhpRedisTimeSeries\Exception\InvalidFilterOperationException;
 
-class Filter
+final class Filter
 {
     public const OP_EQUALS = 0;
     public const OP_NOT_EQUALS = 1;
@@ -23,7 +23,10 @@ class Filter
         self::OP_NOT_IN
     ];
 
-    /** @var array */
+    /**
+     * @var array
+     * @psalm-var array<array{string, int, string|array|null}>
+     */
     private $filters = [];
 
     public function __construct(string $label, string $value)
@@ -69,9 +72,11 @@ public function toRedisParams(): array
         foreach ($this->filters as $filter) {
             switch ($filter[1]) {
                 case self::OP_EQUALS:
+                    assert(is_string($filter[2]));
                     $params[] = $filter[0] . '=' . $filter[2];
                     break;
                 case self::OP_NOT_EQUALS:
+                    assert(is_string($filter[2]));
                     $params[] = $filter[0] . '!=' . $filter[2];
                     break;
                 case self::OP_EXISTS:
@@ -81,9 +86,11 @@ public function toRedisParams(): array
                     $params[] = $filter[0] . '!=';
                     break;
                 case self::OP_IN:
+                    assert(is_array($filter[2]));
                     $params[] = $filter[0] . '=(' . implode(',', $filter[2]) . ')';
                     break;
                 case self::OP_NOT_IN:
+                    assert(is_array($filter[2]));
                     $params[] = $filter[0] . '!=(' . implode(',', $filter[2]) . ')';
                     break;
             }

src/Label.php

@@ -3,7 +3,8 @@
 
 namespace Palicao\PhpRedisTimeSeries;
 
-class Label
+/** @psalm-immutable */
+final class Label
 {
     /** @var string */
     private $key;

src/Metadata.php

@@ -5,7 +5,8 @@
 
 use DateTimeInterface;
 
-class Metadata
+/** @psalm-immutable */
+final class Metadata
 {
     /** @var DateTimeInterface */
     private $lastTimestamp;
@@ -45,8 +46,7 @@ public function __construct(
         array $labels = [],
         ?string $sourceKey = null,
         array $rules = []
-    )
-    {
+    ) {
         $this->lastTimestamp = $lastTimestamp;
         $this->retentionTime = $retentionTime;
         $this->chunkCount = $chunkCount;
@@ -56,6 +56,16 @@ public function __construct(
         $this->rules = $rules;
     }
 
+    /**
+     * @param int $lastTimestamp
+     * @param int $retentionTime
+     * @param int $chunkCount
+     * @param int $maxSamplesPerChunk
+     * @param Label[] $labels
+     * @param string|null $sourceKey
+     * @param AggregationRule[] $rules
+     * @return static
+     */
     public static function fromRedis(
         int $lastTimestamp,
         int $retentionTime = 0,

src/Sample.php

@@ -5,16 +5,17 @@
 
 use DateTimeInterface;
 
+/** @psalm-immutable */
 class Sample
 {
     /** @var string */
-    private $key;
+    protected $key;
 
     /** @var float */
-    private $value;
+    protected $value;
 
     /** @var DateTimeInterface|null */
-    private $dateTime;
+    protected $dateTime;
 
     public function __construct(string $key, float $value, ?DateTimeInterface $dateTime = null)
     {
@@ -44,18 +45,22 @@ public function getDateTime(): ?DateTimeInterface
     }
 
     /**
-     * @return int|string
+     * @return string
+     * @psalm-external-mutation-free
      */
-    public function getTimestampWithMs()
+    public function getTimestampWithMs(): string
     {
         if ($this->dateTime === null) {
             return '*';
         }
-        return DateTimeUtils::timestampWithMsFromDateTime($this->dateTime);
+        return (string)DateTimeUtils::timestampWithMsFromDateTime($this->dateTime);
     }
 
+    /**
+     * @return string[]
+     */
     public function toRedisParams(): array
     {
-        return [$this->getKey(), $this->getTimestampWithMs(), $this->getValue()];
+        return [$this->getKey(), $this->getTimestampWithMs(), (string) $this->getValue()];
     }
 }