Move from runkit to UOPZ

Author: Sean Molenaar

README.md

@@ -2,7 +2,7 @@
 This is a parser for API Blueprint files in PHP.[1](#dependencies)
 
 ## Usage
-Requires PHP 5.6+ to run. Unittests require runkit (which is PHP <7.0 only)
+Requires PHP 5.6+ to run. Unittests require runkit or uopz
 For direct usage you can run:
 ```bash
 $ ./phpdraft.phar -f blueprint-file.apib > blueprint-webpage.html

src/PHPDraft/Core/BaseTest.php

@@ -42,19 +42,63 @@ public function tearDown()
     /**
      * Mock an internal function
      *
-     * @param string $name function name
-     * @param string $mock function to replace it with
+     * @param string $name   function name
+     * @param string $return return to use
      *
      * @return void
      */
-    protected function mock_function($name, $mock)
+    protected function mock_function($name, $return)
     {
-        if (function_exists($name . self::FUNCTION_ID) === FALSE)
-        {
+        if (extension_loaded('runkit') === true) {
+            $this->__runkit_mock_function($name, $return);
+
+            return;
+        }
+
+        if (extension_loaded('uopz') === true) {
+            $this->__uopz_mock_function($name, $return);
+
+            return;
+        }
+    }
+
+    /**
+     * Mock an internal function with runkit
+     *
+     * @param string $name   function name
+     * @param string $return function to replace it with
+     *
+     * @return void
+     */
+    private function __runkit_mock_function($name, $return)
+    {
+        if (function_exists($name . self::FUNCTION_ID) === false) {
             runkit_function_copy($name, $name . self::FUNCTION_ID);
         }
 
-        runkit_function_redefine($name, '', $mock);
+        runkit_function_redefine($name, '', 'return '.$return.';');
+    }
+
+    /**
+     * Mock an internal function with uopz
+     *
+     * @param string $name   function name
+     * @param string $return value to return
+     *
+     * @return void
+     */
+    private function __uopz_mock_function($name, $return)
+    {
+        if (PHP_MAJOR_VERSION < 7) {
+            \uopz_backup($name);
+            \uopz_function($name, function () {
+                global $return;
+                return $return;
+            });
+
+            return;
+        }
+        \uopz_set_return($name, $return);
     }
 
     /**
@@ -65,8 +109,49 @@ protected function mock_function($name, $mock)
      * @return void
      */
     protected function unmock_function($name)
+    {
+        if (extension_loaded('runkit') === true) {
+            $this->__runkit_unmock_function($name);
+
+            return;
+        }
+
+        if (extension_loaded('uopz') === true) {
+            $this->__uopz_unmock_function($name);
+
+            return;
+        }
+
+    }
+
+    /**
+     * Unmock a PHP function from runkit.
+     *
+     * @param String $name Function name
+     *
+     * @return void
+     */
+    private function __runkit_unmock_function($name)
     {
         runkit_function_remove($name);
         runkit_function_rename($name . self::FUNCTION_ID, $name);
     }
+
+    /**
+     * Unmock a PHP function from uopz.
+     *
+     * @param String $name Function name
+     *
+     * @return void
+     */
+    private function __uopz_unmock_function($name)
+    {
+        if (PHP_MAJOR_VERSION < 7) {
+            \uopz_restore($name);
+
+            return;
+        }
+
+        uopz_unset_return($name);
+    }
 }

src/PHPDraft/Parse/Tests/DrafterTest.php

@@ -24,8 +24,8 @@ class DrafterTest extends BaseTest
      */
     public function setUp()
     {
-        $this->mock_function('sys_get_temp_dir', 'return "' . TEST_STATICS . '";');
-        $this->mock_function('shell_exec', 'return "/some/dir/drafter\n";');
+        $this->mock_function('sys_get_temp_dir', TEST_STATICS );
+        $this->mock_function('shell_exec', "/some/dir/drafter\n");
         $this->class      = new Drafter(file_get_contents(TEST_STATICS . '/drafter/apib'));
         $this->reflection = new ReflectionClass('PHPDraft\Parse\Drafter');
         $this->unmock_function('shell_exec');
@@ -64,7 +64,7 @@ public function testPreRunStringIsEmpty()
      */
     public function testParseToJSON()
     {
-        $this->mock_function('shell_exec', 'return "";');
+        $this->mock_function('shell_exec', "");
         file_put_contents(TEST_STATICS . '/drafter/index.json', file_get_contents(TEST_STATICS . '/drafter/json'));
         $this->class->parseToJson();
         $this->assertEquals(json_decode(file_get_contents(TEST_STATICS . '/drafter/json')), $this->class->json);
@@ -81,7 +81,7 @@ public function testParseToJSON()
      */
     public function testParseToJSONWithErrors()
     {
-        $this->mock_function('shell_exec', 'return "";');
+        $this->mock_function('shell_exec', "");
         file_put_contents(TEST_STATICS . '/drafter/index.json',
             file_get_contents(TEST_STATICS . '/drafter/json_errors'));
         $this->class->parseToJson();
@@ -99,7 +99,7 @@ public function testParseToJSONWithErrors()
      */
     public function testSetupWithoutDrafter()
     {
-        $this->mock_function('shell_exec', 'return "";');
+        $this->mock_function('shell_exec', "");
         new Drafter('hello');
         $this->unmock_function('shell_exec');
     }
@@ -114,8 +114,8 @@ public function testSetupWithoutDrafter()
      */
     public function testParseToJSONWithInvalidJSON()
     {
-        $this->mock_function('json_last_error', 'return ' . JSON_ERROR_DEPTH . ';');
-        $this->mock_function('json_last_error_msg', 'return "ERROR";');
+        $this->mock_function('json_last_error', JSON_ERROR_DEPTH );
+        $this->mock_function('json_last_error_msg', "ERROR");
         $this->class->parseToJson();
         $this->expectOutputString('ERROR: invalid json in /tmp/drafter/index.json');
         $this->unmock_function('json_last_error_msg');