togls 3.0.0.pre.rc.2 → 3.0.0.pre.rc.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cbf5465b03534a0ea73b226ffacf1bc01825eb9
-  data.tar.gz: f624a8d851aa5b59d69f5d5437f9409f7d987c3e
+  metadata.gz: 05024ddd358a85a71a6c2a321ca23e6dc1f1a54f
+  data.tar.gz: c0cffcdf9ac3c88225383dd052ebf02497a9d43e
 SHA512:
-  metadata.gz: 4d9a49ca3670eee9ef1c00644060a8ca1b505e516f1d451d363353a81404c3cfb48d18fd9169eb0eedc7db8ebe75d96128b5ed19853b6c69b1f1d60597e34b01
-  data.tar.gz: 699d108793a00c42c8228357ecb3eb4413e64f5b6dacec9ee9ed1704c9dc51dc8402b5647bd8c274b93c6c0befa4ed116a993e2274bddc36ee15f4f4d462b9a5
+  metadata.gz: fcc5a4843465954f936decf0da23c2bdd16fd6683634a791905d700bb18753142b226653d1fcf60b8f695cef103a7f95df81e0d37afce3d9bb58bdcea1d7deff
+  data.tar.gz: 73bd020d13232d401c8b0dc77bcff6096a27b16674a4c5f49710cd093b2817a4287ccedca149213cce81de7ddbc3ae853ab7b874af5d015111005253a8d96f5c

data/CHANGELOG.md

@@ -10,6 +10,7 @@ that you can set version constraints properly.
 
 #### [Unreleased] - now
 
+* `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.
 * `Added`: `Togls.rule` method to simplify rule construction from `type_id`

data/README.md

@@ -52,13 +52,28 @@ how one would define some basic feature toggles.
 ```ruby
 Togls.release do
   # Set this feature to always be on
-  feature(:pop_up_login_form, "use pop up login instead of normal login").on 
+  feature(:pop_up_login_form, "use pop up login instead of normal login").on
 
   # Set this feature to always be off
   feature(:send_follup_email, "send the follow up email").off
 end
 ```
 
+The above defined feature toggles would use
+[default feature target type](https://github.com/codebreakdown/togls/wiki/Abstract-Target-Types#setting-the-default-feature-target-type).
+If we wanted to define them explicitly with other target types it would like as
+follows.
+
+```ruby
+Togls.release do
+  # Set this feature to always be on
+  feature(:pop_up_login_form, "use pop up login instead of normal login", :user_id).on
+
+  # Set this feature to always be off
+  feature(:send_follup_email, "send the follow up email", :user_email_address).off
+end
+```
+
 ### Evaluating Feature Toggles
 
 Once you have defined your feature toggles. The next thing you would
@@ -83,6 +98,28 @@ end
 **Note:** Feature toggles that are evaluated but have **not** been
 defined will default to **off**.
 
+The above two feature toggles evaluated are written as if the feature toggle has
+a target type of `Togls::TargetTypes::NONE`. If the feature toggles had a
+specific target type and they were evaluted as shown above an exception would be
+raised notifying you that they expect an entity of that type as the target for
+evaluation. To better match the explicit target type example from Defining
+Feature Toggles it would look something like the following.
+
+
+```ruby
+if Togls.feature(:pop_up_login_form).on?(current_user.id)
+  # Use pop up login form
+else
+  # Use normal non-pop up login form
+end
+
+...
+
+if Togls.feature(:send_follup_email).on?(current_user.email)
+  # send the follow up email
+end
+```
+
 ### Override Feature Toggles
 
 Toggles can be overriden using environment variables following the
@@ -106,7 +143,11 @@ We could override this by setting the value of the
 to override a feature toggle to an on state you can set the
 `TOGLS_POP_UP_LOGIN_FORM` environment variable to `"true"`.
 
-### Toggle Features based on Group Membership  
+**Note:** This feature is explicitly designed for use in your development
+environment. If you use this feature in other environments (qa, staging,
+production, etc.) it may not behave as you expect.
+
+### Toggle Features based on Group Membership
 
 `togls` provides out of the box support for toggling features based on
 group membership. This basically allows you to have a feature **on** for
@@ -115,10 +156,10 @@ extremely useful if you want to enable features for a small alpha test
 group for example.
 
 **Note:** This is implemented using `togls` extremely robust [custom
-rules](https://github.com/codebreakdown/togls/wiki/Custom-Rules) system.
+rules](https://github.com/codebreakdown/togls/wiki/Custom-Rule-Types-&-Rules) system.
 The following example is just one of the many powerful things you can do
 with `togls` and [custom
-rules](https://github.com/codebreakdown/togls/wiki/Custom-Rules).
+rules](https://github.com/codebreakdown/togls/wiki/Custom-Rule-Types-&-Rules).
 
 #### Defining Group based Feature Toggles
 
@@ -128,11 +169,10 @@ based on group membership.
 ```ruby
 # Create a group rule so the feature is on if the user is a member of
 # the group.
-alpha_testers = Togls::Rules::Group.new(["user1@email.com",
-                                         "user2@example.com"])
+alpha_testers = Togls.rule(:group, ["user1@email.com", "user2@example.com"], target_type: :user_email_address)
 
 Togls.release do
-  feature(:new_contact_form, "use new contact form").on(alpha_testers)
+  feature(:new_contact_form, "use new contact form", target_type: :user_email_address).on(alpha_testers)
 end
 ```
 
@@ -181,10 +221,10 @@ in the example above and it would look something like the following:
 ```ruby
 # Create a group rule so the feature is on if the user is a member of
 # the group.
-alpha_testers = Togls::Rules::Group.new([1, 23, 42, 83])
+alpha_testers = Togls.rule(:group, [1, 23, 42, 83], :user_id)
 
 Togls.release do
-  feature(:new_contact_form, "use new contact form").on(alpha_testers)
+  feature(:new_contact_form, "use new contact form", :user_id).on(alpha_testers)
 end
 ```
 
@@ -213,7 +253,7 @@ Toggles](https://github.com/codebreakdown/togls/wiki/Testing-with-Toggles),
 [Provided Rules
 Reference](https://github.com/codebreakdown/togls/wiki/Provided-Rules-Reference),
 [Custom
-Rules](https://github.com/codebreakdown/togls/wiki/Custom-Rules),
+Rules](https://github.com/codebreakdown/togls/wiki/Custom-Rule-Types-&-Rules),
 [Organize Toggle
 Definitions](https://github.com/codebreakdown/togls/wiki/Organize-Toggle-Definitions),
 [Creating Additional Toggle

data/lib/togls/feature_toggle_registry_manager.rb

@@ -24,19 +24,6 @@ module Togls
         @release_blocks ||= []
       end
 
-      def rule_types(&block)
-        rule_type_registry.expand(&block) if block
-        rule_type_registry
-      end
-
-      def rule_type(type_id)
-        rule_type_registry.get(type_id)
-      end
-
-      def rule(type_id, data, target_type: Togls::TargetTypes::NOT_SET)
-        rule_type(type_id).new(type_id, data, target_type: target_type)
-      end
-
       def feature(key)
         Toggler.new(release_toggle_registry.instance_variable_get(:@toggle_repository), release_toggle_registry.get(key))
       end
@@ -62,38 +49,17 @@ module Togls
 
       private
 
-      def rule_type_repository
-        if @rule_type_repository.nil?
-          rule_type_repository_drivers = [RuleTypeRepositoryDrivers::InMemoryDriver.new]
-          @rule_type_repository = RuleTypeRepository.new(rule_type_repository_drivers)
-        end
-        @rule_type_repository
-      end
-
-      def rule_type_registry
-        if @rule_type_registry.nil?
-          @rule_type_registry = RuleTypeRegistry.new(rule_type_repository)
-          @rule_type_registry.register(:boolean, Togls::Rules::Boolean)
-          @rule_type_registry.register(:group, Togls::Rules::Group)
-        end
-        @rule_type_registry
-      end
-
       def test_toggle_registry
         feature_repository_drivers =
           [Togls::FeatureRepositoryDrivers::InMemoryDriver.new]
         test_feature_repository = Togls::FeatureRepository.new(
           feature_repository_drivers)
 
-        rule_repository_drivers =
-          [Togls::RuleRepositoryDrivers::InMemoryDriver.new]
-        rule_repository = Togls::RuleRepository.new(rule_type_registry, rule_repository_drivers)
-
         toggle_repository_drivers = [
           Togls::ToggleRepositoryDrivers::InMemoryDriver.new]
 
         toggle_repository = Togls::ToggleRepository.new(
-          toggle_repository_drivers, test_feature_repository, rule_repository)
+          toggle_repository_drivers, test_feature_repository)
 
         tr = ToggleRegistry.new(test_feature_repository, toggle_repository)
         release_blocks.each do |p|
@@ -105,12 +71,6 @@ module Togls
 
       def release_toggle_registry
         if @release_toggle_registry.nil?
-          rule_repository_drivers = [
-            Togls::RuleRepositoryDrivers::InMemoryDriver.new,
-            Togls::RuleRepositoryDrivers::EnvOverrideDriver.new
-          ]
-
-          rule_repository = Togls::RuleRepository.new(rule_type_registry, rule_repository_drivers)
 
           toggle_repository_drivers = [
             Togls::ToggleRepositoryDrivers::InMemoryDriver.new,
@@ -118,7 +78,7 @@ module Togls
           ]
 
           toggle_repository = Togls::ToggleRepository.new(
-            toggle_repository_drivers, feature_repository, rule_repository)
+            toggle_repository_drivers, feature_repository)
 
           @release_toggle_registry = ToggleRegistry.new(feature_repository,
                                                         toggle_repository)

data/lib/togls/rule_manager.rb

@@ -0,0 +1,53 @@
+module Togls
+  module RuleManager
+    def self.included(mod)
+      mod.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def rule_types(&block)
+        rule_type_registry.expand(&block) if block
+        rule_type_registry
+      end
+
+      def rule_type(type_id)
+        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)
+      end
+
+      private
+
+      def rule_type_repository
+        if @rule_type_repository.nil?
+          rule_type_repository_drivers = [RuleTypeRepositoryDrivers::InMemoryDriver.new]
+          @rule_type_repository = RuleTypeRepository.new(rule_type_repository_drivers)
+        end
+        @rule_type_repository
+      end
+
+      def rule_type_registry
+        if @rule_type_registry.nil?
+          @rule_type_registry = RuleTypeRegistry.new(rule_type_repository)
+          @rule_type_registry.register(:boolean, Togls::Rules::Boolean)
+          @rule_type_registry.register(:group, Togls::Rules::Group)
+        end
+        @rule_type_registry
+      end
+
+      def rule_repository
+        if @rule_repository.nil?
+          rule_repository_drivers = [
+            Togls::RuleRepositoryDrivers::InMemoryDriver.new,
+            Togls::RuleRepositoryDrivers::EnvOverrideDriver.new
+          ]
+
+          @rule_repository = Togls::RuleRepository.new(rule_repository_drivers)
+        end
+        @rule_repository
+      end
+    end
+  end
+end

data/lib/togls/rule_repository.rb

@@ -5,7 +5,7 @@ module Togls
   # It does these by interfacing with Rule Repository Drivers which are passed
   # in during construction as an Array.
   class RuleRepository
-    def initialize(rule_type_registry, drivers)
+    def initialize(drivers)
       unless drivers.is_a?(Array)
         raise Togls::InvalidDriver, 'RuleRepository requires a valid driver'
       end
@@ -13,7 +13,6 @@ module Togls
         raise Togls::MissingDriver, 'RuleRepository requires a driver'
       end
       @drivers = drivers
-      @rule_type_registry = rule_type_registry
     end
 
     def store(rule)
@@ -25,7 +24,7 @@ module Togls
 
     def extract_storage_payload(rule)
       {
-        'type_id' => @rule_type_registry.get_type_id(rule.class.to_s),
+        'type_id' => ::Togls.send(:rule_type_registry).get_type_id(rule.class.to_s),
         'data' => rule.data, 
         'target_type' => rule.target_type.to_s
       }
@@ -69,11 +68,12 @@ module Togls
 
     def reconstitute_rule(rule_data)
       if rule_data.has_key?('target_type')
-        @rule_type_registry.get(rule_data['type_id'])\
+        ::Togls.rule_type(rule_data['type_id'])\
           .new(rule_data['type_id'].to_sym, rule_data['data'],
                target_type: rule_data['target_type'].to_sym)
       else
-        @rule_type_registry.get(rule_data['type_id']).new(rule_data['type_id'].to_sym, rule_data['data'])
+        ::Togls.rule_type(rule_data['type_id']).new(rule_data['type_id'].to_sym,
+                                                    rule_data['data'])
       end
     end
   end

data/lib/togls/toggle_repository.rb

@@ -3,7 +3,7 @@ module Togls
   #
   # Repository interface for storing and retrieving toggles.
   class ToggleRepository
-    def initialize(drivers, feature_repository, rule_repository)
+    def initialize(drivers, feature_repository)
       unless drivers.is_a?(Array)
         raise Togls::InvalidDriver, 'ToggleRepository requires a valid driver'
       end
@@ -12,12 +12,11 @@ module Togls
       end
       @drivers = drivers
       @feature_repository = feature_repository
-      @rule_repository = rule_repository
     end
 
     def store(toggle)
       @feature_repository.store(toggle.feature)
-      @rule_repository.store(toggle.rule)
+      ::Togls.send(:rule_repository).store(toggle.rule)
       payload = extract_storage_payload(toggle)
 
       @drivers.each do |driver|
@@ -43,7 +42,7 @@ module Togls
       end
 
       begin
-        rule = @rule_repository.get(toggle_data['rule_id'])
+        rule = ::Togls.send(:rule_repository).get(toggle_data['rule_id'])
       rescue Togls::RepositoryRuleDataInvalid => e
         return Togls::NullToggle.new
       end

data/lib/togls/version.rb

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

data/lib/togls.rb

@@ -25,6 +25,7 @@ require 'togls/null_toggle'
 require 'togls/rule'
 require 'togls/rules'
 require 'logger'
+require 'togls/rule_manager'
 require 'togls/feature_toggle_registry_manager'
 require 'togls/default_feature_target_type_manager'
 
@@ -33,6 +34,7 @@ require 'togls/default_feature_target_type_manager'
 # Togls is the primary interface to the out of the box toggle registry. It is
 # the namespace the DSL is exposed under.
 module Togls
+  include RuleManager
   include FeatureToggleRegistryManager
   include DefaultFeatureTargetTypeManager
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: togls
 version: !ruby/object:Gem::Version
-  version: 3.0.0.pre.rc.2
+  version: 3.0.0.pre.rc.3
 platform: ruby
 authors:
 - Brian Miller
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-09 00:00:00.000000000 Z
+date: 2016-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,6 +104,7 @@ files:
 - lib/togls/helpers.rb
 - lib/togls/null_toggle.rb
 - lib/togls/rule.rb
+- lib/togls/rule_manager.rb
 - lib/togls/rule_repository.rb
 - lib/togls/rule_repository_drivers.rb
 - lib/togls/rule_repository_drivers/env_override_driver.rb