abstract_feature_branch 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6a6aaa5dee1e8e0fa7d7dba8051fe8a160e1cb1
-  data.tar.gz: 7f089bf19a1c027ba5e4e27cea6cfccf92d5dd40
+  metadata.gz: fb2107fd2312b62c1864e7b60ce08c24620229c0
+  data.tar.gz: e9a07cf69f21a778a4f9245e5c53e3b2e71f4d53
 SHA512:
-  metadata.gz: 7b8e441a5218c69ba59fee50418b379d99ffd00298f370b3e6939a043f97f2f85d1e72a056722e005f0d2694672023fa6efe6b6a72455767e009c996f9c4fdb2
-  data.tar.gz: a07a4fbcc2ad0e16d9f75be7563a91970eda21e67d1c085804f2648f215f7fdb65f9076949ce9c843b3fc64d8f5740790bc557d0c95ae7990c7f10ff223bcfb3
+  metadata.gz: bca12505dd8a199f432261d7498ed5378b2199a36236bca57cb13613c3f83b58acfefba5faa18cf9a223d5bdc29a451326429b9ae31bfa9f0923475d5d2e8c0a
+  data.tar.gz: f1f7d0a7db3534745891a034fd357557b93299b9ac86fb4879715a5bae84a53d825684dfe49d00557b3137f51b165d0cd3d6ca26cd9744178226c2f511fca650

data/README.md

@@ -24,13 +24,18 @@ Setup
 -----
 
 1. Configure Rubygem
-   - 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>
+   - Rails (~> 4.0.0 or ~> 3.0): Add the following to Gemfile <pre>gem 'abstract_feature_branch', '0.5.0'</pre>
+   - Rails (~> 2.0): Add the following to config/environment.rb <pre>config.gem 'absract_feature_branch', :version => '0.5.0'</pre>
+2. Generate <code>config/features.yml</code> and <code>config/features.local.yml</code> in your Rails app directory by running <pre>rails g abstract_feature_branch:install</pre>
 
 Instructions
 ------------
 
+<code>config/features.yml</code> contains the main configuration for the application features.
+
+<code>config/features.local.yml</code> contains local overrides for the configuration, ignored by git, thus useful for temporary
+local feature switching for development/testing/troubleshooting purposes.
+
 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).
 
@@ -67,7 +72,7 @@ multi-line logic:
 single-line logic:
 >     feature_branch(:feature1) { # perform logic }
 
-Note that feature_branch returns nil and does not execute the block if the feature is disabled or non-existent.
+Note that <code>feature_branch</code> returns nil and does not execute the block if the feature is disabled or non-existent.
 
 - Declaratively feature branch two paths of logic, one that runs when feature1 is enabled and one that runs when it is disabled:
 
@@ -79,7 +84,7 @@ Note that feature_branch returns nil and does not execute the block if the featu
 >                      # perform alternate logic
 >                    }
 
-Note that feature_branch executes the false branch if the feature is non-existent.
+Note that <code>feature_branch</code> executes the false branch if the feature is non-existent.
 
 - Imperatively check if a feature is enabled or not:
 
@@ -89,39 +94,7 @@ Note that feature_branch executes the false branch if the feature is non-existen
 >       # perform alternate logic
 >     end
 
-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.
+Note that <code>feature_enabled?</code> 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).
 
 Recommendations
 ---------------
@@ -183,9 +156,74 @@ simply switching off the URL route to them. Example:
 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.
 
+- When working on a new feature locally that the developer does not want others on the team to see yet, the feature
+can be enabled in <code>config/features.local.yml</code> only as it is git ignored, and disabled in <code>config/features.yml</code>
+
+- When troubleshooting a deployed feature by simulating a non-development environment (e.g. staging or production) locally,
+the developer can disable it temporarily in <code>config/features.local.yml</code> (git ignored) under the non-development environment,
+perform tests on the feature, and then remove the local configuration once done.
+
+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"
+
+Example:
+
+>     export ABSTRACT_FEATURE_BRANCH_FEATURE1=TRUE
+>     rails s
+
+The first command adds an environment variable override for <code>feature1</code> that enables it regardless of any
+feature configuration, and the second command starts the rails server with <code>feature1</code> enabled.
+
+To remove environment variable override, you may run:
+
+>     unset ABSTRACT_FEATURE_BRANCH_FEATURE1
+>     rails s
+
+This can be done more easily via <code>config/features.local.yml</code> mentioned above. However, environment variable overrides are
+implemented to support overriding feature configuration for a Heroku deployed application more easily.
+
+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>
+
+Recommendation:
+
+It is recommended that you use environment variable overrides on Heroku only as an emergency or temporary measure.
+Afterward, make the change officially in config/features.yml, deploy, and remove the environment variable override for the long term.
+
+Gotcha with abstract feature branching in CSS and JS files:
+
+If you've used abstract feature branching in CSS or JS files via ERB, setting environment variable overrides won't
+affect them as you need asset recompilation in addition to it, which can only be triggered by changing a CSS or JS
+file and redeploying on Heroku (hint: even if it's just a minor change to force it). In any case, environment variable
+overrides have been recommended above as an emergency or temporary measure. If there is a need to rely on environment
+variable overrides to alter the style or JavaScript behavior of a page back and forth without a redeploy, one solution
+is to do additional abstract feature branching in HTML templates (e.g. ERB or HAML templates) to link to different
+CSS classes or invoke different JavaScript methods per branch of HTML for example.
+
 Release Notes
 -------------
 
+Version 0.5.0:
+- Added support for local configuration feature ignored by git + some performance optimizations via configuration caching and better algorithms.
+
 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.
 

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/abstract_feature_branch.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "abstract_feature_branch"
-  s.version = "0.4.0"
+  s.version = "0.5.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-21"
+  s.date = "2013-11-22"
   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",
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
     "lib/abstract_feature_branch.rb",
     "lib/ext/feature_branch.rb",
     "lib/generators/abstract_feature_branch/install_generator.rb",
+    "lib/generators/templates/config/features.local.yml",
     "lib/generators/templates/config/features.yml"
   ]
   s.homepage = "http://github.com/AndyObtiva/abstract_feature_branch"

