abstract_feature_branch 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 695366cdc70dc9883e9bcfcc498c384d8b52620c
-  data.tar.gz: 9850c42b60dd40e604500acac757ea21598dd339
+  metadata.gz: c89fdfb59675ab1f3591c973daf0970ca1ad2c8f
+  data.tar.gz: 9fdb542f2134917987b0b45be6d2a6db9510b49a
 SHA512:
-  metadata.gz: 918fdebd4a2ea0b5f600141910d816573721434bb3931dd7d0e881815adfec0f5c0da2c084e1e5cd1a667c812a9ca95457929ef16b1afa477202c40c7db5861b
-  data.tar.gz: a1a7c5fceca419639dee473ee41d38ef9b0d9bb7f1aff55242d7fa4147e71ee950c860a8dac8172ce1c3a1e11b3c0c46f85894a4f36a9030410dae18368320af
+  metadata.gz: 13306a2b078d7fbc4938f7f4306bb0c8a0615ef1726a7b2bdbb306c5c16675a4e9d9956110982ffbeea2e1b4cc1e0e7e732a2073832b0e354561dd0240aff221
+  data.tar.gz: 408facf5b950144549f27faef351d36362f1a324a5f78faf8473574b7f0ed5331bff4c8ae70f4af2b8f096a174689547ea0ecc2162af098725d68ac46aab4fe2

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: ylr6gphUkEVGf9nvY5Hfz48RHZnOf0Jjv

data/.travis.yml

@@ -7,3 +7,22 @@ rvm:
   - jruby-18mode
   - jruby-19mode
   - rbx-2.1.1
+gemfile:
+  - Gemfile
+  - ruby187.Gemfile
+matrix:
+  include:
+    - rvm: 2.0.0
+      gemfile: Gemfile
+    - rvm: 1.9.3
+      gemfile: Gemfile
+    - rvm: 1.8.7
+      gemfile: ruby187.Gemfile
+    - rvm: ree
+      gemfile: ruby187.Gemfile
+    - rvm: jruby-18mode
+      gemfile: Gemfile
+    - rvm: jruby-19mode
+      gemfile: Gemfile
+    - rvm: rbx-2.1.1
+      gemfile: ruby187.Gemfile

data/README.md

@@ -2,6 +2,7 @@ Abstract Feature Branch
 =======================
 [![Gem Version](https://badge.fury.io/rb/abstract_feature_branch.png)](http://badge.fury.io/rb/abstract_feature_branch)
 [![Build Status](https://api.travis-ci.org/AndyObtiva/abstract_feature_branch.png?branch=master)](https://travis-ci.org/AndyObtiva/abstract_feature_branch)
+[![Coverage Status](https://coveralls.io/repos/AndyObtiva/abstract_feature_branch/badge.png?branch=master)](https://coveralls.io/r/AndyObtiva/abstract_feature_branch?branch=master)
 
 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
@@ -35,15 +36,15 @@ Setup
 ### Rails Application Use
 
 1. Configure Rubygem
-   - Rails (~> 4.0.0 or ~> 3.0): Add the following to Gemfile <pre>gem 'abstract_feature_branch', '0.8.0'</pre>
-   - Rails (~> 2.0): Add the following to config/environment.rb <pre>config.gem 'abstract_feature_branch', :version => '0.8.0'</pre>
+   - Rails (~> 4.0.0 or ~> 3.0): Add the following to Gemfile <pre>gem 'abstract_feature_branch', '0.9.0'</pre>
+   - Rails (~> 2.0): Add the following to config/environment.rb <pre>config.gem 'abstract_feature_branch', :version => '0.9.0'</pre>
 2. Generate <code>config/initializers/abstract_feature_branch.rb</code>, <code>lib/tasks/abstract_feature_branch.rake</code>, <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> (more details under [**instructions**](#instructions))
 4. (Optional and rarely needed) Customize configuration in <code>config/initializers/abstract_feature_branch.rb</code> (can be useful for changing location of feature files in Rails application or troubleshooting a specific Rails environment feature configuration)
 
 ### Ruby Application General Use
 
-1. <pre>gem install abstract_feature_branch -v 0.8.0</pre>
+1. <pre>gem install abstract_feature_branch -v 0.9.0</pre>
 2. Add code <code>require 'abstract_feature_branch'</code>
 3. Create <code>config/features.yml</code> under <code>AbstractFeatureBranch.application_root</code> and fill it with content similar to that of the sample <code>config/features.yml</code> mentioned under [**instructions**](#instructions).
 4. (Optional) Create <code>config/features.local.yml</code> under <code>AbstractFeatureBranch.application_root</code>  (more details under [**instructions**](#instructions))
@@ -358,6 +359,7 @@ For Rails application use, the rake task is generated under <code>lib/tasks/abst
 
 For Ruby application general use, here is the content of the rake task:
 
+>     require 'abstract_feature_branch'
 >     namespace :abstract_feature_branch do
 >
 >       desc "Beautify YAML of specified feature file via file_path argument or all feature files when no argument specified (config/features.yml, config/features.local.yml, and config/features/**/*.yml) by sorting features by name and eliminating extra empty lines"
@@ -378,6 +380,9 @@ task changes.
 Release Notes
 -------------
 
+Version 0.9.0:
+- Added support for runtime read of feature files in development to ease local testing (trading off performance)
+
 Version 0.8.0:
 - Added rake task for beautifying feature files, sorting feature names within environment sections and eliminating extra empty lines. Added support for externalized logger.
 
@@ -428,7 +433,6 @@ Version 0.2.0:
 Upcoming
 --------
 
-- 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.8.0
+0.9.0

data/abstract_feature_branch.gemspec

@@ -5,17 +5,18 @@
 
 Gem::Specification.new do |s|
   s.name = "abstract_feature_branch"
-  s.version = "0.8.0"
+  s.version = "0.9.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-25"
+  s.date = "2013-11-26"
   s.description = "abstract_feature_branch is a Rails gem that enables developers to easily branch by abstraction as per this pattern:\nhttp://paulhammant.com/blog/branch_by_abstraction.html\n\nIt is a productivity and fault tolerance enhancing team practice that has been utilized by professional software development\nteams at large corporations, such as Sears and Groupon.\n\nIt provides the ability to wrap blocks of code with an abstract feature branch name, and then\nspecify in a configuration file which features to be switched on or off.\n\nThe goal is to build out upcoming features in the same source code repository branch, regardless of whether all are\ncompleted by the next release date or not, thus increasing team productivity by preventing integration delays.\nDevelopers then disable in-progress features until they are ready to be switched on in production, yet enable them\nlocally and in staging environments for in-progress testing.\n\nThis gives developers the added benefit of being able to switch a feature off after release should big problems arise\nfor a high risk feature.\n\nabstract_feature_branch additionally supports DDD's pattern of\nBounded Contexts by allowing developers to configure\ncontext-specific feature files if needed.\n"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
   ]
   s.files = [
+    ".coveralls.yml",
     ".travis.yml",
     "LICENSE.txt",
     "README.md",
@@ -37,9 +38,11 @@ Gem::Specification.new do |s|
     "lib/generators/templates/config/features.yml",
     "lib/generators/templates/config/initializers/abstract_feature_branch.rb",
     "lib/generators/templates/lib/tasks/abstract_feature_branch.rake",
+    "ruby187.Gemfile",
     "spec/abstract_feature_branch/file_beautifier_spec.rb",
     "spec/ext/feature_branch__feature_branch_spec.rb",
     "spec/ext/feature_branch__feature_enabled_spec.rb",
+    "spec/fixtures/application_development_config/config/features.reference.yml",
     "spec/fixtures/application_no_config/no_config",
     "spec/fixtures/application_rails_config/config/features.local.yml",
     "spec/fixtures/application_rails_config/config/features.yml",
@@ -69,16 +72,13 @@ Gem::Specification.new do |s|
     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<jeweler>, ["= 1.8.8"])
-      s.add_development_dependency(%q<rspec>, ["= 2.14.1"])
     else
       s.add_dependency(%q<deep_merge>, ["= 1.0.0"])
       s.add_dependency(%q<jeweler>, ["= 1.8.8"])
-      s.add_dependency(%q<rspec>, ["= 2.14.1"])
     end
   else
     s.add_dependency(%q<deep_merge>, ["= 1.0.0"])
     s.add_dependency(%q<jeweler>, ["= 1.8.8"])
-    s.add_dependency(%q<rspec>, ["= 2.14.1"])
   end
 end
 

data/lib/abstract_feature_branch.rb

@@ -82,6 +82,7 @@ module AbstractFeatureBranch
     @environment_features[environment] = features[environment].merge(local_features[environment]).merge(environment_variable_overrides)
   end
   def self.application_features
+    unload_application_features unless cacheable?
     environment_features(application_environment)
   end
   def self.load_application_features
@@ -90,6 +91,15 @@ module AbstractFeatureBranch
     AbstractFeatureBranch.load_local_features
     AbstractFeatureBranch.load_environment_features(application_environment)
   end
+  def self.unload_application_features
+    @environment_variable_overrides = nil
+    @features = nil
+    @local_features = nil
+    @environment_features = nil
+  end
+  def self.cacheable?
+    application_environment != 'development'
+  end
 
   private
 

data/ruby187.Gemfile

@@ -0,0 +1,11 @@
+source 'http://rubygems.org'
+
+gem 'deep_merge', '1.0.0', :require => false #avoid loading into memory to use deep_merge only if Rails is unavailable
+
+group :development do
+  gem 'jeweler', '1.8.8'
+end
+
+group :test do
+  gem 'rspec', '2.14.1'
+end

data/spec/ext/feature_branch__feature_branch_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe 'feature_branch object extensions' do
   before do
     @app_env_backup = AbstractFeatureBranch.application_environment
+    @app_root_backup = AbstractFeatureBranch.application_root
     AbstractFeatureBranch.logger.warn 'Environment variable ABSTRACT_FEATURE_BRANCH_FEATURE1 already set, potentially conflicting with another test' if ENV.keys.include?('ABSTRACT_FEATURE_BRANCH_FEATURE1')
     AbstractFeatureBranch.logger.warn 'Environment variable Abstract_Feature_Branch_Feature2 already set, potentially conflicting with another test' if ENV.keys.include?('Abstract_Feature_Branch_Feature2')
     AbstractFeatureBranch.logger.warn 'Environment variable abstract_feature_branch_feature3 already set, potentially conflicting with another test' if ENV.keys.include?('abstract_feature_branch_feature3')
@@ -11,9 +12,9 @@ describe 'feature_branch object extensions' do
     ENV.delete('ABSTRACT_FEATURE_BRANCH_FEATURE1')
     ENV.delete('Abstract_Feature_Branch_Feature2')
     ENV.delete('abstract_feature_branch_feature3')
-    AbstractFeatureBranch.initialize_application_root
-    AbstractFeatureBranch.load_application_features
+    AbstractFeatureBranch.application_root = @app_root_backup
     AbstractFeatureBranch.application_environment = @app_env_backup
+    AbstractFeatureBranch.unload_application_features
   end
   describe '#feature_branch' do
     context 'class level behavior (case-insensitive string or symbol feature names)' do

data/spec/ext/feature_branch__feature_enabled_spec.rb

@@ -3,6 +3,7 @@ require 'spec_helper'
 describe 'feature_branch object extensions' do
   before do
     @app_env_backup = AbstractFeatureBranch.application_environment
+    @app_root_backup = AbstractFeatureBranch.application_root
     AbstractFeatureBranch.logger.warn 'Environment variable ABSTRACT_FEATURE_BRANCH_FEATURE1 already set, potentially conflicting with another test' if ENV.keys.include?('ABSTRACT_FEATURE_BRANCH_FEATURE1')
     AbstractFeatureBranch.logger.warn 'Environment variable Abstract_Feature_Branch_Feature2 already set, potentially conflicting with another test' if ENV.keys.include?('Abstract_Feature_Branch_Feature2')
     AbstractFeatureBranch.logger.warn 'Environment variable abstract_feature_branch_feature3 already set, potentially conflicting with another test' if ENV.keys.include?('abstract_feature_branch_feature3')
@@ -11,9 +12,9 @@ describe 'feature_branch object extensions' do
     ENV.delete('ABSTRACT_FEATURE_BRANCH_FEATURE1')
     ENV.delete('Abstract_Feature_Branch_Feature2')
     ENV.delete('abstract_feature_branch_feature3')
-    AbstractFeatureBranch.initialize_application_root
-    AbstractFeatureBranch.load_application_features
+    AbstractFeatureBranch.application_root = @app_root_backup
     AbstractFeatureBranch.application_environment = @app_env_backup
+    AbstractFeatureBranch.unload_application_features
   end
   describe '#feature_enabled?' do
     it 'determines whether a feature is enabled or not in features configuration (case-insensitive string or symbol feature names)' do
@@ -38,7 +39,7 @@ describe 'feature_branch object extensions' do
       feature_enabled?(:feature4).should == false
       feature_enabled?(:feature5).should == true
     end
-    it 'no local configuration in production environment' do
+    it 'has no local configuration for production environment' do
       AbstractFeatureBranch.application_environment = 'production'
       feature_enabled?(:feature4).should == true
       feature_enabled?(:feature5).should be_nil
@@ -64,6 +65,86 @@ describe 'feature_branch object extensions' do
       feature_enabled?(:feature4a).should be_nil
       feature_enabled?(:feature5).should be_nil
     end
+
+    context 'cacheability' do
+      before do
+        @development_application_root = File.expand_path(File.join(__FILE__, '..', '..', 'fixtures', 'application_development_config'))
+        @feature_file_reference_path = File.join(@development_application_root, 'config', 'features.reference.yml')
+        @feature_file_path = File.join(@development_application_root, 'config', 'features.yml')
+        FileUtils.cp(@feature_file_reference_path, @feature_file_path)
+        AbstractFeatureBranch.application_root = @development_application_root
+      end
+      after do
+        FileUtils.rm(@feature_file_path)
+      end
+      it 'refreshes features at runtime in development (without forcing load of application features again)' do
+        AbstractFeatureBranch.application_environment = 'development'
+        feature_enabled?(:feature1).should == false
+        feature_enabled?(:feature2).should == true
+        File.open(@feature_file_path, 'w+') do |file|
+          file << <<-CONTENT
+defaults: &defaults
+
+development:
+  <<: *defaults
+  FEATURE1: true
+  Feature2: false
+
+test:
+  <<: *defaults
+  FEATURE1: true
+  Feature2: false
+
+staging:
+  <<: *defaults
+  FEATURE1: true
+  Feature2: false
+
+production:
+  <<: *defaults
+  FEATURE1: true
+  Feature2: false
+          CONTENT
+        end
+        feature_enabled?(:feature1).should == true
+        feature_enabled?(:feature2).should == false
+      end
+      %w(test staging production).each do |environment|
+        it "does not refresh features at runtime in #{environment} (without forcing load of application features again)" do
+          AbstractFeatureBranch.application_environment = environment
+          AbstractFeatureBranch.load_application_features
+          feature_enabled?(:feature1).should == false
+          feature_enabled?(:feature2).should == true
+          File.open(@feature_file_path, 'w+') do |file|
+            file << <<-CONTENT
+defaults: &defaults
+
+development:
+  <<: *defaults
+  FEATURE1: true
+  Feature2: false
+
+test:
+  <<: *defaults
+  FEATURE1: true
+  Feature2: false
+
+staging:
+  <<: *defaults
+  FEATURE1: true
+  Feature2: false
+
+production:
+  <<: *defaults
+  FEATURE1: true
+  Feature2: false
+            CONTENT
+          end
+          feature_enabled?(:feature1).should == false
+          feature_enabled?(:feature2).should == true
+        end
+      end
+    end
   end
   describe 'self#feature_enabled?' do
     after do

data/spec/fixtures/application_development_config/config/features.reference.yml

@@ -0,0 +1,21 @@
+defaults: &defaults
+
+development:
+  <<: *defaults
+  FEATURE1: false
+  Feature2: true
+
+test:
+  <<: *defaults
+  FEATURE1: false
+  Feature2: true
+
+staging:
+  <<: *defaults
+  FEATURE1: false
+  Feature2: true
+
+production:
+  <<: *defaults
+  FEATURE1: false
+  Feature2: true

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abstract_feature_branch
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Annas "Andy" Maleh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-25 00:00:00.000000000 Z
+date: 2013-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -38,20 +38,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.8.8
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.14.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 2.14.1
 description: |
   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
@@ -80,6 +66,7 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- .coveralls.yml
 - .travis.yml
 - LICENSE.txt
 - README.md
@@ -101,9 +88,11 @@ files:
 - lib/generators/templates/config/features.yml
 - lib/generators/templates/config/initializers/abstract_feature_branch.rb
 - lib/generators/templates/lib/tasks/abstract_feature_branch.rake
+- ruby187.Gemfile
 - spec/abstract_feature_branch/file_beautifier_spec.rb
 - spec/ext/feature_branch__feature_branch_spec.rb
 - spec/ext/feature_branch__feature_enabled_spec.rb
+- spec/fixtures/application_development_config/config/features.reference.yml
 - spec/fixtures/application_no_config/no_config
 - spec/fixtures/application_rails_config/config/features.local.yml
 - spec/fixtures/application_rails_config/config/features.yml