feature_flagger 0.7.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: '08ad3deca247deb946f6fd7f95fe12747978303e'
-  data.tar.gz: 8512e9a0a733eaaa95c8faa61caf340786b10189
+SHA256:
+  metadata.gz: a96951570dcb83956c8a817ac63a0928fdcd276e65fda789828fd4ef2a9b0234
+  data.tar.gz: 332306b6061c58cd5f215b3e51ad0084434eff4d82d77d7ae533b353176ecca6
 SHA512:
-  metadata.gz: 11e2542ada2893c96bd7588a959f424f1904e29e8b7a4a1425557e995a8cefa95c4e47b839282e28bb8a4e7d6b4ef753e24dc538ebdfbba6c8a590b8904af509
-  data.tar.gz: fd70b4252d581ff110ca37ce59a5e5dcae514fa040e52e1580f4ef5c24ca51313b9ec7c041a8b1c9898c3c0ce4be884605fe1d420e17b6bde0d2594db2a29140
+  metadata.gz: 1dd51d20a1e52136ee0609ca619c3bb11d6fbc086170f339e6b40c6c09ab49bd9a3ff55b5901ad9a4a09c9e2b840e3eda44ebedc504e07deeede38c9cfcedfb9
+  data.tar.gz: 97c93e48cb0a5ef452c3df7f17b35848c636151366bbdf329f91f40e19134491c2c6d441bb31e3308ccaea67bc2688788d5817b7c657ede7f7f1b20de93f809e

data/README.md

@@ -4,6 +4,14 @@
 
 Partially release your features.
 
+## Working with Docker
+
+Open IRB
+`docker-compose run feature_flagger`
+
+Running tests
+`docker-compose run feature_flagger rspec`
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -63,7 +71,7 @@ account.release(:email_marketing, :new_email_flow)
 #=> true
 
 # Check feature for a given account
-account.rollout?(:email_marketing, :new_email_flow)
+account.released?(:email_marketing, :new_email_flow)
 #=> true
 
 # Remove feature for given account
@@ -71,7 +79,7 @@ account.unrelease(:email_marketing, :new_email_flow)
 #=> true
 
 # If you try to check an inexistent rollout key it will raise an error.
-account.rollout?(:email_marketing, :new_email_flow)
+account.released?(:email_marketing, :new_email_flow)
 FeatureFlagger::KeyNotFoundError: ["account", "email_marketing", "new_email_flo"]
 
 # Check feature for a specific account id
