abstract_feature_branch 0.1.0 → 0.2.0

data/README.md

@@ -1,5 +1,5 @@
-Abstract Feature Branch
-=======================
+Abstract Feature Branch 0.2.0
+=============================
 
 abstract_feature_branch is a Rails gem that enables developers to easily branch by
 abstraction as per this pattern: http://paulhammant.com/blog/branch_by_abstraction.html
@@ -15,77 +15,117 @@ switched on in production, but do enable them in staging and locally.
 This gives developers the added benefit of being able to switch a feature off after
 release should big problems arise for a high risk feature.
 
+Requirements
+------------
+- Ruby 1.9.x or 1.8.7x
+- Rails 3.x or 2.x
+
 Setup
 -----
 
-In Rails 3.x:
-
-1. Add 'abstract_feature_branch' gem to Gemfile in Rails 3.x or
+- Add 'abstract_feature_branch' gem to Gemfile in Rails 3.x or
 "config.gem 'absract_feature_branch'" to environment.rb in Rails 2.x
-2. Configure config/features.yml in your Rails app directory as follows:
-\*
-    defaults: &defaults
-      features:
-    #    feature1: true
-    #    feature2: true
-    #    feature3: false
-
-    development:
-      <<: *defaults
-
-    test:
-      <<: *defaults
-
-    staging:
-      <<: *defaults
-    #    feature2: false
-
-    production:
-      <<: *defaults
-      features:
-    #    feature1: false
-    #    feature2: false
-\*
-Notice how the feature "add_business_project" was configured as true (enabled) by default, but
+- Configure config/features.yml in your Rails app directory as follows:
+
+>     defaults: &defaults
+>       features:
+>         feature1: true
+>         feature2: true
+>         feature3: false
+>     
+>     development:
+>       <<: *defaults
+>     
+>     test:
+>       <<: *defaults
+>     
+>     staging:
+>       <<: *defaults
+>         feature2: false
+>     
+>     production:
+>       <<: *defaults
+>       features:
+>         feature1: false
+>         feature2: false
+
+Notice how the feature "feature1" was configured as true (enabled) by default, but
 overridden as false (disabled) in production. This is a recommended practice.
-3. feature branch your logic as per this example:
-\*
-    feature_branch :feature1 do
-      # perform add business logic
-    end
-\*
+
+Instructions
+------------
+
+- declaratively feature branch logic to only run when feature1 is enabled:
+
+>     feature_branch :feature1 do
+>       # perform logic
+>     end
+
+- declaratively feature branch two paths of logic, one that runs when feature1 is enabled and one that runs when it is disabled:
+
+>     feature_branch :feature1,
+>                    :true => lambda {
+>                      # perform logic
+>                    },
+>                    :false => lambda {
+>                      # perform alternate logic
+>                    }
+
+- imperatively check if a feature is enabled or not:
+
+>     if feature_enabled?(:feature1)
+>       # perform logic
+>     else
+>       # perform alternate logic
+>     end
 
 Recommendations
 ---------------
+
 - Wrap routes in routes.rb with feature blocks to disable entire MVC feature elements by
 simply switching off the URL route to them. Example:
-\*
-    feature_branch :add_business_project do
-      resources :projects
-    end
-\*
+
+>     feature_branch :add_business_project do
+>       resources :projects
+>     end
 
 - Wrap visual links to these routes in ERB views. Example:
