Merge pull request #17 from assertwell/feature/functions-trait

Define the Functions trait

README.md

@@ -30,7 +30,7 @@ class MyTestClass extends TestCase
 
 ### Introduction to Runkit
 
-Some of the traits will rely on [Runkit7](https://www.php.net/runkit7), a port of PHP's runkit designed to work in PHP 7.x, to rewrite code at runtime (a.k.a. "monkey-patching").
+Some of the traits will rely on [Runkit7], a port of PHP's runkit designed to work in PHP 7.x, to rewrite code at runtime (a.k.a. "monkey-patching").
 
 For example, once a PHP constant is defined, it will normally have that value until the PHP process ends. Under normal circumstances, that's great: it prevents the value from being accidentally overwritten and/or tampered with.
 
@@ -46,7 +46,7 @@ var_dump(SOME_CONSTANT)
 #=> string(10) "some value"
 
 // Now, re-define the constant.
-runkit_constant_redefine('SOME_CONSTANT', 'some other value');
+runkit7_constant_redefine('SOME_CONSTANT', 'some other value');
 var_dump(SOME_CONSTANT)
 #=> string(16) "some other value"
 ```
@@ -57,11 +57,14 @@ Of course, we might want a constant's original value to be restored after our te
 
 The library offers a number of traits, based on the type of global state that might need to be manipulated.
 
-* [Constants](docs/Constants.md) (requires Runkit7)
+* [Constants](docs/Constants.md) (requires [Runkit7])
 * [Environment Variables](docs/EnvironmentVariables.md)
+* [Functions](docs/Functions.md) (requires [Runkit7])
 * [Global Variables](docs/GlobalVariables.md)
 
 
 ## Contributing
 
 If you're interested in contributing to the library, [please review our contributing guidelines](.github/CONTRIBUTING.md).
+
+[Runkit7]: docs/Runkit.md

composer.json

@@ -28,7 +28,7 @@
         "phpcompatibility/php-compatibility": "^9.3",
         "phpstan/phpstan": "^0.12",
         "squizlabs/php_codesniffer": "^3.5",
-        "stevegrunwell/runkit7-installer": "^1.1",
+        "stevegrunwell/runkit7-installer": "^1.2",
         "symfony/phpunit-bridge": "^5.1"
     },
     "suggest": {
@@ -42,7 +42,10 @@
     "autoload-dev": {
         "psr-4": {
             "Tests\\": "tests/"
-        }
+        },
+        "files": [
+            "tests/stubs/functions.php"
+        ]
     },
     "config": {
         "preferred-install": "dist",

docs/Constants.md

@@ -2,15 +2,8 @@
 
 Some applications — especially WordPress — will use [PHP constants](https://www.php.net/manual/en/language.constants.php) for configuration that should not be edited directly through the <abbr title="User Interface">UI</abbr>.
 
-Normally, a constant cannot be redefined or removed once defined; however, [the runkit7 extension](https://www.php.net/manual/en/book.runkit7) exposes functions to modify normally immutable constructs.
+Normally, a constant cannot be redefined or removed once defined; however, [the runkit7 extension](Runkit.md) exposes functions to modify normally immutable constructs.
 
-If runkit functions are unavailable, the `Constants` trait will automatically skip tests that rely on this functionality.
-
-In order to install runkit7 in your development and CI environments, you may use [the installer bundled with this repo](https://github.com/stevegrunwell/runkit7-installer):
-
-```sh
-$ sudo ./vendor/bin/install-runkit.sh
-```
 
 ## Methods