Merge pull request #3 from Slickdeals/add-aware-trait

Add aware interface to easily auto-inject client

.cz.json

@@ -0,0 +1 @@
+{"commitizen": {"name": "cz_conventional_commits", "version": "3.0.2", "tag_format": "$version"}}

.github/workflows/php.yml

@@ -25,7 +25,7 @@ jobs:
       run: composer install --prefer-dist --no-progress --no-suggest --no-interaction
 
     - name: phpcs
-      run: vendor/bin/phpcs -s --standard=vendor/flyeralarm/php-code-validator/ruleset.xml src/ tests/
+      run: vendor/bin/php-cs-fixer fix --diff --dry-run -v
 
     - name: psalm
       run: vendor/bin/psalm --show-info=false

.gitignore

@@ -13,3 +13,6 @@ stats.log
 /vendor
 /composer.lock
 /composer.phar
+
+# php-cs-fixer
+.php-cs-fixer.cache

.php-cs-fixer.dist.php

@@ -0,0 +1,13 @@
+<?php
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__)
+;
+
+$config = new PhpCsFixer\Config();
+return $config->setRules([
+    '@PSR12' => true,
+    'array_syntax' => ['syntax' => 'short'],
+])
+    ->setFinder($finder)
+;

README.md

@@ -102,6 +102,33 @@ To disable sending any metrics to the statsd server, you can use the `Domnikl\St
 
class instead of the default socket abstraction. This may be incredibly useful for feature flags. Another options is
 to use `Domnikl\Statsd\Connection\InMemory` connection class, that will collect your messages but won't actually send them.
 
+## StatsdAwareInterface
+
+You can use the `StatsdAwareInterface` and `StatsdAwareTrait` in order to have dependency injection containers (such as
+Symfony's DI component) automatically detect the StatsdAwareInterface and inject the client into your service.
+
+### Symfony
+
+```yaml
+# config/services.yaml
+services:
+  _instanceof:
+    Domnikl\Statsd\StatsdAwareInterface:
+      calls:
+        - [setStatsdClient, ['@Domnikl\Statsd\Client']]
+
+  Domnikl\Statsd\Client:
+    arguments:
+      $connection: '@app.statsd_connection'
+      $namespace: '<namespace>'
+
+  app.statsd_connection:
+    class: Domnikl\Statsd\Connection\UdpSocket
+    arguments:
+      $host: '%env(STATSD_HOST)%'
+      $port: '%env(STATSD_PORT)%'
+```
+
 ## Authors
 
 Original author: Dominik Liebler <[email protected]>

composer.json

@@ -22,8 +22,8 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^9",
-        "flyeralarm/php-code-validator": "^3.2",
-        "vimeo/psalm": "^4.6"
+        "vimeo/psalm": "^4.6",
+        "friendsofphp/php-cs-fixer": "^3.0"
     },
     "autoload": {
         "psr-4": {

src/StatsdAwareInterface.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Domnikl\Statsd;
+
+/**
+ * Describes a StatsD-aware instance.
+ */
+interface StatsdAwareInterface
+{
+    /**
+     * Sets a StatsD client instance on the object.
+     */
+    public function setStatsdClient(Client $client): void;
+}

src/StatsdAwareTrait.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Domnikl\Statsd;
+
+/**
+ * Basic implementation of StatsdAwareInterface.
+ */
+trait StatsdAwareTrait
+{
+    /**
+     * @var Client
+     */
+    protected $statsd;
+
+    /**
+     * Sets the StatsD client.
+     */
+    public function setStatsdClient(Client $client)
+    {
+        $this->statsd = $client;
+    }
+}

tests/unit/ClientBatchTest.php

@@ -32,47 +32,47 @@ public function testInit()
 
     public function testStartBatch()
     {
-          $this->client->startBatch();
-          $this->assertTrue($this->client->isBatch());
+        $this->client->startBatch();
+        $this->assertTrue($this->client->isBatch());
     }
 
     public function testSendIsRecordingInBatch()
     {
-          $this->client->startBatch();
-          $this->client->increment("foobar", 1);
+        $this->client->startBatch();
+        $this->client->increment("foobar", 1);
 
-          $message = $this->connection->getLastMessage();
-          $this->assertNull($message);
+        $message = $this->connection->getLastMessage();
+        $this->assertNull($message);
     }
 
     public function testEndBatch()
     {
-          $this->client->startBatch();
-          $this->client->count("foobar", 1);
-          $this->client->count("foobar", 2);
-          $this->client->endBatch();
+        $this->client->startBatch();
+        $this->client->count("foobar", 1);
+        $this->client->count("foobar", 2);
+        $this->client->endBatch();
 
-          $this->assertFalse($this->client->isBatch());
-          $this->assertSame("foobar:1|c\nfoobar:2|c", $this->connection->getLastMessage());
+        $this->assertFalse($this->client->isBatch());
+        $this->assertSame("foobar:1|c\nfoobar:2|c", $this->connection->getLastMessage());
 
-          // run a new batch => don't send the old values!
+        // run a new batch => don't send the old values!
 
-          $this->client->startBatch();
-          $this->client->count("baz", 100);
-          $this->client->count("baz", 300);
-          $this->client->endBatch();
+        $this->client->startBatch();
+        $this->client->count("baz", 100);
+        $this->client->count("baz", 300);
+        $this->client->endBatch();
 
-          $this->assertFalse($this->client->isBatch());
-          $this->assertSame("baz:100|c\nbaz:300|c", $this->connection->getLastMessage());
+        $this->assertFalse($this->client->isBatch());
+        $this->assertSame("baz:100|c\nbaz:300|c", $this->connection->getLastMessage());
     }
 
     public function testCancelBatch()
     {
-          $this->client->startBatch();
-          $this->client->count("foobar", 4);
-          $this->client->cancelBatch();
+        $this->client->startBatch();
+        $this->client->count("foobar", 4);
+        $this->client->cancelBatch();
 
-          $this->assertFalse($this->client->isBatch());
-          $this->assertNull($this->connection->getLastMessage());
+        $this->assertFalse($this->client->isBatch());
+        $this->assertNull($this->connection->getLastMessage());
     }
 }