abstract_feature_branch 0.9.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c89fdfb59675ab1f3591c973daf0970ca1ad2c8f
-  data.tar.gz: 9fdb542f2134917987b0b45be6d2a6db9510b49a
+  metadata.gz: a94572977e6efa72fc039c72a7674229b158a774
+  data.tar.gz: 4afc8329e8a7122248ba1be4fd4af84d8f58f386
 SHA512:
-  metadata.gz: 13306a2b078d7fbc4938f7f4306bb0c8a0615ef1726a7b2bdbb306c5c16675a4e9d9956110982ffbeea2e1b4cc1e0e7e732a2073832b0e354561dd0240aff221
-  data.tar.gz: 408facf5b950144549f27faef351d36362f1a324a5f78faf8473574b7f0ed5331bff4c8ae70f4af2b8f096a174689547ea0ecc2162af098725d68ac46aab4fe2
+  metadata.gz: b35df2e5e4fbdc3430c88ef4642895296063a2479584fceeed1c89d43dd95675905198d28edae0dbcdd1d5ce5952c73a7837046827feec60d253a46b6a8bea13
+  data.tar.gz: 9ecc727ef80cae0d170e123fd310db95154ad7da8d12ddc7732e72e523bcf20a50781a0b88c256c3dcce273e6d22be2b1a68f53e2d67b860d1d78f6dfcb99161

data/.travis.yml

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

data/README.md

@@ -36,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.9.0'</pre>
-   - Rails (~> 2.0): Add the following to config/environment.rb <pre>config.gem 'abstract_feature_branch', :version => '0.9.0'</pre>
+   - Rails (~> 4.0.0 or ~> 3.0): Add the following to Gemfile <pre>gem 'abstract_feature_branch', '1.0.0'</pre>
+   - Rails (~> 2.0): Add the following to config/environment.rb <pre>config.gem 'abstract_feature_branch', :version => '1.0.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.9.0</pre>
+1. <pre>gem install abstract_feature_branch -v 1.0.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))
@@ -52,7 +52,8 @@ Setup
 6. (Optional) Add code <code>AbstractFeatureBranch.application_root = "[your_application_path]"</code> to configure the location of feature files (it defaults to <code>'.'</code>)
 7. (Optional) Add code <code>AbstractFeatureBranch.application_environment = "[your_application_environment]"</code> (it defaults to <code>'development'</code>). Alternatively, you can set <code>ENV['APP_ENV']</code> before the <code>require</code> statement or an an external environment variable.
 8. (Optional) Add code <code>AbstractFeatureBranch.logger = "[your_application_logger]"</code> (it defaults to a new instance of Ruby <code>Logger</code>. Must use a logger with <code>info</code> and <code>warn</code> methods).
-9. (Optional) Add code <code>AbstractFeatureBranch.load_application_features</code> to pre-load application features for improved first-use performance
+9. (Optional) Add code <code>AbstractFeatureBranch.cacheable = {[environment] => [true/false]}</code> to indicate cacheability of loaded feature files for enhanced performance (it defaults to true for every environment other than development).
+10. (Optional) Add code <code>AbstractFeatureBranch.load_application_features</code> to pre-load application features for improved first-use performance
 
 Instructions
 ------------
@@ -283,8 +284,17 @@ Here is the content of the generated initializer (<code>config/initializers/abst
 >     # Abstract Feature Branch logger
 >     AbstractFeatureBranch.logger = Rails.logger
 >
->     # Pre-loads application features to improve performance of first web-page hit
->     AbstractFeatureBranch.load_application_features
+>     # Cache feature files once read or re-read them at runtime on every use (helps development).
+>     # Defaults to true if environment not specified, except for development, which defaults to false.
+>     AbstractFeatureBranch.cacheable = {
+>       :development => false,
+>       :test => true,
+>       :staging => true,
+>       :production => true
+>     }
+>
+>     # Pre-load application features to improve performance of first web-page hit
+>     AbstractFeatureBranch.load_application_features unless Rails.env.development?
 
 Rake Task
 ---------
@@ -374,67 +384,10 @@ The rake task may be invoked in a number of ways:
 - <code>rake abstract_feature_branch:beautify_files[file_path]</code> beautifies a single feature file
 - <code>rake abstract_feature_branch:beautify_files[directory_path]</code> beautifies all feature files under directory path recursively
 
-Verify after the task has been invoked that your feature file contents are to your satisfaction before committing the
+Note that the beautifier ignores comments at the top, but deletes entire line comments in the middle of a YAML file, so
+after invoking the rake task, **verify** that your feature file contents are to your satisfaction before committing the
 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.
-
-Version 0.7.1:
-- Fixed undefined method issue with using <code>AbstractFeatureBranch.load_application_features</code> to improve first use performance
-
-Version 0.7.0:
-- Added support for general Ruby use (without Rails) by externalizing AbstractFeatureBranch.application_root and AbstractFeatureBranch.application_environment. Added initializer to optionally configure them. Supported case-insensitive feature names.
-
-Version 0.6.1 - 0.6.4:
-- Fixed issues including making feature configuration files optional (in case one wants to get rid of <code>features.local.yml</code> or even <code>features.yml</code>)
-
-Version 0.6.0:
-- Added a context generator and support for reading feature configuration from context files <code>config/features/**/*.yml</code> and <code>config/features/**/*.local.yml</code>
-
-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.
-
-Version 0.3.6:
-- Fixed feature_branch issue with invalid feature name, preventing block execution and returning nil instead
-
-Version 0.3.5:
-- Fixed issue with generator not allowing consuming client app to start Rails server successfully
-
-Version 0.3.4:
-- Added <code>abstract_feature_branch:install</code> generator to easily get started with a sample <code>config/features.yml</code>
-
-Version 0.3.3:
-- Removed version from README title
-
-Version 0.3.2:
-- Added <code>AbstractFeatureBranch.features</code> to delay YAML load until <code>Rails.root</code> has been established
-
-Version 0.3.1:
-- Removed dependency on the rails_config gem
-
-Version 0.3.0:
-- Simplified <code>features.yml</code> requirement to have a features header under each environment
-- Moved feature storage from Settings object to <code>AbstractFeatureBranch::FEATURES</code>
-
-Version 0.2.0:
-- Support an "else" block to execute when a feature is off (via <code>:true</code> and <code>:false</code> lambda arguments)
-- Support ability to check if a feature is enabled or not (via <code>feature_enabled?</code>)
-
-Upcoming
---------
-
-- Support configuring per environment whether features yml is read at runtime or not (given performance trade-off)
-
 Contributing to abstract_feature_branch
 ---------------------------------------
 

data/RELEASE_NOTES.md

@@ -0,0 +1,55 @@
+Release Notes
+-------------
+
+Version 0.9.0:
+- Added configuration support for feature cacheability
+
+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.
+
+Version 0.7.1:
+- Fixed undefined method issue with using <code>AbstractFeatureBranch.load_application_features</code> to improve first use performance
+
+Version 0.7.0:
+- Added support for general Ruby use (without Rails) by externalizing AbstractFeatureBranch.application_root and AbstractFeatureBranch.application_environment. Added initializer to optionally configure them. Supported case-insensitive feature names.
+
+Version 0.6.1 - 0.6.4:
+- Fixed issues including making feature configuration files optional (in case one wants to get rid of <code>features.local.yml</code> or even <code>features.yml</code>)
+
+Version 0.6.0:
+- Added a context generator and support for reading feature configuration from context files <code>config/features/**/*.yml</code> and <code>config/features/**/*.local.yml</code>
+
+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.
+
+Version 0.3.6:
+- Fixed feature_branch issue with invalid feature name, preventing block execution and returning nil instead
+
+Version 0.3.5:
+- Fixed issue with generator not allowing consuming client app to start Rails server successfully
+
+Version 0.3.4:
+- Added <code>abstract_feature_branch:install</code> generator to easily get started with a sample <code>config/features.yml</code>
+
+Version 0.3.3:
+- Removed version from README title
+
+Version 0.3.2:
+- Added <code>AbstractFeatureBranch.features</code> to delay YAML load until <code>Rails.root</code> has been established
+
+Version 0.3.1:
+- Removed dependency on the rails_config gem
+
+Version 0.3.0:
+- Simplified <code>features.yml</code> requirement to have a features header under each environment
+- Moved feature storage from Settings object to <code>AbstractFeatureBranch::FEATURES</code>
+
+Version 0.2.0:
+- Support an "else" block to execute when a feature is off (via <code>:true</code> and <code>:false</code> lambda arguments)
+- Support ability to check if a feature is enabled or not (via <code>feature_enabled?</code>)

data/VERSION

@@ -1 +1 @@
-0.9.0
+1.0.0

data/abstract_feature_branch.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "abstract_feature_branch"
-  s.version = "0.9.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Annas \"Andy\" Maleh"]
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
     ".travis.yml",
     "LICENSE.txt",
     "README.md",
