Synchronized package files with skeleton template

Author: shudd3r

.github/skeleton.json

@@ -0,0 +1,8 @@
+{
+    "package.name": "Polymorphine/Headers",
+    "repository.name": "polymorphine/headers",
+    "package.description": "HTTP Response headers middleware",
+    "namespace.src": "Polymorphine\\Headers",
+    "author.name": "Shudd3r",
+    "author.email": "q3.shudder@gmail.com"
+}

.github/workflows/build.yml

@@ -50,7 +50,9 @@ jobs:
       - name: "Coding standard CodeSniffer checks"
         run: |
           vendor/bin/phpcs --extensions=php --standard=vendor/polymorphine/dev/phpcs.xml src
-          vendor/bin/phpcs --extensions=php --standard=vendor/polymorphine/dev/phpcs.xml --ignore=*/CodeSamples/* tests
+          vendor/bin/phpcs --extensions=php --standard=vendor/polymorphine/dev/phpcs.xml --ignore=*/code-samples/* tests
+      - name: "Package skeleton validation"
+        run: vendor/bin/polymorphine-skeleton check
       - name: "Run PhpUnit tests with coverage"
         run: |
           mkdir -p build/logs

.gitignore

@@ -1,5 +1,3 @@
-.idea/
-vendor/
-build/
-temp/
+/.dev/
+/vendor/
 /composer.lock

README.md

@@ -1,61 +1,63 @@
 # Polymorphine/Headers
-[![Latest Stable Version](https://poser.pugx.org/polymorphine/headers/version)](https://packagist.org/packages/polymorphine/headers)
+[![Latest stable release](https://poser.pugx.org/polymorphine/headers/version)](https://packagist.org/packages/polymorphine/headers)
 [![Build status](https://github.com/polymorphine/headers/workflows/build/badge.svg)](https://github.com/polymorphine/headers/actions)
 [![Coverage status](https://coveralls.io/repos/github/polymorphine/headers/badge.svg?branch=develop)](https://coveralls.io/github/polymorphine/headers?branch=develop)
 [![PHP version](https://img.shields.io/packagist/php-v/polymorphine/headers.svg)](https://packagist.org/packages/polymorphine/headers)
 [![LICENSE](https://img.shields.io/github/license/polymorphine/headers.svg?color=blue)](LICENSE)
 ### HTTP Response headers middleware
 
 ### Installation with [Composer](https://getcomposer.org/)
-    php composer.phar require polymorphine/headers
+```bash
+composer require polymorphine/headers
+```
 
 ### Basic usage
-##### *Set-Cookie header*
 
+##### *Set-Cookie header*
 1. Instantiate a cookie builder using `ResponseHeaders` context:
-
-       $headers     = new ResponseHeaders();
-       $cookieSetup = new CookieSetup($headers);
-   
+   ```php
+   $headers     = new ResponseHeaders();
+   $cookieSetup = new CookieSetup($headers);
+   ```
    Alternatively, instantiating `CookieSetup` is possible with `ResponseHeaders` method:
-   
-       $cookieSetup = $context->cookieSetup();
-
+   ```php
+   $cookieSetup = $context->cookieSetup();
+   ```
 2. Configure cookie with array of its directives/attributes
-   (see [`CookieSetup::directives()`](/src/Cookie/CookieSetup.php#L48) method):
-
-       $cookieSetup->directives([
-           'Domain'   => 'example.com',
-           'Path'     => '/admin',
-           'Expires'  => new DateTime(...),
-           'MaxAge'   => 1234,
-           'Secure'   => true,
-           'HttpOnly' => true,
-           'SameSite' => 'Strict'
-       ]);
-
+   (see [`CookieSetup::directives()`](/src/Cookie/CookieSetup.php#L51) method):
+   ```php
+   $cookieSetup->directives([
+       'Domain'   => 'example.com',
+       'Path'     => '/admin',
+       'Expires'  => new DateTime(...),
+       'MaxAge'   => 1234,
+       'Secure'   => true,
+       'HttpOnly' => true,
+       'SameSite' => 'Strict'
+   ]);
+   ```
    Modifying setup object is also possible with its builder methods:
-
-       $cookieSetup->domain('example.com')
-                   ->path('/admin')
-                   ->expires(new DateTime(...))
-                   ->maxAge(1234)
-                   ->secure()
-                   ->httpOnly()
-                   ->sameSite('Strict');
-
+   ```php
+   $cookieSetup->domain('example.com')
+               ->path('/admin')
+               ->expires(new DateTime(...))
+               ->maxAge(1234)
+               ->secure()
+               ->httpOnly()
+               ->sameSite('Strict');
+   ```
 3. Instantiate [`Cookie`](/src/Cookie.php) type object with its name:
-
-       $cookie = $cookieSetup->cookie('MyCookie');
-
+   ```php
+   $cookie = $cookieSetup->cookie('MyCookie');
+   ```
 4. Send value:
-
-       $cookie->send('value');
-       
+   ```php
+   $cookie->send('value');
+   ```
    or order to revoke cookie, so that it should not be sent with future requests:   
-       
-       $cookie->revoke();
-
+   ```php
+   $cookie->revoke();
+   ```       
    Each cookie can send/revoke header only once
 
 ##### Directives and Attributes
@@ -67,15 +69,15 @@ Concise description with additional class logic is explained in docBlocks of mut
 of [`CookieSetup`](src/Cookie/CookieSetup.php) class.
 
 Here are some class-specific rules for setting those directives:
-* Empty values and root path (`/`) might be omitted as they're same as default.
-* `SameSite` allowed values are `Strict` or `Lax`, but `Lax` will be set for any non-empty value given.
-* `Expires` and `MaxAge` are different ways to set the same cookie's expiry date.
+- Empty values and root path (`/`) might be omitted as they're same as default.
+- `SameSite` allowed values are `Strict` or `Lax`, but `Lax` will be set for any non-empty value given.
+- `Expires` and `MaxAge` are different ways to set the same cookie's expiry date.
   If both directives will be passed into constructor or `directivesArray()` method,
   last value will be used due to overwrite.
 
 ##### Cookie with predefined directives
 
 `CookieSetup` has two alternative methods creating `Cookie` instance: `CookieSetup::permanentCookie()` and
 `CookieSetup::sessionCookie()`.
-* *Permanent* constructor sets long (5 years) expiry values (`Expires` and `MaxAge`) 
-* *Session* constructor sets security directives (`HttpOnly` and `SameSite=Lax`)
+- *Permanent* constructor sets long (5 years) expiry values (`Expires` and `MaxAge`) 
+- *Session* constructor sets security directives (`HttpOnly` and `SameSite=Lax`)

composer.json

@@ -2,6 +2,13 @@
     "name": "polymorphine/headers",
     "description": "HTTP Response headers middleware",
     "type": "library",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Shudd3r",
+            "email": "q3.shudder@gmail.com"
+        }
+    ],
     "minimum-stability": "stable",
     "require": {
         "php": "^7.4 || ^8.0",
@@ -10,15 +17,8 @@
         "psr/http-server-middleware": "^1.0"
     },
     "require-dev": {
-        "polymorphine/dev": "0.1.*"
+        "polymorphine/dev": "0.2.*"
     },
-    "license": "MIT",
-    "authors": [
-        {
-            "name": "Shudd3r",
-            "email": "q3.shudder@gmail.com"
-        }
-    ],
     "autoload": {
         "psr-4": {
             "Polymorphine\\Headers\\": "src/"
@@ -31,9 +31,11 @@
     },
     "scripts": {
         "test-cs": [
-            "vendor/bin/php-cs-fixer --dry-run -v --config=cs-fixer.php.dist --path-mode=intersection fix src tests",
-            "vendor/bin/phpcs --extensions=php --standard=vendor/polymorphine/dev/phpcs.xml src",
-            "vendor/bin/phpcs --extensions=php --standard=vendor/polymorphine/dev/phpcs.xml --ignore=*/CodeSamples/* tests"
-        ]
+            "php-cs-fixer --dry-run -v --config=cs-fixer.php.dist --path-mode=intersection fix src tests",
+            "phpcs --extensions=php --standard=vendor/polymorphine/dev/phpcs.xml src",
+            "phpcs --extensions=php --standard=vendor/polymorphine/dev/phpcs.xml --ignore=*/code-samples/* tests"
+        ],
+        "test-php": "phpunit",
+        "test-skeleton": "polymorphine-skeleton check"
     }
 }

phpunit.xml.dist

@@ -2,7 +2,7 @@
 <phpunit
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
-    cacheResultFile="temp/.phpunit.result.cache"
+    cacheResultFile=".dev/temp/.phpunit.result.cache"
     colors="true"
     bootstrap="vendor/autoload.php"
 >