feature_flipper 1.1.0 → 1.2.0

data/README.md

@@ -18,6 +18,36 @@ configuration file after requiring FeatureFlipper:
     require 'feature_flipper'
     FeatureFlipper::Config.path_to_file = "#{RAILS_ROOT}/config/features.rb"
 
+Example config file
+-------------------
+
+    FeatureFlipper.features do
+      in_state :development do
+        feature :rating_game, :description => 'play a game to get recommendations'
+      end
+
+      in_state :live do
+        feature :city_feed, :description => 'stream of content for each city'
+      end
+    end
+
+    FeatureFlipper::Config.states = {
+      :development => ['development', 'test'].include?(Rails.env),
+      :live        => true
+    }
+
+This is your complete features.rb config file. In the example there are two
+states: `:development` is active on development boxes and `:live` is always active
+(this is the last state a feature goes through).
+
+The feature `:rating_game` is still in development and not shown on the
+production site. The feature `:city_feed` is done and already enabled
+everywhere. You transition features between states by just moving the line to
+the new state block.
+
+You can take a look at the `static_states.rb` in the examples folder to
+see this in detail.
+
 Configuration
 -------------
 
@@ -27,10 +57,11 @@ FeatureFlipper cares about:
  * states
  * features
 
-You first define multiple 'states' which normally depend on an environment
-(for example: the state 'dev' is only active on development boxes). After that
-you add 'features' which correspond to logical chunks of work in your project.
-These features then move through the different states as they get developed.
+You first define multiple 'states' which normally depend on the environment
+(for example: the state 'development' is only active on development boxes).
+After that you add 'features' which correspond to logical chunks of work in
+your project. These features then move through the different states
+as they get developed (for example: :development -> :staging -> :live).
 
 ### Defining features
 
@@ -39,22 +70,24 @@ more detailed description, a ticket number, a date when it was started, etc.
 Features are always defined in a state, you cannot define a feature which
 doesn't belong to a state.
 
-    in_state :dev do
+    in_state :development do
       feature :rating_game, :description => 'play a game to get recommendations'
     end
 
 ### Defining states
 
 A state is just a name and a boolean check. The check needs to evaluate to
-´true´ when it is active. For a Rails app you can just use environments:
+`true` when it is active. For a Rails app you can just use environments:
 
-    :dev      => ['development', 'test'].include?(Rails.env),
+    FeatureFlipper::Config.states = {
+      :development => ['development', 'test'].include?(Rails.env)
+    }
 
 Usage
 -----
 
 In your code you then use the `show_feature?` method to branch depending on
-wether the feature is active or not:
+wether a feature is active or not:
 
     if show_feature?(:rating_game)
       # new code
@@ -64,42 +97,12 @@ wether the feature is active or not:
 
 The `show_feature?` method is defined on Object, so you can use it everywhere.
 
-Example config file
--------------------
-
-    FeatureFlipper.features do
-      in_state :dev do
-        feature :rating_game, :description => 'play a game to get recommendations'
-      end
-
-      in_state :live do
-        feature :city_feed, :description => 'stream of content for each city'
-      end
-    end
-
-    FeatureFlipper::Config.states = {
-      :dev      => ['development', 'test'].include?(Rails.env),
-      :live     => true
-    }
-
-This is your complete features.rb config file. In the example there are two
-states: `:dev` is active on development boxes and `:live` is always active
-(this is the last state a feature goes through).
-
-The feature `:rating_game` is still in development and not shown on the
-production site. The feature `:city_feed` is done and already enabled
-everywhere. You transition features between states by just moving the line to
-the new state block.
-
-You can take a look at the `static_states.rb` in the 'examples' folder to
-see this in detail.
-
 Cleaning up
 -----------
 
 The drawback of this approach is that your code can get quite ugly with all
-these if/else branches. So you have to be strict about removing (we call it
-de-featurizing) features after they have gone live.
+these if/else branches. So you have to be strict about removing features
+(we call it de-featurizing) after they have gone live.
 
 Dynamic feature groups
 ----------------------
@@ -107,43 +110,45 @@ Dynamic feature groups
 As soon as we have the feature_flipper infrastructure in place, we can start
 doing more interesting things with it. For example, dynamic features which
 are enabled on a per user basis. This allows you to release features to
-employees only, to a private beta group, etc.
+employees only or to a private beta group, etc.
 
 ### Defining dynamic states
 
 A dynamic state is defined a bit different than a normal, static state.
 
     FeatureFlipper::Config.states = {
-      :dev       => ['development', 'test'].include?(Rails.env),
-      :employees => { :required_state => :dev, :feature_group => :employees }
+      :development => ['development', 'test'].include?(Rails.env),
+      :employees   => { :required_state => :development, :feature_group => :employees }
     }
 
 It has a required state and a feature group. The feature group defines
-the name of the group of users which should see this feature. The required
-state is the state that gets looked at for all other users that aren't in
-the feature group. The required_state must also be defined as a separate state.
+a symbolic name for the group of users who should see this feature. You
+can name this whatever you want. The required state is the state that gets
+looked at for all other users that aren't in the feature group. The required
+state (:development) must be a defined, static state.
 
 ### Setting the feature group
 
-The current feature group is set globally and is active for the whole thread.
+The feature group is set globally and is active for the whole thread.
 In Rails you would define a before_filter like this:
 
     class ApplicationController < ActionController::Base
-      before_filter :set_current_feature_group
+      before_filter :set_active_feature_group
       
-      def set_current_feature_group
+      def set_active_feature_group
         # we need to reset the feature group in each request,
