Add PHPStan (#8)

* add phpstan

* make phpstan happy

Author: cosmastech

.github/workflows/php.yml

@@ -42,3 +42,6 @@ jobs:
 
     - name: Style check
       run: composer php-cs-fixer-check
+
+    - name: Static Analysis
+      run: composer static-analysis

composer.json

@@ -19,7 +19,8 @@
     "friendsofphp/php-cs-fixer": "^3.59",
     "league/statsd": "^2.0.0",
     "cosmastech/psr-logger-spy": "^0.0.2",
-    "datadog/php-datadogstatsd": "^1.6.1"
+    "datadog/php-datadogstatsd": "^1.6.1",
+    "phpstan/phpstan": "^1.11"
   },
   "suggest": {
     "datadog/php-datadogstatsd": "For DataDog stats",
@@ -40,6 +41,9 @@
   "scripts": {
     "test": "phpunit tests",
     "php-cs-fixer": "./vendor/bin/php-cs-fixer fix ./",
-    "php-cs-fixer-check": "./vendor/bin/php-cs-fixer check ./"
+    "php-cs-fixer-check": "./vendor/bin/php-cs-fixer check ./",
+    "static-analysis": [
+      "@php vendor/bin/phpstan analyse -c phpstan.neon"
+    ]
   }
 }

phpstan.neon

@@ -0,0 +1,5 @@
+parameters:
+	level: 7
+	paths:
+		- src
+		- tests

src/Adapters/Concerns/HasDefaultTagsTrait.php

@@ -4,6 +4,9 @@
 
 trait HasDefaultTagsTrait
 {
+    /**
+     * @var array<mixed, mixed>
+     */
     protected array $defaultTags = [];
 
     /**
@@ -23,8 +26,8 @@ public function setDefaultTags(array $defaultTags = []): void
     }
 
     /**
-     * @param  array<string, mixed>  $tags
-     * @return array<string, mixed>
+     * @param  array<mixed, mixed>  $tags
+     * @return array<mixed, mixed>
      */
     protected function mergeTags(array $tags): array
     {

src/Adapters/Concerns/TagNormalizerAwareTrait.php

@@ -13,6 +13,10 @@ public function setTagNormalizer(TagNormalizer $tagNormalizer): void
         $this->tagNormalizer = $tagNormalizer;
     }
 
+    /**
+     * @param  array<mixed, mixed>  $tags
+     * @return array<mixed, mixed>
+     */
     protected function normalizeTags(array $tags): array
     {
         return $this->tagNormalizer->normalize($tags);

src/Adapters/Datadog/DatadogStatsDClientAdapter.php

@@ -14,6 +14,10 @@ class DatadogStatsDClientAdapter implements StatsDClientAdapter, TagNormalizerAw
     use HasDefaultTagsTrait;
     use TagNormalizerAwareTrait;
 
+    /**
+     * @param  DogStatsd  $datadogClient
+     * @param  array<mixed, mixed>  $defaultTags
+     */
     public function __construct(protected readonly DogStatsd $datadogClient, array $defaultTags = [])
     {
         $this->tagNormalizer = new NoopTagNormalizer();
@@ -90,7 +94,7 @@ public function decrement(array|string $stats, float $sampleRate = 1.0, array $t
         );
     }
 
-    public function updateStats(array|string $stats, int $delta = 1, $sampleRate = 1.0, $tags = null): void
+    public function updateStats(array|string $stats, int $delta = 1, $sampleRate = 1.0, array $tags = null): void
     {
         $this->datadogClient->updateStats(
             $stats,

src/Adapters/InMemory/InMemoryClientAdapter.php

@@ -25,6 +25,10 @@ class InMemoryClientAdapter implements StatsDClientAdapter, TagNormalizerAware
     protected InMemoryStatsRecord $stats;
     protected readonly ClockInterface $clock;
 
+    /**
+     * @param  ClockInterface  $clock
+     * @param  array<mixed, mixed>  $defaultTags
+     */
     public function __construct(ClockInterface $clock = new Clock(), array $defaultTags = [])
     {
         $this->clock = $clock;
@@ -34,6 +38,9 @@ public function __construct(ClockInterface $clock = new Clock(), array $defaultT
         $this->setDefaultTags($defaultTags);
     }
 
+    /**
+     * @inheritDoc
+     */
     public function timing(string $stat, float $durationMs, float $sampleRate = 1.0, array $tags = []): void
     {
         $this->stats->timing[] = new InMemoryTimingRecord(
@@ -45,6 +52,9 @@ public function timing(string $stat, float $durationMs, float $sampleRate = 1.0,
         );
     }
 
+    /**
+     * @inheritDoc
+     */
     public function gauge(string $stat, float $value, float $sampleRate = 1.0, array $tags = []): void
     {
         $this->stats->gauge[] = new InMemoryGaugeRecord(
@@ -103,7 +113,10 @@ public function decrement(array|string $stats, float $sampleRate = 1.0, array $t
         $this->updateStats($stats, $value, $sampleRate, $tags);
     }
 
-    public function updateStats(array|string $stats, int $delta = 1, $sampleRate = 1.0, $tags = null): void
+    /**
+     * @inheritDoc
+     */
+    public function updateStats(array|string $stats, int $delta = 1, float $sampleRate = 1.0, array $tags = []): void
     {
         $stats = (array) $stats;
         $now = $this->clock->now();

src/Adapters/InMemory/Models/InMemoryCountRecord.php

@@ -6,6 +6,13 @@
 
 class InMemoryCountRecord
 {
+    /**
+     * @param  string  $stat
+     * @param  int  $count
+     * @param  float  $sampleRate
+     * @param  array<mixed, mixed>  $tags
+     * @param  DateTimeImmutable  $recordedAt
+     */
     public function __construct(
         public string $stat,
         public int $count,

src/Adapters/InMemory/Models/InMemoryDistributionRecord.php

@@ -6,6 +6,13 @@
 
 readonly class InMemoryDistributionRecord
 {
+    /**
+     * @param  string  $stat
+     * @param  float  $value
+     * @param  float  $sampleRate
+     * @param  array<mixed, mixed>  $tags
+     * @param  DateTimeImmutable  $recordedAt
+     */
     public function __construct(
         public string $stat,
         public float $value,

src/Adapters/InMemory/Models/InMemoryGaugeRecord.php

@@ -6,6 +6,13 @@
 
 readonly class InMemoryGaugeRecord
 {
+    /**
+     * @param  string  $stat
+     * @param  float  $value
+     * @param  float  $sampleRate
+     * @param  array<mixed, mixed>  $tags
+     * @param  DateTimeImmutable  $recordedAt
+     */
     public function __construct(
         public string $stat,
         public float $value,