Merge pull request #146 from php-school/generic-comparison-result

Generic comparison failure result

Author: AydinHassan

src/Result/ComparisonFailure.php

@@ -0,0 +1,77 @@
+<?php
+
+namespace PhpSchool\PhpWorkshop\Result;
+
+/**
+ * @author Aydin Hassan <[email protected]>
+ */
+class ComparisonFailure implements FailureInterface
+{
+    /**
+     * @var string
+     */
+    private $name;
+
+    /**
+     * @var string
+     */
+    private $expectedValue;
+
+    /**
+     * @var string
+     */
+    private $actualValue;
+
+    /**
+     * @param string $name
+     * @param string $expectedValue
+     * @param string $actualValue
+     */
+    public function __construct($name, $expectedValue, $actualValue)
+    {
+        $this->name          = $name;
+        $this->expectedValue = $expectedValue;
+        $this->actualValue   = $actualValue;
+    }
+
+    /**
+     * @param string $name
+     * @param string $expectedValue
+     * @param string $actualValue
+     * @return static
+     */
+    public static function fromNameAndValues($name, $expectedValue, $actualValue)
+    {
+        return new static($name, $expectedValue, $actualValue);
+    }
+
+    /**
+     * Get the name of the check that this result was produced from.
+     *
+     * @return string
+     */
+    public function getCheckName()
+    {
+        return $this->name;
+    }
+
+    /**
+     * Get the expected value.
+     *
+     * @return string
+     */
+    public function getExpectedValue()
+    {
+        return $this->expectedValue;
+    }
+
+    /**
+     * Get the actual value.
+     *
+     * @return string
+     */
+    public function getActualValue()
+    {
+        return $this->actualValue;
+    }
+}

src/ResultRenderer/ComparisonFailureRenderer.php

@@ -0,0 +1,61 @@
+<?php
+
+namespace PhpSchool\PhpWorkshop\ResultRenderer;
+
+use PhpSchool\PhpWorkshop\Result\Cli\RequestFailure;
+use PhpSchool\PhpWorkshop\Result\ComparisonFailure;
+
+/**
+ * Renderer for `PhpSchool\PhpWorkshop\Result\ComparisonFailure`.
+ *
+ * @package PhpSchool\PhpWorkshop\ResultRenderer
+ */
+class ComparisonFailureRenderer implements ResultRendererInterface
+{
+    /**
+     * @var RequestFailure
+     */
+    private $result;
+
+    /**
+     * @param ComparisonFailure $result The failure.
+     */
+    public function __construct(ComparisonFailure $result)
+    {
+        $this->result = $result;
+    }
+
+    /**
+     * Print the actual and expected output.
+     *
+     * @param ResultsRenderer $renderer
+     * @return string
+     */
+    public function render(ResultsRenderer $renderer)
+    {
+        return sprintf(
+            "  %s\n%s\n\n  %s\n%s\n",
+            $renderer->style('YOUR OUTPUT:', ['bold', 'yellow']),
+            $this->indent($renderer->style(sprintf('"%s"', $this->result->getActualValue()), 'red')),
+            $renderer->style('EXPECTED OUTPUT:', ['bold', 'yellow']),
+            $this->indent($renderer->style(sprintf('"%s"', $this->result->getExpectedValue()), 'green'))
+        );
+    }
+
+    /**
+     * @param string $string
+     * @return string
+     */
+    private function indent($string)
+    {
+        return implode(
+            "\n",
+            array_map(
+                function ($line) {
+                    return sprintf('  %s', $line);
+                },
+                explode("\n", $string)
+            )
+        );
+    }
+}

test/Result/ComparisonFailureTest.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace PhpSchool\PhpWorkshopTest\Result;
+
+use PhpSchool\PhpWorkshop\Result\ComparisonFailure;
+use PHPUnit_Framework_TestCase;
+use PhpSchool\PhpWorkshop\Result\StdOutFailure;
+
+/**
+ * @author Aydin Hassan <[email protected]>
+ */
+class ComparisonFailureTest extends PHPUnit_Framework_TestCase
+{
+    public function testGetters()
+    {
+        $failure = new ComparisonFailure('Name', 'Expected Output', 'Actual Output');
+        self::assertSame('Name', $failure->getCheckName());
+        self::assertEquals('Expected Output', $failure->getExpectedValue());
+        self::assertEquals('Actual Output', $failure->getActualValue());
+    }
+
+    public function testFailureFromArgsAndOutput()
+    {
+        $failure = ComparisonFailure::fromNameAndValues('Name', 'Expected Output', 'Actual Output');
+        self::assertSame('Name', $failure->getCheckName());
+        self::assertEquals('Expected Output', $failure->getExpectedValue());
+        self::assertEquals('Actual Output', $failure->getActualValue());
+    }
+}

test/ResultRenderer/ComparisonFailureRendererTest.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace PhpSchool\PhpWorkshopTest\ResultRenderer;
+
+use PhpSchool\PhpWorkshop\Result\ComparisonFailure;
+use PhpSchool\PhpWorkshop\ResultRenderer\ComparisonFailureRenderer;
+
+/**
+ * @author Aydin Hassan <[email protected]>
+ */
+class ComparisonFailureRendererTest extends AbstractResultRendererTest
+{
+    public function testRender()
+    {
+        $failure  = new ComparisonFailure('Name', 'EXPECTED OUTPUT', 'ACTUAL OUTPUT');
+        $renderer = new ComparisonFailureRenderer($failure);
+
+        $expected  = "  \e[33m\e[1mYOUR OUTPUT:\e[0m\e[0m\n";
+        $expected .= "  \e[31m\"ACTUAL OUTPUT\"\e[0m\n\n";
+        $expected .= "  \e[33m\e[1mEXPECTED OUTPUT:\e[0m\e[0m\n";
+        $expected .= "  \e[32m\"EXPECTED OUTPUT\"\e[0m\n";
+
+        $this->assertEquals($expected, $renderer->render($this->getRenderer()));
+    }
+}