data/lib/abstract_feature_branch.rb

@@ -10,8 +10,47 @@ rescue Bundler::BundlerError => e
 end
 
 module AbstractFeatureBranch
+  def self.environment_variable_overrides
+    @environment_variable_overrides ||= load_environment_variable_overrides
+  end
+  def self.load_environment_variable_overrides
+    @environment_variable_overrides = featureize_keys(select_feature_keys(booleanize_values(downcase_keys(ENV))))
+  end
+  def self.local_features
+    @local_features ||= Hash[YAML.load_file(File.join(Rails.root, 'config', 'features.local.yml')).map {|k, v| [k, v && downcase_keys(v)]}]
+    @local_features
+  end
   def self.features
-    @features ||= YAML.load_file(File.join(Rails.root, 'config', 'features.yml'))
+    @features ||= Hash[YAML.load_file(File.join(Rails.root, 'config', 'features.yml')).map {|k, v| [k, v && downcase_keys(v)]}]
+    @features
+  end
+  # performance optimization via caching of feature values resolved through environment variable overrides and local features
+  def self.environment_features(environment)
+    @environment_features ||= {}
+    @environment_features[environment] ||= load_environment_features(environment)
+  end
+  def self.load_environment_features(environment)
+    @environment_features[environment] = features[environment].merge(local_features[environment]).merge(environment_variable_overrides)
+  end
+
+  private
+
+  ENV_FEATURE_PREFIX = "abstract_feature_branch_"
+
+  def self.featureize_keys(hash)
+    Hash[hash.map {|k, v| [k.sub(ENV_FEATURE_PREFIX, ''), v]}]
+  end
+
+  def self.select_feature_keys(hash)
+    hash.reject {|k, v| !k.start_with?(ENV_FEATURE_PREFIX)} # using reject for Ruby 1.8 compatibility as select returns an array in it
+  end
+
+  def self.booleanize_values(hash)
+    Hash[hash.map {|k, v| [k, v.downcase == 'true']}]
+  end
+
+  def self.downcase_keys(hash)
+    Hash[hash.map {|k, v| [k.downcase, v]}]
   end
 end
 

data/lib/ext/feature_branch.rb

@@ -3,15 +3,13 @@ class Object
   def self.feature_branch(feature_name, branches = {}, &feature_work)
     branches[:true] ||= feature_work
     branches[:false] ||= lambda {}
-    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
+    feature_branch_symbol_value = (!!feature_enabled?(feature_name)).to_s.to_sym
+    branches[feature_branch_symbol_value].call
   end
 
   raise 'Abstract feature branch conflicts with another Ruby library' if respond_to?(:feature_enabled?)
   def self.feature_enabled?(feature_name)
-    AbstractFeatureBranch.features[Rails.env.to_s][feature_name.to_s]
+    AbstractFeatureBranch.environment_features(Rails.env.to_s)[feature_name.to_s]
   end
 
   raise 'Abstract feature branch conflicts with another Ruby library' if Object.new.respond_to?(:feature_branch)
@@ -23,15 +21,4 @@ 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

data/lib/generators/abstract_feature_branch/install_generator.rb

@@ -3,10 +3,15 @@ module AbstractFeatureBranch
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path("../../templates", __FILE__)
 
-      desc "Creates an Abstract Feature Branch configuration file in your application."
-
+      desc "Creates Abstract Feature Branch configuration files in your application."
       def copy_config
         template "config/features.yml", "config/features.yml"
+        template "config/features.local.yml", "config/features.local.yml"
+        append_to_file '.gitignore', <<-GIT_IGNORE_CONTENT
+
+#abstract_feature_branch local configuration file
+config/features.local.yml
+        GIT_IGNORE_CONTENT
       end
     end
   end

data/lib/generators/templates/config/features.local.yml

@@ -0,0 +1,15 @@
+# This file allows you to override any feature configuration locally without it being committed to git
+# It is recommended to use this file only for temporary overrides. Once done, make final change in config/features.yml
+defaults: &defaults
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+staging:
+  <<: *defaults
+
+production:
+  <<: *defaults

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abstract_feature_branch
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Annas "Andy" Maleh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-21 00:00:00.000000000 Z
+date: 2013-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -77,6 +77,7 @@ files:
 - lib/abstract_feature_branch.rb
 - lib/ext/feature_branch.rb
 - lib/generators/abstract_feature_branch/install_generator.rb
+- lib/generators/templates/config/features.local.yml
 - lib/generators/templates/config/features.yml
 homepage: http://github.com/AndyObtiva/abstract_feature_branch
 licenses: