abstract_feature_branch 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0240cf2db5b90b0e267e2655cdc6492dc601983959d5438f6e8489ab2eb2c93b
-  data.tar.gz: 17a136533fdc8dc4332428d302581aa154463272a0a3dff94ca43d3a076a85b7
+  metadata.gz: 9b05f473f9e1490d0e627cd6ee46bc065fd99054eeec4fe4276b6009650a3ad4
+  data.tar.gz: 657dbe0b15b9ac0827ef3dcbaa748bc571cb7d1ef95b25e44d3ee8c1029bf4ae
 SHA512:
-  metadata.gz: cf380b5f6c9fd78ea192887bad5628a8632e26ade45636ee4ee10028efa69e3413c92d19748349e21421bed4666ac72c7b88a3ab8979be97621075a4abc36f0e
-  data.tar.gz: 441c92f87e112691be34ee9b703e039a7a368b6a7e4d0e082242892dc14907472e3892d3b81a95378eee8a70197e12b31daff631e017772a00d60b0ffce28e24
+  metadata.gz: cbf7abdfa86da1c21bb55e913809879adc0fb7d049ae047a272dbbdec648f064112036bc1671ed2f66dc0cdec7539d0e6fee0f7d9bc099dcc710229cc8a2d1e4
+  data.tar.gz: 8effdc0bba15209eb0d4366dd719b98bd11c3d5e6f772788156d40a625f2539b17a726ea79ceeedc29576dc58b49a14f1b0a26cabe46a8037473e0fe5c3cc4be

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Change Log
 
+## 1.5.1
+
+- `AbstractFeatureBranch.toggled_features_for_scope(scope)` API method that returns toggled features for a scope (String)
+- `AbstractFeatureBranch.scopes_for_feature(feature)` API method that returns scopes for a (scoped) feature (String or Symbol)
+
 ## 1.5.0
 
 - Generalize "Per-User Feature Enablement" as "Scoped Feature Enablement" (using `scoped` value instead of `per_user` value) to scope features by any scope IDs (e.g. entity IDs or value objects)

data/README.md

@@ -1,4 +1,4 @@
-# Abstract Feature Branch 1.5.0
+# Abstract Feature Branch 1.5.1
 [![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)
@@ -23,8 +23,6 @@ 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](https://redis.com) as a very fast in-memory data store).
 
-
-
 Requirements
 ------------
 - Ruby (between `~> 3.1.0` and `~> 1.8.7`)
@@ -38,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.0'</pre>
-   - With `rails` `~> 2.0` only: Add the following to config/environment.rb <pre>config.gem 'abstract_feature_branch', :version => '1.5.0'</pre>
+   - 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>
 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)
@@ -48,7 +46,7 @@ Setup
 
 ### Ruby Application General Use
 
-1. <pre>gem install abstract_feature_branch -v 1.5.0</pre>
+1. <pre>gem install abstract_feature_branch -v 1.5.1</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))
@@ -138,10 +136,10 @@ It is possible to restrict enablement of features per specific users (or per ent
 1. Use <code>toggle_features_for_scope</code> in Ruby code to enable features per scope ID (e.g. entity ID, comma-separated compound ID, JSON string, or value object), which must be a String or a value that is safely-convertable to a String like Integer (e.g. email address or database ID). This loads Redis client gem into memory and stores scoped 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).
 
->     scope_id = current_user.email
->     AbstractFeatureBranch.toggle_features_for_scope(scope_id, :feature1 => true, :feature2 => false, :feature3 => true, :feature5 => true)
+>     scope = current_user.email
+>     AbstractFeatureBranch.toggle_features_for_scope(scope, :feature1 => true, :feature2 => false, :feature3 => true, :feature5 => true)
 
-Use alternate version of <code>feature_branch</code> and <code>feature_enabled?</code> passing extra <code>scope_id</code> argument
+Use alternate version of <code>feature_branch</code> and <code>feature_enabled?</code> passing extra <code>scope</code> argument
 
 Examples:
 
@@ -171,6 +169,14 @@ If a feature is enabled as <code>true</code> or disabled as <code>false</code> i
 like features.local.yml or environment variable overrides), then it overrides toggled scoped feature restrictions, becoming
 enabled or disabled globally.
 
+API
+---
+
+`AbstractFeatureBranch.toggle_features_for_scope(scope, feature1: true, feature2: false, ...)`: API method that toggles features (Strings or Symbols) for a scope
+
+`AbstractFeatureBranch.toggled_features_for_scope(scope)`: API method that returns toggled features for a scope (String)
+
+`AbstractFeatureBranch.scopes_for_feature(feature)`: API method that returns scopes for a (scoped) feature (String or Symbol)
 
 Recommendations
 ---------------

data/VERSION

@@ -1 +1 @@
-1.5.0
+1.5.1

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.0 ruby lib
+# stub: abstract_feature_branch 1.5.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "abstract_feature_branch".freeze
-  s.version = "1.5.0"
+  s.version = "1.5.1"
 
   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-12"
+  s.date = "2023-02-14"
   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",

data/lib/abstract_feature_branch.rb

@@ -101,10 +101,7 @@ module AbstractFeatureBranch
             normalized_feature_name = feature.to_s.downcase
             @redis_scoped_features[normalized_feature_name] ||= []
             begin
-              scoped_feature_scope_ids = AbstractFeatureBranch.
-                                            feature_store.
-                                            smembers("#{AbstractFeatureBranch::ENV_FEATURE_PREFIX}#{normalized_feature_name}")
-              @redis_scoped_features[normalized_feature_name] += scoped_feature_scope_ids
+              @redis_scoped_features[normalized_feature_name] += scopes_for_feature(normalized_feature_name)
             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
@@ -192,17 +189,34 @@ module AbstractFeatureBranch
       end
     end
     
-    def toggle_features_for_scope(scope_id, features)
+    def toggle_features_for_scope(scope, features)
       features.each do |name, value|
         if value
-          feature_store.sadd("#{ENV_FEATURE_PREFIX}#{name.to_s.downcase}", scope_id)
+          feature_store.sadd("#{ENV_FEATURE_PREFIX}#{name.to_s.downcase}", scope)
         else
-          feature_store.srem("#{ENV_FEATURE_PREFIX}#{name.to_s.downcase}", scope_id)
+          feature_store.srem("#{ENV_FEATURE_PREFIX}#{name.to_s.downcase}", scope)
         end
       end
     end
     alias toggle_features_for_user toggle_features_for_scope
-
+    
+    def toggled_features_for_scope(scope)
+      AbstractFeatureBranch.feature_store.keys.select do |key|
+        key.start_with?(AbstractFeatureBranch::ENV_FEATURE_PREFIX)
+      end.map do |key|
+        feature = key.sub(AbstractFeatureBranch::ENV_FEATURE_PREFIX, '')
+      end.select do |feature|
+        scopes_for_feature(feature).include?(scope.to_s)
+      end
+    end
+    
+    def scopes_for_feature(feature)
+      normalized_feature_name = feature.to_s.downcase
+      AbstractFeatureBranch.
+        feature_store.
+        smembers("#{AbstractFeatureBranch::ENV_FEATURE_PREFIX}#{normalized_feature_name}")
+    end
+    
     private
 
     def load_specific_features(features_hash, extension)

data/lib/ext/feature_branch.rb

@@ -1,20 +1,20 @@
 class Object
   class << self
     raise 'Abstract feature branch conflicts with another Ruby library having Object::feature_branch' if respond_to?(:feature_branch)
-    def feature_branch(feature_name, scope_id = nil, &feature_work)
-      if feature_enabled?(feature_name, scope_id)
+    def feature_branch(feature_name, scope = nil, &feature_work)
+      if feature_enabled?(feature_name, scope)
         feature_work.call
       end
     end
   
     raise 'Abstract feature branch conflicts with another Ruby library having Object::feature_enabled?' if respond_to?(:feature_enabled?)
-    def feature_enabled?(feature_name, scope_id = nil)
+    def feature_enabled?(feature_name, scope = nil)
       normalized_feature_name = feature_name.to_s.downcase
   
       redis_override_value = feature_enabled_reddis_override_value(normalized_feature_name)
       value = !redis_override_value.nil? ? redis_override_value : AbstractFeatureBranch.application_features[normalized_feature_name]
       if AbstractFeatureBranch.scoped_value?(value)
-        value = !scope_id.nil? && feature_enabled_scoped_value(feature_name, scope_id)
+        value = !scope.nil? && feature_enabled_scoped_value(feature_name, scope)
       end
       value
     end
@@ -34,27 +34,27 @@ class Object
     end
     
     raise 'Abstract feature branch conflicts with another Ruby library having Object::feature_enabled_scoped_value' if Object.new.respond_to?(:feature_enabled_scoped_value, true)
-    def feature_enabled_scoped_value(normalized_feature_name, scope_id)
+    def feature_enabled_scoped_value(normalized_feature_name, scope)
       if AbstractFeatureBranch.configuration.feature_store_live_fetching?
         begin
-          AbstractFeatureBranch.feature_store.sismember("#{AbstractFeatureBranch::ENV_FEATURE_PREFIX}#{normalized_feature_name}", scope_id)
+          AbstractFeatureBranch.feature_store.sismember("#{AbstractFeatureBranch::ENV_FEATURE_PREFIX}#{normalized_feature_name}", scope)
         rescue Exception => error
-          AbstractFeatureBranch.logger.error "AbstractFeatureBranch encountered an error in retrieving Per-User value for feature \"#{normalized_feature_name}\" and scope_id #{scope_id}! Defaulting to nil value...\n\nError: #{error.full_message}\n\n"
+          AbstractFeatureBranch.logger.error "AbstractFeatureBranch encountered an error in retrieving Per-User value for feature \"#{normalized_feature_name}\" and scope #{scope}! Defaulting to nil value...\n\nError: #{error.full_message}\n\n"
           nil
         end
       else
-        AbstractFeatureBranch.redis_scoped_features[normalized_feature_name]&.include?(scope_id.to_s)
+        AbstractFeatureBranch.redis_scoped_features[normalized_feature_name]&.include?(scope.to_s)
       end
     end
   end
   
   raise 'Abstract feature branch conflicts with another Ruby library having Object#feature_branch' if Object.new.respond_to?(:feature_branch)
-  def feature_branch(feature_name, scope_id = nil, &feature_work)
-    Object.feature_branch(feature_name.to_s, scope_id, &feature_work)
+  def feature_branch(feature_name, scope = nil, &feature_work)
+    Object.feature_branch(feature_name.to_s, scope, &feature_work)
   end
 
   raise 'Abstract feature branch conflicts with another Ruby library having Object#feature_enabled?' if Object.new.respond_to?(:feature_enabled?)
-  def feature_enabled?(feature_name, scope_id = nil)
-    Object.feature_enabled?(feature_name.to_s, scope_id)
+  def feature_enabled?(feature_name, scope = nil)
+    Object.feature_enabled?(feature_name.to_s, scope)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abstract_feature_branch
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Andy Maleh
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-12 00:00:00.000000000 Z
+date: 2023-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge