CI: Switch to Github Actions (#4)

bpolaszek · web-flow · commit 21b517399630 · 2021-12-13T11:44:51.000+01:00
diff --git a/.github/workflows/ci-workflow.yml b/.github/workflows/ci-workflow.yml
@@ -0,0 +1,67 @@
+name: CI Workflow
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  code-style:
+    name: Code Style & Static Analysis
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 7.1
+          extensions: mbstring, pcntl
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: Check code style
+        run: vendor/bin/phpcs --standard=psr2 -n src/
+
+
+  tests:
+    name: Test Suite
+    runs-on: ubuntu-20.04
+    strategy:
+      max-parallel: 10
+      matrix:
+        php:
+          - 7.1
+          - 7.2
+          - 7.3
+          - 7.4
+          - 8.0
+          - 8.1
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          extensions: mbstring, curl, zip
+          coverage: xdebug
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
+
+      - name: Run tests
+        run: vendor/bin/phpunit --coverage-clover=coverage.xml
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
diff --git a/.github/workflows/security-check.yml b/.github/workflows/security-check.yml
@@ -0,0 +1,21 @@
+name: Security Check
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+  schedule:
+    - cron: "0 0 1 * *"
+
+jobs:
+  security-check:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/cache@v2
+        id: cache-db
+        with:
+          path: ~/.symfony/cache
+          key: db
+      - uses: symfonycorp/security-checker-action@v2
diff --git a/.travis.yml b/.travis.yml
diff --git a/README.md b/README.md
@@ -1,13 +1,13 @@
 [![Latest Stable Version](https://poser.pugx.org/bentools/querystring/v/stable)](https://packagist.org/packages/bentools/querystring)
 [![License](https://poser.pugx.org/bentools/querystring/license)](https://packagist.org/packages/bentools/querystring)
-[![Build Status](https://img.shields.io/travis/bpolaszek/querystring/master.svg?style=flat-square)](https://travis-ci.org/bpolaszek/querystring)
-[![Coverage Status](https://coveralls.io/repos/github/bpolaszek/querystring/badge.svg?branch=master)](https://coveralls.io/github/bpolaszek/querystring?branch=master)
+[![CI Workflow](https://github.com/bpolaszek/querystring/actions/workflows/ci-workflow.yml/badge.svg)](https://github.com/bpolaszek/querystring/actions/workflows/ci-workflow.yml)
+[![Coverage](https://codecov.io/gh/bpolaszek/querystring/branch/master/graph/badge.svg?token=9AXQUHY1R7)](https://codecov.io/gh/bpolaszek/querystring)
 [![Quality Score](https://img.shields.io/scrutinizer/g/bpolaszek/querystring.svg?style=flat-square)](https://scrutinizer-ci.com/g/bpolaszek/querystring)
 [![Total Downloads](https://poser.pugx.org/bentools/querystring/downloads)](https://packagist.org/packages/bentools/querystring)
 
 # QueryString
 
-A PSR-7 compliant query string manipulator, with **no dependency**. Not even PSR-7, actually.
+A lightweight, object-oriented, Query String manipulation library.
 
 ## Why?
 
@@ -76,4 +76,4 @@ MIT
 
 [bentools/string-combinations](https://github.com/bpolaszek/string-combinations) - A string combinations generator.
 
-[bentools/flatten-iterator](https://github.com/bpolaszek/flatten-iterator) - An iterator that flattens multiple iterators or arrays. 
+[bentools/flatten-iterator](https://github.com/bpolaszek/flatten-iterator) - An iterator that flattens multiple iterators or arrays. 
diff --git a/composer.json b/composer.json
@@ -17,10 +17,9 @@
     },
     "require-dev": {
         "league/uri": "^5.0",
-        "php-coveralls/php-coveralls": "^2.4",
-        "phpunit/phpunit": "^5.0|^6.0|^7.0",
+        "phpunit/phpunit": "^7.5|^8.0|^9.0",
         "squizlabs/php_codesniffer": "^3.0",
-        "symfony/var-dumper": "^3.3"
+        "symfony/var-dumper": "@stable"
     },
     "autoload": {
         "psr-4": {
diff --git a/tests/ArrayValuesNormalizerRendererTest.php b/tests/ArrayValuesNormalizerRendererTest.php
@@ -13,7 +13,7 @@ class ArrayValuesNormalizerRendererTest extends TestCase
 
     private $defaultSeparator;
 
-    public function testRenderer()
+    public function testRenderer(): void
     {
         $data = [
             'foo' => 'bar',
@@ -41,7 +41,7 @@ public function testRenderer()
         $this->assertEquals('foo=bar&sort[bar]=desc&sort[foo]=asc&filters[foo][]=bar&filters[foo][]=baz&filters[bar][]=foo bar', urldecode($qs->withRenderer($renderer->withEncoding(PHP_QUERY_RFC1738))));
     }
 
-    public function testRendererOnlyAffectsKeys()
+    public function testRendererOnlyAffectsKeys(): void
     {
         $data = [
             'foo' => [
@@ -52,7 +52,7 @@ public function testRendererOnlyAffectsKeys()
         $this->assertEquals('foo%5B%5D=bar%20baz%5B0%5D', (string) $qs->withRenderer(withoutNumericIndices()));
     }
 
-    public function testChangeEncoding()
+    public function testChangeEncoding(): void
     {
         $renderer = ArrayValuesNormalizerRenderer::factory();
         $this->assertNotSame($renderer->withEncoding($renderer->getEncoding()), $renderer);
@@ -62,7 +62,7 @@ public function testChangeEncoding()
         $this->assertEquals(PHP_QUERY_RFC1738, $renderer->getEncoding());
     }
 
-    public function testChangeSeparator()
+    public function testChangeSeparator(): void
     {
 
         ini_set('arg_separator.output', '~');
@@ -83,23 +83,21 @@ public function testChangeSeparator()
         ini_set('arg_separator.output', $this->defaultSeparator);
     }
 
-    /**
-     * @expectedException  \RuntimeException
-     */
-    public function testBlankSeparator()
+    public function testBlankSeparator(): void
     {
+        $this->expectException(\RuntimeException::class);
         $qs = query_string(['foo' => 'bar', 'bar' => 'baz']);
         $renderer = ArrayValuesNormalizerRenderer::factory();
         $renderer = $renderer->withSeparator(''); // Blank separator
         $renderer->render($qs);
     }
 
-    public function setUp()
+    public function setUp(): void
     {
         $this->defaultSeparator = ini_get('arg_separator.output');
     }
 
-    public function tearDown()
+    public function tearDown(): void
     {
         ini_set('arg_separator.output', $this->defaultSeparator);
     }
diff --git a/tests/FlatRendererTest.php b/tests/FlatRendererTest.php
@@ -8,7 +8,7 @@
 
 class FlatRendererTest extends TestCase
 {
-    public function testRenderer()
+    public function testRenderer(): void
     {
         $data = [
             'foo' => 'bar',
diff --git a/tests/NativeParserTest.php b/tests/NativeParserTest.php
@@ -8,7 +8,7 @@
 class NativeParserTest extends TestCase
 {
 
-    public function testParser()
+    public function testParser(): void
     {
         $parser = new NativeParser();
         $this->assertEquals(['foo' => 'bar', 'baz' => 'bat'], $parser->parse('foo=bar&baz=bat'));
diff --git a/tests/NativeRendererTest.php b/tests/NativeRendererTest.php
@@ -11,7 +11,7 @@ class NativeRendererTest extends TestCase
 {
     private $defaultSeparator;
 
-    public function testRenderer()
+    public function testRenderer(): void
     {
         $data = [
             'foo' => 'bar',
@@ -40,24 +40,20 @@ public function testRenderer()
         $this->assertEquals('foo=bar&sort[bar]=desc&sort[foo]=asc&filters[foo][0]=bar&filters[foo][1]=baz&filters[bar][0]=foo bar', urldecode($qs->withRenderer($renderer->withEncoding(PHP_QUERY_RFC1738))));
     }
 
-    /**
-     * @expectedException \InvalidArgumentException
-     */
-    public function testFactoryFails()
+    public function testFactoryFails(): void
     {
+        $this->expectException(\InvalidArgumentException::class);
         NativeRenderer::factory(1000);
     }
 
-    /**
-     * @expectedException \InvalidArgumentException
-     */
-    public function testChangeEncodingFails()
+    public function testChangeEncodingFails(): void
     {
+        $this->expectException(\InvalidArgumentException::class);
         $renderer = NativeRenderer::factory();
         $renderer->withEncoding(1000);
     }
 
-    public function testChangeEncoding()
+    public function testChangeEncoding(): void
     {
         $renderer = NativeRenderer::factory();
         $this->assertNotSame($renderer->withEncoding($renderer->getEncoding()), $renderer);
@@ -67,7 +63,7 @@ public function testChangeEncoding()
         $this->assertEquals(PHP_QUERY_RFC1738, $renderer->getEncoding());
     }
 
-    public function testChangeSeparator()
+    public function testChangeSeparator(): void
     {
 
         ini_set('arg_separator.output', '~');
@@ -91,12 +87,12 @@ public function testChangeSeparator()
         ini_set('arg_separator.output', $this->defaultSeparator);
     }
 
-    public function setUp()
+    public function setUp(): void
     {
         $this->defaultSeparator = ini_get('arg_separator.output');
     }
 
-    public function tearDown()
+    public function tearDown(): void
     {
         ini_set('arg_separator.output', $this->defaultSeparator);
     }
diff --git a/tests/PairsTest.php b/tests/PairsTest.php
@@ -10,7 +10,7 @@
 class PairsTest extends TestCase
 {
 
-    public function testPairsWithoutDecoding()
+    public function testPairsWithoutDecoding(): void
     {
         $qs = (string) query_string('foo[bar]=baz bat');
         $pairs = new IteratorIterator(new Pairs($qs));
@@ -19,7 +19,7 @@ public function testPairsWithoutDecoding()
         $this->assertEquals('baz%20bat', $pairs->current());
     }
 
-    public function testPairsWithKeyDecoding()
+    public function testPairsWithKeyDecoding(): void
     {
         $qs = (string) query_string('foo[bar]=baz bat');
         $pairs = new IteratorIterator(new Pairs($qs, true));
@@ -34,7 +34,7 @@ public function testPairsWithKeyDecoding()
         $this->assertEquals('baz%20bat', $pairs->current());
     }
 
-    public function testPairsWithValueDecoding()
+    public function testPairsWithValueDecoding(): void
     {
         $qs = (string) query_string('foo[bar]=baz bat');
         $pairs = new IteratorIterator(new Pairs($qs, false, true));
@@ -49,21 +49,21 @@ public function testPairsWithValueDecoding()
         $this->assertEquals('baz bat', $pairs->current());
     }
 
-    public function testPairsWithDifferentSeparator()
+    public function testPairsWithDifferentSeparator(): void
     {
         $qs = 'foo=bar;baz=bat';
         $this->assertEquals(['foo' => 'bar', 'baz' => 'bat'], iterator_to_array(new Pairs($qs, false, false, ';')));
         $qs = 'foo=bar;baz=bat';
         $this->assertEquals(['foo' => 'bar', 'baz' => 'bat'], iterator_to_array((new Pairs($qs))->withSeparator(';')));
     }
 
-    public function testPairsWithMissingValues()
+    public function testPairsWithMissingValues(): void
     {
         $qs = 'foo=&baz';
         $this->assertEquals(['foo' => '', 'baz' => null], iterator_to_array(new Pairs($qs, false, false)));
     }
 
-    public function testPairsOnEmptyQueryString()
+    public function testPairsOnEmptyQueryString(): void
     {
         $qs = ' ';
         $this->assertEquals([], iterator_to_array(new Pairs($qs)));
diff --git a/tests/QueryStringTest.php b/tests/QueryStringTest.php

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ class ArrayValuesNormalizerRendererTest extends TestCase`
`13`	`13`
`14`	`14`	`private $defaultSeparator;`
`15`	`15`
`16`		`- public function testRenderer()`
	`16`	`+ public function testRenderer(): void`
`17`	`17`	`{`
`18`	`18`	`$data = [`
`19`	`19`	`'foo' => 'bar',`
`@@ -41,7 +41,7 @@ public function testRenderer()`
`41`	`41`	`$this->assertEquals('foo=bar&sort[bar]=desc&sort[foo]=asc&filters[foo][]=bar&filters[foo][]=baz&filters[bar][]=foo bar', urldecode($qs->withRenderer($renderer->withEncoding(PHP_QUERY_RFC1738))));`
`42`	`42`	`}`
`43`	`43`
`44`		`- public function testRendererOnlyAffectsKeys()`
	`44`	`+ public function testRendererOnlyAffectsKeys(): void`
`45`	`45`	`{`
`46`	`46`	`$data = [`
`47`	`47`	`'foo' => [`
`@@ -52,7 +52,7 @@ public function testRendererOnlyAffectsKeys()`
`52`	`52`	`$this->assertEquals('foo%5B%5D=bar%20baz%5B0%5D', (string) $qs->withRenderer(withoutNumericIndices()));`
`53`	`53`	`}`
`54`	`54`
`55`		`- public function testChangeEncoding()`
	`55`	`+ public function testChangeEncoding(): void`
`56`	`56`	`{`
`57`	`57`	`$renderer = ArrayValuesNormalizerRenderer::factory();`
`58`	`58`	`$this->assertNotSame($renderer->withEncoding($renderer->getEncoding()), $renderer);`
`@@ -62,7 +62,7 @@ public function testChangeEncoding()`
`62`	`62`	`$this->assertEquals(PHP_QUERY_RFC1738, $renderer->getEncoding());`
`63`	`63`	`}`
`64`	`64`
`65`		`- public function testChangeSeparator()`
	`65`	`+ public function testChangeSeparator(): void`
`66`	`66`	`{`
`67`	`67`
`68`	`68`	`ini_set('arg_separator.output', '~');`
`@@ -83,23 +83,21 @@ public function testChangeSeparator()`
`83`	`83`	`ini_set('arg_separator.output', $this->defaultSeparator);`
`84`	`84`	`}`
`85`	`85`
`86`		`- /**`
`87`		`- * @expectedException \RuntimeException`
`88`		`- */`
`89`		`- public function testBlankSeparator()`
	`86`	`+ public function testBlankSeparator(): void`
`90`	`87`	`{`
	`88`	`+ $this->expectException(\RuntimeException::class);`
`91`	`89`	`$qs = query_string(['foo' => 'bar', 'bar' => 'baz']);`
`92`	`90`	`$renderer = ArrayValuesNormalizerRenderer::factory();`
`93`	`91`	`$renderer = $renderer->withSeparator(''); // Blank separator`
`94`	`92`	`$renderer->render($qs);`
`95`	`93`	`}`
`96`	`94`
`97`		`- public function setUp()`
	`95`	`+ public function setUp(): void`
`98`	`96`	`{`
`99`	`97`	`$this->defaultSeparator = ini_get('arg_separator.output');`
`100`	`98`	`}`
`101`	`99`
`102`		`- public function tearDown()`
	`100`	`+ public function tearDown(): void`
`103`	`101`	`{`
`104`	`102`	`ini_set('arg_separator.output', $this->defaultSeparator);`
`105`	`103`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`
`9`	`9`	`class FlatRendererTest extends TestCase`
`10`	`10`	`{`
`11`		`- public function testRenderer()`
	`11`	`+ public function testRenderer(): void`
`12`	`12`	`{`
`13`	`13`	`$data = [`
`14`	`14`	`'foo' => 'bar',`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`	`class NativeParserTest extends TestCase`
`9`	`9`	`{`
`10`	`10`
`11`		`- public function testParser()`
	`11`	`+ public function testParser(): void`
`12`	`12`	`{`
`13`	`13`	`$parser = new NativeParser();`
`14`	`14`	`$this->assertEquals(['foo' => 'bar', 'baz' => 'bat'], $parser->parse('foo=bar&baz=bat'));`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ class NativeRendererTest extends TestCase`
`11`	`11`	`{`
`12`	`12`	`private $defaultSeparator;`
`13`	`13`
`14`		`- public function testRenderer()`
	`14`	`+ public function testRenderer(): void`
`15`	`15`	`{`
`16`	`16`	`$data = [`
`17`	`17`	`'foo' => 'bar',`
`@@ -40,24 +40,20 @@ public function testRenderer()`
`40`	`40`	`$this->assertEquals('foo=bar&sort[bar]=desc&sort[foo]=asc&filters[foo][0]=bar&filters[foo][1]=baz&filters[bar][0]=foo bar', urldecode($qs->withRenderer($renderer->withEncoding(PHP_QUERY_RFC1738))));`
`41`	`41`	`}`
`42`	`42`
`43`		`- /**`
`44`		`- * @expectedException \InvalidArgumentException`
`45`		`- */`
`46`		`- public function testFactoryFails()`
	`43`	`+ public function testFactoryFails(): void`
`47`	`44`	`{`
	`45`	`+ $this->expectException(\InvalidArgumentException::class);`
`48`	`46`	`NativeRenderer::factory(1000);`
`49`	`47`	`}`
`50`	`48`
`51`		`- /**`
`52`		`- * @expectedException \InvalidArgumentException`
`53`		`- */`
`54`		`- public function testChangeEncodingFails()`
	`49`	`+ public function testChangeEncodingFails(): void`
`55`	`50`	`{`
	`51`	`+ $this->expectException(\InvalidArgumentException::class);`
`56`	`52`	`$renderer = NativeRenderer::factory();`
`57`	`53`	`$renderer->withEncoding(1000);`
`58`	`54`	`}`
`59`	`55`
`60`		`- public function testChangeEncoding()`
	`56`	`+ public function testChangeEncoding(): void`
`61`	`57`	`{`
`62`	`58`	`$renderer = NativeRenderer::factory();`
`63`	`59`	`$this->assertNotSame($renderer->withEncoding($renderer->getEncoding()), $renderer);`
`@@ -67,7 +63,7 @@ public function testChangeEncoding()`
`67`	`63`	`$this->assertEquals(PHP_QUERY_RFC1738, $renderer->getEncoding());`
`68`	`64`	`}`
`69`	`65`
`70`		`- public function testChangeSeparator()`
	`66`	`+ public function testChangeSeparator(): void`
`71`	`67`	`{`
`72`	`68`
`73`	`69`	`ini_set('arg_separator.output', '~');`
`@@ -91,12 +87,12 @@ public function testChangeSeparator()`
`91`	`87`	`ini_set('arg_separator.output', $this->defaultSeparator);`
`92`	`88`	`}`
`93`	`89`
`94`		`- public function setUp()`
	`90`	`+ public function setUp(): void`
`95`	`91`	`{`
`96`	`92`	`$this->defaultSeparator = ini_get('arg_separator.output');`
`97`	`93`	`}`
`98`	`94`
`99`		`- public function tearDown()`
	`95`	`+ public function tearDown(): void`
`100`	`96`	`{`
`101`	`97`	`ini_set('arg_separator.output', $this->defaultSeparator);`
`102`	`98`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@`
`10`	`10`	`class PairsTest extends TestCase`
`11`	`11`	`{`
`12`	`12`
`13`		`- public function testPairsWithoutDecoding()`
	`13`	`+ public function testPairsWithoutDecoding(): void`
`14`	`14`	`{`
`15`	`15`	`$qs = (string) query_string('foo[bar]=baz bat');`
`16`	`16`	`$pairs = new IteratorIterator(new Pairs($qs));`
`@@ -19,7 +19,7 @@ public function testPairsWithoutDecoding()`
`19`	`19`	`$this->assertEquals('baz%20bat', $pairs->current());`
`20`	`20`	`}`
`21`	`21`
`22`		`- public function testPairsWithKeyDecoding()`
	`22`	`+ public function testPairsWithKeyDecoding(): void`
`23`	`23`	`{`
`24`	`24`	`$qs = (string) query_string('foo[bar]=baz bat');`
`25`	`25`	`$pairs = new IteratorIterator(new Pairs($qs, true));`
`@@ -34,7 +34,7 @@ public function testPairsWithKeyDecoding()`
`34`	`34`	`$this->assertEquals('baz%20bat', $pairs->current());`
`35`	`35`	`}`
`36`	`36`
`37`		`- public function testPairsWithValueDecoding()`
	`37`	`+ public function testPairsWithValueDecoding(): void`
`38`	`38`	`{`
`39`	`39`	`$qs = (string) query_string('foo[bar]=baz bat');`
`40`	`40`	`$pairs = new IteratorIterator(new Pairs($qs, false, true));`
`@@ -49,21 +49,21 @@ public function testPairsWithValueDecoding()`
`49`	`49`	`$this->assertEquals('baz bat', $pairs->current());`
`50`	`50`	`}`
`51`	`51`
`52`		`- public function testPairsWithDifferentSeparator()`
	`52`	`+ public function testPairsWithDifferentSeparator(): void`
`53`	`53`	`{`
`54`	`54`	`$qs = 'foo=bar;baz=bat';`
`55`	`55`	`$this->assertEquals(['foo' => 'bar', 'baz' => 'bat'], iterator_to_array(new Pairs($qs, false, false, ';')));`
`56`	`56`	`$qs = 'foo=bar;baz=bat';`
`57`	`57`	`$this->assertEquals(['foo' => 'bar', 'baz' => 'bat'], iterator_to_array((new Pairs($qs))->withSeparator(';')));`
`58`	`58`	`}`
`59`	`59`
`60`		`- public function testPairsWithMissingValues()`
	`60`	`+ public function testPairsWithMissingValues(): void`
`61`	`61`	`{`
`62`	`62`	`$qs = 'foo=&baz';`
`63`	`63`	`$this->assertEquals(['foo' => '', 'baz' => null], iterator_to_array(new Pairs($qs, false, false)));`
`64`	`64`	`}`
`65`	`65`
`66`		`- public function testPairsOnEmptyQueryString()`
	`66`	`+ public function testPairsOnEmptyQueryString(): void`
`67`	`67`	`{`
`68`	`68`	`$qs = ' ';`
`69`	`69`	`$this->assertEquals([], iterator_to_array(new Pairs($qs)));`