Using PHP8.4 Deprecated attributes and simplifying github actions

thephpleague · Nov 22, 2024 · 08af8b3 · 08af8b3
1 parent 1a31de9
commit 08af8b3
Show file tree

Hide file tree

Showing 25 changed files with 71 additions and 20 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -10,13 +10,8 @@ jobs:
         runs-on: ubuntu-20.04
         strategy:
             matrix:
-                php: ['8.1', '8.2', '8.3']
+                php: ['8.1', '8.2', '8.3', '8.4']
                 stability: [prefer-lowest, prefer-stable]
-                include:
-                    -   php: '8.4'
-                        flags: "--ignore-platform-req=php"
-                        phpunit-flags: '--no-coverage'
-                        stability: prefer-stable
         steps:
             - name: Checkout code
               uses: actions/checkout@v3
@@ -50,11 +45,6 @@ jobs:
 
             - name: Run Unit tests with coverage
               run: composer phpunit -- ${{ matrix.phpunit-flags }}
-              if: ${{ matrix.php == '8.3' || matrix.php == '8.2' || matrix.php == '8.1'}}
-
-            - name:  Run Unit tests without coverage
-              run: composer phpunit:min
-              if: ${{ matrix.php == '8.4'}}
 
             - name: Run static analysis
               run: composer phpstan

diff --git a/phpstan.neon b/phpstan.neon
@@ -8,6 +8,7 @@ parameters:
         - identifier: missingType.generics
         - identifier: missingType.iterableValue
         - '#implements deprecated interface League\\Csv\\ByteSequence#'
+        - '#Attribute class Deprecated does not exist.#'
     level: max
     paths:
         - src

diff --git a/src/AbstractCsv.php b/src/AbstractCsv.php
@@ -13,6 +13,7 @@
 
 namespace League\Csv;
 
+use Deprecated;
 use Generator;
 use InvalidArgumentException;
 use RuntimeException;
@@ -399,6 +400,7 @@ public function addStreamFilter(string $filtername, null|array $params = null):
      *
      * Returns the stream filter mode.
      */
