Apply feedbacks

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,19 @@
+<!-----------------------------------------------------------------------------
+Thank you for contributing to the PrestaShop project! 
+
+Please take the time to edit the "Answers" rows below with the necessary information.
+
+Check out our contribution guidelines to find out how to complete it:
+https://devdocs.prestashop.com/1.7/contribute/contribution-guidelines/#pull-requests
+------------------------------------------------------------------------------>
+
+| Questions     | Answers
+| ------------- | -------------------------------------------------------
+| Description?  | Please be specific when describing the PR. <br> Every detail helps: versions, browser/server configuration, specific module/theme, etc. Feel free to add more information below this table.
+| Type?         | bug fix / improvement / new feature / refacto / critical
+| BC breaks?    | yes / no
+| Deprecations? | yes / no
+| Fixed ticket? | Fixes PrestaShop/Prestashop#{issue number here}.
+| How to test?  | Please indicate how to best verify that this PR is correct.
+
+<!-- Click the form's "Preview" button to make sure the table is functional in GitHub. Thank you! -->

.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "04:00"
+  open-pull-requests-limit: 10
+  target-branch: dev
+- package-ecosystem: composer
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "04:00"
+  open-pull-requests-limit: 10
+  target-branch: dev

.github/release-drafter.yml

@@ -1,16 +1,15 @@
+branches:
+  - master
 name-template: v$NEXT_PATCH_VERSION
 tag-template: v$NEXT_PATCH_VERSION
 categories:
-  - title: 🔨 Improvements
+  - title: 🚀 Improvements
     label: enhancement
   - title: 🐛 Bug Fixes
     label: bug
-  - title: 🚀 New Features
-    label: Feature
 change-template: '- #$NUMBER: $TITLE by @$AUTHOR'
 template: |
   # Changes
 
   $CHANGES
   
-

.github/workflows/build-release.yml

@@ -1,61 +1,62 @@
-name: Build & Release draft
-
-on:
-  pull_request:
-  push:
-    branches:
-      - master
+name: Build
+on: [push, pull_request]
 
 jobs:
-  deploy:
-    name: build dependencies & create artifact
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/[email protected]
-      - name: Install composer dependencies
-        run: composer install --no-dev -o
-      - name: Clean-up project
-        uses: PrestaShopCorp/[email protected]
-      - name: Create & upload artifact
-        uses: actions/upload-artifact@v1
-        with:
-          name: ${{ github.event.repository.name }}
-          path: ../
-  update_release_draft:
-    runs-on: ubuntu-latest
-    needs: [deploy]
-    if: github.event_name == 'push'
-    steps:
-      - name: Download artifact
-        uses: actions/download-artifact@v1
-        with:
-          name: ${{ github.event.repository.name }}
-      - id: release_info
-        uses: toolmantim/release-drafter@v5
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: Prepare for Release
-        run: |
-          cd ${{ github.event.repository.name }}
-          zip -r ${{ github.event.repository.name }}.zip ${{ github.event.repository.name }}
-      - name: Clean existing assets
-        shell: bash
-        run: |
-          curl -fsSL https://github.com/github/hub/raw/master/script/get | bash -s 2.14.1
-          assets=`bin/hub api -t repos/${{ github.repository }}/releases/${{ steps.release_info.outputs.id }}/assets | awk '/\].url/ { print $2 }'`
-          for asset in $assets
-          do
-            bin/hub api -X DELETE $asset
-          done
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: Publish to GitHub Release
-        uses: actions/[email protected]
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          upload_url: ${{ steps.release_info.outputs.upload_url }}
-          asset_path: ./${{ github.event.repository.name }}/${{ github.event.repository.name }}.zip
-          asset_name: ${{ github.event.repository.name }}.zip
-          asset_content_type: application/zip
+    deploy:
+        name: build dependencies & create artifact
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout
+              uses: actions/[email protected]
+            - name: Install composer dependencies
+              run: composer install --no-dev -o
+            - name: Clean-up project
+              uses: PrestaShopCorp/[email protected]
+            - name: Prepare auto-index tool
+              run: |
+                  composer global require prestashop/autoindex
+            - name: Generate index.php
+              run: |
+                  ~/.composer/vendor/bin/autoindex
+            - name: Create & upload artifact
+              uses: actions/upload-artifact@v1
+              with:
+                  name: ${{ github.event.repository.name }}
+                  path: ../
+    update_release_draft:
+        runs-on: ubuntu-latest
+        needs: [deploy]
+        if: github.event_name == 'push' && github.event.ref == 'refs/heads/master'
+        steps:
+            - name: Download artifact
+              uses: actions/download-artifact@v1
+              with:
+                  name: ${{ github.event.repository.name }}
+            - id: release_info
+              uses: toolmantim/release-drafter@v5
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+            - name: Prepare for Release
+              run: |
+                  cd ${{ github.event.repository.name }}
+                  zip -r ${{ github.event.repository.name }}.zip ${{ github.event.repository.name }}
+            - name: Clean existing assets
+              shell: bash
+              run: |
+                  curl -fsSL https://github.com/github/hub/raw/master/script/get | bash -s 2.14.1
+                  assets=`bin/hub api -t repos/${{ github.repository }}/releases/${{ steps.release_info.outputs.id }}/assets | awk '/\].url/ { print $2 }'`
+                  for asset in $assets
+                  do
+                      bin/hub api -X DELETE $asset
+                  done
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+            - name: Publish to GitHub Release
+              uses: actions/[email protected]
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+              with:
+                  upload_url: ${{ steps.release_info.outputs.upload_url }}
+                  asset_path: ./${{ github.event.repository.name }}/${{ github.event.repository.name }}.zip
+                  asset_name: ${{ github.event.repository.name }}.zip
+                  asset_content_type: application/zip

.github/workflows/php.yml

@@ -1,42 +1,81 @@
 name: PHP tests
 on: [push, pull_request]
 jobs:
+  # Check there is no syntax errors in the project
   php-linter:
-    name: PHP Syntax check 5.6|7.2|7.3
+    name: PHP Syntax check 5.6|7.2|7.3|7.4|8.0|8.1
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/[email protected]
+
       - name: PHP syntax checker 5.6
         uses: prestashop/github-action-php-lint/5.6@master
+
       - name: PHP syntax checker 7.2
         uses: prestashop/github-action-php-lint/7.2@master
+
       - name: PHP syntax checker 7.3
         uses: prestashop/github-action-php-lint/7.3@master
+
+      - name: PHP syntax checker 7.4
+        uses: prestashop/github-action-php-lint/7.4@master
+
+      - name: PHP syntax checker 8.0
+        uses: prestashop/github-action-php-lint/8.0@master
+
+      - name: PHP syntax checker 8.1
+        uses: prestashop/github-action-php-lint/8.1@master
+
+  # Check the PHP code follow the coding standards
   php-cs-fixer:
     name: PHP-CS-Fixer
     runs-on: ubuntu-latest
     steps:
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '7.4'
+
       - name: Checkout
         uses: actions/[email protected]
+
+      - name: Cache dependencies
+        uses: actions/cache@v2
+        with:
+          path: vendor
+          key: php-${{ hashFiles('composer.lock') }}
+
+      - name: Install dependencies
+        run: composer install
+
       - name: Run PHP-CS-Fixer
-        uses: prestashopcorp/github-action-php-cs-fixer@master
+        run: ./vendor/bin/php-cs-fixer fix --dry-run --diff --using-cache=no --diff-format udiff
+
+  # Run PHPStan against the module and a PrestaShop release
   phpstan:
     name: PHPStan
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        presta-versions: ['1.7.0.3', 'latest']
+        presta-versions: ['1.7.6', '1.7.7', '1.7.8', 'latest']
     steps:
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '7.4'
+
       - name: Checkout
         uses: actions/[email protected]
 
+      # Add vendor folder in cache to make next builds faster
       - name: Cache vendor folder
         uses: actions/cache@v1
         with:
           path: vendor
           key: php-${{ hashFiles('composer.lock') }}
 
