[BC break] New ApiDoc

.github/CONTRIBUTING.md

@@ -0,0 +1,34 @@
+# CONTRIBUTING
+
+## Code Contributions
+
+## Installation
+
+Install project dependencies and test tools by running the following commands.
+
+```bash
+$ composer install
+```
+
+## Running tests
+
+```bash
+$ composer test
+```
+```bash
+$ composer coverage // xdebug
+$ composer pcov     // pcov
+```
+
+Add tests for your new code ensuring that you have 100% code coverage.
+In rare cases, code may be excluded from test coverage using `@codeCoverageIgnore`.
+
+## Sending a pull request
+
+To ensure your PHP code changes pass the CI checks, make sure to run all the same checks before submitting a PR.
+
+```bash
+$ composer tests
+```
+
+When you make a pull request, the tests will automatically be run again by GH action on multiple php versions.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,14 @@
+---
+name: Bug Report
+about: Create a bug report
+labels: Bug
+---
+
+### Bug Report
+
+<!-- Provide a summary describing the problem you are experiencing. -->
+
+### How to reproduce
+
+<!--- Describe exactly how to reproduce the problem, using a minimal test-case or working code sample. -->
+

.github/ISSUE_TEMPLATE/feature.md

@@ -0,0 +1,7 @@
+---
+name: Feature
+about: Suggest a new feature or enhancement
+labels: Feature
+---
+
+<!-- Write your suggestion here. -->

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,7 @@
+---
+name: Question
+about: Ask a question regarding software usage
+labels: Support
+---
+
+<!-- Write your question here. -->

.github/SECURITY.md

@@ -0,0 +1,6 @@
+# Reporting a vulnerability
+
+If you have found any issues that might have security implications,
+please send a report privately to akihito.koriyama@gmail.com
+
+Do not report security reports publicly.

.github/workflows/coding-standards.yml

@@ -0,0 +1,41 @@
+name: Coding Standards
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  coding-standards:
+    name: Coding Standards
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.0
+          tools: cs2pr
+          coverage: none
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install dependencies
+        run: composer install --no-interaction --no-progress --prefer-dist
+
+      - name: Validate composer.json
+        run: composer validate --strict
+
+      - name: Run PHP_CodeSniffer
+        run: ./vendor/bin/phpcs -q --no-colors --report=checkstyle src tests | cs2pr

.github/workflows/continuous-integration.yml

@@ -0,0 +1,59 @@
+name: Continuous Integration
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  phpunit:
+    name: PHPUnit
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        operating-system:
+          - ubuntu-latest
+        php-version:
+          - '7.3'
+          - '7.4'
+          - '8.0'
+        dependencies:
+          - lowest
+          - highest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+
+      - name: Setup PHP ${{ matrix.php-version }}
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          coverage: pcov
+          ini-values: zend.assertions=1
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install lowest dependencies
+        if: ${{ matrix.dependencies == 'lowest' }}
+        run: composer update --prefer-lowest --no-interaction --no-progress
+
+      - name: Install highest dependencies
+        if: ${{ matrix.dependencies == 'highest' }}
+        run: composer update --no-interaction --no-progress
+
+      - name: Run test suite
+        run: ./vendor/bin/phpunit -c ./phpunit.xml.dist --coverage-clover=coverage.xml
+
+      - name: Upload coverage report
+        uses: codecov/codecov-action@v1
+        with:
+          file: ./coverage.xml

.github/workflows/static-analysis.yml

@@ -0,0 +1,139 @@
+name: Static Analysis
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  static-analysis-phpstan:
+    name: Static Analysis with PHPStan
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.0
+          tools: cs2pr
+          coverage: none
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install dependencies
+        run: composer install --no-interaction --no-progress --prefer-dist
+
+      - name: Run PHPStan
+        run: ./vendor/bin/phpstan analyse -c phpstan.neon --no-progress --no-interaction --error-format=checkstyle | cs2pr
+
+  static-analysis-psalm:
+    name: Static Analysis with Psalm
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.0
+          tools: cs2pr
+          coverage: none
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Install dependencies
+        run: composer install --no-interaction --no-progress --prefer-dist
+
+      - name: Run Psalm
+        run: ./vendor/bin/psalm --show-info=false --output-format=checkstyle --shepherd | cs2pr
+
+  static-analysis-phpmd:
+    name: Static Analysis with PHPMD
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 7.4
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install dependencies
+        run: composer install --no-interaction --no-progress --prefer-dist
+
+      - name: Run PHP Mess Detector
+        run: ./vendor/bin/phpmd src text ./phpmd.xml
+
+  static-analysis-php-metrics:
+    name: Static Analysis with PhpMetrics
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.0
+          coverage: none
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Install dependencies
+        run: composer install --no-interaction --no-progress --prefer-dist
+
+      - name: Run PhpMetrics
+        run: ./vendor/bin/phpmetrics --exclude=Exception src
+
+  static-analysis-composer-require-checker:
+    name: Static Analysis with ComposerRequireChecker
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.0
+          coverage: none
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "::set-output name=dir::$(composer config cache-files-dir)"
+
+      - name: Install dependencies
+        run: |
+          composer install --no-interaction --no-progress --prefer-dist
+          composer require --dev maglnet/composer-require-checker ^3.0
+
+      - name: Run composer-require-checker
+        run: ./vendor/bin/composer-require-checker --config-file=./.composer-require-checker.config.json

.gitignore

@@ -5,3 +5,6 @@
 /phpunit.xml
 /.phpunit.result.cache
 /.phpcs-cache
+/docs/
+/tests/docs/
+/.phpunit.cache

apidoc.xml.dist

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<apidoc
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="./apidoc.xsd">
+    <appName>MyVendor/Package</appName>
+    <scheme>app</scheme>
+    <docDir>docs/api</docDir>
+    <format>html</format>
+    <title>MyVendor/Package</title>
+    <description>API Document</description>
+    <links>
+        <link rel="BEAR.Sunday" href="https://bearsunday.github.io/"/>
+    </links>
+</apidoc>