+    #[Deprecated(message:'Use AbstractCsv::supportsStreamFilterOnRead or AbstractCsv::supportsStreamFilterOnWrite instead', since:'league/csv:9.7.0')]
     public function getStreamFilterMode(): int
     {
         return static::STREAM_FILTER_MODE;
@@ -414,6 +416,7 @@ public function getStreamFilterMode(): int
      *
      * Tells whether the stream filter capabilities can be used.
      */
+    #[Deprecated(message:'Use AbstractCsv::supportsStreamFilterOnRead or AbstractCsv::supportsStreamFilterOnWrite instead', since:'league/csv:9.7.0')]
     public function supportsStreamFilter(): bool
     {
         return $this->document instanceof Stream;
@@ -428,6 +431,7 @@ public function supportsStreamFilter(): bool
      * @see AbstractCsv::toString
      * @codeCoverageIgnore
      */
+    #[Deprecated(message:'Use AbstractCsv::toString instead', since:'league/csv:9.7.0')]
     public function getContent(): string
     {
         return $this->toString();
@@ -442,6 +446,7 @@ public function getContent(): string
      *
      * Retrieves the CSV content
      */
+    #[Deprecated(message:'Use AbstractCsv::toString instead', since:'league/csv:9.1.0')]
     public function __toString(): string
     {
         return $this->toString();
@@ -462,6 +467,7 @@ public function __toString(): string
      * @deprecated since version 9.17.0
      * @see https://tools.ietf.org/html/rfc6266#section-4.3
      */
+    #[Deprecated(message:'Use HttpHeaders::forFileDownload instead', since:'league/csv:9.17.0')]
     protected function sendHeaders(string $filename): void
     {
         if (strlen($filename) !== strcspn($filename, '\\/')) {
@@ -501,6 +507,7 @@ protected function sendHeaders(string $filename): void
      *
      * @throws Exception
      */
+    #[Deprecated(message:'Use AbstractCsv::download instead', since:'league/csv:9.18.0')]
     public function output(?string $filename = null): int
     {
         try {

diff --git a/src/ByteSequence.php b/src/ByteSequence.php
@@ -11,12 +11,15 @@
 
 namespace League\Csv;
 
+use Deprecated;
+
 /**
  * Defines constants for common BOM sequences.
  *
  * @deprecated since version 9.16.0
  * @see Bom
  */
+#[Deprecated(message:'Use Bom Enum instead', since:'league/csv:9.16.0')]
 interface ByteSequence
 {
     public const BOM_UTF8 = "\xEF\xBB\xBF";

diff --git a/src/EncloseField.php b/src/EncloseField.php
@@ -13,6 +13,7 @@
 
 namespace League\Csv;
 
+use Deprecated;
 use InvalidArgumentException;
 use php_user_filter;
 
@@ -37,6 +38,7 @@
  * @see https://tools.ietf.org/html/rfc4180#section-2
  * @see https://bugs.php.net/bug.php?id=38301
  */
+#[Deprecated(message:'Use Writter::forceEnclosure instead', since:'league/csv:9.10.0')]
 class EncloseField extends php_user_filter
 {
     public const FILTERNAME = 'convert.league.csv.enclosure';

diff --git a/src/EncloseFieldTest.php b/src/EncloseFieldTest.php
@@ -13,6 +13,7 @@
 
 namespace League\Csv;
 
+use Deprecated;
 use InvalidArgumentException;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Group;
@@ -26,6 +27,7 @@
  * @deprecated since version 9.10.0
  */
 #[Group('filter')]
+#[Deprecated(message:'Use Writer::forceEnclosure instead', since:'league/csv:9.10.0')]
 final class EncloseFieldTest extends TestCase
 {
     /**

diff --git a/src/EscapeFormula.php b/src/EscapeFormula.php
@@ -13,6 +13,7 @@
 
 namespace League\Csv;
 
+use Deprecated;
 use InvalidArgumentException;
 use Stringable;
 
@@ -138,6 +139,7 @@ protected function unescapeField(mixed $cell): mixed
      *
      * @param mixed $value value to check if it is stringable
      */
+    #[Deprecated(message:'No longer in use', since:'league/csv:9.7.2')]
     protected function isStringable(mixed $value): bool
     {
         return is_string($value) || $value instanceof Stringable;
@@ -151,6 +153,7 @@ protected function isStringable(mixed $value): bool
      *
      * @see escapeRecord
      */
+    #[Deprecated(message:'use EscapeFormula::escapeRecord instead', since:'league/csv:9.11.0')]
     public function __invoke(array $record): array
     {
         return $this->escapeRecord($record);

diff --git a/src/HTMLConverter.php b/src/HTMLConverter.php
@@ -13,6 +13,7 @@
 
 namespace League\Csv;
 
+use Deprecated;
 use DOMDocument;
 use DOMElement;
 use DOMException;
@@ -39,9 +40,10 @@ public static function create(): self
      * DEPRECATION WARNING! This method will be removed in the next major point release.
      *
      * @throws DOMException
-     * @see HTMLConverterTest::create()
+     * @see HTMLConverter::create()
      * @deprecated since version 9.7.0
      */
+    #[Deprecated(message:'use HTNLConverter::create instead', since:'league/csv:9.7.0')]
     public function __construct()
     {
         $this->xml_converter = XMLConverter::create()

diff --git a/src/Info.php b/src/Info.php
@@ -13,6 +13,8 @@
 
 namespace League\Csv;
 
+use Deprecated;
+
 use function array_fill_keys;
 use function array_filter;
 use function array_reduce;
@@ -33,6 +35,7 @@ final class Info implements ByteSequence
      * @see Bom::tryFromSequence()
      * @codeCoverageIgnore
      */
+    #[Deprecated(message:'use Bom::tryFromSequence instead', since:'league/csv:9.16.0')]
     public static function fetchBOMSequence(string $str): ?string
     {
         return Bom::tryFromSequence($str)?->value;

diff --git a/src/InvalidArgument.php b/src/InvalidArgument.php
@@ -13,6 +13,7 @@
 
 namespace League\Csv;
 
+use Deprecated;
 use Throwable;
 
 /**
@@ -25,6 +26,7 @@ class InvalidArgument extends Exception
      *
      * @deprecated since version 9.7.0
      */
+    #[Deprecated(message:'use its named constructor instead', since:'league/csv:9.7.0')]
     public function __construct(string $message = '', int $code = 0, ?Throwable $previous = null)
     {
         parent::__construct($message, $code, $previous);

diff --git a/src/JsonConverter.php b/src/JsonConverter.php
@@ -15,6 +15,7 @@
 
 use BadMethodCallException;
 use Closure;
+use Deprecated;
 use Exception;
 use InvalidArgumentException;
 use Iterator;
@@ -502,6 +503,7 @@ public function convert(iterable $records): Iterator
      *
      * @param int<1, max> $indentSize
      */
+    #[Deprecated(message:'Use JsonConverter::withPrettyPrint instead', since:'league/csv:9.19.0')]
     public function indentSize(int $indentSize): self
     {
         return match ($indentSize) {

diff --git a/src/RFC4180Field.php b/src/RFC4180Field.php
@@ -13,6 +13,7 @@
 
 namespace League\Csv;
 
+use Deprecated;
 use InvalidArgumentException;
 use php_user_filter;
 use TypeError;
@@ -41,6 +42,7 @@
  *
  * @see https://tools.ietf.org/html/rfc4180#section-2
  */
+#[Deprecated(message:'use its AbstractCsv::setEscape instead', since:'league/csv:9.2.0')]
 class RFC4180Field extends php_user_filter
 {
     public const FILTERNAME = 'convert.league.csv.rfc4180';

diff --git a/src/RFC4180FieldTest.php b/src/RFC4180FieldTest.php
@@ -13,6 +13,7 @@
 
 namespace League\Csv;
 
+use Deprecated;
 use InvalidArgumentException;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\Attributes\Group;
@@ -30,6 +31,7 @@
  * @deprecated since version 9.2.0
  */
 #[Group('filter')]
+#[Deprecated(message:'Test will be removed their are left to avoid regression', since:'league/csv:9.2.0')]
 final class RFC4180FieldTest extends TestCase
 {
     /**

diff --git a/src/Reader.php b/src/Reader.php
@@ -15,6 +15,7 @@
 
 use CallbackFilterIterator;
 use Closure;
+use Deprecated;
 use Iterator;
 use JsonSerializable;
 use League\Csv\Serializer\Denormalizer;
@@ -614,6 +615,7 @@ protected function combineHeader(Iterator $iterator, array $header): Iterator
      * @deprecated since version 9.9.0
      * @codeCoverageIgnore
      */
+    #[Deprecated(message:'Use Reader::nth instead', since:'league/csv:9.9.0')]
     public function fetchOne(int $nth_record = 0): array
     {
         return $this->nth($nth_record);
@@ -633,6 +635,7 @@ public function fetchOne(int $nth_record = 0): array
      * @throws MappingFailed
      * @throws TypeCastingFailed
      */
+    #[Deprecated(message:'Use Reader::getRecordsAsObject instead', since:'league/csv:9.15.0')]
     public function getObjects(string $className, array $header = []): Iterator
     {
         return $this->getRecordsAsObject($className, $header);

diff --git a/src/ResultSet.php b/src/ResultSet.php
@@ -16,6 +16,7 @@
 use ArrayIterator;
 use CallbackFilterIterator;
 use Closure;
+use Deprecated;
 use Generator;
 use Iterator;
 use JsonSerializable;
@@ -546,6 +547,7 @@ public function fetchPairs($offset_index = 0, $value_index = 1): Iterator
      * @deprecated since version 9.9.0
      * @codeCoverageIgnore
      */
+    #[Deprecated(message:'Use Resultset::nth instead', since:'league/csv:9.9.0')]
     public function fetchOne(int $nth_record = 0): array
     {
         return $this->nth($nth_record);
@@ -554,7 +556,7 @@ public function fetchOne(int $nth_record = 0): array
     /**
      * DEPRECATION WARNING! This method will be removed in the next major point release.
      *
-     * @see Reader::getRecordsAsObject()
+     * @see ResultSet::getRecordsAsObject()
      * @deprecated Since version 9.15.0
      * @codeCoverageIgnore
      *
@@ -565,6 +567,7 @@ public function fetchOne(int $nth_record = 0): array
      * @throws MappingFailed
      * @throws TypeCastingFailed
      */
+    #[Deprecated(message:'Use ResultSet::getRecordsAsObject instead', since:'league/csv:9.15.0')]
     public function getObjects(string $className, array $header = []): Iterator
     {
         return $this->getRecordsAsObject($className, $header);

diff --git a/src/Serializer/AfterMapping.php b/src/Serializer/AfterMapping.php
@@ -14,6 +14,7 @@
 namespace League\Csv\Serializer;
 
 use Attribute;
+use Deprecated;
 use ReflectionAttribute;
 use ReflectionClass;
 
@@ -23,6 +24,7 @@
  * @see MapRecord
  */
 #[Attribute(Attribute::TARGET_CLASS)]
+#[Deprecated(message:'Use MapRecord attribute instead', since:'league/csv:9.17.0')]
 final class AfterMapping
 {
     public readonly MapRecord $mapRecord;

diff --git a/src/Serializer/CallbackCasting.php b/src/Serializer/CallbackCasting.php
@@ -14,6 +14,7 @@
 namespace League\Csv\Serializer;
 
 use Closure;
+use Deprecated;
 use ReflectionClass;
 use ReflectionNamedType;
 use ReflectionParameter;
@@ -376,6 +377,7 @@ private static function getTypes(?ReflectionType $type): array
      * @see CallbackCasting::unregisterType()
      * @codeCoverageIgnore
      */
+    #[Deprecated(message:'Use CallbackCasting::unregisterType instead', since:'league/csv:9.13.0')]
     public static function unregister(string $type): bool
     {
         return self::unregisterType($type);

diff --git a/src/Serializer/Denormalizer.php b/src/Serializer/Denormalizer.php
@@ -14,6 +14,7 @@
 namespace League\Csv\Serializer;
 
 use Closure;
+use Deprecated;
 use Iterator;
 use League\Csv\MapIterator;
 use ReflectionAttribute;
@@ -65,6 +66,7 @@ public function __construct(string $className, array $propertyNames = [])
      *
      * Enables converting empty string to the null value.
      */
+    #[Deprecated(message:'Use MapRecord::$convertEmptyStringToNull or MapCell::$convertEmptyStringToNullinstead', since:'league/csv:9.17.0')]
     public static function allowEmptyStringAsNull(): void
     {
         self::$convertEmptyStringToNull = true;
@@ -78,6 +80,7 @@ public static function allowEmptyStringAsNull(): void
      *
      * Disables converting empty string to the null value.
      */
+    #[Deprecated(message:'Use MapRecord::$convertEmptyStringToNull or MapCell::$convertEmptyStringToNullinstead', since:'league/csv:9.17.0')]
     public static function disallowEmptyStringAsNull(): void
     {
         self::$convertEmptyStringToNull = false;