Merge pull request #70 from maximehuran/feature/sylius-1-13

Allow Sylius 1.13
monsieurbiz · Jul 4, 2024 · 2900db8 · 2900db8
2 parents f1a5036 + bad4a91
commit 2900db8
Show file tree

Hide file tree

Showing 15 changed files with 127 additions and 142 deletions.
diff --git a/.github/workflows/recipe.yaml b/.github/workflows/recipe.yaml
@@ -9,47 +9,54 @@ jobs:
 
   recipe:
 
-    name: Flex recipe (PHP ${{ matrix.php }}, Sylius ${{ matrix.sylius }})
-
     runs-on: ubuntu-latest
 
     strategy:
       fail-fast: false
       matrix:
         php: ['8.0', '8.1', '8.2']
-        sylius: ['~1.11.0', '~1.12.0']
-        include:
-          - php: '8.1'
-            sylius: '~1.12.0'
-            sylius_paypal: '~1.5.0'
+        sylius: ["~1.11.0", "~1.12.0", "~1.13.0"]
+        exclude:
           - php: '8.2'
+            sylius: '~1.11.0'
+          - php: '8.0'
             sylius: '~1.12.0'
-            sylius_paypal: '~1.5.0'
+          - php: '8.0'
+            sylius: '~1.13.0'
 
     steps:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
           extensions: gd, intl, json
+          ini-values: date.timezone=UTC
+          tools: symfony-cli
 
       - name: Set project php-version
         run: |
-          echo "${{ matrix.php }}" > .php-version
+          echo ${{ matrix.php }} > .php-version
 
       - uses: actions/checkout@v3
         with:
           path: plugin
 
-      - run: mkdir -p /home/runner/{.composer/cache,.config/composer}
+      - name: Determine composer cache directory
+        id: composer-cache-directory
+        working-directory: plugin
+        run: echo "directory=$(composer config cache-dir)" >> $GITHUB_OUTPUT
 
-      - uses: actions/cache@v3
+      - name: Cache dependencies installed with composer
+        uses: actions/cache@v3
         id: cache-composer
         with:
-          path: /home/runner/.composer/cache
-          key: composer2-php:${{ matrix.php }}-sylius:${{ matrix.sylius }}-${{ github.sha }}
+          path: ${{ steps.composer-cache-directory.outputs.directory }}
+          key: composer2-php:${{ matrix.php }}-sylius:${{ matrix.sylius }}-${{ hashFiles('**/composer.json') }}
           restore-keys: composer2-php:${{ matrix.php }}-sylius:${{ matrix.sylius }}-
 
+      - name: Ensure that composer cache directory exists
+        run: mkdir -p ${{ steps.composer-cache-directory.outputs.directory }}
+
       - name: Composer Github Auth
         run: composer config -g github-oauth.github.com ${{ github.token }}
 
@@ -63,13 +70,6 @@ jobs:
         run: |
             composer require --no-install --no-scripts --no-progress sylius/sylius="${{ matrix.sylius }}"
 
-      # Fix Paypal 1.5 on Sylius 1.12 and PHP 8.1
-      - name: Make sure to install the required version of Sylius Paypal Plugin
-        if: ${{ matrix.sylius_paypal }}
-        working-directory: ./sylius
-        run: |
-            composer require --no-install --no-scripts --no-progress sylius/paypal-plugin="${{ matrix.sylius_paypal }}" # @see https://github.com/Sylius/PayPalPlugin/issues/295
-
       - name: Setup some requirements
         working-directory: ./sylius
         run: |
@@ -79,8 +79,9 @@ jobs:
             composer config --no-plugins --unset platform.php
             composer config --no-plugins extra.symfony.docker false
             composer config --no-plugins --json extra.symfony.endpoint '["https://api.github.com/repos/monsieurbiz/symfony-recipes/contents/index.json?ref=flex/master","flex://defaults"]'
+            composer config repositories.plugin '{"type": "path", "url": "../plugin/"}'
 
       - name: Require plugin & install all dependencies
         working-directory: ./sylius
         run: |
-            composer require monsieurbiz/sylius-cms-page-plugin="*@dev"
+          composer require monsieurbiz/sylius-cms-page-plugin="*@dev"
diff --git a/.github/workflows/security.yaml b/.github/workflows/security.yaml
@@ -8,14 +8,12 @@ jobs:
 
   security:
 
-    name: Security check (PHP ${{ matrix.php }})
-
     runs-on: ubuntu-latest
 
     strategy:
       fail-fast: false
       matrix:
