adjust request matcher to the symfony model

Author: dbu

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+### Added
+
+ - The RequestMatcher is built after the Symfony RequestMatcher and separates
+   scheme, host and path expressions and provides an option to filter on the 
+   method. The RegexRequestMatcher is deprecated and will be removed in 2.0.
 
 ## 1.1.0
 

composer.json

@@ -48,7 +48,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.1-dev"
+            "dev-master": "1.2-dev"
         }
     }
 }

spec/RequestMatcher/RequestMatcherSpec.php

@@ -0,0 +1,106 @@
+<?php
+
+namespace spec\Http\Message\RequestMatcher;
+
+use Http\Message\RequestMatcher;
+use Psr\Http\Message\RequestInterface;
+use Psr\Http\Message\UriInterface;
+use PhpSpec\ObjectBehavior;
+
+class RequestMatcherSpec extends ObjectBehavior
+{
+    function let()
+    {
+        $this->beConstructedWith();
+    }
+
+    function it_is_initializable()
+    {
+        $this->shouldHaveType('Http\Message\RequestMatcher\RequestMatcher');
+    }
+
+    function it_is_a_request_matcher()
+    {
+        $this->shouldImplement('Http\Message\RequestMatcher');
+    }
+
+    function it_matches_a_path(RequestInterface $request, UriInterface $uri)
+    {
+        $this->beConstructedWith('^/tes?');
+
+        $request->getUri()->willReturn($uri);
+        $uri->getPath()->willReturn('/test/foo');
+
+        $this->matches($request)->shouldReturn(true);
+    }
+
+    function it_does_not_match_a_path(RequestInterface $request, UriInterface $uri)
+    {
+        $this->beConstructedWith('#^/tes?#');
+
+        $request->getUri()->willReturn($uri);
+        $uri->getPath()->willReturn('/ttttt');
+
+        $this->matches($request)->shouldReturn(false);
+    }
+
+
+    function it_matches_a_host(RequestInterface $request, UriInterface $uri)
+    {
+        $this->beConstructedWith(null, 'php-htt?');
+
+        $request->getUri()->willReturn($uri);
+        $uri->getHost()->willReturn('php-http.org');
+
+        $this->matches($request)->shouldReturn(true);
+    }
+
+    function it_does_not_match_a_host(RequestInterface $request, UriInterface $uri)
+    {
+        $this->beConstructedWith(null, 'php-htt?');
+
+        $request->getUri()->willReturn($uri);
+        $uri->getHost()->willReturn('httplug.io');
+
+        $this->matches($request)->shouldReturn(false);
+    }
+
+    function it_matches_a_method(RequestInterface $request)
+    {
+        $this->beConstructedWith(null, null, 'get');
+
+        $request->getMethod()->willReturn('GET');
+
+        $this->matches($request)->shouldReturn(true);
+    }
+
+    function it_does_not_match_a_method(RequestInterface $request)
+    {
+        $this->beConstructedWith(null, null, 'get');
+
+        $request->getMethod()->willReturn('post');
+
+        $this->matches($request)->shouldReturn(false);
+    }
+
+
+    function it_matches_a_scheme(RequestInterface $request, UriInterface $uri)
+    {
+        $this->beConstructedWith(null, null, null, 'http');
+
+        $request->getUri()->willReturn($uri);
+        $uri->getScheme()->willReturn('http');
+
+        $this->matches($request)->shouldReturn(true);
+    }
+
+    function it_does_not_match_a_scheme(RequestInterface $request, UriInterface $uri)
+    {
+        $this->beConstructedWith(null, null, null, 'http');
+
+        $request->getUri()->willReturn($uri);
+        $uri->getScheme()->willReturn('https');
+
+        $this->matches($request)->shouldReturn(false);
+    }
+}

src/RequestMatcher/RegexRequestMatcher.php

@@ -5,9 +5,13 @@
 use Http\Message\RequestMatcher;
 use Psr\Http\Message\RequestInterface;
 
+@trigger_error('The '.__NAMESPACE__.'\RegexREquestMatcher class is deprecated since version 1.2 and will be removed in 2.0. Use Http\Message\RequestMatcher\RequestMatcher instead.', E_USER_DEPRECATED);
+
 /**
  * Match a request with a regex on the uri.
  *
+ * @deprecated Use RequestMatcher instead. This class will be removed in version 2.0
+ *
  * @author Joel Wurtz <[email protected]>
  */
 final class RegexRequestMatcher implements RequestMatcher

src/RequestMatcher/RequestMatcher.php

@@ -0,0 +1,78 @@
+<?php
+
+namespace Http\Message\RequestMatcher;
+
+use Http\Message\RequestMatcher as RequestMatcherInterface;
+use Psr\Http\Message\RequestInterface;
+
+/**
+ * A port of the Symfony RequestMatcher for PSR-7.
+ *
+ * @author Fabien Potencier <[email protected]>
+ * @author Joel Wurtz <[email protected]>
+ */
+final class RequestMatcher implements RequestMatcherInterface
+{
+    /**
+     * @var string
+     */
+    private $path;
+
+    /**
+     * @var string
+     */
+    private $host;
+
+    /**
+     * @var array
+     */
+    private $methods = [];
+
+    /**
+     * @var string[]
+     */
+    private $schemes = [];
+
+    /**
+     * The regular expressions used for path or host must be specified without delimiter.
+     * You do not need to escape the forward slash / to match it.
+     *
+     * @param string|null          $path    Regular expression for the path
+     * @param string|null          $host    Regular expression for the hostname
+     * @param string|string[]|null $methods Method or list of methods to match
+     * @param string|string[]|null $schemes Scheme or list of schemes to match (e.g. http or https)
+     */
+    public function __construct($path = null, $host = null, $methods = [], $schemes = [])
+    {
+        $this->path = $path;
+        $this->host = $host;
+        $this->methods = array_map('strtoupper', (array) $methods);
+        $this->schemes = array_map('strtolower', (array) $schemes);
+    }
+
+    /**
+     * {@inheritdoc}
+     *
+     * @api
+     */
+    public function matches(RequestInterface $request)
+    {
+        if ($this->schemes && !in_array($request->getUri()->getScheme(), $this->schemes)) {
+            return false;
+        }
+
+        if ($this->methods && !in_array($request->getMethod(), $this->methods)) {
+            return false;
+        }
+
+        if (null !== $this->path && !preg_match('{'.$this->path.'}', rawurldecode($request->getUri()->getPath()))) {
+            return false;
+        }
+
+        if (null !== $this->host && !preg_match('{'.$this->host.'}i', $request->getUri()->getHost())) {
+            return false;
+        }
+
+        return true;
+    }
+}