Merge pull request #734 from wayofdev/feat/infra-dx

lotyp · web-flow · commit 3f641094019d · 2024-05-26T14:41:10.000+03:00
diff --git a/.github/.yamllint.yaml b/.github/.yamllint.yaml
diff --git a/.github/workflows/coding-standards.yml b/.github/workflows/coding-standards.yml
@@ -0,0 +1,196 @@
+---
+
+on:  # yamllint disable-line rule:truthy
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+
+name: 🧹 Fix PHP coding standards
+
+jobs:
+  commit-linting:
+    timeout-minutes: 4
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+    steps:
+      - name: 📦 Check out the codebase
+        uses: actions/checkout@v4.1.6
+
+      - name: 🧐 Lint commits using "commitlint"
+        uses: wagoid/commitlint-github-action@v6.0.1
+        with:
+          configFile: ${{ github.workspace }}/.github/.commitlint.config.mjs
+          failOnWarnings: false
+          failOnErrors: false
+          helpURL: 'https://github.com/conventional-changelog/commitlint/#what-is-commitlint'
+
+  yaml-linting:
+    timeout-minutes: 4
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: read
+    steps:
+      - name: 📦 Check out the codebase
+        uses: actions/checkout@v4.1.6
+
+      - name: 🧐 Lint YAML files
+        uses: ibiqlik/action-yamllint@v3.1.1
+        with:
+          config_file: .github/.yamllint.yaml
+          file_or_dir: '.'
+          strict: true
+
+  markdown-linting:
+    timeout-minutes: 4
+    runs-on: ubuntu-latest
+    concurrency:
+      cancel-in-progress: true
+      group: markdown-linting-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+    steps:
+      - name: 📦 Check out the codebase
+        uses: actions/checkout@v4.1.6
+
+      - name: 🧐 Lint Markdown files
+        uses: DavidAnson/markdownlint-cli2-action@v16.0.0
+        with:
+          globs: |
+            **/*.md
+            !CHANGELOG.md
+
+  composer-linting:
+    timeout-minutes: 4
+    runs-on: ${{ matrix.os }}
+    concurrency:
+      cancel-in-progress: true
+      group: composer-linting-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+        php-version:
+          - '8.2'
+        dependencies:
+          - locked
+    permissions:
+      contents: write
+    steps:
+      - name: 🛠️ Setup PHP
+        uses: shivammathur/setup-php@2.30.4
+        with:
+          php-version: ${{ matrix.php-version }}
+          extensions: none, ctype, dom, json, mbstring, simplexml, tokenizer, xml, xmlwriter, pdo, curl, fileinfo, pdo_mysql
+          ini-values: error_reporting=E_ALL
+          coverage: none
+          tools: phive
+
+      - name: 📦 Check out the codebase
+        uses: actions/checkout@v4.1.6
+
+      - name: 🛠️ Setup problem matchers
+        run: |
+          echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+
+      - name: 🤖 Validate composer.json and composer.lock
+        run: composer validate --ansi --strict
+
+      - name: 🔍 Get composer cache directory
+        uses: wayofdev/gh-actions/actions/composer/get-cache-directory@v3.1.0
+
+      - name: ♻️ Restore cached dependencies installed with composer
+        uses: actions/cache@v4.0.2
+        with:
+          path: ${{ env.COMPOSER_CACHE_DIR }}
+          key: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }}
+          restore-keys: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-
+
+      - name: 📥 Install "${{ matrix.dependencies }}" dependencies with composer
+        uses: wayofdev/gh-actions/actions/composer/install@v3.1.0
+        with:
+          dependencies: ${{ matrix.dependencies }}
+
+      - name: 📥 Install dependencies with phive
+        uses: wayofdev/gh-actions/actions/phive/install@v3.1.0
+        with:
+          phive-home: '.phive'
+          trust-gpg-keys: '0xC00543248C87FB13,0x033E5F8D801A2F8D'
+
+      - name: 🔍 Run ergebnis/composer-normalize
+        run: .phive/composer-normalize --ansi --dry-run
+
+  coding-standards:
+    timeout-minutes: 4
+    runs-on: ${{ matrix.os }}
+    concurrency:
+      cancel-in-progress: true
+      group: coding-standards-${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+    strategy:
+      matrix:
+        os:
+          - ubuntu-latest
+        php-version:
+          - '8.2'
+        dependencies:
+          - locked
+    permissions:
+      contents: write
+    steps:
+      - name: ⚙️ Set git to use LF line endings
+        run: |
+          git config --global core.autocrlf false
+          git config --global core.eol lf
+
+      - name: 🛠️ Setup PHP
+        uses: shivammathur/setup-php@2.30.4
+        with:
+          php-version: ${{ matrix.php-version }}
+          extensions: none, ctype, dom, json, mbstring, simplexml, tokenizer, xml, xmlwriter, pdo, curl, fileinfo, pdo_mysql
+          ini-values: error_reporting=E_ALL
+          coverage: none
+
+      - name: 📦 Check out the codebase
+        uses: actions/checkout@v4.1.6
+
+      - name: 🛠️ Setup problem matchers
+        run: |
+          echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+
+      - name: 🤖 Validate composer.json and composer.lock
+        run: composer validate --ansi --strict
+
+      - name: 🔍 Get composer cache directory
+        uses: wayofdev/gh-actions/actions/composer/get-cache-directory@v3.1.0
+
+      - name: ♻️ Restore cached dependencies installed with composer
+        uses: actions/cache@v4.0.2
+        with:
+          path: ${{ env.COMPOSER_CACHE_DIR }}
+          key: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-${{ hashFiles('composer.lock') }}
+          restore-keys: php-${{ matrix.php-version }}-composer-${{ matrix.dependencies }}-
+
+      - name: 📥 Install "${{ matrix.dependencies }}" dependencies with composer
+        uses: wayofdev/gh-actions/actions/composer/install@v3.1.0
+        with:
+          dependencies: ${{ matrix.dependencies }}
+
+      - name: 🛠️ Prepare environment
+        run: make prepare
+
+      - name: 🚨 Run coding standards task
+        run: composer cs:fix
+        env:
+          PHP_CS_FIXER_IGNORE_ENV: true
+
+      - name: 📤 Commit and push changed files back to GitHub
+        uses: stefanzweifel/git-auto-commit-action@v5.0.1
+        with:
+          commit_message: 'style(php-cs-fixer): lint php files and fix coding standards'
+          branch: ${{ github.head_ref }}
+          commit_author: 'github-actions <github-actions@users.noreply.github.com>'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/Makefile b/Makefile
@@ -32,6 +32,7 @@ ENVSUBST ?= $(BUILDER) envsubst
 YAML_LINT_RUNNER ?= $(DOCKER) run --rm $$(tty -s && echo "-it" || echo) \
 	-v $(PWD):/data \
 	cytopia/yamllint:latest \
+	-c ./.github/.yamllint.yaml \
 	-f colored .
 
 ACTION_LINT_RUNNER ?= $(DOCKER) run --rm $$(tty -s && echo "-it" || echo) \
diff --git a/package.json b/package.json
diff --git a/src/Bridge/Laravel/Console/Commands/Database/ListCommand.php b/src/Bridge/Laravel/Console/Commands/Database/ListCommand.php
@@ -48,7 +48,7 @@ public function handle(DatabaseConfig $config, DatabaseProviderInterface $dbal):
         $databaseArgumentValue = $this->argument('db');
 
         /** @var array<string> $databases */
