torm 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf7d146ecc3d6ebd40de586588fefc52a94d4552
-  data.tar.gz: c861e3383026631ec4c2e293555e16c30963bb5f
+  metadata.gz: 7d836591fc7a86a288f8571e032ee400b2f0f54f
+  data.tar.gz: 1b6d4c109b4ec5fb035b87c4187c25e4efc17019
 SHA512:
-  metadata.gz: d55a9a923f5fb23af03694b42e01c6bad1c295f4e0529be376832c71b6e9054ab2d4816c4cf99fbe22dfb729ea832c745b74a23e1909da904eee0e493606eb72
-  data.tar.gz: 43d60da6351014ab2576d994c60333e17749883801fa1aaadc8078166860120abadbc7e45254a649b8130933f23ff747ced466fab8f744a883575af2da4bde93
+  metadata.gz: 3944504f6b1263b60382ea19422484372630907caaccebdb64adce3cd3bb13d73d55c96ba32874b14ff4b7c3872e44619a505722f74341776d7e10dca5fd1670
+  data.tar.gz: 843de465105451cb798e027ab185b8d6316c9b2b4e805bad5a0acb0fafba6334776404e793e49bea554dd3839ba1cf02adf1db23a70d9fc0c7ea69f1502e1115

data/README.md

@@ -29,12 +29,25 @@ Torm.default_rules_file = Rails.root.join('tmp/my_rules.json').to_s
 # Torm.set_defaults will load an engine if a rules file exists, otherwise you get an empty engine.
 # Add rules, then after the block it will automatically save the rules file when new rules were changed.
 Torm.set_defaults do |engine|
-  # Add a new rule named 'Happy', with a 'default' policy value of true
+  # Setup custom priorities. Higher priority rules take precedence over lower ones.
+  engine.priorities = [:high, :medium, :low, :default]
+
+  # Add a new rule named 'Happy', with a value of true as 'default' policy
   engine.add_rules 'Happy', true, :default do |rule|
-    # Add a variant on the 'Happy' rule: we're not happy when it rains
-    rule.variant false, :default, rain: true
-    # Another variant. Due to the abundance of rain, in Great Britain the law dictates you're still happy when it rains.
-    rule.variant true, :law, rain: true, country: 'GB'
+    # Setup general conditions for the rest of the block
+    rule.conditions rain: true do |rule|
+      # By default, nobody likes rain...
+      rule.variation false, :default
+      # ...except for the Brits. They love rain :-)
+      rule.variation true, :high, country: 'GB'
+
+      rule.conditions umbrella: true do |rule|
+        # People with an umbrella don't mind rain.
+        rule.variation true, :high
+        # Red umbrellas still make people grumpy, though.
+        rule.variation false, :medium, umbrella_color: :red
+      end
+    end
   end
 end
 

data/lib/torm/rules_engine.rb

@@ -23,6 +23,12 @@ module Torm
 
     # Add a new rule.
     # Will mark the engine as dirty when a rules was added.
+    #
+    # @param [String] name
+    # @param [true, false, String, Numeric, Range, Hash] value Either a simple type, or a Range, or a Hash with a :minimum or :maximum key to represent a Range extreme.
+    # @param [Symbol] policy The source of the rule and thus how heavy it weighs.
+    # @param [Hash] conditions Conditions that must be met before a rule evaluates to return this value.
+    #
     # @return [Torm::RulesEngine] (self) Returns the engine that rules were added to.
     def add_rule(name, value, policy, conditions={})
       raise "Illegal policy: #{policy.inspect}, must be one of: #{policies.inspect}" unless policies.include?(policy)
@@ -41,16 +47,41 @@ module Torm
 
     # Simple helper class to add the block DSL to add_rules
     class RuleVariationHelper
-      def initialize(engine, name)
+      def initialize(engine, name, **conditions)
         @engine = engine
         @name = name
+        @conditions = conditions
       end
 
       def variation(value, policy, **conditions)
-        @engine.add_rule(@name, value, policy, conditions)
+        @engine.add_rule(@name, value, policy, @conditions.merge(conditions))
+        nil
+      end
+
+      # @yield [Torm::RulesEngine::RulesVariationHelper]
+      def conditions(**conditions)
+        engine = self.class.new(@engine, @name, @conditions.merge(conditions))
+        yield engine
+        nil
       end
     end
 
+    # Add multiple rules via the block syntax:
+    #
+    # @example
+    #
+    #   engine = Torm::RulesEngine.new
+    #   engine.add_rules 'Happy', true, :default do |rule|
+    #     rule.variant false, :default, rain: true
+    #   end
+    #
+    # @param [String] name
+    # @param [true, false, String, Numeric, Range, Hash] value Either a simple type, or a Range, or a Hash with a :minimum or :maximum key to represent a Range extreme.
+    # @param [Symbol] policy The source of the rule and thus how heavy it weighs.
+    #
+    # @yield [Torm::RulesEngine::RuleVariationHelper]
+    #
+    # @return [Torm::RulesEngine] Returns self
     def add_rules(name, value, policy)
       # Add the default rule
       add_rule(name, value, policy)

data/lib/torm/version.rb

@@ -1,3 +1,3 @@
 module Torm
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/test/torm/rules_engine_test.rb

@@ -101,8 +101,8 @@ describe Torm::RulesEngine do
       end
     end
 
-    describe '#add_rules block syntax with #variation' do
-      it 'should just work' do
+    describe '#add_rules block syntax' do
+      it 'should yield an object that responds to :variation to add rules' do
         engine.add_rules 'Happy', true, :default do |rule|
           # Nobody likes rain...
           rule.variation false, :default, rain: true
@@ -111,9 +111,34 @@ describe Torm::RulesEngine do
         end
 
         assert engine.decide('Happy')
-        assert !engine.decide('Happy', rain: true)
+        refute engine.decide('Happy', rain: true)
         assert engine.decide('Happy', rain: true, country: 'GB')
       end
+
+      it 'should yield an object that responds to :conditions to yield a block with those conditions applied' do
+        engine.add_rules 'Happy', true, :default do |rule|
+          # Setup general conditions for the entire block
+          rule.conditions rain: true do |rule|
+            # Nobody likes rain...
+            rule.variation false, :default
+            # ...except for the Brits :-)
+            rule.variation true, :law, country: 'GB'
+
+            rule.conditions umbrella: true do |rule|
+              # ...or people with an umbrella
+              rule.variation true, :law
+              # Red umbrellas still make people grumpy, though.
+              rule.variation false, :law, umbrella_color: :red
+            end
+          end
+        end
+
+        assert engine.decide('Happy')
+        refute engine.decide('Happy', rain: true)
+        assert engine.decide('Happy', rain: true, country: 'GB')
+        assert engine.decide('Happy', rain: true, umbrella: true)
+        refute engine.decide('Happy', rain: true, umbrella: true, umbrella_color: :red)
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: torm
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Wes Oldenbeuving
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-24 00:00:00.000000000 Z
+date: 2014-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json