Merge pull request #8 from mitelg/add-php-82

Add PHP 8.2 compatibility

Author: bcremer

.github/workflows/build.yaml

@@ -10,16 +10,48 @@ on:
       - main
 
 jobs:
+  static-analysis:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          coverage: none
+          php-version: 7.4
+
+      - name: Determine composer cache directory
+        id: determine-composer-cache-directory
+        run: echo "::set-output name=directory::$(composer config cache-dir)"
+
+      - name: Cache dependencies installed with composer
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.determine-composer-cache-directory.outputs.directory }}
+          key: php-7.4-composer-${{ hashFiles('composer.json') }}
+          restore-keys: php-7.4-composer-
+
+      - name: Install dependencies
+        run: composer install --no-interaction --no-progress
+
+      - name: Check code style
+        run: composer cs-check
+
+      - name: Check PHPStan
+        run: composer phpstan
+
   unit-tests:
     name: Tests
     runs-on: ubuntu-latest
     strategy:
       matrix:
         php-version:
-          - 7.3
           - 7.4
           - 8.0
           - 8.1
+          - 8.2
     steps:
       - name: Checkout
         uses: actions/checkout@v2

.gitignore

@@ -4,3 +4,5 @@ clover.xml
 tests/testfile_*.txt
 infection-log.txt
 .phpunit.result.cache
+.idea
+.php-cs-fixer.cache

.php-cs-fixer.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Finder;
+
+$finder = Finder::create()
+    ->in('src')
+    ->in('tests');
+
+$config = new Config();
+
+return $config
+    ->setRiskyAllowed(true)
+    ->setRules([
+        '@PSR12' => true,
+        '@Symfony' => true,
+        'concat_space' => ['spacing' => 'one'],
+        'declare_strict_types' => true,
+        'increment_style' => ['style' => 'post'],
+        'native_function_invocation' => true,
+        'no_superfluous_phpdoc_tags' => true,
+        'phpdoc_summary' => false,
+        'yoda_style' => ['equal' => false, 'identical' => false, 'less_and_greater' => false],
+    ])
+    ->setFinder($finder);

CHANGELOG.md

@@ -1,11 +1,17 @@
+## 1.3.0
+- Introduced support for PHP 8.2
+- Added code style fixer
+- Added PHPStan analysis
+- Drop support for PHP 7.3
+
 ## 1.2.0
 - Introduced support for PHP 8.1
 
 ## 1.1.0
 - Introduced support for PHP 7.4
 - Introduced support for PHP 8.0
 - Bumped minimum PHP Version to 7.3
-- Introduced github actions
+- Introduced GitHub actions
 
 ## 1.0.1
 
@@ -29,5 +35,3 @@
 ## 0.1.0
 
 - Initial Release
-
-

composer.json

@@ -10,11 +10,14 @@
         }
     ],
     "require": {
-        "php": "^7.3|^7.4|^8.0|^8.1"
+        "php": "^7.4 || ^8.0"
     },
     "require-dev": {
         "phpunit/phpunit": "^9.4",
-        "infection/infection": "^0.18"
+        "infection/infection": "^0.26",
+        "friendsofphp/php-cs-fixer": "3.13.2",
+        "phpstan/phpstan": "1.9.14",
+        "phpstan/phpstan-phpunit": "1.3.3"
     },
     "autoload": {
         "psr-4": {
@@ -27,6 +30,14 @@
         }
     },
     "scripts": {
-        "test": "phpunit"
+        "test": "phpunit",
+        "cs-fix": "php-cs-fixer fix -v",
+        "cs-check": "php-cs-fixer fix --dry-run -v",
+        "phpstan": "phpstan"
+    },
+    "config": {
+        "allow-plugins": {
+            "infection/extension-installer": true
+        }
     }
 }

phpstan.neon

@@ -0,0 +1,6 @@
+parameters:
+    level: max
+    phpVersion: 70300
+    paths:
+        - src
+        - tests

src/LineReader.php

@@ -1,17 +1,21 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Bcremer\LineReader;
 
 final class LineReader
 {
     /**
      * Prevent instantiation
      */
-    private function __construct() {}
+    private function __construct()
+    {
+    }
 
     /**
-     * @param string $filePath
-     * @return \Generator
+     * @return \Generator<int, string, void, void>
+     *
      * @throws \InvalidArgumentException if $filePath is not readable
      */
     public static function readLines(string $filePath): \Generator
@@ -24,8 +28,8 @@ public static function readLines(string $filePath): \Generator
     }
 
     /**
-     * @param string $filePath
-     * @return \Generator
+     * @return \Generator<int, string, void, void>
+     *
      * @throws \InvalidArgumentException if $filePath is not readable
      */
     public static function readLinesBackwards(string $filePath): \Generator
@@ -35,13 +39,15 @@ public static function readLinesBackwards(string $filePath): \Generator
         }
 
         $size = filesize($filePath);
