From 4574540904cf0319312edd86de2c7bd0224fd934 Mon Sep 17 00:00:00 2001 From: Niels Vanpachtenbeke <10651054+Nielsvanpach@users.noreply.github.com> Date: Fri, 12 Jan 2024 10:22:31 +0100 Subject: [PATCH] configure skeleton --- .github/FUNDING.yml | 2 +- .github/ISSUE_TEMPLATE/config.yml | 6 +- .../fix-php-code-style-issues-pint.yml | 28 -- ...ixer.yml => fix-php-code-style-issues.yml} | 0 .github/workflows/run-tests-phpunit.yml | 48 --- .../{run-tests-pest.yml => run-tests.yml} | 0 CHANGELOG.md | 2 +- LICENSE.md | 2 +- README.md | 31 +- composer.json | 29 +- configure.php | 288 ------------------ phpunit.xml.dist | 2 +- src/HolidaysClass.php | 7 + src/SkeletonClass.php | 7 - .../{ExampleTestPest.php => ExampleTest.php} | 0 tests/ExampleTestPhpunit.php | 9 - 16 files changed, 40 insertions(+), 421 deletions(-) delete mode 100644 .github/workflows/fix-php-code-style-issues-pint.yml rename .github/workflows/{fix-php-code-style-issues-cs-fixer.yml => fix-php-code-style-issues.yml} (100%) delete mode 100644 .github/workflows/run-tests-phpunit.yml rename .github/workflows/{run-tests-pest.yml => run-tests.yml} (100%) delete mode 100644 configure.php create mode 100755 src/HolidaysClass.php delete mode 100755 src/SkeletonClass.php rename tests/{ExampleTestPest.php => ExampleTest.php} (100%) delete mode 100644 tests/ExampleTestPhpunit.php diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index c68765b06..5ccc87cfb 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1 +1 @@ -github: :vendor_name +github: spatie diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 96701be9f..add816256 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,11 +1,11 @@ blank_issues_enabled: false contact_links: - name: Ask a question - url: https://github.com/:vendor_name/:package_name/discussions/new?category=q-a + url: https://github.com/spatie/holidays/discussions/new?category=q-a about: Ask the community for help - name: Request a feature - url: https://github.com/:vendor_name/:package_name/discussions/new?category=ideas + url: https://github.com/spatie/holidays/discussions/new?category=ideas about: Share ideas for new features - name: Report a security issue - url: https://github.com/:vendor_name/:package_name/security/policy + url: https://github.com/spatie/holidays/security/policy about: Learn how to notify us for sensitive bugs diff --git a/.github/workflows/fix-php-code-style-issues-pint.yml b/.github/workflows/fix-php-code-style-issues-pint.yml deleted file mode 100644 index cd4239c24..000000000 --- a/.github/workflows/fix-php-code-style-issues-pint.yml +++ /dev/null @@ -1,28 +0,0 @@ -name: Fix PHP code style issues - -on: - push: - paths: - - '**.php' - -permissions: - contents: write - -jobs: - php-code-styling: - runs-on: ubuntu-latest - timeout-minutes: 5 - - steps: - - name: Checkout code - uses: actions/checkout@v4 - with: - ref: ${{ github.head_ref }} - - - name: Fix PHP code style issues - uses: aglipanci/laravel-pint-action@2.3.1 - - - name: Commit changes - uses: stefanzweifel/git-auto-commit-action@v5 - with: - commit_message: Fix styling diff --git a/.github/workflows/fix-php-code-style-issues-cs-fixer.yml b/.github/workflows/fix-php-code-style-issues.yml similarity index 100% rename from .github/workflows/fix-php-code-style-issues-cs-fixer.yml rename to .github/workflows/fix-php-code-style-issues.yml diff --git a/.github/workflows/run-tests-phpunit.yml b/.github/workflows/run-tests-phpunit.yml deleted file mode 100644 index cf9f034ed..000000000 --- a/.github/workflows/run-tests-phpunit.yml +++ /dev/null @@ -1,48 +0,0 @@ -name: Tests - -on: - push: - paths: - - '**.php' - - '.github/workflows/run-tests-phpunit.yml' - - 'phpunit.xml.dist' - - 'composer.json' - - 'composer.lock' - -jobs: - test: - runs-on: ${{ matrix.os }} - timeout-minutes: 5 - strategy: - fail-fast: true - matrix: - os: [ubuntu-latest, windows-latest] - php: [8.3, 8.2, 8.1] - stability: [prefer-lowest, prefer-stable] - - name: P${{ matrix.php }} - ${{ matrix.stability }} - ${{ matrix.os }} - - steps: - - name: Checkout code - uses: actions/checkout@v4 - - - name: Setup PHP - uses: shivammathur/setup-php@v2 - with: - php-version: ${{ matrix.php }} - extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo - coverage: none - - - name: Setup problem matchers - run: | - echo "::add-matcher::${{ runner.tool_cache }}/php.json" - echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json" - - - name: Install dependencies - run: composer update --${{ matrix.stability }} --prefer-dist --no-interaction - - - name: List Installed Dependencies - run: composer show -D - - - name: Execute tests - run: vendor/bin/phpunit diff --git a/.github/workflows/run-tests-pest.yml b/.github/workflows/run-tests.yml similarity index 100% rename from .github/workflows/run-tests-pest.yml rename to .github/workflows/run-tests.yml diff --git a/CHANGELOG.md b/CHANGELOG.md index 8d01146d7..2601c0aad 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ # Changelog -All notable changes to `:package_name` will be documented in this file. +All notable changes to `holidays` will be documented in this file. diff --git a/LICENSE.md b/LICENSE.md index 58c9ad42f..cfe14134f 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) :vendor_name +Copyright (c) spatie 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/README.md b/README.md index da3e83182..c5e440b6b 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,14 @@ -# :package_description - -[![Latest Version on Packagist](https://img.shields.io/packagist/v/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug) -[![Tests](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions/workflows/run-tests.yml) -[![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug) - ---- -This package can be used as to scaffold a framework agnostic package. Follow these steps to get started: - -1. Press the "Use template" button at the top of this repo to create a new repo with the contents of this skeleton -2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files -3. Have fun creating your package. -4. If you need help creating a package, consider picking up our Laravel Package Training video course. ---- - +# Calculate public holidays + +[![Latest Version on Packagist](https://img.shields.io/packagist/v/spatie/holidays.svg?style=flat-square)](https://packagist.org/packages/spatie/holidays) +[![Tests](https://img.shields.io/github/actions/workflow/status/spatie/holidays/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/spatie/holidays/actions/workflows/run-tests.yml) +[![Total Downloads](https://img.shields.io/packagist/dt/spatie/holidays.svg?style=flat-square)](https://packagist.org/packages/spatie/holidays) + This is where your description should go. Try and limit it to a paragraph or two. Consider adding a small example. ## Support us -[](https://spatie.be/github-ad-click/:package_name) +[](https://spatie.be/github-ad-click/holidays) We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us). @@ -28,14 +19,14 @@ We highly appreciate you sending us a postcard from your hometown, mentioning wh You can install the package via composer: ```bash -composer require :vendor_slug/:package_slug +composer require spatie/holidays ``` ## Usage ```php -$skeleton = new VendorName\Skeleton(); -echo $skeleton->echoPhrase('Hello, VendorName!'); +$skeleton = new Spatie\Holidays(); +echo $skeleton->echoPhrase('Hello, Spatie!'); ``` ## Testing @@ -58,7 +49,7 @@ Please review [our security policy](../../security/policy) on how to report secu ## Credits -- [:author_name](https://github.com/:author_username) +- [Niels Vanpachtenbeke](https://github.com/Nielsvanpach) - [All Contributors](../../contributors) ## License diff --git a/composer.json b/composer.json index 98297a179..c380e1b3c 100644 --- a/composer.json +++ b/composer.json @@ -1,16 +1,16 @@ { - "name": ":vendor_slug/:package_slug", - "description": ":package_description", + "name": "spatie/holidays", + "description": "Calculate public holidays", "keywords": [ - ":vendor_name", - ":package_slug" + "spatie", + "holidays" ], - "homepage": "https://github.com/:vendor_slug/:package_slug", + "homepage": "https://github.com/spatie/holidays", "license": "MIT", "authors": [ { - "name": ":author_name", - "email": "author@domain.com", + "name": "Niels Vanpachtenbeke", + "email": "freek@spatie.be", "role": "Developer" } ], @@ -18,28 +18,29 @@ "php": "^8.1" }, "require-dev": { - :require_dev_testing, - :require_dev_codestyle, + "pestphp/pest": "^2.15", + "friendsofphp/php-cs-fixer": "^3.21.1", "spatie/ray": "^1.28" }, "autoload": { "psr-4": { - "VendorName\\Skeleton\\": "src" + "Spatie\\Holidays\\": "src" } }, "autoload-dev": { "psr-4": { - "VendorName\\Skeleton\\Tests\\": "tests" + "Spatie\\Holidays\\Tests\\": "tests" } }, "scripts": { - :scripts_testing, - :scripts_codestyle + "test": "vendor/bin/pest", + "test-coverage": "vendor/bin/pest --coverage", + "format": "vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php --allow-risky=yes" }, "config": { "sort-packages": true, "allow-plugins": { - :plugins_testing, + "pestphp/pest-plugin": true, "phpstan/extension-installer": true } }, diff --git a/configure.php b/configure.php deleted file mode 100644 index dcff87ec4..000000000 --- a/configure.php +++ /dev/null @@ -1,288 +0,0 @@ -#!/usr/bin/env php - $option === $default ? strtoupper($option) : $option, - $options, - )); - - $answer = ask("{$question} ({$suggestions})"); - - $validOptions = implode(', ', $options); - - while (! in_array($answer, $options)) { - if ($default && $answer === '') { - $answer = $default; - - break; - } - - writeln(PHP_EOL."Please pick one of the following options: {$validOptions}"); - - $answer = ask("{$question} ({$suggestions})"); - } - - if (! $answer) { - $answer = $default; - } - - return $answer; -} - -function confirm(string $question, bool $default = false): bool -{ - $answer = ask($question.' ('.($default ? 'Y/n' : 'y/N').')'); - - if (! $answer) { - return $default; - } - - return strtolower($answer) === 'y'; -} - -function writeln(string $line): void -{ - echo $line.PHP_EOL; -} - -function run(string $command): string -{ - return trim(shell_exec($command)); -} - -function str_after(string $subject, string $search): string -{ - $pos = strrpos($subject, $search); - - if ($pos === false) { - return $subject; - } - - return substr($subject, $pos + strlen($search)); -} - -function slugify(string $subject): string -{ - return strtolower(trim(preg_replace('/[^A-Za-z0-9-]+/', '-', $subject), '-')); -} - -function title_case(string $subject): string -{ - return str_replace(' ', '', ucwords(str_replace(['-', '_'], ' ', $subject))); -} - -function replace_in_file(string $file, array $replacements): void -{ - $contents = file_get_contents($file); - - file_put_contents( - $file, - str_replace( - array_keys($replacements), - array_values($replacements), - $contents - ) - ); -} - -function removeReadmeParagraphs(string $file): void -{ - $contents = file_get_contents($file); - - file_put_contents( - $file, - preg_replace('/.*/s', '', $contents) ?: $contents - ); -} - -function determineSeparator(string $path): string -{ - return str_replace('/', DIRECTORY_SEPARATOR, $path); -} - -function replaceForWindows(): array -{ - return preg_split('/\\r\\n|\\r|\\n/', run('dir /S /B * | findstr /v /i .git\ | findstr /v /i vendor | findstr /v /i '.basename(__FILE__).' | findstr /r /i /M /F:/ ":author :vendor :package VendorName skeleton vendor_name vendor_slug author@domain.com"')); -} - -function replaceForAllOtherOSes(): array -{ - return explode(PHP_EOL, run('grep -E -r -l -i ":author|:vendor|:package|VendorName|skeleton|vendor_name|vendor_slug|author@domain.com" --exclude-dir=vendor ./* ./.github/* | grep -v '.basename(__FILE__))); -} - -function setupTestingLibrary(string $testingLibrary): void -{ - if ($testingLibrary === 'pest') { - unlink(__DIR__.'/tests/ExampleTestPhpunit.php'); - unlink(__DIR__.'/.github/workflows/run-tests-phpunit.yml'); - - rename( - from: __DIR__.'/tests/ExampleTestPest.php', - to: __DIR__.'/tests/ExampleTest.php' - ); - - rename( - from: __DIR__.'/.github/workflows/run-tests-pest.yml', - to: __DIR__.'/.github/workflows/run-tests.yml' - ); - - replace_in_file(__DIR__.'/composer.json', [ - ':require_dev_testing' => '"pestphp/pest": "^2.15"', - ':scripts_testing' => '"test": "vendor/bin/pest", - "test-coverage": "vendor/bin/pest --coverage"', - ':plugins_testing' => '"pestphp/pest-plugin": true', - ]); - } elseif ($testingLibrary === 'phpunit') { - unlink(__DIR__.'/tests/ExampleTestPest.php'); - unlink(__DIR__.'/tests/ArchTest.php'); - unlink(__DIR__.'/tests/Pest.php'); - unlink(__DIR__.'/.github/workflows/run-tests-pest.yml'); - - rename( - from: __DIR__.'/tests/ExampleTestPhpunit.php', - to: __DIR__.'/tests/ExampleTest.php' - ); - - rename( - from: __DIR__.'/.github/workflows/run-tests-phpunit.yml', - to: __DIR__.'/.github/workflows/run-tests.yml' - ); - - replace_in_file(__DIR__.'/composer.json', [ - ':require_dev_testing' => '"phpunit/phpunit": "^10.3.2"', - ':scripts_testing' => '"test": "vendor/bin/phpunit", - "test-coverage": "vendor/bin/phpunit --coverage"', - ':plugins_testing,' => '', // We need to remove the comma here as well, since there's nothing to add - ]); - } -} - -function setupCodeStyleLibrary(string $codeStyleLibrary): void -{ - if ($codeStyleLibrary === 'pint') { - unlink(__DIR__.'/.github/workflows/fix-php-code-style-issues-cs-fixer.yml'); - - rename( - from: __DIR__.'/.github/workflows/fix-php-code-style-issues-pint.yml', - to: __DIR__.'/.github/workflows/fix-php-code-style-issues.yml' - ); - - replace_in_file(__DIR__.'/composer.json', [ - ':require_dev_codestyle' => '"laravel/pint": "^1.0"', - ':scripts_codestyle' => '"format": "vendor/bin/pint"', - ':plugins_testing' => '', - ]); - - unlink(__DIR__.'/.php-cs-fixer.dist.php'); - } elseif ($codeStyleLibrary === 'cs fixer') { - unlink(__DIR__.'/.github/workflows/fix-php-code-style-issues-pint.yml'); - - rename( - from: __DIR__.'/.github/workflows/fix-php-code-style-issues-cs-fixer.yml', - to: __DIR__.'/.github/workflows/fix-php-code-style-issues.yml' - ); - - replace_in_file(__DIR__.'/composer.json', [ - ':require_dev_codestyle' => '"friendsofphp/php-cs-fixer": "^3.21.1"', - ':scripts_codestyle' => '"format": "vendor/bin/php-cs-fixer fix --config=.php-cs-fixer.dist.php --allow-risky=yes"', - ':plugins_testing' => '', - ]); - } -} - -$gitName = run('git config user.name'); -$authorName = ask('Author name', $gitName); - -$gitEmail = run('git config user.email'); -$authorEmail = ask('Author email', $gitEmail); - -$usernameGuess = explode(':', run('git config remote.origin.url'))[1]; -$usernameGuess = dirname($usernameGuess); -$usernameGuess = basename($usernameGuess); -$authorUsername = ask('Author username', $usernameGuess); - -$vendorName = ask('Vendor name', $authorUsername); -$vendorSlug = slugify($vendorName); -$vendorNamespace = ucwords($vendorName); -$vendorNamespace = ask('Vendor namespace', $vendorNamespace); - -$currentDirectory = getcwd(); -$folderName = basename($currentDirectory); - -$packageName = ask('Package name', $folderName); -$packageSlug = slugify($packageName); - -$className = title_case($packageName); -$className = ask('Class name', $className); -$description = ask('Package description', "This is my package {$packageSlug}"); - -$testingLibrary = askWithOptions( - 'Which testing library do you want to use?', - ['pest', 'phpunit'], - 'pest', -); - -$codeStyleLibrary = askWithOptions( - 'Which code style library do you want to use?', - ['pint', 'cs fixer'], - 'pint', -); - -writeln('------'); -writeln("Author : {$authorName} ({$authorUsername}, {$authorEmail})"); -writeln("Vendor : {$vendorName} ({$vendorSlug})"); -writeln("Package : {$packageSlug} <{$description}>"); -writeln("Namespace : {$vendorNamespace}\\{$className}"); -writeln("Class name : {$className}"); -writeln("Testing library : {$testingLibrary}"); -writeln("Code style library : {$codeStyleLibrary}"); -writeln('------'); - -writeln('This script will replace the above values in all relevant files in the project directory.'); - -if (! confirm('Modify files?', true)) { - exit(1); -} - -$files = (str_starts_with(strtoupper(PHP_OS), 'WIN') ? replaceForWindows() : replaceForAllOtherOSes()); - -foreach ($files as $file) { - replace_in_file($file, [ - ':author_name' => $authorName, - ':author_username' => $authorUsername, - 'author@domain.com' => $authorEmail, - ':vendor_name' => $vendorName, - ':vendor_slug' => $vendorSlug, - 'VendorName' => $vendorNamespace, - ':package_name' => $packageName, - ':package_slug' => $packageSlug, - 'Skeleton' => $className, - ':package_description' => $description, - ]); - - match (true) { - str_contains($file, determineSeparator('src/SkeletonClass.php')) => rename($file, determineSeparator('./src/'.$className.'Class.php')), - str_contains($file, 'README.md') => removeReadmeParagraphs($file), - default => [], - }; -} - -setupTestingLibrary($testingLibrary); -setupCodeStyleLibrary($codeStyleLibrary); - -confirm('Execute `composer install` and run tests?') && run('composer install && composer test'); - -confirm('Let this script delete itself?', true) && unlink(__FILE__); diff --git a/phpunit.xml.dist b/phpunit.xml.dist index 4c6104224..6a137c1cd 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -16,7 +16,7 @@ backupStaticProperties="false" > - + tests diff --git a/src/HolidaysClass.php b/src/HolidaysClass.php new file mode 100755 index 000000000..1708ef4ce --- /dev/null +++ b/src/HolidaysClass.php @@ -0,0 +1,7 @@ +