Merge pull request #91 from Progi1984/dev

Release 2.4.0

.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,9 +1,15 @@
-change-template: '- $TITLE (#$NUMBER)'
+branches:
+  - master
+name-template: v$NEXT_PATCH_VERSION
+tag-template: v$NEXT_PATCH_VERSION
+categories:
+  - title: 🚀 Improvements
+    label: enhancement
+  - title: 🐛 Bug Fixes
+    label: bug
+change-template: '- #$NUMBER: $TITLE by @$AUTHOR'
 template: |
-    ## Changelog
+  # Changes
 
-    $CHANGES
-
-    ### Contributors
-
-    $CONTRIBUTORS
+  $CHANGES
+  

.github/workflows/build-release.yml

@@ -0,0 +1,62 @@
+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: 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

@@ -0,0 +1,118 @@
+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
+        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
+
+    # 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
+              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.1.2', '1.7.2.5', '1.7.3.4', '1.7.4.4', '1.7.5.1', '1.7.6.9', '1.7.7.3', '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:
+                path: ~/.composer/cache
+                key: php-composer-cache
+
+            - run: composer install
+
+            # 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 }}
+
+    phpunit:
+        name: PHPUnit
+        runs-on: ubuntu-latest
+        steps:
+            - name: Setup PHP
+              uses: shivammathur/setup-php@v2
+              with:
+                php-version: 7.4
+                coverage: xdebug
+
+            - 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:
+                  path: ~/.composer/cache
+                  key: php-composer-cache
+
+            - run: composer install
+            - run: composer run test
+
+            - name: Upload coverage results to Coveralls
+              env:
+                COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+              run: |
+                wget https://github.com/php-coveralls/php-coveralls/releases/download/v2.4.3/php-coveralls.phar
+                chmod +x php-coveralls.phar
+                php php-coveralls.phar --coverage_clover=build/clover.xml --json_path=build/coveralls-upload.json -vvv

.php_cs.dist

@@ -0,0 +1,11 @@
+<?php
+
+$config = new PrestaShop\CodingStandards\CsFixer\Config();
+
+$config
+    ->setUsingCache(true)
+    ->getFinder()
+    ->in(__DIR__)
+    ->exclude('vendor');
+
+return $config;

Readme.md → README.md

@@ -2,7 +2,7 @@
 
 ## About
 
-Become an e-commerce expert within the blink of an eye! This module displays tips in your Back Office to help you make the best out of your shop.
+Check your completion rate and unblock all badges to become an e-commerce expert within the blink of an eye!
 
 ### Execute the test suite