7. Modules

Modules contain assertions. If you need to create your own assertions you will likely want to create one or more modules.

7.1. Creating a Module

Each module is a class that extends Concise\Module\AbstractModule and contains methods that are annotated with the syntaxes they will match on, for example:

class UrlModule extends \Concise\Module\AbstractModule
{
    public function getName()
    {
        return "URLs";
    }

    /**
     * Validate URL.
     *
     * @syntax url ?:string is valid
     */
    public function urlIsValid()
    {
        $this->failIf(
            filter_var($this->data[0], FILTER_VALIDATE_URL) === false
        );
    }
}

Methods in a module can have zero or more @syntax annotations. You may use fail() or failIf(bool) to throw failures. Any value returned will be returned as-is to be used in nested assertions.

7.2. Loading a Module

Modules can be loaded through the ModuleManager like:

ModuleManager::getInstance()->loadModule(new MyModule());

Some things to note:

• It is safe to load the same module multiple times. Internally modules are identified by their class name so loading the same module will be ignored.
• Once modules are loaded into the ModuleManager they remain there for the entire run. If you had a bootstrap file for your test suite it would be a good idea to load your modules here, otherwise putting them in the appropriate test cases is fine too.

7.3. Testing Modules

Use the Concise\Module\AbstractModuleTestCase when testing modules:

class MyModuleTest extends AbstractMatcherTestCase
{
    public function setUp()
    {
        parent::setUp();
        $this->module = new MyModule();
    }

    public function testIntegerIsAnInteger()
    {
        $this->assert(123)->isAnInteger;
    }

    /**
     * @expectedException @expectedException \Concise\Core\DidNotMatchException
     */
    public function testFloatIsNotAnInteger()
    {
        $this->assert(123.0)->isAnInteger;
    }
}