+    "RELEASE_NOTES.md",
     "VERSION",
     "abstract_feature_branch.gemspec",
     "config/features/admin.local.yml",
@@ -39,6 +40,7 @@ Gem::Specification.new do |s|
     "lib/generators/templates/config/initializers/abstract_feature_branch.rb",
     "lib/generators/templates/lib/tasks/abstract_feature_branch.rake",
     "ruby187.Gemfile",
+    "ruby187.Gemfile.lock",
     "spec/abstract_feature_branch/file_beautifier_spec.rb",
     "spec/ext/feature_branch__feature_branch_spec.rb",
     "spec/ext/feature_branch__feature_enabled_spec.rb",

data/lib/abstract_feature_branch.rb

@@ -40,6 +40,20 @@ module AbstractFeatureBranch
   def self.initialize_logger
     self.logger = defined?(Rails) && Rails.logger ? Rails.logger : Logger.new(STDOUT)
   end
+  def self.cacheable
+    @cacheable ||= initialize_cacheable
+  end
+  def self.cacheable=(cacheable)
+    @cacheable = cacheable
+  end
+  def self.initialize_cacheable
+    self.cacheable = {
+      :development => false,
+      :test => true,
+      :staging => true,
+      :production => true
+    }
+  end
   def self.environment_variable_overrides
     @environment_variable_overrides ||= load_environment_variable_overrides
   end
@@ -98,7 +112,9 @@ module AbstractFeatureBranch
     @environment_features = nil
   end
   def self.cacheable?
-    application_environment != 'development'
+    value = downcase_keys(cacheable)[application_environment]
+    value = (application_environment != 'development') if value.nil?
+    value
   end
 
   private

data/lib/generators/templates/config/initializers/abstract_feature_branch.rb

@@ -7,5 +7,14 @@ AbstractFeatureBranch.application_environment = Rails.env.to_s
 # Abstract Feature Branch logger
 AbstractFeatureBranch.logger = Rails.logger
 
-# Pre-loads application features to improve performance of first web-page hit
-AbstractFeatureBranch.load_application_features
+# Cache feature files once read or re-read them at runtime on every use (helps development).
+# Defaults to true if environment not specified, except for development, which defaults to false.
+AbstractFeatureBranch.cacheable = {
+  :development => false,
+  :test => true,
+  :staging => true,
+  :production => true
+}
+
+# Pre-load application features to improve performance of first web-page hit
+AbstractFeatureBranch.load_application_features unless Rails.env.development?

data/ruby187.Gemfile.lock

@@ -0,0 +1,63 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    builder (3.2.2)
+    deep_merge (1.0.0)
+    diff-lcs (1.2.5)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.20)
+    httpauth (0.2.0)
+    jeweler (1.8.8)
+      builder
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
+      rake
+      rdoc
+    json (1.8.1)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.0)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  deep_merge (= 1.0.0)
+  jeweler (= 1.8.8)
+  rspec (= 2.14.1)

data/spec/ext/feature_branch__feature_enabled_spec.rb

@@ -109,6 +109,7 @@ production:
         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
@@ -144,6 +145,77 @@ production:
           feature_enabled?(:feature2).should == true
         end
       end
+
+      it 'does not refresh features at runtime in development when overridden' do
+        AbstractFeatureBranch.application_environment = 'development'
+        AbstractFeatureBranch.cacheable = {:development => true}
+        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
+
+      %w(test staging production).each do |environment|
+        it "does refresh features at runtime in #{environment} (without forcing load of application features again)" do
+          AbstractFeatureBranch.application_environment = environment
+          AbstractFeatureBranch.cacheable = {:test => false, :staging => false, :production => false}
+          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
+      end
     end
   end
   describe 'self#feature_enabled?' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: abstract_feature_branch
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Annas "Andy" Maleh
@@ -70,6 +70,7 @@ files:
 - .travis.yml
 - LICENSE.txt
 - README.md
+- RELEASE_NOTES.md
 - VERSION
 - abstract_feature_branch.gemspec
 - config/features/admin.local.yml
@@ -89,6 +90,7 @@ files:
 - lib/generators/templates/config/initializers/abstract_feature_branch.rb
 - lib/generators/templates/lib/tasks/abstract_feature_branch.rake
 - ruby187.Gemfile
+- ruby187.Gemfile.lock
 - spec/abstract_feature_branch/file_beautifier_spec.rb
 - spec/ext/feature_branch__feature_branch_spec.rb
 - spec/ext/feature_branch__feature_enabled_spec.rb