feat: adding php-cs-fixer-config code

lotyp · lotyp · commit 56679da65139 · 2022-07-14T20:33:10.000+03:00
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -11,7 +11,34 @@ on:  # yamllint disable-line rule:truthy
       - master
 
 jobs:
-  job_one:
-    name: job_one
+  tests:
+    name: PHP ${{ matrix.php }} - ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: true
+      matrix:
+        os: ["ubuntu-22.04"]
+        php: ["8.1"]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: dom, curl, libxml, mbstring, zip, fileinfo
+          ini-values: error_reporting=E_ALL
+          tools: composer:v2
+          coverage: none
+
+      - name: Install dependencies
+        run: composer install
+
+      - name: Execute tests
+        run: make test
+
+      - name: Run phpstan
+        run: make stan
 
 ...
diff --git a/.github/workflows/release-please.yml b/.github/workflows/release-please.yml
@@ -18,7 +18,7 @@ jobs:
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           release-type: node
-          package-name: php-package-tpl
+          package-name: php-cs-fixer-config
           default-branch: master
           changelog-types: |
             [
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -2,3 +2,17 @@
 
 declare(strict_types=1);
 
+use WayOfDev\PhpCsFixer\Config\RuleSets\DefaultSet;
+
+require_once 'vendor/autoload.php';
+
+$config = WayOfDev\PhpCsFixer\Config\ConfigBuilder::createFromRuleSet(new DefaultSet())
+    ->inDir(__DIR__ . '/src')
+    ->inDir(__DIR__ . '/tests')
+    ->addFiles([__FILE__])
+    ->getConfig()
+;
+
+$config->setCacheFile(__DIR__ . '/.build/php-cs-fixer/php-cs-fixer.cache');
+
+return $config;
diff --git a/.yamllint.yaml b/.yamllint.yaml
@@ -51,6 +51,8 @@ rules:
     require-starting-space: true
     min-spaces-from-content: 1
 
+  line-length: disable
+
 yaml-files:
   - "*.yaml"
   - "*.yml"
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/Makefile b/Makefile
@@ -29,7 +29,7 @@ else
 	WHITE := ""
 	RST := ""
 endif
-MAKE_LOGFILE = /tmp/wayofdev-php-package-tpl.log
+MAKE_LOGFILE = /tmp/wayofdev-php-cs-fixer-config.log
 MAKE_CMD_COLOR := $(BLUE)
 
 help:
@@ -40,14 +40,18 @@ help:
 	@echo
 	@echo '    📑 Logs are stored in      $(MAKE_LOGFILE)'
 	@echo
-	@echo '    📦 Package                 php-package-tpl (github.com/wayofdev/php-package-tpl)'
+	@echo '    📦 Package                 php-cs-fixer-config (github.com/wayofdev/php-cs-fixer-config)'
 	@echo '    🤠 Author                  Andrij Orlenko (github.com/lotyp)'
 	@echo '    🏢 ${YELLOW}Org                     wayofdev (github.com/wayofdev)${RST}'
 .PHONY: help
 
-all: install hooks
+all: prepare install hooks
 .PHONY: all
 
+prepare:
+	mkdir -p .build/php-cs-fixer
+.PHONY: prepare
+
 # Composer
 # ------------------------------------------------------------------------------------
 install: ## Installs composer dependencies
@@ -60,11 +64,11 @@ update: ## Updates composer dependencies by running composer update command
 
 # Testing
 # ------------------------------------------------------------------------------------
-cs-diff: ## Runs php-cs-fixer in dry-run mode and shows diff which will by applied
+cs-diff: prepare ## Runs php-cs-fixer in dry-run mode and shows diff which will by applied
 	$(COMPOSER_RUN) cs-diff
 .PHONY: cs-diff
 
-cs-fix: ## Fixes code to follow coding standards using php-cs-fixer
+cs-fix: prepare ## Fixes code to follow coding standards using php-cs-fixer
 	$(COMPOSER_RUN) cs-fix
 .PHONY: cs-fix
 
diff --git a/README.md b/README.md
@@ -12,10 +12,10 @@
 <br>
 
 <div align="center">
-<a href="https://actions-badge.atrox.dev/wayofdev/php-package-tpl/goto"><img alt="Build Status" src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Flotyp%2Fdotfiles%2Fbadge&style=flat-square"/></a>
-<a href="https://github.com/wayofdev/php-package-tpl/tags"><img src="https://img.shields.io/github/v/tag/wayofdev/php-package-tpl?sort=semver&style=flat-square" alt="Latest Version"></a>
-<a href="LICENSE"><img src="https://img.shields.io/github/license/wayofdev/php-package-tpl.svg?style=flat-square&color=blue" alt="Software License"/></a>
-<a href="#"><img alt="Commits since latest release" src="https://img.shields.io/github/commits-since/wayofdev/php-package-tpl/latest?style=flat-square"></a>
+<a href="https://actions-badge.atrox.dev/wayofdev/php-cs-fixer-config/goto"><img alt="Build Status" src="https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Flotyp%2Fdotfiles%2Fbadge&style=flat-square"/></a>
+<a href="https://github.com/wayofdev/php-cs-fixer-config/tags"><img src="https://img.shields.io/github/v/tag/wayofdev/php-cs-fixer-config?sort=semver&style=flat-square" alt="Latest Version"></a>
+<a href="LICENSE"><img src="https://img.shields.io/github/license/wayofdev/php-cs-fixer-config.svg?style=flat-square&color=blue" alt="Software License"/></a>
+<a href="#"><img alt="Commits since latest release" src="https://img.shields.io/github/commits-since/wayofdev/php-cs-fixer-config/latest?style=flat-square"></a>
 </div>
 
 <br>
@@ -26,7 +26,7 @@ This is minimal PHP template which is used by other PHP projects in wayofdev org
 
 If you **like/use** this package, please consider **starring** it. Thanks!
 
-![Screenshot](assets/screenshot.png)
+<br>
 
 ## 💿 Installation
 
@@ -70,7 +70,7 @@ $ make cs-fix
 
 ## 🤝 License
 
-[![Licence](https://img.shields.io/github/license/wayofdev/php-package-tpl?style=for-the-badge&color=blue)](./LICENSE)
+[![Licence](https://img.shields.io/github/license/wayofdev/php-cs-fixer-config?style=for-the-badge&color=blue)](./LICENSE)
 
 <br>
 
diff --git a/assets/screenshot.png b/assets/screenshot.png
diff --git a/composer.json b/composer.json
@@ -1,21 +1,22 @@
 {
-    "name": "wayofdev/package-tpl",
-    "description": "PHP package template with GitHub Actions",
+    "name": "wayofdev/cs-fixer-config",
+    "description": "Package adds custom rule-sets to php-cs-fixer",
     "type": "library",
     "license": "MIT",
     "homepage": "https://wayof.dev",
     "support": {
-        "issues": "https://github.com/wayofdev/php-package-tpl/issues",
-        "source": "https://github.com/wayofdev/php-package-tpl"
+        "issues": "https://github.com/wayofdev/php-cs-fixer-config/issues",
+        "source": "https://github.com/wayofdev/php-cs-fixer-config"
     },
     "authors": [
         {
-            "name": "lotyp",
+            "name": "Andrij Orlenko",
             "email": "the@wayof.dev"
         }
     ],
     "require": {
-        "php": "^8.1"
+        "php": "^8.1",
+        "friendsofphp/php-cs-fixer": "^3.9.3"
     },
     "require-dev": {
         "ergebnis/composer-normalize": "^2.28",
@@ -29,12 +30,12 @@
     },
     "autoload": {
         "psr-4": {
-            "WayOfDev\\PackageTpl\\": "src/"
+            "WayOfDev\\PhpCsFixer\\Config\\": "src/"
         }
     },
     "autoload-dev": {
         "psr-4": {
-            "WayOfDev\\PackageTpl\\Tests\\": "tests/"
+            "WayOfDev\\PhpCsFixer\\Config\\Tests\\": "tests/"
         }
     },
     "scripts": {
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "version": "1.0.0",
     "repository": {
-        "url": "https://github.com/wayofdev/php-package-tpl.git"
+        "url": "https://github.com/wayofdev/php-cs-fixer-config.git"
     }
 }
diff --git a/src/ConfigBuilder.php b/src/ConfigBuilder.php
@@ -0,0 +1,78 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WayOfDev\PhpCsFixer\Config;
+
+use BadMethodCallException;
+use PhpCsFixer\Config;
+use PhpCsFixer\ConfigInterface;
+use PhpCsFixer\Finder;
+
+use function call_user_func_array;
+use function get_class;
+use function is_callable;
+use function sprintf;
+
+/**
+ * @method self setRiskyAllowed(bool $flag)
+ * @method self setUsingCache(bool $flag)
+ */
+final class ConfigBuilder
+{
+    private Config $config;
+
+    public static function createFromRuleSet(RuleSet $ruleSet): self
+    {
+        return new self($ruleSet);
+    }
+
+    /**
+     * @throws BadMethodCallException
+     */
+    public function __call(string $name, array $arguments): self
+    {
+        $method = [$this->config, $name];
+
+        if (is_callable($method)) {
+            call_user_func_array($method, $arguments);
+
+            return $this;
+        }
+
+        throw new BadMethodCallException(sprintf('Method "%s::%s" does not exists.', get_class($this->config), $name));
+    }
+
+    public function inDir(string $dir): self
+    {
+        $this->getFinder()->in([$dir]);
+
+        return $this;
+    }
+
+    public function addFiles(array $files): self
+    {
+        $this->getFinder()->append($files);
+
+        return $this;
+    }
+
+    public function getConfig(): ConfigInterface
+    {
+        return $this->config->setRules($this->ruleSet->rules());
+    }
+
+    private function __construct(private readonly RuleSet $ruleSet)
+    {
+        $this->config = new Config($ruleSet->name());
+        $this->config
+            ->setRiskyAllowed($ruleSet->allowRisky())
+            ->setUsingCache($ruleSet->useCache())
+        ;
+    }
+
+    private function getFinder(): Finder
+    {
+        return $this->config->getFinder();
+    }
+}
diff --git a/src/Package.php b/src/Package.php
diff --git a/src/RuleSet.php b/src/RuleSet.php
@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace WayOfDev\PhpCsFixer\Config;
+
+interface RuleSet
+{
+    public function name(): string;
+
+    public function allowRisky(): bool;
+
+    public function useCache(): bool;
+
+    public function rules(): array;
+}
diff --git a/src/RuleSets/DefaultSet.php b/src/RuleSets/DefaultSet.php
diff --git a/tests/Unit/ConfigBuilderTest.php b/tests/Unit/ConfigBuilderTest.php

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ jobs:`
`18`	`18`	`with:`
`19`	`19`	`token: ${{ secrets.GITHUB_TOKEN }}`
`20`	`20`	`release-type: node`
`21`		`- package-name: php-package-tpl`
	`21`	`+ package-name: php-cs-fixer-config`
`22`	`22`	`default-branch: master`
`23`	`23`	`changelog-types: \|`
`24`	`24`	`[`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"version": "1.0.0",`
`3`	`3`	`"repository": {`
`4`		`- "url": "https://github.com/wayofdev/php-package-tpl.git"`
	`4`	`+ "url": "https://github.com/wayofdev/php-cs-fixer-config.git"`
`5`	`5`	`}`
`6`	`6`	`}`