Merge pull request #80 from innocraft/spice-psr

Adds test for PHPCS

.github/workflows/phpcs.yml

@@ -0,0 +1,43 @@
+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 init --name=matomo/invalidatereports --quiet;
+          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

Controller.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * InnoCraft - the company of the makers of Piwik Analytics, the free/libre analytics platform
  *

InvalidateReports.php

@@ -1,10 +1,12 @@
 <?php
+
 /**
  * InnoCraft - the company of the makers of Piwik Analytics, the free/libre analytics platform
  *
  * @link https://www.innocraft.com
  * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
  */
+
 namespace Piwik\Plugins\InvalidateReports;
 
 /**
@@ -55,4 +57,4 @@ public function getClientSideTranslationKeys(&$translationKeys)
         $translationKeys[] = 'InvalidateReports_ExamplesFunnels';
         $translationKeys[] = 'InvalidateReports_ExamplesRawData';
     }
-}
+}

Menu.php

@@ -1,10 +1,12 @@
 <?php
+
 /**
  * InnoCraft - the company of the makers of Piwik Analytics, the free/libre analytics platform
  *
  * @link https://www.innocraft.com
  * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
  */
+
 namespace Piwik\Plugins\InvalidateReports;
 
 use Piwik\Menu\MenuAdmin;
@@ -22,5 +24,4 @@ public function configureAdminMenu(MenuAdmin $menu)
             );
         }
     }
-
-}
+}

phpcs.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0"?>
+<ruleset name="invalidateReports" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="vendor/squizlabs/php_codesniffer/phpcs.xsd">
+
+    <description>Matomo Coding Standard for InvalidateReports plugin</description>
+
+    <arg name="extensions" value="php" />
+
+    <file>.</file>
+
+    <exclude-pattern>tests/javascript/*</exclude-pattern>
+    <exclude-pattern>*/vendor/*</exclude-pattern>
+
+    <rule ref="Matomo"></rule>
+
+    <rule ref="Generic.Files.LineLength">
+        <properties>
+            <property name="lineLimit" value="250" />
+        </properties>
+        <exclude-pattern>tests/*</exclude-pattern>
+    </rule>
+
+    <rule ref="Squiz.Classes.ValidClassName.NotCamelCaps">
+        <!-- Classnames for our update files don't match PascalCase, this can't be changed easily -->
+        <exclude-pattern>Updates/*</exclude-pattern>
+    </rule>
+
+    <rule ref="PSR1.Methods.CamelCapsMethodName.NotCamelCaps">
+        <!-- Allow using method name without camel caps in tests as long as some methods are named test_* -->
+        <exclude-pattern>tests/*</exclude-pattern>
+    </rule>
+
+    <rule ref="PSR1.Classes.ClassDeclaration.MultipleClasses">
+        <!-- Allow using multiple classes in one file for tests -->
+        <exclude-pattern>tests/*</exclude-pattern>
+    </rule>
+</ruleset>

tests/System/CheckDirectDependencyUseCommandTest.php

@@ -1,4 +1,5 @@
 <?php
+
 /**
  * Copyright (C) InnoCraft Ltd - All rights reserved.
  *
@@ -50,4 +51,4 @@ public function testCommand()
             ],
         ], $checkDirectDependencyUse->usesFoundList[$pluginName]);
     }
-}
+}