-        php: ['8.0', '8.1', '8.2']
+        php: ['8.1', '8.2']
 
     steps:
       - uses: actions/checkout@v3
@@ -30,21 +28,26 @@ jobs:
         run: |
           echo "${{ matrix.php }}" > .php-version
 
-      - uses: actions/cache@v3
+      - name: Determine composer cache directory
+        id: composer-cache-directory
+        run: echo "directory=$(composer config cache-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache dependencies installed with composer
+        uses: actions/cache@v3
         id: cache-composer
         with:
-          path: /home/runner/.composer/cache
+          path: ${{ steps.composer-cache-directory.outputs.directory }}
           key: composer2-php:${{ matrix.php }}-${{ github.sha }}
           restore-keys: composer2-php:${{ matrix.php }}-
 
-      - run: mkdir -p /home/runner/{.composer/cache,.config/composer}
+      - name: Ensure that composer cache directory exists
+        run: mkdir -p ${{ steps.composer-cache-directory.outputs.directory }}
 
       - name: Composer Github Auth
         run: composer config -g github-oauth.github.com ${{ github.token }}
 
-      - uses: actions/checkout@v3
-
       - name: Install PHP dependencies
         run: composer update --prefer-dist
 
-      - uses: symfonycorp/security-checker-action@v3
+      - uses: symfonycorp/security-checker-action@v4
+
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -9,49 +9,49 @@ jobs:
 
   php:
 
-    name: Quality tests (PHP ${{ matrix.php }})
-
     runs-on: ubuntu-latest
 
     strategy:
       fail-fast: false
       matrix:
-        php: ['8.0', '8.1', '8.2']
+        php: ['8.1', '8.2']
 
     env:
       SYMFONY_ARGS: --no-tls
       COMPOSER_ARGS: --prefer-dist
       DOCKER_INTERACTIVE_ARGS: -t
 
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-node@v3
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
         with:
-          node-version: '16'
-
+          node-version: '14'
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}
           extensions: gd, intl, json
+          ini-values: date.timezone=UTC
+          tools: symfony-cli
 
       - name: Set project php-version
         run: |
           echo "${{ matrix.php }}" > .php-version
 
-      - name: Install symfony CLI
-        run: |
-          curl -1sLf 'https://dl.cloudsmith.io/public/symfony/stable/setup.deb.sh' | sudo -E bash
-          sudo apt install symfony-cli
+      - name: Determine composer cache directory
+        id: composer-cache-directory
+        run: echo "directory=$(composer config cache-dir)" >> $GITHUB_OUTPUT
 
-      - uses: actions/cache@v3
+      - name: Cache dependencies installed with composer
+        uses: actions/cache@v3
         id: cache-composer
         with:
-          path: /home/runner/.composer/cache
+          path: ${{ steps.composer-cache-directory.outputs.directory }}
           key: composer2-php:${{ matrix.php }}-${{ github.sha }}
           restore-keys: composer2-php:${{ matrix.php }}-
 
-      - run: mkdir -p /home/runner/{.composer/cache,.config/composer}
+      - name: Ensure that composer cache directory exists
+        run: mkdir -p ${{ steps.composer-cache-directory.outputs.directory }}
 
       - name: Composer Github Auth
         run: composer config -g github-oauth.github.com ${{ github.token }}

diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -49,10 +49,8 @@
         'binary_operator_spaces' => true,
         'blank_line_after_opening_tag' => true,
         'blank_line_after_namespace' => true,
+        'blank_lines_before_namespace' => true,
         'blank_line_before_statement' => true,
