Version 2.0.0

CONTRIBUTING.md → .github/CONTRIBUTING.md

@@ -44,7 +44,7 @@ This project uses [the PSR-2 coding standards](http://www.php-fig.org/psr/psr-2/
 [PHPUnit](https://phpunit.de/) is included as a development dependency, and should be run regularly. When submitting changes, please be sure to add or update unit tests accordingly. You may run unit tests at any time by running:
 
 ```bash
-$ ./vendor/bin/phpunit
+$ composer test
 ```
 
 #### Code coverage

.github/workflows/code-coverage.yml

@@ -0,0 +1,35 @@
+name: Code Coverage
+
+on:
+  pull_request:
+  push:
+    branches:
+      - develop
+      - main
+
+jobs:
+  coverage:
+    name: Report code coverage
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.2'
+          coverage: xdebug
+
+      - name: Install Composer dependencies
+        uses: ramsey/composer-install@v2
+
+      - name: Run test suite
+        run: vendor/bin/simple-phpunit --coverage-text --coverage-clover=tests/coverage
+
+      - name: Publish to Coveralls
+        uses: coverallsapp/github-action@v2
+        with:
+          files: tests/coverage
+          format: clover
+          fail-on-error: false

.github/workflows/coding-standards.yml

@@ -0,0 +1,23 @@
+name: Coding Standards
+
+on: [pull_request]
+
+jobs:
+  phpcs:
+    name: PHP_CodeSniffer
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.2'
+          coverage: none
+
+      - name: Install Composer dependencies
+        uses: ramsey/composer-install@v2
+
+      - name: Run test suite
+        run: composer coding-standards

.github/workflows/static-code-analysis.yml

@@ -0,0 +1,28 @@
+name: Static Code Analysis
+
+on: [pull_request]
+
+jobs:
+  phpcs:
+    name: PHPStan
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.2'
+          coverage: none
+
+      - name: Install Composer dependencies
+        uses: ramsey/composer-install@v2
+
+      # PHPUnit Bridge won't install a version of PHPUnit by default, but this will trick
+      # it into doing so.
+      - name: Install PHPUnit
+        run: composer test -- --version
+
+      - name: Run PHPStan
+        run: composer static-analysis

.github/workflows/unit-tests.yml

@@ -8,17 +8,20 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php-version: ['5.6', '7.0', '7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2']
+        php-version: ['7.1', '7.2', '7.3', '7.4', '8.0', '8.1', '8.2', '8.3', '8.4']
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-version }}
           coverage: none
 
+      - name: Remove PHPStan as a dependency
+        run: composer remove --dev phpstan/phpstan
+
       - name: Install Composer dependencies
         uses: ramsey/composer-install@v2
 

.gitignore

@@ -1,7 +1,11 @@
-tests/coverage
-vendor
+*.DS_Store
 .phpunit.result.cache
 .vscode
+phpcs.xml
+phpstan.neon
+phpunit.xml
+tests/coverage
+vendor
 
 # The composer.lock file is not needed, as this is a library whose dependencies
 # will depend on the version of PHP being used.

.phpcs.xml.dist