-\*
-    <% feature_branch :add_business_project do %>
-      <h2>Submit a Business</h2>
-      <p>
-        Please submit a business idea for investors to look at.
-      </p>
-      <ul>
-        <% current_user.projects.each do |p| %>
-        <li><%= link_to p.business_campaign_name, project_path(p) %></li>
-        <% end %>
-      </ul>
-      <h4>
-        <%= link_to('Start', new_project_path, :id => "business_background_invitation", :class => 'button') %>
-      </h4>
-    <% end %>
-\*
+
+>     <% feature_branch :add_business_project do %>
+>       <h2>Submit a Business</h2>
+>       <p>
+>         Please submit a business idea for review.
+>       </p>
+>       <ul>
+>         <% current_user.projects.each do |p| %>
+>         <li><%= link_to p.business_campaign_name, project_path(p) %></li>
+>         <% end %>
+>       </ul>
+>       <h4>
+>         <%= link_to('Start', new_project_path, :id => "business_background_invitation", :class => 'button') %>
+>       </h4>
+>     <% end %>
+
 - Once a feature has been released and switched on in production, and it has worked well for a while,
 it is recommended that its feature branching code is plucked out of the code base to simplify the code
 for better maintenance as the need is not longer there for feature branching at that point.
 
+Release Notes
+-------------
+
+Version 0.2.0:
+
+- Support an "else" block to execute when a feature is off (via :true and :false lambda arguments)
+- Support ability to check if a feature is enabled or not (via feature_enabled?)
+
+Upcoming
+--------
+
+- Support the option of having multiple features.yml files, one per environment, as opposed to one for all environments
+- Support general Ruby (non-Rails) use
+- Support contexts of features to group features, once they grow beyond a certain size, in separate files, one per context
+- Simplify features.yml requirement to have a features header under each environment
+- Add rake task to reorder feature entries in feature.yml alphabetically
 
 Contributing to abstract_feature_branch
 ---------------------------------------

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/abstract_feature_branch.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "abstract_feature_branch"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Annas \"Andy\" Maleh"]
-  s.date = "2012-11-12"
+  s.date = "2012-11-25"
   s.description = "It gives ability to wrap blocks of code with an abstract feature branch name, and then\nspecify which features to be switched on or off in a configuration file.\n\nThe goal is to build out future features with full integration into the codebase, thus\nensuring no delay in integration in the future, while releasing currently done features\nat the same time. Developers then disable future features until they are ready to be\nswitched on in production, but do enable them in staging and locally.\n\nThis gives developers the added benefit of being able to switch a feature off after\nrelease should big problems arise for a high risk feature.\n"
   s.extra_rdoc_files = [
     "LICENSE.txt",

data/lib/ext/feature_branch.rb

@@ -1,13 +1,24 @@
 class Object
-  raise 'Abstract branch conflicts with another Ruby library' if respond_to?(:feature_branch)
-  def self.feature_branch(feature_name, &feature_work)
-    if Settings[Rails.env.to_s]['features'][feature_name]
-      feature_work.call
-    end
+  raise 'Abstract feature branch conflicts with another Ruby library' if respond_to?(:feature_branch)
+  def self.feature_branch(feature_name, branches = {}, &feature_work)
+    branches[:true] ||= feature_work
+    branches[:false] ||= lambda {}
+    feature_status = Settings[Rails.env.to_s]['features'][feature_name].to_s.to_sym
+    branches[feature_status].call
   end
 
-  raise 'Abstract branch conflicts with another Ruby library' if Object.new.respond_to?(:feature_branch)
-  def feature_branch(feature_name, &feature_work)
-    Object.feature_branch(feature_name, &feature_work)
+  raise 'Abstract feature branch conflicts with another Ruby library' if respond_to?(:feature_enabled?)
+  def self.feature_enabled?(feature_name)
+    Settings[Rails.env.to_s]['features'][feature_name]
+  end
+
+  raise 'Abstract feature branch conflicts with another Ruby library' if Object.new.respond_to?(:feature_branch)
+  def feature_branch(feature_name, branches = {}, &feature_work)
+    Object.feature_branch(feature_name, branches, &feature_work)
+  end
+
+  raise 'Abstract feature branch conflicts with another Ruby library' if Object.new.respond_to?(:feature_enabled?)
+  def feature_enabled?(feature_name)
+    Object.feature_enabled?(feature_name)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: abstract_feature_branch
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-12 00:00:00.000000000 Z
+date: 2012-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails_config
@@ -141,7 +141,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -381377031789369031
+      hash: 2916198605962621809
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: