intial commit

clxmstaab · clxmstaab · commit 82ffd0aded96 · 2021-08-04T14:47:44.000+02:00
diff --git a/.github/.kodiak.toml b/.github/.kodiak.toml
@@ -0,0 +1,19 @@
+# .kodiak.toml
+version = 1
+
+[merge]
+method = "squash"
+delete_branch_on_merge = true
+dont_wait_on_status_checks = ["WIP"] # handle github.com/apps/wip
+# label to use to enable Kodiak to merge a PR
+automerge_label = "automerge" # default: "automerge"
+# require that the automerge label be set for Kodiak to merge a PR. if you
+# disable this Kodiak will immediately attempt to merge every PR you create
+require_automerge_label = true
+
+[merge.message]
+title = "pull_request_title"
+body = "empty"
+include_coauthors = true
+include_pr_number = true
+strip_html_comments = true # remove html comments to auto remove PR templates
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -0,0 +1 @@
+github: [staabm]
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,15 @@
+# Dependabot config reference
+# https://help.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+    -   package-ecosystem: composer
+        directory: /
+        versioning-strategy: increase
+        schedule:
+            interval: weekly
+
+    -   package-ecosystem: github-actions
+        directory: /
+        schedule:
+            interval: weekly
diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml
@@ -0,0 +1,40 @@
+name: Static Analysis
+
+on:
+    push:
+        branches:
+            - main
+    pull_request:
+        types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+    phpstan:
+        name: phpstan static code analysis
+        runs-on: ${{ matrix.os }}
+
+        strategy:
+            matrix:
+                include:
+                    #-   os: ubuntu-18.04
+                    #    php-version: '7.2'
+                    -   os: ubuntu-latest
+                        php-version: '7.4'
+
+        steps:
+            -   name: Checkout
+                uses: actions/checkout@v2
+
+            -   name: Setup PHP
+                uses: shivammathur/setup-php@v2
+                with:
+                    php-version: ${{ matrix.php-version }}
+                    extensions: gd, intl, pdo_mysql
+                    coverage: none # disable xdebug, pcov
+
+            -   name: Composer install
+                uses: ramsey/composer-install@v1
+                with:
+                    composer-options: '--ansi --prefer-dist'
+
+            -   name: Run phpstan analysis
+                run: vendor/bin/phpstan analyse --ansi
diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml
@@ -0,0 +1,42 @@
+name: Unit tests
+
+on:
+    push:
+        branches:
+            - main
+    pull_request:
+        types: [opened, synchronize, reopened, ready_for_review]
+
+jobs:
+    phpunit:
+        runs-on: ${{ matrix.os }}
+
+        strategy:
+            matrix:
+                include:
+                    #-   os: ubuntu-18.04
+                    #    php-version: '7.2'
+                    -   os: ubuntu-latest
+                        php-version: '7.4'
+
+        steps:
+            -   name: Checkout
+                uses: actions/checkout@v2
+
+            -   name: Setup PHP
+                uses: shivammathur/setup-php@v2
+                with:
+                    php-version: ${{ matrix.php-version }}
+                    extensions: gd, intl, pdo_mysql
+                    coverage: none # disable xdebug, pcov
+
+            -   name: Composer install
+                uses: ramsey/composer-install@v1
+                with:
+                    composer-options: '--ansi --prefer-dist'
+
+            -   name: Setup Problem Matchers for PHPUnit
+                run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
+
+            -   name: Run phpunit
+                run: vendor/bin/phpunit --colors=always
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,4 @@
+/vendor/
+/tmp/
+/.phpunit.result.cache
+/composer.lock
diff --git a/README.md b/README.md
@@ -0,0 +1 @@
+Analyzes phpstan baseline files
diff --git a/bin/phpstan-baseline-analyze.php b/bin/phpstan-baseline-analyze.php
@@ -0,0 +1,19 @@
+#!/usr/bin/env php
+<?php
+
+// Finding composer
+
+$paths = [
+    __DIR__.'/../vendor/autoload.php',
+    __DIR__.'/../../../autoload.php',
+];
+
+foreach ($paths as $path) {
+    if (file_exists($path)) {
+        include $path;
+        break;
+    }
+}
+
+$app = new \staabm\PHPStanBaselineAnalysis\Application();
+$app->start($argv[1]);
diff --git a/composer.json b/composer.json
@@ -0,0 +1,33 @@
+{
+    "name": "staabm/phpstan-baseline-analysis",
+    "license": "MIT",
+    "autoload": {
+        "classmap": ["lib/"]
+    },
+    "autoload-dev": {
+        "classmap": [
+            "tests/"
+        ]
+    },
+    "require": {
+        "php": ">=7.4 || ^8.0",
+        "nette/neon": "^3.2",
+        "symfony/polyfill-php80": "^1.23"
+    },
+    "require-dev": {
+        "phpunit/phpunit": "^9.5",
+        "phpstan/phpstan": "^0.12",
+        "symfony/var-dumper": "^5.3"
+    },
+    "config": {
+        "optimize-autoloader": true,
+        "sort-packages": true
+    },
+    "scripts": {
+        "phpstan": "phpstan analyze",
+        "phpunit": "phpunit"
+    },
+    "bin": [
+        "bin/phpstan-baseline-analyze.php"
+    ]
+}
diff --git a/lib/AnalyzerResult.php b/lib/AnalyzerResult.php
@@ -0,0 +1,10 @@
+<?php
+
+namespace staabm\PHPStanBaselineAnalysis;
+
+final class AnalyzerResult {
+    /**
+     * @var int
+     */
+    public $overallComplexity = 0;
+}
diff --git a/lib/Application.php b/lib/Application.php
@@ -0,0 +1,22 @@
+<?php
+
+namespace staabm\PHPStanBaselineAnalysis;
+
+use Nette\Neon\Neon;
+
+final class Application {
+
+    public function start(string $glob)
+    {
+        $baselines = BaselineFinder::forGlob($glob);
+
+        foreach($baselines as $baseline) {
+            printf("Analyzing %s\n", $baseline->getFilePath());
+
+            $analyzer = new BaselineAnalyzer($baseline);
+            $result = $analyzer->analyze();
+
+            printf("  Overall-Complexity: %s\n", $result->overallComplexity);
+        }
+    }
+}
diff --git a/lib/Baseline.php b/lib/Baseline.php
@@ -0,0 +1,58 @@
+<?php
+
+namespace staabm\PHPStanBaselineAnalysis;
+
+use Nette\Neon\Neon;
+
+final class Baseline {
+    /**
+     * @var array
+     */
+    private $content;
+
+    /**
+     * @var string
+     */
+    private $filePath;
+
+    static public function forFile(string $filePath):self {
+
+        $content = file_get_contents($filePath);
+        $decoded = Neon::decode($content);
+
+        if (!is_array($decoded)) {
+            throw new \RuntimeException(sprintf('expecting baseline %s to be non-empty', $filePath));
+        }
+
+        $baseline = new self();
+        $baseline->content = $decoded;
+        $baseline->filePath = $filePath;
+        return $baseline;
+    }
+
+    /**
+     * @return Iterator<string>
+     */
+    public function getIgnoreErrors() {
+        if (!array_key_exists('parameters', $this->content)) {
+            throw new \RuntimeException('missing paramters from baseline');
+        }
+        $parameters = $this->content['parameters'];
+
+        if (!array_key_exists('ignoreErrors', $parameters)) {
+            throw new \RuntimeException('missing ignoreErrors from baseline');
+        }
+        $ignoreErrors = $parameters['ignoreErrors'];
+
+        /**
+         * @var array{message: string, count: int, path: string} $error
+         */
+        foreach($ignoreErrors as $error) {
+            yield $error['message'];
+        }
+    }
+
+    public function getFilePath():string {
+        return $this->filePath;
+    }
+}
diff --git a/lib/BaselineAnalyzer.php b/lib/BaselineAnalyzer.php
@@ -0,0 +1,27 @@
+<?php
+
+namespace staabm\PHPStanBaselineAnalysis;
+
+final class BaselineAnalyzer {
+    private $baseline;
+
+    public function __construct(Baseline $baseline) {
+        $this->baseline = $baseline;
+    }
+
+    public function analyze():AnalyzerResult {
+        $result = new AnalyzerResult();
+
+        foreach($this->baseline->getIgnoreErrors() as $errorMessage) {
+            if (!str_contains($errorMessage, 'cognitive complexity')) {
+                continue;
+            }
+
+            preg_match('/Class cognitive complexity is (?P<value>\d+), keep it under (?P<limit>\d+)/', $errorMessage, $matches);
+
+            $result->overallComplexity += $matches['value'];
+        }
+
+        return $result;
+    }
+}
diff --git a/lib/BaselineFinder.php b/lib/BaselineFinder.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace staabm\PHPStanBaselineAnalysis;
+
+use Nette\Neon\Neon;
+
+final class BaselineFinder
+{
+    /**
+     * @return Baseline[]
+     */
+    static public function forGlob(string $glob):array
+    {
+        $baselines = [];
+
+        foreach (glob($glob) as $baseline) {
+            if (!is_file($baseline)) {
+                continue;
+            }
+
+            if (!str_ends_with($baseline, '.neon')) {
+                continue;
+            }
+
+            $baselines[] = Baseline::forFile($baseline);
+        }
+
+        return $baselines;
+    }
+}
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -0,0 +1,5 @@
+parameters:
+    level: max
+    
+    paths:
+        - lib/
diff --git a/phpunit.xml b/phpunit.xml
@@ -0,0 +1,17 @@
+<?xml version="1.0"?>
+<phpunit
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.5/phpunit.xsd"
+        bootstrap="tests/bootstrap.php"
+        colors="true"
+>
+    <testsuites>
+        <testsuite name="main">
+            <directory>tests</directory>
+        </testsuite>
+    </testsuites>
+
+    <php>
+        <ini name="memory_limit" value="-1" />
+    </php>
+</phpunit>
diff --git a/tests/BaselineAnalyzerTest.php b/tests/BaselineAnalyzerTest.php
@@ -0,0 +1,19 @@
+<?php
+
+namespace staabm\PHPStanBaselineAnalysis\Tests;
+
+use PHPUnit\Framework\TestCase;
+use staabm\PHPStanBaselineAnalysis\Baseline;
+use staabm\PHPStanBaselineAnalysis\BaselineAnalyzer;
+
+class BaselineAnalyzerTest extends TestCase
+{
+    function testClassComplexity()
+    {
+        $analyzer = new BaselineAnalyzer(Baseline::forFile(__DIR__ . '/fixtures/class-complexity.neon'));
+        $result = $analyzer->analyze();
+
+        $this->assertSame(26, $result->overallComplexity);
+    }
+
+}
diff --git a/tests/bootstrap.php b/tests/bootstrap.php
@@ -0,0 +1,3 @@
+<?php
+
+require_once __DIR__ . '/../vendor/autoload.php';
diff --git a/tests/fixtures/all-in.neon b/tests/fixtures/all-in.neon
diff --git a/tests/fixtures/class-complexity.neon b/tests/fixtures/class-complexity.neon
diff --git a/tests/fixtures/method-complexity.neon b/tests/fixtures/method-complexity.neon
