feature_toggle 0.0.1

data/README.md

@@ -0,0 +1,52 @@
+
+# FeatureToggle
+
+FeatureToggle is a [feature toggle](http://martinfowler.com/bliki/FeatureToggle.html) library for ruby.
+
+## Installation
+
+        gem install feature_toggle
+
+## Examples
+
+### Rails
+
+        # File: Gemfile
+        gem 'feature_toggle'
+
+        # File: config/features.yml
+        feature1:
+            controller1:
+				- action1
+				- action2
+			controller2:
+				- action1
+				- action2
+        feature2:
+			controller3:
+				- action1
+				- action2
+        feature3:
+            controller4:
+				- action1
+				- action2
+
+        # File: config/initializers/feature_toggle.rb
+		FEATURES = FeatureToggle.load(File.join(RAILS_ROOT, 'config', 'features.yml'))
+		FEATURES.deactivate('feature1', 'feature2', 'feature3')
+
+        # File: app/controllers/application_controller.rb
+		before_filter :check_feature_activated?
+
+		def	check_feature_activated?
+			FEATURES.active_action?(params[:controller], params[:action])
+		end
+
+        # File: app/views/example/index.html.erb
+        <% if FEATURES.active?('feature1') %>
+          <%# Feature implementation goes here %>
+        <% end %>
+        <% if FEATURES.active_action?('controller4', 'action1') %>
+          <%# Feature implementation goes here %>
+        <% end %>
+

data/lib/feature_toggle.rb

@@ -0,0 +1,11 @@
+require 'yaml'
+require 'feature_toggle/features'
+module FeatureToggle
+  class UnknownFeatureError < StandardError
+  end
+
+  def load(config_file)
+    Features.new YAML.load(File.read(config_file))
+  end
+  module_function :load
+end

data/lib/feature_toggle/features.rb

@@ -0,0 +1,53 @@
+require 'set'
+module FeatureToggle
+  class Features
+    def initialize(features)
+      @features = features
+      @actions = build_actions_feature_map(features)
+      @deactivated_features = Set.new
+    end
+
+    def [](feature_name)
+      @features[feature_name]
+    end
+
+    def activate(*feature_names)
+      feature_names.each do |feature_name|
+        validate!(feature_name)
+        @deactivated_features.delete(feature_name)
+      end
+    end
+
+    def deactivate(*feature_names)
+      feature_names.each do |feature_name|
+        validate!(feature_name)
+        @deactivated_features << feature_name
+      end
+    end
+
+    def active_action?(controller, action)
+      feature = @actions["#{controller}:#{action}"]
+      active?(feature)
+    end
+
+    def active?(feature_name)
+      !@deactivated_features.include?(feature_name)
+    end
+
+    private
+    def validate!(feature_name)
+      raise UnknownFeatureError, "Unknown feature name: #{feature_name}" unless @features.has_key?(feature_name)
+    end
+    def build_actions_feature_map(features)
+      map = {}
+      features.each do |feature, controllers|
+        controllers.each do |controller_name, actions|
+          actions.each do |action_name|
+            map["#{controller_name}:#{action_name}"] = feature
+          end
+        end
+      end
+      map
+    end
+  end
+end

data/test/feature_toggle_test.rb

@@ -0,0 +1,60 @@
+require "test/unit"
+
+require "feature_toggle"
+
+class FeatureToggleTest < Test::Unit::TestCase
+  def test_load_features
+    features = load_features
+    assert_equal({'users' => ['update', 'show']}, features['user_profile'])
+  end
+
+  def test_can_deactivate_features
+    features = load_features
+    assert features.active?('user_profile')
+
+    features.deactivate("user_profile")
+    assert !features.active?('user_profile')
+
+    features.deactivate("wpc", "rao")
+    assert !features.active?('wpc')
+    assert !features.active?('rao')
+  end
+
+  def test_activate_feature_after_deactivated_feature
+    features = load_features
+    features.deactivate("user_profile")
+    features.activate("user_profile")
+    assert features.active?('user_profile')
+  end
+
+  def test_disabling_non_existent_features_should_raise_error
+    features = load_features
+    assert_raises FeatureToggle::UnknownFeatureError do
+      features.deactivate("user")
+    end
+  end
+
+  def test_activating_non_existent_features_should_raise_error
+    features = load_features
+    assert_raises FeatureToggle::UnknownFeatureError do
+      features.activate("user")
+    end
+  end
+
+  def test_feature_actions_should_be_active_when_feature_is_active
+    features = load_features
+    assert features.active_action?('users', 'update')
+    features.deactivate("user_profile")
+    assert !features.active_action?('users', 'update')
+  end
+
+  def test_feature_action_should_be_active_when_no_feature_defines_the_action
+    features = load_features
+    assert features.active_action?('users', 'destroy')
+  end
+
+  def load_features
+    config = File.join(File.dirname(__FILE__), 'features.yml')
+    FeatureToggle.load(config)
+  end
+end

data/test/features.yml

@@ -0,0 +1,11 @@
+user_profile:
+  users:
+    - update
+    - show
+wpc:
+  body:
+    - move
+    - jump
+rao:
+  hand:
+    - wave

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: feature_toggle
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Mingle SaaS team
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-07-31 00:00:00 Z
+dependencies: []
+
+description: 
+email: mingle.saas@thoughtworks.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/feature_toggle/features.rb
+- lib/feature_toggle.rb
+- test/feature_toggle_test.rb
+- test/features.yml
+- Rakefile
+- README.md
+- CHANGELOG.md
+homepage: https://github.com/ThoughtWorksStudios/feature_toggle
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Feature Toggle library for ruby
+test_files: []
+