Merge pull request #5 from bcremer/bump-php-compat

bcremer · web-flow · commit e95645fa62e0 · 2020-12-08T14:55:12.000+01:00
Introduce Github Actions / Increase minimum PHP Version
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -0,0 +1,90 @@
+
+# https://docs.github.com/en/actions
+
+name: Build
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  unit-tests:
+    name: Tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-version:
+          - 7.3
+          - 7.4
+          - 8.0
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          coverage: none
+          php-version: ${{ matrix.php-version }}
+
+      - 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-${{ matrix.php-version }}-composer-${{ hashFiles('composer.json') }}
+          restore-keys: php-${{ matrix.php-version }}-composer-
+
+      - name: Install dependencies
+        run: composer install --no-interaction --no-progress
+
+      - name: Run phpunit/phpunit
+        run: vendor/bin/phpunit
+
+  tests-with-coverage:
+    name: "Tests with coverage and PR Comments"
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-version:
+          - 7.4
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          coverage: pcov
+          php-version: ${{ matrix.php-version }}
+
+      - name: Setup problem matchers for PHP
+        run: echo "::add-matcher::${{ runner.tool_cache }}/php.json"
+
+      - name: Setup problem matchers for PHPUnit
+        run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
+
+      - 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-${{ matrix.php-version }}-composer-${{ hashFiles('composer.json') }}
+          restore-keys: php-${{ matrix.php-version }}-composer-
+
+      - name: Install dependencies
+        run: composer install --no-interaction --no-progress
+
+      - name: Run phpunit/phpunit with code coverage
+        run: vendor/bin/phpunit --coverage-text --coverage-clover=clover.xml --coverage-xml=coverage/coverage.xml --log-junit=coverage/junit.xml
+
+      - name: Run infection
+        run: vendor/bin/infection --threads=4 --min-msi=81 --min-covered-msi=81 --coverage=coverage
diff --git a/.gitignore b/.gitignore
@@ -2,5 +2,5 @@ vendor
 composer.lock
 clover.xml
 tests/testfile_*.txt
-ocular.phar
 infection-log.txt
+.phpunit.result.cache
diff --git a/.scrutinizer.yml b/.scrutinizer.yml
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -2,9 +2,7 @@
 
 [![Latest Version on Packagist][ico-version]][link-packagist]
 [![Software License][ico-license]](LICENSE.md)
