Refactor for SSP 2.5.x

.github/workflows/php.yml

@@ -0,0 +1,234 @@
+---
+
+name: CI
+
+on:  # yamllint disable-line rule:truthy
+  push:
+    branches: ['**']
+    paths-ignore:
+      - '**.md'
+  pull_request:
+    branches: [master, main, release-*]
+    paths-ignore:
+      - '**.md'
+  workflow_dispatch:
+
+jobs:
+  phplinter:
+    name: 'PHP-Linter'
+    strategy:
+      fail-fast: false
+      matrix:
+        php-version: ['8.3', '8.4', '8.5']
+
+    uses: simplesamlphp/simplesamlphp-test-framework/.github/workflows/reusable_phplinter.yml@v1.11.3
+    with:
+      php-version: ${{ matrix.php-version }}
+
+  linter:
+    name: 'Linter'
+    strategy:
+      fail-fast: false
+
+    uses: simplesamlphp/simplesamlphp-test-framework/.github/workflows/reusable_linter.yml@v1.11.3
+    with:
+      enable_eslinter: false
+      enable_jsonlinter: true
+      enable_stylelinter: false
+      enable_yamllinter: true
+
+  unit-tests-linux:
+    name: "Unit tests, PHP ${{ matrix.php-versions }}, ${{ matrix.operating-system }}"
+    runs-on: ${{ matrix.operating-system }}
+    needs: [phplinter, linter]
+
+    strategy:
+      fail-fast: false
+      matrix:
+        operating-system: [ubuntu-latest]
+        php-versions: ['8.3', '8.4', '8.5']
+
+    steps:
+      - name: Setup PHP, with composer and extensions
+        # https://github.com/shivammathur/setup-php
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+          extensions: >
+            ctype, date, dom, fileinfo, filter, hash, intl, mbstring,
+            openssl, pcre, posix, sodium, spl, xdebug, xml
+          tools: composer
+          ini-values: error_reporting=E_ALL, pcov.directory=.
+          coverage: pcov
+
+      - name: Setup problem matchers for PHP
+        run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+
+      - name: Setup problem matchers for PHPUnit
+        run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
+
+      - name: Set git to use LF
+        run: |
+          git config --global core.autocrlf false
+          git config --global core.eol lf
+
+      - uses: actions/checkout@v6
+
+      - name: Get composer cache directory
+        run: echo COMPOSER_CACHE="$(composer config cache-files-dir)" >> "$GITHUB_ENV"
+
+      - name: Cache composer dependencies
+        uses: actions/cache@v5
+        with:
+          path: ${{ env.COMPOSER_CACHE }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install Composer dependencies
+        run: composer install --no-progress --prefer-dist --optimize-autoloader
+
+      - name: Run unit tests with coverage
+        if: ${{ matrix.php-versions == '8.5' }}
+        run: vendor/bin/phpunit --exclude-group=skipOnGithub
+
+      - name: Run unit tests (no coverage)
+        if: ${{ matrix.php-versions != '8.5' }}
+        run: vendor/bin/phpunit --exclude-group=skipOnGithub --no-coverage
+
+      - name: Save coverage data
+        if: ${{ matrix.php-versions == '8.5' }}
+        uses: actions/upload-artifact@v7
+        with:
+          name: coverage-data
+          path: ${{ github.workspace }}/build
+
+  quality:
+    name: Quality control
+    runs-on: [ubuntu-latest]
+    # needs: [unit-tests-linux]
+
+    steps:
+      - name: Setup PHP, with composer and extensions
+        id: setup-php
+        # https://github.com/shivammathur/setup-php
+        uses: shivammathur/setup-php@v2
+        with:
+          # Should be the higest supported version, so we can use the newest tools
+          php-version: '8.5'
+          tools: composer, composer-require-checker, composer-unused, phpcs, phpstan
+          extensions: >
+            ctype, date, dom, fileinfo, filter, hash, intl, mbstring,
+            opcache, openssl, pcre, posix, sodium, spl, xml
+
+      - name: Setup problem matchers for PHP
+        run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+
+      - name: Setup problem matchers for PHPUnit
+        run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
+
+      - name: Set git to use LF
+        run: |
+          git config --global core.autocrlf false
+          git config --global core.eol lf
+
+      - uses: actions/checkout@v6
+
+      - name: Get composer cache directory
+        run: echo COMPOSER_CACHE="$(composer config cache-files-dir)" >> "$GITHUB_ENV"
+
+      - name: Cache composer dependencies
+        uses: actions/cache@v5
+        with:
+          path: ${{ env.COMPOSER_CACHE }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate
+
+      - name: Install Composer dependencies
+        run: composer install --no-progress --prefer-dist --optimize-autoloader
+
+      - name: Check code for hard dependencies missing in composer.json
+        run: composer-require-checker check --config-file=tools/composer-require-checker.json composer.json
+
+      - name: Check code for unused dependencies in composer.json
+        run: |
+          composer-unused
+
+      - name: PHP Code Sniffer
+        run: vendor/bin/phpcs
+
+      - name: PHPStan
+        run: |
+          vendor/bin/phpstan analyze -c phpstan.neon --debug
+
+      - name: PHPStan (testsuite)
+        run: |
+          vendor/bin/phpstan analyze -c phpstan-dev.neon --debug
+
+  security:
+    name: Security checks
+    runs-on: [ubuntu-latest]
+    # needs: [unit-tests-linux]
+
+    steps:
+      - name: Setup PHP, with composer and extensions
+        # https://github.com/shivammathur/setup-php
+        uses: shivammathur/setup-php@v2
+        with:
+          # Should be the lowest supported version
+          php-version: '8.3'
+          extensions: >
+            ctype, date, dom, fileinfo, filter, hash, intl, mbstring,
+            openssl, pcre, posix, sodium, spl, xml
+          tools: composer
+          coverage: none
+
+      - name: Setup problem matchers for PHP
+        run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+
+      - name: Setup problem matchers for PHPUnit
+        run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
+
+      - name: Set git to use LF
+        run: |
+          git config --global core.autocrlf false
+          git config --global core.eol lf
+
+      - uses: actions/checkout@v6
+
+      - name: Get composer cache directory
+        run: echo COMPOSER_CACHE="$(composer config cache-files-dir)" >> "$GITHUB_ENV"
+
+      - name: Cache composer dependencies
+        uses: actions/cache@v5
+        with:
+          path: ${{ env.COMPOSER_CACHE }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Install Composer dependencies
+        run: composer install --no-progress --prefer-dist --optimize-autoloader
+
+      - name: Security check for locked dependencies
+        run: composer audit
+
+      - name: Update Composer dependencies
+        run: composer update --no-progress --prefer-dist --optimize-autoloader
+
+      - name: Security check for updated dependencies
+        run: composer audit
+
+  cleanup:
+    name: Cleanup artifacts
+    needs: [unit-tests-linux]
+    runs-on: [ubuntu-latest]
+    if: |
+      always() &&
+      needs.unit-tests-linux.result == 'success'
+
+    steps:
+      - uses: geekyeggo/delete-artifact@v5
+        with:
+          name: coverage-data

.gitignore

@@ -1,3 +1,12 @@
-*~
-vendor
+.phpunit.result.cache
+.phpunit.cache
+composer.lock
+composer.phar
+/vendor/
+/build/
 .idea
+*~
+
+# Commit your application's lock file https://getcomposer.org/doc/01-basic-usage.md#commit-your-composer-lock-file-to-version-control
+# You may choose to ignore a library lock file http://getcomposer.org/doc/02-libraries.md#lock-file
+# composer.lock

.php_cs.dist

@@ -0,0 +1,15 @@
+<?php
+$finder = PhpCsFixer\Finder::create()
+    ->in([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+;
+return PhpCsFixer\Config::create()
+    ->setRules([
+        '@PSR2' => true,
+        '@PSR4' => true,
+        '@PSR5' => true,
+    ])
+    ->setFinder($finder)
+;

codecov.yml

@@ -0,0 +1,20 @@
+---
+
+coverage:
+  status:
+    project:
+      default:
+        target: 0%
+        threshold: 2%
+    patch: off
+
+comment:
+  layout: "diff"
+  behavior: once
+  require_changes: true
+  require_base: false
+  require_head: true
+  branches: null
+
+github_checks:
+  annotations: false

composer.json

@@ -3,18 +3,34 @@
     "description": "Filter to remove attribute values which are not properly scoped.",
     "keywords": [ "simplesamlphp", "scope", "sp", "module", "filter" ],
     "type": "simplesamlphp-module",
+    "autoload": {
+        "psr-4": {
+            "SimpleSAML\\Module\\attributescope\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "SimpleSAML\\Test\\Utils\\": "vendor/simplesamlphp/simplesamlphp/tests/Utils"
+        }
+    },
     "require": {
-        "simplesamlphp/composer-module-installer": "^1.1"
+        "php": "^8.3",
+        "simplesamlphp/simplesamlphp": "~2.5@dev",
+        "simplesamlphp/composer-module-installer": "~1.7"
     },
     "require-dev": {
-        "simplesamlphp/simplesamlphp": "1.14",
-        "phpunit/phpunit": "~4.8.35"
-    },
-    "autoload-dev": {
-      "files": ["tests/_autoload_modules.php"]
+        "simplesamlphp/simplesamlphp-test-framework": "~1.11"
     },
     "support": {
         "issues": "https://github.com/NIIF/simplesamlphp-module-attributescope/issues",
         "source": "https://github.com/NIIF/simplesamlphp-module-attributescope"
+    },
+    "config": {
+        "allow-plugins": {
+            "simplesamlphp/composer-module-installer": true,
+            "simplesamlphp/composer-xmlprovider-installer": true,
+            "dealerdirect/phpcodesniffer-composer-installer": true,
+            "phpstan/extension-installer": true
+        }
     }
 }