togls 3.0.0.pre.rc.5 → 3.0.0.pre.rc.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d5cfdb23f6d9ccbe350c2873ced5a0a92cd8113
-  data.tar.gz: 8d6b8a61e178ebbfb7bf2bfa0c6b2adb411a8c36
+  metadata.gz: 2ee73b04334051fd4cfa74b24dd639181dd80433
+  data.tar.gz: a28ffbf8cfa7968d31d755f250ba287f3ec4ad05
 SHA512:
-  metadata.gz: 83a2799fbead2f62efaa7755d56133566e548e968d0fd77d9d728e506f6f15fd615c9f31802ce8ea1ce3f42d6077a4e1c2df2156970126a423d0c4b8294c3e79
-  data.tar.gz: 1f2f5a523c90a468790f427eb0c6f95b079e86cd9ed39f7936192495b6565740a23d4831648dd5f5ac6bc8693b7515cfe915aa8aa9d3f318793da287dcfc71f6
+  metadata.gz: e5d9044189ee0e1ea1f19ce740da3bef438f01d4e0ae8b462b72d0a25eaa0db6cfc5f4c71efced54b2e4d2d3aa8aa5fc6486beb525575b26cfb69f4b59f9ab99
+  data.tar.gz: ee82fe7033ff9de9b91e062ff395886b8167897f0853d25bc8448ef92f6d3c45eece901478cceb1f88014b2264e01535022eb937b9ee7df9668b37e116a8f0dd

data/CHANGELOG.md

@@ -10,6 +10,7 @@ that you can set version constraints properly.
 
 #### [Unreleased] - now
 
+* `Changed`: Rules to be identified by an abstract given string id
 * `Changed`: Rule and Rule Type management to be global under Togls
 * `Changed`: The testing interface to allow for contract enforcement in tests
   and allow altering existing feature rules within tests.

data/lib/togls/null_toggle.rb

@@ -18,6 +18,5 @@ module Togls
     end
   end
 
-  class ToggleMissingToggle < NullToggle; end
   class RuleFeatureMismatchToggle < NullToggle; end
 end

data/lib/togls/rule.rb

@@ -4,7 +4,7 @@ module Togls
   # The Rule is an abstract base class that is intended to act as an interface
   # for other rules to be implemented against.
   class Rule
-    attr_reader :data, :type_id
+    attr_reader :data, :type_id, :id
 
     def self.title
       raise Togls::NotImplemented, "Rule type title not implemented"
@@ -18,7 +18,8 @@ module Togls
       Togls::TargetTypes::NOT_SET
     end
 
-    def initialize(type_id, data = nil, target_type: Togls::TargetTypes::NOT_SET)
+    def initialize(id, type_id, data = nil, target_type: Togls::TargetTypes::NOT_SET)
+      @id = id
       @type_id = type_id
       @data = data
       @target_type = target_type
@@ -29,10 +30,6 @@ module Togls
       raise Togls::NotImplemented, "Rule's #run method must be implemented"
     end
 
-    def id
-      Togls::Helpers.sha1(@type_id, @data, target_type)
-    end
-
     def target_type
       return @target_type if @target_type && @target_type != Togls::TargetTypes::NOT_SET
       return self.class.target_type unless self.class.target_type.nil?

data/lib/togls/rule_manager.rb

@@ -14,8 +14,8 @@ module Togls
         rule_type_registry.get(type_id)
       end
 
-      def rule(type_id, data = nil, target_type: Togls::TargetTypes::NOT_SET)
-        rule_type(type_id).new(type_id, data, target_type: target_type)
+      def rule(id, type_id, data = nil, target_type: Togls::TargetTypes::NOT_SET)
+        rule_type(type_id).new(id, type_id, data, target_type: target_type)
       end
 
       private

data/lib/togls/rule_repository.rb

@@ -18,14 +18,15 @@ module Togls
     def store(rule)
       rule_data = extract_storage_payload(rule)
       @drivers.each do |driver|
-        driver.store(rule.id, rule_data)
+        driver.store(rule.id.to_s, rule_data)
       end
     end
 
     def extract_storage_payload(rule)
       {
+        'id' => rule.id.to_s,
         'type_id' => ::Togls.send(:rule_type_registry).get_type_id(rule.class.to_s),
-        'data' => rule.data, 
+        'data' => rule.data,
         'target_type' => rule.target_type.to_s
       }
     end
@@ -51,14 +52,14 @@ module Togls
         raise Togls::RepositoryRuleDataInvalid, "None of the rule repository drivers claim to have the rule"
       end
 
-      ['type_id', 'data', 'target_type'].each do |k|
+      ['id', 'type_id', 'data', 'target_type'].each do |k|
         if !rule_data.has_key? k
           Togls.logger.debug "One of the rule repository drivers returned rule data that is missing the '#{k}'"
           raise Togls::RepositoryRuleDataInvalid, "One of the rule repository drivers returned rule data that is missing the '#{k}'"
         end
       end
 
-      ['type_id', 'target_type'].each do |k|
+      ['id', 'type_id', 'target_type'].each do |k|
         if !rule_data[k].is_a?(String)
           Togls.logger.debug "One of the rule repository drivers returned rule data with '#{k}' not being a string"
           raise Togls::RepositoryRuleDataInvalid, "One of the rule repository drivers returned rule data with '#{k}' not being a string"
@@ -69,10 +70,11 @@ module Togls
     def reconstitute_rule(rule_data)
       if rule_data.has_key?('target_type')
         ::Togls.rule_type(rule_data['type_id'])\
-          .new(rule_data['type_id'].to_sym, rule_data['data'],
+          .new(rule_data['id'].to_sym, rule_data['type_id'].to_sym, rule_data['data'],
                target_type: rule_data['target_type'].to_sym)
       else
-        ::Togls.rule_type(rule_data['type_id']).new(rule_data['type_id'].to_sym,
+        ::Togls.rule_type(rule_data['type_id']).new(rule_data['id'].to_sym,
+                                                    rule_data['type_id'].to_sym,
                                                     rule_data['data'])
       end
     end

data/lib/togls/rule_repository_drivers/env_override_driver.rb

@@ -9,12 +9,12 @@ module Togls
       end
 
       def get(rule_id)
-        boolean_false = Togls::Rules::Boolean.new(:boolean, false)
-        boolean_true = Togls::Rules::Boolean.new(:boolean, true)
-        if rule_id == boolean_true.id
-          return { 'type_id' => 'boolean', 'data' => true, 'target_type' => Togls::TargetTypes::NONE.to_s }
-        elsif rule_id == boolean_false.id
-          return { 'type_id' => 'boolean', 'data' => false, 'target_type' => Togls::TargetTypes::NONE.to_s }
+        boolean_false = Togls::Rules::Boolean.new(:off, :boolean, false)
+        boolean_true = Togls::Rules::Boolean.new(:on, :boolean, true)
+        if rule_id == boolean_true.id.to_s
+          return { 'id' => 'on', 'type_id' => 'boolean', 'data' => true, 'target_type' => Togls::TargetTypes::NONE.to_s }
+        elsif rule_id == boolean_false.id.to_s
+          return { 'id' => 'off', 'type_id' => 'boolean', 'data' => false, 'target_type' => Togls::TargetTypes::NONE.to_s }
         else
           nil
         end

data/lib/togls/rules/boolean.rb

@@ -6,7 +6,7 @@ module Togls
     # it's initialization data and when evaluated determines the toggle state
     # based on the initialization value. Example:
     #
-    # always_on = Togls::Rules::Boolean.new(:boolean, true)
+    # always_on = Togls::Rules::Boolean.new(:on, :boolean, true)
     # Togls.features do
     #   feature(:foo).on(always_on)
     # end
@@ -25,9 +25,9 @@ The Boolean rule type is the base line rule for Togls. It allows you to
 flag a feature on/off by specifing a boolean value as the initialization
 data. For example:
 
-Togls::Rules::Boolean.new(:boolean, true) # rule that always evaluates to on
+Togls::Rules::Boolean.new(:on, :boolean, true) # rule that always evaluates to on
 
-Togls::Rules::Boolean.new(:boolean, false) # rule that always evaluates to off
+Togls::Rules::Boolean.new(:off, :boolean, false) # rule that always evaluates to off
         }
       end
 

data/lib/togls/toggle.rb

@@ -9,7 +9,7 @@ module Togls
 
     def initialize(feature)
       @feature = feature
-      @rule = Togls::Rules::Boolean.new(:boolean, false)
+      @rule = Togls::Rules::Boolean.new(:off, :boolean, false)
     end
 
     def id

data/lib/togls/toggle_registry.rb

@@ -31,15 +31,7 @@ module Togls
     end
 
     def get(key)
-      toggle = @toggle_repository.get(key.to_s)
-      if toggle.is_a?(Togls::ToggleMissingToggle)
-        Togls.logger.warn("Feature identified by '#{key}' has not been defined")
-      end
-      toggle
-    end
-
-    def all
-      @toggle_repository.all
+      @toggle_repository.get(key.to_s)
     end
   end
 end

data/lib/togls/toggle_repository.rb

@@ -25,13 +25,18 @@ module Togls
     end
 
     def extract_storage_payload(toggle)
-      { 'feature_id' => toggle.feature.id, 'rule_id' => toggle.rule.id }
+      { 'feature_id' => toggle.feature.id, 'rule_id' => toggle.rule.id.to_s }
     end
 
     def get(id)
-      toggle_data = fetch_toggle_data(id)
-      return reconstitute_toggle(toggle_data) if toggle_data
-      Togls::ToggleMissingToggle.new
+      @drivers.reverse.each do |driver|
+        toggle_data = driver.get(id)
+        if toggle_data
+          toggle = reconstitute_toggle(toggle_data)
+          return toggle unless toggle.is_a?(::Togls::NullToggle)
+        end
+      end
+      Togls::NullToggle.new
     end
 
     def reconstitute_toggle(toggle_data)
@@ -56,30 +61,5 @@ module Togls
         return Togls::RuleFeatureMismatchToggle.new
       end
     end
-
-    def fetch_toggle_data(id)
-      toggle_data = nil
-      @drivers.reverse.each do |driver|
-        toggle_data = driver.get(id)
-        break if toggle_data
-      end
-      toggle_data
-    end
-
-    def fetch_all_toggle_data
-      toggle_data_collection = {}
-      @drivers.each do |driver|
-        toggle_data_collection.merge!(driver.all)
-      end
-      toggle_data_collection
-    end
-
-    def all
-      toggle_data_collection = fetch_all_toggle_data.values
-
-      toggle_data_collection.map do |toggle_data|
-        reconstitute_toggle(toggle_data)
-      end
-    end
   end
 end

data/lib/togls/toggle_repository_drivers/env_override_driver.rb

@@ -23,19 +23,15 @@ module Togls
         return nil if ENV[toggle_env_key(toggle_id)].nil?
         if ENV[toggle_env_key(toggle_id)] == 'true'
           return { 'feature_id' => toggle_id, 'rule_id' =>
-                   Togls::Rules::Boolean.new(:boolean, true).id }
+                   Togls::Rules::Boolean.new(:on, :boolean, true).id.to_s }
         elsif ENV[toggle_env_key(toggle_id)] == 'false'
           return { 'feature_id' => toggle_id, 'rule_id' =>
-                   Togls::Rules::Boolean.new(:boolean, false).id }
+                   Togls::Rules::Boolean.new(:off, :boolean, false).id.to_s }
         else
           return nil
         end
       end
 
