abstract_feature_branch 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60dae0db7cb3e49d719eb59a65c186f9884a69e9
-  data.tar.gz: 017e10b3fa79ec92f3b8644896f6a1726b9e2284
+  metadata.gz: 56c9f13ee57d4f800bba4ab8028e76ff0b5fecdb
+  data.tar.gz: 091ac1a493c92555c32402ff470ed523198777e2
 SHA512:
-  metadata.gz: 885a2e9d627e97709b811f2d01f4ec46f31728cda35bff3b2e65be40e2eb3306a1e83a067c0282017059021b0e569d3df43d7e08eb45b4feef7b71bd72bf1b68
-  data.tar.gz: e23f2de2aa5481f26b2dfca13e7140eefb2e183337899b3aa3e2e6d5e192cd3e0e1d849aafbdea95832e6d4ea83a006a5ddaa03b7c884f0dcb120670a68c1359
+  metadata.gz: d6a9fb212dd6c931e5cb5b74ac7376a98671cebe88091807cd09c3465dd83acb2d6344200a09b9ab707de113fdc979e7ffb5ac3ae87923e230994c6559baa539
+  data.tar.gz: ff9599ee6671b064457f4a1dc5f7e4df27bd6adab3fbd3b5d7db308c01779911829c039f4905a44f1d945c62319e1cb9449d8076c024431dcd372b729be28025

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
+services:
+  - redis-server
 rvm:
   - 2.0.0
   - 1.9.3
@@ -22,11 +24,17 @@ matrix:
       gemfile: ruby187.Gemfile
     - rvm: ree
       gemfile: Gemfile
+    - rvm: ree
+      gemfile: ruby187.Gemfile
     - rvm: jruby-18mode
       gemfile: Gemfile
     - rvm: jruby-18mode
       gemfile: ruby187.Gemfile
     - rvm: jruby-19mode
       gemfile: ruby187.Gemfile
+    - rvm: jruby-19mode
+      gemfile: Gemfile
     - rvm: rbx-2.1.1
       gemfile: Gemfile
+    - rvm: rbx-2.1.1
+      gemfile: ruby187.Gemfile

data/README.md

@@ -79,6 +79,7 @@ enabled (true) or disabled (false) per environment (e.g. production).
 >       feature1: true
 >       feature2: true
 >       feature3: false
+>       feature4: per_user
 >
 >     development:
 >       <<: *defaults
@@ -122,8 +123,7 @@ Note that <code>feature_enabled?</code> returns false if the feature is disabled
 
 ### Per-User Feature Enablement
 
