Update tools and use make to run them

nucleos · Dec 6, 2021 · ecd0724 · ecd0724
1 parent 496ebc6
commit ecd0724
Show file tree

Hide file tree

Showing 10 changed files with 509 additions and 893 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -3,8 +3,8 @@ infection.json          export-ignore
 Makefile                export-ignore
 phpstan.neon.dist       export-ignore
 phpstan-baseline.neon   export-ignore
-phpunit.xml.dist        export-ignore
 psalm-baseline.xml      export-ignore
 psalm.xml               export-ignore
+phpunit.xml.dist        export-ignore
 /tests                  export-ignore
 /vendor-bin             export-ignore
diff --git a/.github/workflows/continuous-integration.yml b/.github/workflows/continuous-integration.yml
@@ -18,11 +18,11 @@ jobs:
     strategy:
       matrix:
         php-version:
-          - 8.0
+          - 8.1
 
     steps:
       - name: "Checkout"
-        uses: actions/checkout@v2.3.4
+        uses: actions/checkout@v2.4.0
 
       - name: "Install PHP with extensions"
         uses: shivammathur/setup-php@2.16.0
@@ -31,9 +31,6 @@ jobs:
           extensions: "mbstring, json"
           php-version: ${{ matrix.php-version }}
 
-      - name: "Validate composer.json and composer.lock"
-        run: composer validate --strict
-
       - name: "Cache dependencies installed with composer"
         uses: actions/cache@v2.1.7
         with:
@@ -45,8 +42,8 @@ jobs:
       - name: "Install locked dependencies with composer"
         run: composer install --no-interaction --no-progress --no-suggest
 
-      - name: "Run localheinz/composer-normalize"
-        run: composer normalize --dry-run
+      - name: "Run composer lint"
+        run: make lint-composer
 
       - name: "Create cache directory for friendsofphp/php-cs-fixer"
         run: mkdir -p .build/php-cs-fixer
@@ -60,7 +57,9 @@ jobs:
             php${{ matrix.php-version }}-php-cs-fixer-
 
       - name: "Run friendsofphp/php-cs-fixer"
-        run: composer cs-diff
+        env:
+            PHP_CS_FIXER_IGNORE_ENV: 1
+        run: make cs
 
   static-code-analysis:
     name: "Static Code Analysis"
@@ -74,7 +73,7 @@ jobs:
 
     steps:
       - name: "Checkout"
-        uses: actions/checkout@v2.3.4
+        uses: actions/checkout@v2.4.0
 
       - name: "Install PHP with extensions"
         uses: shivammathur/setup-php@2.16.0
@@ -95,13 +94,13 @@ jobs:
         run: composer install --no-interaction --no-progress --no-suggest
 
       - name: "Run phpstan/phpstan"
-        run: composer phpstan
+        run: make phpstan
 
       - name: "Run psalm"
-        run: vendor/bin/psalm --config=psalm.xml --diff --shepherd --show-info=false --stats --threads=4
+        run: make psalm
 
       - name: "Run phpmd"
-        run: composer phpmd
+        run: make phpmd
 
   tests:
     name: "Test (PHP ${{ matrix.php-version }}, ${{ matrix.dependencies }})"
@@ -120,7 +119,7 @@ jobs:
 
     steps:
       - name: "Checkout"
-        uses: actions/checkout@v2.3.4
+        uses: actions/checkout@v2.4.0
 
       - name: "Install PHP with extensions"
         uses: shivammathur/setup-php@2.16.0
@@ -146,7 +145,7 @@ jobs:
         run: composer update --no-interaction --no-progress --no-suggest
 
       - name: "Run tests with phpunit/phpunit"
-        run: composer test
+        run: make test
 
   code-coverage:
     name: "Code Coverage"
@@ -160,7 +159,7 @@ jobs:
 
     steps:
       - name: "Checkout"
-        uses: actions/checkout@v2.3.4
+        uses: actions/checkout@v2.4.0
 
       - name: "Install PHP with extensions"
         uses: shivammathur/setup-php@2.16.0
@@ -181,7 +180,7 @@ jobs:
         run: composer install --no-interaction --no-progress --no-suggest
 
       - name: "Collect code coverage with pcov and phpunit/phpunit"
-        run: composer coverage
+        run: make coverage
 
       - name: "Send code coverage report to Codecov.io"
         env:
@@ -196,17 +195,17 @@ jobs:
     strategy:
       matrix:
         php-version:
-          - 8.1
+          - 8.0
 
     steps:
       - name: "Checkout"
-        uses: actions/checkout@v2.3.4
+        uses: actions/checkout@v2.4.0
 
       - name: "Install PHP with extensions"
         uses: shivammathur/setup-php@2.16.0
         with:
           coverage: pcov
