Query param matcher API (#31)

lstrojny · lstrojny · commit d986affc482c · 2016-05-20T20:59:27.000+02:00
diff --git a/doc/stubbing.md b/doc/stubbing.md
@@ -63,6 +63,10 @@ $this->http->mock
     ->end();`
 ```
 
+Additional matching methods are `queryParamExists(string $param)`, `queryParamNotExists(string $param)`,
+`queryParamIs(string $param, mixed $value)`, `queryParamsExist(array $params)`, `queryParamsNotExist(array $params)`
+ and `queryParamsAre(array $paramMap)`.
+
 If you have more ideas for syntactic sugar, feel free to open a pull requests.
 
 ## Pattern matching
diff --git a/src/Expectation.php b/src/Expectation.php
@@ -55,6 +55,54 @@ public function methodIs($matcher)
         return $this;
     }
 
+    public function queryParamIs($param, $matcher)
+    {
+        $this->appendMatcher($matcher, $this->extractorFactory->createParamExtractor($param));
+
+        return $this;
+    }
+
+    public function queryParamExists($param)
+    {
+        $this->appendMatcher(true, $this->extractorFactory->createParamExistsExtractor($param));
+
+        return $this;
+    }
+
+    public function queryParamNotExists($param)
+    {
+        $this->appendMatcher(false, $this->extractorFactory->createParamExistsExtractor($param));
+
+        return $this;
+    }
+
+    public function queryParamsAre(array $paramMap)
+    {
+        foreach ($paramMap as $param => $value) {
+            $this->queryParamIs($param, $value);
+        }
+
+        return $this;
+    }
+
+    public function queryParamsExist(array $params)
+    {
+        foreach ($params as $param) {
+            $this->queryParamExists($param);
+        }
+
+        return $this;
+    }
+
+    public function queryParamsNotExist(array $params)
+    {
+        foreach ($params as $param) {
+            $this->queryParamNotExists($param);
+        }
+
+        return $this;
+    }
+
     public function callback(Closure $callback)
     {
         $this->appendMatcher($this->matcherFactory->closure($callback));
diff --git a/src/Matcher/ExtractorFactory.php b/src/Matcher/ExtractorFactory.php
@@ -1,7 +1,6 @@
 <?php
 namespace InterNations\Component\HttpMock\Matcher;
 
-use Closure;
 use Symfony\Component\HttpFoundation\Request;
 
 class ExtractorFactory
@@ -13,7 +12,6 @@ public function __construct($basePath = '')
         $this->basePath = rtrim($basePath, '/');
     }
 
-    /** @return Closure */
     public function createPathExtractor()
     {
         $basePath = $this->basePath;
@@ -23,11 +21,24 @@ public function createPathExtractor()
         };
     }
 
-    /** @return Closure */
     public function createMethodExtractor()
     {
         return static function (Request $request) {
             return $request->getMethod();
         };
     }
+
+    public function createParamExtractor($param)
+    {
+        return static function (Request $request) use ($param) {
+            return $request->query->get($param);
+        };
+    }
+
+    public function createParamExistsExtractor($param)
+    {
+        return static function (Request $request) use ($param) {
+            return $request->query->has($param);
+        };
+    }
 }
diff --git a/tests/PHPUnit/HttpMockPHPUnitIntegrationTest.php b/tests/PHPUnit/HttpMockPHPUnitIntegrationTest.php
@@ -293,6 +293,39 @@ public function testMatchRegex()
         $this->assertSame('response', (string) $this->http->client->get('/')->send()->getBody());
     }
 
+    public function testMatchQueryParams()
+    {
+        $this->http->mock
+            ->when()
+                ->queryParamExists('p1')
+                ->queryParamIs('p2', 'v2')
+                ->queryParamNotExists('p3')
+                ->queryParamsExist(['p4'])
+                ->queryParamsAre(['p5' => 'v5', 'p6' => 'v6'])
+                ->queryParamsNotExist(['p7'])
+            ->then()
+                ->body('response')
+            ->end();
+        $this->http->setUp();
+
+        $this->assertSame(
+            'response',
+            (string) $this->http->client->get('/?p1=&p2=v2&p4=any&p5=v5&p6=v6')->send()->getBody()
+        );
+        $this->assertEquals(
+            Response::HTTP_NOT_FOUND,
+            (string) $this->http->client->get('/?p1=&p2=v2&p3=foo')->send()->getStatusCode()
+        );
+        $this->assertEquals(
+            Response::HTTP_NOT_FOUND,
+            (string) $this->http->client->get('/?p1=')->send()->getStatusCode()
+        );
+        $this->assertEquals(
+            Response::HTTP_NOT_FOUND,
+            (string) $this->http->client->get('/?p3=foo')->send()->getStatusCode()
+        );
+    }
+
     public function testFatalError()
     {
         $this->markTestSkipped('Comment in to test if fatal errors are properly handled');
