abstract_feature_branch 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f1030acce2b8092fcf6ac90e233253b273d5e10
-  data.tar.gz: 91baad506146ddd0aa419062c30c8d3f7d8dae3e
+  metadata.gz: c6a6aaa5dee1e8e0fa7d7dba8051fe8a160e1cb1
+  data.tar.gz: 7f089bf19a1c027ba5e4e27cea6cfccf92d5dd40
 SHA512:
-  metadata.gz: c4a44fabd06d5945c799cc157b22019cc2522fcbe7aa86ff0174d83f0bba64eebdee6d539b28c2628c61b0d84343167ed6ff37f17877ad6241f750472ee5be7c
-  data.tar.gz: 54c63e4ea5f19b9900ec5b565f8c8100f033bdaa35a40640dd960d3809855f109b5eb8defd5bbe825122eeff18eda10bce03a82af32e0cf5bdb42372a81cbb3b
+  metadata.gz: 7b8e441a5218c69ba59fee50418b379d99ffd00298f370b3e6939a043f97f2f85d1e72a056722e005f0d2694672023fa6efe6b6a72455767e009c996f9c4fdb2
+  data.tar.gz: a07a4fbcc2ad0e16d9f75be7563a91970eda21e67d1c085804f2648f215f7fdb65f9076949ce9c843b3fc64d8f5740790bc557d0c95ae7990c7f10ff223bcfb3

data/README.md

@@ -24,11 +24,15 @@ Setup
 -----
 
 1. Configure Rubygem
-   - Rails (~> 4.0.0 or ~> 3.0): Add the following to Gemfile <pre>gem 'abstract_feature_branch', '0.3.6'</pre>
-   - Rails (~> 2.0): Add the following to config/environment.rb <pre>config.gem 'absract_feature_branch'</pre>
+   - Rails (~> 4.0.0 or ~> 3.0): Add the following to Gemfile <pre>gem 'abstract_feature_branch', '0.4.0'</pre>
+   - Rails (~> 2.0): Add the following to config/environment.rb <pre>config.gem 'absract_feature_branch', :version => '0.4.0'</pre>
 2. Generate config/features.yml in your Rails app directory by running <pre>rails g abstract_feature_branch:install</pre>
 
-Here are the contents of the generated sample config/features.yml, which you can modify with your own features.
+Instructions
+------------
+
+Here are the contents of the generated sample config/features.yml, which you can modify with your own features, each
+enabled (true) or disabled (false) per environment (e.g. production).
 
 >     defaults: &defaults
 >       feature1: true
@@ -53,9 +57,6 @@ Here are the contents of the generated sample config/features.yml, which you can
 Notice in the sample file how the feature "feature1" was configured as true (enabled) by default, but
 overridden as false (disabled) in production. This is a recommended practice.
 
-Instructions
-------------
-
 - Declaratively feature branch logic to only run when feature1 is enabled:
 
 multi-line logic:
@@ -90,6 +91,38 @@ Note that feature_branch executes the false branch if the feature is non-existen
 
 Note that feature_enabled? returns false if the feature is disabled and nil if the feature is non-existent (practically the same effect, but nil can sometimes be useful to detect if a feature is referenced).
 
+Environment Variable Overrides
+------------------------------
+
+You can override feature configuration with environment variables by setting an environment variable with
+a name matching this convention (case-insensitive):
+ABSTRACT_FEATURE_BRANCH_[feature_name] and giving it the case-insensitive value "TRUE" or "FALSE"
+
+Examples:
+
+- export ABSTRACT_FEATURE_BRANCH_FEATURE1=TRUE
+- export abstract_feature_branch_feature2=false
+
+Heroku
+------
+
+Environment variable overrides can be extremely helpful on Heroku as they allow developers to enable/disable features
+at runtime without a redeploy.
+
+Examples:
+
+Enabling a new feature without a redeploy:
+<pre>heroku config:add ABSTRACT_FEATURE_BRANCH_FEATURE3=true -a heroku_application_name</pre>
+
+Disabling a buggy recently deployed feature without a redeploy:
+<pre>heroku config:add ABSTRACT_FEATURE_BRANCH_FEATURE2=false -a heroku_application_name</pre>
+
+Removing an environment variable override:
+<pre>heroku config:remove ABSTRACT_FEATURE_BRANCH_FEATURE2 -a heroku_application_name</pre>
+
+Note that it is recommended to use environment variables as an emergency or temporary measure, make the change
+officially in config/features.yml afterward, deploy, and finally remove the environment variable override for the long term.
+
 Recommendations
 ---------------
 
@@ -153,6 +186,9 @@ for better maintenance as the need is not longer there for feature branching at
 Release Notes
 -------------
 
+Version 0.4.0:
+- Added support for overwriting feature configuration with environment variable overrides. Very useful on Heroku to quickly enable/disable features without a redeploy.
+
 Version 0.3.6:
 - Fixed feature_branch issue with invalid feature name, preventing block execution and returning nil instead
 

data/VERSION

@@ -1 +1 @@
-0.3.6
+0.4.0

data/abstract_feature_branch.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "abstract_feature_branch"
-  s.version = "0.3.6"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Annas \"Andy\" Maleh"]
-  s.date = "2013-11-19"
+  s.date = "2013-11-21"
   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

@@ -3,8 +3,10 @@ class Object
   def self.feature_branch(feature_name, branches = {}, &feature_work)
     branches[:true] ||= feature_work
     branches[:false] ||= lambda {}
-    feature_status = (AbstractFeatureBranch.features[Rails.env.to_s][feature_name.to_s] || false).to_s.to_sym
-    branches[feature_status].call
+    feature_status = abstract_feature_branch_environment_value(feature_name)
+    feature_status = AbstractFeatureBranch.features[Rails.env.to_s][feature_name.to_s] if feature_status.nil?
+    feature_status = false if feature_status.nil?
+    branches[feature_status.to_s.to_sym].call
   end
 
   raise 'Abstract feature branch conflicts with another Ruby library' if respond_to?(:feature_enabled?)
@@ -21,4 +23,15 @@ class Object
   def feature_enabled?(feature_name)
     Object.feature_enabled?(feature_name.to_s)
   end
+
+  private
+
+  ABSTRACT_FEATURE_BRANCH_POSITIVE_VALUES = ['true', 'on', 'yes']
+
+  raise 'Abstract feature branch conflicts with another Ruby library' if respond_to?(:abstract_feature_branch_environment_value)
+  def self.abstract_feature_branch_environment_value(feature_name)
+    downcased_env = Hash[ENV.map {|k, v| [k.downcase, v]}]
+    value = downcased_env["abstract_feature_branch_#{feature_name.to_s.downcase}"]
+    value && ABSTRACT_FEATURE_BRANCH_POSITIVE_VALUES.include?(value.downcase)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abstract_feature_branch
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Annas "Andy" Maleh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-19 00:00:00.000000000 Z
+date: 2013-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec