brule 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86b2ca827bc1365eda3e1c2be029086dcbd7777bd70a2ead29469c502d171a13
-  data.tar.gz: bc97f46ef11b350b664e6278b9978d75ed85f703681e0e7e896aafe853f55888
+  metadata.gz: 669938141fcd377863b801be38726843c5f1ed81737754e76178923298794541
+  data.tar.gz: aa7e4e0b3c4a84f0ab2c449518097e3519d8ede931f350119946d7beeed11ea0
 SHA512:
-  metadata.gz: 3369d8945f69fe5334338550207943dd4a200bcbf3ddae031cbed2fa1101dbecacb5f06c38d9999d80d9fbd0d2c5f08da9ce5ad5e3bcec6ea3ddef844c5b31ff
-  data.tar.gz: 5d74c2c6bb63d900b8cff010d5a8266dc7226ab614820c827f808d3c0a6370c297f8e3188f9d9bdde3186cb280dd627aac2dda253cd643ab09c82899dd0bd87c
+  metadata.gz: 2e68b2077b6c133989d430b4b8226aea8b06dda3264b0e92892ec2684265350fcc969a9737d290cf32683c50cedee0699331a35c28830cd00b01872272aaf32f
+  data.tar.gz: 44da1bdbecb77ae14b17230997ce3b3b5a47c623ebf86a44836bd8a245f2f12644d152edb2f50f47834e99eed3f5cd2c7dbc072319dab7b9403891cfac16adce

data/README.md

@@ -7,6 +7,8 @@ business rules. It helps when:
 * You want to make your tests independent from your production data.
 * You want to introspect the computation of a result.
 
