#248: Added PHP CS Fixer to build plan

Author: raymondschouten

.github/workflows/build.yaml

@@ -38,6 +38,21 @@ jobs:
       - name: 'PHPStan'
         run: 'vendor/bin/phpstan analyze --no-progress --ansi'
 
+  php-cs-fixer:
+    name: 'PHP CS Fixer'
+    runs-on: 'ubuntu-24.04'
+    steps:
+      - name: 'Checkout'
+        uses: 'actions/checkout@v4'
+      - name: 'Setup PHP'
+        uses: 'shivammathur/setup-php@v2'
+        with:
+          php-version: '8.0'
+      - name: 'Composer Install'
+        uses: 'ramsey/composer-install@v3'
+      - name: 'PHP CS Fixer'
+        run: 'vendor/bin/php-cs-fixer fix --diff --dry-run --show-progress=none --ansi'
+
   phpunit:
     name: 'PHPUnit'
     runs-on: 'ubuntu-24.04'

.gitignore

@@ -1,4 +1,5 @@
 /.idea/
+/.php-cs-fixer.cache
 /.phpunit.cache/
 /composer.lock
 /vendor/

.php-cs-fixer.dist.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+$finder = (new PhpCsFixer\Finder())
+    ->in(__DIR__);
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PhpCsFixer' => true,
+        '@PSR1' => true,
+        '@PSR2' => true,
+        '@PSR12' => true,
+        '@Symfony' => true,
+        'concat_space' => ['spacing' => 'one'], // overrules @Symfony
+        'global_namespace_import' => ['import_classes' => false],
+        'multiline_whitespace_before_semicolons' => ['strategy' => 'no_multi_line'], // overrules @PhpCsFixer
+        'no_superfluous_elseif' => false, // overrules @PhpCsFixer
+        'phpdoc_align' => ['tags' => ['method', 'param', 'property', 'return', 'throws', 'type', 'var'], 'align' => 'left'], // overrules @Symfony
+        'yoda_style' => false, // overrules @Symfony
+    ])
+    ->setFinder($finder);

README.md

@@ -4,7 +4,7 @@
 [![Total Downloads](https://poser.pugx.org/darkwebdesign/symfony-addon-transformers/downloads?format=flat)](https://packagist.org/packages/darkwebdesign/symfony-addon-transformers)
 [![License](https://poser.pugx.org/darkwebdesign/symfony-addon-transformers/license?format=flat)](https://packagist.org/packages/darkwebdesign/symfony-addon-transformers)
 
-[![Build Status](https://app.travis-ci.com/darkwebdesign/symfony-addon-transformers.svg?branch=6.0)](https://app.travis-ci.com/darkwebdesign/symfony-addon-transformers)
+[![Build Status](https://github.com/darkwebdesign/symfony-addon-transformers/actions/workflows/build.yaml/badge.svg?branch=6.0)](https://github.com/darkwebdesign/symfony-addon-transformers/actions/workflows/build.yaml)
 [![Coverage Status](https://codecov.io/gh/darkwebdesign/symfony-addon-transformers/branch/6.0/graph/badge.svg)](https://codecov.io/gh/darkwebdesign/symfony-addon-transformers)
 [![PHP Version](https://img.shields.io/badge/php-8.0%2B-777BB3.svg)](https://php.net/)
 [![Symfony Version](https://img.shields.io/badge/symfony-6.0-93C74B.svg)](https://symfony.com/)

composer.json

@@ -14,6 +14,7 @@
     },
     "require-dev": {
         "doctrine/orm": "^2.7",
+        "friendsofphp/php-cs-fixer": "^3.58",
         "phpstan/extension-installer": "^1.3",
         "phpstan/phpstan": "^1.11",
         "phpstan/phpstan-doctrine": "^1.4",

src/BooleanToValueTransformer.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2017 DarkWeb Design
+ * Copyright (c) 2017 DarkWeb Design.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -27,6 +27,7 @@
 
 /**
  * @template R of string|int|float|bool
+ *
  * @template-implements DataTransformerInterface<bool, R>
  *
  * @author Raymond Schouten

src/EntityToIdentifierTransformer.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2017 DarkWeb Design
+ * Copyright (c) 2017 DarkWeb Design.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -38,6 +38,7 @@
 /**
  * @template T of object
  * @template R of mixed
+ *
  * @template-implements DataTransformerInterface<T, R>
  *
  * @author Raymond Schouten
@@ -120,9 +121,7 @@ public function reverseTransform(mixed $value): ?object
         $entity = $this->repository->find($value);
 
         if (null === $entity) {
-            throw new TransformationFailedException(
-                sprintf('Entity %s with identifier "%s" not found.', $this->className, $value)
-            );
+            throw new TransformationFailedException(sprintf('Entity %s with identifier "%s" not found.', $this->className, $value));
         }
 
         return $entity;

tests/BooleanToValueTransformerTest.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2017 DarkWeb Design
+ * Copyright (c) 2017 DarkWeb Design.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -28,6 +28,8 @@
 
 /**
  * @covers \DarkWebDesign\SymfonyAddonTransformers\BooleanToValueTransformer
+ *
+ * @internal
  */
 class BooleanToValueTransformerTest extends TestCase
 {
@@ -155,7 +157,7 @@ public function providerNoBool(): array
             'float' => [1.2],
             'string' => ['foo'],
             'array' => [['foo', 'bar']],
-            'object' => [new \stdClass],
+            'object' => [new \stdClass()],
             'resource' => [tmpfile()],
             'callable' => [function () {}],
         ];
@@ -168,7 +170,7 @@ public function providerNoScalar(): array
     {
         return [
             'array' => [['foo', 'bar']],
-            'object' => [new \stdClass],
+            'object' => [new \stdClass()],
             'resource' => [tmpfile()],
             'callable' => [function () {}],
         ];

tests/EntityToIdentifierTransformerTest.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2017 DarkWeb Design
+ * Copyright (c) 2017 DarkWeb Design.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -35,6 +35,8 @@
 
 /**
  * @covers \DarkWebDesign\SymfonyAddonTransformers\EntityToIdentifierTransformer
+ *
+ * @internal
  */
 class EntityToIdentifierTransformerTest extends TestCase
 {

tests/Models/AbstractPerson.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2018 DarkWeb Design
+ * Copyright (c) 2018 DarkWeb Design.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal