abstract_feature_branch 0.6.4 → 0.7.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OTZmZjg1MjYyZWNiOWEyOGU1YmFiYWI3YmEwYWYwNGVhYWNmMzAyYg==
-  data.tar.gz: !binary |-
-    YzlhNjZiOWJhNjE3NDMxMGYzOTY3MDRlZDM3OTI2NDA5YzQ0MzcyZg==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    ZTk0NjE0Njk4MDIwNTg5NTA0ZmQzM2JkOGJiNGUzN2JhYWM1ZmE0Mjg3OTFi
-    OTkyODlhZjNkNDQxZDYxMTA3NGRmZDU2NzdmYzc4NmVhMTk5ZTk4YTAxZTFk
-    YTFkZTNhZWUxZGQxMDg5NGYwNDJmYWQ3ZmE4ZjNjMjEyMjZkNjM=
-  data.tar.gz: !binary |-
-    ODViYmE4NTg4ZmRjZDY5MmM5MTAyNDIzYWY0ZmM3Njg1M2UxZTEyZTQ3ODNh
-    MzkxNzE0NjY1ZjljYmE1OGZiZmRkODhlZTRiZDgwNzhkNmIyYzFmOWFhN2Fj
-    NzE0ZDdkMGM1NzIxMTRhMmUzZjhlN2U2NzNkZTE1NzIyZjQzYTM=
+SHA1:
+  metadata.gz: 73e3ea8bac7b5d86a2361282c395524039ad9ac5
+  data.tar.gz: 2160f9152209cf5e3a51e9a5f470031fa3561469
+SHA512:
+  metadata.gz: f6de2cebd3d561fb4e42daff405bf075e9b46f01da13f65bb56bdf55e7c3adb71a4e6e3df11b1db6248aace07f78b4aa1ad88d6427ce5aaecccd2ee2f76f2e07
+  data.tar.gz: 2514d572fdff4b7ed0db2995948f67021fcc1ba86309a9e4f16d346c94a451fa382c250ebd7e2abf9ec1898223db5515ac7473c1d73c7afaaf05bb6437fb6324

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.8.7
+  - ree
+  - jruby-18mode
+  - jruby-19mode
+  - rbx-2.1.1

data/README.md

@@ -1,9 +1,10 @@
 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)
 
-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
+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.
@@ -11,13 +12,13 @@ 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.
 
-The goal is to build out future features with full integration into the codebase, thus
-ensuring no delay in integration in the future, while releasing currently done features
-at the same time. Developers then disable future features until they are ready to be
-switched on in production, but do enable them in staging and locally.
+The goal is to build out upcoming features in the same source code repository branch, regardless of whether all are
+completed by the next release date or not, thus increasing team productivity by preventing integration delays.
+Developers then disable in-progress features until they are ready to be switched on in production, yet enable them
+locally and in staging environments for in-progress testing.
 
-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.
+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/) by allowing developers to configure
@@ -26,16 +27,30 @@ context-specific feature files if needed.
 Requirements
 ------------
 - Ruby ~> 2.0.0, ~> 1.9 or ~> 1.8.7
-- Rails ~> 4.0.0, ~> 3.0 or ~> 2.0
+- (Optional) Rails ~> 4.0.0, ~> 3.0 or ~> 2.0
 
 Setup
 -----
 
+### Rails Application
+
 1. Configure Rubygem
-   - Rails (~> 4.0.0 or ~> 3.0): Add the following to Gemfile <pre>gem 'abstract_feature_branch', '0.6.4'</pre>
-   - Rails (~> 2.0): Add the following to config/environment.rb <pre>config.gem 'absract_feature_branch', :version => '0.6.4'</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>
+   - Rails (~> 4.0.0 or ~> 3.0): Add the following to Gemfile <pre>gem 'abstract_feature_branch', '0.7.0'</pre>
+   - Rails (~> 2.0): Add the following to config/environment.rb <pre>config.gem 'abstract_feature_branch', :version => '0.7.0'</pre>
+2. Generate <code>config/initializers/abstract_feature_branch.rb</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**)
+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.7.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**.
+4. (Optional) Create <code>config/features.local.yml</code> under <code>AbstractFeatureBranch.application_root</code>  (more details under **instructions**)
+5. (Optional) Create <code>config/features/[context_path].yml</code> under <code>AbstractFeatureBranch.application_root</code> (more details under **instructions**)
+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.load_application_features</code> to pre-load application features for improved first-use performance
 
 Instructions
 ------------
@@ -53,7 +68,7 @@ These files are rarely necessary as any feature (even a context feature) can be
 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
+Here are the contents of the generated sample <code>config/features.yml</code>, which you can modify with your own features, each
 enabled (true) or disabled (false) per environment (e.g. production).
 
 >     defaults: &defaults
@@ -113,6 +128,20 @@ Note that <code>feature_branch</code> executes the false branch if the feature i
 
 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).
 
+Initializer
+-----------
+
+Here is the content of the generated initializer (<code>config/initializers/abstract_feature_branch.rb</code>), which contains instructions on how to customize:
+
+>     # Application root where config/features.yml or config/features/ is found
+>     AbstractFeatureBranch.application_root = Rails.root
+>
+>     # Application environment (e.g. "development", "staging" or "production")
+>     AbstractFeatureBranch.application_environment = Rails.env.to_s
+>
+>     # Pre-loads application features to improve performance of first web-page hit
+>     AbstractFeatureBranch.load_application_features
+
 Recommendations
 ---------------
 
@@ -169,9 +198,9 @@ simply switching off the URL route to them. Example:
 >       display: inline;
 >     }
 
-- Once a feature has been released and switched on in production, and it has worked well for a while,
-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.
+- Once a feature has been released and switched on in production, and it has worked well for a while (e.g. for two consecutive releases),
+it is recommended that its feature branching code is plucked out of the codebase to simplify and improve
+future maintainability given that it is no longer needed 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>
@@ -254,6 +283,9 @@ the former if overlap in features occurs:
 Release Notes
 -------------
 
+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>)
 
@@ -295,7 +327,6 @@ Version 0.2.0:
 Upcoming
 --------
 
-- Support general Ruby (non-Rails) use
 - 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)
@@ -311,6 +342,14 @@ Contributing to abstract_feature_branch
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
+Committers
+---------------------------------------
+[Annas "Andy" Maleh (Author)](https://github.com/AndyObtiva)
+
+Contributors
+---------------------------------------
+[Christian Nennemann](https://github.com/XORwell)
+
 Copyright
 ---------------------------------------
 

data/VERSION

@@ -1 +1 @@
-0.6.4
+0.7.0

data/abstract_feature_branch.gemspec

@@ -5,17 +5,18 @@
 
 Gem::Specification.new do |s|
   s.name = "abstract_feature_branch"
-  s.version = "0.6.4"
+  s.version = "0.7.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-23"
+  s.date = "2013-11-25"
   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",
     "README.md"
   ]
   s.files = [
+    ".travis.yml",
     "LICENSE.txt",
     "README.md",
     "VERSION",
@@ -33,12 +34,15 @@ Gem::Specification.new do |s|
     "lib/generators/templates/config/features.example.yml",
     "lib/generators/templates/config/features.local.yml",
     "lib/generators/templates/config/features.yml",
-    "spec/application_no_config/no_config"
+    "lib/generators/templates/config/initializers/abstract_feature_branch.rb",
+    "spec/application_no_config/no_config",
+    "spec/application_rails_config/config/features.local.yml",
+    "spec/application_rails_config/config/features.yml"
   ]
   s.homepage = "http://github.com/AndyObtiva/abstract_feature_branch"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "2.0.7"
+  s.rubygems_version = "2.0.6"
   s.summary = "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"
 
   if s.respond_to? :specification_version then

data/lib/abstract_feature_branch.rb

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'bundler'
 require 'yaml'
-YAML::ENGINE.yamler = "syck"
+YAML::ENGINE.yamler = "syck" if RUBY_VERSION.start_with?('1.9')
 begin
   Bundler.setup(:default)
 rescue Bundler::BundlerError => e
@@ -15,12 +15,21 @@ module AbstractFeatureBranch
   def self.application_root
     @application_root ||= initialize_application_root
   end
-  def self.initialize_application_root
-    @application_root = Rails.root
-  end
   def self.application_root=(path)
     @application_root = path
   end
+  def self.initialize_application_root
+    self.application_root = Object.const_defined?(:Rails) ? Rails.root : '.'
+  end
+  def self.application_environment
+    @application_environment ||= initialize_application_environment
+  end
+  def self.application_environment=(environment)
+    @application_environment = environment
+  end
+  def self.initialize_application_environment
+    self.application_environment = Object.const_defined?(:Rails) ? Rails.env.to_s : ENV['APP_ENV'] || 'development'
+  end
   def self.environment_variable_overrides
     @environment_variable_overrides ||= load_environment_variable_overrides
   end
@@ -61,6 +70,15 @@ module AbstractFeatureBranch
     local_features[environment] ||= {}
     @environment_features[environment] = features[environment].merge(local_features[environment]).merge(environment_variable_overrides)
   end
+  def self.application_features
+    environment_features(application_environment)
+  end
+  def self.load_application_features
+    AbstractFeatureBranch.load_environment_variable_overrides
+    AbstractFeatureBranch.load_features
+    AbstractFeatureBranch.load_local_features
+    AbstractFeatureBranch.load_environment_features(application_environment)
+  end
 
   private
 

data/lib/ext/feature_branch.rb

@@ -9,7 +9,7 @@ class Object
 
   raise 'Abstract feature branch conflicts with another Ruby library' if respond_to?(:feature_enabled?)
   def self.feature_enabled?(feature_name)
-    AbstractFeatureBranch.environment_features(Rails.env.to_s)[feature_name.to_s]
+    AbstractFeatureBranch.application_features[feature_name.to_s.downcase]
   end
 
   raise 'Abstract feature branch conflicts with another Ruby library' if Object.new.respond_to?(:feature_branch)

data/lib/generators/abstract_feature_branch/install_generator.rb

@@ -5,6 +5,7 @@ module AbstractFeatureBranch
 
       desc "Installs Abstract Feature Branch by generating basic configuration files, including git ignored local one."
       def copy_config
+        template "config/initializers/abstract_feature_branch.rb", "config/initializers/abstract_feature_branch.rb"
         template "config/features.example.yml", "config/features.yml"
         template "config/features.local.yml", "config/features.local.yml"
         append_to_file '.gitignore', <<-GIT_IGNORE_CONTENT

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

@@ -0,0 +1,8 @@
+# Application root where config/features.yml or config/features/ is found
+AbstractFeatureBranch.application_root = Rails.root
+
+# Application environment (e.g. "development", "staging" or "production")
+AbstractFeatureBranch.application_environment = Rails.env.to_s
+
+# Pre-loads application features to improve performance of first web-page hit
+AbstractFeatureBranch.load_application_features

data/spec/application_rails_config/config/features.local.yml

@@ -0,0 +1,15 @@
+defaults: &defaults
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+staging:
+  <<: *defaults
+  feature3: false
+
+production:
+  <<: *defaults
+

data/spec/application_rails_config/config/features.yml

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abstract_feature_branch
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.7.0
 platform: ruby
 authors:
 - Annas "Andy" Maleh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-23 00:00:00.000000000 Z
+date: 2013-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -66,28 +66,17 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.8.8
-description: ! 'It gives ability to wrap blocks of code with an abstract feature branch
-  name, and then
-
+description: |
+  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.
 
-
-  The goal is to build out future features with full integration into the codebase,
-  thus
-
+  The goal is to build out future features with full integration into the codebase, thus
   ensuring no delay in integration in the future, while releasing currently done features
-
-  at the same time. Developers then disable future features until they are ready to
-  be
-
+  at the same time. Developers then disable future features until they are ready to be
   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.
-
-'
 email: 
 executables: []
 extensions: []
@@ -95,6 +84,7 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- .travis.yml
 - LICENSE.txt
 - README.md
 - VERSION
@@ -112,7 +102,10 @@ files:
 - lib/generators/templates/config/features.example.yml
 - lib/generators/templates/config/features.local.yml
 - lib/generators/templates/config/features.yml
+- lib/generators/templates/config/initializers/abstract_feature_branch.rb
 - spec/application_no_config/no_config
+- spec/application_rails_config/config/features.local.yml
+- spec/application_rails_config/config/features.yml
 homepage: http://github.com/AndyObtiva/abstract_feature_branch
 licenses:
 - MIT
@@ -123,19 +116,19 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
-summary: ! 'abstract_feature_branch is a Rails gem that enables developers to easily
+summary: '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'
 test_files: []