Merge pull request #8 from phpsu/task/add-psalm-shepherd

add shepherd.dev for psalm coverage

Author: ChrisB9

.github/workflows/shepherd.yml

@@ -0,0 +1,16 @@
+name: Run Shepherd
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress --no-suggest
+
+      - name: Run Psalm
+        run: composer psalm -- --output-format=github --shepherd

src/ShellBuilder.php

@@ -14,7 +14,7 @@
 use PHPSu\ShellCommandBuilder\Exception\ShellBuilderException;
 use TypeError;
 
-final class ShellBuilder implements ShellInterface
+final class ShellBuilder implements ShellInterface, \JsonSerializable
 {
     /** @var array<ShellInterface|CollectionTuple>  */
     private $commandList = [];
@@ -32,6 +32,16 @@ public static function new(): self
         return new ShellBuilder();
     }
 
+    /**
+     * This is a shortcut for quicker fluid access to the command api
+     * @param string $executable
+     * @return ShellCommand
+     */
+    public static function command(string $executable): ShellCommand
+    {
+        return new ShellCommand($executable, new self());
+    }
+
     public function __construct(int $groupType = GroupType::NO_GROUP)
     {
         $this->groupType = $groupType;
@@ -213,6 +223,11 @@ private function validateCommand(ShellInterface $command, bool $allowEmpty): voi
         }
     }
 
+    public function jsonSerialize(): array
+    {
+        return $this->__toArray();
+    }
+
     /**
      * @return array<mixed>
      */

tests/ShellBuilderTest.php

@@ -579,4 +579,13 @@ public function testCommandDebugWithPipeAndCondition(): void
         $this->assertEquals('&&', $debug[1][0]);
         $this->assertEquals('|', $debug[2][0]);
     }
+
+    public function testJsonSerializeShellBuilder(): void
+    {
+        // command example from documentation
+        $echo = ShellBuilder::command('echo')->addArgument('hello world');
+        $grep = ShellBuilder::command('echo')->addShortOption('e', 'world');
+        $builder = ShellBuilder::new()->add($echo)->pipe($grep);
+        $this->assertJson(json_encode($builder));
+    }
 }