rutkai/featureflipperbundle

This package is abandoned and no longer maintained. No replacement package was suggested.

Provides advanced feature toggling support for Symfony2 based projects

v1.0.1 2015-03-17 10:22 UTC

Requires

• php: >=5.3.2
• symfony/config: ~2.3
• symfony/console: ~2.3
• symfony/dependency-injection: ~2.3
• symfony/http-kernel: ~2.3
• symfony/swiftmailer-bundle: ~2.3
• twig/twig: >=1.12

Requires (Dev)

• phpunit/phpunit: 4.3.*
• symfony/yaml: ~2.3

MIT

• András Rutkai

• feature toggle
• feature toggling
• feature flipping
• feature flipper

README

This bundle provides a feature flipper interface for Symfony2. Main features:

• Feature checks in twigs and controllers (via DI)
• Assigning expiration date to features
• Assigning responsible people to features

Installation

Add this bundle to composer.json file:

"require": {
    ...
    "rutkai/featureflipperbundle": "~1.0"
},

Register it in AppKernel:

$bundles = array(
    ...
    new Rutkai\FeatureFlipperBundle\RutkaiFeatureFlipperBundle(),
);

Usage

Configuration

# config.yml

rutkai_feature_flipper:
    enable_undefined_feature: true  # Optional, sets the default strategy for undefined features
    expiration_warning: 7           # Optional, expiration e-mails will be sent to responsibles if expiration occurs within the next x days
    feature_class: Rutkai\FeatureFlipperBundle\Feature\Feature  # Optional, default feature container, must implement FeatureInterface
    templates:
        warning_console: RutkaiFeatureFlipperBundle:FeatureCheck:warning.txt.twig # Optional, output warning template for feature check command
        warning_email: RutkaiFeatureFlipperBundle:FeatureCheck:warning.txt.twig   # Optional, e-mail warning template for feature check command
        alert_console: RutkaiFeatureFlipperBundle:FeatureCheck:alert.txt.twig     # Optional, output alert template for feature check command
        alert_email: RutkaiFeatureFlipperBundle:FeatureCheck:alert.txt.twig       # Optional, e-mail alert template for feature check command
    email:
        from: [e-mail] # Required, sender of the warning (default: [e-mail])
        subject: Expired feature    # Optional, subject for the warnings
    features:
        feature_id:
            enabled: true                       # Required
            expiration: "2015-03-03 12:00:00"   # Optional
            responsible: "András Rutkai"        # Optional
            responsible_email: [e-mail] # Optional
        feature_id_2:
            enabled: false
            expiration: ~   # no expiration
            responsible: ~  # no responsible

Twig

{% if feature_enabled("feature_id") %}
    ...
{% endif %}

Twig functions:

• feature_enabled('feature_id')
• has_feature('feature_id')

Controller or services

$featureManager = $this->get('feature.manager');
if ($featureManager->isEnabled("feature_id"))
    ...

Feature manager functions:

• $featureManager->isEnabled('feature_id')
• $featureManager->hasFeature('feature_id')
• $featureManager->getFeature('feature_id')
• $featureManager->addFeature($feature) where $feature implements FeatureInterface

Roadmap

• 1.0.0: YML/XML based configuration, notifications using e-mail
• 1.1.0: Doctrine backend for storing features
• 1.2.0: Redis backend for storing features