feature_flagger 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89d925393dab41d5de3c0fd8872e9d0914936ed98140d5dea69e9ff9286cde7f
-  data.tar.gz: 68cd51804dbc9a1b8547ed1ddbd0be9630704afd0493e99b3c1a740f4c460c99
+  metadata.gz: 79074c1692fc84013e4a00bfaf72483e5267420f66d6a3af668cf8211af5abef
+  data.tar.gz: c50835a33526f4a3e58a24101d80bab6f784affd33bea935da82e921f74613b0
 SHA512:
-  metadata.gz: 6d1be4855ef2b133f1c0233f12f21833bdfd81bf35b3dd172e562fdd404bd6d674c429aeef4ec67a0f3062741b84f1ee99ba5bf6d317ec12b7f6517a9ab77ce1
-  data.tar.gz: 434ad5fda2e78b6bc63157bdee07000fcfde62ae102db74e543a09852914441c4bdd72fd15ddbf72bf1dec55e7acc2ff735d69bf9ca49e8482d56356ea032d6c
+  metadata.gz: 8ff4fc2a7c9a76252cab626fe285b2adda27348f009f7801fb7ed5c4cb2b49e389d4a29a7b42d5486faadf695cebaf538198da97382240e02cbd0e1f647d762d
+  data.tar.gz: c393c77c9a02634d3533c1731536a2cbde8cb7420eee0b696f431cc8d1e79553ddeb59a253cc84274ebb079af6bbe60e762483e92fbdc169a899f60f66d20dfe

data/README.md

@@ -43,6 +43,15 @@ FeatureFlagger.configure do |config|
 end
 ```
 
+It's also possible to configure an additional cache layer by using ActiveSupport::Cache APIs. You can configure it the same way you would setup cache_store for Rails Apps. Caching is not enabled by default.
+
+
+```ruby
+configuration.cache_store = :memory_store, { expires_in: 100 }
+
+```
+
+
 1. Create a `rollout.yml` in _config_ path and declare a rollout:
 ```yml
 account: # model name
@@ -96,6 +105,10 @@ account.release(:email_marketing, :new_email_flow)
 account.released?(:email_marketing, :new_email_flow)
 #=> true
 
+# In order to bypass the cache if cache_store is configured
+account.released?(:email_marketing, :new_email_flow, skip_cache: true)
+#=> true
+
 # Remove feature for given account
 account.unrelease(:email_marketing, :new_email_flow)
 #=> true
@@ -108,6 +121,10 @@ FeatureFlagger::KeyNotFoundError: ["account", "email_marketing", "new_email_flo"
 Account.released_id?(42, :email_marketing, :new_email_flow)
 #=> true
 
+# In order to bypass the cache if cache_store is configured
+Account.released_id?(42, :email_marketing, :new_email_flow, skip_cache: true)
+#=> true
+
 # Release a feature for a specific account id
 Account.release_id(42, :email_marketing, :new_email_flow)
 #=> true
@@ -123,6 +140,10 @@ Account.unrelease_to_all(:email_marketing, :new_email_flow)
 
 # Return an array with all features released for all
 Account.released_features_to_all
+
+# In order to bypass the cache if cache_store is configured
+Account.released_features_to_all(skip_cache: true)
+
 ```
 
 ## Clean up action

data/lib/feature_flagger.rb

@@ -30,7 +30,7 @@ module FeatureFlagger
     end
 
     def control
-      @@control ||= Control.new(config.storage, notifier)
+      @@control ||= Control.new(config.storage, notifier, config.cache_store)
     end
   end
 end

data/lib/feature_flagger/configuration.rb

@@ -1,11 +1,17 @@
 module FeatureFlagger
   class Configuration
-    attr_accessor :storage, :yaml_filepath, :notifier_callback
+    attr_accessor :storage, :cache_store, :yaml_filepath, :notifier_callback
 
     def initialize
       @storage       ||= Storage::Redis.default_client
       @yaml_filepath ||= default_yaml_filepath
       @notifier_callback = nil
+      @cache_store = nil
+    end
+
+    def cache_store=(cache_store)
+      raise ArgumentError, "Cache is only support when used with ActiveSupport" unless defined?(ActiveSupport)
+      @cache_store = ActiveSupport::Cache.lookup_store(*cache_store)
     end
 
     def info

data/lib/feature_flagger/control.rb

@@ -4,13 +4,16 @@ module FeatureFlagger
 
     RELEASED_FEATURES = 'released_features'
 
-    def initialize(storage, notifier)
+    def initialize(storage, notifier, cache_store = nil)
       @storage = storage
       @notifier = notifier
+      @cache_store = cache_store
     end
 
-    def released?(feature_key, resource_id)
-      @storage.has_value?(RELEASED_FEATURES, feature_key) || @storage.has_value?(feature_key, resource_id)
+    def released?(feature_key, resource_id, options = {})
+      cache "released/#{feature_key}", options do
+        @storage.has_value?(RELEASED_FEATURES, feature_key) || @storage.has_value?(feature_key, resource_id)
+      end
     end
 
     def release(feature_key, resource_id)
@@ -22,8 +25,10 @@ module FeatureFlagger
       @storage.add(feature_key, resource_name, resource_id)
     end
 
-    def releases(resource_name, resource_id)
-      @storage.fetch_releases(resource_name, resource_id, RELEASED_FEATURES)
+    def releases(resource_name, resource_id, options = {})
+      cache "releases/#{RELEASED_FEATURES}", options do
+        @storage.fetch_releases(resource_name, resource_id, RELEASED_FEATURES)
+      end
     end
 
     def release_to_all(feature_key)
@@ -44,16 +49,22 @@ module FeatureFlagger
       @storage.remove_all(RELEASED_FEATURES, feature_key)
     end
 
-    def resource_ids(feature_key)
-      @storage.all_values(feature_key)
+    def resource_ids(feature_key, options = {})
+      cache "all_values/#{feature_key}", options do
+        @storage.all_values(feature_key)
+      end
     end
 
-    def released_features_to_all
-      @storage.all_values(RELEASED_FEATURES)
+    def released_features_to_all(options = {})
+      cache "all_values/#{RELEASED_FEATURES}", options do
+        @storage.all_values(RELEASED_FEATURES)
+      end
     end
 
-    def released_to_all?(feature_key)
-      @storage.has_value?(RELEASED_FEATURES, feature_key)
+    def released_to_all?(feature_key, options = {})
+      cache "has_value/#{RELEASED_FEATURES}", options do
+        @storage.has_value?(RELEASED_FEATURES, feature_key)
+      end
     end
 
     # DEPRECATED: this method will be removed from public api on v2.0 version.
@@ -65,5 +76,16 @@ module FeatureFlagger
     def feature_keys
       @storage.feature_keys - [FeatureFlagger::Control::RELEASED_FEATURES]
     end
+
+    def cache(name, options, &block)
+      if @cache_store
+        @cache_store.fetch(name, force: options[:skip_cache]) do
+          block.call
+        end
+      else
+        block.call
+      end
+    end
+
   end
 end

data/lib/feature_flagger/model.rb

@@ -12,8 +12,8 @@ module FeatureFlagger
       base.extend ClassMethods
     end
 
-    def released?(*feature_key)
-      self.class.released_id?(feature_flagger_identifier, feature_key)
+    def released?(*feature_key, **options)
+      self.class.released_id?(feature_flagger_identifier, feature_key, options)
     end
 
     def release(*feature_key)
@@ -26,9 +26,9 @@ module FeatureFlagger
       FeatureFlagger.control.unrelease(feature.key, id)
     end
 
-    def releases
+    def releases(options = {})
       resource_name = self.class.feature_flagger_model_settings.entity_name
-      FeatureFlagger.control.releases(resource_name, id)
+      FeatureFlagger.control.releases(resource_name, id, options)
     end
 
     private
@@ -43,9 +43,9 @@ module FeatureFlagger
         yield feature_flagger_model_settings
       end
 
-      def released_id?(resource_id, *feature_key)
+      def released_id?(resource_id, *feature_key, **options)
         feature = Feature.new(feature_key, feature_flagger_model_settings.entity_name)
-        FeatureFlagger.control.released?(feature.key, resource_id)
+        FeatureFlagger.control.released?(feature.key, resource_id, options)
       end
 
       def release_id(resource_id, *feature_key)
@@ -58,10 +58,10 @@ module FeatureFlagger
         FeatureFlagger.control.unrelease(feature.key, resource_id)
       end
 
-      def all_released_ids_for(*feature_key)
+      def all_released_ids_for(*feature_key, **options)
         feature_key.flatten!
         feature = Feature.new(feature_key, feature_flagger_model_settings.entity_name)
-        FeatureFlagger.control.resource_ids(feature.key)
+        FeatureFlagger.control.resource_ids(feature.key, options)
       end
 
       def release_to_all(*feature_key)
@@ -74,13 +74,13 @@ module FeatureFlagger
         FeatureFlagger.control.unrelease_to_all(feature.key)
       end
 
-      def released_features_to_all
-        FeatureFlagger.control.released_features_to_all
+      def released_features_to_all(options = {})
+        FeatureFlagger.control.released_features_to_all(options)
       end
 
-      def released_to_all?(*feature_key)
+      def released_to_all?(*feature_key, **options)
         feature = Feature.new(feature_key, feature_flagger_model_settings.entity_name)
-        FeatureFlagger.control.released_to_all?(feature.key)
+        FeatureFlagger.control.released_to_all?(feature.key, options)
       end
 
       def detached_feature_keys

data/lib/feature_flagger/version.rb

@@ -1,3 +1,3 @@
 module FeatureFlagger
-  VERSION = "2.0.1"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: feature_flagger
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Nando Sousa
 - Geison Biazus
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-27 00:00:00.000000000 Z
+date: 2021-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -39,6 +39,20 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -138,7 +152,7 @@ homepage: http://github.com/ResultadosDigitais/feature_flagger
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -154,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 2.0.0
 requirements: []
 rubygems_version: 3.2.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Partial release your features.
 test_files: []