Added cookieSetup method to ResponseHeaders

Author: shudd3r

README.md

@@ -9,12 +9,14 @@
     php composer.phar require polymorphine/headers
 
 ### Basic usage
+##### *Set-Cookie header*
 
-1. Instantiate a cookie setup with `ResponseHeaders` context and (*optional*) array
-   of directives/attributes (see [`resetDirectives()`](/src/Cookie/CookieSetup.php#L54) method):
+1. Instantiate a cookie setup using `ResponseHeaders` context and configure with array
+   of directives/attributes (or builder methods) when their value needs to be specified
+   (see [`directives()`](/src/Cookie/CookieSetup.php#L48) method):
 
        $context = new ResponseHeaders();
-       $cookieSetup = new CookieSetup($context, [
+       $cookieSetup = $context->directives([
            'Domain'   => 'example.com',
            'Path'     => '/admin',
            'Expires'  => new DateTime(...),
@@ -40,7 +42,7 @@
 
    Each cookie can send/revoke header only once
 
-### Directives and Attributes
+##### Directives and Attributes
 
 Directives are used according to [RFC6265](https://tools.ietf.org/html/rfc6265#section-4.1.2)
 section about Set-Cookie header attributes (except relatively new `SameSite` directive). Their
@@ -55,7 +57,7 @@ Here are some class-specific rules for setting those directives:
   If both directives will be passed into constructor or `directivesArray()` method,
   last value will be used due to overwrite.
 
-### Cookie with predefined directives
+##### Cookie with predefined directives
 
 `CookieSetup` has two alternative methods creating `Cookie` instance: `CookieSetup::permanentCookie()` and
 `CookieSetup::sessionCookie()`.

src/Cookie/CookieSetup.php

@@ -23,16 +23,10 @@ class CookieSetup
     private $responseHeaders;
     private $directives;
 
-    /**
-     * @see CookieSetup::resetDirectives() for $directives parameter details
-     *
-     * @param ResponseHeaders $responseHeaders
-     * @param array           $directives
-     */
-    public function __construct(ResponseHeaders $responseHeaders, array $directives = [])
+    public function __construct(ResponseHeaders $responseHeaders)
     {
         $this->responseHeaders = $responseHeaders;
-        $this->resetDirectives($directives);
+        $this->directives();
     }
 
     /**
@@ -51,7 +45,7 @@ public function __construct(ResponseHeaders $responseHeaders, array $directives
      *
      * @return static
      */
-    public function resetDirectives(array $directives): self
+    public function directives(array $directives = []): self
     {
         $this->directives = [
             'Domain'   => null,

src/ResponseHeaders.php

@@ -11,6 +11,7 @@
 
 namespace Polymorphine\Headers;
 
+use Polymorphine\Headers\Cookie\CookieSetup;
 use Psr\Http\Server\MiddlewareInterface;
 use Psr\Http\Server\RequestHandlerInterface;
 use Psr\Http\Message\ServerRequestInterface;
@@ -42,4 +43,9 @@ public function push(Header $header): void
     {
         $this->headers[] = $header;
     }
+
+    public function cookieSetup(): CookieSetup
+    {
+        return new CookieSetup($this);
+    }
 }

tests/HeadersContextCookieTest.php

@@ -33,7 +33,7 @@ public function testInstantiation()
 
     public function testStandardSetup()
     {
-        $this->cookieSetup($context, ['Expires' => $this->fixedDate(7200)])
+        $this->cookieSetup($context)->directives(['Expires' => $this->fixedDate(7200)])
              ->cookie('name')
              ->send('value');
 
@@ -43,7 +43,8 @@ public function testStandardSetup()
 
     public function testPermanentSetup()
     {
-        $this->cookieSetup($context, ['Expires' => $this->fixedDate(7200)])
+        $this->cookieSetup($context)
+             ->directives(['Expires' => $this->fixedDate(7200)])
              ->permanentCookie('name')
              ->send('value');
 
@@ -74,7 +75,8 @@ public function testName_ReturnsCookieName()
      */
     public function testConstructorDirectivesSetting(string $expectedHeader, array $data)
     {
-        $cookie = $this->cookieSetup($context, $data)
+        $cookie = $this->cookieSetup($context)
+                       ->directives($data)
                        ->cookie($data['name']);
         $data['value'] ? $cookie->send($data['value']) : $cookie->revoke();
         $this->assertEquals([$expectedHeader], $this->responseHeader($context));
@@ -94,7 +96,8 @@ public function testHeadersAreAdded()
 
     public function testGivenBothExpiryDirectivesToSetupConstructor_FirstOneIsOverwritten()
     {
-        $this->cookieSetup($context, ['Expires' => $this->fixedDate(3600), 'MaxAge' => 100])
+        $this->cookieSetup($context)
+             ->directives(['Expires' => $this->fixedDate(3600), 'MaxAge' => 100])
              ->cookie('name')
              ->send('value');
 
@@ -104,7 +107,8 @@ public function testGivenBothExpiryDirectivesToSetupConstructor_FirstOneIsOverwr
 
     public function testSecureNamePrefix_ForcesSecureDirective()
     {
-        $this->cookieSetup($context, ['Domain' => 'example.com', 'Path' => '/test'])
+        $this->cookieSetup($context)
+             ->directives(['Domain' => 'example.com', 'Path' => '/test'])
              ->cookie('__SECURE-name')
              ->send('test');
 
@@ -114,7 +118,8 @@ public function testSecureNamePrefix_ForcesSecureDirective()
 
     public function testHostNamePrefix_ForceSecureRootPathDirectivesWithoutDomain()
     {
-        $this->cookieSetup($context, ['Domain' => 'example.com', 'Path' => '/test'])
+        $this->cookieSetup($context)
+             ->directives(['Domain' => 'example.com', 'Path' => '/test'])
              ->cookie('__host-name')
              ->send('test');
 
@@ -199,10 +204,10 @@ private function fixedDate(int $secondsFromNow = 0): DateTime
         return (new DateTime())->setTimestamp(\Polymorphine\Headers\Cookie\time() + $secondsFromNow);
     }
 
-    private function cookieSetup(&$context = null, array $attributes = []): CookieSetup
+    private function cookieSetup(&$context = null): CookieSetup
     {
         $context or $context = new ResponseHeaders();
-        return new CookieSetup($context, $attributes);
+        return new CookieSetup($context);
     }
 
     private function responseHeader(ResponseHeaders $context): array

tests/ResponseHeadersTest.php

@@ -12,6 +12,7 @@
 namespace Polymorphine\Headers\Tests;
 
 use PHPUnit\Framework\TestCase;
+use Polymorphine\Headers\Cookie\CookieSetup;
 use Polymorphine\Headers\ResponseHeaders;
 use Polymorphine\Headers\Header;
 use Polymorphine\Headers\Tests\Doubles\FakeHeader;
@@ -36,6 +37,11 @@ public function testAddHeaders()
         $this->assertSame(['Set-Cookie' => ['default=value', 'name=value']], $this->response($headers)->getHeaders());
     }
 
+    public function testCookieSetup()
+    {
+        $this->assertInstanceOf(CookieSetup::class, $this->middleware()->cookieSetup());
+    }
+
     private function middleware(Header ...$headers)
     {
         return new ResponseHeaders(...$headers);