Added Memory backend

Author: vgarvardt

README.md

@@ -19,6 +19,7 @@ dashboards to track activity and problems.
 * Several stats backends:
   * `log` for development environment
   * `statsd` for production
+  * `memory` for testing purpose, to track stats operations in unit tests
   * `noop` for environments that do not require any stats gathering
 * Fixed metric sections count for all metrics to allow easy monitoring/alerting setup in `grafana`
 * Easy to build HTTP requests metrics - timing and count

src/Client/Memory.php

@@ -0,0 +1,81 @@
+<?php
+
+namespace HelloFresh\Stats\Client;
+
+
+use HelloFresh\Stats\Client;
+use HelloFresh\Stats\Incrementer;
+use HelloFresh\Stats\State;
+use HelloFresh\Stats\Timer;
+
+class Memory extends AbstractClient implements Client
+{
+    /** @var Incrementer\Memory */
+    protected $incrementer;
+    /** @var State\Memory */
+    protected $state;
+    /** @var Timer\Memory[] */
+    protected $timers;
+
+    /**
+     * @inheritdoc
+     */
+    protected function getIncrementer()
+    {
+        if (null === $this->incrementer) {
+            $this->incrementer = new Incrementer\Memory();
+        }
+        return $this->incrementer;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function getState()
+    {
+        if (null === $this->state) {
+            $this->state = new State\Memory();
+        }
+        return $this->state;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function buildTimer()
+    {
+        $timer = new Timer\Memory();
+        $this->timers[] = $timer;
+        return $timer;
+    }
+
+    /**
+     * @return Timer\Memory[]
+     */
+    public function getTimers()
+    {
+        return $this->timers;
+    }
+
+    /**
+     * Returns all stored metrics array.
+     * Key - metric name, value - metric value.
+     *
+     * @return array
+     */
+    public function getIncrementedMetrics()
+    {
+        return $this->getIncrementer()->getMetrics();
+    }
+
+    /**
+     * Returns all stored states array.
+     * Key - metric name, value - metric value.
+     *
+     * @return array
+     */
+    public function getStateMetrics()
+    {
+        return $this->getState()->getMetrics();
+    }
+}

src/Factory.php

@@ -4,6 +4,7 @@
 
 
 use HelloFresh\Stats\Client\Log;
+use HelloFresh\Stats\Client\Memory;
 use HelloFresh\Stats\Client\NoOp;
 use HelloFresh\Stats\Client\StatsD;
 use Psr\Log\LoggerInterface;
@@ -13,6 +14,7 @@ class Factory
     const STATSD = 'statsd';
     const LOG = 'log';
     const NOOP = 'noop';
+    const MEMORY = 'memory';
 
     /**
      * Builds Stats Client instance.
@@ -34,6 +36,9 @@ public static function build($dsn, LoggerInterface $logger)
 
             case static::NOOP:
                 return new NoOp();
+
+            case static::MEMORY:
+                return new Memory();
         }
 
         throw new \RuntimeException('Unknown client type');

src/Incrementer.php

@@ -11,7 +11,7 @@ interface Incrementer
      * @param string $metric
      * @param int $n
      *
-     * @return void
+     * @return self
      */
     public function increment($metric, $n = 1);
 

src/Incrementer/AbstractIncrementer.php

@@ -18,9 +18,9 @@ abstract public function increment($metric, $n = 1);
      */
     public function incrementAll(Bucket $bucket, $n = 1)
     {
-        $this->increment($bucket->metric(), $n);
-        $this->increment($bucket->metricWithSuffix(), $n);
-        $this->increment($bucket->metricTotal(), $n);
-        $this->increment($bucket->metricTotalWithSuffix(), $n);
+        $this->increment($bucket->metric(), $n)
+            ->increment($bucket->metricWithSuffix(), $n)
+            ->increment($bucket->metricTotal(), $n)
+            ->increment($bucket->metricTotalWithSuffix(), $n);
     }
 }

src/Incrementer/Log.php

@@ -27,5 +27,6 @@ public function __construct($logger)
     public function increment($metric, $n = 1)
     {
         $this->logger->debug('Stats counter increment', ['metric' => $metric, 'n' => $n]);
+        return $this;
     }
 }

src/Incrementer/Memory.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace HelloFresh\Stats\Incrementer;
+
+
+use HelloFresh\Stats\Incrementer;
+
+class Memory extends AbstractIncrementer implements Incrementer
+{
+    protected $metrics = [];
+
+    /**
+     * @inheritdoc
+     */
+    public function increment($metric, $n = 1)
+    {
+        $this->metrics[$metric] = empty($this->metrics[$metric]) ? $n : $this->metrics[$metric] + $n;
+        return $this;
+    }
+
+    /**
+     * Returns all stored metrics array.
+     * Key - metric name, value - metric value.
+     *
+     * @return array
+     */
+    public function getMetrics()
+    {
+        return $this->metrics;
+    }
+}

src/Incrementer/NoOp.php

@@ -12,5 +12,6 @@ class NoOp extends AbstractIncrementer implements Incrementer
      */
     public function increment($metric, $n = 1)
     {
+        return $this;
     }
 }

src/Incrementer/StatsD.php

@@ -27,5 +27,6 @@ public function __construct(Client $client)
     public function increment($metric, $n = 1)
     {
         $this->client->increment($metric, $n);
+        return $this;
     }
 }

src/State/Memory.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace HelloFresh\Stats\State;
+
+
+use HelloFresh\Stats\State;
+
+class Memory implements State
+{
+    protected $metrics = [];
+
+    /**
+     * @inheritdoc
+     */
+    public function set($metric, $state)
+    {
+        $this->metrics[$metric] = $state;
+    }
+
+    /**
+     * Returns all stored states array.
+     * Key - metric name, value - metric value.
+     *
+     * @return array
+     */
+    public function getMetrics()
+    {
+        return $this->metrics;
+    }
+}