refactor: Rework the composer root version checker into a proper sub-project (#789)

This 3 files script have been quite annoying to write and they are now failing again. I think it's high time this is restructured a bit with some tests.

Author: theofidry

.gitattributes

@@ -3,10 +3,11 @@
 *.php text eol=lf
 
 # Ignore all test and documentation with "export-ignore".
-/.gitattributes     export-ignore
-/.gitignore         export-ignore
-/.styleci.yml       export-ignore
-/.travis.yml        export-ignore
-/.appveyor.yml      export-ignore
-/phpunit.xml.dist   export-ignore
-/tests              export-ignore
+/.gitattributes                  export-ignore
+/.gitignore                      export-ignore
+/.styleci.yml                    export-ignore
+/.travis.yml                     export-ignore
+/.appveyor.yml                   export-ignore
+/phpunit.xml.dist                export-ignore
+/composer-root-version-checker   export-ignore
+/tests                           export-ignore

.github/workflows/composer-root-version.yaml

@@ -0,0 +1,68 @@
+name: RootVersionChecker
+
+on:
+    push:
+        branches: [ main ]
+    pull_request:
+
+jobs:
+    cs-lint:
+        runs-on: ubuntu-latest
+        name: CS lint
+        strategy:
+            fail-fast: false
+            matrix:
+                php: [ '8.1' ]  # Should be the latest PHP version supported
+
+        steps:
+            -   name: Checkout
+                uses: actions/checkout@v3
+
+            -   name: Setup PHP
+                uses: shivammathur/setup-php@v2
+                with:
+                    php-version: "${{ matrix.php }}"
+                    tools: composer
+
+            -   name: Install PHP-CS-Fixer
+                uses: ramsey/composer-install@v2
+                with:
+                    working-directory: 'vendor-bin/php-cs-fixer'
+                    tools: composer
+
+            -   name: Ensures the makefile does not remake the PHP-CS-Fixer target
+                run: touch -c vendor-bin/php-cs-fixer/vendor/friendsofphp/php-cs-fixer/php-cs-fixer
+
+            -   name: Install the Composer dependencies
+                uses: ramsey/composer-install@v2
+                with:
+                    working-directory: 'composer-root-version-checker'
+
+            -   name: Lints CS
+                run: cd composer-root-version-checker; make cs_lint
+
+    tests:
+        runs-on: ubuntu-latest
+        name: Tests
+        strategy:
+            fail-fast: false
+            matrix:
+                php: [ '8.1' ]  # Should be the latest PHP version supported
+
+        steps:
+            -   name: Checkout
+                uses: actions/checkout@v3
+
+            -   name: Setup PHP
+                uses: shivammathur/setup-php@v2
+                with:
+                    php-version: "${{ matrix.php }}"
+                    tools: composer
+
+            -   name: Install the Composer dependencies
+                uses: ramsey/composer-install@v2
+                with:
+                    working-directory: 'composer-root-version-checker'
+
+            -   name: Runs the tests
+                run: cd composer-root-version-checker; make test

.github/workflows/tests.yaml

@@ -15,7 +15,7 @@ jobs:
         strategy:
             fail-fast: false
             matrix:
-                php: [ '8.1' ]
+                php: [ '8.1' ]  # Should be the latest PHP version supported
         steps:
             -   name: Checkout
                 uses: actions/checkout@v3
@@ -29,6 +29,11 @@ jobs:
                     tools: composer
                     coverage: none
 
+            -   name: Install Composer dependencies
+                uses: ramsey/composer-install@v2
+                with:
+                    working-directory: 'composer-root-version-checker'
+
             -   name: Check COMPOSER_ROOT_VERSION
                 run: make check_composer_root_version
 

.php-cs-fixer.dist.php

@@ -17,6 +17,9 @@
 
 $finder = Finder::create()
     ->in([
+        'composer-root-version-checker/bin',
+        'composer-root-version-checker/src',
+        'composer-root-version-checker/tests',
         'src',
         'tests',
     ])

.scrutinizer.yml

@@ -2,7 +2,7 @@ build:
     image: default-bionic
     environment:
         variables:
-            COMPOSER_ROOT_VERSION: '0.17.99'
+            COMPOSER_ROOT_VERSION: '0.18.0-rc.0'
 
     nodes:
         analysis:

Makefile

@@ -118,7 +118,7 @@ validate_package:
 .PHONY: check_composer_root_version
 check_composer_root_version: ## Checks that the COMPOSER_ROOT_VERSION is up to date
 check_composer_root_version: .composer-root-version
-	php bin/check-composer-root-version.php
+	cd composer-root-version-checker; $(MAKE) --makefile Makefile check_root_version
 
 .PHONY: covers_validator
 covers_validator:  ## Checks PHPUnit @coves tag

bin/check-composer-root-version.php

@@ -0,0 +1 @@
+/vendor/