-        'braces' => [
-            'allow_single_line_closure' => true,
-        ],
         'cast_spaces' => true,
         'class_attributes_separation' => true,
         'class_definition' => [
@@ -62,7 +60,7 @@
         'combine_consecutive_issets' => true,
         'combine_consecutive_unsets' => true,
         'comment_to_phpdoc' => true,
-        'compact_nullable_typehint' => true,
+        'compact_nullable_type_declaration' => true,
         'concat_space' => [
             'spacing' => 'one',
         ],
@@ -88,8 +86,12 @@
         'fully_qualified_strict_types' => true,
         'function_declaration' => true,
         'function_to_constant' => true,
-        'function_typehint_space' => true,
         'general_phpdoc_tag_rename' => true,
+        'global_namespace_import' => [
+            'import_classes' => true,
+            'import_constants' => false,
+            'import_functions' => false,
+        ],
         'header_comment' => [
             'header' => $header,
             'location' => 'after_open',
@@ -110,14 +112,15 @@
         'lowercase_static_reference' => true,
         'magic_constant_casing' => true,
         'method_argument_space' => true,
+        'modernize_strpos' => false,
         'modernize_types_casting' => true,
         'multiline_comment_opening_closing' => true,
         'multiline_whitespace_before_semicolons' => [
             'strategy' => 'new_line_for_chained_calls',
         ],
         'native_constant_invocation' => true,
         'native_function_casing' => true,
-        'new_with_braces' => true,
+        'new_with_parentheses' => true,
         'no_alias_functions' => true,
         'no_alternative_syntax' => true,
         'no_blank_lines_after_class_opening' => true,
@@ -156,27 +159,27 @@
         'no_short_bool_cast' => true,
         'no_spaces_after_function_name' => true,
         'no_spaces_around_offset' => true,
-        'no_spaces_inside_parenthesis' => true,
+        'spaces_inside_parentheses' => true,
         'no_superfluous_elseif' => true,
         'no_superfluous_phpdoc_tags' => [
             'allow_mixed' => true,
         ],
         'no_unset_cast' => true,
         'no_unneeded_control_parentheses' => true,
-        'no_unneeded_curly_braces' => true,
+        'no_unneeded_braces' => true,
         'no_unneeded_final_method' => true,
         'no_unset_on_property' => true,
         'no_unused_imports' => true,
         'no_useless_else' => true,
         'no_useless_return' => true,
-        'no_trailing_comma_in_list_call' => true,
-        'no_trailing_comma_in_singleline_array' => true,
+        'no_trailing_comma_in_singleline' => true,
         'no_trailing_whitespace' => true,
         'no_trailing_whitespace_in_comment' => true,
         'no_whitespace_before_comma_in_array' => true,
         'no_whitespace_in_blank_line' => true,
         'non_printable_character' => true,
         'normalize_index_brace' => true,
+        'nullable_type_declaration_for_default_null_value' => false,
         'object_operator_without_whitespace' => true,
         'ordered_imports' => [
             'imports_order' => [
@@ -211,7 +214,9 @@
         'phpdoc_order' => true,
         'phpdoc_return_self_reference' => true,
         'phpdoc_scalar' => true,
-        'phpdoc_separation' => true,
+        'phpdoc_separation' => ['groups' => [
+            ['ORM\\*'], ['Assert\\*'],
+        ]],
         'phpdoc_single_line_var_spacing' => true,
         'phpdoc_tag_type' => true,
         'phpdoc_to_comment' => false,
@@ -231,7 +236,6 @@
         'self_accessor' => true,
         'short_scalar_cast' => true,
         'single_blank_line_at_eof' => true,
-        'single_blank_line_before_namespace' => true,
         'single_class_element_per_statement' => true,
         'single_import_per_statement' => true,
         'single_line_after_imports' => true,
@@ -248,6 +252,7 @@
             'elements' => ['arrays'],
         ],
         'trim_array_spaces' => true,
+        'type_declaration_spaces' => true,
         'unary_operator_spaces' => true,
         'visibility_required' => [
             'elements' => [

diff --git a/.php-version.dist b/.php-version.dist
@@ -1 +1 @@
-8.1
+8.2
diff --git a/Makefile b/Makefile
@@ -1,8 +1,7 @@
 .DEFAULT_GOAL := help
 SHELL=/bin/bash
 APP_DIR=tests/Application
-SYLIUS_VERSION=1.12.0
-SYLIUS_PAYPAL_VERSION=1.5.0
+SYLIUS_VERSION=1.13.0
 SYMFONY=cd ${APP_DIR} && symfony
 COMPOSER=symfony composer
 CONSOLE=${SYMFONY} console
@@ -73,8 +72,8 @@ setup_application:
 	(cd ${APP_DIR} && ${COMPOSER} config extra.symfony.allow-contrib true)
 	(cd ${APP_DIR} && ${COMPOSER} config minimum-stability dev)
 	(cd ${APP_DIR} && ${COMPOSER} config --no-plugins allow-plugins true)
+	(cd ${APP_DIR} && ${COMPOSER} config --no-plugins --json extra.symfony.endpoint '["https://api.github.com/repos/monsieurbiz/symfony-recipes/contents/index.json?ref=flex/master","flex://defaults"]')
 	(cd ${APP_DIR} && ${COMPOSER} require --no-install --no-scripts --no-progress sylius/sylius="~${SYLIUS_VERSION}") # Make sure to install the required version of sylius because the sylius-standard has a soft constraint
-	(cd ${APP_DIR} && ${COMPOSER} require --no-install --no-scripts --no-progress sylius/paypal-plugin="~${SYLIUS_PAYPAL_VERSION}") # @see https://github.com/Sylius/PayPalPlugin/issues/295
 	$(MAKE) ${APP_DIR}/.php-version
 	$(MAKE) ${APP_DIR}/php.ini
 	(cd ${APP_DIR} && ${COMPOSER} install --no-interaction)
@@ -86,8 +85,8 @@ setup_application:
 ${APP_DIR}/docker-compose.yaml:
 	rm -f ${APP_DIR}/docker-compose.yml
 	rm -f ${APP_DIR}/docker-compose.yaml
-	rm -f ${APP_DIR}/compose.yml
-	rm -f ${APP_DIR}/compose.override.dist.yml
+	rm -f ${APP_DIR}/compose.yml # Remove Sylius file about Docker
+	rm -f ${APP_DIR}/compose.override.dist.yml # Remove Sylius file about Docker
 	ln -s ../../docker-compose.yaml.dist ${APP_DIR}/docker-compose.yaml
 .PHONY: ${APP_DIR}/docker-compose.yaml
 
@@ -139,7 +138,7 @@ test.container: ## Lint the symfony container
 	${CONSOLE} lint:container
 
 test.yaml: ## Lint the symfony Yaml files
-	${CONSOLE} lint:yaml ../../src/Resources/config
+	${CONSOLE} lint:yaml ../../src/Resources/config --parse-tags
 
 test.schema: ## Validate MySQL Schema
 	${CONSOLE} doctrine:schema:validate

diff --git a/README.md b/README.md
@@ -1,19 +1,34 @@
 [![Banner of Sylius CMS Pages plugin](docs/images/banner.jpg)](https://monsieurbiz.com/agence-web-experte-sylius)
 
-<h1 align="center">CMS Pages</h1>
+<h1 align="center">Sylius CMS Pages</h1>
 
 [![CMS Page Plugin license](https://img.shields.io/github/license/monsieurbiz/SyliusCmsPagePlugin?public)](https://github.com/monsieurbiz/SyliusCmsPagePlugin/blob/master/LICENSE.txt)
-[![Tests Status](https://img.shields.io/github/workflow/status/monsieurbiz/SyliusCmsPagePlugin/Tests?logo=github)](https://github.com/monsieurbiz/SyliusCmsPagePlugin/actions?query=workflow%3ATests)
-[![Security Status](https://img.shields.io/github/workflow/status/monsieurbiz/SyliusCmsPagePlugin/Security?label=security&logo=github)](https://github.com/monsieurbiz/SyliusCmsPagePlugin/actions?query=workflow%3ASecurity)
+[![Tests Status](https://img.shields.io/github/actions/workflow/status/monsieurbiz/SyliusCmsPagePlugin/tests.yaml?branch=master&logo=github)](https://github.com/monsieurbiz/SyliusCmsPagePlugin/actions?query=workflow%3ATests)
+[![Recipe Status](https://img.shields.io/github/actions/workflow/status/monsieurbiz/SyliusCmsPagePlugin/recipe.yaml?branch=master&label=recipes&logo=github)](https://github.com/monsieurbiz/SyliusCmsPagePlugin/actions?query=workflow%3ASecurity)
+[![Security Status](https://img.shields.io/github/actions/workflow/status/monsieurbiz/SyliusCmsPagePlugin/security.yaml?branch=master&label=security&logo=github)](https://github.com/monsieurbiz/SyliusCmsPagePlugin/actions?query=workflow%3ASecurity)
 
 This plugins allows you to add manage CMS pages using the Rich Editor.
 
 If you want to know more about our editor, see the [Rich Editor Repository](https://github.com/monsieurbiz/SyliusRichEditorPlugin)
 
 ![Example of CMS page creation](screenshots/demo.gif)
 
+## Compatibility
+
+| Sylius Version | PHP Version |
+|---|---|
+| 1.11 | 8.0 - 8.1 |
+| 1.12 | 8.1 - 8.2 |
+| 1.13 | 8.1 - 8.2 |
+
 ## Installation
 
+If you want to use our recipes, you can configure your composer.json by running:
+
+```bash
+composer config --no-plugins --json extra.symfony.endpoint '["https://api.github.com/repos/monsieurbiz/symfony-recipes/contents/index.json?ref=flex/master","flex://defaults"]'
+```
+
 ```bash
 composer require monsieurbiz/sylius-cms-page-plugin
 ```