Merge pull request #360 from Baachi/stopwatch

Add TimedGeocoder

Author: Baachi

composer.json

@@ -17,12 +17,14 @@
         "igorw/get-in": "~1.0"
     },
     "require-dev": {
-        "geoip2/geoip2": "~0.6"
+        "geoip2/geoip2": "~0.6",
+        "symfony/stopwatch": "~2.5"
     },
     "suggest": {
         "ext-geoip": "Enabling the geoip extension allows you to use the MaxMindProvider.",
         "geoip/geoip": "If you are going to use the MaxMindBinaryProvider (conflict with geoip extension).",
-        "geoip2/geoip2": "If you are going to use the GeoIP2DatabaseProvider."
+        "geoip2/geoip2": "If you are going to use the GeoIP2DatabaseProvider.",
+        "symfony/stopwatch": "If you want to use the TimedGeocoder"
     },
     "autoload": {
         "psr-0": { "Geocoder": "src/" }

src/Geocoder/TimedGeocoder.php

@@ -0,0 +1,54 @@
+<?php
+
+/**
+ * This file is part of the Geocoder package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Geocoder;
+
+use Symfony\Component\Stopwatch\Stopwatch;
+
+/**
+ * This Geocoder allows you to profile your API/Database calls. 
+ *
+ * @author Markus Bachmann <[email protected]>
+ */
+class TimedGeocoder implements Geocoder
+{
+    private $delegate;
+
+    private $stopwatch;
+
+    public function __construct(Geocoder $delegate, Stopwatch $stopwatch)
+    {
+        $this->delegate = $delegate;
+        $this->stopwatch = $stopwatch;
+    }
+
+    public function geocode($value)
+    {
+       $this->stopwatch->start('geocode', 'geocoder');
+       $result = $this->delegate->geocode($value);
+       $this->stopwatch->stop('geocode');
+
+       return $result;
+    }
+
+    public function reverse($latitude, $longitude)
+    {
+       $this->stopwatch->start('reverse', 'geocoder');
+       $result = $this->delegate->reverse($latitude, $longitude);
+       $this->stopwatch->stop('reverse');
+
+       return $result;
+    }
+
+    public function __call($method, $args)
+    {
+        return call_user_func_array([$this->delegate, $method], $args);
+    }
+}

tests/Geocoder/TestTimedGeocoder.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Geocoder\Tests;
+
+use Geocoder\TimedGeocoder;
+use Symfony\Component\Stopwatch\Stopwatch;
+
+class TimedGeocoderTest extends TestCase
+{
+   protected function setUp()
+   {
+       $this->stopwatch = new Stopwatch();
+       $this->delegate = $this->getMock('Geocoder\Geocoder');
+       $this->geocoder = new TimedGeocoder($this->delegate, $this->stopwatch);
+   }
+
+   public function testGeocode()
+   {
+      $this->delegate->expects($this->once())
+           ->method('geocode')
+           ->with($this->equalTo('foo'))
+           ->will($this->returnValue([]));
+
+      $this->geocoder->geocode('foo');
+      
+      $this->assertCount(1, $this->stopwatch->getSectionEvents('__root__'));
+   }
+
+   public function testReverse()
+   {
+      $this->delegate->expects($this->once())
+           ->method('reverse')
+           ->with($this->equalTo(0, 0))
+           ->will($this->returnValue([]));
+
+      $this->geocoder->reverse(0, 0);
+
+      $this->assertCount(1, $this->stopwatch->getSectionEvents('__root__'));
+   }
+}