-        # otherwise it persists (which is not want we want).
-        FeatureFlipper.reset_current_feature_groups
+        # otherwise it's also active for the following requests.
+        FeatureFlipper.reset_active_feature_groups
         
         if logged_in? && current_user.employee?
-          FeatureFlipper.current_feature_groups << :employees
+          FeatureFlipper.active_feature_groups << :employees
         end
       end
 
-It's really important to reset the feature group, otherwise it's not dynamic.
-The condition if someone is in a feature group can be anything: You can
-store it in the database, in Redis, look at request parameters, etc.
+Don't forget to reset the feature group, without it the feature group
+is active forever. The condition if someone is in a feature group
+can be anything: You can store it in the database, in Redis,
+look at request parameters, based on the current time, etc.
 
 Take a look at `dynamic_states.rb` in the examples folder to see this
 in detail.

data/examples/dynamic_states.rb

@@ -26,7 +26,7 @@ FeatureFlipper::Config.path_to_file = "features.rb"
 
 puts "=== first example:"
 
-# no current_feature_group set, so the required_state of badges is looked at
+# no active feature_group set, so the required_state of badges is looked at
 if show_feature?(:badges)
   puts "shiny new badges not live on prod yet"
 else
@@ -35,10 +35,10 @@ end
 
 puts "\n=== second example:"
 
-# now we set the current_feature_group. Usually depending on the logged in user
+# now we set the active feature_group. Usually depending on the logged in user
 
-FeatureFlipper.reset_current_feature_groups
-FeatureFlipper.current_feature_groups << :employees
+FeatureFlipper.reset_active_feature_groups
+FeatureFlipper.active_feature_groups << :employees
 
 if show_feature?(:badges)
   puts "shiny new badges for this user"

data/examples/features.rb

@@ -4,7 +4,7 @@
 #
 
 FeatureFlipper.features do
-  in_state :dev do
+  in_state :development do
     feature :rating_game, :description => 'play a game to get recommendations'
   end
 
@@ -18,7 +18,7 @@ FeatureFlipper.features do
 end
 
 FeatureFlipper::Config.states = {
-  :dev       => ['development', 'test'].include?(Rails.env),
-  :employees => { :required_state => :dev, :feature_group => :employees },
-  :live      => true
+  :development => ['development', 'test'].include?(Rails.env),
+  :employees   => { :required_state => :development, :feature_group => :employees },
+  :live        => true
 }

data/lib/feature_flipper/config.rb

@@ -51,7 +51,7 @@ module FeatureFlipper
         else
           group, required_state = active.to_a.flatten
         end
-        (FeatureFlipper.current_feature_groups.include?(group)) || (states[required_state] == true)
+        (FeatureFlipper.active_feature_groups.include?(group)) || (states[required_state] == true)
       else
         active == true
       end
@@ -91,11 +91,11 @@ module FeatureFlipper
     StateMapper.new.instance_eval(&block)
   end
 
-  def self.current_feature_groups
-    Thread.current[:feature_system_current_feature_groups] ||= []
+  def self.active_feature_groups
+    Thread.current[:feature_system_active_feature_groups] ||= []
   end
 
-  def self.reset_current_feature_groups
-    current_feature_groups.clear
+  def self.reset_active_feature_groups
+    active_feature_groups.clear
   end
 end

data/lib/feature_flipper/version.rb

@@ -1,3 +1,3 @@
 module FeatureFlipper
-  Version = VERSION = '1.1.0'
+  Version = VERSION = '1.2.0'
 end

data/test/feature_flipper_test.rb

@@ -76,12 +76,12 @@ context 'dynamic feature groups' do
   setup do
     FeatureFlipper::Config.path_to_file = 'features.rb'
     FeatureFlipper::Config.reload_config
-    FeatureFlipper.reset_current_feature_groups
+    FeatureFlipper.reset_active_feature_groups
   end
 
   test 'should show a beta feature to the feature group' do
     Rails.stubs(:env).returns('production')
-    FeatureFlipper.current_feature_groups << :beta_users
+    FeatureFlipper.active_feature_groups << :beta_users
 
     assert show_feature?(:beta_feature_old)
     assert show_feature?(:beta_feature_new)
@@ -89,7 +89,7 @@ context 'dynamic feature groups' do
 
   test 'should not show a beta feature if not in the group' do
     Rails.stubs(:env).returns('production')
-    FeatureFlipper.current_feature_groups << :different_feature_group
+    FeatureFlipper.active_feature_groups << :different_feature_group
 
     assert !show_feature?(:beta_feature_old)
     assert !show_feature?(:beta_feature_new)
@@ -97,7 +97,7 @@ context 'dynamic feature groups' do
 
   test 'should always show a beta feature on dev' do
     Rails.stubs(:env).returns('development')
-    FeatureFlipper.current_feature_groups << nil
+    FeatureFlipper.active_feature_groups << nil
 
     assert show_feature?(:beta_feature_old)
     assert show_feature?(:beta_feature_new)
@@ -105,8 +105,8 @@ context 'dynamic feature groups' do
 
   test 'can be in two feature groups at the same time' do
     Rails.stubs(:env).returns('production')
-    FeatureFlipper.current_feature_groups << :beta_users
-    FeatureFlipper.current_feature_groups << :employees
+    FeatureFlipper.active_feature_groups << :beta_users
+    FeatureFlipper.active_feature_groups << :employees
 
     assert show_feature?(:beta_feature_new)
     assert show_feature?(:employee_feature)

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Florian Munz
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-21 00:00:00 +02:00
+date: 2010-06-01 00:00:00 +02:00
 default_executable: 
 dependencies: []