abstract_feature_branch 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb2107fd2312b62c1864e7b60ce08c24620229c0
-  data.tar.gz: e9a07cf69f21a778a4f9245e5c53e3b2e71f4d53
+  metadata.gz: e0ac105f82f311d41f4de3e74b47d80a97f256ae
+  data.tar.gz: 2a6c82543d466d7f0783e325d4a351e81ccac8d3
 SHA512:
-  metadata.gz: bca12505dd8a199f432261d7498ed5378b2199a36236bca57cb13613c3f83b58acfefba5faa18cf9a223d5bdc29a451326429b9ae31bfa9f0923475d5d2e8c0a
-  data.tar.gz: f1f7d0a7db3534745891a034fd357557b93299b9ac86fb4879715a5bae84a53d825684dfe49d00557b3137f51b165d0cd3d6ca26cd9744178226c2f511fca650
+  metadata.gz: 2e19186625bb9665d2606069de65e9ae9131cf4287c6ec2a467a235ce4698ccba85b818e17d9f07cec343f65c77207956161c4ae1a5ef7883de2067642746bfd
+  data.tar.gz: 6dcf6ac83b3ce412f9b5fd0de2999889042ca94b0ab21a31c7268386471ef178de6a3e6256cdd6ad1efb66ab0fdf801e0448511a41673fa2a247b34da665a1a4

data/README.md

@@ -4,6 +4,9 @@ Abstract Feature Branch
 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
 
+It is a productivity and fault tolerance enhancing team practice that has been utilized by professional software development
+teams at large corporations, such as Sears and Groupon.
+
 It gives ability to wrap blocks of code with an abstract feature branch name, and then
 specify which features to be switched on or off in a configuration file.
 
@@ -15,6 +18,10 @@ 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.
 
+abstract_feature_branch additionally supports [DDD](http://www.domaindrivendesign.org)'s pattern of
+[bounded contexts](http://dddcommunity.org/uncategorized/bounded-context/), but allowing developers to configure
+context-specific feature files if needed.
+
 Requirements
 ------------
 - Ruby ~> 2.0.0, ~> 1.9 or ~> 1.8.7
@@ -24,9 +31,10 @@ Setup
 -----
 
 1. Configure Rubygem
-   - 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>
+   - Rails (~> 4.0.0 or ~> 3.0): Add the following to Gemfile <pre>gem 'abstract_feature_branch', '0.6.0'</pre>
+   - Rails (~> 2.0): Add the following to config/environment.rb <pre>config.gem 'absract_feature_branch', :version => '0.6.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>
+3. (Optional) Generate <code>config/features/[context_path].yml</code> in your Rails app directory by running <pre>rails g abstract_feature_branch:context context_path</pre>
 
 Instructions
 ------------
@@ -36,6 +44,14 @@ Instructions
 <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.
 
+Optional context specific <code>config/features/[context_path].yml</code> contain feature configuration for specific application contexts.
+For example: admin, public, or even internal/wiki. Useful for better organization especially once <code>config/features.yml</code> grows too big (e.g. 20+ features)
+
+Optional context specific <code>config/features/[context_path].local.yml</code> contain local overrides for context-specific feature configuration.
+These files are rarely necessary as any feature (even a context feature) can be overridden in <code>config/features.local.yml</code>,
+so these additional <code>*.local.yml</code> files are only recommended to be utilized once <code>config/features.local.yml</code> grows
+too big (e.g. 20+ features).
+
 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).
 
@@ -156,6 +172,9 @@ 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.
 
+- Split <code>config/features.yml</code> into multiple context-specific feature files once it grows too big (e.g. 20+ features) by
+utilizing the context generator mentioned above: <pre>rails g abstract_feature_branch:context context_path</pre>
+
 - 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>
 
@@ -178,13 +197,14 @@ Example:
 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:
+To remove an 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.
+The benefits can be achieved 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
 ------
@@ -218,9 +238,24 @@ variable overrides to alter the style or JavaScript behavior of a page back and
 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.
 
+Feature Configuration Load Order
+--------------------------------
+
+For better knowledge and clarity, here is the order in which feature configuration is loaded, with the latter sources overriding
+the former if overlap in features occurs:
+
+1. Context-specific feature files: <code>config/features/**/*.yml</code>
+2. Main feature file: <code>config/features.yml</code>
+3. Context-specific local feature file overrides: <code>config/features/**/*.local.yml</code>
+4. Main local feature file override: <code>config/features.local.yml</code>
+5. Environment variable overrides
+
 Release Notes
 -------------
 
+Version 0.6.0:
+- Added a context generator and support for reading feature configuration from context files config/features/**/*.yml and config/features/**/*.local.yml
+
 Version 0.5.0:
 - Added support for local configuration feature ignored by git + some performance optimizations via configuration caching and better algorithms.
 
@@ -256,10 +291,10 @@ Version 0.2.0:
 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
 - Add rake task to reorder feature entries in feature.yml alphabetically
+- Support runtime read of features yml in development for easy testing purposes (trading off performance)
+- Support configuring per environment whether features yml is read at runtime or not (given performance trade-off)
 
 Contributing to abstract_feature_branch
 ---------------------------------------

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/abstract_feature_branch.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "abstract_feature_branch"
-  s.version = "0.5.0"
+  s.version = "0.6.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-22"
+  s.date = "2013-11-23"
   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",
@@ -20,9 +20,17 @@ Gem::Specification.new do |s|
     "README.md",
     "VERSION",
     "abstract_feature_branch.gemspec",
+    "config/features/admin.local.yml",
+    "config/features/admin.yml",
+    "config/features/internal/wiki.local.yml",
+    "config/features/internal/wiki.yml",
+    "config/features/public.local.yml",
+    "config/features/public.yml",
     "lib/abstract_feature_branch.rb",
     "lib/ext/feature_branch.rb",
+    "lib/generators/abstract_feature_branch/context_generator.rb",
     "lib/generators/abstract_feature_branch/install_generator.rb",
+    "lib/generators/templates/config/features.example.yml",
     "lib/generators/templates/config/features.local.yml",
     "lib/generators/templates/config/features.yml"
   ]