-          extensions: "mbstring"
+          extensions: "mbstring, json"
           php-version: ${{ matrix.php-version }}
 
       - name: "Cache dependencies installed with composer"
@@ -220,8 +219,5 @@ jobs:
       - name: "Install locked dependencies with composer"
         run: composer install --no-interaction --no-progress --no-suggest
 
-      - name: "Download infection"
-        run: wget -O infection https://github.com/infection/infection/releases/download/0.19.0/infection.phar && chmod +x infection
-
       - name: "Run mutation tests with pcov and infection/infection"
-        run: ./infection
+        run: make infection
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
-.php_cs.cache
+.php-cs-fixer.cache
+.php-cs-fixer.php
 .phpunit.result.cache
 coverage
 composer.lock
@@ -7,3 +8,4 @@ phpunit.xml
 /vendor/
 !/vendor-bin/tools/composer.lock
 /vendor-bin/tools/vendor/
+/vendor-bin/tools/bin/
diff --git a/.php_cs.dist → .php-cs-fixer.dist.php b/.php_cs.dist → .php-cs-fixer.dist.php
@@ -11,7 +11,7 @@
     ->in([ __DIR__.'/src',  __DIR__.'/tests'])
 ;
 
-$config = PhpCsFixer\Config::create()
+$config = (new PhpCsFixer\Config())
     ->setRiskyAllowed(true)
     ->setRules([
         '@Symfony' => true,
@@ -35,7 +35,10 @@
         ],
         'php_unit_internal_class' => false,
         'php_unit_test_class_requires_covers' => false,
-        'no_superfluous_phpdoc_tags' => true,
+        'no_superfluous_phpdoc_tags' => [
+            'allow_mixed' => true,
+            'remove_inheritdoc' => true,
+        ],
         'static_lambda' => true,
         'global_namespace_import' => [
            'import_classes' => true,

diff --git a/Makefile b/Makefile
@@ -0,0 +1,64 @@
+.PHONY: default
+default: lint
+
+.PHONY: fix
+fix: cs-fix lint-fix
+
+.PHONY: lint
+lint: lint-composer
+
+.PHONY: lint-composer
+lint-composer:
+	composer validate --strict
+	composer normalize --dry-run
+
+.PHONY: test
+test: vendor-bin/tools/vendor
+	vendor/bin/phpunit --colors=always
+
+.PHONY: infection
+infection: vendor/bin/infection
+	vendor/bin/infection --threads=4
+
+.PHONY: coverage
+coverage: vendor-bin/tools/vendor
+	vendor/bin/phpunit --colors=always --coverage-clover=build/logs/clover.xml
+
+.PHONY: cs
+cs: vendor-bin/tools/vendor
+	vendor/bin/php-cs-fixer fix  --verbose --diff --dry-run
+
+.PHONY: cs-fix
+cs-fix: vendor-bin/tools/vendor
+	vendor/bin/php-cs-fixer fix --verbose
+
+.PHONY: psalm
+psalm: vendor-bin/tools/vendor
+	vendor/bin/psalm --config=psalm.xml --diff --shepherd --show-info=false --stats --threads=4
+
+.PHONY: phpstan
+phpstan: vendor-bin/tools/vendor
+	vendor/bin/phpstan analyse
+
+.PHONY: phpmd
+phpmd: vendor-bin/tools/vendor
+	vendor/bin/phpmd src,tests ansi phpmd.xml
+
+.PHONY: lint-fix
+lint-fix:
+	find ./src \\( -name '*.xml' -or -name '*.xml.dist' -or -name '*.xlf' \\) -type f -exec xmllint --encode UTF-8 --output '{}' --format '{}' \\;
+	find ./src \\( -name '*.yml' -or -name '*.yaml' \\) -not -path '*/vendor/*' | xargs yaml-lint
+
+.PHONY: check-dependencies
+check-dependencies: vendor-bin/tools/vendor
+	vendor/bin/composer-require-checker check --config-file composer-require.json composer.json
+
+#
+# Installation tasks
+#
+
+vendor-bin/tools/vendor:
+	composer --working-dir=vendor-bin/tools install
+
+vendor/bin/infection: vendor-bin/tools/vendor
+	wget -O vendor/bin/infection https://github.com/infection/infection/releases/latest/download/infection.phar && chmod +x vendor/bin/infection
diff --git a/composer.json b/composer.json
@@ -1,22 +1,40 @@
 {
     "name": "nucleos/lastfm",
-    "type": "library",
     "description": "Last.fm webservice client for php.",
+    "license": "MIT",
+    "type": "library",
     "keywords": [
         "last.fm",
         "api",
         "crawler",
         "spider",
         "webservice client"
     ],
-    "homepage": "https://nucleos.rocks",
-    "license": "MIT",
     "authors": [
         {
             "name": "Christian Gripp",
             "email": "mail@core23.de"
         }
     ],
+    "homepage": "https://nucleos.rocks",
+    "funding": [
+        {
+            "type": "github",
+            "url": "https://github.com/sponsors/core23"
+        },
+        {
+            "type": "opencollective",
+            "url": "https://opencollective.com/core23"
+        },
+        {
+            "type": "ko-fi",
+            "url": "https://ko-fi.com/core23"
+        },
+        {
+            "type": "other",
+            "url": "https://donate.core23.de"
+        }
+    ],
     "require": {
         "php": "^8.0",
         "ext-json": "*",
@@ -38,9 +56,6 @@
     "suggest": {
         "symfony/http-client": "Symfony HTTP client implementation"
     },
-    "config": {
-        "sort-packages": true
-    },
     "autoload": {
         "psr-4": {
             "Nucleos\\LastFm\\": "src/"
@@ -51,43 +66,15 @@
             "Nucleos\\LastFm\\Tests\\": "tests/"
         }
     },
+    "config": {
+        "sort-packages": true
+    },
     "scripts": {
         "post-install-cmd": [
             "@composer bin all install --ansi"
         ],
         "post-update-cmd": [
             "@composer bin all install --ansi"
-        ],
-        "coverage": "vendor/bin/phpunit --colors=always --coverage-clover=build/logs/clover.xml",
-        "cs": "PHP_CS_FIXER_IGNORE_ENV=1 && vendor/bin/php-cs-fixer fix --verbose",
-        "cs-diff": "PHP_CS_FIXER_IGNORE_ENV=1 && vendor/bin/php-cs-fixer fix  --verbose --diff --diff-format=udiff --dry-run",
-        "deps": "vendor/bin/composer-require-checker check --config-file composer-require.json composer.json",
-        "infection": "vendor/bin/infection",
-        "lint": [
-            "find ./src \\( -name '*.xml' -or -name '*.xml.dist' -or -name '*.xlf' \\) -type f -exec xmllint --encode UTF-8 --output '{}' --format '{}' \\;",
-            "find ./src \\( -name '*.yml' -or -name '*.yaml' \\) -not -path '*/vendor/*' | xargs yaml-lint"
-        ],
-        "phpmd": "vendor/bin/phpmd src,tests ansi phpmd.xml",
-        "phpstan": "vendor/bin/phpstan analyse",
-        "psalm": "vendor/bin/psalm --config=psalm.xml --diff --diff-methods --show-info=false --stats --threads=4",
-        "test": "vendor/bin/phpunit --colors=always"
-    },
-    "funding": [
-        {
-            "type": "github",
-            "url": "https://github.com/sponsors/core23"
-        },
-        {
-            "type": "opencollective",
-            "url": "https://opencollective.com/core23"
-        },
-        {
-            "type": "ko-fi",
-            "url": "https://ko-fi.com/core23"
-        },
-        {
-            "type": "other",
-            "url": "https://donate.core23.de"
-        }
-    ]
+        ]
+    }
 }
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -265,31 +265,16 @@ parameters:
 			count: 1
 			path: src/Crawler/AbstractCrawler.php
 
-		-
-			message: "#^Anonymous function should have native return typehint \"int\"\\.$#"
-			count: 1
-			path: src/Crawler/ArtistEventCrawler.php
-
 		-
 			message: "#^Short ternary operator is not allowed\\. Use null coalesce operator if applicable or consider using long ternary\\.$#"
 			count: 1
 			path: src/Crawler/ArtistEventCrawler.php
 
-		-
-			message: "#^Anonymous function should have native return typehint \"void\"\\.$#"
-			count: 1
-			path: src/Crawler/EventListCrawler.php
-
 		-
 			message: "#^Method Nucleos\\\\LastFm\\\\Crawler\\\\EventListCrawler\\:\\:crawlEventListGroup\\(\\) return type has no value type specified in iterable type array\\.$#"
 			count: 1
 			path: src/Crawler/EventListCrawler.php
 
-		-
-			message: "#^Anonymous function should have native return typehint \"int\"\\.$#"
-			count: 1
-			path: src/Crawler/UserEventCrawler.php
-
 		-
 			message: "#^Short ternary operator is not allowed\\. Use null coalesce operator if applicable or consider using long ternary\\.$#"
 			count: 1

diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -2,14 +2,11 @@ includes:
     - phpstan-baseline.neon
 
 parameters:
-    level: max
+    level: 8
 
     paths:
         - src
         - tests
 
     bootstrapFiles:
         - vendor-bin/tools/vendor/autoload.php
-
-    excludes_analyse:
-        - tests/bootstrap.php