-        $databases = (null !== $databaseArgumentValue)
+        $databases = ($databaseArgumentValue !== null)
             ? [$databaseArgumentValue]
             : array_keys($config->getDatabases());
 
diff --git a/src/Bridge/Laravel/Console/Commands/Database/TableCommand.php b/src/Bridge/Laravel/Console/Commands/Database/TableCommand.php
@@ -226,7 +226,7 @@ private function describeType(AbstractColumn $column): string
             $type .= " ({$column->getSize()})";
         }
 
-        if ('decimal' === $abstractType) {
+        if ($abstractType === 'decimal') {
             $type .= " ({$column->getPrecision()}, {$column->getScale()})";
         }
 
diff --git a/src/Bridge/Laravel/Console/Commands/Migrations/MigrateCommand.php b/src/Bridge/Laravel/Console/Commands/Migrations/MigrateCommand.php
@@ -32,7 +32,7 @@ public function handle(): int
         $found = false;
         $count = $this->option('one') ? 1 : PHP_INT_MAX;
 
-        while (0 < $count && null !== ($migration = $this->migrator->run())) {
+        while ($count > 0 && null !== ($migration = $this->migrator->run())) {
             $found = true;
             --$count;
 
diff --git a/src/Bridge/Laravel/Console/Commands/Migrations/RollbackCommand.php b/src/Bridge/Laravel/Console/Commands/Migrations/RollbackCommand.php
@@ -33,7 +33,7 @@ public function handle(): int
         $found = false;
         $count = ! $this->option('all') ? 1 : PHP_INT_MAX;
         try {
-            while (0 < $count && null !== ($migration = $this->migrator->rollback())) {
+            while ($count > 0 && null !== ($migration = $this->migrator->rollback())) {
                 $found = true;
                 --$count;
                 $this->line(
diff --git a/src/Bridge/Laravel/Console/Commands/Migrations/StatusCommand.php b/src/Bridge/Laravel/Console/Commands/Migrations/StatusCommand.php
@@ -16,6 +16,7 @@
 final class StatusCommand extends AbstractCommand
 {
     private const DATE_TIME_FORMAT = 'Y-m-d H:i:s';
+
     private const PENDING = '<fg=red>not executed yet</fg=red>';
 
     protected $signature = 'cycle:migrate:status';
diff --git a/src/Bridge/Laravel/Providers/CycleServiceProvider.php b/src/Bridge/Laravel/Providers/CycleServiceProvider.php
@@ -38,7 +38,7 @@ public function boot(): void
         $config = $this->app->get(IlluminateConfig::class);
         $warmup = $config->get('cycle.warmup');
 
-        if (true === $warmup) {
+        if ($warmup === true) {
             /** @var CycleORM $orm */
             $orm = $this->app->get(ORMInterface::class);
             $orm->prepareServices();
diff --git a/src/Bridge/Laravel/Providers/Registrator.php b/src/Bridge/Laravel/Providers/Registrator.php
@@ -7,11 +7,18 @@
 interface Registrator
 {
     public const CFG_KEY = 'cycle';
+
     public const CFG_KEY_DATABASE = 'cycle.database';
+
     public const CFG_KEY_TOKENIZER = 'cycle.tokenizer';
+
     public const CFG_KEY_ATTRIBUTES = 'cycle.attributes';
+
     public const CFG_KEY_MIGRATIONS = 'cycle.migrations';
+
     public const CFG_KEY_SCHEMA = 'cycle.schema';
+
     public const CFG_KEY_WARMUP = 'cycle.warmup';
+
     public const CFG_KEY_RELATIONS = 'cycle.customRelations';
 }
diff --git a/src/Bridge/Laravel/Rules/Exists.php b/src/Bridge/Laravel/Rules/Exists.php
@@ -31,7 +31,7 @@ public function validate(string $attribute, mixed $value, Closure $fail): void
 
         $count = $table->where([$this->column => $value])->count();
 
-        if (0 === $count) {
+        if ($count === 0) {
             $fail($this->message());
         }
     }
diff --git a/src/Bridge/Laravel/Rules/Unique.php b/src/Bridge/Laravel/Rules/Unique.php
@@ -31,7 +31,7 @@ public function validate(string $attribute, mixed $value, Closure $fail): void
 
         $count = $table->where([$this->column => $value])->count();
 
-        if (0 < $count) {
+        if ($count > 0) {
             $fail($this->message());
         }
     }
diff --git a/src/Bridge/Telescope/Events/Database/QueryExecuted.php b/src/Bridge/Telescope/Events/Database/QueryExecuted.php
@@ -13,6 +13,6 @@ final class QueryExecuted
     public function __construct(public string $sql, public array $bindings, public ?float $time, public ?string $driver = null)
     {
         $this->time = $time * 1000;
-        $this->driver = null !== $driver ? 'CycleORM/' . $driver : 'CycleORM';
+        $this->driver = $driver !== null ? 'CycleORM/' . $driver : 'CycleORM';
     }
 }
diff --git a/src/Bridge/Telescope/TelescopeLogger.php b/src/Bridge/Telescope/TelescopeLogger.php
@@ -21,7 +21,7 @@ public function log($level, $message, array $context = []): void
     {
         $this->parentLogger->log($level, $message, $context);
 
-        if ('info' === $level && isset($context['elapsed'])) {
+        if ($level === 'info' && isset($context['elapsed'])) {
             event(
                 new QueryExecuted(
                     sql: $message,
diff --git a/src/Bridge/Telescope/Watchers/QueryWatcher.php b/src/Bridge/Telescope/Watchers/QueryWatcher.php
@@ -32,7 +32,7 @@ public function recordQuery(QueryExecuted $event): void
         $time = $event->time;
         $caller = $this->getCallerFromStackTrace();
 
-        if (null !== $caller) {
+        if ($caller !== null) {
             Telescope::recordQuery(IncomingEntry::make([
                 'connection' => $event->driver,
                 'bindings' => $event->bindings,
diff --git a/src/Contracts/GeneratorLoader.php b/src/Contracts/GeneratorLoader.php
@@ -9,7 +9,9 @@
 interface GeneratorLoader
 {
     public const GROUP_INDEX = 'index';
+
     public const GROUP_RENDER = 'render';
+
     public const GROUP_POSTPROCESS = 'postprocess';
 
     /**
diff --git a/src/Schema/Compiler.php b/src/Schema/Compiler.php
@@ -17,6 +17,11 @@ final class Compiler
 {
     private const EMPTY_SCHEMA = ':empty:';
 
+    public function __construct(
+        private readonly mixed $schema
+    ) {
+    }
+
     public static function compile(Registry $registry, GeneratorLoader $queue): self
     {
         return new self((new CycleSchemaCompiler())->compile($registry, $queue->get()));
@@ -27,14 +32,9 @@ public static function fromMemory(CacheManager $cache): self
         return new self($cache->get());
     }
 
-    public function __construct(
-        private readonly mixed $schema
-    ) {
-    }
-
     public function isEmpty(): bool
     {
-        return null === $this->schema || [] === $this->schema || self::EMPTY_SCHEMA === $this->schema;
+        return $this->schema === null || $this->schema === [] || $this->schema === self::EMPTY_SCHEMA;
     }
 
     public function toSchema(): SchemaInterface
diff --git a/src/Schema/Generators/GeneratorQueue.php b/src/Schema/Generators/GeneratorQueue.php
@@ -16,7 +16,9 @@
 
 final class GeneratorQueue implements GeneratorLoader
 {
-    /** @var array<array<GeneratorInterface|class-string<GeneratorInterface>>> */
+    /**
+     * @var array<array<GeneratorInterface|class-string<GeneratorInterface>>>
+     */
     private array $generators;
 
     private Container $app;
diff --git a/src/Testing/Constraints/HasInDatabase.php b/src/Testing/Constraints/HasInDatabase.php
@@ -37,7 +37,7 @@ public function matches(mixed $other): bool
         try {
             $count = $tableInterface->where($this->data)->count();
 
-            return 0 < $count;
+            return $count > 0;
         } catch (Throwable $e) {
             return false;
         }
diff --git a/src/Testing/Constraints/NotSoftDeletedInDatabase.php b/src/Testing/Constraints/NotSoftDeletedInDatabase.php
@@ -42,7 +42,7 @@ public function matches(mixed $other): bool
                 ->andWhere($this->deletedAtColumn, '=', null)
                 ->count();
 
-            return 0 < $count;
+            return $count > 0;
         } catch (Throwable $e) {
             return false;
         }
diff --git a/src/Testing/Constraints/SoftDeletedInDatabase.php b/src/Testing/Constraints/SoftDeletedInDatabase.php
diff --git a/tests/app/Entities/Footprint.php b/tests/app/Entities/Footprint.php
diff --git a/tests/app/Entities/Signature.php b/tests/app/Entities/Signature.php
diff --git a/tests/app/Entities/UserId.php b/tests/app/Entities/UserId.php
diff --git a/tests/src/Bridge/Laravel/LoggerFactoryTest.php b/tests/src/Bridge/Laravel/LoggerFactoryTest.php

Original file line number	Diff line number	Diff line change
`@@ -226,7 +226,7 @@ private function describeType(AbstractColumn $column): string`
`226`	`226`	`$type .= " ({$column->getSize()})";`
`227`	`227`	`}`
`228`	`228`
`229`		`- if ('decimal' === $abstractType) {`
	`229`	`+ if ($abstractType === 'decimal') {`
`230`	`230`	`$type .= " ({$column->getPrecision()}, {$column->getScale()})";`
`231`	`231`	`}`
`232`	`232`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@`
`16`	`16`	`final class StatusCommand extends AbstractCommand`
`17`	`17`	`{`
`18`	`18`	`private const DATE_TIME_FORMAT = 'Y-m-d H:i:s';`
	`19`	`+`
`19`	`20`	`private const PENDING = '<fg=red>not executed yet</fg=red>';`
`20`	`21`
`21`	`22`	`protected $signature = 'cycle:migrate:status';`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public function validate(string $attribute, mixed $value, Closure $fail): void`
`31`	`31`
`32`	`32`	`$count = $table->where([$this->column => $value])->count();`
`33`	`33`
`34`		`- if (0 === $count) {`
	`34`	`+ if ($count === 0) {`
`35`	`35`	`$fail($this->message());`
`36`	`36`	`}`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,6 @@ final class QueryExecuted`
`13`	`13`	`public function __construct(public string $sql, public array $bindings, public ?float $time, public ?string $driver = null)`
`14`	`14`	`{`
`15`	`15`	`$this->time = $time * 1000;`
`16`		`- $this->driver = null !== $driver ? 'CycleORM/' . $driver : 'CycleORM';`
	`16`	`+ $this->driver = $driver !== null ? 'CycleORM/' . $driver : 'CycleORM';`
`17`	`17`	`}`
`18`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ public function log($level, $message, array $context = []): void`
`21`	`21`	`{`
`22`	`22`	`$this->parentLogger->log($level, $message, $context);`
`23`	`23`
`24`		`- if ('info' === $level && isset($context['elapsed'])) {`
	`24`	`+ if ($level === 'info' && isset($context['elapsed'])) {`
`25`	`25`	`event(`
`26`	`26`	`new QueryExecuted(`
`27`	`27`	`sql: $message,`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,9 @@`
`9`	`9`	`interface GeneratorLoader`
`10`	`10`	`{`
`11`	`11`	`public const GROUP_INDEX = 'index';`
	`12`	`+`
`12`	`13`	`public const GROUP_RENDER = 'render';`
	`14`	`+`
`13`	`15`	`public const GROUP_POSTPROCESS = 'postprocess';`
`14`	`16`
`15`	`17`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,11 @@ final class Compiler`
`17`	`17`	`{`
`18`	`18`	`private const EMPTY_SCHEMA = ':empty:';`
`19`	`19`
	`20`	`+ public function __construct(`
	`21`	`+ private readonly mixed $schema`
	`22`	`+ ) {`
	`23`	`+ }`
	`24`	`+`
`20`	`25`	`public static function compile(Registry $registry, GeneratorLoader $queue): self`
`21`	`26`	`{`
`22`	`27`	`return new self((new CycleSchemaCompiler())->compile($registry, $queue->get()));`
`@@ -27,14 +32,9 @@ public static function fromMemory(CacheManager $cache): self`
`27`	`32`	`return new self($cache->get());`
`28`	`33`	`}`
`29`	`34`
`30`		`- public function __construct(`
`31`		`- private readonly mixed $schema`
`32`		`- ) {`
`33`		`- }`
`34`		`-`
`35`	`35`	`public function isEmpty(): bool`
`36`	`36`	`{`
`37`		`- return null === $this->schema \|\| [] === $this->schema \|\| self::EMPTY_SCHEMA === $this->schema;`
	`37`	`+ return $this->schema === null \|\| $this->schema === [] \|\| $this->schema === self::EMPTY_SCHEMA;`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`public function toSchema(): SchemaInterface`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,9 @@`
`16`	`16`
`17`	`17`	`final class GeneratorQueue implements GeneratorLoader`
`18`	`18`	`{`
`19`		`- /** @var array<array<GeneratorInterface\|class-string<GeneratorInterface>>> */`
	`19`	`+ /**`
	`20`	`+ * @var array<array<GeneratorInterface\|class-string<GeneratorInterface>>>`
	`21`	`+ */`
`20`	`22`	`private array $generators;`
`21`	`23`
`22`	`24`	`private Container $app;`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public function matches(mixed $other): bool`
`37`	`37`	`try {`
`38`	`38`	`$count = $tableInterface->where($this->data)->count();`
`39`	`39`
`40`		`- return 0 < $count;`
	`40`	`+ return $count > 0;`
`41`	`41`	`} catch (Throwable $e) {`
`42`	`42`	`return false;`
`43`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public function matches(mixed $other): bool`
`42`	`42`	`->andWhere($this->deletedAtColumn, '=', null)`
`43`	`43`	`->count();`
`44`	`44`
`45`		`- return 0 < $count;`
	`45`	`+ return $count > 0;`
`46`	`46`	`} catch (Throwable $e) {`
`47`	`47`	`return false;`
`48`	`48`	`}`