Merge pull request #7 from cleverage/prepare-release

Prepare release v2.0

.docker/compose.yaml

@@ -0,0 +1,14 @@
+x-build-args: &build-args
+  UID: "${UID:-1000}"
+  GID: "${GID:-1000}"
+
+name: cleverage-flysystem-process-bundle
+
+services:
+  php:
+    build:
+      context: php
+      args:
+        <<: *build-args
+    volumes:
+      - ../:/var/www

.docker/php/Dockerfile

@@ -0,0 +1,29 @@
+FROM php:8.2-fpm-alpine
+
+ARG UID
+ARG GID
+
+RUN mv "$PHP_INI_DIR/php.ini-development" "$PHP_INI_DIR/php.ini"
+COPY /conf.d/ "$PHP_INI_DIR/conf.d/"
+
+RUN apk update && apk add \
+    tzdata \
+    shadow \
+    nano \
+    bash \
+    icu-dev \
+    && docker-php-ext-configure intl \
+    && docker-php-ext-install intl opcache \
+    && docker-php-ext-enable opcache
+
+RUN ln -s /usr/share/zoneinfo/Europe/Paris /etc/localtime \
+    && sed -i "s/^;date.timezone =.*/date.timezone = Europe\/Paris/" $PHP_INI_DIR/php.ini
+
+COPY --from=composer:2 /usr/bin/composer /usr/bin/composer
+
+RUN usermod -u $UID www-data \
+    && groupmod -g $GID www-data
+
+USER www-data:www-data
+
+WORKDIR /var/www

.docker/php/conf.d/dev.ini

@@ -0,0 +1,5 @@
+display_errors = 1
+error_reporting = E_ALL
+
+opcache.validate_timestamps = 1
+opcache.revalidate_freq = 0

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,14 @@
+## Description
+
+<!-- Please describe the issue here -->
+
+## Requirements
+
+* Documentation updates
+  - [ ] Reference
+  - [ ] Changelog
+* [ ] Unit tests 
+
+## Breaking changes
+
+<!-- Please list here every breaking changes this might induce with minor/major labels -->

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,14 @@
+## Description
+
+<!-- Please describe the PR purpose, with references to the issues -->
+
+## Requirements
+
+* Documentation updates
+  - [ ] Reference
+  - [ ] Changelog
+* [ ] Unit tests 
+
+## Breaking changes
+
+<!-- Please list here every breaking changes this PR might induce with minor/major labels -->

.github/workflows/notifications.yml

@@ -0,0 +1,23 @@
+name: Rocket chat notifications
+
+# Controls when the action will run. 
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  notification:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Get the tag short reference
+        id: get_tag
+        run: echo "TAG=${GITHUB_REF/refs\/tags\//}" >> $GITHUB_OUTPUT
+
+      - name: Rocket.Chat Notification
+        uses: madalozzo/Rocket.Chat.GitHub.Action.Notification@master
+        with:
+          type: success
+          job_name: "[cleverage/flysystem-process-bundle](https://github.com/cleverage/flysystem-process-bundle) : ${{ steps.get_tag.outputs.TAG }} has been released"
+          url: ${{ secrets.CLEVER_AGE_ROCKET_CHAT_WEBOOK_URL }}

.github/workflows/quality.yml

@@ -0,0 +1,62 @@
+name: Quality
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  phpstan:
+    name: PHPStan
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install PHP with extensions
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.2'
+          coverage: none
+          tools: composer:v2
+      - name: Install Composer dependencies (locked)
+        uses: ramsey/composer-install@v3
+      - name: PHPStan
+        run: vendor/bin/phpstan --no-progress --memory-limit=1G analyse --error-format=github
+
+  php-cs-fixer:
+    name: PHP-CS-Fixer
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install PHP with extensions
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.2'
+          coverage: none
+          tools: composer:v2
+      - name: Install Composer dependencies (locked)
+        uses: ramsey/composer-install@v3
+      - name: PHP-CS-Fixer
+        run: vendor/bin/php-cs-fixer fix --diff --dry-run --show-progress=none
+
+  rector:
+    name: Rector
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install PHP with extensions
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.2'
+          coverage: none
+          tools: composer:v2
+      - name: Install Composer dependencies (locked)
+        uses: ramsey/composer-install@v3
+      - name: Rector
+        run: vendor/bin/rector --no-progress-bar --dry-run

.github/workflows/test.yml

@@ -0,0 +1,74 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: PHP ${{ matrix.php-version }} + ${{ matrix.dependencies }} + ${{ matrix.variant }}
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.allowed-to-fail }}
+    env:
+      SYMFONY_REQUIRE: ${{matrix.symfony-require}}
+
+    strategy:
+      matrix:
+        php-version:
+          - '8.2'
+          - '8.3'
+        dependencies: [highest]
+        allowed-to-fail: [false]
+        symfony-require: ['']
+        variant: [normal]
+        include:
+          - php-version: '8.2'
+            dependencies: highest
+            allowed-to-fail: false
+            symfony-require: 6.4.*
+            variant: symfony/symfony:"6.4.*"
+          - php-version: '8.2'
+            dependencies: highest
+            allowed-to-fail: false
+            symfony-require: 7.1.*
+            variant: symfony/symfony:"7.1.*"
+          - php-version: '8.3'
+            dependencies: highest
+            allowed-to-fail: false
+            symfony-require: 6.4.*
+            variant: symfony/symfony:"6.4.*"
+          - php-version: '8.3'
+            dependencies: highest
+            allowed-to-fail: false
+            symfony-require: 7.1.*
+            variant: symfony/symfony:"7.1.*"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Install PHP with extensions
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          coverage: pcov
+          tools: composer:v2, flex
+      - name: Add PHPUnit matcher
+        run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
+      - name: Install variant
+        if: matrix.variant != 'normal' && !startsWith(matrix.variant, 'symfony/symfony')
+        run: composer require ${{ matrix.variant }} --no-update
+      - name: Install Composer dependencies (${{ matrix.dependencies }})
+        uses: ramsey/composer-install@v3
+        with:
+          dependency-versions: ${{ matrix.dependencies }}
+      - name: Run Tests with coverage
+        run: vendor/bin/phpunit -c phpunit.xml.dist --coverage-clover build/logs/clover.xml
+      #- name: Send coverage to Codecov
+      #  uses: codecov/codecov-action@v4
+      #  with:
+      #    files: build/logs/clover.xml

