abstract_feature_branch 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b05f473f9e1490d0e627cd6ee46bc065fd99054eeec4fe4276b6009650a3ad4
-  data.tar.gz: 657dbe0b15b9ac0827ef3dcbaa748bc571cb7d1ef95b25e44d3ee8c1029bf4ae
+  metadata.gz: 6bb188fdad68361367ec4bb43a495957ccd7eaa3c89355b5a0d2812055dbef07
+  data.tar.gz: 26b576a9a85f5eadac24f46d39086d5d871036b1c8e6b3cfef5ca7b26202373a
 SHA512:
-  metadata.gz: cbf7abdfa86da1c21bb55e913809879adc0fb7d049ae047a272dbbdec648f064112036bc1671ed2f66dc0cdec7539d0e6fee0f7d9bc099dcc710229cc8a2d1e4
-  data.tar.gz: 8effdc0bba15209eb0d4366dd719b98bd11c3d5e6f772788156d40a625f2539b17a726ea79ceeedc29576dc58b49a14f1b0a26cabe46a8037473e0fe5c3cc4be
+  metadata.gz: 265ad74dc47a31670c8088b119c3b1966d895e91eb451d3ff5074a594f29e4f682b26ddd87606c8b17d1c783f082fcc78170a290af6935482f2286ce3b487918
+  data.tar.gz: 3b782bfaf2efe15b87707060c22da8995761c8e8267b40a2e02cb43a492ead632a403423d02a7ae7a93ce4999be6af7169e0cb5d7c39ad1f1e537f9d27309584

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 1.6.0
+
+- Support Ruby 3.3 - Ruby 1.9.1
+- Thread-Safe Support for Multi-Threaded Usage of `feature_enabled?` and `feature_branch` (fixes issue with multi-threaded usage of `feature_enabled?` causing a `merge` method invocation error due to a `features[environment]` `nil` value that should have been a `Hash` value instead)
+
 ## 1.5.1
 
 - `AbstractFeatureBranch.toggled_features_for_scope(scope)` API method that returns toggled features for a scope (String)

data/README.md

@@ -1,4 +1,4 @@
-# Abstract Feature Branch 1.5.1
+# Abstract Feature Branch 1.6.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)
@@ -25,7 +25,7 @@ context-specific feature files if needed.
 
 Requirements
 ------------
-- Ruby (between `~> 3.1.0` and `~> 1.8.7`)
+- Ruby (between `~> 3.3.0` and `~> 1.9.1`)
 - [Optional] Rails (between `~> 7.0` and `~> 2.0`)
 - [Optional] Redis Server (between `~> 7.0` and `~> 2.0`)
 - [Optional] Redis client gem (between `~> 5.0` and `~> 3.0`)
@@ -36,8 +36,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.5.1'</pre>
-   - With `rails` `~> 2.0` only: Add the following to config/environment.rb <pre>config.gem 'abstract_feature_branch', :version => '1.5.1'</pre>
+   - With `rails` between `~> 7.0` and `~> 2.0`: Add the following to Gemfile <pre>gem 'abstract_feature_branch', '~> 1.6.0'</pre>
+   - With `rails` `~> 2.0` only: Add the following to config/environment.rb <pre>config.gem 'abstract_feature_branch', :version => '1.6.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 [scoped feature enablement](#scoped-feature-enablement) (e.g. per-user), or troubleshooting a specific Rails environment feature configuration)
@@ -46,7 +46,7 @@ Setup
 
 ### Ruby Application General Use
 
-1. <pre>gem install abstract_feature_branch -v 1.5.1</pre>
+1. <pre>gem install abstract_feature_branch -v 1.6.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))
@@ -112,7 +112,9 @@ multi-line logic:
 single-line logic:
 >     feature_branch(:feature1) { # perform logic }
 
-Note that <code>feature_branch</code> returns nil and does not execute the block if the feature is disabled or non-existent.
+Note that <code>feature_branch</code> returns `nil` and does not execute the block if the feature is disabled or non-existent.
+
+`feature_branch` supports multi-threaded code (i.e. usage from multiple parallel threads, as possible in JRuby).
 
 - Imperatively check if a feature is enabled or not:
 
@@ -122,7 +124,9 @@ Note that <code>feature_branch</code> returns nil and does not execute the block
 >       # perform alternate logic
 >     end
 
-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).
+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).
+
+`feature_enabled?` supports multi-threaded code (i.e. usage from multiple parallel threads, as possible in JRuby).
 
 - List all configured features for a particular environment:
 

data/VERSION

@@ -1 +1 @@
-1.5.1
+1.6.0

data/abstract_feature_branch.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: abstract_feature_branch 1.5.1 ruby lib
+# stub: abstract_feature_branch 1.6.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "abstract_feature_branch".freeze
-  s.version = "1.5.1"
+  s.version = "1.6.0".freeze
 
   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-02-14"
+  s.date = "2024-01-22"
   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",
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
     "lib/abstract_feature_branch.rb",
     "lib/abstract_feature_branch/configuration.rb",
     "lib/abstract_feature_branch/file_beautifier.rb",
+    "lib/abstract_feature_branch/memoizable.rb",
     "lib/abstract_feature_branch/redis/connection_pool_to_redis_adapter.rb",
     "lib/ext/feature_branch.rb",
     "lib/generators/abstract_feature_branch/context_generator.rb",
@@ -40,29 +41,17 @@ 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 scoped feature enablement (e.g. per-user),\nand/or troubleshooting specific Rails environment feature configurations)\n\n".freeze
-  s.rubygems_version = "3.3.6".freeze
+  s.rubygems_version = "3.5.3".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
+  s.specification_version = 4
 
-  if s.respond_to? :add_runtime_dependency then
-    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", "< 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
+  s.add_runtime_dependency(%q<deep_merge>.freeze, [">= 1.0.0".freeze, "< 2.0.0".freeze])
+  s.add_development_dependency(%q<jeweler>.freeze, ["~> 2.3.9".freeze])
+  s.add_development_dependency(%q<bundler>.freeze, [">= 2.1.4".freeze])
+  s.add_development_dependency(%q<rspec>.freeze, ["~> 3.12.0".freeze])
+  s.add_development_dependency(%q<rdoc>.freeze, ["= 5.1.0".freeze])
+  s.add_development_dependency(%q<psych>.freeze, ["= 3.3.4".freeze])
+  s.add_development_dependency(%q<rake-tui>.freeze, ["~> 0.2".freeze])
 end
 

data/lib/abstract_feature_branch/configuration.rb

@@ -1,9 +1,20 @@
+require 'abstract_feature_branch/memoizable'
 require 'abstract_feature_branch/redis/connection_pool_to_redis_adapter'
 
 module AbstractFeatureBranch
   class Configuration
+    include Memoizable
+    
+    MUTEX = {
+      '@application_root': Mutex.new,
+      '@application_environment': Mutex.new,
+      '@logger': Mutex.new,
+      '@cacheable': Mutex.new,
+      '@feature_store_live_fetching': Mutex.new,
+    }
+  
     def application_root
-      @application_root ||= initialize_application_root
+      memoize_thread_safe(:@application_root, :initialize_application_root)
     end
     def application_root=(path)
       @application_root = path
@@ -12,7 +23,7 @@ module AbstractFeatureBranch
       self.application_root = defined?(Rails) ? Rails.root : '.'
     end
     def application_environment
-      @application_environment ||= initialize_application_environment
+      memoize_thread_safe(:@application_environment, :initialize_application_environment)
     end
     def application_environment=(environment)
       @application_environment = environment
@@ -21,7 +32,7 @@ module AbstractFeatureBranch
       self.application_environment = defined?(Rails) ? Rails.env.to_s : ENV['APP_ENV'] || 'development'
     end
     def logger
-      @logger ||= initialize_logger
+      memoize_thread_safe(:@logger, :initialize_logger)
     end
     def logger=(logger)
       @logger = logger
@@ -30,7 +41,7 @@ module AbstractFeatureBranch
       self.logger = defined?(Rails) && Rails.logger ? Rails.logger : Logger.new(STDOUT)
     end
     def cacheable
-      @cacheable ||= initialize_cacheable
+      memoize_thread_safe(:@cacheable, :initialize_cacheable)
     end
     def cacheable=(cacheable)
       @cacheable = cacheable
@@ -64,8 +75,7 @@ module AbstractFeatureBranch
     alias user_features_storage= feature_store=
     
     def feature_store_live_fetching
-      initialize_feature_store_live_fetching if @feature_store_live_fetching.nil?
-      @feature_store_live_fetching
+      memoize_thread_safe(:@feature_store_live_fetching, :initialize_feature_store_live_fetching)
     end
     alias feature_store_live_fetching? feature_store_live_fetching
     

data/lib/abstract_feature_branch/memoizable.rb

@@ -0,0 +1,23 @@
+module AbstractFeatureBranch
+  module Memoizable
+    private
+    
+    # memoizes a variable thread-safe
+    # expects a MUTEX constant on the class including this moddule, which pre-initializes
+    # mutexes at class definition time
+    # Example:
+    # MUTEX = { '@varname' => Mutex.new }
+    def memoize_thread_safe(variable, variable_build_method_name = nil, &variable_builder)
+      variable_builder ||= method(variable_build_method_name)
+      if instance_variable_get(variable).nil?
+        mutex_hash = self.is_a?(Module) ? self::MUTEX : self.class::MUTEX
+        mutex_hash[variable].synchronize do
+          if instance_variable_get(variable).nil?
+            instance_variable_set(variable, variable_builder.call)
+          end
+        end
+      end
+      instance_variable_get(variable)
+    end
+  end
+end

data/lib/abstract_feature_branch.rb

@@ -15,13 +15,28 @@ require 'forwardable'
 
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 
+require 'abstract_feature_branch/memoizable'
 require 'abstract_feature_branch/configuration'
 
 module AbstractFeatureBranch
+  extend Memoizable
+  
   ENV_FEATURE_PREFIX = "abstract_feature_branch_"
   REDIS_HKEY = "abstract_feature_branch"
   VALUE_SCOPED = 'scoped'
   SCOPED_SPECIAL_VALUES = [VALUE_SCOPED, 'per_user', 'per-user', 'per user']
+  MUTEX = {
+    '@configuration': Mutex.new,
+    '@redis_overrides': Mutex.new,
+    '@environment_variable_overrides': Mutex.new,
+    '@local_features': Mutex.new,
+    '@features': Mutex.new,
+    '@environment_features': Mutex.new,
+    '@redis_scoped_features': Mutex.new,
+    'environment_features': Mutex.new,
+    'load_application_features': Mutex.new,
+    'unload_application_features': Mutex.new,
+  }
 
   class << self
     extend Forwardable
@@ -31,11 +46,11 @@ module AbstractFeatureBranch
                    :feature_store_live_fetching, :feature_store_live_fetching=
     
     def configuration
-      @configuration ||= Configuration.new
+      memoize_thread_safe(:@configuration) { Configuration.new }
     end
 
     def redis_overrides
-      @redis_overrides ||= load_redis_overrides
+      memoize_thread_safe(:@redis_overrides, :load_redis_overrides)
     end
     def load_redis_overrides
       return (@redis_overrides = {}) if feature_store.nil?
@@ -51,14 +66,14 @@ module AbstractFeatureBranch
     end
 
     def environment_variable_overrides
-      @environment_variable_overrides ||= load_environment_variable_overrides
+      memoize_thread_safe(:@environment_variable_overrides, :load_environment_variable_overrides)
     end
     def load_environment_variable_overrides
       @environment_variable_overrides = featureize_keys(downcase_keys(booleanize_values(select_feature_keys(ENV))))
     end
     
     def local_features
-      @local_features ||= load_local_features
+      memoize_thread_safe(:@local_features, :load_local_features)
     end
     def load_local_features
       @local_features = {}
@@ -66,7 +81,7 @@ module AbstractFeatureBranch
     end
     
     def features
-      @features ||= load_features
+      memoize_thread_safe(:@features, :load_features)
     end
     def load_features
       @features = {}
@@ -75,8 +90,15 @@ module AbstractFeatureBranch
     
     # performance optimization via caching of feature values resolved through environment variable overrides and local features
     def environment_features(environment)
-      @environment_features ||= {}
-      @environment_features[environment] ||= load_environment_features(environment)
+      if environment_features_for_all_environments[environment].nil?
+        MUTEX[:environment_features].synchronize do
+          if environment_features_for_all_environments[environment].nil?
+            environment_features_for_all_environments[environment] = load_environment_features(environment)
+          end
+          @unload_application_features = nil
+        end
+      end
+      environment_features_for_all_environments[environment]
     end
     def load_environment_features(environment)
       @environment_features ||= {}
@@ -88,8 +110,12 @@ module AbstractFeatureBranch
         merge(redis_overrides)
     end
     
+    def environment_features_for_all_environments
+      memoize_thread_safe(:@environment_features) { {} }
+    end
+    
     def redis_scoped_features
-      @redis_scoped_features ||= load_redis_scoped_features
+      memoize_thread_safe(:@redis_scoped_features, :load_redis_scoped_features)
     end
     def load_redis_scoped_features
       @redis_scoped_features = {}
@@ -114,27 +140,44 @@ module AbstractFeatureBranch
     end
     
     def application_features
-      unload_application_features unless cacheable?
+      unload_application_features if !cacheable?
       environment_features(application_environment)
     end
     def load_application_features
-      AbstractFeatureBranch.load_redis_overrides
-      AbstractFeatureBranch.load_environment_variable_overrides
-      AbstractFeatureBranch.load_features
-      AbstractFeatureBranch.load_local_features
-      AbstractFeatureBranch.load_environment_features(application_environment)
-      AbstractFeatureBranch.load_redis_scoped_features
+      if @load_application_features.nil?
+        MUTEX[:load_application_features].synchronize do
+          if @load_application_features.nil?
+            AbstractFeatureBranch.load_redis_overrides
+            AbstractFeatureBranch.load_environment_variable_overrides
+            AbstractFeatureBranch.load_features
+            AbstractFeatureBranch.load_local_features
+            AbstractFeatureBranch.load_environment_features(application_environment)
+            AbstractFeatureBranch.load_redis_scoped_features
+            @unload_application_features = nil
+            @load_application_features = true
+          end
+        end
+      end
     end
     def unload_application_features
-      @redis_overrides = nil
-      @environment_variable_overrides = nil
-      @features = nil
-      @local_features = nil
-      @environment_features = nil
-      @redis_scoped_features = nil
+      if @unload_application_features.nil?
+        MUTEX[:unload_application_features].synchronize do
+          if @unload_application_features.nil?
+            @redis_overrides = nil
+            @environment_variable_overrides = nil
+            @features = nil
+            @local_features = nil
+            @environment_features = nil
+            @redis_scoped_features = nil
+            @load_application_features = nil
+            @unload_application_features = true
+          end
+        end
+      end
     end
     
     def cacheable?
+      # TODO Make thread-safe
       value = downcase_keys(cacheable)[application_environment]
       value = (application_environment != 'development') if value.nil?
       value
@@ -218,13 +261,13 @@ module AbstractFeatureBranch
     end
     
     private
-
+    
     def load_specific_features(features_hash, extension)
       Dir.glob(File.join(application_root, 'config', 'features', '**', "*#{extension}")).each do |feature_configuration_file|
         features_hash.deep_merge!(downcase_feature_hash_keys(YAML.load_file(feature_configuration_file)))
       end
       main_local_features_file = File.join(application_root, 'config', "features#{extension}")
-      features_hash.deep_merge!(downcase_feature_hash_keys(YAML.load_file(main_local_features_file))) if File.exists?(main_local_features_file)
+      features_hash.deep_merge!(downcase_feature_hash_keys(YAML.load_file(main_local_features_file))) if File.exist?(main_local_features_file)
       features_hash
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abstract_feature_branch
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-14 00:00:00.000000000 Z
+date: 2024-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -62,16 +62,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 3.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.14.1
+        version: 3.12.0
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +142,7 @@ files:
 - lib/abstract_feature_branch.rb
 - lib/abstract_feature_branch/configuration.rb
 - lib/abstract_feature_branch/file_beautifier.rb
+- lib/abstract_feature_branch/memoizable.rb
 - lib/abstract_feature_branch/redis/connection_pool_to_redis_adapter.rb
 - lib/ext/feature_branch.rb
 - lib/generators/abstract_feature_branch/context_generator.rb
@@ -181,7 +182,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.6
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: abstract_feature_branch is a Ruby gem that provides a variation on the Branch