@@ -95,7 +103,15 @@ Account.unrelease_to_all(:email_marketing, :new_email_flow)
 Account.released_features_to_all
 ```
 
+## Clean up action
+
+By default when a key is removed from `rollout.yml` file, its data still in the storage.
+
+To clean it up, execute or schedule the rake:
+
+    $ bundle exec rake feature_flagger:cleanup_removed_rollouts
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at
-https://github.com/ResultadosDigitais/feature_flagger.
+Bug reports and pull requests are welcome!
+Please take a look at our guidelines [here](CONTRIBUTING.md).

data/lib/feature_flagger/configuration.rb

@@ -11,10 +11,36 @@ module FeatureFlagger
       @info ||= YAML.load_file(yaml_filepath) if yaml_filepath
     end
 
+    def mapped_feature_keys(resource_name = nil)
+      info_filtered = resource_name ? info[resource_name] : info
+      [].tap do |keys|
+        make_keys_recursively(info_filtered).each { |key| keys.push(join_key(resource_name, key)) }
+      end
+    end
+
     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)
+        return
+      end
+
+      hash.each do |key, value|
+        composed_key_cloned = composed_key.clone
+        composed_key_cloned.push(key.to_sym)
+        make_keys_recursively(value, keys, composed_key_cloned)
+      end
+      keys
+    end
+
+    def join_key(resource_name, key)
+      key.unshift resource_name if resource_name
+      key.join(":")
+    end
   end
 end

data/lib/feature_flagger/control.rb

@@ -8,7 +8,7 @@ module FeatureFlagger
       @storage = storage
     end
 
-    def rollout?(feature_key, resource_id)
+    def released?(feature_key, resource_id)
       @storage.has_value?(RELEASED_FEATURES, feature_key) || @storage.has_value?(feature_key, resource_id)
     end
 
@@ -17,13 +17,7 @@ module FeatureFlagger
     end
 
     def release_to_all(feature_key)
-      @storage.add(RELEASED_FEATURES, feature_key)
-    end
-
-    # <b>DEPRECATED:</b> Please use <tt>release</tt> instead.
-    def release!(feature_key, resource_id)
-      warn "[DEPRECATION] `release!` is deprecated.  Please use `release` instead."
-      release(feature_key, resource_id)
+      @storage.add_all(RELEASED_FEATURES, feature_key)
     end
 
     def unrelease(feature_key, resource_id)
@@ -31,13 +25,7 @@ module FeatureFlagger
     end
 
     def unrelease_to_all(feature_key)
-      @storage.remove(RELEASED_FEATURES, feature_key)
-    end
-
-    # <b>DEPRECATED:</b> Please use <tt>unrelease</tt> instead.
-    def unrelease!(feature_key, resource_id)
-      warn "[DEPRECATION] `unrelease!` is deprecated.  Please use `unrelease` instead."
-      unrelease(feature_key, resource_id)
+      @storage.remove_all(RELEASED_FEATURES, feature_key)
     end
 
     def resource_ids(feature_key)
@@ -47,5 +35,13 @@ module FeatureFlagger
     def released_features_to_all
       @storage.all_values(RELEASED_FEATURES)
     end
+
+    def released_to_all?(feature_key)
+      @storage.has_value?(RELEASED_FEATURES, feature_key)
+    end
+
+    def search_keys(query)
+      @storage.search_keys(query)
+    end
   end
 end

data/lib/feature_flagger/manager.rb

@@ -0,0 +1,18 @@
+module FeatureFlagger
+  class Manager
+
+    def self.detached_feature_keys
+      persisted_features = FeatureFlagger.control.search_keys("*").to_a
+      mapped_feature_keys = FeatureFlagger.config.mapped_feature_keys
+      persisted_features - mapped_feature_keys
+    end
+
+    def self.cleanup_detached(resource_name, *feature_key)
+      complete_feature_key = feature_key.map(&:to_s).insert(0, resource_name.to_s)
+      key_value = FeatureFlagger.config.info.dig(*complete_feature_key)
+      raise "key is still mapped" if key_value
+      FeatureFlagger.control.unrelease_to_all(complete_feature_key.join(':'))
+    end
+
+  end
+end

data/lib/feature_flagger/model.rb

@@ -12,26 +12,14 @@ module FeatureFlagger
       base.extend ClassMethods
     end
 
-    def rollout?(*feature_key)
+    def released?(*feature_key)
       self.class.released_id?(id, feature_key)
     end
 
-    # <b>DEPRECATED:</b> Please use <tt>release</tt> instead.
-    def release!(*feature_key)
-      warn "[DEPRECATION] `release!` is deprecated.  Please use `release` instead."
-      release(*feature_key)
-    end
-
     def release(*feature_key)
       self.class.release_id(id, *feature_key)
     end
 
-    # <b>DEPRECATED:</b> Please use <tt>unrelease</tt> instead.
-    def unrelease!(*feature_key)
-      warn "[DEPRECATION] `unrelease!` is deprecated.  Please use `unrelease` instead."
-      unrelease(*feature_key)
-    end
-
     def unrelease(*feature_key)
       resource_name = self.class.rollout_resource_name
       feature = Feature.new(feature_key, resource_name)
@@ -39,9 +27,10 @@ module FeatureFlagger
     end
 
     module ClassMethods
+
       def released_id?(resource_id, *feature_key)
         feature = Feature.new(feature_key, rollout_resource_name)
-        FeatureFlagger.control.rollout?(feature.key, resource_id)
+        FeatureFlagger.control.released?(feature.key, resource_id)
       end
 
       def release_id(resource_id, *feature_key)
@@ -69,6 +58,24 @@ module FeatureFlagger
         FeatureFlagger.control.released_features_to_all
       end
 
+      def released_to_all?(*feature_key)
+        feature = Feature.new(feature_key, rollout_resource_name)
+        FeatureFlagger.control.released_to_all?(feature.key)
+      end
+
+      def detached_feature_keys
+        persisted_features = FeatureFlagger.control.search_keys("#{rollout_resource_name}:*").to_a
+        mapped_feature_keys = FeatureFlagger.config.mapped_feature_keys(rollout_resource_name)
+        (persisted_features - mapped_feature_keys).map { |key| key.sub("#{rollout_resource_name}:",'') }
+      end
+
+      def cleanup_detached(*feature_key)
+        complete_feature_key = feature_key.map(&:to_s).insert(0, rollout_resource_name)
+        key_value = FeatureFlagger.config.info.dig(*complete_feature_key)
+        raise "key is still mapped" if key_value
+        FeatureFlagger.control.unrelease_to_all(complete_feature_key.join(':'))
+      end
+
       def rollout_resource_name
         klass_name = self.to_s
         klass_name.gsub!(/::/, '_')

data/lib/feature_flagger/railtie.rb

@@ -0,0 +1,9 @@
+if defined?(Rails)
+  module FeatureFlagger
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        load 'tasks/cleanup.rake'
+      end
+    end
+  end
+end

data/lib/feature_flagger/storage/redis.rb

@@ -29,9 +29,27 @@ module FeatureFlagger
         @redis.srem(key, value)
       end
 
+      def remove_all(global_key, key)
+        @redis.multi do |redis|
+          redis.srem(global_key, key)
+          redis.del(key)
+        end
+      end
+
+      def add_all(global_key, key)
+        @redis.multi do |redis|
+          redis.sadd(global_key, key)
+          redis.del(key)
+        end
+      end
+
       def all_values(key)
         @redis.smembers(key)
       end
+
+      def search_keys(query)
+        @redis.scan_each(match: query)
+      end
     end
   end
 end

data/lib/feature_flagger/version.rb

@@ -1,3 +1,3 @@
 module FeatureFlagger
-  VERSION = "0.7.3"
+  VERSION = "1.0.0"
 end

data/lib/feature_flagger.rb

@@ -6,6 +6,8 @@ require 'feature_flagger/control'
 require 'feature_flagger/model'
 require 'feature_flagger/feature'
 require 'feature_flagger/configuration'
+require 'feature_flagger/manager'
+require 'feature_flagger/railtie'
 
 module FeatureFlagger
   class << self

data/lib/tasks/cleanup.rake

@@ -0,0 +1,10 @@
+namespace :feature_flagger do
+  desc "cleaning up keys from storage that are no longer in the rollout.yml file"
+  task :cleanup_removed_rollouts => :environment do
+    keys = FeatureFlagger::Manager.detached_feature_keys
+    puts "Found keys to remove: #{keys}"
+    keys.each do |key|
+      FeatureFlagger::Manager.cleanup_detached key
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feature_flagger
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Nando Sousa
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-22 00:00:00.000000000 Z
+date: 2019-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -109,9 +109,12 @@ files:
 - lib/feature_flagger/configuration.rb
 - lib/feature_flagger/control.rb
 - lib/feature_flagger/feature.rb
+- lib/feature_flagger/manager.rb
 - lib/feature_flagger/model.rb
+- lib/feature_flagger/railtie.rb
 - lib/feature_flagger/storage/redis.rb
 - lib/feature_flagger/version.rb
+- lib/tasks/cleanup.rake
 homepage: http://github.com/ResultadosDigitais/feature_flagger
 licenses:
 - MIT
@@ -124,15 +127,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: Partial release your features.