@@ -36,15 +44,18 @@ Gem::Specification.new do |s|
     s.specification_version = 4
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<deep_merge>, ["= 1.0.0"])
       s.add_development_dependency(%q<rspec>, ["= 2.11.0"])
       s.add_development_dependency(%q<rdoc>, ["= 3.12.2"])
       s.add_development_dependency(%q<jeweler>, ["= 1.8.8"])
     else
+      s.add_dependency(%q<deep_merge>, ["= 1.0.0"])
       s.add_dependency(%q<rspec>, ["= 2.11.0"])
       s.add_dependency(%q<rdoc>, ["= 3.12.2"])
       s.add_dependency(%q<jeweler>, ["= 1.8.8"])
     end
   else
+    s.add_dependency(%q<deep_merge>, ["= 1.0.0"])
     s.add_dependency(%q<rspec>, ["= 2.11.0"])
     s.add_dependency(%q<rdoc>, ["= 3.12.2"])
     s.add_dependency(%q<jeweler>, ["= 1.8.8"])

data/config/features/admin.local.yml

@@ -0,0 +1,14 @@
+defaults: &defaults
+  admin_feature3: true
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+staging:
+  <<: *defaults
+
+production:
+  <<: *defaults

data/config/features/admin.yml

@@ -0,0 +1,16 @@
+defaults: &defaults
+  admin_feature1: true
+  admin_feature2: false
+  admin_feature3: false
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+staging:
+  <<: *defaults
+
+production:
+  <<: *defaults

data/config/features/internal/wiki.local.yml

@@ -0,0 +1,14 @@
+defaults: &defaults
+  wiki_feature3: true
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+staging:
+  <<: *defaults
+
+production:
+  <<: *defaults

data/config/features/internal/wiki.yml

@@ -0,0 +1,16 @@
+defaults: &defaults
+  wiki_feature1: true
+  wiki_feature2: false
+  wiki_feature3: false
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+staging:
+  <<: *defaults
+
+production:
+  <<: *defaults

data/config/features/public.local.yml

@@ -0,0 +1,14 @@
+defaults: &defaults
+  public_feature3: true
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+staging:
+  <<: *defaults
+
+production:
+  <<: *defaults

data/config/features/public.yml

@@ -0,0 +1,16 @@
+defaults: &defaults
+  public_feature1: true
+  public_feature2: false
+  public_feature3: false
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+staging:
+  <<: *defaults
+
+production:
+  <<: *defaults

data/lib/abstract_feature_branch.rb

@@ -8,6 +8,7 @@ rescue Bundler::BundlerError => e
   $stderr.puts "Run `bundle install` to install missing gems"
   exit e.status_code
 end
+require 'deep_merge' unless {}.respond_to?(:deep_merge!)
 
 module AbstractFeatureBranch
   def self.environment_variable_overrides
@@ -17,12 +18,24 @@ module AbstractFeatureBranch
     @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
+    @local_features ||= load_local_features
+  end
+  def self.load_local_features
+    @local_features = {}
+    Dir.glob(File.join(Rails.root, 'config', 'features', '**', '*.local.yml')).each do |feature_configuration_file|
+      @local_features.deep_merge!(downcase_feature_hash_keys(YAML.load_file(feature_configuration_file)))
+    end
+    @local_features.deep_merge!(downcase_feature_hash_keys(YAML.load_file(File.join(Rails.root, 'config', 'features.local.yml'))))
   end
   def self.features
-    @features ||= Hash[YAML.load_file(File.join(Rails.root, 'config', 'features.yml')).map {|k, v| [k, v && downcase_keys(v)]}]
-    @features
+    @features ||= load_features
+  end
+  def self.load_features
+    @features = {}
+    Dir.glob(File.join(Rails.root, 'config', 'features', '**', '*.yml')).each do |feature_configuration_file|
+      @features.deep_merge!(downcase_feature_hash_keys(YAML.load_file(feature_configuration_file)))
+    end
+    @features.deep_merge!(downcase_feature_hash_keys(YAML.load_file(File.join(Rails.root, 'config', 'features.yml'))))
   end
   # performance optimization via caching of feature values resolved through environment variable overrides and local features
   def self.environment_features(environment)
@@ -52,6 +65,10 @@ module AbstractFeatureBranch
   def self.downcase_keys(hash)
     Hash[hash.map {|k, v| [k.downcase, v]}]
   end
+
+  def self.downcase_feature_hash_keys(hash)
+    Hash[hash.map {|k, v| [k, v && downcase_keys(v)]}]
+  end
 end
 
 require File.join(File.dirname(__FILE__), 'ext', 'feature_branch')

data/lib/generators/abstract_feature_branch/context_generator.rb

@@ -0,0 +1,12 @@
+module AbstractFeatureBranch
+  module Generators
+    class ContextGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Creates a configuration file for a specific application context (e.g. admin). Takes context path as argument (e.g. admin or internal/wiki) to create config/features/#{context_path}.yml"
+      def copy_config
+        template "config/features.yml", "config/features/#{file_path}.yml"
+      end
+    end
+  end
+end

data/lib/generators/abstract_feature_branch/install_generator.rb

@@ -3,14 +3,16 @@ module AbstractFeatureBranch
     class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path("../../templates", __FILE__)
 
-      desc "Creates Abstract Feature Branch configuration files in your application."
+      desc "Installs Abstract Feature Branch by generating basic configuration files, including git ignored local one."
       def copy_config
-        template "config/features.yml", "config/features.yml"
+        template "config/features.example.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
+/config/features.local.yml
+/config/features/*.local.yml
+/config/features/**/*.local.yml
         GIT_IGNORE_CONTENT
       end
     end

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

@@ -0,0 +1,19 @@
+defaults: &defaults
+  feature1: true
+  feature2: true
+  feature3: false
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+staging:
+  <<: *defaults
+  feature2: false
+
+production:
+  <<: *defaults
+  feature1: false
+  feature2: false

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

@@ -1,5 +1,5 @@
 # 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
+# It is recommended to use this file only for temporary overrides. Once done, make final change in main .yml
 defaults: &defaults
 
 development:

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

@@ -1,7 +1,4 @@
 defaults: &defaults
-  feature1: true
-  feature2: true
-  feature3: false
 
 development:
   <<: *defaults
@@ -11,9 +8,6 @@ test:
 
 staging:
   <<: *defaults
-  feature2: false
 
 production:
-  <<: *defaults
-  feature1: false
-  feature2: false
+  <<: *defaults

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: abstract_feature_branch
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Annas "Andy" Maleh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-22 00:00:00.000000000 Z
+date: 2013-11-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -74,9 +88,17 @@ files:
 - README.md
 - VERSION
 - abstract_feature_branch.gemspec
+- config/features/admin.local.yml
+- config/features/admin.yml
+- config/features/internal/wiki.local.yml
+- config/features/internal/wiki.yml
+- config/features/public.local.yml
+- config/features/public.yml
 - lib/abstract_feature_branch.rb
 - lib/ext/feature_branch.rb
+- lib/generators/abstract_feature_branch/context_generator.rb
 - lib/generators/abstract_feature_branch/install_generator.rb
+- lib/generators/templates/config/features.example.yml
 - lib/generators/templates/config/features.local.yml
 - lib/generators/templates/config/features.yml
 homepage: http://github.com/AndyObtiva/abstract_feature_branch