-      def all
-        {}
-      end
-
       private
 
       def toggle_env_key(toggle_id)

data/lib/togls/toggle_repository_drivers/in_memory_driver.rb

@@ -27,14 +27,6 @@ module Togls
           end
         end
       end
-
-      def all
-        result = {}
-        @toggles_lock.synchronize do
-          @toggles.each_pair { |k, v| result[k] = Marshal.load(v) }
-        end
-        result
-      end
     end
   end
 end

data/lib/togls/toggler.rb

@@ -14,14 +14,14 @@ module Togls
     end
 
     def on(rule = nil)
-      rule = Togls::Rules::Boolean.new(:boolean, true) if rule.nil?
+      rule = Togls::Rules::Boolean.new(:on, :boolean, true) if rule.nil?
       @toggle.rule = rule
       @toggle_repository.store(@toggle)
       @toggle
     end
 
     def off
-      rule = Togls::Rules::Boolean.new(:boolean, false)
+      rule = Togls::Rules::Boolean.new(:off, :boolean, false)
       @toggle.rule = rule
       @toggle_repository.store(@toggle)
       @toggle

data/lib/togls/version.rb

@@ -1,3 +1,3 @@
 module Togls
-  VERSION = '3.0.0-rc.5'.freeze
+  VERSION = '3.0.0-rc.6'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: togls
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre.rc.5
+  version: 3.0.0.pre.rc.6
 platform: ruby
 authors:
 - Brian Miller
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-28 00:00:00.000000000 Z
+date: 2016-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler