feature_flagger 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d02210f5b573bd3ebb01a75794885b729981a740412bf045b713a8d9db37a75
-  data.tar.gz: cd9f4ab0e6058029e8a5cab354d98a0b676363a05582169f52d90578c2613b37
+  metadata.gz: 6767ef346f481a29e5ba7d2d6bb9127e1604d52b57ffe51f967e22ab92160639
+  data.tar.gz: a02fca28c7d16ac89332e2d482c1305b460d1d74e5de4bca0bda7062bb027d3d
 SHA512:
-  metadata.gz: d10511abc507466990deaae846843474ebeb9e3ace09e61b2e08bead320a26849f1e8cf04b8ecc52a91de7e7e01348435e5d92332dd98ceea878866da3548be6
-  data.tar.gz: 3c3564c0c34b2ed86552637a47b4af544f66c22100d31d7b89e54d22316e7fa4049118f7973fe1cdf05c837ce0668aa163720fe8bebb43f86011c1d3e9abeeda
+  metadata.gz: b840991512859a8b26ede79c28e30ffa13e2d298f9bedce5abc3c56dba973d425b6c062bb931f6e1cf49be9e927c3ada304894815e9d202e2c29e0fa9fdf8526
+  data.tar.gz: 120dc250044c525d7e365468e2f32bf8cb55882b83b9d678c5fc07cdffa959f7f725a1e41dc86c464d6d98231df1551c974c8763046cf56a9f4a441268ca456c

data/README.md

@@ -161,6 +161,35 @@ to ensure the data stored in Redis storage is right. Check [#67](https://github.
 
     $ bundle exec rake feature_flagger:migrate_to_resource_keys
 
+## Extra options
+
+There are a few options to store/retrieve your rollout manifest (a.k.a rollout.yml):
+
+If you have a rollout.yml file and want to use Redis to keep a backup, add the follow code to the configuration block:
+
+```ruby
+require 'feature_flagger/manifest_sources/yaml_with_backup_to_storage'
+FeatureFlagger.configure do |config|
+  ...
+  config.manifest_source = FeatureFlagger::ManifestSources::YAMLWithBackupToStorage.new(config.storage)
+  ...
+end
+```
+
+If you already have your manifest on Redis and prefer not to keep a copy in your application, add the following code to the configuration block:
+
+```ruby
+require 'feature_flagger/manifest_sources/storage_only'
+
+FeatureFlagger.configure do |config|
+  ...
+  config.manifest_source = FeatureFlagger::ManifestSources::StorageOnly.new(config.storage)
+  ...
+end
+```
+
+If you have the YAML file and don't need a backup, it is unnecessary to do any different configuration.
+
 ## Contributing
 
 Bug reports and pull requests are welcome!

data/lib/feature_flagger/configuration.rb

@@ -1,10 +1,10 @@
 module FeatureFlagger
   class Configuration
-    attr_accessor :storage, :cache_store, :yaml_filepath, :notifier_callback
+    attr_accessor :storage, :cache_store, :manifest_source, :notifier_callback
 
     def initialize
       @storage       ||= Storage::Redis.default_client
-      @yaml_filepath ||= default_yaml_filepath
+      @manifest_source ||= FeatureFlagger::ManifestSources::WithYamlFile.new
       @notifier_callback = nil
       @cache_store = nil
     end
@@ -17,7 +17,7 @@ module FeatureFlagger
     end
 
     def info
-      @info ||= YAML.load_file(yaml_filepath) if yaml_filepath
+      @manifest_source.resolved_info
     end
 
     def mapped_feature_keys(resource_name = nil)
@@ -29,10 +29,6 @@ module FeatureFlagger
 
     private
 
-    def default_yaml_filepath
-      "#{Rails.root}/config/rollout.yml" if defined?(Rails)
-    end
-
     def make_keys_recursively(hash, keys = [], composed_key = [])
       unless hash.values[0].is_a?(Hash)
         keys.push(composed_key)

data/lib/feature_flagger/manifest_sources/storage_only.rb

@@ -0,0 +1,13 @@
+module FeatureFlagger
+  module ManifestSources
+    class StorageOnly
+      def initialize(storage)
+        @storage = storage
+      end
+
+      def resolved_info
+        YAML.load(@storage.read_manifest_backup)
+      end
+    end
+  end
+end

data/lib/feature_flagger/manifest_sources/with_yaml_file.rb

@@ -0,0 +1,14 @@
+module FeatureFlagger
+  module ManifestSources
+    class WithYamlFile
+      def initialize(yaml_path = nil)
+        @yaml_path = yaml_path
+        @yaml_path ||= "#{Rails.root}/config/rollout.yml" if defined?(Rails)
+      end
+
+      def resolved_info
+        @resolved_info ||= ::YAML.load_file(@yaml_path) if @yaml_path
+      end
+    end
+  end
+end

data/lib/feature_flagger/manifest_sources/yaml_with_backup_to_storage.rb

@@ -0,0 +1,18 @@
+module FeatureFlagger
+  module ManifestSources
+    class YAMLWithBackupToStorage
+      def initialize(storage, yaml_path = nil)
+        @yaml_path = yaml_path || ("#{Rails.root}/config/rollout.yml" if defined?(Rails))
+        @storage   = storage
+      end
+
+      def resolved_info
+        @resolved_info ||= begin
+          yaml_data = YAML.load_file(@yaml_path) if @yaml_path
+          @storage.write_manifest_backup(YAML.dump(yaml_data))
+          yaml_data
+        end
+      end
+    end
+  end
+end

data/lib/feature_flagger/model.rb

@@ -13,7 +13,7 @@ module FeatureFlagger
     end
 
     def released?(*feature_key, **options)
-      self.class.released_id?(feature_flagger_identifier, feature_key, options)
+      self.class.released_id?(feature_flagger_identifier, *feature_key, **options)
     end
 
     def release(*feature_key)

data/lib/feature_flagger/storage/redis.rb

@@ -5,8 +5,10 @@ require_relative './keys'
 module FeatureFlagger
   module Storage
     class Redis
-      DEFAULT_NAMESPACE = :feature_flagger
-      RESOURCE_PREFIX = "_r".freeze
+      DEFAULT_NAMESPACE    = :feature_flagger
+      RESOURCE_PREFIX      = "_r".freeze
+      MANIFEST_PREFIX      = "_m".freeze
+      MANIFEST_KEY         = "manifest_file".freeze
       SCAN_EACH_BATCH_SIZE = 1000.freeze
 
       def initialize(redis)
@@ -75,6 +77,7 @@ module FeatureFlagger
           # Reject keys related to feature responsible for return
           # released features for a given account.
           next if key.start_with?("#{RESOURCE_PREFIX}:")
+          next if key.start_with?("#{MANIFEST_PREFIX}:")
 
           feature_keys << key
         end
@@ -89,6 +92,14 @@ module FeatureFlagger
         ).call
       end
 