+        if (!\is_int($size)) {
+            throw new \RuntimeException('Could not get file size');
+        }
 
         return self::readBackwards($fh, $size);
     }
 
     /**
      * @param resource $fh
-     * @return \Generator
      */
     private static function read($fh): \Generator
     {
@@ -60,9 +66,10 @@ private static function read($fh): \Generator
      * a newline character.
      *
      * @see http://stackoverflow.com/a/10494801/147634
+     *
      * @param resource $fh
-     * @param int $pos
-     * @return \Generator
+     *
+     * @return \Generator<int, string, void, void>
      */
     private static function readBackwards($fh, int $pos): \Generator
     {
@@ -79,7 +86,7 @@ private static function readBackwards($fh, int $pos): \Generator
                 continue;
             }
 
-            if ($pos === 0) {
+            if ($pos === 0 && \is_array($buffer)) {
                 yield array_pop($buffer);
                 break;
             }
@@ -91,7 +98,13 @@ private static function readBackwards($fh, int $pos): \Generator
                 $pos -= $bufferSize;
             }
             fseek($fh, $pos);
+            if ($bufferSize < 0) {
+                throw new \RuntimeException('Buffer size cannot be negative');
+            }
             $chunk = fread($fh, $bufferSize);
+            if (!\is_string($chunk)) {
+                throw new \RuntimeException('Could not read file');
+            }
             if ($buffer === null) {
                 // remove single trailing newline, rtrim cannot be used here
                 if (substr($chunk, -1) === "\n") {

tests/LineReaderTest.php

@@ -1,24 +1,29 @@
 <?php
+
+declare(strict_types=1);
+
 namespace Bcremer\LineReaderTests;
 
 use Bcremer\LineReader\LineReader;
 use PHPUnit\Framework\TestCase;
 
 class LineReaderTest extends TestCase
 {
-    private static $maxLines;
-    private static $testFile;
+    private static int $maxLines;
+
+    private static string $testFile;
 
     public static function setUpBeforeClass(): void
     {
-        self::$maxLines = (int)getenv('TEST_MAX_LINES') ?: 10000;
-        self::$testFile = __DIR__.'/testfile_'.self::$maxLines.'.txt';
+        self::$maxLines = (int) getenv('TEST_MAX_LINES') ?: 10000;
+        self::$testFile = __DIR__ . '/testfile_' . self::$maxLines . '.txt';
 
         if (is_file(self::$testFile)) {
             return;
         }
 
         $fh = fopen(self::$testFile, 'w');
+        self::assertIsResource($fh);
         for ($i = 1; $i <= self::$maxLines; $i++) {
             fwrite($fh, "Line $i\n");
         }
@@ -45,8 +50,6 @@ public function testReadsAllLines(): void
     {
         $result = LineReader::readLines(self::$testFile);
 
-        self::assertInstanceOf(\Traversable::class, $result);
-
         $firstLine = 1;
         $lastLine = self::$maxLines;
         $lineCount = self::$maxLines;
@@ -60,7 +63,7 @@ public function testReadsLinesByStartline(): void
 
         $firstLine = 51;
         $lastLine = self::$maxLines;
-        $lineCount = self::$maxLines-50;
+        $lineCount = self::$maxLines - 50;
         $this->assertLines($lineGenerator, $firstLine, $lastLine, $lineCount);
     }
 
@@ -90,15 +93,15 @@ public function testReadsLinesBackwardsWithOffsetAndLimit(): void
         $lineGenerator = LineReader::readLinesBackwards(self::$testFile);
         $lineGenerator = new \LimitIterator($lineGenerator, 10, 50);
 
-        $firstLine = self::$maxLines-10;
-        $lastLine = self::$maxLines-59;
+        $firstLine = self::$maxLines - 10;
+        $lastLine = self::$maxLines - 59;
         $lineCount = 50;
         $this->assertLines($lineGenerator, $firstLine, $lastLine, $lineCount);
     }
 
     public function testEmptyFile(): void
     {
-        $testFile = __DIR__.'/testfile_empty.txt';
+        $testFile = __DIR__ . '/testfile_empty.txt';
         $content = '';
         file_put_contents($testFile, $content);
 
@@ -111,7 +114,7 @@ public function testEmptyFile(): void
 
     public function testFileWithLeadingAndTrailingNewlines(): void
     {
-        $testFile = __DIR__.'/testfile_space.txt';
+        $testFile = __DIR__ . '/testfile_space.txt';
 
         $content = <<<CONTENT
 
@@ -159,20 +162,20 @@ public function testFileWithLeadingAndTrailingNewlines(): void
     /**
      * Runs the generator and asserts on first, last and the total line count
      *
-     * @param \Traversable $generator
+     * @param \Traversable<string> $generator
      */
-    private function assertLines(\Traversable $generator, string $firstLine, int $lastLine, int $lineCount): void
+    private function assertLines(\Traversable $generator, int $firstLine, int $lastLine, int $lineCount): void
     {
         $count = 0;
         $line = '';
         foreach ($generator as $line) {
             if ($count === 0) {
-                self::assertSame("Line $firstLine", $line, 'Expect first line');
+                self::assertSame(sprintf('Line %s', $firstLine), $line, 'Expect first line');
             }
             $count++;
         }
 
-        self::assertSame("Line $lastLine", $line, 'Expect last line');
+        self::assertSame(sprintf('Line %s', $lastLine), $line, 'Expect last line');
         self::assertSame($lineCount, $count, 'Expect total line count');
     }
 }