-It is possible to restrict enablement of features per specific users. This works in concert with having a feature enabled
-in features.yml (or one of the overrides like features.local.yml or environment variable overrides)
+It is possible to restrict enablement of features per specific users by setting a feature value to <code>per_user</code>.
 
 1. Use <code>toggle_features_for_user</code> in Ruby code to enable features per user ID (e.g. email address or database ID). This loads Redis client gem into memory and stores per-user feature configuration in Redis.
 In the example below, current_user is a method that provides the current signed in user (e.g. using Rails [Devise] (https://github.com/plataformatec/devise) library).
@@ -155,6 +155,13 @@ Examples:
 >       # THIS ONE WILL NOT EXECUTE
 >     end
 
+Note:
+
+If a feature is enabled as <code>true</code> or disabled as <code>false</code> in features.yml (or one of the overrides
+like features.local.yml or environment variable overrides), then it overrides toggled per-user restrictions, becoming
+enabled or disabled globally.
+
+
 Recommendations
 ---------------
 

data/VERSION

@@ -1 +1 @@
-1.1.1
+1.2.0

data/abstract_feature_branch.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "abstract_feature_branch"
-  s.version = "1.1.1"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Annas \"Andy\" Maleh"]
-  s.date = "2014-01-14"
+  s.date = "2014-01-19"
   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",

data/lib/abstract_feature_branch.rb

@@ -150,7 +150,13 @@ module AbstractFeatureBranch
     end
 
     def booleanize_values(hash)
-      Hash[hash.map {|k, v| [k, v.to_s.downcase == 'true']}]
+      hash_values = hash.map do |k, v|
+        normalized_value = v.to_s.downcase
+        boolean_value = normalized_value == 'true'
+        new_value = normalized_value == 'per_user' ? 'per_user' : boolean_value
+        [k, new_value]
+      end
+      Hash[hash_values]
     end
 
     def downcase_keys(hash)

data/lib/ext/feature_branch.rb

@@ -9,8 +9,12 @@ class Object
   raise 'Abstract feature branch conflicts with another Ruby library' if respond_to?(:feature_enabled?)
   def self.feature_enabled?(feature_name, user_id = nil)
     normalized_feature_name = feature_name.to_s.downcase
-    AbstractFeatureBranch.application_features[normalized_feature_name] &&
-      (user_id.nil? || AbstractFeatureBranch.user_features_storage.sismember("#{AbstractFeatureBranch::ENV_FEATURE_PREFIX}#{normalized_feature_name}", user_id))
+
+    value = AbstractFeatureBranch.application_features[normalized_feature_name]
+    if value == 'per_user'
+      value = AbstractFeatureBranch.user_features_storage.sismember("#{AbstractFeatureBranch::ENV_FEATURE_PREFIX}#{normalized_feature_name}", user_id)
+    end
+    value
   end
 
   raise 'Abstract feature branch conflicts with another Ruby library' if Object.new.respond_to?(:feature_branch)

data/ruby187.Gemfile.lock

@@ -5,7 +5,7 @@ GEM
     builder (3.2.2)
     deep_merge (1.0.0)
     diff-lcs (1.2.5)
-    faraday (0.8.8)
+    faraday (0.8.9)
       multipart-post (~> 1.2.0)
     git (1.2.6)
     github_api (0.10.1)
@@ -28,9 +28,9 @@ GEM
       rake
       rdoc
     json (1.8.1)
-    jwt (0.1.8)
+    jwt (0.1.10)
       multi_json (>= 1.5)
-    multi_json (1.8.2)
+    multi_json (1.8.4)
     multi_xml (0.5.5)
     multipart-post (1.2.0)
     nokogiri (1.5.10)
@@ -42,8 +42,8 @@ GEM
       multi_xml (~> 0.5)
       rack (~> 1.2)
     rack (1.5.2)
-    rake (10.1.0)
-    rdoc (4.0.1)
+    rake (10.1.1)
+    rdoc (4.1.1)
       json (~> 1.4)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)

data/spec/ext/feature_branch__feature_branch_per_user_spec.rb

@@ -32,56 +32,52 @@ describe 'feature_branch object extensions' do
         user_id = 'email1@example.com'
         Process.fork do
           AbstractFeatureBranch.initialize_user_features_storage
-          AbstractFeatureBranch.toggle_features_for_user(user_id, :feature1 => true, :feature2 => false, :feature3 => true, :feature5 => true)
+          AbstractFeatureBranch.toggle_features_for_user(user_id, :feature1 => false, :feature3 => true, :feature6 => true, :feature7 => false)
         end
         Process.wait
         features_enabled = []
         feature_branch :feature1, user_id do
           features_enabled << :feature1
         end
-        feature_branch :feature2, user_id do
-          features_enabled << :feature2
-        end
         feature_branch :feature3, user_id do
           features_enabled << :feature3
         end
-        feature_branch :feature5, user_id do
-          features_enabled << :feature5
+        feature_branch :feature6, user_id do
+          features_enabled << :feature6
+        end
+        feature_branch :feature6, 'otheruser@example.com' do
+          features_enabled << :feature6_otheruser
+        end
+        feature_branch :feature6 do
+          features_enabled << :feature6_nouserspecified
         end
-        feature_branch :feature5, 'otheruser@example.com' do
-          features_enabled << :feature5_otheruser
+        feature_branch :feature7, user_id do
+          features_enabled << :feature7
         end