+      # Add composer local folder in cache to make next builds faster
       - name: Cache composer folder
         uses: actions/cache@v1
         with:
@@ -45,8 +84,6 @@ jobs:
 
       - run: composer install
 
-      - name: Pull PrestaShop files (Tag ${{ matrix.presta-versions }})
-        run: docker run -tid --rm -v ps-volume:/var/www/html --name temp-ps prestashop/prestashop:${{ matrix.presta-versions }}
-
-      - name : Run PHPStan
-        run: docker run --rm --volumes-from temp-ps -v $PWD:/web/module -e _PS_ROOT_DIR_=/var/www/html --workdir=/web/module phpstan/phpstan:0.12 analyse --configuration=/web/module/tests/phpstan/phpstan.neon
+      # Docker images prestashop/prestashop may be used, even if the shop remains uninstalled
+      - name: Execute PHPStan on PrestaShop (Tag ${{ matrix.presta-versions }})
+        run: ./tests/phpstan.sh ${{ matrix.presta-versions }}

composer.json

@@ -35,4 +35,4 @@
         "prestashop/php-dev-tools": "~3.0"
     },
     "author": "PrestaShop"
-}
+}

tests/index.php

@@ -0,0 +1,35 @@
+<?php
+/*
+* 2007-2015 PrestaShop
+*
+* NOTICE OF LICENSE
+*
+* This source file is subject to the Academic Free License (AFL 3.0)
+* that is bundled with this package in the file LICENSE.txt.
+* It is also available through the world-wide-web at this URL:
+* http://opensource.org/licenses/afl-3.0.php
+* If you did not receive a copy of the license and are unable to
+* obtain it through the world-wide-web, please send an email
+* to [email protected] so we can send you a copy immediately.
+*
+* DISCLAIMER
+*
+* Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+* versions in the future. If you wish to customize PrestaShop for your
+* needs please refer to http://www.prestashop.com for more information.
+*
+*  @author PrestaShop SA <[email protected]>
+*  @copyright  2007-2015 PrestaShop SA
+*  @license    http://opensource.org/licenses/afl-3.0.php  Academic Free License (AFL 3.0)
+*  International Registered Trademark & Property of PrestaShop SA
+*/
+
+header('Expires: Mon, 26 Jul 1997 05:00:00 GMT');
+header('Last-Modified: ' . gmdate('D, d M Y H:i:s') . ' GMT');
+
+header('Cache-Control: no-store, no-cache, must-revalidate');
+header('Cache-Control: post-check=0, pre-check=0', false);
+header('Pragma: no-cache');
+
+header('Location: ../');
+exit;

tests/phpstan.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+PS_VERSION=$1
+
+set -e
+
+# Docker images prestashop/prestashop may be used, even if the shop remains uninstalled
+echo "Pull PrestaShop files (Tag ${PS_VERSION})"
+
+docker rm -f temp-ps || true
+docker volume rm -f ps-volume || true
+
+docker run -tid --rm -v ps-volume:/var/www/html --name temp-ps prestashop/prestashop:$PS_VERSION
+
+# Clear previous instance of the module in the PrestaShop volume
+echo "Clear previous module"
+
+docker exec -t temp-ps rm -rf /var/www/html/modules/ps_cashondelivery
+
+# Run a container for PHPStan, having access to the module content and PrestaShop sources.
+# This tool is outside the composer.json because of the compatibility with PHP 5.6
+echo "Run PHPStan using phpstan-${PS_VERSION}.neon file"
+
+docker run --rm --volumes-from temp-ps \
+       -v $PWD:/var/www/html/modules/ps_cashondelivery \
+       -e _PS_ROOT_DIR_=/var/www/html \
+       --workdir=/var/www/html/modules/ps_cashondelivery phpstan/phpstan:0.12 \
+       analyse \
+       --configuration=/var/www/html/modules/ps_cashondelivery/tests/phpstan/phpstan-$PS_VERSION.neon