feature #21027 [Asset] Provide default context (ro0NL)

fabpot · fabpot · commit c7f664c5e0f6 · 2017-09-28T15:56:48.000-07:00
This PR was squashed before being merged into the 3.4 branch (closes #21027). Discussion ---------- [Asset] Provide default context | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #19396 | License | MIT | Doc PR | should be noted somewhere, ill create an issue Allows configuring the default asset context to make things works on CLI for example. Same approach as the routing component. Introduces ```yaml # parameters.yml asset.request_context.base_path: '/base/path' asset.request_context.secure: false ``` Commits ------- 9137d57 [Asset] Provide default context
diff --git a/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md b/src/Symfony/Bundle/FrameworkBundle/CHANGELOG.md
@@ -54,6 +54,8 @@ CHANGELOG
    `EventDispatcherDebugCommand`, `RouterDebugCommand`, `RouterMatchCommand`,
    `TranslationDebugCommand`, `TranslationUpdateCommand`, `XliffLintCommand`
     and `YamlLintCommand` classes have been marked as final
+ * Added `asset.request_context.base_path` and `asset.request_context.secure` parameters
+   to provide a default request context in case the stack is empty (similar to `router.request_context.*` parameters)
 
 3.3.0
 -----
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/assets.xml b/src/Symfony/Bundle/FrameworkBundle/Resources/config/assets.xml
@@ -4,6 +4,11 @@
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
 
+    <parameters>
+        <parameter key="asset.request_context.base_path"></parameter>
+        <parameter key="asset.request_context.secure">false</parameter>
+    </parameters>
+
     <services>
         <defaults public="false" />
 
@@ -19,6 +24,8 @@
 
         <service id="assets.context" class="Symfony\Component\Asset\Context\RequestStackContext">
             <argument type="service" id="request_stack" />
+            <argument>%asset.request_context.base_path%</argument>
+            <argument>%asset.request_context.secure%</argument>
         </service>
 
         <service id="assets.path_package" class="Symfony\Component\Asset\PathPackage" abstract="true">
diff --git a/src/Symfony/Component/Asset/CHANGELOG.md b/src/Symfony/Component/Asset/CHANGELOG.md
@@ -1,6 +1,12 @@
 CHANGELOG
 =========
 
+3.4.0
+-----
+
+ * added optional arguments `$basePath` and `$secure` in `RequestStackContext::__construct()`
+   to provide a default request context in case the stack is empty
+
 3.3.0
 -----
  * Added `JsonManifestVersionStrategy` as a way to read final,
diff --git a/src/Symfony/Component/Asset/Context/RequestStackContext.php b/src/Symfony/Component/Asset/Context/RequestStackContext.php
@@ -21,10 +21,19 @@
 class RequestStackContext implements ContextInterface
 {
     private $requestStack;
+    private $basePath;
+    private $secure;
 
-    public function __construct(RequestStack $requestStack)
+    /**
+     * @param RequestStack $requestStack
+     * @param string       $basePath
+     * @param bool         $secure
+     */
+    public function __construct(RequestStack $requestStack, $basePath = '', $secure = false)
     {
         $this->requestStack = $requestStack;
+        $this->basePath = $basePath;
+        $this->secure = $secure;
     }
 
     /**
@@ -33,7 +42,7 @@ public function __construct(RequestStack $requestStack)
     public function getBasePath()
     {
         if (!$request = $this->requestStack->getMasterRequest()) {
-            return '';
+            return $this->basePath;
         }
 
         return $request->getBasePath();
@@ -45,7 +54,7 @@ public function getBasePath()
     public function isSecure()
     {
         if (!$request = $this->requestStack->getMasterRequest()) {
-            return false;
+            return $this->secure;
         }
 
         return $request->isSecure();
diff --git a/src/Symfony/Component/Asset/Tests/Context/RequestStackContextTest.php b/src/Symfony/Component/Asset/Tests/Context/RequestStackContextTest.php
@@ -61,4 +61,13 @@ public function testIsSecureTrue()
 
         $this->assertTrue($requestStackContext->isSecure());
     }
+
+    public function testDefaultContext()
+    {
+        $requestStack = $this->getMockBuilder('Symfony\Component\HttpFoundation\RequestStack')->getMock();
+        $requestStackContext = new RequestStackContext($requestStack, 'default-path', true);
+
+        $this->assertSame('default-path', $requestStackContext->getBasePath());
+        $this->assertTrue($requestStackContext->isSecure());
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -21,10 +21,19 @@`
`21`	`21`	`class RequestStackContext implements ContextInterface`
`22`	`22`	`{`
`23`	`23`	`private $requestStack;`
	`24`	`+ private $basePath;`
	`25`	`+ private $secure;`
`24`	`26`
`25`		`- public function __construct(RequestStack $requestStack)`
	`27`	`+ /**`
	`28`	`+ * @param RequestStack $requestStack`
	`29`	`+ * @param string $basePath`
	`30`	`+ * @param bool $secure`
	`31`	`+ */`
	`32`	`+ public function __construct(RequestStack $requestStack, $basePath = '', $secure = false)`
`26`	`33`	`{`
`27`	`34`	`$this->requestStack = $requestStack;`
	`35`	`+ $this->basePath = $basePath;`
	`36`	`+ $this->secure = $secure;`
`28`	`37`	`}`
`29`	`38`
`30`	`39`	`/**`
`@@ -33,7 +42,7 @@ public function __construct(RequestStack $requestStack)`
`33`	`42`	`public function getBasePath()`
`34`	`43`	`{`
`35`	`44`	`if (!$request = $this->requestStack->getMasterRequest()) {`
`36`		`- return '';`
	`45`	`+ return $this->basePath;`
`37`	`46`	`}`
`38`	`47`
`39`	`48`	`return $request->getBasePath();`
`@@ -45,7 +54,7 @@ public function getBasePath()`
`45`	`54`	`public function isSecure()`
`46`	`55`	`{`
`47`	`56`	`if (!$request = $this->requestStack->getMasterRequest()) {`
`48`		`- return false;`
	`57`	`+ return $this->secure;`
`49`	`58`	`}`
`50`	`59`
`51`	`60`	`return $request->isSecure();`
Original file line number	Diff line number	Diff line change
`@@ -61,4 +61,13 @@ public function testIsSecureTrue()`
`61`	`61`
`62`	`62`	`$this->assertTrue($requestStackContext->isSecure());`
`63`	`63`	`}`
	`64`	`+`
	`65`	`+ public function testDefaultContext()`
	`66`	`+ {`
	`67`	`+ $requestStack = $this->getMockBuilder('Symfony\Component\HttpFoundation\RequestStack')->getMock();`
	`68`	`+ $requestStackContext = new RequestStackContext($requestStack, 'default-path', true);`
	`69`	`+`
	`70`	`+ $this->assertSame('default-path', $requestStackContext->getBasePath());`
	`71`	`+ $this->assertTrue($requestStackContext->isSecure());`
	`72`	`+ }`
`64`	`73`	`}`