#248: Added PHP CS Fixer to build plan

raymondschouten · raymondschouten · commit 0fba710a4aa4 · 2024-05-30T05:57:45.000Z
diff --git a/.github/workflows/build.yaml b/.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'
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 /.idea/
+/.php-cs-fixer.cache
 /.phpunit.cache/
 /composer.lock
 /vendor/
diff --git a/.php-cs-fixer.dist.php b/.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);
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 [![Total Downloads](https://poser.pugx.org/darkwebdesign/symfony-addon-form-types/downloads?format=flat)](https://packagist.org/packages/darkwebdesign/symfony-addon-form-types)
 [![License](https://poser.pugx.org/darkwebdesign/symfony-addon-form-types/license?format=flat)](https://packagist.org/packages/darkwebdesign/symfony-addon-form-types)
 
-[![Build Status](https://app.travis-ci.com/darkwebdesign/symfony-addon-form-types.svg?branch=6.0)](https://app.travis-ci.com/darkwebdesign/symfony-addon-form-types)
+[![Build Status](https://github.com/darkwebdesign/symfony-addon-form-types/actions/workflows/build.yaml/badge.svg?branch=6.0)](https://github.com/darkwebdesign/symfony-addon-form-types/actions/workflows/build.yaml)
 [![Coverage Status](https://codecov.io/gh/darkwebdesign/symfony-addon-form-types/branch/6.0/graph/badge.svg)](https://codecov.io/gh/darkwebdesign/symfony-addon-form-types)
 [![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/)
diff --git a/composer.json b/composer.json
@@ -17,6 +17,7 @@
     "require-dev": {
         "darkwebdesign/symfony-addon-transformers": "6.0.*",
         "doctrine/orm": "^2.7",
+        "friendsofphp/php-cs-fixer": "^3.58",
         "phpstan/extension-installer": "^1.3",
         "phpstan/phpstan": "^1.11",
         "phpstan/phpstan-doctrine": "^1.4",
diff --git a/src/BirthdayType.php b/src/BirthdayType.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
diff --git a/src/BooleanToYesNoSubscriber.php b/src/BooleanToYesNoSubscriber.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2021 DarkWeb Design
+ * Copyright (c) 2021 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
diff --git a/src/BooleanType.php b/src/BooleanType.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
@@ -47,20 +47,17 @@ public function buildForm(FormBuilderInterface $builder, array $options): void
 
     public function configureOptions(OptionsResolver $resolver): void
     {
-        $labelTrueNormalizer = fn(Options $options, $value) =>
-            !is_null($value) ? (string) $value : $this->humanize((string) $options['value_true']);
+        $labelTrueNormalizer = fn (Options $options, $value) => !is_null($value) ? (string) $value : $this->humanize((string) $options['value_true']);
+        $labelFalseNormalizer = fn (Options $options, $value) => !is_null($value) ? (string) $value : $this->humanize((string) $options['value_false']);
 
-        $labelFalseNormalizer = fn(Options $options, $value) =>
-            !is_null($value) ? (string) $value : $this->humanize((string) $options['value_false']);
-
-        $choicesNormalizer = fn(Options $options) => [
+        $choicesNormalizer = fn (Options $options) => [
             $options['label_true'] => $options['value_true'],
             $options['label_false'] => $options['value_false'],
         ];
 
-        $expandedNormalizer = fn(Options $options) => 'choice' !== $options['widget'];
+        $expandedNormalizer = fn (Options $options) => 'choice' !== $options['widget'];
 
-        $multipleNormalizer = fn() => false;
+        $multipleNormalizer = fn () => false;
 
         $resolver->setDefaults([
             'label_true' => null,
diff --git a/src/EntityType.php b/src/EntityType.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
@@ -78,16 +78,13 @@ public function configureOptions(OptionsResolver $resolver): void
             $entityManager = $registry->getManagerForClass($options['class']);
 
             if (null === $entityManager) {
-                throw new RuntimeException(sprintf(
-                    'Class "%s" seems not to be a managed Doctrine entity. Did you forget to map it?',
-                    $options['class']
-                ));
+                throw new RuntimeException(sprintf('Class "%s" seems not to be a managed Doctrine entity. Did you forget to map it?', $options['class']));
             }
 
             return $entityManager;
         };
 
-        $compoundNormalizer = fn() => false;
+        $compoundNormalizer = fn () => false;
 
         $resolver->setDefaults([
             'entity_manager' => null,
diff --git a/src/JsonSchemaSubscriber.php b/src/JsonSchemaSubscriber.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2021 DarkWeb Design
+ * Copyright (c) 2021 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
diff --git a/src/UnstructuredType.php b/src/UnstructuredType.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2019 DarkWeb Design
+ * Copyright (c) 2019 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
@@ -34,9 +34,9 @@ class UnstructuredType extends AbstractType
 {
     public function configureOptions(OptionsResolver $resolver): void
     {
-        $compoundNormalizer = fn() => false;
+        $compoundNormalizer = fn () => false;
 
-        $multipleNormalizer = fn() => true;
+        $multipleNormalizer = fn () => true;
 
         $resolver->setDefaults([
             'multiple' => true,
diff --git a/tests/BirthdayTypeTest.php b/tests/BirthdayTypeTest.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,8 @@
 
 /**
  * @covers \DarkWebDesign\SymfonyAddonFormTypes\BirthdayType
+ *
+ * @internal
  */
 class BirthdayTypeTest extends TypeTestCase
 {
@@ -38,6 +40,6 @@ public function test(): void
 
         $this->assertCount(121, $choices);
         $this->assertSame((int) date('Y'), reset($choices));
-        $this->assertSame((date('Y') - 120), end($choices));
+        $this->assertSame(date('Y') - 120, end($choices));
     }
 }
diff --git a/tests/BooleanToYesNoSubscriberTest.php b/tests/BooleanToYesNoSubscriberTest.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2021 DarkWeb Design
+ * Copyright (c) 2021 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
@@ -31,6 +31,8 @@
  *
  * @uses \DarkWebDesign\SymfonyAddonFormTypes\BooleanType
  * @uses \DarkWebDesign\SymfonyAddonTransformers\BooleanToValueTransformer
+ *
+ * @internal
  */
 class BooleanToYesNoSubscriberTest extends TypeTestCase
 {
diff --git a/tests/BooleanTypeTest.php b/tests/BooleanTypeTest.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
@@ -29,6 +29,8 @@
  * @covers \DarkWebDesign\SymfonyAddonFormTypes\BooleanType
  *
  * @uses \DarkWebDesign\SymfonyAddonTransformers\BooleanToValueTransformer
+ *
+ * @internal
  */
 class BooleanTypeTest extends TypeTestCase
 {
diff --git a/tests/EntityTypeTest.php b/tests/EntityTypeTest.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
@@ -24,11 +24,11 @@
 
 use DarkWebDesign\SymfonyAddonFormTypes\EntityType;
 use DarkWebDesign\SymfonyAddonFormTypes\Tests\Models\City;
+use Doctrine\ORM\EntityManager;
 use Doctrine\Persistence\ManagerRegistry;
 use Doctrine\Persistence\Mapping\ClassMetadata;
 use Doctrine\Persistence\ObjectManager;
 use Doctrine\Persistence\ObjectRepository;
-use Doctrine\ORM\EntityManager;
 use PHPUnit\Framework\MockObject\MockObject;
 use Symfony\Component\Form\Exception\RuntimeException;
 use Symfony\Component\Form\FormExtensionInterface;
@@ -39,6 +39,8 @@
  * @covers \DarkWebDesign\SymfonyAddonFormTypes\EntityType
  *
  * @uses \DarkWebDesign\SymfonyAddonTransformers\EntityToIdentifierTransformer
+ *
+ * @internal
  */
 class EntityTypeTest extends TypeTestCase
 {
diff --git a/tests/JsonSchemaSubscriberTest.php b/tests/JsonSchemaSubscriberTest.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2021 DarkWeb Design
+ * Copyright (c) 2021 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\SymfonyAddonFormTypes\JsonSchemaSubscriber
+ *
+ * @internal
  */
 class JsonSchemaSubscriberTest extends TypeTestCase
 {
diff --git a/tests/Models/City.php b/tests/Models/City.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
diff --git a/tests/UnstructuredTypeTest.php b/tests/UnstructuredTypeTest.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2019 DarkWeb Design
+ * Copyright (c) 2019 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,8 @@
 
 /**
  * @covers \DarkWebDesign\SymfonyAddonFormTypes\UnstructuredType
+ *
+ * @internal
  */
 class UnstructuredTypeTest extends TypeTestCase
 {

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`<?php`
`2`	`2`	`/**`
`3`		`- * Copyright (c) 2017 DarkWeb Design`
	`3`	`+ * Copyright (c) 2017 DarkWeb Design.`
`4`	`4`	`*`
`5`	`5`	`* Permission is hereby granted, free of charge, to any person obtaining a copy`
`6`	`6`	`* of this software and associated documentation files (the "Software"), to deal`