brule 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13f788107d09cf82f121f314df0fd7247e808d4895a369afc56315aceaa21e84
-  data.tar.gz: 92d514d8305373969d48069d5627432d8d13e136ae0f38f1a94b1368ebbfb63c
+  metadata.gz: 67b697b560f27e984a2ec669e672dee5b1cab777071c88d1b0ea7f1d358e4067
+  data.tar.gz: 3d9c7e21ca6fecc1a8b3d1b9120e15894dfc7c7e5ecd055d24fb118fb9ee11e2
 SHA512:
-  metadata.gz: fba662d4ee2caaffba41aba4368069c1ab1aab6730fcd0b84a73a7158a799e1e34149eac0f7e37627a56bf9c16ea0f4af26298e0ef15ce0a76df0487ddbcf895
-  data.tar.gz: 4f798d703d68a4e109b19c69469e1c86c2d16762ba45bb3cacc5cbf8ec3fe61ea64d57e1d942428d488655ea24068a541f79875071d2b3578f66d13bec02432b
+  metadata.gz: b7b7e87db8e466cda35e0330774818f03a75ce5d925f4dcdc394e0bdb1751a5037141bf4490cd602434d3ee56caee16526b40b3fb3fb9d8ddf4e19224a029032
+  data.tar.gz: 21d8166b5a3aac5cc63ef8cd1414bd2defc05eab1548d85697081d1c3d678ffc42cf9ac960399a61308db6fb99fa60e7e60610a4490ea25d1b33aa8dad13b649

data/README.md

@@ -1,11 +1,11 @@
-This project aims at providing a set of tools to build somehow complex
-business processes or rules. It helps when:
+This project aims at providing a set of tools to build complex and evolving
+business rules. It helps when:
 
-* You decided to split the process into smaller parts working together.
-* You need to keep the rules evolving while maintaining the old versions.
-* You want to persist the rules that lead to the result of a process.
+* You decided to split the computation into smaller parts working together.
+* You need to keep old versions of the rules working.
+* You want to persist the rules leading to a result.
 * You want to make your tests independent from your production data.
-* You want to introspect what lead to the result of a process.
+* You want to introspect the computation of a result.
 
 ## How does it work
 
@@ -50,7 +50,7 @@ module Pricing
   end
 
   class OrderTotal < Brule::Rule
-    config_reader :unit_price, :item_count
+    context_reader :unit_price, :item_count
     context_writer :price
 
     def apply

data/lib/brule.rb

@@ -1,98 +1,8 @@
 # frozen_string_literal: true
 
-require 'forwardable'
-
 module Brule
-  module RuleHelpers
-    def context_reader(*symbols)
-      symbols.each do |symbol|
-        define_method(symbol) { context.fetch(symbol) }
-      end
-    end
-
-    def context_writer(*symbols)
-      symbols.each do |symbol|
-        define_method("#{symbol}=") { |value| context[symbol] = value }
-      end
-    end
-
-    def context_accessor(*symbols)
-      context_reader(*symbols)
-      context_writer(*symbols)
-    end
-
-    def config_reader(*symbols)
-      symbols.each do |symbol|
-        define_method(symbol) { config.fetch(symbol) }
-      end
-    end
-  end
-
-  Rule = Struct.new(:config) do
-    extend RuleHelpers
-
-    attr_accessor :context
-
-    def trigger?
-      true
-    end
-
-    def apply
-      raise NotImplementedError
-    end
-  end
-
-  class Context
-    extend Forwardable
-
-    def_delegators :@content, :[], :fetch, :fetch_values, :key?, :[]=, :merge!
-
-    def self.wrap(context)
-      context.is_a?(self) ? context : new(context)
-    end
-
-    def initialize(hash = {})
-      @content = hash
-    end
-
-    def initialize_copy(orig)
-      super
-      @content = orig.instance_variable_get(:@content).dup
-    end
-  end
-
-  class Engine
-    attr_reader :context
-
-    def initialize(rules:)
-      @rules = rules
-      @history = {}
-    end
-
-    def call(context = {})
-      @history = {}
-      @context = Context.wrap(context)
-      snapshot!(tag: :initial)
-      @rules.each { |rule| apply(rule) }
-      result
-    end
-
-    def history(key:)
-      @history.map { |tag, content| [tag, content.fetch(key, nil)] }
-    end
-
-    private
-
-    def snapshot!(tag:)
-      @history[tag] = @context.dup
-    end
-
-    def apply(rule)
-      rule.context = @context
-      return unless rule.trigger?
-
-      rule.apply
-      snapshot!(tag: rule)
-    end
-  end
+  autoload :Context, 'brule/context'
+  autoload :Engine, 'brule/engine'
+  autoload :Rule, 'brule/rule'
+  autoload :Utils, 'brule/utils'
 end

