Full code coverage for the ParametersExtractorTrait class

Author: Ingannatore

Controller/ParametersExtractorTrait.php

@@ -22,6 +22,14 @@
 trait ParametersExtractorTrait
 {
     /**
+     * Executes the extraction from the given Request instance.
+     *
+     * The source can be `null` or one of the following:
+     *
+     * - "query": to extract from the GET parameters
+     * - "request": to extract from the POST parameters
+     * - "content": to extract from a JSON payload
+     *
      * @param \Symfony\Component\HttpFoundation\Request $request
      * @param string|null $prefix
      * @param string|null $source
@@ -30,13 +38,13 @@ trait ParametersExtractorTrait
     protected function extractParameters(Request $request, $prefix = null, $source = null)
     {
         switch ($source) {
-            case 'get':
+            case 'query':
                 $parameters = $request->query->all();
                 break;
-            case 'post':
+            case 'request':
                 $parameters = $request->request->all();
                 break;
-            case 'body':
+            case 'content':
                 $parameters = (array)json_decode($request->getContent(), true);
                 break;
             default:

Tests/ParametersExtractorTraitTest.php

@@ -0,0 +1,111 @@
+<?php
+
+/*
+ * This file is part of the GiBilogic Elements package.
+ *
+ * (c) GiBilogic Srl <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Gibilogic\Elements\Tests;
+
+use Symfony\Component\HttpFoundation\Request;
+use Gibilogic\Elements\Controller\ParametersExtractorTrait;
+
+/**
+ * Unit tests for the ParametersExtractorTrait.
+ *
+ * @author Matteo Guindani https://github.com/Ingannatore
+ * @see ParametersExtractorTrait
+ * @see \PHPUnit_Framework_TestCase
+ */
+class ParametersExtractorTraitTest extends \PHPUnit_Framework_TestCase
+{
+    use ParametersExtractorTrait;
+
+    /**
+     * Test for a simple extraction (ie, without prefix) from "query" (GET) source.
+     */
+    public function testSimpleExtractionFromQuery()
+    {
+        $queryData = ['a' => 1, 'b' => 2];
+        $requestData = ['a' => 2, 'b' => 4, 'c' => 8];
+        $contentData = ['b' => 3, 'c' => 6, 'd' => 9];
+        $request = $this->createRequest($queryData, $requestData, $contentData);
+
+        $this->assertEquals($queryData, $this->extractParameters($request, null, 'query'));
+    }
+
+    /**
+     * Test for a simple extraction (ie, without prefix) from "request" (POST) source.
+     */
+    public function testSimpleExtractionFromRequest()
+    {
+        $queryData = ['a' => 1, 'b' => 2];
+        $requestData = ['a' => 2, 'b' => 4, 'c' => 8];
+        $contentData = ['b' => 3, 'c' => 6, 'd' => 9];
+        $request = $this->createRequest($queryData, $requestData, $contentData);
+
+        $this->assertEquals($requestData, $this->extractParameters($request, null, 'request'));
+    }
+
+    /**
+     * Test for a simple extraction (ie, without prefix) from "request" (POST) source.
+     */
+    public function testSimpleExtractionFromContent()
+    {
+        $queryData = ['a' => 1, 'b' => 2];
+        $requestData = ['a' => 2, 'b' => 4, 'c' => 8];
+        $contentData = ['b' => 3, 'c' => 6, 'd' => 9];
+        $request = $this->createRequest($queryData, $requestData, $contentData);
+
+        $this->assertEquals($contentData, $this->extractParameters($request, null, 'content'));
+    }
+
+    /**
+     * Test for a simple extraction (ie, without prefix) from all sources.
+     */
+    public function testSimpleExtractionFromAllSources()
+    {
+        $queryData = ['a' => 1, 'b' => 2];
+        $requestData = ['a' => 2, 'b' => 4, 'c' => 8];
+        $contentData = ['b' => 3, 'c' => 6, 'd' => 9];
+        $request = $this->createRequest($queryData, $requestData, $contentData);
+
+        $this->assertEquals(
+            ['a' => 2, 'b' => 3, 'c' => 6, 'd' => 9],
+            $this->extractParameters($request)
+        );
+    }
+
+    /**
+     * Test a prefixed extraction from all sources.
+     */
+    public function testPrefixedExtraction()
+    {
+        $queryData = ['prefix_a' => 1, 'b' => 2];
+        $requestData = ['a' => 2, 'prefix_b' => 4, 'c' => 8];
+        $contentData = ['b' => 3, 'prefix_c' => 6, 'prefix_d' => 9];
+        $request = $this->createRequest($queryData, $requestData, $contentData);
+
+        $this->assertEquals(
+            ['a' => 1, 'b' => 4, 'c' => 6, 'd' => 9],
+            $this->extractParameters($request, 'prefix_')
+        );
+    }
+
+    /**
+     * Creates a mock-up request instance.
+     *
+     * @param array $query
+     * @param array $request
+     * @param array $content
+     * @return Request
+     */
+    protected function createRequest(array $query, array $request, array $content)
+    {
+        return new Request($query, $request, [], [], [], [], json_encode($content));
+    }
+}