Refactoring naming

Author: akadlec

.docs/en/index.md

@@ -107,7 +107,7 @@ class ArticleHydrator extends Hydrators\Hydrator
                 $groups[] = $this->groupRepository->findById($identifier->getId());
 
             } catch (NotFoundException $ex) {
-                throw new Exceptions\JsonApiErrorException(
+                throw new Exceptions\JsonApiError(
                     422,
                     'Defined group relation was not found',
                     'Defined group relation was not foun in our application',
@@ -119,7 +119,7 @@ class ArticleHydrator extends Hydrators\Hydrator
         }
 
         if ($groups === []) {
-            throw new Exceptions\JsonApiErrorException(
+            throw new Exceptions\JsonApiError(
                 422,
                 'Groups relation is missing',
                 'Provide at least one group relation to create or update article',
@@ -311,7 +311,7 @@ use Neomerx\JsonApi;
 
 use Your\CoolApplication\Entities;
 
-class ArticleSchema extends Schemas\JsonApiSchema
+class ArticleSchema extends Schemas\JsonApi
 {
     /** @var Routing\IRouter */
     private Routing\IRouter $router;

.editorconfig

@@ -1,14 +1,10 @@
 # Not archived
+/.docs export-ignore
 /.github export-ignore
 /tests export-ignore
 .editorconfig export-ignore
-.eslintrc export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore
-.npmignore export-ignore
-babel.config.js export-ignore
-editorconfig.xml export-ignore
 Makefile export-ignore
+phpcs.xml export-ignore
 phpstan.neon export-ignore
-ruleset.xml export-ignore
-tslint.json export-ignore

.gitattributes

@@ -6,7 +6,9 @@ on:
       - ".docs/**"
   push:
     branches:
-      - "master"
+      - "main"
+    tags:
+      - v*
   schedule:
     - cron: "0 8 * * 1" # At 08:00 on Monday
 
@@ -18,15 +20,15 @@ env:
   coverage: "none"
 
 jobs:
-  php-qa:
-    name: "Quality assurance for PHP code"
+  qa:
+    name: "Code quality assurance"
     runs-on: "${{ matrix.operating-system }}"
 
     strategy:
       fail-fast: false
       matrix:
-        php-version: [ "8.0", "8.1" ]
-        operating-system: [ "ubuntu-latest" ]
+        php-version: ["8.1"]
+        operating-system: ["ubuntu-latest"]
 
     steps:
       - name: "Checkout"
@@ -76,17 +78,17 @@ jobs:
         run: "${{ env.composer-install }}"
 
       - name: "Coding Standard"
-        run: "make php_cs"
+        run: "make cs"
 
-  php-static-analysis:
-    name: "Static analysis for PHP code"
+  static-analysis:
+    name: "Code static analysis"
     runs-on: "${{ matrix.operating-system }}"
 
     strategy:
       fail-fast: false
       matrix:
-        php-version: [ "8.0", "8.1" ]
-        operating-system: [ "ubuntu-latest" ]
+        php-version: ["8.1"]
+        operating-system: ["ubuntu-latest"]
 
     steps:
       - name: "Checkout"
@@ -135,27 +137,27 @@ jobs:
       - name: "PHPStan"
         run: "make phpstan"
 
-  php-tests:
-    name: "Tests for PHP code"
+  tests:
+    name: "Code tests"
     runs-on: "${{ matrix.operating-system }}"
-    needs: [ "php-qa", "php-static-analysis" ]
+    needs: ["qa", "static-analysis"]
 
     strategy:
       fail-fast: false
       matrix:
-        php-version: [ "8.0", "8.1" ]
-        operating-system: [ "ubuntu-latest" ]
+        php-version: ["8.1"]
+        operating-system: ["ubuntu-latest"]
 
     steps:
       - name: "Checkout"
         uses: "actions/checkout@v2"
 
-      - name: "Setup MySQL"
-        uses: "mirromutth/[email protected]"
-        with:
-          mysql version: "5.7"
-          mysql database: "testdb"
-          mysql root password: "root"
+      - name : "Setup MySQL"
+        uses : "mirromutth/[email protected]"
+        with :
+          mysql version : "5.7"
+          mysql database : "testdb"
+          mysql root password : "root"
 
       - name: "Setup PHP cache environment"
         id: "extcache"
@@ -198,7 +200,7 @@ jobs:
         run: "${{ env.composer-install }} ${{ matrix.composer-args }}"
 
       - name: "Tests"
-        run: "make php_tests"
+        run: "make tests"
 
       - name: "Upload test output"
         if: ${{ failure() }}
@@ -207,15 +209,15 @@ jobs:
           name: output
           path: tests/**/output
 
-  php-tests-code-coverage:
-    name: "Tests for PHP code with code coverage"
+  tests-code-coverage:
+    name: "Code tests with code coverage"
     runs-on: "${{ matrix.operating-system }}"
-    needs: [ "php-tests" ]
+    needs: ["tests"]
 
     strategy:
       matrix:
-        php-version: [ "8.1" ]
-        operating-system: [ "ubuntu-latest" ]
+        php-version: ["8.1"]
+        operating-system: ["ubuntu-latest"]
       fail-fast: false
 
     if: "github.event_name == 'push'"
@@ -224,12 +226,12 @@ jobs:
       - name: "Checkout"
         uses: "actions/checkout@v2"
 
-      - name: "Setup MySQL"
-        uses: "mirromutth/[email protected]"
-        with:
-          mysql version: "5.7"
-          mysql database: "testdb"
-          mysql root password: "root"
+      - name : "Setup MySQL"
+        uses : "mirromutth/[email protected]"
+        with :
+          mysql version : "5.7"
+          mysql database : "testdb"
+          mysql root password : "root"
 
       - name: "Setup PHP cache environment"
         id: "extcache"
@@ -272,7 +274,7 @@ jobs:
         run: "${{ env.composer-install }} ${{ matrix.composer-args }}"
 
       - name: "Tests"
-        run: "make php_coverage"
+        run: "make coverage"
 
       - name: "Coveralls.io"
         env:

.github/workflows/ci.yaml

@@ -1,5 +1,6 @@
 .idea
 /vendor
 /composer.lock
-tests/*/output
-tests/tmp
+/tests/*/output
+/tests/tmp
+.DS_Store

.gitignore

@@ -1,27 +1,27 @@
-.PHONY: php_qa php_lint php_cs php_csf phpstan php_tests php_coverage
+.PHONY: qa lint cs csf phpstan tests coverage
 
 all:
 	@$(MAKE) -pRrq -f $(lastword $(MAKEFILE_LIST)) : 2>/dev/null | awk -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' | sort | egrep -v -e '^[^[:alnum:]]' -e '^$@$$' | xargs
 
 vendor: composer.json composer.lock
 	composer install
 
-php_qa: php_lint phpstan php_cs
+qa: lint phpstan cs
 
-php_lint: vendor
-	vendor/bin/linter src tests
+lint: vendor
+	vendor/bin/parallel-lint --exclude .git --exclude vendor src tests
 
-php_cs: vendor
-	vendor/bin/codesniffer src tests
+cs: vendor
+	vendor/bin/phpcs --standard=phpcs.xml src tests
 
-php_csf: vendor
-	vendor/bin/codefixer src tests
+csf: vendor
+	vendor/bin/phpcbf --standard=phpcs.xml src tests
 
 phpstan: vendor
 	vendor/bin/phpstan analyse -c phpstan.neon src
 
-php_tests: vendor
+tests: vendor
 	vendor/bin/tester -s -p php --colors 1 -C tests/cases
 
-php_coverage: vendor
+coverage: vendor
 	vendor/bin/tester -s -p php --colors 1 -C --coverage ./coverage.xml --coverage-src ./src tests/cases

Makefile

@@ -9,6 +9,8 @@
 [![Downloads total](https://badgen.net/packagist/dt/FastyBird/json-api?cache=300&style=flast-square)](https://packagist.org/packages/FastyBird/json-api)
 [![PHPStan](https://img.shields.io/badge/PHPStan-enabled-brightgreen.svg?style=flat-square)](https://github.com/phpstan/phpstan)
 
+***
+
 ## What is FastyBird {JSON:API} library?
 
 This is a [Nette framework](https://nette.org) extension which is implementing [{JSON:API}](https://jsonapi.org/)

README.md

@@ -38,40 +38,41 @@
   "minimum-stability" : "stable",
 
   "require" : {
-    "php": ">=8.0.0|>=8.1.0",
-    "ext-json": "*",
-    "consistence-community/consistence": "^2.1",
-    "cweagans/composer-patches": "^1.7",
-    "doctrine/annotations": "^1.13",
-    "doctrine/orm": "^2.6",
-    "fig/http-message-util": "^1.1",
-    "ipub/json-api-document": "^0.2",
-    "neomerx/json-api": "^4.0",
-    "nette/bootstrap": "^3.1",
-    "nette/di": "^3.0",
-    "nette/utils": "^3.2",
-    "phpdocumentor/reflection-docblock": "^5.3",
-    "psr/http-factory": "^1.0",
-    "psr/http-message": "^1.0",
-    "psr/http-server-middleware": "^1.0",
-    "psr/log": "^1.1|^3.0",
-    "ramsey/uuid": "^4.2"
+    "php" : ">=8.1.0",
+    "ext-json" : "*",
+    "consistence-community/consistence" : "^2.1",
+    "cweagans/composer-patches" : "^1.7",
+    "doctrine/annotations" : "^1.13",
+    "doctrine/orm" : "^2.6",
+    "fig/http-message-util" : "^1.1",
+    "ipub/json-api-document" : "^0.2",
+    "neomerx/json-api" : "^4.0",
+    "nette/bootstrap" : "^3.1",
+    "nette/di" : "^3.0",
+    "nette/utils" : "^3.2",
+    "phpdocumentor/reflection-docblock" : "^5.3",
+    "psr/http-factory" : "^1.0",
+    "psr/http-message" : "^1.0",
+    "psr/http-server-middleware" : "^1.0",
+    "psr/log" : "^1.1|^3.0",
+    "ramsey/uuid" : "^4.2"
   },
 
   "require-dev" : {
-    "contributte/translation": "^0.9",
-    "fastybird/web-server": "^0.8",
-    "mockery/mockery": "^1.4",
-    "ninjify/nunjuck": "^0.3",
-    "ninjify/qa": "^0.13",
-    "pds/skeleton": "^1.0",
-    "phpstan/extension-installer": "^1.1",
-    "phpstan/phpstan": "^1.3",
-    "phpstan/phpstan-deprecation-rules": "^1.0",
-    "phpstan/phpstan-doctrine": "^1.0",
-    "phpstan/phpstan-nette": "^1.0",
-    "phpstan/phpstan-strict-rules": "^1.1",
-    "tracy/tracy": "^2.9"
+    "contributte/translation" : "^0.9",
+    "fastybird/web-server" : "^0.8",
+    "mockery/mockery" : "^1.4",
+    "ninjify/nunjuck" : "^0.3",
+    "orisai/coding-standard" : "^3.2",
+    "pds/skeleton" : "^1.0",
+    "php-parallel-lint/php-parallel-lint" : "^1.3",
+    "phpstan/extension-installer" : "^1.1",
+    "phpstan/phpstan" : "^1.3",
+    "phpstan/phpstan-deprecation-rules" : "^1.0",
+    "phpstan/phpstan-doctrine" : "^1.0",
+    "phpstan/phpstan-nette" : "^1.0",
+    "phpstan/phpstan-strict-rules" : "^1.1",
+    "tracy/tracy" : "^2.9"
   },
 
   "suggest" : {
@@ -93,10 +94,10 @@
 
   "config" : {
     "sort-packages" : true,
-    "allow-plugins": {
-      "dealerdirect/phpcodesniffer-composer-installer": true,
-      "cweagans/composer-patches": true,
-      "phpstan/extension-installer": true
+    "allow-plugins" : {
+      "dealerdirect/phpcodesniffer-composer-installer" : true,
+      "cweagans/composer-patches" : true,
+      "phpstan/extension-installer" : true
     }
   },
 

composer.json

@@ -0,0 +1,27 @@
+<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="./vendor/squizlabs/php_codesniffer/phpcs.xsd">
+    <!-- Show only relevant part of path -->
+    <arg name="basepath" value="./"/>
+
+    <!-- Import coding-standard -->
+    <rule ref="./vendor/orisai/coding-standard/src/ruleset-8.1.xml">
+        <exclude name="SlevomatCodingStandard.Commenting.ForbiddenAnnotations.AnnotationForbidden"/>
+
+        <exclude name="SlevomatCodingStandard.Commenting.DocCommentSpacing.IncorrectLinesCountBetweenDifferentAnnotationsTypes"/>
+        <exclude name="SlevomatCodingStandard.Commenting.DocCommentSpacing.IncorrectAnnotationsGroup"/>
+    </rule>
+
+    <!-- Configure PSR-4 rule -->
+    <rule ref="SlevomatCodingStandard.Files.TypeNameMatchesFileName">
+        <properties>
+            <property name="rootNamespaces" type="array">
+                <element key="src" value="FastyBird\JsonApi"/>
+                <element key="tests/cases/unit" value="Tests\Cases\Unit"/>
+                <element key="tests/tools" value="Tests\Tools"/>
+            </property>
+        </properties>
+    </rule>
+
+    <!--Exclude folders -->
+    <exclude-pattern>/tests/tmp</exclude-pattern>
+    <exclude-pattern>/tests/stubs/*</exclude-pattern>
+</ruleset>

phpcs.xml

@@ -1,10 +1,10 @@
 parameters:
     level: max
     stubFiles:
-        - tests/PHPStan/stubs/Neomerx/JsonApi/Contracts/Factories/FactoryInterface.php
-        - tests/PHPStan/stubs/Neomerx/JsonApi/Contracts/Schema/ContextInterface.php
-        - tests/PHPStan/stubs/Neomerx/JsonApi/Contracts/Schema/LinkInterface.php
-        - tests/PHPStan/stubs/Neomerx/JsonApi/Contracts/Schema/SchemaContainerInterface.php
-        - tests/PHPStan/stubs/Neomerx/JsonApi/Contracts/Schema/SchemaInterface.php
-        - tests/PHPStan/stubs/Neomerx/JsonApi/Factories/Factory.php
+        - tests/stubs/Neomerx/JsonApi/Contracts/Factories/FactoryInterface.stub
+        - tests/stubs/Neomerx/JsonApi/Contracts/Schema/ContextInterface.stub
+        - tests/stubs/Neomerx/JsonApi/Contracts/Schema/LinkInterface.stub
+        - tests/stubs/Neomerx/JsonApi/Contracts/Schema/SchemaContainerInterface.stub
+        - tests/stubs/Neomerx/JsonApi/Contracts/Schema/SchemaInterface.stub
+        - tests/stubs/Neomerx/JsonApi/Factories/Factory.stub
     checkGenericClassInNonGenericObjectType: false