+![Test](https://github.com/nicoolas25/brule-rb/workflows/Test/badge.svg?branch=master)
+
 ## How does it work
 
 The idea is very similar to function composition or Rack's middlewares. It is a
@@ -21,17 +23,20 @@ doing that, the engine apply its _rules_.
 
 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.
+for the engine to produce the result. Rules can be initialized with a
+_configuration_.
 
 ![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.
 
 ## How does it look
 
-Here is an example from the [Elephant Carpaccio][elephant] kata. The specs are:
+[Here](https://nicoolas25.github.io/brule-rb/examples/elephant_carpaccio.html)
+is an example from the [Elephant Carpaccio][elephant] kata. The specs are:
 
 > Accept 3 inputs from the user:
 >
@@ -42,116 +47,19 @@ Here is an example from the [Elephant Carpaccio][elephant] kata. The specs are:
 > Output the total price. Give a discount based on the total price, add state
 > tax based on the state and the discounted price.
 
-```ruby
-require "brule"
-
-module Pricing
-  class Engine < Brule::Engine
-    def result
-      context.fetch(:price)
-    end
-  end
-
-  class OrderTotal < Brule::Rule
-    context_reader :unit_price, :item_count
-    context_writer :price
-
-    def apply
-      self.price = unit_price * item_count
-    end
-  end
-
-  class Discount < Brule::Rule
-    config_reader :rates
-    context_accessor :price, :discount_rate, :discount_amount
-
-    def trigger?
-      !applicable_discount.nil?
-    end
-
-    def apply
-      self.discount_rate = applicable_discount.last
-      self.discount_amount = (price * discount_rate).ceil
-      self.price = price - discount_amount
-    end
-
-    private
-
-    def applicable_discount
-      rates
-        .sort_by { |order_value, _| order_value * -1 }
-        .find    { |order_value, _| order_value <= context.fetch(:price) }
-    end
-  end
-
-  class StateTax < Brule::Rule
-    config_reader :rates
-    context_reader :state
-    context_accessor :price, :state_tax
-
-    def apply
-      tax_rate = rates.fetch(state)
-      self.state_tax = (price * tax_rate).ceil
-      self.price = price + state_tax
-    end
-  end
-end
-
-require "bigdecimal"
-require "bigdecimal/util"
+[This](https://nicoolas25.github.io/brule-rb/examples/elephant_carpaccio.html)
+is the smallest example and the _best_ one to refer to. More examples are
+available:
 
-engine = Pricing::Engine.new(
-  rules: [
-    Pricing::OrderTotal.new,
-    Pricing::Discount.new(
-      rates: [
-        [  1_000_00, "0.03".to_d ],
-        [  5_000_00, "0.05".to_d ],
-        [  7_000_00, "0.07".to_d ],
-        [ 10_000_00, "0.10".to_d ],
-        [ 50_000_00, "0.15".to_d ],
-      ],
-    ),
-    Pricing::StateTax.new(
-      rates: {
-        "UT" => "0.0685".to_d,
-        "NV" => "0.0800".to_d,
-        "TX" => "0.0625".to_d,
-        "AL" => "0.0400".to_d,
-        "CA" => "0.0825".to_d,
-      },
-    ),
-  ],
-)
-
-result = engine.call(
-  item_count: 100,
-  unit_price: 100_00,
-  state: "NV",
-)
-
-# Access the main result
-result                        # => 9_720_00 ($9,720.00)
-
-# Access the context
-engine.context.fetch_values(
-  :discount_rate,             # =>      0.1 (10%)
-  :discount_amount,           # => 1_000_00 ($1,000.00)
-  :state_tax,                 # =>   720_00 ($720.00)
-)
-
-# Access the history
-engine.history(key: :price)   # => [
-                              # =>   [:initial,                                nil],
-                              # =>   [#<struct Pricing::OrderTotal ...>, 10_000_00],
-                              # =>   [#<struct Pricing::Discount ...>,    9_000_00],
-                              # =>   [#<struct Pricing::StateTax ...>,    9_720_00],
-                              # => ]
-```
+- [Elephant Carpaccio](https://nicoolas25.github.io/brule-rb/examples/elephant_carpaccio.html)
+- [Car rental](https://nicoolas25.github.io/brule-rb/examples/car_rental.html)
+- [Studio rental](https://nicoolas25.github.io/brule-rb/examples/studio_rental.html)
+- [Promo code](https://nicoolas25.github.io/brule-rb/examples/promo_code.html) (WIP)
 
 ## What does it bring to the table
 
-If you compare this approach with a simple method like this one:
+If you compare [this approach](https://nicoolas25.github.io/brule-rb/examples/elephant_carpaccio.html)
+with a simple method like this one:
 
 ```ruby
 require "bigdecimal"

data/lib/brule/engine.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Brule
   class Engine
-    attr_reader :context
+    attr_reader :context, :rules
 
     def initialize(rules:)
       @rules = rules
@@ -19,6 +21,19 @@ module Brule
       @history.map { |tag, content| [tag, content.fetch(key, nil)] }
     end
 
+    def to_hash
+      { 'engine_class' => self.class.name, 'rules' => @rules.map(&:to_hash) }
+    end
+
+    def self.from_hash(hash)
+      engine_class = Object.const_get(hash.fetch('engine_class'))
+      rules = hash.fetch('rules').map do |rule_hash|
+        rule_class = Object.const_get(rule_hash.fetch('rule_class'))
+        rule_class.from_hash(rule_hash)
+      end
+      engine_class.new(rules: rules)
+    end
+
     private
 
     def snapshot!(tag:)

data/lib/brule/rule.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Brule
   Rule = Struct.new(:config) do
     attr_accessor :context
@@ -14,26 +16,38 @@ module Brule
       self
     end
 
-    def self.context_reader(*symbols)
-      symbols.each do |symbol|
-        define_method(symbol) { context.fetch(symbol) }
+    def to_hash
+      config_hash = block_given? ? yield(config) : config&.to_hash
+      { 'rule_class' => self.class.name, 'config' => config_hash }
+    end
+
+    def self.from_hash(hash)
+      raise ArgumentError unless hash.fetch('rule_class') == name
+
+      config_hash = hash.fetch('config')
+      new(block_given? ? yield(config_hash) : config_hash)
+    end
+
+    def self.context_reader(*keys)
+      keys.each do |key|
+        define_method(key) { context.fetch(key) }
       end
     end
 
-    def self.context_writer(*symbols)
-      symbols.each do |symbol|
-        define_method("#{symbol}=") { |value| context[symbol] = value }
+    def self.context_writer(*keys)
+      keys.each do |key|
+        define_method("#{key}=") { |value| context[key] = value }
       end
     end
 
-    def self.context_accessor(*symbols)
-      context_reader(*symbols)
-      context_writer(*symbols)
+    def self.context_accessor(*keys)
+      context_reader(*keys)
+      context_writer(*keys)
     end
 
-    def self.config_reader(*symbols)
-      symbols.each do |symbol|
-        define_method(symbol) { config.fetch(symbol) }
+    def self.config_reader(*keys)
+      keys.each do |key|
+        define_method(key) { config.fetch(key) }
       end
     end
   end

data/lib/brule/utils.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Brule
   module Utils
     autoload :Either, 'brule/utils/either'

data/lib/brule/utils/either.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'forwardable'
 
 module Brule
@@ -10,7 +12,26 @@ module Brule
 
       def_delegators :only_match, :apply, :trigger?, :to_tag
 
-      config_reader :rules
+      config_reader 'rules'
+
+      def to_hash
+        super do |config|
+          config.to_hash.tap do |config_hash|
+            config_hash['rules'] = config.fetch('rules').map(&:to_hash)
+          end
+        end
+      end
+
+      def self.from_hash(*)
+        super do |config_hash|
+          config_hash.tap do |config|
+            config['rules'] = config_hash.fetch('rules').map do |rule_hash|
+              rule_class = Object.const_get(rule_hash.fetch('rule_class'))
+              rule_class.from_hash(rule_hash)
+            end
+          end
+        end
+      end
 
       private
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brule
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Nicolas Zermati
@@ -38,6 +38,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.32'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.32'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
 description: 
 email: ''
 executables: []