Merge pull request #547 from matomo-org/spice-psr-check-coding-standard

Adds test for phpcs using Matomo coding standards, #PG-3751
matomo-org · Sep 26, 2024 · e9b088f · e9b088f
2 parents b3c4c62 + ae4de50
commit e9b088f
Show file tree

Hide file tree

Showing 116 changed files with 918 additions and 269 deletions.
diff --git a/.github/workflows/phpcs.yml b/.github/workflows/phpcs.yml
@@ -0,0 +1,42 @@
+name: PHPCS check
+
+on: pull_request
+
+permissions:
+  actions: read
+  checks: read
+  contents: read
+  deployments: none
+  issues: read
+  packages: none
+  pull-requests: read
+  repository-projects: none
+  security-events: none
+  statuses: read
+
+jobs:
+  phpcs:
+    name: PHPCS
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          lfs: false
+          persist-credentials: false
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '7.4'
+          tools: cs2pr
+      - name: Install dependencies
+        run:
+          composer --no-plugins config allow-plugins.dealerdirect/phpcodesniffer-composer-installer true -n;
+          composer config repositories.matomo-coding-standards vcs https://github.com/matomo-org/matomo-coding-standards -n;
+          composer require matomo-org/matomo-coding-standards:dev-master;
+          composer install --dev --prefer-dist --no-progress --no-suggest
+      - name: Check PHP code styles
+        id: phpcs
+        run: ./vendor/bin/phpcs --report-full --standard=phpcs.xml --report-checkstyle=./phpcs-report.xml
+      - name: Show PHPCS results in PR
+        if: ${{ always() && steps.phpcs.outcome == 'failure' }}
+        run: cs2pr ./phpcs-report.xml --prepend-filename
diff --git a/ApiQuotaHelper.php b/ApiQuotaHelper.php
@@ -6,6 +6,7 @@
  * @link https://matomo.org
  * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
  */
+
 namespace Piwik\Plugins\GoogleAnalyticsImporter;
 
 /**
@@ -17,7 +18,7 @@ class ApiQuotaHelper
      * Calculate the daily maximum api quota available for the instance
      * @return int
      */
