brule 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67b697b560f27e984a2ec669e672dee5b1cab777071c88d1b0ea7f1d358e4067
-  data.tar.gz: 3d9c7e21ca6fecc1a8b3d1b9120e15894dfc7c7e5ecd055d24fb118fb9ee11e2
+  metadata.gz: 86b2ca827bc1365eda3e1c2be029086dcbd7777bd70a2ead29469c502d171a13
+  data.tar.gz: bc97f46ef11b350b664e6278b9978d75ed85f703681e0e7e896aafe853f55888
 SHA512:
-  metadata.gz: b7b7e87db8e466cda35e0330774818f03a75ce5d925f4dcdc394e0bdb1751a5037141bf4490cd602434d3ee56caee16526b40b3fb3fb9d8ddf4e19224a029032
-  data.tar.gz: 21d8166b5a3aac5cc63ef8cd1414bd2defc05eab1548d85697081d1c3d678ffc42cf9ac960399a61308db6fb99fa60e7e60610a4490ea25d1b33aa8dad13b649
+  metadata.gz: 3369d8945f69fe5334338550207943dd4a200bcbf3ddae031cbed2fa1101dbecacb5f06c38d9999d80d9fbd0d2c5f08da9ce5ad5e3bcec6ea3ddef844c5b31ff
+  data.tar.gz: 5d74c2c6bb63d900b8cff010d5a8266dc7226ab614820c827f808d3c0a6370c297f8e3188f9d9bdde3186cb280dd627aac2dda253cd643ab09c82899dd0bd87c

data/README.md

@@ -9,23 +9,26 @@ business rules. It helps when:
 
 ## How does it work
 
-If you use this gem, you'll have a couple of premade elements to build and test
-an _engine_ that, given a set of _rules_ and a _context_ will produce a
-_result_.
+The idea is very similar to function composition or Rack's middlewares. It is a
+layering abstraction where each layer works for the next layers in order for the
+whole to produce a single result.
+
+An _engine_ respond to `#call`, taking a `context` in argument. It produces a
+_result_ that is extracted from the _context_ by the `#result` method. Before
+doing that, the engine apply its _rules_.
+
+![Engine](https://github.com/nicoolas25/brule-rb/blob/master/docs/img/engine.png?raw=true)
+
+Each rule have two methods: `#trigger?` and `#apply`. `#apply` runs only when
+`trigger?` is true. `#apply` writes stuff to the context for other rules and
+for the engine to produce the result.
+
+![Rule](https://github.com/nicoolas25/brule-rb/blob/master/docs/img/rule.png?raw=true)
 
 A typical usage for this kind of engine is to use it to compute the price of a
 service or a good. But, this is not limited to that use-case as an engine
 would be able to produce any kind of results.
 
-An _engine_ orchestrate _rules_ in a way that they would produce enough
-information for the engine to assemble a _result_. The rules are arranged in an
-ordered sequence and are picked depending on the _context_. Each rule will write
-in the context too.
-
-The idea is very similar to function composition or Rack's middlewares. It is a
-layering abstraction where each layer works for the next layers in order for the
-stack to produce a single value.
-
 ## How does it look
 
 Here is an example from the [Elephant Carpaccio][elephant] kata. The specs are:

data/lib/brule.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Brule
-  autoload :Context, 'brule/context'
   autoload :Engine, 'brule/engine'
   autoload :Rule, 'brule/rule'
   autoload :Utils, 'brule/utils'

data/lib/brule/engine.rb

@@ -9,7 +9,7 @@ module Brule
 
     def call(context = {})
       @history = {}
-      @context = Context.wrap(context)
+      @context = context
       snapshot!(tag: :initial)
       @rules.each { |rule| apply(rule) }
       result

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brule
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Nicolas Zermati
@@ -46,7 +46,6 @@ 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

data/lib/brule/context.rb

@@ -1,22 +0,0 @@
-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