Merge pull request #9 from zaengle/develop

Adds support for Laravel 10 and drops lower than Laravel 8

Author: jesseschutt

.github/workflows/php.yml

@@ -17,11 +17,11 @@ jobs:
     - name: Setup PHP
       uses: shivammathur/setup-php@v2
       with:
-        php-version: '7.4'
+        php-version: '8.1'
 
     - name: Validate composer.json and composer.lock
       run: composer validate
-      
+
     - name: Cache Composer packages
       id: composer-cache
       uses: actions/cache@v2

README.md

@@ -65,7 +65,7 @@ The first step in using the Zaengle Pipeline is to create a Data Traveler class.
 $traveler = (new RegisterTraveler())->setRequest(request()->all());
 ```
 
-While not required, by extending `Zaengle\Pipeline\Contracts\AbstractTraveler` you will inherit additional methods utilized in the `Zaengle\Pipeline\Pipeline` class.
+`Zaengle\Pipeline\Contracts\AbstractTraveler` provides additional methods utilized in the `Zaengle\Pipeline\Pipeline` class.
 
 ```php
 <?php
@@ -122,7 +122,7 @@ use App\User;
 use Zaengle\Pipeline\Contracts\PipeInterface;
 
 class CreateUser implements PipeInterface {
-    public function handle($traveler, \Closure $next)
+    public function handle(RegisterTraveler|AbstractTraveler $traveler, \Closure $next): RegisterTraveler
     {
         $traveler->setUser(
             User::create([
@@ -144,7 +144,7 @@ use Zaengle\Pipeline\Contracts\PipeInterface;
 
 class HandleMailingList implements PipeInterface
 {
-    public function handle($traveler, \Closure $next)
+    public function handle(RegisterTraveler|AbstractTraveler $traveler, \Closure $next): RegisterTraveler
     {
         if ($traveler->getRequest()->subscribe) {
             MailingService::subscribe($traveler->getUser()->email);
@@ -171,7 +171,7 @@ $response = app(Pipeline::class)->pipe($traveler, $pipes, $useTransactions = tru
 ```
 
 #### Results
-Assuming the traveler extends `AbstractTraveler`, after sending the `$traveler` through the data pipes you will have access to a `->passed()` method which indicates whether the pipeline completed successfully or not. 
+After sending the `$traveler` through the data pipes you will have access to a `->passed()` method which indicates whether the pipeline completed successfully or not. 
 
 ```php
 $response = app(Pipeline::class)->pipe($traveler, $pipes, $useTransactions = true);
@@ -187,7 +187,7 @@ if ($response->passed()) {
 }
 ```
 
-Extending `AbstractTraveler` also grants you access to the following convenience methods:
+`AbstractTraveler` grants you access to the following convenience methods:
 
  *`$response->passed()`*
 

composer.json

@@ -10,14 +10,14 @@
     }
   ],
   "require": {
-    "php": "^7.3|^8.0",
-    "illuminate/support": "5.*|6.*|7.*|8.*|9.*",
-    "illuminate/console": "5.*|6.*|7.*|8.*|9.*"
+    "php": "^8.1",
+    "illuminate/support": "8.*|9.*|10.*",
+    "illuminate/console": "8.*|9.*|10.*"
   },
   "require-dev": {
     "mockery/mockery": ">=0.9.9",
     "phpunit/phpunit": ">=4.1",
-    "orchestra/testbench": "~3.6.0|~3.7.0|~3.8.0"
+    "orchestra/testbench": "~8.0"
   },
   "autoload": {
     "psr-4": {

phpunit.xml

@@ -1,16 +1,15 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit backupGlobals="false"
-         backupStaticAttributes="false"
-         bootstrap="vendor/autoload.php"
-         colors="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnError="false"
-         stopOnFailure="false"
-         verbose="true"
->
+<phpunit
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        backupGlobals="false"
+        bootstrap="vendor/autoload.php"
+        colors="true"
+        processIsolation="false"
+        stopOnError="false"
+        stopOnFailure="false"
+        xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd"
+        cacheDirectory=".phpunit.cache"
+        backupStaticProperties="false">
   <testsuites>
     <testsuite name="Zaengle Pipeline Test Suite">
       <directory suffix="Test.php">./tests/</directory>

src/Contracts/AbstractTraveler.php

@@ -2,91 +2,57 @@
 
 namespace Zaengle\Pipeline\Contracts;
 
-/**
- * Class AbstractTraveler.
- */
+use Exception;
+
 abstract class AbstractTraveler
 {
     const TRAVELER_SUCCESS = 'ok';
 
     const TRAVELER_FAIL = 'fail';
 
-    /**
-     * @var string
-     */
-    protected $status;
-
-    /**
-     * @var string
-     */
-    protected $message = 'Traveler passed successfully.';
-
-    /**
-     * @var \Exception
-     */
-    protected $exception;
-
-    /**
-     * @param  mixed  $status
-     * @return AbstractTraveler
-     */
-    public function setStatus($status)
+    protected string $status;
+
+    protected string $message = 'Traveler passed successfully.';
+
+    protected ?Exception $exception = null;
+
+    public function setStatus(string $status): AbstractTraveler
     {
         $this->status = $status;
 
         return $this;
     }
 
-    /**
-     * @return mixed
-     */
-    public function getStatus()
+    public function getStatus(): string
     {
         return $this->status;
     }
 
-    /**
-     * @param  mixed  $message
-     * @return AbstractTraveler
-     */
-    public function setMessage($message)
+    public function setMessage(string $message): AbstractTraveler
     {
         $this->message = $message;
 
         return $this;
     }
 
-    /**
-     * @return mixed
-     */
-    public function getMessage()
+    public function getMessage(): string
     {
         return $this->message;
     }
 
-    /**
-     * @param  mixed  $exception
-     * @return AbstractTraveler
-     */
-    public function setException($exception)
+    public function setException(Exception $exception): AbstractTraveler
     {
         $this->exception = $exception;
 
         return $this;
     }
 
-    /**
-     * @return mixed
-     */
-    public function getException()
+    public function getException(): ?Exception
     {
         return $this->exception;
     }
 
-    /**
-     * @return bool
-     */
-    public function passed()
+    public function passed(): bool
     {
         return $this->getStatus() === self::TRAVELER_SUCCESS;
     }

src/Contracts/PipeInterface.php

@@ -2,15 +2,9 @@
 
 namespace Zaengle\Pipeline\Contracts;
 
-/**
- * Interface PipeInterface.
- */
+use Closure;
+
 interface PipeInterface
 {
-    /**
-     * @param $traveler
-     * @param  \Closure  $next
-     * @return mixed
-     */
-    public function handle($traveler, \Closure $next);
+    public function handle(AbstractTraveler $traveler, Closure $next): AbstractTraveler;
 }

src/Example/ExamplePipeline.php

@@ -5,17 +5,14 @@
 use Zaengle\Pipeline\Example\Pipes\ExamplePipe;
 use Zaengle\Pipeline\Pipeline;
 
-/**
- * Class Example.
- */
 class ExamplePipeline
 {
     public function __invoke()
     {
         $traveler = (new ExampleTraveler())
-      ->setDemoData([
-          'name' => 'Zaengle',
-      ]);
+            ->setDemoData([
+                'name' => 'Zaengle',
+            ]);
 
         $pipes = [
             ExamplePipe::class,
@@ -27,9 +24,9 @@ public function __invoke()
             // Handle pass
         } else {
             // Handle fail
-      // $response->getException();
-      // $response->getMessage();
-      // $response->getStatus();
+            // $response->getException();
+            // $response->getMessage();
+            // $response->getStatus();
         }
     }
 }

src/Example/ExampleTraveler.php

@@ -4,29 +4,16 @@
 
 use Zaengle\Pipeline\Contracts\AbstractTraveler;
 
-/**
- * Class ExampleTraveler.
- */
 class ExampleTraveler extends AbstractTraveler
 {
-    /**
-     * @var mixed
-     */
-    private $demoData;
+    private array $demoData;
 
-    /**
-     * @return mixed
-     */
-    public function getDemoData()
+    public function getDemoData(): array
     {
         return $this->demoData;
     }
 
-    /**
-     * @param  mixed  $demoData
-     * @return ExampleTraveler
-     */
-    public function setDemoData($demoData)
+    public function setDemoData(array $demoData): ExampleTraveler
     {
         $this->demoData = $demoData;
 

src/Example/Pipes/ExamplePipe.php

@@ -2,17 +2,14 @@
 
 namespace Zaengle\Pipeline\Example\Pipes;
 
+use Closure;
+use Zaengle\Pipeline\Contracts\AbstractTraveler;
 use Zaengle\Pipeline\Contracts\PipeInterface;
+use Zaengle\Pipeline\Example\ExampleTraveler;
 
-/**
- * Class ExamplePipe.
- */
 class ExamplePipe implements PipeInterface
 {
-    /**
-     * {@inheritdoc}
-     */
-    public function handle($traveler, \Closure $next)
+    public function handle(ExampleTraveler|AbstractTraveler $traveler, Closure $next): AbstractTraveler
     {
         dump($traveler->getName());
 

src/Facade.php

@@ -2,15 +2,12 @@
 
 namespace Zaengle\Pipeline;
 
-/**
- * Class Facade.
- */
 class Facade extends \Illuminate\Support\Facades\Facade
 {
     /**
      * {@inheritdoc}
      */
-    protected static function getFacadeAccessor()
+    protected static function getFacadeAccessor(): string
     {
         return 'pipeline';
     }