dmn 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83ab9c509d78447fc0dcf11d993e79c9105baf97904af53e932e16ae7eaee2df
-  data.tar.gz: be469b68cdeab12f0ffee64e6a1c884ee9b67d10e2d9b899f1f3ecfa7905a975
+  metadata.gz: 82afe806c546d827f5629bbf843320de290af2c0ab983054a7abb2ddbf90835a
+  data.tar.gz: dd43fd946d1506a3b80dd1634a8e6045051bae58ce6acf5786c6bf630fd57569
 SHA512:
-  metadata.gz: a5b1b6a24a4c6d2f305d41e94ac83bcb951f1dbfe8fc4ddccc6d5675ee5f3af70529778f288db5c7dea989a5ef7af685250ad6b7abd5dea7b80bef1afe20d019
-  data.tar.gz: 62e2cecb612379245854e09684e1632ae6fb670d0618577685d00e92c944aaf44c9e8a5e59173372280a5887879a190603bd1ec47e07f34bebb9e533f91d9a3b
+  metadata.gz: e2e1664964bff590b8b82658db0fe289a2be1b6bfd56b19f8645bdf3baba51e5d722bc3972fda9ef597327ae495ad2f288188b1bf7be38112cc374935843f75c
+  data.tar.gz: 2384486276b03d18280066ab756026b9e11a9caa2a0a784b7b5829383a86b85955fc7172fea3ffef72b0d62525fb8e05d37207cb21177ec241b6a02fec2de9f5

data/README.md

@@ -1,69 +1,11 @@
-# Spot Feel
+# DMN
 
-A light-weight DMN FEEL expression evaluator and business rule engine in Ruby.
+A light-weight DMN (Decision Model and Notation) business rule ruby gem.
 
