Update php-cs-fixer and its config and fix the codebase

.gitignore

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

.php-cs-fixer.php

@@ -0,0 +1,39 @@
+<?php
+
+/*
+ * This file is part of JoliTypo - a project by JoliCode.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the MIT license.
+ */
+
+$fileHeaderComment = <<<'EOF'
+    This file is part of JoliTypo - a project by JoliCode.
+
+    This software consists of voluntary contributions made by many individuals
+    and is licensed under the MIT license.
+    EOF;
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__)
+    ->notPath('src/JoliTypo/Bridge/Symfony/DependencyInjection/Configuration.php')
+    ->append([
+        __FILE__,
+    ])
+;
+
+return (new PhpCsFixer\Config())
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@Symfony' => true,
+        '@Symfony:risky' => true,
+        '@PHP74Migration' => true,
+        '@PhpCsFixer' => true,
+        'php_unit_internal_class' => false, // From @PhpCsFixer but we don't want it
+        'php_unit_test_class_requires_covers' => false, // From @PhpCsFixer but we don't want it
+        'phpdoc_add_missing_param_annotation' => false, // From @PhpCsFixer but we don't want it
+        'header_comment' => ['header' => $fileHeaderComment],
+        'concat_space' => ['spacing' => 'one'],
+    ])
+    ->setFinder($finder)
+;

composer.json