@@ -0,0 +1,24 @@
+<?xml version="1.0"?>
+<ruleset name="Custom ruleset">
+    <description>Coding standards for PHPUnit Markup Assertions</description>
+
+    <!-- Show progress and sniff codes in all reports -->
+	<arg value="ps"/>
+
+    <!-- Check all PHP files in directory tree by default. -->
+	<arg name="extensions" value="php"/>
+	<file>.</file>
+    <exclude-pattern>*/vendor/*</exclude-pattern>
+
+    <!-- Default to PSR-12 for coding standards-->
+    <rule ref="PSR12"/>
+
+    <!-- The tests/ directory may use snake_case for test methods -->
+    <rule ref="PSR1.Methods.CamelCapsMethodName.NotCamelCaps">
+        <exclude-pattern>tests/*</exclude-pattern>
+    </rule>
+
+    <!-- Ensure we're compatible with PHP 7.1+ -->
+    <rule ref="PHPCompatibility"/>
+    <config name="testVersion" value="7.1-"/>
+</ruleset>

README.md

@@ -1,7 +1,8 @@
 # PHPUnit Markup Assertions
 
 ![Build Status](https://github.com/stevegrunwell/phpunit-markup-assertions/workflows/Unit%20Tests/badge.svg)
-[![GitHub release](https://img.shields.io/github/release/stevegrunwell/phpunit-markup-assertions.svg)](https://github.com/stevegrunwell/phpunit-markup-assertions/releases)
+[![Code Coverage](https://coveralls.io/repos/github/stevegrunwell/phpunit-markup-assertions/badge.svg?branch=develop)](https://coveralls.io/github/stevegrunwell/phpunit-markup-assertions?branch=develop)
+[![GitHub Release](https://img.shields.io/github/release/stevegrunwell/phpunit-markup-assertions.svg)](https://github.com/stevegrunwell/phpunit-markup-assertions/releases)
 
 This library introduces the `MarkupAssertionsTrait` trait for use in [PHPUnit](https://phpunit.de) tests.
 

composer.json

@@ -15,11 +15,16 @@
         "source": "https://github.com/stevegrunwell/phpunit-markup-assertions/"
     },
     "require": {
-        "php": "^5.6 || ^7.0 || ^8.0",
-        "laminas/laminas-dom": "~2.7.2 || ^2.8"
+        "php": "^7.1 || ^8.0",
+        "symfony/css-selector": "^4.4|^5.4|^6.0|^7.0",
+        "symfony/dom-crawler": "^4.4|^5.4|^6.0|^7.0"
     },
     "require-dev": {
-        "symfony/phpunit-bridge": "^5.2 || ^6.2"
+        "dealerdirect/phpcodesniffer-composer-installer": "^1.0",
+        "phpcompatibility/php-compatibility": "^9.3",
+        "phpstan/phpstan": "^2.1",
+        "squizlabs/php_codesniffer": "^3.7",
+        "symfony/phpunit-bridge": "^5.2 || ^6.2 || ^7.0"
     },
     "autoload": {
         "psr-4": {
@@ -32,19 +37,38 @@
         }
     },
     "scripts": {
+        "coding-standards": [
+            "phpcs"
+        ],
+        "static-analysis": [
+            "phpstan analyse"
+        ],
         "test": [
             "simple-phpunit --testdox"
         ],
         "test-coverage": [
-            "phpdbg -qrr -d memory_limit=-1 ./vendor/bin/simple-phpunit --coverage-html=tests/coverage --colors=always"
+            "XDEBUG_MODE=coverage ./vendor/bin/simple-phpunit --coverage-html=tests/coverage --colors=always"
         ]
     },
     "scripts-descriptions": {
+        "coding-standards": "Check coding standards.",
+        "static-analysis": "Run static code analysis",
         "test": "Run all test suites.",
         "test-coverage": "Generate code coverage reports in tests/coverage."
     },
     "config": {
         "preferred-install": "dist",
-        "sort-packages": true
+        "sort-packages": true,
+        "allow-plugins": {
+            "dealerdirect/phpcodesniffer-composer-installer": true
+        }
+    },
+    "archive": {
+        "exclude": [
+            "_config.yml",
+            ".*",
+            "phpunit.*",
+            "tests"
+        ]
     }
 }

phpstan.neon.dist

@@ -0,0 +1,15 @@
+parameters:
+	level: 10
+
+	# Code to be analyzed
+	paths:
+		- src
+		- tests
+
+	# Don't worry about the coverage reports
+	excludePaths:
+		- tests/coverage (?)
+
+	# PHPUnit Bridge puts the PHPUnit source in an unconventional location
+	scanDirectories:
+		- vendor/bin/.phpunit/phpunit