Merge branch 'release-v0-10-1'

Author: gnugat

.dockerignore

@@ -0,0 +1,42 @@
+# composer
+vendor/
+
+# docker
+Dockerfile
+.dockerignore
+
+# documentation
+*.md
+
+# friendsofphp/php-cs-fixer
+.php-cs-fixer.php
+.php-cs-fixer.cache
+
+# git
+.git
+.gitignore
+.gitattributes
+
+# IDEs
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# phpstan
+phpstan.neon
+
+# phpunit
+phpunit.xml
+.phpunit.cache
+

.github/workflows/ci.yml

@@ -0,0 +1,56 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  qa:
+    name: QA (PHP ${{ matrix.php }})
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        php: ['8.0']
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: mbstring
+          coverage: none
+
+      - name: Get Composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache Composer dependencies
+        uses: actions/cache@v4
+        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 --prefer-dist --no-progress --optimize-autoloader
+
+      - name: Check coding standards
+        run: vendor/bin/php-cs-fixer fix --dry-run --verbose
+
+      - name: Run PHPStan
+        run: vendor/bin/phpstan analyze --memory-limit=256M
+
+      - name: Run Rector
+        run: vendor/bin/rector process --dry-run
+
+      - name: Run phpspec
+        run: vendor/bin/phpspec --no-interaction run
+
+      - name: Run PHPUnit
+        run: vendor/bin/phpunit

.gitignore

@@ -1,12 +1,22 @@
-# Third party
-/composer.lock
-/vendor
-/phpunit.xml
-/.couscous
-/.php_cs.cache
-/.phpunit.result.cache
+# composer
+composer.lock
+vendor/
+
+# couscous
+.couscous
+
+# friendsofphp/php-cs-fixer
+.php_cs.cache
+.php-cs-fixer.php
+.php-cs-fixer.cache
+
+# phpstan
+phpstan.neon
+
+# phpunit
+phpunit.xml
+.phpunit.result.cache
 
 # Temporary files
-/.php_cs.cache
 /fixtures/actual
 !/fixtures/actual/Generated*Test/.gitkeep

.php-cs-fixer.dist.php

@@ -0,0 +1,47 @@
+<?php
+
+/**
+ * PHP CS Fixer documentation:
+ * - Homepage: https://cs.symfony.com/
+ * - List of all available rules: https://cs.symfony.com/doc/rules/index.html
+ * - List of all available rule sets: https://cs.symfony.com/doc/ruleSets/index.html
+ * - Find / Compare / See History rules: https://mlocati.github.io/php-cs-fixer-configurator
+ *
+ * To inspect a specific rule (e.g. `blank_line_before_statement`), run:
+ *
+ * ```console
+ * > php-cs-fixer describe blank_line_before_statement
+ * ```
+ *
+ * ------------------------------------------------------------------------------
+ *
+ * `new \PhpCsFixer\Finder()` is equivalent to:
+ *
+ * ```php
+ * \Symfony\Component\Finder\Finder::create()
+ *     ->files()
+ *     ->name('/\.php$/')
+ *     ->exclude('vendor')
+ *     ->ignoreVCSIgnored(true) // Follow rules establish in .gitignore
+ *     ->ignoreDotFiles(false) // Do not ignore files starting with `.`, like `.php-cs-fixer-dist.php`
+ * ;
+ * ```
+ */
+
+$finder = (new PhpCsFixer\Finder())
+    ->in(__DIR__)
+;
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@Symfony' => true,
+
+        // [Symfony] defaults to `camelCase`, we set it to `snake_case` (phpspec style) 
+        'php_unit_method_casing' => ['case' => 'snake_case'],
+
+        // [Symfony] defaults to `true`, we set it to `false` for phpspec
+        'visibility_required' => false,
+    ])
+    ->setUsingCache(true)
+    ->setFinder($finder)
+;

.php_cs