data/lib/brule/context.rb

@@ -0,0 +1,22 @@
+require 'forwardable'
+
+module Brule
+  class Context
+    extend Forwardable
+
+    def_delegators :@content, :[], :fetch, :fetch_values, :key?, :[]=, :merge!
+
+    def initialize(hash = {})
+      @content = hash
+    end
+
+    def initialize_copy(orig)
+      super
+      @content = orig.instance_variable_get(:@content).dup
+    end
+
+    def self.wrap(context)
+      context.is_a?(self) ? context : new(context)
+    end
+  end
+end

data/lib/brule/engine.rb

@@ -0,0 +1,36 @@
+module Brule
+  class Engine
+    attr_reader :context
+
+    def initialize(rules:)
+      @rules = rules
+      @history = {}
+    end
+
+    def call(context = {})
+      @history = {}
+      @context = Context.wrap(context)
+      snapshot!(tag: :initial)
+      @rules.each { |rule| apply(rule) }
+      result
+    end
+
+    def history(key:)
+      @history.map { |tag, content| [tag, content.fetch(key, nil)] }
+    end
+
+    private
+
+    def snapshot!(tag:)
+      @history[tag] = @context.dup
+    end
+
+    def apply(rule)
+      rule.context = @context
+      return unless rule.trigger?
+
+      rule.apply
+      snapshot!(tag: rule.to_tag)
+    end
+  end
+end

data/lib/brule/rule.rb

@@ -0,0 +1,40 @@
+module Brule
+  Rule = Struct.new(:config) do
+    attr_accessor :context
+
+    def trigger?
+      true
+    end
+
+    def apply
+      raise NotImplementedError
+    end
+
+    def to_tag
+      self
+    end
+
+    def self.context_reader(*symbols)
+      symbols.each do |symbol|
+        define_method(symbol) { context.fetch(symbol) }
+      end
+    end
+
+    def self.context_writer(*symbols)
+      symbols.each do |symbol|
+        define_method("#{symbol}=") { |value| context[symbol] = value }
+      end
+    end
+
+    def self.context_accessor(*symbols)
+      context_reader(*symbols)
+      context_writer(*symbols)
+    end
+
+    def self.config_reader(*symbols)
+      symbols.each do |symbol|
+        define_method(symbol) { config.fetch(symbol) }
+      end
+    end
+  end
+end

data/lib/brule/utils.rb

@@ -0,0 +1,5 @@
+module Brule
+  module Utils
+    autoload :Either, 'brule/utils/either'
+  end
+end

data/lib/brule/utils/either.rb

@@ -0,0 +1,35 @@
+require 'forwardable'
+
+module Brule
+  module Utils
+    class Either < Brule::Rule
+      TooManyMatches = Class.new(StandardError)
+      NoMatchFound = Class.new(StandardError)
+
+      extend Forwardable
+
+      def_delegators :only_match, :apply, :trigger?, :to_tag
+
+      config_reader :rules
+
+      private
+
+      def only_match
+        matches = rules.select do |rule|
+          rule.context = context
+          rule.trigger?
+        end
+
+        if matches.size >= 2
+          raise TooManyMatches, "Rules #{matches.join(', ')} are all a match"
+        end
+
+        if matches.empty?
+          raise NoMatchFound, "No rules from #{rules.join(', ')} is a match"
+        end
+
+        matches.first
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brule
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Nicolas Zermati
@@ -46,6 +46,11 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/brule.rb
+- lib/brule/context.rb
+- lib/brule/engine.rb
+- lib/brule/rule.rb
+- lib/brule/utils.rb
+- lib/brule/utils/either.rb
 homepage: https://github.com/nicoolas25/brule-rb
 licenses:
 - MIT