feature_flagger 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e6648b809fb71f619b7f183de45faff5c8f7e180b716bb7ed4f41178b9b6a7b
-  data.tar.gz: ba3ec6da4184d199d2a74e360fcb789fd2ac9aeb95dea738de7dc650129f6369
+  metadata.gz: b54bc71d733eb04b2e52156763557a45f94d9722918b12b09e89a07553b88ee4
+  data.tar.gz: 5984d522ae2d19f324de342db5810cd9bf351c43a9e60e159f8442209f38575f
 SHA512:
-  metadata.gz: 196c76cad916494a7bb3438a69a4ddfe4dbc3a1efc6584078f4eee681c7dc9d3e53ece3e37796aed9d4e4d865602cf12deb4e165f1fc3a62f43eee0f5f71878f
-  data.tar.gz: 7b81c8fd3679000af48b11f05996155962215928d14c28cd841b0874bbf19ce09d1aa6149e7831f4de69e11ce09cad94daf8837ae94a2387173bb20c5f38c198
+  metadata.gz: ece7587ed9528ca583e61645bc3e5e9fcb710f37308ebbc8bb278390966e8edec6e8dc0a282fbb5864893623da631a1d4f3bffc0876dd484d3523e8008c90c11
+  data.tar.gz: 9ccdf791f1c7b6c5f10674753ecfbbfb81b4fa69546057e8061b8c0c269c347999503cb4fc868a215073e70cd6b8cb1382c39bcccfb8c11a0fcd2a346601f82d

data/lib/feature_flagger.rb

@@ -4,6 +4,7 @@ require 'feature_flagger/version'
 require 'feature_flagger/storage/redis'
 require 'feature_flagger/control'
 require 'feature_flagger/model'
+require 'feature_flagger/model_settings'
 require 'feature_flagger/feature'
 require 'feature_flagger/configuration'
 require 'feature_flagger/manager'

data/lib/feature_flagger/model.rb

@@ -13,44 +13,54 @@ module FeatureFlagger
     end
 
     def released?(*feature_key)
-      self.class.released_id?(id, feature_key)
+      self.class.released_id?(feature_flagger_identifier, feature_key)
     end
 
     def release(*feature_key)
-      self.class.release_id(id, *feature_key)
+      self.class.release_id(feature_flagger_identifier, *feature_key)
     end
 
     def unrelease(*feature_key)
-      resource_name = self.class.rollout_resource_name
+      resource_name = self.class.feature_flagger_model_settings.entity_name
       feature = Feature.new(feature_key, resource_name)
       FeatureFlagger.control.unrelease(feature.key, id)
     end
 
+    private
+
+    def feature_flagger_identifier
+      public_send(self.class.feature_flagger_model_settings.identifier_field)
+    end
+
     module ClassMethods
+      def feature_flagger
+        raise ArgumentError unless block_given?
+        yield feature_flagger_model_settings
+      end
 
       def released_id?(resource_id, *feature_key)
-        feature = Feature.new(feature_key, rollout_resource_name)
+        feature = Feature.new(feature_key, feature_flagger_model_settings.entity_name)
         FeatureFlagger.control.released?(feature.key, resource_id)
       end
 
       def release_id(resource_id, *feature_key)
-        feature = Feature.new(feature_key, rollout_resource_name)
+        feature = Feature.new(feature_key, feature_flagger_model_settings.entity_name)
         FeatureFlagger.control.release(feature.key, resource_id)
       end
 
       def all_released_ids_for(*feature_key)
         feature_key.flatten!
-        feature = Feature.new(feature_key, rollout_resource_name)
+        feature = Feature.new(feature_key, feature_flagger_model_settings.entity_name)
         FeatureFlagger.control.resource_ids(feature.key)
       end
 
       def release_to_all(*feature_key)
-        feature = Feature.new(feature_key, rollout_resource_name)
+        feature = Feature.new(feature_key, feature_flagger_model_settings.entity_name)
         FeatureFlagger.control.release_to_all(feature.key)
       end
 
       def unrelease_to_all(*feature_key)
-        feature = Feature.new(feature_key, rollout_resource_name)
+        feature = Feature.new(feature_key, feature_flagger_model_settings.entity_name)
         FeatureFlagger.control.unrelease_to_all(feature.key)
       end
 
@@ -59,18 +69,19 @@ module FeatureFlagger
       end
 
       def released_to_all?(*feature_key)
-        feature = Feature.new(feature_key, rollout_resource_name)
+        feature = Feature.new(feature_key, feature_flagger_model_settings.entity_name)
         FeatureFlagger.control.released_to_all?(feature.key)
       end
 
       def detached_feature_keys
+        rollout_resource_name = feature_flagger_model_settings.entity_name
         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)
+        complete_feature_key = feature_key.map(&:to_s).insert(0, feature_flagger_model_settings.entity_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(':'))
@@ -85,6 +96,17 @@ module FeatureFlagger
         klass_name.downcase!
         klass_name
       end
+
+      def feature_flagger_model_settings
+        @feature_flagger_model_settings ||= FeatureFlagger::ModelSettings.new(
+          identifier_field: :id,
+          entity_name: rollout_resource_name
+        )
+      end
+
+      def feature_flagger_identifier
+        public_send(feature_flagger_model_settings.identifier_field)
+      end
     end
   end
 end

data/lib/feature_flagger/model_settings.rb

@@ -0,0 +1,36 @@
+module FeatureFlagger
+  class ModelSettings
+    def initialize(arguments)
+      arguments.each do |field, value|
+        self.public_send("#{field}=", value)
+      end
+    end
+
+    # Public: identifier_field Refers to which field must represent the unique model
+    # id.
+    attr_accessor :identifier_field
+
+    # Public: entity_name to which entity the model is targeting.
+    # Take this yaml file as example:
+    # 
+    # account:
+    #   email_marketing:
+    #       whitelabel:
+    #         description: a rollout
+    #         owner: core
+    # account_in_migration:
+    #   email_marketing:
+    #       whitelabel:
+    #         description: a rollout
+    #         owner: core
+    #
+    # class Account < ActiveRecord::Base
+    #   include FeatureFlagger::Model
+    #
+    #   feature_flagger do |config|
+    #     config.identifier_field = :cdp_tenant_id
+    #     config.entity_name = :account_in_migration
+    #   end
+    attr_accessor :entity_name
+  end
+end

data/lib/feature_flagger/version.rb

@@ -1,3 +1,3 @@
 module FeatureFlagger
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: feature_flagger
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Nando Sousa
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-09 00:00:00.000000000 Z
+date: 2019-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -111,6 +111,7 @@ files:
 - lib/feature_flagger/feature.rb
 - lib/feature_flagger/manager.rb
 - lib/feature_flagger/model.rb
+- lib/feature_flagger/model_settings.rb
 - lib/feature_flagger/railtie.rb
 - lib/feature_flagger/storage/redis.rb
 - lib/feature_flagger/version.rb
@@ -134,7 +135,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.0.3
+rubyforge_project: 
+rubygems_version: 2.7.9
 signing_key: 
 specification_version: 4
 summary: Partial release your features.