Merge pull request #92 from PrestaShopCorp/dev

Prepare release of v1.2.0
PrestaShop · Jul 16, 2020 · 1609172 · 1609172
2 parents 89ec4d8 + 4c78507
commit 1609172
Show file tree

Hide file tree

Showing 91 changed files with 3,662 additions and 1,891 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.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! -->
diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
@@ -0,0 +1,16 @@
+name-template: v$NEXT_PATCH_VERSION
+tag-template: v$NEXT_PATCH_VERSION
+categories:
+  - title: 🔨 Improvements
+    label: enhancement
+  - title: 🐛 Bug Fixes
+    label: bug
+  - title: 🚀 New Features
+    label: Feature
+change-template: '- #$NUMBER: $TITLE by @$AUTHOR'
+template: |
+  # Changes
+
+  $CHANGES
+  
+
diff --git a/.github/workflows/build-release.yml b/.github/workflows/build-release.yml
@@ -0,0 +1,61 @@
+name: Build & Release draft
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  deploy:
+    name: build dependencies & create artifact
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2.0.0
+      - name: Install composer dependencies
+        run: composer install --no-dev -o
+      - name: Clean-up project
+        uses: PrestaShopCorp/github-action-clean-before-deploy@v1.0
+      - 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/upload-release-asset@v1.0.1
+        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
diff --git a/.github/workflows/php.yml b/.github/workflows/php.yml
@@ -0,0 +1,52 @@
+name: PHP tests
+on: [push, pull_request]
+jobs:
+  php-linter:
+    name: PHP Syntax check 5.6|7.2|7.3
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2.0.0
+      - 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
+  php-cs-fixer:
+    name: PHP-CS-Fixer
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2.0.0
+      - name: Run PHP-CS-Fixer
+        uses: prestashopcorp/github-action-php-cs-fixer@master
+  phpstan:
+    name: PHPStan
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        presta-versions: ['1.7.0.3', 'latest']
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2.0.0
+
+      - name: Cache vendor folder
+        uses: actions/cache@v1
+        with:
+          path: vendor
+          key: php-${{ hashFiles('composer.lock') }}
+
+      - name: Cache composer folder
+        uses: actions/cache@v1
+        with:
+          path: ~/.composer/cache
+          key: php-composer-cache
+
+      - 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 --error-format github
diff --git a/.gitignore b/.gitignore
@@ -1,126 +1,6 @@
-
-# Created by https://www.gitignore.io/api/vim,linux,macos,windows,sublimetext,visualstudiocode
-
-### Linux ###
-*~
-
-# temporary files which can be created if a process still has a handle open of a deleted file
-.fuse_hidden*
-
-# KDE directory preferences
-.directory
-
-# Linux trash folder which might appear on any partition or disk
-.Trash-*
-
-# .nfs files are created when an open file is removed but is still being accessed
-.nfs*
-
-### macOS ###
-*.DS_Store
-.AppleDouble
-.LSOverride
-
-# Icon must end with two \r
-Icon
-
-# Thumbnails
-._*
-
-# Files that might appear in the root of a volume
-.DocumentRevisions-V100
-.fseventsd
-.Spotlight-V100
-.TemporaryItems
-.Trashes
-.VolumeIcon.icns
-.com.apple.timemachine.donotpresent
-
-# Directories potentially created on remote AFP share
-.AppleDB
-.AppleDesktop
-Network Trash Folder
-Temporary Items
-.apdisk
-
-### SublimeText ###
-# cache files for sublime text
-*.tmlanguage.cache
-*.tmPreferences.cache
-*.stTheme.cache
-*.phpintel/
-
-# workspace files are user-specific
-*.sublime-workspace
-
-# project files should be checked into the repository, unless a significant
-# proportion of contributors will probably not be using SublimeText
-# *.sublime-project
-
-# sftp configuration file
-sftp-config.json
-
-# Package control specific files
-Package Control.last-run
-Package Control.ca-list
-Package Control.ca-bundle
-Package Control.system-ca-bundle
-Package Control.cache/
-Package Control.ca-certs/
-Package Control.merged-ca-bundle
-Package Control.user-ca-bundle
-oscrypto-ca-bundle.crt
-bh_unicode_properties.cache
-
-# Sublime-github package stores a github token in this file
-# https://packagecontrol.io/packages/sublime-github
-GitHub.sublime-settings
-
-### Vim ###
-.phpcomplete_extended/*
-# swap
-[._]*.s[a-v][a-z]
-[._]*.sw[a-p]
-[._]s[a-v][a-z]
-[._]sw[a-p]
-# session
-Session.vim
-# temporary
-.netrwhist
-# auto-generated tag files
-tags
-
-### VisualStudioCode ###
-.vscode/
-.vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
-.history
-
-### Windows ###
-# Windows thumbnail cache files
-Thumbs.db
-ehthumbs.db
-ehthumbs_vista.db
-
-# Folder config file
-Desktop.ini
-
-# Recycle Bin used on file shares
-$RECYCLE.BIN/
-
-# Windows Installer files
-*.cab
-*.msi
-*.msm
-*.msp
-
-# Windows shortcuts
-*.lnk
-
-*.xml
-composer.json
-composer.lock
-# End of https://www.gitignore.io/api/vim,linux,macos,windows,sublimetext,visualstudiocode
+/vendor
+/node_modules
+tests/php/coverage
+config_*.xml
+.php_cs.cache
+.idea
diff --git a/.php_cs.dist b/.php_cs.dist
@@ -0,0 +1,11 @@
+<?php
+
+$config = new PrestaShop\CodingStandards\CsFixer\Config();
+
+$config
+    ->setUsingCache(true)
+    ->getFinder()
+    ->in(__DIR__)
+    ->exclude('vendor');
+
+return $config;
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -0,0 +1,12 @@
+GitHub contributors:
+--------------------------------
+ - GuillaumeKadolis
+ - Kamel Boukhateb
+ - Matt75
+ - Quetzacoalt91
+ - SebBareyre
+ - Shiryu75
+ - daresh
+ - eternoendless
+ - netraagal
+ - v4lux
diff --git a/Readme.md b/Readme.md
@@ -4,6 +4,10 @@
 
 Official GDPR compliance module
 
+## Multistore compatibility
+
+This module is partially compatible with the multistore feature. Some of its options might not be available.
+
 ## Contributing
 
 PrestaShop modules are open source extensions to the [PrestaShop e-commerce platform][prestashop]. Everyone is welcome and even encouraged to contribute with their own improvements!

diff --git a/classes/APIFAQClass.php b/classes/APIFAQClass.php
@@ -1,45 +1,56 @@
 <?php
 /**
-* 2007-2016 PrestaShop
-*
-* 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 <contact@prestashop.com>
-* @copyright 2007-2015 PrestaShop SA
-* @license   http://addons.prestashop.com/en/content/12-terms-and-conditions-of-use
-* International Registered Trademark & Property of PrestaShop SA
-*/
-
+ * 2007-2020 PrestaShop and Contributors
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Academic Free License 3.0 (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:
+ * https://opensource.org/licenses/AFL-3.0
+ * 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 license@prestashop.com so we can send you a copy immediately.
+ *
+ * @author    PrestaShop SA <contact@prestashop.com>
+ * @copyright 2007-2020 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/AFL-3.0 Academic Free License 3.0 (AFL-3.0)
+ * International Registered Trademark & Property of PrestaShop SA
+ */
 class APIFAQ
 {
+    /**
+     * @param string $module_key
+     * @param mixed $version
+     *
+     * @return object|false
+     */
     public function getData($module_key, $version)
     {
         if (function_exists('curl_init') == false) {
             return false;
         }
         $context = Context::getContext();
         $iso_code = Language::getIsoById($context->language->id);
-        $url = 'http://api.addons.prestashop.com/request/faq/'.$module_key.'/'.$version.'/'.$iso_code;
-        $options = array(
-            CURLOPT_URL            => $url,
+        $url = 'http://api.addons.prestashop.com/request/faq/' . $module_key . '/' . $version . '/' . $iso_code;
+        $options = [
+            CURLOPT_URL => $url,
             CURLOPT_RETURNTRANSFER => true,
-            CURLOPT_HEADER         => false
-        );
+            CURLOPT_HEADER => false,
+        ];
         $CURL = curl_init();
         curl_setopt_array($CURL, $options);
         $content = curl_exec($CURL);
         curl_close($CURL);
         if (!$content) {
             return false;
         }
-        $content = Tools::jsonDecode($content);
-        if (!$content || empty($content->categories)) {
+        /** @var object $content */
+        $content = Tools::jsonDecode($content, true);
+        if (empty($content->categories)) {
             return false;
         }
+
         return $content->categories;
     }
 }