geocoder-php · Nyholm · Aug 1, 2017 · Jul 15, 2017 · Jul 15, 2017 · Jul 15, 2017
diff --git a/composer.json b/composer.json
@@ -19,7 +19,9 @@
         "php-http/client-implementation": "^1.0",
         "php-http/message-factory": "^1.0.2",
         "php-http/httplug": "^1.0",
-        "php-http/discovery": "^1.0"
+        "php-http/discovery": "^1.0",
+        "psr/simple-cache": "^1.0",
+        "php-http/promise": "^1.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^6.1",
@@ -31,8 +33,9 @@
         "php-http/mock-client": "^1.0",
         "nyholm/psr7": "^0.2.2",
         "nyholm/nsa": "^1.1",
-        "cache/simple-cache-bridge": "^0.1.1",
-        "cache/array-adapter": "^0.5.0"
+        "cache/simple-cache-bridge": "^1.0",
+        "cache/array-adapter": "^1.0",
+        "cache/void-adapter": "^1.0"
     },
     "suggest": {
         "ext-geoip": "Enabling the geoip extension allows you to use the MaxMindProvider.",
@@ -52,6 +55,7 @@
         "test": "vendor/bin/phpunit"
     },
     "minimum-stability": "dev",
+    "prefer-dist": true,
     "extra": {
         "branch-alias": {
             "dev-master": "4.0-dev"

diff --git a/src/Plugin/.gitattributes b/src/Plugin/.gitattributes
@@ -0,0 +1,4 @@
+.gitattributes   export-ignore
+.travis.yml      export-ignore
+phpunit.xml.dist export-ignore
+Tests/           export-ignore
diff --git a/src/Plugin/.travis.yml b/src/Plugin/.travis.yml
@@ -0,0 +1,15 @@
+language: php
+sudo: false
+
+php: 7.0
+
+install:
+  - composer update --prefer-stable --prefer-dist
+
+script:
+    - composer test-ci
+
+after_success:
+    - wget https://scrutinizer-ci.com/ocular.phar
+    - php ocular.phar code-coverage:upload --format=php-clover build/coverage.xml
+
diff --git a/src/Plugin/CHANGELOG.md b/src/Plugin/CHANGELOG.md
@@ -0,0 +1,7 @@
+# Change Log
+
+The change log describes what is "Added", "Removed", "Changed" or "Fixed" between each release.
+
+## 1.0.0
+
+First release of this library. 
diff --git a/src/Plugin/Exception/LoopException.php b/src/Plugin/Exception/LoopException.php
@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * 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\Plugin\Exception;
+
+use Geocoder\Exception\Exception;
+use Geocoder\Query\Query;
+
+/**
+ * Thrown when the Plugin Client detects an endless loop.
+ *
+ * @author Joel Wurtz <[email protected]>
+ */
+class LoopException extends \RuntimeException implements Exception
+{
+    /**
+     * @var Query
+     */
+    private $query;
+
+    public static function create($message, Query $query)
+    {
+        $ex = new self($message);
+        $ex->query = $query;
+
+        return $ex;
+    }
+
+    /**
+     * @return Query
+     */
+    public function getQuery(): Query
+    {
+        return $this->query;
+    }
+}
diff --git a/src/Plugin/LICENSE b/src/Plugin/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2011 — William Durand <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/src/Plugin/Plugin.php b/src/Plugin/Plugin.php
@@ -0,0 +1,41 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * 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\Plugin;
+
+use Geocoder\Query\Query;
+use Http\Promise\Promise;
+
+/**
+ * A plugin is a middleware to transform the Query and/or the Collection.
+ *
+ * The plugin can:
+ *  - break the chain and return a Collection
+ *  - dispatch the Query to the next middleware
+ *  - restart the Query
+ *
+ * @author Joel Wurtz <[email protected]>
+ * @author Tobias Nyholm <[email protected]>
+ */
+interface Plugin
+{
+    /**
+     * Handle the Query and return the Collection coming from the next callable.
+     *
+     * @param Query    $query
+     * @param callable $next  Next middleware in the chain, the query is passed as the first argument
+     * @param callable $first First middleware in the chain, used to to restart a request
+     *
+     * @return Promise Resolves a Collection or fails with an Geocoder\Exception\Exception
+     */
+    public function handleQuery(Query $query, callable $next, callable $first);
+}
diff --git a/src/Plugin/Plugin/BoundsPlugin.php b/src/Plugin/Plugin/BoundsPlugin.php
@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * 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\Plugin\Plugin;
+
+use Geocoder\Model\Bounds;
+use Geocoder\Plugin\Plugin;
+use Geocoder\Query\GeocodeQuery;
+use Geocoder\Query\Query;
+
+/**
+ * Add bounds to each GeocoderQuery
+ *
+ * @author Tobias Nyholm <[email protected]>
+ */
+class BoundsPlugin implements Plugin
+{
+    /**
+     * @var Bounds
+     */
+    private $bounds;
+
+    /**
+     * @param Bounds $bounds
+     */
+    public function __construct(Bounds $bounds)
+    {
+        $this->bounds = $bounds;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function handleQuery(Query $query, callable $next, callable $first)
+    {
+        if (!$query instanceof GeocodeQuery) {
+            return $next($query);
+        }
+
+        if (empty($query->getBounds())) {
+            $query = $query->withBounds($this->bounds);
+        }
+
+        return $next($query);
+    }
+}
diff --git a/src/Plugin/Plugin/CachePlugin.php b/src/Plugin/Plugin/CachePlugin.php
@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * 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\Plugin\Plugin;
+
+use Geocoder\Plugin\Plugin;
+use Geocoder\Query\Query;
+use Psr\SimpleCache\CacheInterface;
+
+/**
+ * Cache the result of a query.
+ *
+ * @author Tobias Nyholm <[email protected]>
+ */
+class CachePlugin implements Plugin
+{
+    /**
+     * @var CacheInterface
+     */
+    private $cache;
+
+    /**
+     * How log a result is going to be cached.
+     *
+     * @var int|null
+     */
+    private $lifetime;
+
+    /**
+     * @param CacheInterface $cache
+     * @param int            $lifetime
+     */
+    public function __construct(CacheInterface $cache, int $lifetime = null)
+    {
+        $this->cache = $cache;
+        $this->lifetime = $lifetime;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function handleQuery(Query $query, callable $next, callable $first)
+    {
+        $cacheKey = $this->getCacheKey($query);
+        if (null !== $cachedResult = $this->cache->get($cacheKey)) {
+            return $cachedResult;
+        }
+
+        $result = $next($query);
+        $this->cache->set($cacheKey, $result, $this->lifetime);
+
+        return $result;
+    }
+
+    /**
+     * @param Query $query
+     *
+     * @return string
+     */
+    private function getCacheKey(Query $query): string
+    {
+        // Include the major version number of the geocoder to avoid issues unserializing.
+        return 'v4'.sha1((string) $query);
+    }
+}
diff --git a/src/Plugin/Plugin/LimitPlugin.php b/src/Plugin/Plugin/LimitPlugin.php
@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * 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\Plugin\Plugin;
+
+use Geocoder\Plugin\Plugin;
+use Geocoder\Query\Query;
+
+/**
+ * Add limit on the query
+ *
+ * @author Tobias Nyholm <[email protected]>
+ */
+class LimitPlugin implements Plugin
+{
+    /**
+     * @var int
+     */
+    private $limit;
+
+    /**
+     * @param int $limit
+     */
+    public function __construct(int $limit)
+    {
+        $this->limit = $limit;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function handleQuery(Query $query, callable $next, callable $first)
+    {
+        if (empty($query->getLocale())) {
+            $query = $query->withLimit($this->limit);
+        }
+
+        return $next($query);
+    }
+}