+      def read_manifest_backup
+        @redis.get("#{MANIFEST_PREFIX}:#{MANIFEST_KEY}")
+      end
+
+      def write_manifest_backup(yaml_as_string)
+        @redis.set("#{MANIFEST_PREFIX}:#{MANIFEST_KEY}", yaml_as_string)
+      end
+
       private
 
       def resource_key(resource_name, resource_id)

data/lib/feature_flagger/version.rb

@@ -1,3 +1,3 @@
 module FeatureFlagger
-  VERSION = "2.1.1"
+  VERSION = "2.2.0"
 end

data/lib/feature_flagger.rb

@@ -11,6 +11,7 @@ require 'feature_flagger/configuration'
 require 'feature_flagger/manager'
 require 'feature_flagger/railtie'
 require 'feature_flagger/notifier'
+require 'feature_flagger/manifest_sources/with_yaml_file'
 
 module FeatureFlagger
   class << self

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: feature_flagger
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Nando Sousa
 - Geison Biazus
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-01 00:00:00.000000000 Z
+date: 2021-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -139,6 +139,9 @@ files:
 - lib/feature_flagger/core_ext.rb
 - lib/feature_flagger/feature.rb
 - lib/feature_flagger/manager.rb
+- lib/feature_flagger/manifest_sources/storage_only.rb
+- lib/feature_flagger/manifest_sources/with_yaml_file.rb
+- lib/feature_flagger/manifest_sources/yaml_with_backup_to_storage.rb
 - lib/feature_flagger/model.rb
 - lib/feature_flagger/model_settings.rb
 - lib/feature_flagger/notifier.rb
@@ -152,7 +155,7 @@ homepage: http://github.com/ResultadosDigitais/feature_flagger
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -167,8 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: Partial release your features.
 test_files: []