Improve internal codebase

thephpleague · Sep 25, 2024 · 8b8ea7f · 8b8ea7f
1 parent f14b525
commit 8b8ea7f
Show file tree

Hide file tree

Showing 14 changed files with 31 additions and 87 deletions.
diff --git a/composer.json b/composer.json
@@ -33,13 +33,14 @@
         "ext-dom": "*",
         "ext-xdebug": "*",
         "friendsofphp/php-cs-fixer": "^3.64.0",
+        "illuminate/collections": "^11.24.1",
         "phpbench/phpbench": "^1.3.1",
         "phpstan/phpstan": "^1.12.4",
         "phpstan/phpstan-deprecation-rules": "^1.2.1",
         "phpstan/phpstan-phpunit": "^1.4.0",
-        "phpstan/phpstan-strict-rules": "^1.6.0",
+        "phpstan/phpstan-strict-rules": "^1.6.1",
         "phpunit/phpunit": "^10.5.16 || ^11.3.6",
-        "symfony/var-dumper": "^6.4.6 || ^7.1.4"
+        "symfony/var-dumper": "^6.4.6 || ^7.1.5"
     },
     "autoload": {
         "psr-4": {

diff --git a/src/AbstractCsv.php b/src/AbstractCsv.php
@@ -317,9 +317,7 @@ public function setDelimiter(string $delimiter): static
             return $this;
         }
 
-        if (1 !== strlen($delimiter)) {
-            throw InvalidArgument::dueToInvalidDelimiterCharacter($delimiter, __METHOD__);
-        }
+        1 === strlen($delimiter) || throw InvalidArgument::dueToInvalidDelimiterCharacter($delimiter, __METHOD__);
 
         $this->delimiter = $delimiter;
         $this->resetProperties();
@@ -338,9 +336,7 @@ public function setEnclosure(string $enclosure): static
             return $this;
         }
 
-        if (1 !== strlen($enclosure)) {
-            throw InvalidArgument::dueToInvalidEnclosureCharacter($enclosure, __METHOD__);
-        }
+        1 === strlen($enclosure) || throw InvalidArgument::dueToInvalidEnclosureCharacter($enclosure, __METHOD__);
 
         $this->enclosure = $enclosure;
         $this->resetProperties();
@@ -418,9 +414,7 @@ public function setOutputBOM(Bom|string|null $str): static
      */
     public function addStreamFilter(string $filtername, null|array $params = null): static
     {
-        if (!$this->document instanceof Stream) {
-            throw UnavailableFeature::dueToUnsupportedStreamFilterApi(get_class($this->document));
-        }
+        $this->document instanceof Stream || throw UnavailableFeature::dueToUnsupportedStreamFilterApi(get_class($this->document));
 
         $this->document->appendFilter($filtername, static::STREAM_FILTER_MODE, $params);
         $this->stream_filters[$filtername] = true;

diff --git a/src/ColumnConsistency.php b/src/ColumnConsistency.php
@@ -26,9 +26,7 @@ class ColumnConsistency
     public function __construct(
         protected int $columns_count = -1
     ) {
-        if ($this->columns_count < -1) {
-            throw InvalidArgument::dueToInvalidColumnCount($this->columns_count, __METHOD__);
-        }
+        $this->columns_count >= -1 || throw InvalidArgument::dueToInvalidColumnCount($this->columns_count, __METHOD__);
     }
 
     /**

diff --git a/src/EscapeFormula.php b/src/EscapeFormula.php
@@ -58,9 +58,7 @@ public function __construct(
     protected function filterSpecialCharacters(string ...$characters): array
     {
         foreach ($characters as $str) {
-            if (1 !== strlen($str)) {
-                throw new InvalidArgumentException('The submitted string '.$str.' must be a single character');
-            }
+            1 === strlen($str) || throw new InvalidArgumentException('The submitted string '.$str.' must be a single character');
         }
 
         return $characters;

diff --git a/src/HTMLConverter.php b/src/HTMLConverter.php
@@ -128,9 +128,8 @@ protected function addHTMLAttributes(DOMElement $node): void
      */
     public function table(string $class_name, string $id_value = ''): self
     {
-        if (1 === preg_match(",\s,", $id_value)) {
-            throw new DOMException("The id attribute's value must not contain whitespace (spaces, tabs etc.)");
-        }
+        1 !== preg_match(",\s,", $id_value) || throw new DOMException("The id attribute's value must not contain whitespace (spaces, tabs etc.)");
+
         $clone = clone $this;
         $clone->class_name = $class_name;
         $clone->id_value = $id_value;

diff --git a/src/JsonConverter.php b/src/JsonConverter.php
@@ -66,13 +66,9 @@ private function __construct(
         ?Closure $formatter
     ) {
         json_encode([], $flags & ~JSON_THROW_ON_ERROR, $depth);
-        if (JSON_ERROR_NONE !== json_last_error()) {
-            throw new InvalidArgumentException('The flags or the depth given are not valid JSON encoding parameters in PHP; '.json_last_error_msg());
-        }
 
-        if (1 > $indentSize) {
-            throw new InvalidArgumentException('The indentation space must be greater or equal to 1.');
-        }
+        JSON_ERROR_NONE === json_last_error() || throw new InvalidArgumentException('The flags or the depth given are not valid JSON encoding parameters in PHP; '.json_last_error_msg());
+        1 <= $indentSize || throw new InvalidArgumentException('The indentation space must be greater or equal to 1.');
 
         $this->flags = $flags;
         $this->depth = $depth;

diff --git a/src/Query/Constraint/TwoColumns.php b/src/Query/Constraint/TwoColumns.php
@@ -45,9 +45,7 @@ private function __construct(
         public readonly Comparison|Closure $operator,
         public readonly array|string|int $second,
     ) {
-        if ($this->operator instanceof Closure && is_array($this->second)) {
-            throw new QueryException('The second column must be a string if the operator is a callback.');
-        }
+        !$this->operator instanceof Closure || !is_array($this->second) || throw new QueryException('The second column must be a string if the operator is a callback.');
 
         if (is_array($this->second)) {
             $res = array_filter($this->second, fn (mixed $value): bool => !is_string($value) && !is_int($value));

diff --git a/src/Query/Limit.php b/src/Query/Limit.php
@@ -22,13 +22,8 @@ private function __construct(
         public readonly int $offset,
         public readonly int $length,
     ) {
-        if (0 > $this->offset) {
-            throw new QueryException(self::class.' expects the offset to be greater or equal to 0, '.$this->offset.' given.');
-        }
-
-        if (-1 > $this->length) {
-            throw new QueryException(self::class.' expects the length to be greater or equal to -1, '.$this->length.' given.');
-        }
+        0 <= $this->offset || throw new QueryException(self::class.' expects the offset to be greater or equal to 0, '.$this->offset.' given.');
+        -2 < $this->length || throw new QueryException(self::class.' expects the length to be greater or equal to -1, '.$this->length.' given.');
     }
 
     public static function new(int $offset, int $length): self

diff --git a/src/Query/Row.php b/src/Query/Row.php
@@ -124,9 +124,7 @@ private static function getObjectPropertyValue(object $row, string|int ...$keys)
                 continue;
             }
 
-            if (is_int($key)) {
-                throw QueryException::dueToUnknownColumn($key, $row);
-            }
+            !is_int($key) || throw QueryException::dueToUnknownColumn($key, $row);
 
             if ($object->hasProperty($key) && $object->getProperty($key)->isPublic()) {
                 $res[$key] = $object->getProperty($key)->getValue($row);

diff --git a/src/Reader.php b/src/Reader.php
@@ -79,9 +79,7 @@ public function setHeaderOffset(?int $offset): static
             return $this;
         }
 
-        if (null !== $offset && 0 > $offset) {
-            throw InvalidArgument::dueToInvalidHeaderOffset($offset, __METHOD__);
-        }
+        null === $offset || -1 < $offset || throw InvalidArgument::dueToInvalidHeaderOffset($offset, __METHOD__);
 
         $this->header_offset = $offset;
         $this->resetProperties();
@@ -536,9 +534,7 @@ protected function stripBOM(Iterator $iterator, ?Bom $bom): Iterator
      */
     protected function prepareHeader($header = []): array
     {
-        if ($header !== (array_filter($header, is_string(...)))) {
-            throw SyntaxError::dueToInvalidHeaderColumnNames();
-        }
+        $header == array_filter($header, is_string(...)) || throw SyntaxError::dueToInvalidHeaderColumnNames();
 
         return $this->computeHeader($header);
     }

diff --git a/src/ResultSet.php b/src/ResultSet.php
@@ -54,9 +54,7 @@ class ResultSet implements TabularDataReader, JsonSerializable
      */
     public function __construct(Iterator|array $records, array $header = [])
     {
-        if ($header !== array_filter($header, is_string(...))) {
-            throw SyntaxError::dueToInvalidHeaderColumnNames();
-        }
+        $header === array_filter($header, is_string(...)) || throw SyntaxError::dueToInvalidHeaderColumnNames();
 
         $this->header = array_values($this->validateHeader($header));
         $this->records = match (true) {
@@ -174,9 +172,7 @@ public function reduce(Closure $callback, mixed $initial = null): mixed
      */
     public function chunkBy(int $recordsCount): iterable
     {
-        if ($recordsCount < 1) {
-            throw InvalidArgument::dueToInvalidChunkSize($recordsCount, __METHOD__);
-        }
+        $recordsCount > 0 || throw InvalidArgument::dueToInvalidChunkSize($recordsCount, __METHOD__);
 
         $header = $this->getHeader();
         $records = [];
@@ -323,10 +319,7 @@ public function getRecordsAsObject(string $className, array $header = []): Itera
      */
     protected function prepareHeader(array $header): array
     {
-        if ($header !== array_filter($header, is_string(...))) {
-            throw SyntaxError::dueToInvalidHeaderColumnNames();
-        }
-
+        $header === array_filter($header, is_string(...)) || throw SyntaxError::dueToInvalidHeaderColumnNames();
         $header = $this->validateHeader($header);
         if ([] === $header) {
             $header = $this->header;
@@ -382,9 +375,7 @@ public function value(int|string $column = 0): mixed
 
     public function nth(int $nth_record): array
     {
-        if ($nth_record < 0) {
-            throw InvalidArgument::dueToInvalidRecordOffset($nth_record, __METHOD__);
-        }
+        0 <= $nth_record || throw InvalidArgument::dueToInvalidRecordOffset($nth_record, __METHOD__);
 
         $iterator = new LimitIterator($this->getIterator(), $nth_record, 1);
         $iterator->rewind();

diff --git a/src/Statement.php b/src/Statement.php
@@ -280,10 +280,7 @@ public function offset(int $offset): self
      */
     public function limit(int $limit): self
     {
-        if (-1 > $limit) {
-            throw InvalidArgument::dueToInvalidLimit($limit, __METHOD__);
-        }
-
+        $limit >= -1 || throw InvalidArgument::dueToInvalidLimit($limit, __METHOD__);
         if ($limit === $this->limit) {
             return $this;
         }

diff --git a/src/Stream.php b/src/Stream.php
@@ -131,9 +131,7 @@ public static function createFromPath(string $path, string $open_mode = 'r', $co
         $resource = fopen(...$args);
         restore_error_handler();
 
-        if (!is_resource($resource)) {
-            throw UnavailableStream::dueToPathNotFound($path);
-        }
+        is_resource($resource) || throw UnavailableStream::dueToPathNotFound($path);
 
         $instance = new self($resource);
         $instance->should_close_stream = true;
@@ -187,9 +185,7 @@ public function appendFilter(string $filtername, int $read_write, ?array $params
         set_error_handler(fn (int $errno, string $errstr, string $errfile, int $errline) => true);
         $res = stream_filter_append($this->stream, $filtername, $read_write, $params ?? []);
         restore_error_handler();
-        if (!is_resource($res)) {
-            throw InvalidArgument::dueToStreamFilterNotFound($filtername);
-        }
+        is_resource($res) || throw InvalidArgument::dueToStreamFilterNotFound($filtername);
 
         $this->filters[$filtername][] = $res;
     }
@@ -292,13 +288,8 @@ public function next(): void
      */
     public function rewind(): void
     {
-        if (!$this->is_seekable) {
-            throw UnavailableFeature::dueToMissingStreamSeekability();
-        }
-
-        if (false === rewind($this->stream)) {
-            throw new RuntimeException('Unable to rewind the document.');
-        }
+        $this->is_seekable || throw UnavailableFeature::dueToMissingStreamSeekability();
+        false !== rewind($this->stream) || throw new RuntimeException('Unable to rewind the document.');
 
         $this->offset = 0;
         $this->value = false;
@@ -355,9 +346,7 @@ public function fgets(): string|false
      */
     public function setMaxLineLen(int $maxLength): void
     {
-        if (0 > $maxLength) {
-            throw new ValueError(' Argument #1 ($maxLength) must be greater than or equal to 0');
-        }
+        0 <= $maxLength || throw new ValueError(' Argument #1 ($maxLength) must be greater than or equal to 0');
 
         $this->maxLength = $maxLength;
     }
@@ -429,9 +418,7 @@ private function getCurrentLine(): string|false
      */
     public function seek(int $offset): void
     {
-        if ($offset < 0) {
-            throw InvalidArgument::dueToInvalidSeekingPosition($offset, __METHOD__);
-        }
+        $offset >= 0 || throw InvalidArgument::dueToInvalidSeekingPosition($offset, __METHOD__);
 
         $this->rewind();
         while ($this->key() !== $offset && $this->valid()) {

diff --git a/src/Writer.php b/src/Writer.php
@@ -145,9 +145,7 @@ public function insertOne(array $record): int
     protected function validateRecord(array $record): void
     {
         foreach ($this->validators as $name => $validator) {
-            if (true !== $validator($record)) {
-                throw CannotInsertRecord::triggerOnValidation($name, $record);
-            }
+            true === $validator($record) || throw CannotInsertRecord::triggerOnValidation($name, $record);
         }
     }
 
@@ -192,9 +190,7 @@ public function setFlushThreshold(?int $threshold): self
             return $this;
         }
 
-        if (null !== $threshold && 1 > $threshold) {
-            throw InvalidArgument::dueToInvalidThreshold($threshold, __METHOD__);
-        }
+        null === $threshold || 1 <= $threshold || throw InvalidArgument::dueToInvalidThreshold($threshold, __METHOD__);
 
         $this->flush_threshold = $threshold;
         $this->flush_counter = 0;