graham-campbell/phpspec-skip-example-extension

Skip your PhpSpec examples through annotations

v5.1.1 2021-10-17 20:25 UTC

Requires

• php: ^7.1 || ^8.0
• phpspec/phpspec: ^5.0 || ^6.0 || ^7.0

Conflicts

• akeneo/phpspec-skip-example-extension: *
• pamil/phpspec-skip-example-extension: *

MIT

• Gildas Quéméner
• Nicolas Dupont
• Kamil Kokot
• Graham Campbell

README

This Phpspec extension allows to skip example through user-friendly annotations.

Installation

$ composer require "graham-campbell/phpspec-skip-example-extension:^5.1"

Configuration

You can now activate the extension by creating a phpspec.yml file at the root of your project:

extensions:
    Akeneo\SkipExampleExtension: ~

Usage

@require

Skips all the spec example if the class or interface is not available

/**
 * @require Vendor\Builder\ToolInterface
 */
class BridgeBuilderSpec extends ObjectBehavior
{
    // Will be skipped if the Vendor\Builder\ToolInterface interface does not exist
    function it_builds_a_brige()
    {
    }

    // Will be skipped if the Vendor\Builder\ToolInterface interface does not exist
    function it_builds_the_road()
    {
    }

    //...
}

Contributions

Feel free to contribute to this extension if you find some interesting ways to improve it!