Merge pull request #1 from nopenopenope/readme-adaption

Adapt Readme, add test and add flow for workflow.

Author: bytes-commerce

.github/workflow/ci.yml .github/workflows/ci.yml.github/workflow/ci.yml renamed to .github/workflows/ci.yml

@@ -43,7 +43,13 @@ jobs:
         run: "composer install --no-interaction --no-progress --no-suggest"
 
       - name: "EasyCodingStandards for src"
-        run: "vendor/bin/ecs check src --no-interaction --no-progress-bar"
+        run: "vendor/bin/ecs check src tests --no-interaction --no-progress-bar"
 
       - name: "PhpStan for src"
         run: "vendor/bin/phpstan analyse --error-format=checkstyle src --level=8 | cs2pr"
+
+      - name: "PhpStan for tests"
+        run: "vendor/bin/phpstan analyse --error-format=checkstyle tests --level=6 | cs2pr"
+
+      - name: "PHPUnit Test"
+        run: "vendor/bin/phpunit tests/BaseTest.php"

.gitignore

@@ -1 +1,2 @@
 /vendor
+/.idea

.idea/inspectionProfiles/Project_Default.xml

@@ -51,7 +51,7 @@ Another example for automatic replacement in correctly formatted code:
 becomes
 
 ```php
-->with(...$this->consecutiveParams(
+->with(...$this->withConsecutive(
     ['a', 'b'],
     ['c', 'd'],
     ['e', 'f']

.idea/phpunit.xml

@@ -2,7 +2,13 @@
   "name": "seec/phpunit-consecutive-params",
   "type": "library",
   "description": "Drop-in Trait to use removed ConsecutiveParams from PhpUnit",
-  "keywords": ["phpunit","tdd","unit testing","variadic", "consecutive params"],
+  "keywords": [
+    "phpunit",
+    "tdd",
+    "unit testing",
+    "variadic",
+    "consecutive params"
+  ],
   "homepage": "https://github.com/nopenopenope/behat-test-runner",
   "license": "GPL-3.0-or-later",
   "minimum-stability": "dev",
@@ -15,7 +21,7 @@
     }
   ],
   "require": {
-    "php" : "^8.0"
+    "php": "^8.0"
   },
   "require-dev": {
     "phpstan/phpstan": "^1.10",
@@ -26,5 +32,10 @@
     "psr-4": {
       "SEEC\\PhpUnit\\Helper\\": "src"
     }
+  },
+  "autoload-dev": {
+    "psr-4": {
+      "SEEC\\PhpUnit\\Helper\\Tests\\": "tests"
+    }
   }
 }

README.md

@@ -11,5 +11,6 @@ services:
       - "host.docker.internal:host-gateway"
     volumes:
       - ./src:/var/www/html/src
+      - ./tests:/var/www/html/tests
       - ./vendor:/var/www/html/vendor
       - ./composer.json:/var/www/html/composer.json

composer.json

@@ -17,6 +17,7 @@ RUN apk add -u \
 
 COPY ./composer.json /var/www/html/composer.json
 COPY ./src /var/www/html/src
+COPY ./tests /var/www/html/tests
 COPY ./ecs.php /var/www/html/ecs.php
 COPY ./phpstan.neon /var/www/html/phpstan.neon
 

docker-compose.yml

@@ -4,11 +4,11 @@
 
 namespace SEEC\PhpUnit\Helper;
 
-use PHPUnit\Framework\TestCase;
 use function array_column;
 use function count;
 use PHPUnit\Framework\Constraint\Callback;
 use PHPUnit\Framework\Constraint\Constraint;
+use PHPUnit\Framework\TestCase;
 
 trait ConsecutiveParams
 {

docker/php/Dockerfile

@@ -0,0 +1,49 @@
+<?php
+
+declare(strict_types=1);
+
+namespace SEEC\PhpUnit\Helper\Tests;
+
+use PHPUnit\Framework\TestCase;
+use SEEC\PhpUnit\Helper\ConsecutiveParams;
+
+final class TestableClass
+{
+    public function foo(object $testClass): void
+    {
+        $testClass->setSomething(1);
+        $testClass->setSomething(2);
+    }
+}
+
+final class InputClass implements InputInterface
+{
+    public function setSomething(int $i): void
+    {
+    }
+}
+
+interface InputInterface
+{
+    public function setSomething(int $i): void;
+}
+
+final class BaseTest extends TestCase
+{
+    use ConsecutiveParams;
+
+    public function test_it_can_run_a_test(): void
+    {
+        $mockClass = $this->getMockBuilder(InputInterface::class)
+            ->onlyMethods(['setSomething'])
+            ->getMock();
+        $mockClass->expects($this->exactly(2))
+            ->method('setSomething')
+            ->with(...$this->withConsecutive(
+                [1],
+                [2]
+            ));
+        $testClass = new TestableClass();
+        $testClass->foo($mockClass);
+    }
+}