diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index c68765b..6991be2 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1 +1 @@ -github: :vendor_name +github: Morning-Train diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 96701be..f62e810 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/Morning-Train/e-conomic/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/Morning-Train/e-conomic/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/Morning-Train/e-conomic/security/policy about: Learn how to notify us for sensitive bugs diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php deleted file mode 100644 index 7ee4ffa..0000000 --- a/.php-cs-fixer.dist.php +++ /dev/null @@ -1,39 +0,0 @@ -in([ - __DIR__ . '/src', - __DIR__ . '/tests', - ]) - ->name('*.php') - ->ignoreDotFiles(true) - ->ignoreVCS(true); - -return (new PhpCsFixer\Config()) - ->setRules([ - '@PSR12' => true, - 'array_syntax' => ['syntax' => 'short'], - 'ordered_imports' => ['sort_algorithm' => 'alpha'], - 'no_unused_imports' => true, - 'not_operator_with_successor_space' => true, - 'trailing_comma_in_multiline' => true, - 'phpdoc_scalar' => true, - 'unary_operator_spaces' => true, - 'binary_operator_spaces' => true, - 'blank_line_before_statement' => [ - 'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'], - ], - 'phpdoc_single_line_var_spacing' => true, - 'phpdoc_var_without_name' => true, - 'class_attributes_separation' => [ - 'elements' => [ - 'method' => 'one', - ], - ], - 'method_argument_space' => [ - 'on_multiline' => 'ensure_fully_multiline', - 'keep_multiple_spaces_after_comma' => true, - ], - 'single_trait_insert_per_statement' => true, - ]) - ->setFinder($finder); diff --git a/CHANGELOG.md b/CHANGELOG.md index 8d01146..05e8eec 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 `e-conomic` will be documented in this file. diff --git a/LICENSE.md b/LICENSE.md index 58c9ad4..808a5a1 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) :vendor_name +Copyright (c) Morning-Train 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 da3e831..21aacb7 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. ---- - +# This is my package e-conomic + +[![Latest Version on Packagist](https://img.shields.io/packagist/v/morning-train/e-conomic.svg?style=flat-square)](https://packagist.org/packages/morning-train/e-conomic) +[![Tests](https://img.shields.io/github/actions/workflow/status/morning-train/e-conomic/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/morning-train/e-conomic/actions/workflows/run-tests.yml) +[![Total Downloads](https://img.shields.io/packagist/dt/morning-train/e-conomic.svg?style=flat-square)](https://packagist.org/packages/morning-train/e-conomic) + 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/e-conomic) 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 morning-train/e-conomic ``` ## Usage ```php -$skeleton = new VendorName\Skeleton(); -echo $skeleton->echoPhrase('Hello, VendorName!'); +$skeleton = new MorningTrain\Economic(); +echo $skeleton->echoPhrase('Hello, MorningTrain!'); ``` ## 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) +- [Simon Jønsson](https://github.com/Morning-Train) - [All Contributors](../../contributors) ## License diff --git a/composer.json b/composer.json index 98297a1..262595e 100644 --- a/composer.json +++ b/composer.json @@ -1,16 +1,16 @@ { - "name": ":vendor_slug/:package_slug", - "description": ":package_description", + "name": "morning-train/e-conomic", + "description": "This is my package e-conomic", "keywords": [ - ":vendor_name", - ":package_slug" + "Morning-Train", + "e-conomic" ], - "homepage": "https://github.com/:vendor_slug/:package_slug", + "homepage": "https://github.com/morning-train/e-conomic", "license": "MIT", "authors": [ { - "name": ":author_name", - "email": "author@domain.com", + "name": "Simon Jønsson", + "email": "sj@morningtrain.dk", "role": "Developer" } ], @@ -18,28 +18,29 @@ "php": "^8.1" }, "require-dev": { - :require_dev_testing, - :require_dev_codestyle, + "pestphp/pest": "^2.15", + "laravel/pint": "^1.0", "spatie/ray": "^1.28" }, "autoload": { "psr-4": { - "VendorName\\Skeleton\\": "src" + "MorningTrain\\Economic\\": "src" } }, "autoload-dev": { "psr-4": { - "VendorName\\Skeleton\\Tests\\": "tests" + "MorningTrain\\Economic\\Tests\\": "tests" } }, "scripts": { - :scripts_testing, - :scripts_codestyle + "test": "vendor/bin/pest", + "test-coverage": "vendor/bin/pest --coverage", + "format": "vendor/bin/pint" }, "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 dcff87e..0000000 --- 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/src/EconomicClass.php b/src/EconomicClass.php new file mode 100755 index 0000000..09bb06a --- /dev/null +++ b/src/EconomicClass.php @@ -0,0 +1,7 @@ +