Add Code Analysis and Code Style validation (#5)

Automattic · Jun 21, 2023 · cefcf39 · cefcf39
1 parent 534c66f
commit cefcf39
Show file tree

Hide file tree

Showing 22 changed files with 308 additions and 76 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,8 @@
+/.*                   export-ignore
+/Makefile             export-ignore
+/*.dist               export-ignore
+/*.dist.*             export-ignore
+/tests                export-ignore
+
+# Test with:
+# git archive --format=tar HEAD | tar t
diff --git a/.github/workflows/ca.yml b/.github/workflows/ca.yml
@@ -0,0 +1,47 @@
+# yamllint disable rule:line-length
+# yamllint disable rule:braces
+
+name: Code Analysis
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Static code analysis with PHP ${{ matrix.php-version }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        php-version:
+          - "7.4"
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          coverage: none
+
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v3
+        with:
+          path: vendor
+          key: composer-${{ matrix.php-version }}-${{ hashFiles('composer.*') }}
+          restore-keys: |
+            composer-${{ matrix.php-version }}-
+            composer-
+
+      - name: Install dependencies
+        run: |
+          composer install --prefer-dist --no-progress
+
+      - name: Run Psalm
+        run: |
+          php vendor/bin/psalm --output-format=github --long-progress --php-version=${{ matrix.php-version }}
diff --git a/.github/workflows/cs.yml b/.github/workflows/cs.yml
@@ -0,0 +1,65 @@
+# yamllint disable rule:line-length
+# yamllint disable rule:braces
+
+name: Code Style
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Code style with PHP ${{ matrix.php-version }}
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        php-version:
+          - "7.4"
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          coverage: none
+
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v3
+        with:
+          path: vendor
+          key: composer-${{ matrix.php-version }}-${{ hashFiles('composer.*') }}
+          restore-keys: |
+            composer-${{ matrix.php-version }}-
+            composer-
+
+      - name: Install dependencies
+        run: |
+          composer install --prefer-dist --no-progress
+
+      - name: Validate composer.json
+        run: |
+          composer validate --strict
+
+      - name: Normalize composer.json
+        run: |
+          composer normalize --dry-run --diff
+
+      - name: Restore PHP-CS-Fixer cache
+        uses: actions/cache@v3
+        with:
+          path: build/cache/.php_cs.cache
+          key: php-cs-fixer-${{ matrix.php-version }}-${{ hashFiles('composer.*') }}
+          restore-keys: |
+            php-cs-fixer-${{ matrix.php-version }}-
+            php-cs-fixer-
+
+      - name: Run PHP-CS-Fixer
+        run: |
+          mkdir -p build/cache/
+          vendor/bin/php-cs-fixer fix --diff --dry-run --verbose --cache-file=build/cache/.php_cs.cache
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -7,7 +7,6 @@ on:
   push:
     branches:
       - main
-      - v*.*
 
 jobs:
   tests:

diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -0,0 +1,72 @@
+<?php declare(strict_types=1);
+/**
+ * The Sliding Window Counter, a short-lived time series library.
+ * Copyright 2023 Automattic, Inc.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+$header = <<<'EOF'
+The Sliding Window Counter, a short-lived time series library.
+Copyright 2023 Automattic, Inc.
+
+This program is free software; you can redistribute it and/or
+modify it under the terms of the GNU General Public License
+as published by the Free Software Foundation; either version 2
+of the License, or (at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along
+with this program; if not, write to the Free Software Foundation, Inc.,
+51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+EOF;
+
+$config = new PhpCsFixer\Config();
+$config
+    ->setRiskyAllowed(true)
+    ->setRules([
+        'header_comment' => [
+            'comment_type' => 'PHPDoc',
+            'header' => $header,
+            'separate' => 'bottom',
+            'location' => 'after_declare_strict',
+        ],
+        '@PER-CS1.0' => true,
+        'array_indentation' => true,
+        'native_function_invocation' => [
+            'include' => ['@internal'],
+            'scope' => 'namespaced',
+        ],
+        'global_namespace_import' => [
+            'import_classes' => true,
+            'import_constants' => true,
+            'import_functions' => true,
+        ],
+        'declare_equal_normalize' => ['space' => 'none'],
+        'blank_line_after_opening_tag' => false,
+        'linebreak_after_opening_tag' => false,
+    ])
+    ->setFinder(
+        PhpCsFixer\Finder::create()
+            ->in(__DIR__)
+            ->append([__FILE__])
+    )
+;
+
+return $config;
diff --git a/example.php b/example.php
@@ -17,6 +17,24 @@
  */
 
 declare(strict_types=1);
+/**
+ * The Sliding Window Counter, a short-lived time series library.
+ * Copyright 2023 Automattic, Inc.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
 
 require 'vendor/autoload.php';
 

diff --git a/psalm.xml.dist b/psalm.xml.dist
@@ -0,0 +1,16 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="2"
+    resolveFromConfigFile="true"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="src" />
+        <file name="example.php" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+</psalm>
diff --git a/src/AnomalyDetectionResult.php b/src/AnomalyDetectionResult.php
@@ -1,5 +1,6 @@
-<?php
+<?php declare(strict_types=1);
 /**
+ * The Sliding Window Counter, a short-lived time series library.
  * Copyright 2023 Automattic, Inc.
  *
  * This program is free software; you can redistribute it and/or
@@ -12,12 +13,11 @@
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
-declare(strict_types=1);
-
 namespace Automattic\SlidingWindowCounter;
 
 use function abs;

diff --git a/src/Cache/CounterCache.php b/src/Cache/CounterCache.php
@@ -1,5 +1,6 @@
-<?php
+<?php declare(strict_types=1);
 /**
+ * The Sliding Window Counter, a short-lived time series library.
  * Copyright 2023 Automattic, Inc.
  *
  * This program is free software; you can redistribute it and/or
@@ -12,12 +13,11 @@
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
-declare(strict_types=1);
-
 namespace Automattic\SlidingWindowCounter\Cache;
 
 interface CounterCache

diff --git a/src/Cache/MemcachedAdapter.php b/src/Cache/MemcachedAdapter.php
@@ -1,5 +1,6 @@
-<?php
+<?php declare(strict_types=1);
 /**
+ * The Sliding Window Counter, a short-lived time series library.
  * Copyright 2023 Automattic, Inc.
  *
  * This program is free software; you can redistribute it and/or
@@ -12,15 +13,15 @@
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
-declare(strict_types=1);
-
 namespace Automattic\SlidingWindowCounter\Cache;
 
 use Memcached;
+
 use function implode;
 use function is_int;
 

diff --git a/src/Cache/WPCacheAdapter.php b/src/Cache/WPCacheAdapter.php
@@ -1,5 +1,6 @@
-<?php
+<?php declare(strict_types=1);
 /**
+ * The Sliding Window Counter, a short-lived time series library.
  * Copyright 2023 Automattic, Inc.
  *
  * This program is free software; you can redistribute it and/or
@@ -12,15 +13,15 @@
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
-declare(strict_types=1);
-
 namespace Automattic\SlidingWindowCounter\Cache;
 
 use WP_Object_Cache;
+
 use function is_int;
 
 /**

diff --git a/src/Helper/Frame.php b/src/Helper/Frame.php
@@ -1,5 +1,6 @@
-<?php
+<?php declare(strict_types=1);
 /**
+ * The Sliding Window Counter, a short-lived time series library.
  * Copyright 2023 Automattic, Inc.
  *
  * This program is free software; you can redistribute it and/or
@@ -12,12 +13,11 @@
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; If not, see <http://www.gnu.org/licenses/>.
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  */
 
-declare(strict_types=1);
-
 namespace Automattic\SlidingWindowCounter\Helper;
 
 use function implode;