diff --git a/.github/composer-config.json b/.github/composer-config.json new file mode 100644 index 0000000..3cf8468 --- /dev/null +++ b/.github/composer-config.json @@ -0,0 +1,13 @@ +{ + "config": { + "cache-vcs-dir": "/dev/null", + "platform-check": false, + "preferred-install": { + "*": "dist" + }, + "allow-plugins": { + "ergebnis/composer-normalize": true, + "symfony/flex": true + } + } +} diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml deleted file mode 100644 index cb9a946..0000000 --- a/.github/workflows/ci.yaml +++ /dev/null @@ -1,157 +0,0 @@ -name: 'CI' - -on: - push: - branches: - - main - pull_request: - branches: - - main - -jobs: - cs-fixer: - name: 'PHP CS Fixer' - - runs-on: 'ubuntu-latest' - - strategy: - matrix: - php-version: - - '8.2' - - steps: - - - name: 'Check out' - uses: 'actions/checkout@v4' - - - - name: 'Set up PHP' - uses: 'shivammathur/setup-php@v2' - with: - php-version: '${{ matrix.php-version }}' - coverage: 'none' - - - - name: 'Get Composer cache directory' - id: 'composer-cache' - run: 'echo "cache_dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT' - - - - name: 'Cache dependencies' - uses: 'actions/cache@v3' - with: - path: '${{ steps.composer-cache.outputs.cache_dir }}' - key: "php-${{ matrix.php-version }}-composer-locked-${{ hashFiles('composer.lock') }}" - restore-keys: 'php-${{ matrix.php-version }}-composer-locked-' - - - - name: 'Install dependencies' - run: 'composer install --no-progress' - - - - name: 'Check the code style' - run: 'make cs' - - phpstan: - name: 'PhpStan' - - runs-on: 'ubuntu-latest' - - strategy: - matrix: - php-version: - - '8.2' - - steps: - - - name: 'Check out' - uses: 'actions/checkout@v4' - - - - name: 'Set up PHP' - uses: 'shivammathur/setup-php@v2' - with: - php-version: '${{ matrix.php-version }}' - coverage: 'none' - - - - name: 'Get Composer cache directory' - id: 'composer-cache' - run: 'echo "cache_dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT' - - - - name: 'Cache dependencies' - uses: 'actions/cache@v3' - with: - path: '${{ steps.composer-cache.outputs.cache_dir }}' - key: "php-${{ matrix.php-version }}-composer-locked-${{ hashFiles('composer.lock') }}" - restore-keys: 'php-${{ matrix.php-version }}-composer-locked-' - - - - name: 'Install dependencies' - run: 'composer install --no-progress' - - - - name: 'Run PhpStan' - run: 'vendor/bin/phpstan analyze --no-progress' - - tests: - name: 'PHPUnit' - - runs-on: 'ubuntu-latest' - - strategy: - matrix: - include: - - - php-version: '8.1' - composer-options: '--prefer-stable' - symfony-version: '6.3' - - - php-version: '8.2' - composer-options: '--prefer-stable' - symfony-version: '^6.4' - - - - php-version: '8.2' - composer-options: '--prefer-stable' - symfony-version: '^7.0' - - steps: - - - name: 'Check out' - uses: 'actions/checkout@v4' - - - - name: 'Set up PHP' - uses: 'shivammathur/setup-php@v2' - with: - php-version: '${{ matrix.php-version }}' - coverage: 'none' - - - - name: 'Get Composer cache directory' - id: 'composer-cache' - run: 'echo "cache_dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT' - - - - name: 'Cache dependencies' - uses: 'actions/cache@v3' - with: - path: '${{ steps.composer-cache.outputs.cache_dir }}' - key: "php-${{ matrix.php-version }}-composer-locked-${{ hashFiles('composer.lock') }}" - restore-keys: 'php-${{ matrix.php-version }}-composer-locked-' - - - - name: 'Install dependencies' - env: - COMPOSER_OPTIONS: '${{ matrix.composer-options }}' - SYMFONY_REQUIRE: '${{ matrix.symfony-version }}' - run: | - composer global config --no-plugins allow-plugins.symfony/flex true - composer global require --no-progress --no-scripts --no-plugins symfony/flex - composer update --no-progress $COMPOSER_OPTIONS - - - - name: 'Run tests' - run: make phpunit diff --git a/.github/workflows/composer-validate.yaml b/.github/workflows/composer-validate.yaml new file mode 100644 index 0000000..4eaa602 --- /dev/null +++ b/.github/workflows/composer-validate.yaml @@ -0,0 +1,51 @@ +name: Composer Validate + +on: + push: + paths: + - 'composer.json' + pull_request: + paths: + - 'composer.json' + +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} + cancel-in-progress: true + +permissions: + contents: read + +jobs: + composer-sync: + name: 'Composer validation' + runs-on: ubuntu-24.04 + env: + php-version: '8.4' + + steps: + - + name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ env.php-version }} + ini-values: "memory_limit=-1" + coverage: none + + - + name: Checkout target branch + uses: actions/checkout@v6 + + - + name: 'Install dependencies' + run: | + COMPOSER_HOME="$(composer config home)" + ([ -d "$COMPOSER_HOME" ] || mkdir "$COMPOSER_HOME") && cp .github/composer-config.json "$COMPOSER_HOME/config.json" + composer global require -q "ergebnis/composer-normalize" + composer install --no-progress + + - + name: 'Normalized composer.json' + run: | + echo "composer.json" + composer validate + composer normalize diff --git a/.github/workflows/inspector-bot.yaml b/.github/workflows/inspector-bot.yaml new file mode 100644 index 0000000..2499218 --- /dev/null +++ b/.github/workflows/inspector-bot.yaml @@ -0,0 +1,16 @@ +name: CS + +on: + pull_request: + +permissions: + contents: read + +jobs: + call-inspector-bot: + name: InspectorBot + uses: rollerscapes/inspector-bot/.github/workflows/inspector-bot.yml@main + with: + package: RollerworksUriEncoder + check_license: true + diff --git a/.github/workflows/phpstan.yaml b/.github/workflows/phpstan.yaml new file mode 100644 index 0000000..6169481 --- /dev/null +++ b/.github/workflows/phpstan.yaml @@ -0,0 +1,62 @@ +name: PHPStan + +on: + pull_request: + +defaults: + run: + shell: bash + +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} + cancel-in-progress: true + +permissions: + contents: read + +jobs: + phpstan: + name: PHPStan + runs-on: ubuntu-24.04 + + env: + php-version: '8.2' + steps: + - + name: Setup PHP + uses: shivammathur/setup-php@v2 + with: + php-version: ${{ env.php-version }} + ini-values: "memory_limit=-1" + coverage: none + + - + name: Checkout target branch + uses: actions/checkout@v6 + with: + ref: ${{ github.base_ref }} + + - + name: Checkout PR + uses: actions/checkout@v6 + + - + name: Install dependencies + run: | + COMPOSER_HOME="$(composer config home)" + ([ -d "$COMPOSER_HOME" ] || mkdir "$COMPOSER_HOME") && cp .github/composer-config.json "$COMPOSER_HOME/config.json" + composer install --no-progress --ansi --no-plugins + + - + name: Generate PHPStan baseline + run: | + git checkout composer.json + git checkout -m ${{ github.base_ref }} + vendor/bin/phpstan analyze --generate-baseline --allow-empty-baseline --no-progress + git checkout -m FETCH_HEAD + + - + name: PHPStan + run: | + vendor/bin/phpstan analyze --no-progress --error-format=github + diff --git a/.github/workflows/unit-tests.yml b/.github/workflows/unit-tests.yml new file mode 100644 index 0000000..1e25587 --- /dev/null +++ b/.github/workflows/unit-tests.yml @@ -0,0 +1,52 @@ +name: CI +on: + push: + branches: + - main + pull_request: + branches: + - main + +jobs: + + test: + + name: 'PHPUnit with PHP ${{ matrix.php-version }} / Symfony ${{ matrix.symfony-version }}' + runs-on: ubuntu-latest + + strategy: + fail-fast: false + matrix: + include: + - php-version: '8.1' + - php-version: '8.2' + - php-version: '8.3' + - php-version: '8.4' + - php-version: '8.5' + steps: + - + name: Checkout + uses: actions/checkout@v6 + + - + name: 'Set up PHP' + uses: 'shivammathur/setup-php@v2' + with: + php-version: '${{ matrix.php-version }}' + coverage: none + env: + update: true + + - + name: 'Install dependencies' + env: + COMPOSER_OPTIONS: '${{ matrix.composer-options }}' + SYMFONY_REQUIRE: '${{ matrix.symfony-version }}' + run: | + composer global config --no-plugins allow-plugins.symfony/flex true + composer global require --no-progress --no-scripts --no-plugins symfony/flex + composer update --no-progress --no-interaction --optimize-autoloader $COMPOSER_OPTIONS + + - + name: Run Tests + run: make phpunit diff --git a/LICENSE b/LICENSE index 90816ab..5c5b0fa 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2014 Sebastiaan Stok +Copyright (c) 2014-present Sebastiaan Stok Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/composer.json b/composer.json index a8b73be..e0bf5d4 100644 --- a/composer.json +++ b/composer.json @@ -1,9 +1,11 @@ { "name": "rollerworks/uri-encoder", "description": "A simple library, to safely encode a string for usage in a URI.", - "keywords": ["rollerworks"], - "type": "library", "license": "MIT", + "type": "library", + "keywords": [ + "rollerworks" + ], "authors": [ { "name": "Sebastiaan Stok", @@ -20,8 +22,8 @@ }, "require-dev": { "ext-zlib": "*", - "rollerscapes/standards": "^1.0", - "phpunit/phpunit": "^10.4" + "phpunit/phpunit": "^10.4", + "rollerscapes/standards": "^1.0" }, "minimum-stability": "dev", "prefer-stable": true, @@ -29,14 +31,16 @@ "psr-4": { "Rollerworks\\Component\\UriEncoder\\": "src/" }, - "exclude-from-classmap": ["tests/"] + "exclude-from-classmap": [ + "tests/" + ] }, "autoload-dev": { "Rollerworks\\Component\\UriEncoder\\Tests\\": "tests/" }, "extra": { "branch-alias": { - "dev-master": "2.0-dev" + "dev-2.0": "2.1-dev" } } } diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon new file mode 100644 index 0000000..aab4991 --- /dev/null +++ b/phpstan-baseline.neon @@ -0,0 +1,2 @@ +parameters: + ignoreErrors: [] diff --git a/phpstan.neon b/phpstan.neon index 0e56097..a2e113b 100644 --- a/phpstan.neon +++ b/phpstan.neon @@ -1,6 +1,6 @@ includes: - vendor/rollerscapes/standards/phpstan.neon - #- phpstan-baseline.neon + - phpstan-baseline.neon parameters: #reportUnmatchedIgnoredErrors: false @@ -8,9 +8,5 @@ parameters: paths: - ./src - ./tests - excludePaths: - - var/ - - templates/ - - translations/ #ignoreErrors: