Switch out test system for a framework

Author: SMillerDev

composer.json

@@ -18,12 +18,14 @@
     }
   ],
   "require": {
-    "php": "5.6.* || 7.*",
+    "php": "~7.1",
     "ql/uri-template": "1.*",
     "michelf/php-markdown": "1.*",
-    "lukasoppermann/http-status": "2.*"
+    "lukasoppermann/http-status": "2.*",
+    "ext-json": "*"
   },
   "require-dev": {
+    "lunr/halo": "*",
     "phpunit/phpunit": "~7.0",
     "theseer/autoload": "1.*"
   },

src/PHPDraft/Core/BaseTest.php

@@ -50,9 +50,14 @@ public function __construct($filename = 'index.apib')
         set_include_path(get_include_path() . ':' . $this->location);
     }
 
+    /**
+     * Get parse the apib file.
+     *
+     * @return $this self reference.
+     */
     public function parse()
     {
-        $this->full_apib = $this->get_apib($this->filename);
+        $this->full_apib = $this->get_apib($this->filename, $this->location);
 
         return $this;
     }
@@ -61,19 +66,22 @@ public function parse()
      * Parse a given API Blueprint file
      * This changes all `include(file)` tags to the contents of the file.
      *
-     * @param string $filename File to parse
+     * @param string      $filename File to parse.
+     * @param string|null $rel_path File location to look.
+     *
+     * @throws ExecutionException when the file could not be found.
      *
-     * @return string The full API blueprint file
+     * @return string The full API blueprint file.
      */
-    private function get_apib($filename)
+    private function get_apib($filename, $rel_path = NULL)
     {
-        $path    = $this->file_path($filename);
+        $path    = $this->file_path($filename, $rel_path);
         $file    = file_get_contents($path);
         $matches = [];
         preg_match_all('<!-- include\(([\S\s]*?)(\.[a-z]*?)\) -->', $file, $matches);
         for ($i = 0; $i < count($matches[1]); $i++) {
             $file = str_replace('<!-- include(' . $matches[1][$i] . $matches[2][$i] . ') -->',
-                $this->get_apib($matches[1][$i] . $matches[2][$i]), $file);
+                $this->get_apib($matches[1][$i] . $matches[2][$i], dirname($path)), $file);
         }
 
         preg_match_all('<!-- schema\(([a-z0-9_.\/\:]*?)\) -->', $file, $matches);
@@ -88,23 +96,35 @@ private function get_apib($filename)
      * Check if an APIB file exists.
      *
      * @param string $filename File to check
+     * @param string|null $rel_path File location to look.
      *
      * @throws ExecutionException when the file could not be found.
      *
      * @return string
      */
-    private function file_path($filename)
+    private function file_path($filename, $rel_path = NULL)
     {
-        $path = $this->location . $filename;
-        if (file_exists($path)) {
-            return $path;
+        // Absolute path
+        if (file_exists($filename)) {
+            return $filename;
         }
-        $path = stream_resolve_include_path($filename);
-        if ($path === FALSE || !file_exists($path)) {
-            throw new ExecutionException("API File not found: $filename", 1);
+
+        // Path relative to the top file
+        if ($rel_path !== null && file_exists($rel_path . $filename)) {
+            return $rel_path . $filename;
+        }
+
+        // Path relative to the top file
+        if (file_exists($this->location . $filename)) {
+            return $this->location . $filename;
+        }
+
+        $included_path = stream_resolve_include_path($filename);
+        if ($included_path !== FALSE) {
+            return $included_path;
         }
 
-        return $path;
+        throw new ExecutionException("API File not found: $filename", 1);
     }
 
     /**

src/PHPDraft/In/ApibFileParser.php

@@ -8,23 +8,23 @@
 
 namespace PHPDraft\In\Tests;
 
-use PHPDraft\Core\BaseTest;
+use Lunr\Halo\LunrBaseTest;
 use PHPDraft\In\ApibFileParser;
 use ReflectionClass;
 
 /**
  * Class ApibFileParserTest
  * @covers \PHPDraft\In\ApibFileParser
  */
-class ApibFileParserTest extends BaseTest
+class ApibFileParserTest extends LunrBaseTest
 {
 
     /**
      * Set up tests.
      *
      * @return void Test is now set up.
      */
-    public function setUp()
+    public function setUp(): void
     {
         $this->class      = new ApibFileParser(__DIR__ . '/ApibFileParserTest.php');
         $this->reflection = new ReflectionClass('PHPDraft\In\ApibFileParser');
@@ -34,7 +34,7 @@ public function setUp()
      * Test if setup is successful
      * @return void
      */
-    public function testLocationSetup()
+    public function testLocationSetup(): void
     {
         $property = $this->reflection->getProperty('location');
         $property->setAccessible(true);
@@ -45,7 +45,7 @@ public function testLocationSetup()
      * Test if setup is successful
      * @return void
      */
-    public function testFilenameSetup()
+    public function testFilenameSetup(): void
     {
         $property = $this->reflection->getProperty('filename');
         $property->setAccessible(true);
@@ -60,7 +60,7 @@ public function testFilenameSetup()
      *
      * @return void
      */
-    public function testFilenameSetupWrong()
+    public function testFilenameSetupWrong(): void
     {
         $property = $this->reflection->getProperty('filename');
         $property->setAccessible(true);
@@ -72,7 +72,7 @@ public function testFilenameSetupWrong()
      * Test if setup is successful
      * @return void
      */
-    public function testParseBasic()
+    public function testParseBasic(): void
     {
         $property = $this->reflection->getProperty('filename');
         $property->setAccessible(true);
@@ -81,7 +81,7 @@ public function testParseBasic()
         $loc_property->setAccessible(true);
         $loc_property->setValue($this->class, TEST_STATICS . '/drafter/apib/');
 
-        $this->mock_function('curl_exec', 'hello');
+        $this->mock_function('curl_exec', function() { return 'hello';});
         $this->class->parse();
         $this->unmock_function('curl_exec');
 

src/PHPDraft/In/Tests/ApibFileParserTest.php

@@ -53,7 +53,7 @@ public function parse($object)
 
                     break;
                 default:
-                    continue;
+                    continue 2;
                     break;
             }
         }

src/PHPDraft/Model/Category.php

@@ -8,14 +8,14 @@
 
 namespace PHPDraft\Model\Elements\Tests;
 
-use PHPDraft\Core\BaseTest;
+use Lunr\Halo\LunrBaseTest;
 use PHPDraft\Model\Elements\ArrayStructureElement;
 
 /**
  * Class ArrayStructureTest
- * @covers PHPDraft\Model\Elements\ArrayStructureElement
+ * @covers \PHPDraft\Model\Elements\ArrayStructureElement
  */
-class ArrayStructureElementTest extends BaseTest
+class ArrayStructureElementTest extends LunrBaseTest
 {
 
     /**