abstract_feature_branch 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a8c7180bcc59c08383c35f7aaaa993c8d64684d8d5f52174f5cd27c6fbca1da
-  data.tar.gz: f22086f5d839b540864caa62ab5fc3f31baf8f99d194c5516135ec0ddc85f032
+  metadata.gz: 0241ac7ec58e588b7ad5705d3e2261d38d34b1cb8b7e354f1e356d36fbea4772
+  data.tar.gz: 25bb7d870cf117cae57df4d9510ba92dd01d6892f9088b33e5d6eb48d52a4eae
 SHA512:
-  metadata.gz: 44908f37b872e59a8160d87b7a598949635489553b82a8cb56fcaa28ca5eac43679f9334ef273908aacaa90d6e2b7fe255913d1805eaff05cca2a9792c3d5f6e
-  data.tar.gz: 8723b3f9ed9ce9131cbdc4c259e3700ad708925f50226c736115ee2f65da5a897f0f08537e1bac7b24d39741a0ef710ae732f8196e6ee7388b22058075318479
+  metadata.gz: 25e037089e15a21f1620f112c2ce9a5479c10633e2bccdd5760d680c3f490c6a5bdd8a9a981ae8e3f2119623ddc232d8ca67d8efac5260d7e0197bf50458c72d
+  data.tar.gz: 287cda44bd97f86a0dd031747af5be1af7b5c748cc9794aa3d776607dd3db28d25703c67fb6afba10f7b0b725dcbd7694e9f6d3a5995b433628a9b52d204c6a0

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## 1.4.0
+
+- Avoid live loading of per-user features when `AbstractFeatureBranch.feature_store_live_fetching` is `false` to ensure better performance through caching.
+
 ## 1.3.3
 
 - Redis network failure error handling for per-user feature enablement to default to `nil` value instead of crashing

data/README.md

@@ -1,17 +1,15 @@
-# Abstract Feature Branch 1.3.3
+# Abstract Feature Branch 1.4.0
 [![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)
 [![Code Climate](https://codeclimate.com/github/AndyObtiva/abstract_feature_branch.png)](https://codeclimate.com/github/AndyObtiva/abstract_feature_branch)
 
-[`abstract_feature_branch`](https://rubygems.org/gems/abstract_feature_branch) is a Ruby gem that provides a variation on the [Branch by Abstraction Pattern](http://paulhammant.com/blog/branch_by_abstraction.html) by [Paul Hammant](https://paulhammant.com/) and the [Feature Toggles Pattern](https://martinfowler.com/bliki/FeatureToggle.html) by [Martin Fowler](https://martinfowler.com/).
-
-It is a productivity and fault tolerance enhancing team practice.
+[`abstract_feature_branch`](https://rubygems.org/gems/abstract_feature_branch) is a Ruby gem that provides a unique variation on the [Branch by Abstraction Pattern](http://paulhammant.com/blog/branch_by_abstraction.html) by [Paul Hammant](https://paulhammant.com/) and the [Feature Toggles Pattern](https://martinfowler.com/bliki/FeatureToggle.html) by [Martin Fowler](https://martinfowler.com/) to enhance team productivity and improve software fault tolerance.
 
 It provides the ability to wrap blocks of code with an abstract feature branch name, and then
 [specify in a configuration file](#instructions) which features to be switched on or off.
 
-The goal is to build out upcoming features in the same source code repository branch (i.e. continuous integration), regardless of whether all are
+The goal is to build out upcoming features in the same source code repository branch (i.e. [Continuous Integration](https://en.wikipedia.org/wiki/Continuous_integration) and [Trunk-Based Development](https://trunkbaseddevelopment.com)), 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.
@@ -23,7 +21,7 @@ for a high risk feature.
 [Bounded Contexts](https://www.domainlanguage.com/wp-content/uploads/2016/05/DDD_Reference_2015-03.pdf) by allowing developers to configure
 context-specific feature files if needed.
 
-[`abstract_feature_branch`](https://rubygems.org/gems/abstract_feature_branch) is one of the simplest and most minimalistic "Feature Flags" Ruby gems out there as it enables you to get started very quickly by simply leveraging YAML files without having to set up a data store if you do not need it (albeit, you also have the option to use Redis as a very fast in-memory data store).
+[`abstract_feature_branch`](https://rubygems.org/gems/abstract_feature_branch) is one of the simplest and most minimalistic "Feature Flags" Ruby gems out there as it enables you to get started very quickly by simply leveraging YAML files without having to set up a data store if you do not need it (albeit, you also have the option to use [Redis](https://redis.com) as a very fast in-memory data store).
 
 
 
@@ -40,8 +38,8 @@ Setup
 ### Rails Application Use
 
 1. Configure Rubygem
-   - With `rails` between `~> 7.0` and `~> 2.0`: Add the following to Gemfile <pre>gem 'abstract_feature_branch', '~> 1.3.3'</pre>
-   - With `rails` `~> 2.0` only: Add the following to config/environment.rb <pre>config.gem 'abstract_feature_branch', :version => '1.3.3'</pre>
+   - With `rails` between `~> 7.0` and `~> 2.0`: Add the following to Gemfile <pre>gem 'abstract_feature_branch', '~> 1.4.0'</pre>
+   - With `rails` `~> 2.0` only: Add the following to config/environment.rb <pre>config.gem 'abstract_feature_branch', :version => '1.4.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] Customize configuration in <code>config/initializers/abstract_feature_branch.rb</code> (can be useful for changing location of feature files in Rails application, configuring Redis with a Redis or ConnectionPool instance to use for overrides, and [per-user feature enablement](#per-user-feature-enablement), or troubleshooting a specific Rails environment feature configuration)
@@ -50,7 +48,7 @@ Setup
 
 ### Ruby Application General Use
 
-1. <pre>gem install abstract_feature_branch -v 1.3.3</pre>
+1. <pre>gem install abstract_feature_branch -v 1.4.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))
@@ -61,7 +59,7 @@ Setup
 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
 11. [Optional] Add code <code>AbstractFeatureBranch.feature_store = Redis.new(options)</code> to configure Redis for overrides and/or [per-user feature enablement](#per-user-feature-enablement)
-12. [Optional] Set <code>AbstractFeatureBranch.feature_store_live_fetching = true</code> to enable live fetching of features from store (e.g. Redis) to avoid need for app/server restart upon feature changes, with the trade-off of slightly more latency due to making calls to feature store over the network
+12. [Optional] Set <code>AbstractFeatureBranch.feature_store_live_fetching = true</code> to enable live fetching of features from store (e.g. Redis) to avoid need for app/server restart upon feature changes, with the trade-off of slightly more latency due to making calls to feature store over the network (this affects per-user feature enablement too, pre-caching all user IDs for features on app/server restart when disabled)
 
 Instructions
 ------------

data/VERSION

@@ -1 +1 @@
-1.3.3
+1.4.0

data/abstract_feature_branch.gemspec

@@ -2,17 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: abstract_feature_branch 1.3.3 ruby lib
+# stub: abstract_feature_branch 1.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "abstract_feature_branch".freeze
-  s.version = "1.3.3"
+  s.version = "1.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Andy Maleh".freeze]
-  s.date = "2023-01-15"
-  s.description = "abstract_feature_branch is a Ruby gem that provides a variation on the Branch by Abstraction Pattern by Paul Hammant and the Feature Toggles Pattern by Martin Fowler.\n\nIt is a productivity and fault tolerance enhancing team practice.\n\nIt provides the ability to wrap blocks of code with an abstract feature branch name, and then specify 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 (i.e. continuous integration), 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.\n\nThis gives developers the added benefit of being able to switch a feature off after release should big problems arise for a high risk feature.\n\nabstract_feature_branch additionally supports Domain Driven Design's pattern of Bounded Contexts by allowing developers to configure context-specific feature files if needed.\n\nabstract_feature_branch is one of the simplest and most minimalistic \"Feature Flags\" Ruby gems out there as it enables you to get started very quickly by simply leveraging YAML files without having to set up a data store if you do not need it (albeit, you also have the option to use Redis as a very fast in-memory data store).\n".freeze
+  s.date = "2023-02-05"
+  s.description = "abstract_feature_branch is a Ruby gem that provides a unique variation on the Branch by Abstraction Pattern by Paul Hammant and the Feature Toggles Pattern by Martin Fowler to enhance team productivity and improve software fault tolerance.\n\nIt provides the ability to wrap blocks of code with an abstract feature branch name, and then specify 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 (i.e. Continuous Integration and Trunk-Based Development), 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.\n\nThis gives developers the added benefit of being able to switch a feature off after release should big problems arise for a high risk feature.\n\nabstract_feature_branch additionally supports Domain Driven Design's pattern of Bounded Contexts by allowing developers to configure context-specific feature files if needed.\n\nabstract_feature_branch is one of the simplest and most minimalistic \"Feature Flags\" Ruby gems out there as it enables you to get started very quickly by simply leveraging YAML files without having to set up a data store if you do not need it (albeit, you also have the option to use Redis as a very fast in-memory data store).\n".freeze
   s.extra_rdoc_files = [
     "CHANGELOG.md",
     "LICENSE.txt",
@@ -40,27 +40,29 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/AndyObtiva/abstract_feature_branch".freeze
   s.licenses = ["MIT".freeze]
   s.post_install_message = "\nRails-only post-install instructions:\n\n1) Run the following command to generate the Rails initializer and basic feature files:\n\nrails g abstract_feature_branch:install\n\n2) Optionally, you may run this command to generate feature files per context:\n\nrails g abstract_feature_branch:context context_path\n   \n3) Optionally, install Redis server with [Homebrew](https://brew.sh/) by running:\n\nbrew install redis\n\n4) Optionally, install redis client gem (required with Redis server) by adding the following line to Gemfile above abstract_feature_branch:\n\ngem 'redis', '~> 5.0.5'\n\nAfterwards, run:\n\nbundle\n\n5) Optionally, customize configuration in config/initializers/abstract_feature_branch.rb\n\n(can be useful for changing location of feature files in Rails application,\nconfiguring Redis with a Redis or ConnectionPool instance to use for overrides and per-user feature enablement,\nand/or troubleshooting specific Rails environment feature configurations)\n\n".freeze
-  s.rubygems_version = "3.1.4".freeze
-  s.summary = "abstract_feature_branch is a Ruby gem that provides a variation on the Branch by Abstraction Pattern by Paul Hammant and the Feature Toggles Pattern by Martin Fowler (aka Feature Flags).".freeze
+  s.rubygems_version = "3.3.6".freeze
+  s.summary = "abstract_feature_branch is a Ruby gem that provides a variation on the Branch by Abstraction Pattern by Paul Hammant and the Feature Toggles Pattern by Martin Fowler (aka Feature Flags) to enable Continuous Integration and Trunk-Based Development.".freeze
 
   if s.respond_to? :specification_version then
     s.specification_version = 4
   end
 
   if s.respond_to? :add_runtime_dependency then
-    s.add_runtime_dependency(%q<deep_merge>.freeze, ["~> 1.0.0"])
+    s.add_runtime_dependency(%q<deep_merge>.freeze, [">= 1.0.0", "< 2.0.0"])
     s.add_development_dependency(%q<jeweler>.freeze, ["~> 2.3.9"])
     s.add_development_dependency(%q<bundler>.freeze, [">= 2.1.4"])
     s.add_development_dependency(%q<rspec>.freeze, ["= 2.14.1"])
     s.add_development_dependency(%q<rdoc>.freeze, ["= 5.1.0"])
     s.add_development_dependency(%q<psych>.freeze, ["= 3.3.4"])
+    s.add_development_dependency(%q<rake-tui>.freeze, ["~> 0.2"])
   else
-    s.add_dependency(%q<deep_merge>.freeze, ["~> 1.0.0"])
+    s.add_dependency(%q<deep_merge>.freeze, [">= 1.0.0", "< 2.0.0"])
     s.add_dependency(%q<jeweler>.freeze, ["~> 2.3.9"])
     s.add_dependency(%q<bundler>.freeze, [">= 2.1.4"])
     s.add_dependency(%q<rspec>.freeze, ["= 2.14.1"])
     s.add_dependency(%q<rdoc>.freeze, ["= 5.1.0"])
     s.add_dependency(%q<psych>.freeze, ["= 3.3.4"])
+    s.add_dependency(%q<rake-tui>.freeze, ["~> 0.2"])
   end
 end
 

data/lib/abstract_feature_branch.rb

@@ -23,7 +23,8 @@ module AbstractFeatureBranch
 
   class << self
     extend Forwardable
-    def_delegators :configuration, :application_root, :application_root=, :initialize_application_root, :application_environment, :application_environment=, :initialize_application_environment,
+    def_delegators :configuration, # delegating the following methods to configuration
+                   :application_root, :application_root=, :initialize_application_root, :application_environment, :application_environment=, :initialize_application_environment,
                    :logger, :logger=, :initialize_logger, :cacheable, :cacheable=, :initialize_cacheable, :feature_store, :feature_store=, :user_features_storage, :user_features_storage=,
                    :feature_store_live_fetching, :feature_store_live_fetching=
 
@@ -84,6 +85,35 @@ module AbstractFeatureBranch
         merge(environment_variable_overrides).
         merge(redis_overrides)
     end
+    
+    def redis_per_user_features
+      @redis_per_user_features ||= load_redis_per_user_features
+    end
+    def load_redis_per_user_features
+      @redis_per_user_features = {}
+      return @redis_per_user_features if AbstractFeatureBranch.configuration.feature_store_live_fetching?
+      
+      @environment_features.each do |environment, features|
+        features.each do |feature, value|
+          if value == 'per_user'
+            normalized_feature_name = feature.to_s.downcase
+            @redis_per_user_features[normalized_feature_name] ||= []
+            begin
+              per_user_feature_user_ids = AbstractFeatureBranch.
+                                            user_features_storage.
+                                            smembers("#{AbstractFeatureBranch::ENV_FEATURE_PREFIX}#{normalized_feature_name}")
+              @redis_per_user_features[normalized_feature_name] += per_user_feature_user_ids
+            rescue Exception => error
+              AbstractFeatureBranch.logger.error "AbstractFeatureBranch encountered an error in retrieving Per-User values for feature \"#{normalized_feature_name}\"! Defaulting to no values...\n\nError: #{error.full_message}\n\n"
+              nil
+            end
+          end
+        end
+      end
+      
+      @redis_per_user_features
+    end
+    
     def application_features
       unload_application_features unless cacheable?
       environment_features(application_environment)
@@ -94,6 +124,7 @@ module AbstractFeatureBranch
       AbstractFeatureBranch.load_features
       AbstractFeatureBranch.load_local_features
       AbstractFeatureBranch.load_environment_features(application_environment)
+      AbstractFeatureBranch.load_redis_per_user_features
     end
     def unload_application_features
       @redis_overrides = nil
@@ -101,7 +132,9 @@ module AbstractFeatureBranch
       @features = nil
       @local_features = nil
       @environment_features = nil
+      @redis_per_user_features = nil
     end
+    
     def cacheable?
       value = downcase_keys(cacheable)[application_environment]
       value = (application_environment != 'development') if value.nil?

data/lib/ext/feature_branch.rb

@@ -35,11 +35,15 @@ class Object
     
     raise 'Abstract feature branch conflicts with another Ruby library having Object::feature_enabled_per_user_value' if Object.new.respond_to?(:feature_enabled_per_user_value, true)
     def feature_enabled_per_user_value(normalized_feature_name, user_id)
-      begin
-        AbstractFeatureBranch.user_features_storage.sismember("#{AbstractFeatureBranch::ENV_FEATURE_PREFIX}#{normalized_feature_name}", user_id)
-      rescue Exception => error
-        AbstractFeatureBranch.logger.error "AbstractFeatureBranch encountered an error in retrieving Per-User value for feature \"#{normalized_feature_name}\" and user_id #{user_id}! Defaulting to nil value...\n\nError: #{error.full_message}\n\n"
-        nil
+      if AbstractFeatureBranch.configuration.feature_store_live_fetching?
+        begin
+          AbstractFeatureBranch.user_features_storage.sismember("#{AbstractFeatureBranch::ENV_FEATURE_PREFIX}#{normalized_feature_name}", user_id)
+        rescue Exception => error
+          AbstractFeatureBranch.logger.error "AbstractFeatureBranch encountered an error in retrieving Per-User value for feature \"#{normalized_feature_name}\" and user_id #{user_id}! Defaulting to nil value...\n\nError: #{error.full_message}\n\n"
+          nil
+        end
+      else
+        AbstractFeatureBranch.redis_per_user_features[normalized_feature_name]&.include?(user_id.to_s)
       end
     end
   end

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

@@ -7,8 +7,10 @@
 # The following example line works with Heroku Redis To Go while still operating on local Redis for local development
 # AbstractFeatureBranch.feature_store = Redis.new(:url => ENV['REDISTOGO_URL'])
 
-# Enable live fetching of feature configuration from storage system, to update features without app/server restart.
+# Enable live fetching of feature configuration from storage system (Redis), to update features without app/server restart.
 # false by default to only load features on app/server start for faster performance (requires restart on change)
+# This also affects per-user feature loading from storage system (Redis), pre-caching user IDs for features on app/server
+# restart when false, for better performance.
 AbstractFeatureBranch.feature_store_live_fetching = false
 
 # Application root where config/features.yml or config/features/ is found

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: abstract_feature_branch
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-15 00:00:00.000000000 Z
+date: 2023-02-05 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
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
@@ -94,14 +100,26 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.3.4
+- !ruby/object:Gem::Dependency
+  name: rake-tui
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 description: |
-  abstract_feature_branch is a Ruby gem that provides a variation on the Branch by Abstraction Pattern by Paul Hammant and the Feature Toggles Pattern by Martin Fowler.
-
-  It is a productivity and fault tolerance enhancing team practice.
+  abstract_feature_branch is a Ruby gem that provides a unique variation on the Branch by Abstraction Pattern by Paul Hammant and the Feature Toggles Pattern by Martin Fowler to enhance team productivity and improve software fault tolerance.
 
   It provides the ability to wrap blocks of code with an abstract feature branch name, and then specify in a configuration file which features to be switched on or off.
 
-  The goal is to build out upcoming features in the same source code repository branch (i.e. continuous integration), 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.
+  The goal is to build out upcoming features in the same source code repository branch (i.e. Continuous Integration and Trunk-Based Development), 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.
 
@@ -162,10 +180,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.6
 signing_key:
 specification_version: 4
 summary: abstract_feature_branch is a Ruby gem that provides a variation on the Branch
   by Abstraction Pattern by Paul Hammant and the Feature Toggles Pattern by Martin
-  Fowler (aka Feature Flags).
+  Fowler (aka Feature Flags) to enable Continuous Integration and Trunk-Based Development.
 test_files: []