Aktualisiere auf PHP-CS-Fixer 2.19.0, angepasste Konfiguration und automatische Commits (Case 130695) (#11)

* Aktualisiere auf PHP-CS-Fixer 2.19.0, angepasste Konfiguration und automatische Commits (Case 130695)

* Fix CS with PHP-CS-Fixer 2.19.0

Co-authored-by: mpdude <mpdude@users.noreply.github.com>

Author: mpdude

.github/workflows/fix-cs-php.yml

@@ -12,39 +12,18 @@ name: Coding Standards
 jobs:
     open-pr-for-cs-violations:
         name: PHP-CS-Fixer
-        runs-on: ubuntu-18.04
+        runs-on: ubuntu-20.04
+        if: github.actor != 'dependabot[bot]'
         steps:
-
             -   name: Checkout code
                 uses: actions/checkout@v2
                 with:
                     ref: ${{ github.head_ref }}
 
             -   name: Run PHP-CS-Fixer
-                uses: docker://oskarstark/php-cs-fixer-ga:2.16.7
-
-            -   name: Create PR for CS fixups
-                uses: peter-evans/create-pull-request@v3.8.2
-                id: create-pull-request
-                with:
-                    token: ${{ secrets.GITHUB_TOKEN }}
-                    title: Fix coding standards in ${{ github.ref }}
-                    branch: php-cs-fixer/${{ github.ref }}
-                    assignees: ${{ github.actor }}
-                    labels: php-cs-fixer
-                    body: Please merge these changes into the ${{ github.ref }} branch to fix coding standard violations.
-                    commit-message: Apply php-cs-fixer changes as of ${{ github.sha }}
+                uses: docker://oskarstark/php-cs-fixer-ga:2.19.0
 
-            -   name: Leave a notice in the discussion when fixing code in a Pull Request
-                uses: docker://mpdude/comment-on-pr:v1.2.0
-                env:
-                    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-                if: steps.create-pull-request.outputs.pr_number # only if PR was created in the previous step
-                continue-on-error: true # continue on failure - necessary when the current branch does not have a pending PR
+            -   name: Commit and push back changes
+                uses: stefanzweifel/git-auto-commit-action@v4
                 with:
-                    msg: |
-                        @${{ github.actor }} please apply the coding standard fixes from #${{ steps.create-pull-request.outputs.pr_number }}
-
-            -   name: Fail the workflow when necessary CS fixes were detected
-                run: echo "Failing workflow run because CS violations were detected." && exit 1
-                if: steps.create-pull-request.outputs.pr_number
+                    commit_message: "Fix CS with PHP-CS-Fixer 2.19.0"

.php_cs.dist

@@ -9,6 +9,9 @@ return PhpCsFixer\Config::create()
         'braces' => array('allow_single_line_closure' => true),
         'heredoc_to_nowdoc' => false,
         'phpdoc_annotation_without_dot' => false,
+        'php_unit_test_annotation' => false,
+        'php_unit_method_casing' => false,
+        'global_namespace_import' => ['import_classes' => true, 'import_constants' => false, 'import_functions' => false],
     ])
     ->setRiskyAllowed(true)
     ->setFinder(

src/Doctrine/PersistentTranslatable.php

@@ -10,6 +10,7 @@
 namespace Webfactory\Bundle\PolyglotBundle\Doctrine;
 
 use Doctrine\Common\Collections\Criteria;
+use Exception;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 use ReflectionClass;
@@ -220,7 +221,7 @@ public function translate($locale = null)
             }
 
             return $this->primaryValue;
-        } catch (\Exception $e) {
+        } catch (Exception $e) {
             $message = sprintf(
                 'Cannot translate property %s::%s into locale %s',
                 \get_class($this->entity),
@@ -249,7 +250,7 @@ public function __toString()
     {
         try {
             return (string) $this->translate();
-        } catch (\Exception $e) {
+        } catch (Exception $e) {
             $this->logger->error($this->stringifyException($e));
 
             return '';
@@ -332,12 +333,12 @@ protected function getCachedTranslation($locale)
     /**
      * @return string
      */
-    private function stringifyException(\Exception $e)
+    private function stringifyException(Exception $e)
     {
         $exceptionAsString = '';
         while (null !== $e) {
             if (!empty($exceptionAsString)) {
-                $exceptionAsString .= PHP_EOL.'Previous exception: '.PHP_EOL;
+                $exceptionAsString .= \PHP_EOL.'Previous exception: '.\PHP_EOL;
             }
             $exceptionAsString .= sprintf(
                 "Exception '%s' with message '%s' in %s:%d\n%s",

src/Doctrine/PolyglotListener.php

@@ -16,6 +16,7 @@
 use Doctrine\ORM\Event\PreFlushEventArgs;
 use Doctrine\ORM\Mapping\ClassMetadataInfo;
 use Psr\Log\LoggerInterface;
+use SplObjectStorage;
 use Webfactory\Bundle\PolyglotBundle\Locale\DefaultLocaleProvider;
 
 class PolyglotListener
@@ -27,7 +28,7 @@ class PolyglotListener
     protected $_proxiesStripped = [];
     protected $defaultLocaleProvider;
 
-    /** @var \SplObjectStorage */
+    /** @var SplObjectStorage */
     private $entitiesWithTranslations;
 
     /**
@@ -47,7 +48,7 @@ public function __construct(
         $this->defaultLocaleProvider = $defaultLocaleProvider;
         $this->logger = $logger;
 
-        $this->entitiesWithTranslations = new \SplObjectStorage();
+        $this->entitiesWithTranslations = new SplObjectStorage();
     }
 
     public function postLoad(LifecycleEventArgs $event)

src/Doctrine/TranslatableClassMetadata.php

@@ -16,6 +16,9 @@
 use Doctrine\Persistence\Mapping\ClassMetadata;
 use Doctrine\Persistence\Mapping\ReflectionService;
 use Psr\Log\LoggerInterface;
+use ReflectionClass;
+use ReflectionProperty;
+use RuntimeException;
 use Webfactory\Bundle\PolyglotBundle\Annotation as Annotation;
 use Webfactory\Bundle\PolyglotBundle\Locale\DefaultLocaleProvider;
 use Webfactory\Bundle\PolyglotBundle\Translatable;
@@ -32,40 +35,40 @@ class TranslatableClassMetadata
      * Ein Mapping von Feldnamen in der Hauptklasse auf die Felder in der
      * Übersetzungs-Klasse, in denen die jeweilige Übersetzung liegt.
      *
-     * @var \ReflectionProperty[]
+     * @var ReflectionProperty[]
      */
     protected $translationFieldMapping = [];
 
     /**
      * Die Eigenschaften der Haupt-Klasse, die übersetzbar sind; indiziert nach Feldnamen.
      *
-     * @var \ReflectionProperty[]
+     * @var ReflectionProperty[]
      */
     protected $translatedProperties = [];
 
     /**
      * Die Eigenschaft der Haupt-Klasse, die die Collection der Übersetzungen hält.
      *
-     * @var \ReflectionProperty
+     * @var ReflectionProperty
      */
     protected $translationsCollectionProperty;
 
     /**
      * Die Eigenschaft der Übersetzungs-Klasse, die als many-to-one auf die Haupt-Klasse verweist.
      *
-     * @var \ReflectionProperty
+     * @var ReflectionProperty
      */
     protected $translationMappingProperty;
 
     /**
      * Die Eigenschaft in der Übersetzungs-Klasse, die die Sprache einer Übersetzungsinstanz enhtält.
      *
-     * @var \ReflectionProperty
+     * @var ReflectionProperty
      */
     protected $translationLocaleProperty;
 
     /**
-     * @var \ReflectionClass Die Übersetzungs-Klasse.
+     * @var ReflectionClass Die Übersetzungs-Klasse.
      */
     protected $translationClass;
 
@@ -148,19 +151,19 @@ protected function assertNoAnnotationsArePresent()
     protected function assertAnnotationsAreComplete()
     {
         if (null === $this->translationClass) {
-            throw new \RuntimeException('The annotation with the translation class name is missing or incorrect, e.g. '.'@ORM\OneToMany(targetEntity="TestEntityTranslation", ...)');
+            throw new RuntimeException('The annotation with the translation class name is missing or incorrect, e.g. '.'@ORM\OneToMany(targetEntity="TestEntityTranslation", ...)');
         }
 
         if (null === $this->translationLocaleProperty) {
-            throw new \RuntimeException('The @Polyglot\Locale annotation at the language property of the translation class is missing or '.'incorrect');
+            throw new RuntimeException('The @Polyglot\Locale annotation at the language property of the translation class is missing or '.'incorrect');
         }
 
         if (null === $this->translationMappingProperty) {
-            throw new \RuntimeException('The attribute referenced in the mappedBy-Attribute of the @ORM\OneToMany(..., mappedBy="...") is '.'missing or incorrect');
+            throw new RuntimeException('The attribute referenced in the mappedBy-Attribute of the @ORM\OneToMany(..., mappedBy="...") is '.'missing or incorrect');
         }
 
         if (0 === \count($this->translatedProperties)) {
-            throw new \RuntimeException('No translatable attributes annotated with @Polyglot\Translatable were found');
+            throw new RuntimeException('No translatable attributes annotated with @Polyglot\Translatable were found');
         }
     }
 
@@ -221,7 +224,7 @@ protected function findPrimaryLocale(Reader $reader, ClassMetadata $classMetadat
 
     protected function parseTranslationsEntity(Reader $reader, $class)
     {
-        $this->translationClass = new \ReflectionClass($class);
+        $this->translationClass = new ReflectionClass($class);
 
         foreach ($this->translationClass->getProperties() as $property) {
             $annotation = $reader->getPropertyAnnotation(

src/Exception/TranslationException.php

@@ -2,14 +2,16 @@
 
 namespace Webfactory\Bundle\PolyglotBundle\Exception;
 
-class TranslationException extends \Exception
+use Exception;
+
+class TranslationException extends Exception
 {
     /**
      * TranslationException constructor.
      *
      * @param string $message
      */
-    public function __construct($message, \Exception $previous)
+    public function __construct($message, Exception $previous)
     {
         parent::__construct($message, 0, $previous);
     }

src/Translatable.php

@@ -9,6 +9,7 @@
 
 namespace Webfactory\Bundle\PolyglotBundle;
 
+use InvalidArgumentException;
 use Webfactory\Bundle\PolyglotBundle\Locale\DefaultLocaleProvider;
 
 /**
@@ -58,7 +59,7 @@ class Translatable implements TranslatableInterface
     public function __construct($value = null, $defaultLocale = null)
     {
         if (null !== $defaultLocale && !\is_string($defaultLocale) && !$defaultLocale instanceof DefaultLocaleProvider) {
-            throw new \InvalidArgumentException('When provided, the $defaultLocale argument must either be a string or an instance of DefaultLocaleProvider');
+            throw new InvalidArgumentException('When provided, the $defaultLocale argument must either be a string or an instance of DefaultLocaleProvider');
         }
 
         $this->defaultLocale = $defaultLocale;

tests/Doctrine/PersistentTranslatableTest.php

@@ -2,14 +2,18 @@
 
 namespace Webfactory\Bundle\PolyglotBundle\Tests\Doctrine;
 
+use PHPUnit_Framework_TestCase;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
+use ReflectionClass;
+use ReflectionProperty;
+use RuntimeException;
 use Symfony\Component\ErrorHandler\BufferingLogger;
 use Webfactory\Bundle\PolyglotBundle\Doctrine\PersistentTranslatable;
 use Webfactory\Bundle\PolyglotBundle\Locale\DefaultLocaleProvider;
 use Webfactory\Bundle\PolyglotBundle\Tests\TestEntity;
 
-class PersistentTranslatableTest extends \PHPUnit_Framework_TestCase
+class PersistentTranslatableTest extends PHPUnit_Framework_TestCase
 {
     public function testToStringReturnsTranslatedMessage()
     {
@@ -155,11 +159,11 @@ private function createProxy(TestEntity $entity, LoggerInterface $logger = null)
             $entity,
             'en',
             $localeProvider,
-            $this->makeAccessible(new \ReflectionProperty($translationClass, 'text')),
-            $this->makeAccessible(new \ReflectionProperty($entity, 'translations')),
-            new \ReflectionClass($translationClass),
-            $this->makeAccessible(new \ReflectionProperty($translationClass, 'locale')),
-            $this->makeAccessible(new \ReflectionProperty($translationClass, 'entity')),
+            $this->makeAccessible(new ReflectionProperty($translationClass, 'text')),
+            $this->makeAccessible(new ReflectionProperty($entity, 'translations')),
+            new ReflectionClass($translationClass),
+            $this->makeAccessible(new ReflectionProperty($translationClass, 'locale')),
+            $this->makeAccessible(new ReflectionProperty($translationClass, 'entity')),
             $logger
         );
 
@@ -171,16 +175,16 @@ private function breakEntity(TestEntity $entity)
         $brokenCollection = $this->getMockBuilder('Doctrine\Common\Collections\ArrayCollection')->getMock();
         $brokenCollection->expects($this->any())
             ->method('matching')
-            ->will($this->throwException(new \RuntimeException('Cannot find translations')));
-        $property = new \ReflectionProperty($entity, 'translations');
+            ->will($this->throwException(new RuntimeException('Cannot find translations')));
+        $property = new ReflectionProperty($entity, 'translations');
         $property->setAccessible(true);
         $property->setValue($entity, $brokenCollection);
     }
 
     /**
-     * @return \ReflectionProperty
+     * @return ReflectionProperty
      */
-    private function makeAccessible(\ReflectionProperty $property)
+    private function makeAccessible(ReflectionProperty $property)
     {
         $property->setAccessible(true);
 

tests/Doctrine/TranslatableClassMetadataTest.php

@@ -4,13 +4,14 @@
 
 use Doctrine\Common\Annotations\AnnotationReader;
 use Doctrine\Persistence\Mapping\RuntimeReflectionService;
+use PHPUnit_Framework_TestCase;
 use Psr\Log\LoggerInterface;
 use Webfactory\Bundle\PolyglotBundle\Doctrine\TranslatableClassMetadata;
 use Webfactory\Bundle\PolyglotBundle\Tests\TestEntity;
 use Webfactory\Bundle\PolyglotBundle\Tests\TestEntityTranslation;
 use Webfactory\Doctrine\ORMTestInfrastructure\ORMInfrastructure;
 
-class TranslatableClassMetadataTest extends \PHPUnit_Framework_TestCase
+class TranslatableClassMetadataTest extends PHPUnit_Framework_TestCase
 {
     /**
      * @test

tests/IntegrationTest.php

@@ -4,6 +4,7 @@
 
 use Doctrine\Common\Annotations\AnnotationReader;
 use Doctrine\ORM\EntityManagerInterface;
+use PHPUnit_Framework_TestCase;
 use Webfactory\Bundle\PolyglotBundle\Doctrine\PolyglotListener;
 use Webfactory\Bundle\PolyglotBundle\Locale\DefaultLocaleProvider;
 use Webfactory\Bundle\PolyglotBundle\Tests\TestEntity;
@@ -12,7 +13,7 @@
 use Webfactory\Bundle\PolyglotBundle\TranslatableInterface;
 use Webfactory\Doctrine\ORMTestInfrastructure\ORMInfrastructure;
 
-class IntegrationTest extends \PHPUnit_Framework_TestCase
+class IntegrationTest extends PHPUnit_Framework_TestCase
 {
     /** @var ORMInfrastructure */
     private $infrastructure;