Merge pull request #15 from ElvenSpellmaker/feature/pipesys-examples

Adds examples and sets them up as tests.

Author: ElvenSpellmaker

.gitignore

@@ -2,3 +2,4 @@
 /vendor/
 /bin/sca/phpcs.txt
 /bin/sca/phpmd.html
+composer.lock

.travis.yml

@@ -1,10 +1,18 @@
 language: php
+
 php:
   - '5.6'
   - '7.0'
   - hhvm
   - nightly
+
 install: composer install
+
+matrix:
+  allow_failures:
+    - php: hhvm
+
 script:
   - ./vendor/bin/phpcs --standard=phpcs.xml src/
   - ./vendor/bin/phpmd src/ text phpmd.xml
+  - ./bin/runtests.sh

bin/runtests.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+BASEDIR=$(dirname $0)
+
+php BASEDIR/../tests/TestRig.php

composer.json

@@ -12,7 +12,8 @@
 	],
 	"require-dev": {
 		"ve-interactive/php-sniffer-rules": "dev-master",
-		"ve-interactive/php-mess-detector": "*"
+		"ve-interactive/php-mess-detector": "*",
+		"phpdocumentor/reflection-docblock": "2.0.4"
 	},
 	"require": {
 		"php": ">=5.6.0"

examples/GrepExample.php

@@ -0,0 +1,19 @@
+<?php
+/**
+ * @title    Basic example to show grepping.
+ * @command  ChattyYes | grep 'Yes\|Chatty' | head
+ * @expected Yes\nChatty\nYes\nChatty\nYes\nChatty\nYes\nChatty\nYes\nChatty\n
+ */
+
+error_reporting(E_ALL);
+
+include __DIR__ . '/../vendor/autoload.php';
+
+use ElvenSpellmaker\PipeSys as PS;
+use ElvenSpellmaker\PipeSys\Command as Command;
+
+$c = new PS\Scheduler(new Command\StandardConnector);
+$c->addCommand(new Command\ChattyYes);
+$c->addCommand(new Command\Grep('Yes|Chatty'));
+$c->addCommand(new Command\Head);
+$c->run();

examples/LargeToSmallHeadExample.php

@@ -0,0 +1,19 @@
+<?php
+/**
+ * @title    Example to show large head into smaller head.
+ * @command  ChattyYes | head -n 200 | head -n 7
+ * @expected Yes\nI\nAm\nChatty\nYes\nI\nAm\n
+ */
+
+error_reporting(E_ALL);
+
+include __DIR__ . '/../vendor/autoload.php';
+
+use ElvenSpellmaker\PipeSys as PS;
+use ElvenSpellmaker\PipeSys\Command as Command;
+
+$c = new PS\Scheduler(new Command\StandardConnector);
+$c->addCommand(new Command\ChattyYes);
+$c->addCommand(new Command\Head(200));
+$c->addCommand(new Command\Head(7));
+$c->run();

examples/SmallToLargeHeadExample.php

@@ -0,0 +1,19 @@
+<?php
+/**
+ * @title    Example to show small head into larger head.
+ * @command  ChattyYes | head -n 5 | head
+ * @expected Yes\nI\nAm\nChatty\nYes\n
+ */
+
+error_reporting(E_ALL);
+
+include __DIR__ . '/../vendor/autoload.php';
+
+use ElvenSpellmaker\PipeSys as PS;
+use ElvenSpellmaker\PipeSys\Command as Command;
+
+$c = new PS\Scheduler(new Command\StandardConnector);
+$c->addCommand(new Command\ChattyYes);
+$c->addCommand(new Command\Head(5));
+$c->addCommand(new Command\Head(10));
+$c->run();

examples/YesHeadExample.php

@@ -0,0 +1,18 @@
+<?php
+/**
+ * @title    Basic example to show that `head` terminates `yes`.
+ * @command  yes | head
+ * @expected y\ny\ny\ny\ny\ny\ny\ny\ny\ny\n
+ */
+
+error_reporting(E_ALL);
+
+include __DIR__ . '/../vendor/autoload.php';
+
+use ElvenSpellmaker\PipeSys as PS;
+use ElvenSpellmaker\PipeSys\Command as Command;
+
+$c = new PS\Scheduler(new Command\StandardConnector);
+$c->addCommand(new Command\Yes);
+$c->addCommand(new Command\Head);
+$c->run();

examples/YesYesHeadExample.php

@@ -0,0 +1,19 @@
+<?php
+/**
+ * @title    Tests two infinite commands and a terminating command.
+ * @command  yes | yes | head
+ * @expected y\ny\ny\ny\ny\ny\ny\ny\ny\ny\n
+ */
+
+error_reporting(E_ALL);
+
+include __DIR__ . '/../vendor/autoload.php';
+
+use ElvenSpellmaker\PipeSys as PS;
+use ElvenSpellmaker\PipeSys\Command as Command;
+
+$c = new PS\Scheduler(new Command\StandardConnector);
+$c->addCommand(new Command\Yes);
+$c->addCommand(new Command\Yes);
+$c->addCommand(new Command\Head);
+$c->run();

src/PipeSys/Command/ChattyYes.php

@@ -21,10 +21,10 @@ class ChattyYes extends AbstractCommand
 	public function __construct()
 	{
 		$this->chatting = [
-			'Yes' . PHP_EOL,
-			'I' . PHP_EOL,
-			'Am' . PHP_EOL,
-			'Chatty' . PHP_EOL,
+			"Yes\n",
+			"I\n",
+			"Am\n",
+			"Chatty\n",
 		];
 	}