Merge branch 'release/1.1.3'

Author: sunaoka

.github/workflows/test.yml

@@ -16,13 +16,13 @@ jobs:
         php: [
           '5.5', '5.6',
           '7.0', '7.1', '7.2', '7.3', '7.4',
-          '8.0', '8.1', '8.2'
+          '8.0', '8.1', '8.2', '8.3'
         ]
 
     name: PHP ${{ matrix.php }}
 
     steps:
-      - name: Setup PHP ${{ matrix.php-version }}
+      - name: Setup PHP ${{ matrix.php }}
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php }}

src/NDJSON.php

@@ -5,8 +5,15 @@
 use Generator;
 use SplFileObject;
 
+/**
+ * @template TKey as array-key
+ * @template TValue
+ */
 class NDJSON extends SplFileObject
 {
+    /**
+     * @param string $filename
+     */
     public function __construct($filename)
     {
         parent::__construct($filename, 'a+');
@@ -16,7 +23,7 @@ public function __construct($filename)
     /**
      * Gets line from file and decode a JSON string
      *
-     * @return array|null
+     * @return array<TKey, TValue>|null
      */
     public function readline()
     {
@@ -28,6 +35,7 @@ public function readline()
             return null;
         }
 
+        /** @var array<TKey, TValue>|null */
         return json_decode(trim($row), true);
     }
 
@@ -64,9 +72,9 @@ public function readlines($lines)
     /**
      * Write the array to file with JSON encoding
      *
-     * @param array  $values
-     * @param int    $json_flags
-     * @param string $separator
+     * @param array<TKey, TValue> $values
+     * @param int                 $json_flags
+     * @param string              $separator
      *
      * @return int|false
      */
@@ -80,9 +88,9 @@ public function writeline($values, $json_flags = 0, $separator = "\n")
     /**
      * Write multiple arrays to a file with JSON encoding
      *
-     * @param array  $values
-     * @param int    $json_flags
-     * @param string $separator
+     * @param array<TKey, TValue> $values
+     * @param int                 $json_flags
+     * @param string              $separator
      *
      * @return int|false
      */

tests/NDJSONTest.php

@@ -2,15 +2,17 @@
 
 namespace Tests;
 
-use Sunaoka\Ndjson\NDJSON;
 use PHPUnit\Framework\TestCase;
+use Sunaoka\Ndjson\NDJSON;
 
 class NDJSONTest extends TestCase
 {
     /**
      * @dataProvider readlineProvider
      *
      * @param string $file
+     *
+     * @return void
      */
     public function test_readline_newline_successful($file)
     {
@@ -23,6 +25,9 @@ public function test_readline_newline_successful($file)
         self::assertSame(['test' => '002'], $actual);
     }
 
+    /**
+     * @return string[][]
+     */
     public static function readlineProvider()
     {
         return [
@@ -35,6 +40,8 @@ public static function readlineProvider()
      * @dataProvider emptyLineProvider
      *
      * @param string $file
+     *
+     * @return void
      */
     public function test_readline_empty_line_successful($file)
     {
@@ -46,6 +53,9 @@ public function test_readline_empty_line_successful($file)
         }
     }
 
+    /**
+     * @return string[][]
+     */
     public static function emptyLineProvider()
     {
         return [
@@ -54,6 +64,9 @@ public static function emptyLineProvider()
         ];
     }
 
+    /**
+     * @return void
+     */
     public function test_readline_empty_successful()
     {
         $ndjson = new NDJSON(__DIR__ . '/fixtures/empty.ndjson');
@@ -66,6 +79,8 @@ public function test_readline_empty_successful()
      * @dataProvider readlinesProvider
      *
      * @param string $file
+     *
+     * @return void
      */
     public function test_readlines_newline_successful($file)
     {
@@ -120,6 +135,9 @@ public function test_readlines_newline_successful($file)
         self::assertSame(1, $actual);
     }
 
+    /**
+     * @return string[][]
+     */
     public static function readlinesProvider()
     {
         return [
@@ -128,6 +146,9 @@ public static function readlinesProvider()
         ];
     }
 
+    /**
+     * @return void
+     */
     public function test_readlines_empty_successful()
     {
         $ndjson = new NDJSON(__DIR__ . '/fixtures/empty.ndjson');
@@ -138,6 +159,9 @@ public function test_readlines_empty_successful()
         self::assertNull($actual);
     }
 
+    /**
+     * @return void
+     */
     public function test_writeline_successful()
     {
         $ndjson = new NDJSON('php://memory');
@@ -157,6 +181,9 @@ public function test_writeline_successful()
         self::assertSame(['test' => '002'], $actual);
     }
 
+    /**
+     * @return void
+     */
     public function test_writelines_successful()
     {
         $ndjson = new NDJSON('php://memory');