-    public function getMaxDailyApiQuota() : int
+    public function getMaxDailyApiQuota(): int
     {
         //Local installation. No limitations from google applicable
         return -1;

diff --git a/CannotImportCustomDimensionException.php b/CannotImportCustomDimensionException.php
@@ -6,6 +6,7 @@
  * @link http://piwik.org
  * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
  */
+
 namespace Piwik\Plugins\GoogleAnalyticsImporter;
 
 class CannotImportCustomDimensionException extends \Exception

diff --git a/CannotImportCustomDimensionGA4Exception.php b/CannotImportCustomDimensionGA4Exception.php
@@ -6,6 +6,7 @@
  * @link http://piwik.org
  * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
  */
+
 namespace Piwik\Plugins\GoogleAnalyticsImporter;
 
 class CannotImportCustomDimensionGA4Exception extends \Exception

diff --git a/CannotImportGoalException.php b/CannotImportGoalException.php
@@ -6,6 +6,7 @@
  * @link http://piwik.org
  * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
  */
+
 namespace Piwik\Plugins\GoogleAnalyticsImporter;
 
 class CannotImportGoalException extends \Exception

diff --git a/CannotProcessImportException.php b/CannotProcessImportException.php
@@ -6,6 +6,7 @@
  * @link http://piwik.org
  * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
  */
+
 namespace Piwik\Plugins\GoogleAnalyticsImporter;
 
 class CannotProcessImportException extends \Exception

diff --git a/Commands/ArchiveImportedData.php b/Commands/ArchiveImportedData.php
@@ -6,25 +6,29 @@
  * @link https://matomo.org
  * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
  */
+
 namespace Piwik\Plugins\GoogleAnalyticsImporter\Commands;
 
 use Piwik\Container\StaticContainer;
 use Piwik\Plugin\ConsoleCommand;
 use Piwik\Plugins\GoogleAnalyticsImporter\ImportStatus;
 use Piwik\Plugins\GoogleAnalyticsImporter\Logger\LogToSingleFileProcessor;
 use Piwik\Plugins\GoogleAnalyticsImporter\Tasks;
+
 class ArchiveImportedData extends ConsoleCommand
 {
     protected function configure()
     {
         $this->setName('googleanalyticsimporter:archive-imported-data');
-        $this->setDescription('Initiates core:archive for an imported site. This is run automatically every day, but can be run manually if needed.' . ' All it really does is call core:archive w/ a few custom parameters so data from years back gets archived.');
+        $this->setDescription(
+            'Initiates core:archive for an imported site. This is run automatically every day, but can be run manually if needed.' . ' All it really does is call core:archive w/ a few custom parameters so data from years back gets archived.'
+        );
         $this->addRequiredValueOption('idSite', null, 'The ID of the imported site to initiate archiving for.');
     }
     /**
      * @return int
      */
-    protected function doExecute() : int
+    protected function doExecute(): int
     {
         $input = $this->getInput();
         $output = $this->getOutput();

diff --git a/Commands/GenerateGaTestData.php b/Commands/GenerateGaTestData.php
@@ -6,6 +6,7 @@
  * @link http://piwik.org
  * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
  */
+
 namespace Piwik\Plugins\GoogleAnalyticsImporter\Commands;
 
 use Piwik\Common;
@@ -14,6 +15,7 @@
 use Piwik\Http;
 use Piwik\Plugin\ConsoleCommand;
 use Piwik\Log\LoggerInterface;
+
 class GenerateGaTestData extends ConsoleCommand
 {
     private $visitorIdSeeds = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25];
@@ -137,7 +139,7 @@ public function isEnabled()
     {
         return Development::isEnabled();
     }
-    protected function doExecute() : int
+    protected function doExecute(): int
     {
         $input = $this->getInput();
         $output = $this->getOutput();

diff --git a/Commands/ImportGA4Reports.php b/Commands/ImportGA4Reports.php
@@ -6,6 +6,7 @@
  * @link http://piwik.org
  * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
  */
+
 namespace Piwik\Plugins\GoogleAnalyticsImporter\Commands;
 
 use Piwik\Config;
@@ -28,6 +29,7 @@
 use Piwik\Plugins\GoogleAnalyticsImporter\ImportWasCancelledException;
 use Piwik\Plugins\GoogleAnalyticsImporter\Logger\LogToSingleFileProcessor;
 use Piwik\Plugins\GoogleAnalyticsImporter\Tasks;
+
 require_once __DIR__ . '/../vendor/autoload.php';
 class ImportGA4Reports extends ConsoleCommand
 {
@@ -39,16 +41,27 @@ protected function configure()
         $this->addRequiredValueOption('streamIds', null, 'The streamId for which you want to pull data. For multiple streams, use comma separated streamIds. By default it pulls data for all streams');
         $this->addRequiredValueOption('dates', null, 'The dates to import, eg, 2015-03-04,2015-04-12.');
         $this->addRequiredValueOption('idsite', null, 'The site to import into. This will attempt to continue an existing import.');
-        $this->addRequiredValueOption('cvar-count', null, 'The number of custom variables to support (if not supplied defaults to however many are currently available). ' . 'NOTE: This option will attempt to set the number of custom variable slots which should be done with care on an existing system.');
+        $this->addRequiredValueOption(
+            'cvar-count',
+            null,
+            'The number of custom variables to support (if not supplied defaults to however many are currently available). ' .
+            'NOTE: This option will attempt to set the number of custom variable slots which should be done with care on an existing system.'
+        );
         $this->addNoValueOption('skip-archiving', null, 'Skips launching archiving at the end of an import. Use this only if executing PHP from the command line results in an error on your system.');
         $this->addNoValueOption('mobile-app', null, 'If this option is used, the Matomo measurable that is created will be a mobile app. Requires the MobileAppMeasurable be activated.');
         $this->addRequiredValueOption('timezone', null, 'If your GA property\'s timezone is set to a value that is not a timezone recognized by PHP, you can specify a valid timezone manually with this option.');
-        $this->addRequiredValueOption('extra-custom-dimension', null, 'Map extra google analytics dimensions as matomo dimensions. This can be used to import dimensions like age & gender. Values should be like "gaDimension,dimensionScope", for example "userAgeBracket,visit".', [], \true);
+        $this->addRequiredValueOption(
+            'extra-custom-dimension',
+            null,
+            'Map extra google analytics dimensions as matomo dimensions. This can be used to import dimensions like age & gender. Values should be like "gaDimension,dimensionScope", for example "userAgeBracket,visit".',
+            [],
+            \true
+        );
     }
     /**
      * @return int
      */
-    protected function doExecute() : int
+    protected function doExecute(): int
     {
         try {
             return $this->executeImpl();
@@ -60,7 +73,7 @@ protected function doExecute() : int
             return self::FAILURE;
         }
     }
-    protected function executeImpl() : int
+    protected function executeImpl(): int
     {
         $input = $this->getInput();
         $output = $this->getOutput();

diff --git a/Commands/ImportReports.php b/Commands/ImportReports.php
@@ -6,6 +6,7 @@
  * @link http://piwik.org
  * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
  */
+
 namespace Piwik\Plugins\GoogleAnalyticsImporter\Commands;
 
 use Piwik\Config;
@@ -27,6 +28,7 @@
 use Piwik\Plugins\WebsiteMeasurable\Type;
 use Piwik\Site;
 use Piwik\Timer;
+
 require_once __DIR__ . '/../vendor/autoload.php';
 // TODO: make sure same version of google api client is used in this & SearchEngineKeywordsPerformance
 // (may have to add test in target plugin)
@@ -51,7 +53,7 @@ protected function configure()
     /**
      * @return int
      */
-    protected function doExecute() : int
+    protected function doExecute(): int
     {
         $this->getOutput()->writeln("GA3 Import disabled");
         return self::FAILURE;
@@ -65,7 +67,7 @@ protected function doExecute() : int
             return self::FAILURE;
         }
     }
-    protected function executeImpl() : int
+    protected function executeImpl(): int
     {
         $isAccountDeduced = \false;
         $input = $this->getInput();

diff --git a/Controller.php b/Controller.php
@@ -7,22 +7,18 @@
  * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
  *
  */
+
 namespace Piwik\Plugins\GoogleAnalyticsImporter;
 
 use Piwik\Common;
 use Piwik\Container\StaticContainer;
 use Piwik\DataTable\Renderer\Json;
 use Piwik\Date;
-use Piwik\Http;
 use Piwik\Nonce;
 use Piwik\Notification;
 use Piwik\Piwik;
-use Piwik\Plugin\Manager;
-use Piwik\Plugins\ConnectAccounts\ConnectAccounts;
-use Piwik\Plugins\ConnectAccounts\helpers\ConnectHelper;
 use Piwik\Plugins\ConnectAccounts\Strategy\Google\GoogleConnect;
 use Piwik\Plugins\GoogleAnalyticsImporter\Commands\ImportGA4Reports;
-use Piwik\Plugins\GoogleAnalyticsImporter\Commands\ImportReports;
 use Piwik\Plugins\GoogleAnalyticsImporter\Google\Authorization;
 use Piwik\Plugins\GoogleAnalyticsImporter\Google\AuthorizationGA4;
 use Piwik\Plugins\GoogleAnalyticsImporter\Input\EndDate;
@@ -34,9 +30,10 @@
 use Piwik\Url;
 use Piwik\Log\LoggerInterface;
 use Piwik\Plugins\SitesManager\SitesManager;
+
 class Controller extends \Piwik\Plugin\ControllerAdmin
 {
-    const OAUTH_STATE_NONCE_NAME = 'GoogleAnalyticsImporter.oauthStateNonce';
+    public const OAUTH_STATE_NONCE_NAME = 'GoogleAnalyticsImporter.oauthStateNonce';
     public function index($errorMessage = \false)
     {
         Piwik::checkUserHasSuperUserAccess();
@@ -105,7 +102,69 @@ public function index($errorMessage = \false)
         }
         $configureConnectionProps = \Piwik\Plugins\GoogleAnalyticsImporter\GoogleAnalyticsImporter::getConfigureConnectProps($nonce);
         $isClientConfigurable = StaticContainer::get('GoogleAnalyticsImporter.isClientConfigurable');
-        return $this->renderTemplate('index', ['isClientConfigurable' => $isClientConfigurable, 'isConfigured' => $authorization->hasAccessToken(), 'auth_nonce' => Nonce::getNonce('gaimport.auth', 1200), 'hasClientConfiguration' => $hasClientConfiguration, 'nonce' => $nonce, 'statuses' => $statuses, 'stopImportNonce' => $stopImportNonce, 'startImportNonce' => $startImportNonce, 'changeImportEndDateNonce' => $changeImportEndDateNonce, 'resumeImportNonce' => $resumeImportNonce, 'scheduleReImportNonce' => $scheduleReImportNonce, 'maxEndDateDesc' => $maxEndDateDesc, 'importOptionsUA' => array('ua' => Piwik::translate('GoogleAnalyticsImporter_SelectImporterUATitle')), 'importOptionsGA4' => ['ga4' => Piwik::translate('GoogleAnalyticsImporter_SelectImporterGA4Title')], 'extraCustomDimensionsField' => ['field1' => ['key' => 'gaDimension', 'title' => Piwik::translate('GoogleAnalyticsImporter_GADimension'), 'uiControl' => 'text', 'availableValues' => null], 'field2' => ['key' => 'dimensionScope', 'title' => Piwik::translate('GoogleAnalyticsImporter_DimensionScope'), 'uiControl' => 'select', 'availableValues' => ['visit' => Piwik::translate('General_Visit'), 'action' => Piwik::translate('General_Action')]]], 'extraCustomDimensionsFieldGA4' => ['field1' => ['key' => 'ga4Dimension', 'title' => Piwik::translate('GoogleAnalyticsImporter_GA4Dimension'), 'uiControl' => 'text', 'availableValues' => null], 'field2' => ['key' => 'dimensionScope', 'title' => Piwik::translate('GoogleAnalyticsImporter_DimensionScope'), 'uiControl' => 'select', 'availableValues' => ['visit' => Piwik::translate('General_Visit'), 'action' => Piwik::translate('General_Action')]]], 'streamIdsFieldGA4' => ['field1' => ['key' => 'streamId', 'title' => Piwik::translate('GoogleAnalyticsImporter_StreamId'), 'uiControl' => 'text', 'availableValues' => null]], 'extensions' => self::getComponentExtensions(), 'configureConnectionProps' => $configureConnectionProps]);
+        return $this->renderTemplate(
+            'index',
+            [
+                'isClientConfigurable' => $isClientConfigurable,
+                'isConfigured' => $authorization->hasAccessToken(),
+                'auth_nonce' => Nonce::getNonce('gaimport.auth', 1200),
+                'hasClientConfiguration' => $hasClientConfiguration,
+                'nonce' => $nonce,
+                'statuses' => $statuses,
+                'stopImportNonce' => $stopImportNonce,
+                'startImportNonce' => $startImportNonce,
+                'changeImportEndDateNonce' => $changeImportEndDateNonce,
+                'resumeImportNonce' => $resumeImportNonce,
+                'scheduleReImportNonce' => $scheduleReImportNonce,
+                'maxEndDateDesc' => $maxEndDateDesc,
+                'importOptionsUA' => array(
+                    'ua' => Piwik::translate('GoogleAnalyticsImporter_SelectImporterUATitle')),
+                'importOptionsGA4' => [
+                    'ga4' => Piwik::translate('GoogleAnalyticsImporter_SelectImporterGA4Title')],
+                'extraCustomDimensionsField' => [
+                    'field1' => [
+                        'key' => 'gaDimension',
+                        'title' => Piwik::translate('GoogleAnalyticsImporter_GADimension'),
+                        'uiControl' => 'text',
+                        'availableValues' => null
+                    ],
+                    'field2' => [
+                        'key' => 'dimensionScope',
+                        'title' => Piwik::translate('GoogleAnalyticsImporter_DimensionScope'),
+                        'uiControl' => 'select',
+                        'availableValues' => [
+                            'visit' => Piwik::translate('General_Visit'),
+                            'action' => Piwik::translate('General_Action')]
+                    ]
+                ],
+                'extraCustomDimensionsFieldGA4' => [
+                    'field1' => [
+                        'key' => 'ga4Dimension',
+                        'title' => Piwik::translate('GoogleAnalyticsImporter_GA4Dimension'),
+                        'uiControl' => 'text',
+                        'availableValues' => null
+                    ],
+                    'field2' => [
+                        'key' => 'dimensionScope',
+                        'title' => Piwik::translate('GoogleAnalyticsImporter_DimensionScope'),
+                        'uiControl' => 'select',
+                        'availableValues' => [
+                            'visit' => Piwik::translate('General_Visit'),
+                            'action' => Piwik::translate('General_Action')]
+                    ]
+                ],
+                'streamIdsFieldGA4' => [
+                    'field1' => [
+                        'key' => 'streamId',
+                        'title' => Piwik::translate('GoogleAnalyticsImporter_StreamId'),
+                        'uiControl' => 'text',
+                        'availableValues' => null
+                    ]
+                ],
+                'extensions' => self::getComponentExtensions(),
+                'configureConnectionProps' => $configureConnectionProps
+            ]
+        );
     }
     public function forwardToAuth()
     {
@@ -457,10 +516,11 @@ public function displayConfigureImportNotification()
      * @return array Map of component extensions. Like [ [ 'plugin' => 'PluginName', 'component' => 'ComponentName' ] ]
      * See {@link https://developer.matomo.org/guides/in-depth-vue#allowing-plugins-to-add-content-to-your-vue-components the developer documentation} for more information.
      */
-    public static function getComponentExtensions($isNoDataPage = \false) : array
+    public static function getComponentExtensions($isNoDataPage = \false): array
     {
         $componentExtensions = [];
         Piwik::postEvent('GoogleAnalyticsImporter.getGoogleConfigComponentExtensions', [&$componentExtensions, $isNoDataPage]);
+
         return $componentExtensions;
     }
     private function getStreamIdsFromRequest()

diff --git a/Diagnostic/RequiredExecutablesCheck.php b/Diagnostic/RequiredExecutablesCheck.php
@@ -7,13 +7,15 @@
  * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
  *
  */
+
 namespace Piwik\Plugins\GoogleAnalyticsImporter\Diagnostic;
 
 use Piwik\CliMulti\CliPhp;
 use Piwik\Plugins\Diagnostics\Diagnostic\Diagnostic;
 use Piwik\Plugins\Diagnostics\Diagnostic\DiagnosticResult;
 use Piwik\SettingsServer;
 use Piwik\Translation\Translator;
+
 class RequiredExecutablesCheck implements Diagnostic
 {
     /**

diff --git a/Diagnostic/RequiredFunctionsCheck.php b/Diagnostic/RequiredFunctionsCheck.php
@@ -7,11 +7,13 @@
  * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
  *
  */
+
 namespace Piwik\Plugins\GoogleAnalyticsImporter\Diagnostic;
 
 use Piwik\Plugins\Diagnostics\Diagnostic\Diagnostic;
 use Piwik\Plugins\Diagnostics\Diagnostic\DiagnosticResult;
 use Piwik\Translation\Translator;
+
 class RequiredFunctionsCheck implements Diagnostic
 {
     /**

diff --git a/Exceptions/CloudApiQuotaExceeded.php b/Exceptions/CloudApiQuotaExceeded.php
@@ -3,6 +3,7 @@
 namespace Piwik\Plugins\GoogleAnalyticsImporter\Exceptions;
 
 use Piwik\Piwik;
+
 class CloudApiQuotaExceeded extends \RuntimeException
 {
     public function __construct($limit = 0)