-This gem implements a subset of FEEL (Friendly Enough Expression Language) as defined in the [DMN 1.3 specification](https://www.omg.org/spec/DMN/1.3/PDF) with some additional extensions.
-
-FEEL expressions are parsed into an abstract syntax tree (AST) and then evaluated in a context. The context is a hash of variables and functions to be resolved inside the expression.
-
-Expressions are safe, side-effect free, and deterministic. They are ideal for capturing business logic for storage in a database or embedded in DMN, BPMN, or Form documents for execution in a workflow engine like [Spot Flow](https://github.com/connectedbits/spot-flow).
-
-This project was inspired by these excellent libraries:
-
-- [feelin](https://github.com/nikku/feelin)
-- [dmn-eval-js](https://github.com/mineko-io/dmn-eval-js)
+This gem depends on the [FEEL](https://github.com/connectedbits/bpmn/tree/main/feel) gem to evaluate DMN decision tables and expressions.
 
 ## Usage
 
-To evaluate an expression:
-
-```ruby
-DMN.evaluate('"👋 Hello " + name', variables: { name: "World" })
-# => "👋 Hello World"
-```
-
-A slightly more complex example:
-
-```ruby
-variables = {
-  person: {
-    name: "Eric",
-    age: 59,
-  }
-}
-DMN.evaluate('if person.age >= 18 then "adult" else "minor"', variables:)
-# => "adult"
-```
-
-Calling a built-in function:
-
-```ruby
-DMN.evaluate('sum([1, 2, 3])')
-# => 6
-```
-
-Calling a user-defined function:
-
-```ruby
-DMN.config.functions = {
-  "reverse": ->(s) { s.reverse }
-}
-DMN.evaluate('reverse("Hello World!")', functions:)
-# => "!dlroW olleH"
-```
-
-To evaluate a unary tests:
-
-```ruby
-DMN.test(3, '<= 10, > 50'))
-# => true
-```
-
-```ruby
-DMN.test("Eric", '"Bob", "Holly", "Eric"')
-# => true
-```
-
 ![Decision Table](docs/media/decision_table.png)
 
 To evaluate a DMN decision table:
@@ -80,71 +22,8 @@ result = DMN.decide('fine_decision', definitions_xml: fixture_source("fine.dmn")
 # => { "amount" => 1000, "points" => 7 })
 ```
 
-To get a list of variables or functions used in an expression:
-
-```ruby
-LiteralExpression.new(text: 'person.first_name + " " + person.last_name').variable_names
-# => ["person.age, person.last_name"]
-```
-
-```ruby
-LiteralExpression.new(text: 'sum([1, 2, 3])').function_names
-# => ["sum"]
-```
-
-```ruby
-UnaryTests.new(text: '> speed - speed_limit').variable_names
-# => ["speed, speed_limit"]
-```
-
 ## Supported Features
 
-### Data Types
-
-- [x] Boolean (true, false)
-- [x] Number (integer, decimal)
-- [x] String (single and double quoted)
-- [x] Date, Time, Duration (ISO 8601)
-- [x] List (array)
-- [x] Context (hash)
-
-### Expressions
-
-- [x] Literal
-- [x] Path
-- [x] Arithmetic
-- [x] Comparison
-- [x] Function Invocation
-- [x] Positional Parameters
-- [x] If Expression
-- [ ] For Expression
-- [ ] Quantified Expression
-- [ ] Filter Expression
-- [ ] Disjunction
-- [ ] Conjuction
-- [ ] Instance Of
-- [ ] Function Definition
-
-### Unary Tests
-
-- [x] Comparison
-- [x] Interval/Range (inclusive and exclusive)
-- [x] Disjunction
-- [x] Negation
-- [ ] Expression
-
-### Built-in Functions
-
-- [x] Conversion: `string`, `number`
-- [x] Boolean: `not`, `is defined`, `get or else`
-- [x] String: `substring`, `substring before`, `substring after`, `string length`, `upper case`, `lower case`, `contains`, `starts with`, `ends with`, `matches`, `replace`, `split`, `strip`, `extract`
-- [x] Numeric: `decimal`, `floor`, `ceiling`, `round`, `abs`, `modulo`, `sqrt`, `log`, `exp`, `odd`, `even`, `random number`
-- [x] List: `list contains`, `count`, `min`, `max`, `sum`, `product`, `mean`, `median`, `stddev`, `mode`, `all`, `any`, `sublist`, `append`, `concatenate`, `insert before`, `remove`, `reverse`, `index of`, `union`, `distinct values`, `duplicate values`, `flatten`, `sort`, `string join`
-- [x] Context: `get entries`, `get value`, `get keys`
-- [x] Temporal: `now`, `today`, `day of week`, `day of year`, `month of year`, `week of year`
-
-### DMN
-
 - [x] Parse DMN XML documents
 - [x] Evaluate DMN Decision Tables
 - [x] Evaluate dependent DMN Decision Tables
@@ -169,13 +48,11 @@ $ gem install dmn
 ```bash
 $ git clone ...
 $ bin/setup
+$ cd dmn
+$ bin/rake
 $ bin/guard
 ```
 
-## Development
-
-[Treetop Doumentation](https://cjheath.github.io/treetop/syntactic_recognition.html) is a good place to start learning about Treetop.
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/dmn/decision.rb

@@ -7,9 +7,9 @@ module DMN
     def self.from_json(json)
       information_requirements = Array.wrap(json[:information_requirement]).map { |ir| InformationRequirement.from_json(ir) } if json[:information_requirement]
       decision_table = DecisionTable.from_json(json[:decision_table]) if json[:decision_table]
-      literal_expression = LiteralExpression.from_json(json[:literal_expression]) if json[:literal_expression]
+      literal_expression = FEEL::LiteralExpression.from_json(json[:literal_expression]) if json[:literal_expression]
       variable = Variable.from_json(json[:variable]) if json[:variable]
-      Decision.new(id: json[:id], name: json[:name], decision_table:, variable:, literal_expression:, information_requirements:)
+      Decision.new(id: json[:id], name: json[:name], decision_table: decision_table, variable: variable, literal_expression: literal_expression, information_requirements: information_requirements)
     end
 
     def initialize(id:, name:, decision_table:, variable:, literal_expression:, information_requirements:)

data/lib/dmn/definitions.rb

@@ -40,7 +40,7 @@ module DMN
         next if already_evaluated_decisions[required_decision_id]
         next if decisions.find { |d| d.id == required_decision_id }.nil?
 
-        result = evaluate(required_decision_id, variables:, already_evaluated_decisions:)
+        result = evaluate(required_decision_id, variables: variables, already_evaluated_decisions: already_evaluated_decisions)
 
         variables.merge!(result) if result.is_a?(Hash)
 

data/lib/dmn/input.rb

@@ -5,8 +5,9 @@ module DMN
     attr_reader :id, :label, :input_expression
 
     def self.from_json(json)
-      input_expression = LiteralExpression.from_json(json[:input_expression]) if json[:input_expression]
-      Input.new(id: json[:id], label: json[:label], input_expression:)
+      input_expression = FEEL::
+      LiteralExpression.from_json(json[:input_expression]) if json[:input_expression]
+      Input.new(id: json[:id], label: json[:label], input_expression: input_expression)
     end
 
     def initialize(id:, label:, input_expression:)

data/lib/dmn/rule.rb

@@ -5,9 +5,9 @@ module DMN
     attr_accessor :id, :input_entries, :output_entries, :description
 
     def self.from_json(json)
-      input_entries = Array.wrap(json[:input_entry]).map { |input_entry| UnaryTests.from_json(input_entry) }
-      output_entries = Array.wrap(json[:output_entry]).map { |output_entry| LiteralExpression.from_json(output_entry) }
-      Rule.new(id: json[:id], input_entries:, output_entries:, description: json[:description])
+      input_entries = Array.wrap(json[:input_entry]).map { |input_entry| FEEL::UnaryTests.from_json(input_entry) }
+      output_entries = Array.wrap(json[:output_entry]).map { |output_entry| FEEL::LiteralExpression.from_json(output_entry) }
+      Rule.new(id: json[:id], input_entries: input_entries, output_entries: output_entries, description: json[:description])
     end
 
     def initialize(id:, input_entries:, output_entries:, description: nil)

data/lib/dmn/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DMN
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/dmn.rb

@@ -6,16 +6,13 @@ require "active_support"
 require "active_support/time"
 require "active_support/core_ext/hash"
 
-require "treetop"
+require "feel"
+
 require "xmlhasher"
 
 require "dmn/configuration"
-require "dmn/nodes"
-require "dmn/parser"
 
 require "dmn/variable"
-require "dmn/literal_expression"
-require "dmn/unary_tests"
 require "dmn/input"
 require "dmn/output"
 require "dmn/rule"
@@ -30,13 +27,13 @@ module DMN
   class EvaluationError < StandardError; end
 
   def self.evaluate(expression_text, variables: {})
-    literal_expression = DMN::LiteralExpression.new(text: expression_text)
+    literal_expression = FEEL::LiteralExpression.new(text: expression_text)
     raise SyntaxError, "Expression is not valid" unless literal_expression.valid?
     literal_expression.evaluate(variables)
   end
 
   def self.test(input, unary_tests_text, variables: {})
-    unary_tests = DMN::UnaryTests.new(text: unary_tests_text)
+    unary_tests = FEEL::UnaryTests.new(text: unary_tests_text)
     raise SyntaxError, "Unary tests are not valid" unless unary_tests.valid?
     unary_tests.test(input, variables)
   end

metadata

@@ -1,42 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: dmn
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Connected Bits
 bindir: bin
 cert_chain: []
-date: 2025-03-03 00:00:00.000000000 Z
+date: 2025-06-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: feel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.4
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.2.3
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.2.3
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.2.3
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 7.0.2.3
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: ostruct
   requirement: !ruby/object:Gem::Requirement
@@ -275,15 +289,10 @@ files:
 - lib/dmn/decision.rb
 - lib/dmn/decision_table.rb
 - lib/dmn/definitions.rb
-- lib/dmn/dmn.treetop
 - lib/dmn/information_requirement.rb
 - lib/dmn/input.rb
-- lib/dmn/literal_expression.rb
-- lib/dmn/nodes.rb
 - lib/dmn/output.rb
-- lib/dmn/parser.rb
 - lib/dmn/rule.rb
-- lib/dmn/unary_tests.rb
 - lib/dmn/variable.rb
 - lib/dmn/version.rb
 homepage: https://www.connectedbits.com
@@ -299,14 +308,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A light-weight DMN FEEL expression evaluator and business rule engine in
   Ruby.