-        features_enabled.should include(:feature1)
-        features_enabled.should_not include(:feature2)
-        features_enabled.should_not include(:feature3)
-        features_enabled.should include(:feature5)
-        features_enabled.should_not include(:feature5_otheruser)
+        features_enabled.should include(:feature1) #remains like features.yml
+        features_enabled.should_not include(:feature3) #remains like features.yml
+        features_enabled.should include(:feature6) #per user honored as true
+        features_enabled.should_not include(:feature6_otheruser) #per user honored as false
+        features_enabled.should_not include(:feature6_nouserspecified) #per user requires user id or it returns false
+        features_enabled.should_not include(:feature7) #per user honored as false
       end
       it 'update feature branching (disabling some features) after having stored feature configuration per user in a separate process (ensuring persistence)' do
         user_id = 'email1@example.com'
         Process.fork do
           AbstractFeatureBranch.initialize_user_features_storage
-          AbstractFeatureBranch.toggle_features_for_user(user_id, :feature1 => true, :feature2 => false, :feature3 => true, :feature5 => true)
-          AbstractFeatureBranch.toggle_features_for_user(user_id, :feature1 => false, :feature2 => true, :feature3 => false, :feature5 => false)
+          AbstractFeatureBranch.toggle_features_for_user(user_id, :feature6 => true, :feature7 => false)
+          AbstractFeatureBranch.toggle_features_for_user(user_id, :feature6 => false, :feature7 => true)
         end
         Process.wait
         features_enabled = []
-        feature_branch :feature1, user_id do
-          features_enabled << :feature1
-        end
-        feature_branch :feature2, user_id do
-          features_enabled << :feature2
-        end
-        feature_branch :feature3, user_id do
-          features_enabled << :feature3
+        feature_branch :feature6, user_id do
+          features_enabled << :feature6
         end
-        feature_branch :feature5, user_id do
-          features_enabled << :feature5
+        feature_branch :feature7, user_id do
+          features_enabled << :feature7
         end
-        features_enabled.should_not include(:feature1)
-        features_enabled.should include(:feature2)
-        features_enabled.should_not include(:feature3)
-        features_enabled.should_not include(:feature5)
+        features_enabled.should_not include(:feature6)
+        features_enabled.should include(:feature7)
       end
 
     end

data/spec/ext/feature_branch__feature_enabled_spec.rb

@@ -65,7 +65,30 @@ describe 'feature_branch object extensions' do
       feature_enabled?(:feature4a).should be_nil
       feature_enabled?(:feature5).should be_nil
     end
-
+    context 'per user' do
+      let(:user_id) { 'email1@example.com' }
+      let(:another_user_id) { 'another_email@example.com' }
+      before do
+        AbstractFeatureBranch.user_features_storage.del("#{AbstractFeatureBranch::ENV_FEATURE_PREFIX}feature6")
+      end
+      after do
+        AbstractFeatureBranch.user_features_storage.del("#{AbstractFeatureBranch::ENV_FEATURE_PREFIX}feature6")
+      end
+      it 'behaves as expected if member list is empty, regardless of the user provided' do
+        feature_enabled?('feature6').should == false
+        feature_enabled?('feature6', nil).should == false
+        feature_enabled?('feature6', user_id).should == false
+      end
+      it 'behaves as expected if member list is not empty, and user provided is in member list' do
+        AbstractFeatureBranch.toggle_features_for_user(user_id, :feature6 => true)
+        feature_enabled?('feature6').should == false
+        feature_enabled?('feature6', user_id).should == true
+      end
+      it 'behaves as expected if member list is not empty, and user provided is not in member list' do
+        AbstractFeatureBranch.toggle_features_for_user(another_user_id, :feature6 => true)
+        feature_enabled?('feature6', user_id).should == false
+      end
+    end
     context 'cacheability' do
       before do
         @development_application_root = File.expand_path(File.join(__FILE__, '..', '..', 'fixtures', 'application_development_config'))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abstract_feature_branch
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Annas "Andy" Maleh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-14 00:00:00.000000000 Z
+date: 2014-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge