PhpCsFixer cleanup

.php-cs-fixer.dist.php

@@ -10,6 +10,6 @@
 
 return $config->setFinder(PhpCsFixer\Finder::create()
     ->exclude('vendor')
-    ->in(__DIR__.'\src')
-    ->in(__DIR__.'\tests')
+    ->in(__DIR__.'/src')
+    ->in(__DIR__.'/tests')
     );

src/Error.php

@@ -7,9 +7,9 @@
 
 namespace ZBateson\MailMimeParser;
 
-use Throwable;
 use InvalidArgumentException;
 use Psr\Log\LogLevel;
+use Throwable;
 
 /**
  * Holds information about an error or notice that happened on a specific
@@ -90,7 +90,7 @@ public function getPsrLevel() : string
      */
     public function getClass() : string
     {
-        return get_class($this->object);
+        return \get_class($this->object);
     }
 
     /**

src/ErrorBag.php

@@ -41,7 +41,6 @@ public function __construct()
     /**
      * Returns the class name.  Override to identify objects in logs.
      *
-     * @return string
      */
     public function getErrorLoggingContextName() : string
     {
@@ -83,29 +82,29 @@ public function addError(string $message, string $psrLogLevel, ?Throwable $excep
         return $this;
     }
 
-    public function getErrors(bool $validate = false, string $minPsrLevel = LogLevel::ERROR): array
+    public function getErrors(bool $validate = false, string $minPsrLevel = LogLevel::ERROR) : array
     {
         if ($validate && !$this->validated) {
             $this->validated = true;
             $this->validate();
         }
         return \array_values(\array_filter(
             $this->errors,
-            function ($e) use ($minPsrLevel) {
+            function($e) use ($minPsrLevel) {
                 return $e->isPsrLevelGreaterOrEqualTo($minPsrLevel);
             }
         ));
     }
 
     public function hasErrors(bool $validate = false, string $minPsrLevel = LogLevel::ERROR) : bool
     {
-        return (count($this->getErrors($validate, $minPsrLevel)) > 0);
+        return (\count($this->getErrors($validate, $minPsrLevel)) > 0);
     }
 
     public function getAllErrors(bool $validate = false, string $minPsrLevel = LogLevel::ERROR) : array
     {
         $arr = \array_values(\array_map(
-            function ($e) use ($validate, $minPsrLevel) {
+            function($e) use ($validate, $minPsrLevel) {
                 return $e->getAllErrors($validate, $minPsrLevel) ?? [];
             },
             $this->getErrorBagChildren()

src/Header/AbstractHeader.php

@@ -7,11 +7,11 @@
 
 namespace ZBateson\MailMimeParser\Header;
 
-use ZBateson\MailMimeParser\MailMimeParser;
+use Psr\Log\LogLevel;
 use ZBateson\MailMimeParser\ErrorBag;
 use ZBateson\MailMimeParser\Header\Consumer\IConsumerService;
 use ZBateson\MailMimeParser\Header\Part\CommentPart;
-use Psr\Log\LogLevel;
+use ZBateson\MailMimeParser\MailMimeParser;
 
 /**
  * Abstract base class representing a mime email's header.
@@ -40,14 +40,14 @@ abstract class AbstractHeader extends ErrorBag implements IHeader
     protected array $allParts = [];
 
     /**
-     * @var string[] array of comments, initialized on demand in getComments()
+     * @var string the raw value
      */
-    private ?array $comments = null;
+    protected string $rawValue;
 
     /**
-     * @var string the raw value
+     * @var string[] array of comments, initialized on demand in getComments()
      */
-    protected string $rawValue;
+    private ?array $comments = null;
 
     /**
      * Assigns the header's name and raw value, then calls parseHeaderValue to
@@ -76,7 +76,7 @@ public function __construct(
      */
     protected function filterAndAssignToParts() : void
     {
-        $this->parts = \array_values(\array_filter($this->allParts, function ($p) {
+        $this->parts = \array_values(\array_filter($this->allParts, function($p) {
             return !($p instanceof CommentPart);
         }));
     }
@@ -117,10 +117,10 @@ public function getComments() : array
     {
         if ($this->comments === null) {
             $this->comments = \array_values(\array_map(
-                function ($p) { return $p->getComment(); },
+                function($p) { return $p->getComment(); },
                 \array_filter(
                     $this->allParts,
-                    function ($p) { return ($p instanceof CommentPart); }
+                    function($p) { return ($p instanceof CommentPart); }
                 )
             ));
         }
@@ -150,7 +150,7 @@ public function __toString() : string
         return "{$this->name}: {$this->rawValue}";
     }
 
-    public function getErrorLoggingContextName(): string
+    public function getErrorLoggingContextName() : string
     {
         return 'Header::' . $this->getName();
     }
@@ -162,10 +162,10 @@ protected function getErrorBagChildren() : array
 
     protected function validate() : void
     {
-        if (strlen(trim($this->name)) === 0) {
+        if (\strlen(\trim($this->name)) === 0) {
             $this->addError('Header doesn\'t have a name', LogLevel::ERROR);
         }
-        if (strlen(trim($this->rawValue)) === 0) {
+        if (\strlen(\trim($this->rawValue)) === 0) {
             $this->addError('Header doesn\'t have a value', LogLevel::NOTICE);
         }
     }
@@ -187,11 +187,11 @@ protected static function getHeaderPartsFrom(string $nameOrLine, ?string $value
         $valuePart = $value;
         if ($value === null) {
             // full header line
-            $parts = explode(':', $nameOrLine, 2);
-            $namePart = (count($parts) > 1) ? $parts[0] : '';
-            $valuePart = trim((count($parts) > 1) ? $parts[1] : $parts[0]);
+            $parts = \explode(':', $nameOrLine, 2);
+            $namePart = (\count($parts) > 1) ? $parts[0] : '';
+            $valuePart = \trim((\count($parts) > 1) ? $parts[1] : $parts[0]);
         }
-        return [ $namePart, $valuePart ];
+        return [$namePart, $valuePart];
     }
 
     /**

src/Header/Consumer/AbstractConsumerService.php

@@ -8,14 +8,14 @@
 namespace ZBateson\MailMimeParser\Header\Consumer;
 
 use ArrayIterator;
+use DI\Attribute\Inject;
 use Iterator;
 use NoRewindIterator;
-use DI\Attribute\Inject;
+use Psr\Log\LoggerInterface;
+use Psr\Log\NullLogger;
 use ZBateson\MailMimeParser\Header\IHeaderPart;
 use ZBateson\MailMimeParser\Header\Part\HeaderPartFactory;
 use ZBateson\MailMimeParser\Header\Part\MimeLiteralPart;
-use Psr\Log\LoggerInterface;
-use Psr\Log\NullLogger;
 
 /**
  * Abstract base class for all header token consumers.
@@ -35,20 +35,19 @@ abstract class AbstractConsumerService implements IConsumerService
      */
     protected HeaderPartFactory $partFactory;
 
-    /**
-     * @var ?string the generated token split pattern on first run, so it doesn't
-     *      need to be regenerated every time.
-     */
-    private ?string $tokenSplitPattern = null;
-
     /**
      * @var AbstractConsumerService[] array of sub-consumers used by this
      *      consumer if any, or an empty array if none exist.
      */
     protected array $subConsumers = [];
 
     /**
-     * @param HeaderPartFactory $partFactory
+     * @var ?string the generated token split pattern on first run, so it doesn't
+     *      need to be regenerated every time.
+     */
+    private ?string $tokenSplitPattern = null;
+
+    /**
      * @param AbstractConsumerService[] $subConsumers
      */
     public function __construct(HeaderPartFactory $partFactory, array $subConsumers = [])
@@ -60,12 +59,12 @@ public function __construct(HeaderPartFactory $partFactory, array $subConsumers
 
     public function __invoke(string $value) : array
     {
-        $this->logger->debug('Starting ${class} for "${value}"', [ 'class' => static::class, 'value' => $value ]);
+        $this->logger->debug('Starting ${class} for "${value}"', ['class' => static::class, 'value' => $value]);
         if ($value !== '') {
             $parts = $this->parseRawValue($value);
             $this->logger->debug(
                 'Ending ${class} for "${value}": parsed into ${cnt} header part objects',
-                [ 'class' => static::class, 'value' => $value, 'cnt' => count($parts) ]
+                ['class' => static::class, 'value' => $value, 'cnt' => \count($parts)]
             );
             return $parts;
         }
@@ -173,7 +172,7 @@ protected function splitRawValue($rawValue) : array
             $this->tokenSplitPattern = $this->getTokenSplitPattern();
             $this->logger->debug(
                 'Configuring ${class} with token split pattern: ${pattern}',
-                [ 'class' => static::class, 'pattern' => $this->tokenSplitPattern]
+                ['class' => static::class, 'pattern' => $this->tokenSplitPattern]
             );
         }
         return \preg_split(
@@ -245,7 +244,7 @@ protected function getConsumerTokenParts(Iterator $tokens) : array
             if ($consumer->isStartToken($token)) {
                 $this->logger->debug(
                     'Token: "${value}" in ${class} starting sub-consumer ${consumer}',
-                    [ 'value' => $token, 'class' => static::class, 'consumer' => get_class($consumer) ]
+                    ['value' => $token, 'class' => static::class, 'consumer' => \get_class($consumer)]
                 );
                 $this->advanceToNextToken($tokens, true);
                 return $consumer->parseTokensIntoParts($tokens);

src/Header/Consumer/AddressBaseConsumerService.php

@@ -7,9 +7,9 @@
 
 namespace ZBateson\MailMimeParser\Header\Consumer;
 
-use ZBateson\MailMimeParser\Header\Part\HeaderPartFactory;
-use ZBateson\MailMimeParser\Header\IHeaderPart;
 use Iterator;
+use ZBateson\MailMimeParser\Header\IHeaderPart;
+use ZBateson\MailMimeParser\Header\Part\HeaderPartFactory;
 
 /**
  * Serves as a base-consumer for recipient/sender email address headers (like
@@ -27,7 +27,7 @@ public function __construct(
         HeaderPartFactory $partFactory,
         AddressConsumerService $addressConsumerService
     ) {
-        parent::__construct($partFactory, [ $addressConsumerService ]);
+        parent::__construct($partFactory, [$addressConsumerService]);
     }
 
     /**

src/Header/Consumer/AddressEmailConsumerService.php

@@ -29,7 +29,7 @@ public function __construct(
     ) {
         parent::__construct(
             $partFactory,
-            [ $commentConsumerService, $quotedStringConsumerService ]
+            [$commentConsumerService, $quotedStringConsumerService]
         );
     }
 

src/Header/Consumer/AddressGroupConsumerService.php

@@ -7,8 +7,8 @@
 
 namespace ZBateson\MailMimeParser\Header\Consumer;
 
-use ZBateson\MailMimeParser\Header\Part\HeaderPartFactory;
 use ZBateson\MailMimeParser\Header\Part\AddressGroupPart;
+use ZBateson\MailMimeParser\Header\Part\HeaderPartFactory;
 
 /**
  * Parses a single group of addresses (as a named-group part of an address
@@ -37,8 +37,7 @@ public function __construct(HeaderPartFactory $partFactory)
     /**
      * Needs to be called in AddressConsumerService's constructor to avoid a
      * circular dependency.
-     * 
-     * @param AddressConsumerService $subConsumer
+     *
      */
     public function setAddressConsumerService(AddressConsumerService $subConsumer) : void
     {

src/Header/Consumer/CommentConsumerService.php

@@ -7,11 +7,11 @@
 
 namespace ZBateson\MailMimeParser\Header\Consumer;
 
-use ZBateson\MailMimeParser\Header\Part\MimeLiteralPartFactory;
+use Iterator;
 use ZBateson\MailMimeParser\Header\IHeaderPart;
 use ZBateson\MailMimeParser\Header\Part\CommentPart;
 use ZBateson\MailMimeParser\Header\Part\LiteralPart;
-use Iterator;
+use ZBateson\MailMimeParser\Header\Part\MimeLiteralPartFactory;
 
 /**
  * Consumes all tokens within parentheses as comments.

src/Header/Consumer/DateConsumerService.php

@@ -45,7 +45,7 @@ protected function processParts(array $parts) : array
         foreach ($parts as $part) {
             $strValue .= $part->getValue();
         }
-        $comments = \array_values(\array_filter($parts, function ($part) {
+        $comments = \array_values(\array_filter($parts, function($part) {
             return ($part instanceof CommentPart);
         }));
         return \array_merge([$this->partFactory->newDatePart($strValue)], $comments);

src/Header/Consumer/GenericConsumerService.php

@@ -25,7 +25,7 @@ public function __construct(
     ) {
         parent::__construct(
             $partFactory,
-            [ $commentConsumerService, $quotedStringConsumerService ]
+            [$commentConsumerService, $quotedStringConsumerService]
         );
     }
 }

src/Header/Consumer/IConsumerService.php

@@ -22,5 +22,5 @@ interface IConsumerService
      * @return \ZBateson\MailMimeParser\Header\IHeaderPart[] the array of parsed
      *         parts
      */
-    function __invoke(string $value) : array;
+    public function __invoke(string $value) : array;
 }

src/Header/Consumer/IdBaseConsumerService.php

@@ -7,8 +7,8 @@
 
 namespace ZBateson\MailMimeParser\Header\Consumer;
 
-use ZBateson\MailMimeParser\Header\Part\HeaderPartFactory;
 use ZBateson\MailMimeParser\Header\IHeaderPart;
+use ZBateson\MailMimeParser\Header\Part\HeaderPartFactory;
 
 /**
  * Serves as a base-consumer for ID headers (like Message-ID and Content-ID).

src/Header/Consumer/IdConsumerService.php

@@ -65,10 +65,10 @@ protected function getPartForToken(string $token, bool $isLiteral) : ?IHeaderPar
      */
     protected function processParts(array $parts) : array
     {
-        $id = \array_reduce(\array_filter($parts), function ($c, $p) {
+        $id = \array_reduce(\array_filter($parts), function($c, $p) {
             return $c . $p->getValue();
         }, '');
-        return array_merge([$this->partFactory->newLiteralPart($id)], \array_values(\array_filter($parts, function ($p) {
+        return \array_merge([$this->partFactory->newLiteralPart($id)], \array_values(\array_filter($parts, function($p) {
             return ($p instanceof CommentPart);
         })));
     }

src/Header/Consumer/Received/GenericReceivedConsumerService.php

@@ -56,7 +56,7 @@ public function __construct(
         CommentConsumerService $commentConsumerService,
         string $partName
     ) {
-        parent::__construct($partFactory, [ $commentConsumerService ]);
+        parent::__construct($partFactory, [$commentConsumerService]);
         $this->partName = $partName;
     }
 

src/Header/Consumer/ReceivedConsumerService.php

@@ -8,11 +8,11 @@
 namespace ZBateson\MailMimeParser\Header\Consumer;
 
 use Iterator;
-use ZBateson\MailMimeParser\Header\Part\HeaderPartFactory;
-use ZBateson\MailMimeParser\Header\Part\Token;
 use ZBateson\MailMimeParser\Header\Consumer\Received\DomainConsumerService;
 use ZBateson\MailMimeParser\Header\Consumer\Received\GenericReceivedConsumerService;
 use ZBateson\MailMimeParser\Header\Consumer\Received\ReceivedDateConsumerService;
+use ZBateson\MailMimeParser\Header\Part\HeaderPartFactory;
+use ZBateson\MailMimeParser\Header\Part\Token;
 
 /**
  * Parses a Received header into ReceivedParts, ReceivedDomainParts, a DatePart,

src/Header/Consumer/SubjectConsumerService.php

@@ -7,9 +7,9 @@
 
 namespace ZBateson\MailMimeParser\Header\Consumer;
 
-use ZBateson\MailMimeParser\Header\Part\MimeLiteralPartFactory;
-use ZBateson\MailMimeParser\Header\IHeaderPart;
 use Iterator;
+use ZBateson\MailMimeParser\Header\IHeaderPart;
+use ZBateson\MailMimeParser\Header\Part\MimeLiteralPartFactory;
 
 /**
  * Extends AbstractGenericConsumerService to use a MimeLiteralPartFactory, and