-[![Build Status][ico-travis]][link-travis]
-[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
-[![Quality Score][ico-code-quality]][link-code-quality]
+[![Build Status][ico-ghactions]][link-ghactions]
 
 LineReader is a library to read large files line by line in a memory efficient (constant) way.
 
@@ -131,11 +129,6 @@ The MIT License (MIT). Please see [License File](LICENSE) for more information.
 
 [ico-version]: https://img.shields.io/packagist/v/bcremer/line-reader.svg?style=flat-square
 [ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
-[ico-travis]: https://img.shields.io/travis/bcremer/LineReader/master.svg?style=flat-square
-[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/bcremer/LineReader.svg?style=flat-square
-[ico-code-quality]: https://img.shields.io/scrutinizer/g/bcremer/LineReader.svg?style=flat-square
-
 [link-packagist]: https://packagist.org/packages/bcremer/line-reader
-[link-travis]: https://travis-ci.org/bcremer/LineReader
-[link-scrutinizer]: https://scrutinizer-ci.com/g/bcremer/LineReader/code-structure
-[link-code-quality]: https://scrutinizer-ci.com/g/bcremer/LineReader
+[ico-ghactions]: https://github.com/bcremer/LineReader/workflows/Build/badge.svg
+[link-ghactions]: https://github.com/bcremer/LineReader/actions?query=workflow%3ABuild
diff --git a/composer.json b/composer.json
@@ -10,11 +10,11 @@
         }
     ],
     "require": {
-        "php": "~7.1|~7.2|~7.3"
+        "php": "^7.3|^7.4|^8.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^7.2",
-        "infection/infection": "^0.9"
+        "phpunit/phpunit": "^9.4",
+        "infection/infection": "^0.18"
     },
     "autoload": {
         "psr-4": {
diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -13,13 +13,12 @@
          failOnWarning="true"
          colors="true"
          verbose="true">
-
+    <coverage>
+        <include>
+            <directory suffix=".php">./src</directory>
+        </include>
+    </coverage>
     <testsuite name="LineReader tests">
         <directory>tests</directory>
     </testsuite>
-    <filter>
-        <whitelist addUncoveredFilesFromWhitelist="true">
-            <directory suffix=".php">./src</directory>
-        </whitelist>
-    </filter>
 </phpunit>
diff --git a/tests/LineReaderTest.php b/tests/LineReaderTest.php
@@ -9,7 +9,7 @@ class LineReaderTest extends TestCase
     private static $maxLines;
     private static $testFile;
 
-    public static function setUpBeforeClass()
+    public static function setUpBeforeClass(): void
     {
         self::$maxLines = (int)getenv('TEST_MAX_LINES') ?: 10000;
         self::$testFile = __DIR__.'/testfile_'.self::$maxLines.'.txt';
@@ -25,29 +25,23 @@ public static function setUpBeforeClass()
         fclose($fh);
     }
 
-    public function testCanNotBeInstantiated()
-    {
-        $this->expectException(\Error::class);
-        new LineReader();
-    }
-
-    public function testReadLinesThrowsException()
+    public function testReadLinesThrowsException(): void
     {
         $this->expectException(\InvalidArgumentException::class);
         $this->expectExceptionMessage('Cannot open file for reading: /tmp/invalid-file.txt');
 
         LineReader::readLines('/tmp/invalid-file.txt');
     }
 
-    public function testReadLinesBackwardsThrowsException()
+    public function testReadLinesBackwardsThrowsException(): void
     {
         $this->expectException(\InvalidArgumentException::class);
         $this->expectExceptionMessage('Cannot open file for reading: /tmp/invalid-file.txt');
 
         LineReader::readLinesBackwards('/tmp/invalid-file.txt');
     }
 
-    public function testReadsAllLines()
+    public function testReadsAllLines(): void
     {
         $result = LineReader::readLines(self::$testFile);
 
@@ -59,7 +53,7 @@ public function testReadsAllLines()
         $this->assertLines($result, $firstLine, $lastLine, $lineCount);
     }
 
-    public function testReadsLinesByStartline()
+    public function testReadsLinesByStartline(): void
     {
         $lineGenerator = LineReader::readLines(self::$testFile);
         $lineGenerator = new \LimitIterator($lineGenerator, 50);
@@ -70,7 +64,7 @@ public function testReadsLinesByStartline()
         $this->assertLines($lineGenerator, $firstLine, $lastLine, $lineCount);
     }
 
-    public function testReadsLinesByLimit()
+    public function testReadsLinesByLimit(): void
     {
         $lineGenerator = LineReader::readLines(self::$testFile);
         $lineGenerator = new \LimitIterator($lineGenerator, 50, 100);
@@ -81,7 +75,7 @@ public function testReadsLinesByLimit()
         $this->assertLines($lineGenerator, $firstLine, $lastLine, $lineCount);
     }
 
-    public function testReadsLinesBackwards()
+    public function testReadsLinesBackwards(): void
     {
         $lineGenerator = LineReader::readLinesBackwards(self::$testFile);
 
@@ -91,7 +85,7 @@ public function testReadsLinesBackwards()
         $this->assertLines($lineGenerator, $firstLine, $lastLine, $lineCount);
     }
 
-    public function testReadsLinesBackwardsWithOffsetAndLimit()
+    public function testReadsLinesBackwardsWithOffsetAndLimit(): void
     {
         $lineGenerator = LineReader::readLinesBackwards(self::$testFile);
         $lineGenerator = new \LimitIterator($lineGenerator, 10, 50);
@@ -102,7 +96,7 @@ public function testReadsLinesBackwardsWithOffsetAndLimit()
         $this->assertLines($lineGenerator, $firstLine, $lastLine, $lineCount);
     }
 
-    public function testEmptyFile()
+    public function testEmptyFile(): void
     {
         $testFile = __DIR__.'/testfile_empty.txt';
         $content = '';
@@ -115,7 +109,7 @@ public function testEmptyFile()
         self::assertSame([], iterator_to_array($lineGenerator));
     }
 
-    public function testFileWithLeadingAndTrailingNewlines()
+    public function testFileWithLeadingAndTrailingNewlines(): void
     {
         $testFile = __DIR__.'/testfile_space.txt';
 
@@ -166,11 +160,8 @@ public function testFileWithLeadingAndTrailingNewlines()
      * Runs the generator and asserts on first, last and the total line count
      *
      * @param \Traversable $generator
-     * @param int $firstLine
-     * @param int $lastLine
-     * @param int $lineCount
      */
-    private function assertLines(\Traversable $generator, $firstLine, $lastLine, $lineCount)
+    private function assertLines(\Traversable $generator, string $firstLine, int $lastLine, int $lineCount): void
     {
         $count = 0;
         $line = '';

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ class LineReaderTest extends TestCase`
`9`	`9`	`private static $maxLines;`
`10`	`10`	`private static $testFile;`
`11`	`11`
`12`		`- public static function setUpBeforeClass()`
	`12`	`+ public static function setUpBeforeClass(): void`
`13`	`13`	`{`
`14`	`14`	`self::$maxLines = (int)getenv('TEST_MAX_LINES') ?: 10000;`
`15`	`15`	`self::$testFile = __DIR__.'/testfile_'.self::$maxLines.'.txt';`
`@@ -25,29 +25,23 @@ public static function setUpBeforeClass()`
`25`	`25`	`fclose($fh);`
`26`	`26`	`}`
`27`	`27`
`28`		`- public function testCanNotBeInstantiated()`
`29`		`- {`
`30`		`- $this->expectException(\Error::class);`
`31`		`- new LineReader();`
`32`		`- }`
`33`		`-`
`34`		`- public function testReadLinesThrowsException()`
	`28`	`+ public function testReadLinesThrowsException(): void`
`35`	`29`	`{`
`36`	`30`	`$this->expectException(\InvalidArgumentException::class);`
`37`	`31`	`$this->expectExceptionMessage('Cannot open file for reading: /tmp/invalid-file.txt');`
`38`	`32`
`39`	`33`	`LineReader::readLines('/tmp/invalid-file.txt');`
`40`	`34`	`}`
`41`	`35`
`42`		`- public function testReadLinesBackwardsThrowsException()`
	`36`	`+ public function testReadLinesBackwardsThrowsException(): void`
`43`	`37`	`{`
`44`	`38`	`$this->expectException(\InvalidArgumentException::class);`
`45`	`39`	`$this->expectExceptionMessage('Cannot open file for reading: /tmp/invalid-file.txt');`
`46`	`40`
`47`	`41`	`LineReader::readLinesBackwards('/tmp/invalid-file.txt');`
`48`	`42`	`}`
`49`	`43`
`50`		`- public function testReadsAllLines()`
	`44`	`+ public function testReadsAllLines(): void`
`51`	`45`	`{`
`52`	`46`	`$result = LineReader::readLines(self::$testFile);`
`53`	`47`
`@@ -59,7 +53,7 @@ public function testReadsAllLines()`
`59`	`53`	`$this->assertLines($result, $firstLine, $lastLine, $lineCount);`
`60`	`54`	`}`
`61`	`55`
`62`		`- public function testReadsLinesByStartline()`
	`56`	`+ public function testReadsLinesByStartline(): void`
`63`	`57`	`{`
`64`	`58`	`$lineGenerator = LineReader::readLines(self::$testFile);`
`65`	`59`	`$lineGenerator = new \LimitIterator($lineGenerator, 50);`
`@@ -70,7 +64,7 @@ public function testReadsLinesByStartline()`
`70`	`64`	`$this->assertLines($lineGenerator, $firstLine, $lastLine, $lineCount);`
`71`	`65`	`}`
`72`	`66`
`73`		`- public function testReadsLinesByLimit()`
	`67`	`+ public function testReadsLinesByLimit(): void`
`74`	`68`	`{`
`75`	`69`	`$lineGenerator = LineReader::readLines(self::$testFile);`
`76`	`70`	`$lineGenerator = new \LimitIterator($lineGenerator, 50, 100);`
`@@ -81,7 +75,7 @@ public function testReadsLinesByLimit()`
`81`	`75`	`$this->assertLines($lineGenerator, $firstLine, $lastLine, $lineCount);`
`82`	`76`	`}`
`83`	`77`
`84`		`- public function testReadsLinesBackwards()`
	`78`	`+ public function testReadsLinesBackwards(): void`
`85`	`79`	`{`
`86`	`80`	`$lineGenerator = LineReader::readLinesBackwards(self::$testFile);`
`87`	`81`
`@@ -91,7 +85,7 @@ public function testReadsLinesBackwards()`
`91`	`85`	`$this->assertLines($lineGenerator, $firstLine, $lastLine, $lineCount);`
`92`	`86`	`}`
`93`	`87`
`94`		`- public function testReadsLinesBackwardsWithOffsetAndLimit()`
	`88`	`+ public function testReadsLinesBackwardsWithOffsetAndLimit(): void`
`95`	`89`	`{`
`96`	`90`	`$lineGenerator = LineReader::readLinesBackwards(self::$testFile);`
`97`	`91`	`$lineGenerator = new \LimitIterator($lineGenerator, 10, 50);`
`@@ -102,7 +96,7 @@ public function testReadsLinesBackwardsWithOffsetAndLimit()`
`102`	`96`	`$this->assertLines($lineGenerator, $firstLine, $lastLine, $lineCount);`
`103`	`97`	`}`
`104`	`98`
`105`		`- public function testEmptyFile()`
	`99`	`+ public function testEmptyFile(): void`
`106`	`100`	`{`
`107`	`101`	`$testFile = __DIR__.'/testfile_empty.txt';`
`108`	`102`	`$content = '';`
`@@ -115,7 +109,7 @@ public function testEmptyFile()`
`115`	`109`	`self::assertSame([], iterator_to_array($lineGenerator));`
`116`	`110`	`}`
`117`	`111`
`118`		`- public function testFileWithLeadingAndTrailingNewlines()`
	`112`	`+ public function testFileWithLeadingAndTrailingNewlines(): void`
`119`	`113`	`{`
`120`	`114`	`$testFile = __DIR__.'/testfile_space.txt';`
`121`	`115`
`@@ -166,11 +160,8 @@ public function testFileWithLeadingAndTrailingNewlines()`
`166`	`160`	`* Runs the generator and asserts on first, last and the total line count`
`167`	`161`	`*`
`168`	`162`	`* @param \Traversable $generator`
`169`		`- * @param int $firstLine`
`170`		`- * @param int $lastLine`
`171`		`- * @param int $lineCount`
`172`	`163`	`*/`
`173`		`- private function assertLines(\Traversable $generator, $firstLine, $lastLine, $lineCount)`
	`164`	`+ private function assertLines(\Traversable $generator, string $firstLine, int $lastLine, int $lineCount): void`
`174`	`165`	`{`
`175`	`166`	`$count = 0;`
`176`	`167`	`$line = '';`