@@ -19,7 +19,7 @@
         "org_heigl/hyphenator": "~2.6.0"
     },
     "require-dev": {
-        "friendsofphp/php-cs-fixer": "^2",
+        "friendsofphp/php-cs-fixer": "^3.3.2",
         "symfony/phpunit-bridge": "^5.0",
         "symfony/framework-bundle": "^3.4.26|^4.1.12|^5.0",
         "symfony/twig-bundle": "^3.4.26|^4.1.12|^5.0",

src/JoliTypo/Fixer.php

@@ -18,32 +18,31 @@ class Fixer
      * DOMDocument does not like all the HTML entities; sometimes they are double encoded.
      * So the entities here are plain utf8 and DOCDocument::saveHTML transform them to entity.
      */
-    const NO_BREAK_THIN_SPACE = "\xE2\x80\xAF"; //  
-    const NO_BREAK_SPACE = "\xC2\xA0"; //  
-    const ELLIPSIS = '…';
-    const LAQUO = '«'; // «
-    const RAQUO = '»'; // »
-    const RSQUO = '’'; // ’
-    const TIMES = '×'; // ×
-    const NDASH = '–'; // – or –
-    const MDASH = '—'; // — or —
-    const LDQUO = '“'; // “ or “
-    const RDQUO = '”'; // ” or ”
-    const BDQUO = '„'; // „ or „
-    const SHY = "\xC2\xAD"; // ­
-    const TRADE = '™'; // ™
-    const REG = '®'; // ®
-    const COPY = '©'; // ©
-    const ALL_SPACES = "\xE2\x80\xAF|\xC2\xAD|\xC2\xA0|\\s"; // All supported spaces, used in regexps. Better than \s
-
-    const RECOMMENDED_RULES_BY_LOCALE = [
+    public const NO_BREAK_THIN_SPACE = "\xE2\x80\xAF"; //  
+    public const NO_BREAK_SPACE = "\xC2\xA0"; //  
+    public const ELLIPSIS = '…';
+    public const LAQUO = '«'; // «
+    public const RAQUO = '»'; // »
+    public const RSQUO = '’'; // ’
+    public const TIMES = '×'; // ×
+    public const NDASH = '–'; // – or –
+    public const MDASH = '—'; // — or —
+    public const LDQUO = '“'; // “ or “
+    public const RDQUO = '”'; // ” or ”
+    public const BDQUO = '„'; // „ or „
+    public const SHY = "\xC2\xAD"; // ­
+    public const TRADE = '™'; // ™
+    public const REG = '®'; // ®
+    public const COPY = '©'; // ©
+    public const ALL_SPACES = "\xE2\x80\xAF|\xC2\xAD|\xC2\xA0|\\s"; // All supported spaces, used in regexps. Better than \s
+
+    public const RECOMMENDED_RULES_BY_LOCALE = [
         'en_GB' => ['Ellipsis', 'Dimension', 'Unit', 'Dash', 'SmartQuotes', 'NoSpaceBeforeComma', 'CurlyQuote', 'Hyphen', 'Trademark'],
         'fr_FR' => ['Ellipsis', 'Dimension', 'Unit', 'Dash', 'SmartQuotes', 'FrenchNoBreakSpace', 'NoSpaceBeforeComma', 'CurlyQuote', 'Hyphen', 'Trademark'],
         'fr_CA' => ['Ellipsis', 'Dimension', 'Unit', 'Dash', 'SmartQuotes', 'NoSpaceBeforeComma', 'CurlyQuote', 'Hyphen', 'Trademark'],
         'de_DE' => ['Ellipsis', 'Dimension', 'Unit', 'Dash', 'SmartQuotes', 'NoSpaceBeforeComma', 'CurlyQuote', 'Hyphen', 'Trademark'],
     ];
 
-
     /**
      * @var array HTML Tags to bypass
      */
@@ -93,9 +92,7 @@ public function fix($content)
 
         $this->processDOM($dom, $dom);
 
-        $content = $this->exportDOMDocument($dom);
-
-        return $content;
+        return $this->exportDOMDocument($dom);
     }
 
     /**
@@ -124,6 +121,73 @@ public function setRules($rules)
         $this->compileRules($rules);
     }
 
+    /**
+     * Customize the list of protected tags.
+     *
+     * @param array $protectedTags
+     *
+     * @throws \InvalidArgumentException
+     */
+    public function setProtectedTags($protectedTags)
+    {
+        if (!\is_array($protectedTags)) {
+            throw new \InvalidArgumentException('Protected tags must be an array (empty array for no protection).');
+        }
+
+        $this->protectedTags = $protectedTags;
+    }
+
+    /**
+     * Get the current Locale tag.
+     *
+     * @return string
+     */
+    public function getLocale()
+    {
+        return $this->locale;
+    }
+
+    /**
+     * Change the locale of the Fixer.
+     *
+     * @param string $locale An IETF language tag
+     *
+     * @throws \InvalidArgumentException
+     */
+    public function setLocale($locale)
+    {
+        if (!\is_string($locale) || empty($locale)) {
+            throw new \InvalidArgumentException('Locale must be an IETF language tag.');
+        }
+
+        // Set the Locale on Fixer that needs it
+        foreach ($this->_rules as $rule) {
+            if ($rule instanceof LocaleAwareFixerInterface) {
+                $rule->setLocale($locale);
+            }
+        }
+
+        $this->locale = $locale;
+    }
+
+    /**
+     * Get language part of a Locale string (fr_FR => fr).
+     *
+     * @param $locale
+     *
+     * @return string
+     */
+    public static function getLanguageFromLocale($locale)
+    {
+        if (strpos($locale, '_')) {
+            $parts = explode('_', $locale);
+
+            return strtolower($parts[0]);
+        }
+
+        return $locale;
+    }
+
     /**
      * Build the _rules array of Fixer.
      *
@@ -133,19 +197,19 @@ public function setRules($rules)
      */
     private function compileRules($rules)
     {
-        if (!is_array($rules) || empty($rules)) {
+        if (!\is_array($rules) || empty($rules)) {
             throw new BadRuleSetException('Rules must be an array of Fixer');
         }
 
         $this->_rules = [];
         foreach ($rules as $rule) {
-            if (is_object($rule)) {
+            if (\is_object($rule)) {
                 $fixer = $rule;
-                $className = get_class($rule);
+                $className = \get_class($rule);
             } else {
                 $className = class_exists($rule) ? $rule : (class_exists(
-                    'JoliTypo\\Fixer\\'.$rule
-                ) ? 'JoliTypo\\Fixer\\'.$rule : false);
+                    'JoliTypo\\Fixer\\' . $rule
+                ) ? 'JoliTypo\\Fixer\\' . $rule : false);
                 if (!$className) {
                     throw new BadRuleSetException(sprintf('Fixer %s not found', $rule));
                 }
@@ -174,7 +238,7 @@ private function processDOM(\DOMNode $node, \DOMDocument $dom)
             $nodes = [];
             foreach ($node->childNodes as $childNode) {
                 if ($childNode instanceof \DOMElement && $childNode->tagName) {
-                    if (in_array($childNode->tagName, $this->protectedTags)) {
+                    if (\in_array($childNode->tagName, $this->protectedTags)) {
                         continue;
                     }
                 }
@@ -228,9 +292,9 @@ private function doFix(\DOMText $childNode, \DOMNode $node, \DOMDocument $dom)
     /**
      * @param $content
      *
-     * @return \DOMDocument
-     *
      * @throws Exception\InvalidMarkupException
+     *
+     * @return \DOMDocument
      */
     private function loadDOMDocument($content)
     {
@@ -278,7 +342,7 @@ private function fixContentEncoding($content)
                     $content,
                     '<body'
                 ) ? '<?xml encoding="UTF-8"><body>' : '<?xml encoding="UTF-8">';
-                $content = $hack.$content;
+                $content = $hack . $content;
             }
 
             $encoding = mb_detect_encoding($content);
@@ -287,8 +351,8 @@ private function fixContentEncoding($content)
             // Add a meta to the <head> section
             if (false !== $headPos) {
                 $headPos += 6;
-                $content = mb_substr($content, 0, $headPos).
-                    '<meta http-equiv="Content-Type" content="text/html; charset='.$encoding.'">'.
+                $content = mb_substr($content, 0, $headPos) .
+                    '<meta http-equiv="Content-Type" content="text/html; charset=' . $encoding . '">' .
                     mb_substr($content, $headPos);
             }
 
@@ -306,7 +370,7 @@ private function exportDOMDocument(\DOMDocument $dom)
         // Remove added body & doctype
         $content = preg_replace(
             [
-                "/^\<\!DOCTYPE.*?<html>.*?<body>/si",
+                '/^\\<\\!DOCTYPE.*?<html>.*?<body>/si',
                 '!</body>\n?</html>$!si',
             ],
             '',
@@ -315,71 +379,4 @@ private function exportDOMDocument(\DOMDocument $dom)
 
         return trim($content);
     }
-
-    /**
-     * Customize the list of protected tags.
-     *
-     * @param array $protectedTags
-     *
-     * @throws \InvalidArgumentException
-     */
-    public function setProtectedTags($protectedTags)
-    {
-        if (!is_array($protectedTags)) {
-            throw new \InvalidArgumentException('Protected tags must be an array (empty array for no protection).');
-        }
-
-        $this->protectedTags = $protectedTags;
-    }
-
-    /**
-     * Get the current Locale tag.
-     *
-     * @return string
-     */
-    public function getLocale()
-    {
-        return $this->locale;
-    }
-
-    /**
-     * Change the locale of the Fixer.
-     *
-     * @param string $locale An IETF language tag
-     *
-     * @throws \InvalidArgumentException
-     */
-    public function setLocale($locale)
-    {
-        if (!is_string($locale) || empty($locale)) {
-            throw new \InvalidArgumentException('Locale must be an IETF language tag.');
-        }
-
-        // Set the Locale on Fixer that needs it
-        foreach ($this->_rules as $rule) {
-            if ($rule instanceof LocaleAwareFixerInterface) {
-                $rule->setLocale($locale);
-            }
-        }
-
-        $this->locale = $locale;
-    }
-
-    /**
-     * Get language part of a Locale string (fr_FR => fr).
-     *
-     * @param $locale
-     *
-     * @return string
-     */
-    public static function getLanguageFromLocale($locale)
-    {
-        if (strpos($locale, '_')) {
-            $parts = explode('_', $locale);
-
-            return strtolower($parts[0]);
-        }
-
-        return $locale;
-    }
 }

src/JoliTypo/Fixer/BaseOpenClosePair.php

@@ -29,10 +29,10 @@ protected function fixViaState($content, StateBag $stateBag, $stateName, $openRe
         // If we have a open sibling and we detect a closing quote
         } elseif ($storedSibling instanceof StateNode && preg_match($closeRegexp, $content)) {
             // Replace the closing tag
-            $content = preg_replace($closeRegexp, '$1'.$closeReplacement.'$2', $content, 1);
+            $content = preg_replace($closeRegexp, '$1' . $closeReplacement . '$2', $content, 1);
 
             // Replace the opening tag
-            $open_content = preg_replace($openRegexp, '$1'.$openReplacement.'$2', $storedSibling->getNode()->wholeText, 1);
+            $open_content = preg_replace($openRegexp, '$1' . $openReplacement . '$2', $storedSibling->getNode()->wholeText, 1);
 
             $stateBag->fixSiblingNode($stateName, $open_content);
         }

src/JoliTypo/Fixer/CurlyQuote.php

@@ -17,6 +17,6 @@ class CurlyQuote implements FixerInterface
 {
     public function fix($content, StateBag $stateBag = null)
     {
-        return preg_replace('@([a-z])\'@im', '$1'.Fixer::RSQUO, $content);
+        return preg_replace('@([a-z])\'@im', '$1' . Fixer::RSQUO, $content);
     }
 }

src/JoliTypo/Fixer/Dash.php

@@ -18,8 +18,7 @@ class Dash implements FixerInterface
     public function fix($content, StateBag $stateBag = null)
     {
         $content = preg_replace('@(?<=[0-9 ]|^)-(?=[0-9 ]|$)@', Fixer::NDASH, $content);
-        $content = preg_replace('@ ?-- ?([^-]|$)@s', Fixer::MDASH.'$1', $content);
 
-        return $content;
+        return preg_replace('@ ?-- ?([^-]|$)@s', Fixer::MDASH . '$1', $content);
     }
 }