.gitignore

@@ -1,2 +1,9 @@
 /composer.lock
 /vendor
+.env
+.idea
+/phpunit.xml
+.phpunit.result.cache
+.phpunit.cache
+.php-cs-fixer.cache
+coverage-report

.php-cs-fixer.dist.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the CleverAge/FlysystemProcessBundle package.
+ *
+ * Copyright (c) Clever-Age
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+if (!file_exists(__DIR__.'/src')) {
+    exit(0);
+}
+
+$fileHeaderComment = <<<'EOF'
+    This file is part of the CleverAge/FlysystemProcessBundle package.
+
+    Copyright (c) Clever-Age
+
+    For the full copyright and license information, please view the LICENSE
+    file that was distributed with this source code.
+    EOF;
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PHP71Migration' => true,
+        '@PHP82Migration' => true,
+        '@PHPUnit75Migration:risky' => true,
+        '@Symfony' => true,
+        '@Symfony:risky' => true,
+        'protected_to_private' => false,
+        'native_constant_invocation' => ['strict' => false],
+        'header_comment' => ['header' => $fileHeaderComment],
+        'modernize_strpos' => true,
+        'get_class_to_class_keyword' => true,
+    ])
+    ->setRiskyAllowed(true)
+    ->setFinder(
+        (new PhpCsFixer\Finder())
+            ->in(__DIR__.'/src')
+            ->in(__DIR__.'/tests')
+            ->append([__FILE__])
+    )
+    ->setCacheFile('.php-cs-fixer.cache')
+;

CHANGELOG.md

@@ -0,0 +1,29 @@
+v2.0
+------
+
+## BC breaks
+
+* [#5](https://github.com/cleverage/flysystem-process-bundle/issues/5) Replace "oneup/flysystem-bundle": ">1.0,<4.0" by "league/flysystem-bundle": "^3.0"
+* [#5](https://github.com/cleverage/flysystem-process-bundle/issues/5) Update Tasks for "league/flysystem-bundle": "^3.0"
+* [#6](https://github.com/cleverage/flysystem-process-bundle/issues/6) Update services according to Symfony best practices. Services should not use autowiring or autoconfiguration. Instead, all services should be defined explicitly.
+  Services must be prefixed with the bundle alias instead of using fully qualified class names => `cleverage_flysystem_process`
+
+### Changes
+
+* [#3](https://github.com/cleverage/flysystem-process-bundle/issues/3) Add Makefile & .docker for local standalone usage
+* [#3](https://github.com/cleverage/flysystem-process-bundle/issues/3) Add rector, phpstan & php-cs-fixer configurations & apply it
+* [#4](https://github.com/cleverage/flysystem-process-bundle/issues/4) Remove `sidus/base-bundle` dependency
+
+### Fixes
+
+v1.0.1
+------
+
+### Fixes
+
+* Fixed dependencies after removing sidus/base-bundle from the base process bundle
+
+v1.0.0
+------
+
+* Initial release

CONTRIBUTING.md

@@ -0,0 +1,52 @@
+Contributing
+============
+
+First of all, **thank you** for contributing, **you are awesome**!
+
+Here are a few rules to follow in order to ease code reviews, and discussions before
+maintainers accept and merge your work.
+
+You MUST run the quality & test suites.
+
+You SHOULD write (or update) unit tests.
+
+You SHOULD write documentation.
+
+Please, write [commit messages that make sense](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html),
+and [rebase your branch](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) before submitting your Pull Request.
+
+One may ask you to [squash your commits](https://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html)
+too. This is used to "clean" your Pull Request before merging it (we don't want
+commits such as `fix tests`, `fix 2`, `fix 3`, etc.).
+
+Thank you!
+
+## Running the quality & test suites
+
+Tests suite uses Docker environments in order to be idempotent to OS's. More than this
+PHP version is written inside the Dockerfile; this assures to test the bundle with
+the same resources. No need to have PHP installed.
+
+You only need Docker set it up.
+
+To allow testing environments more smooth we implemented **Makefile**.
+You have two commands available:
+
+```bash
+make quality
+```
+
+```bash
+make tests
+```
+
+## Deprecations notices
+
+When a feature should be deprecated, or when you have a breaking change for a future version, please :
+* [Fill an issue](https://github.com/cleverage/flysystem-process-bundle/issues/new)
+* Add TODO comments with the following format: `@TODO deprecated v2.0`
+* Trigger a deprecation error: `@trigger_error('This feature will be deprecated in v2.0', E_USER_DEPRECATED);`
+
+You can check which deprecation notice is triggered in tests
+* `make bash`
+* `SYMFONY_DEPRECATIONS_HELPER=0 ./vendor/bin/phpunit`