@@ -12,17 +12,34 @@ changes, improvements or alternatives may be given).
 
 Here's some tips to make you the best contributor ever:
 
+* [Getting started](#getting-started)
 * [Standard code](#standard-code)
 * [Specifications](#specifications)
 * [Keeping your fork up-to-date](#keeping-your-fork-up-to-date)
 
+## Getting started
+
+Initialize the Docker development environment:
+
+```console
+make lib-init
+```
+
+Run the full QA pipeline:
+
+```console
+make lib-qa
+```
+
+Run `make` to see all available targets.
+
 ## Standard code
 
 Use [PHP CS fixer](http://cs.sensiolabs.org/) to make your code compliant with
 Memio's coding standards:
 
 ```console
-$ ./vendor/bin/php-cs-fixer fix .
+make cs-fix
 ```
 
 ## Specifications
@@ -32,31 +49,31 @@ Memio drives its development using [phpspec](http://www.phpspec.net/).
 First bootstrap the code for the Specification:
 
 ```console
-$ phpspec describe 'Memio\Memio\MyNewUseCase'
+make phpspec arg="describe 'Memio\SpecGen\MyNewUseCase'"
 ```
 
 Next, write the actual code of the Specification:
 
 ```console
-$ $EDITOR spec/Memio/SpecGen/MyNewUseCase.php
+$EDITOR spec/Memio/SpecGen/MyNewUseCase.php
 ```
 
 Then bootstrap the code for the corresponding Use Case:
 
 ```console
-$ phpspec run
+make phpspec
 ```
 
 Follow that by writing the actual code of the Use Case:
 
 ```console
-$ $EDITOR src/Memio/SpecGen/MyNewUseCase.php
+$EDITOR src/Memio/SpecGen/MyNewUseCase.php
 ```
 
 Finally run the specification:
 
 ```console
-$ phpspec run
+make phpspec
 ```
 
 Results should be green!

.travis.yml

@@ -0,0 +1,51 @@
+# syntax=docker/dockerfile:1
+
+###
+# PHP Dev Container
+# Utility Tools: PHP, bash, Composer
+###
+FROM php:7.2-cli AS php_dev_container
+
+# Composer environment variables:
+# * default user is superuser (root), so allow them
+# * put cache directory in a readable/writable location
+# _Note_: When running `composer` in container, use `--no-cache` option
+ENV COMPOSER_ALLOW_SUPERUSER=1 \
+    COMPOSER_CACHE_DIR=/tmp/.composer/cache
+
+# Update apt sources to use archived Debian repositories
+RUN sed -i 's/deb.debian.org/archive.debian.org/g' /etc/apt/sources.list \
+    && sed -i 's/security.debian.org/archive.debian.org/g' /etc/apt/sources.list \
+    && sed -i '/stretch-updates/d' /etc/apt/sources.list
+
+# Install dependencies:
+# * git: for composer to download packages from source
+# * libzip-dev: for composer packages that use ZIP archives
+# * unzip: for composer to extract packages
+# _Note (Hadolint)_: No version locking for dev container
+# hadolint ignore=DL3008
+RUN apt-get update && apt-get install -y --no-install-recommends \
+        git \
+        libzip-dev \
+        unzip \
+    && rm -rf /var/lib/apt/lists/*
+
+# Copy Composer binary from composer image
+# _Note (Hadolint)_: False positive as `COPY` works with images too
+# See: https://github.com/hadolint/hadolint/issues/197#issuecomment-1016595425
+# hadolint ignore=DL3022
+COPY --from=composer:2 /usr/bin/composer /usr/bin/composer
+
+WORKDIR /app
+
+# Caching `composer install`, as long as composer.json doesn't change.
+COPY composer.json ./
+RUN composer install \
+    --no-cache \
+    --no-interaction \
+    --no-plugins \
+    --no-scripts \
+    --optimize-autoloader
+
+# Copy the remaining application files (excluding those listed in .dockerignore)
+COPY . .