#248: Added PHP CS Fixer to build plan

raymondschouten · raymondschouten · commit 33fef7064bd9 · 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-constraints/downloads?format=flat)](https://packagist.org/packages/darkwebdesign/symfony-addon-constraints)
 [![License](https://poser.pugx.org/darkwebdesign/symfony-addon-constraints/license?format=flat)](https://packagist.org/packages/darkwebdesign/symfony-addon-constraints)
 
-[![Build Status](https://app.travis-ci.com/darkwebdesign/symfony-addon-constraints.svg?branch=6.0)](https://app.travis-ci.com/darkwebdesign/symfony-addon-constraints)
+[![Build Status](https://github.com/darkwebdesign/symfony-addon-constraints/actions/workflows/build.yaml/badge.svg?branch=6.0)](https://github.com/darkwebdesign/symfony-addon-constraints/actions/workflows/build.yaml)
 [![Coverage Status](https://codecov.io/gh/darkwebdesign/symfony-addon-constraints/branch/6.0/graph/badge.svg)](https://codecov.io/gh/darkwebdesign/symfony-addon-constraints)
 [![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
@@ -14,6 +14,7 @@
         "symfony/validator": "6.0.*"
     },
     "require-dev": {
+        "friendsofphp/php-cs-fixer": "^3.58",
         "phpstan/extension-installer": "^1.3",
         "phpstan/phpstan": "^1.11",
         "phpstan/phpstan-phpunit": "^1.4",
diff --git a/src/Bsn.php b/src/Bsn.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
@@ -26,7 +26,6 @@
 
 /**
  * @Annotation
- *
  * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
  *
  * @author Raymond Schouten
diff --git a/src/BsnValidator.php b/src/BsnValidator.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/Collection.php b/src/Collection.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,7 +28,6 @@
 
 /**
  * @Annotation
- *
  * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
  *
  * @author Raymond Schouten
@@ -46,19 +45,11 @@ public function __construct(mixed $options = null)
 
         foreach ($this->constraints as $constraint) {
             if (!$constraint instanceof Constraint) {
-                throw new ConstraintDefinitionException(
-                    sprintf('The value %s is not an instance of Constraint in constraint %s', $constraint, self::class)
-                );
+                throw new ConstraintDefinitionException(sprintf('The value %s is not an instance of Constraint in constraint %s', $constraint, self::class));
             }
 
             if ($constraint instanceof Valid) {
-                throw new ConstraintDefinitionException(
-                    sprintf(
-                        'The constraint Valid cannot be nested inside constraint %s. ' .
-                        'You can only declare the Valid constraint directly on a field or method.',
-                        self::class
-                    )
-                );
+                throw new ConstraintDefinitionException(sprintf('The constraint Valid cannot be nested inside constraint %s. You can only declare the Valid constraint directly on a field or method.', self::class));
             }
         }
     }
diff --git a/src/CollectionValidator.php b/src/CollectionValidator.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/Json.php b/src/Json.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
@@ -26,7 +26,6 @@
 
 /**
  * @Annotation
- *
  * @Target({"PROPERTY", "METHOD", "ANNOTATION"})
  *
  * @author Raymond Schouten
diff --git a/src/JsonValidator.php b/src/JsonValidator.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/tests/BsnValidatorTest.php b/tests/BsnValidatorTest.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
@@ -31,6 +31,8 @@
 
 /**
  * @covers \DarkWebDesign\SymfonyAddonConstraints\BsnValidator
+ *
+ * @internal
  */
 class BsnValidatorTest extends ConstraintValidatorTestCase
 {
diff --git a/tests/CollectionTest.php b/tests/CollectionTest.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
@@ -30,6 +30,8 @@
 
 /**
  * @covers \DarkWebDesign\SymfonyAddonConstraints\Collection
+ *
+ * @internal
  */
 class CollectionTest extends TestCase
 {
diff --git a/tests/CollectionValidatorTest.php b/tests/CollectionValidatorTest.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
@@ -33,6 +33,8 @@
  * @covers \DarkWebDesign\SymfonyAddonConstraints\CollectionValidator
  *
  * @uses \DarkWebDesign\SymfonyAddonConstraints\Collection
+ *
+ * @internal
  */
 class CollectionValidatorTest extends ConstraintValidatorTestCase
 {
diff --git a/tests/JsonValidatorTest.php b/tests/JsonValidatorTest.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
@@ -31,6 +31,8 @@
 
 /**
  * @covers \DarkWebDesign\SymfonyAddonConstraints\JsonValidator
+ *
+ * @internal
  */
 class JsonValidatorTest extends ConstraintValidatorTestCase
 {
diff --git a/tests/Models/ToStringObject.php b/tests/Models/ToStringObject.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/tests/Models/TraversableObject.php b/tests/Models/TraversableObject.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
@@ -25,6 +25,7 @@
 /**
  * @template TKey of array-key
  * @template TValue
+ *
  * @template-implements \IteratorAggregate<TKey, TValue>
  */
 class TraversableObject implements \IteratorAggregate

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`
`@@ -26,7 +26,6 @@`
`26`	`26`
`27`	`27`	`/**`
`28`	`28`	`* @Annotation`
`29`		`- *`
`30`	`29`	`* @Target({"PROPERTY", "METHOD", "ANNOTATION"})`
`31`	`30`	`*`
`32`	`31`	`* @author Raymond Schouten`