rulezilla 0.1.4 → 0.4.1

data/lib/rulezilla/tree.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rulezilla
   class Tree
     attr_reader :current_node, :root_node
@@ -12,7 +14,9 @@ module Rulezilla
       @current_node = is_root? ? @root_node : @current_node.parent
     end
 
-    def find_all(record, node=@root_node)
+    # Returns all the result outcomes of all the matching nodes.
+    #
+    def find_all(record, node = @root_node)
       array = []
       if node.applies?(record)
         node.children.each do |child_node|
@@ -21,10 +25,10 @@ module Rulezilla
 
         return node.has_result? ? array + [node] : array
       end
-      return array
+      array
     end
 
-    def trace(record, node=@root_node)
+    def trace(record, node = @root_node)
       if node.applies?(record)
         node.children.each do |child_node|
           array = trace(record, child_node)
@@ -32,22 +36,26 @@ module Rulezilla
         end
         return node.has_result? ? [node] : []
       end
-      return []
+      []
     end
 
-    def all_results(record, node=@root_node, results=[])
+    def all_results(record, node = @root_node, results = [])
       if node.has_result?
-        results << node.result(record) rescue NoMethodError
+        begin
+          results << node.result(record)
+        rescue StandardError
+          NoMethodError
+        end
       end
 
       node.children.each do |child_node|
         all_results(record, child_node, results)
       end
 
-      return results
+      results
     end
 
-    def create_and_move_to_child(name=nil)
+    def create_and_move_to_child(name = nil)
       node = Node.new
       node.name = name
       @current_node.add_child(node)
@@ -55,20 +63,21 @@ module Rulezilla
       node
     end
 
-    def clone_and_append_children(children, node=@current_node)
+    def clone_and_append_children(children, node = @current_node)
       children.each do |child_node|
         child_node = child_node.dup
         node.add_child(child_node)
 
-        if child_node.has_children?
-          children_nodes = child_node.children
-          child_node.children = []
-          clone_and_append_children(children_nodes, child_node)
-        end
+        next unless child_node.has_children?
+
+        children_nodes = child_node.children
+        child_node.children = []
+        clone_and_append_children(children_nodes, child_node)
       end
     end
 
     private
+
     def is_root?
       @current_node == @root_node
     end

data/lib/rulezilla/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rulezilla
-  VERSION = '0.1.4'
+  VERSION = '0.4.1'
 end

data/lib/rulezilla.rb

@@ -1,35 +1,6 @@
+# frozen_string_literal: true
+
 require 'rulezilla/node'
 require 'rulezilla/tree'
 require 'rulezilla/basic_support'
 require 'rulezilla/dsl'
-require 'rulezilla/rule_builder'
-
-module Rulezilla
-  extend self
-
-  attr_accessor :gherkin_rules_path
-
-  def const_missing(name)
-    raise 'Missing Gherkin Rule Path' if gherkin_rules_path.nil?
-
-    matching_file = Dir.glob(File.join(gherkin_rules_path, '**', '*')).detect do |file|
-      File.basename(file, ".*") == underscore(name.to_s)
-    end
-
-    if matching_file.nil?
-      super
-    else
-      Rulezilla::RuleBuilder.from_file(name, matching_file).build
-    end
-  end
-
-  private
-  def underscore(camel_string)
-    camel_string.gsub(/::/, '/').
-    gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-    gsub(/([a-z\d])([A-Z])/,'\1_\2').
-    tr("-", "_").
-    downcase
-  end
-
-end

data/rulezilla.gemspec

@@ -1,18 +1,25 @@
-$:.push File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+require 'English'
+$LOAD_PATH.push File.expand_path('lib', __dir__)
 require 'rulezilla/version'
 
 Gem::Specification.new do |gem|
-  gem.authors       = ['Peter Wu']
-  gem.email         = ['peter.wu@simplybusiness.com']
-  gem.description   = %q{Rules DSL}
-  gem.summary       = %q{Rules DSL}
-  gem.homepage      = %q{https://github.com/simplybusiness/rulezilla}
+  gem.authors       = ['Simply Business']
+  gem.email         = ['tech@simplybusiness.co.uk']
+  gem.description   = 'Rules DSL'
+  gem.summary       = 'Rules DSL'
+  gem.homepage      = 'https://github.com/simplybusiness/rulezilla'
 
-  gem.files         = `git ls-files`.split($\)
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   gem.name          = 'rulezilla'
   gem.require_paths = ['lib']
   gem.version       = Rulezilla::VERSION
   gem.license       = 'MIT'
 
-  gem.add_runtime_dependency('gherkin')
+  gem.add_runtime_dependency('rspec')
+  gem.add_development_dependency('pry')
+  gem.add_development_dependency('pry-doc')
+  gem.add_development_dependency('rubocop')
+  gem.add_development_dependency('turnip')
 end

data/spec/features/{rulezilla_dsl_framwork.feature → rulezilla_dsl_framework.feature}

@@ -85,7 +85,7 @@ Scenario: If nothing is matched in a group, it will fall to default value of the
   Then the result is "It is alright"
 
 
-Scenario: If nothing is matched, and no default is define in the group, it will fall to the next default
+Scenario: If nothing is matched, and no default is defined in the group, it will fall to the next default
   Given the rule is:
     """
       group :group_1 do
@@ -126,7 +126,7 @@ Scenario: If nothing is matched, it will continue to evaluate the next group
   Then the result is "Bad"
 
 
-Scenario Outline: It evaluate the rule against a record
+Scenario Outline: It evaluates the rule against a record
   Given the rule is:
     """
       define :fruit do
@@ -185,6 +185,53 @@ Scenario: To get all matching outcomes from a rule
     """
   Then all the matching outcomes are "B, C, D, F"
 
+Scenario: To get all matching outcomes from a rule with root node default result
+  Given the rule is:
+  """
+    group :may_not_injure_human do
+      condition { not_injure_human? }
+
+      group :obey_human do
+        condition { do_as_human_told? }
+        result(true)
+
+        define :protect_its_own_existence do
+          condition { in_danger? && not_letting_itself_be_detroyed? }
+          result(true)
+        end
+      end
+    end
+
+    default(false)
+  """
+  When the record has attribute "not_injure_human?" and returns "true"
+  When the record has attribute "do_as_human_told?" and returns "true"
+  When the record has attribute "in_dangert?" and returns "true"
+  When the record has attribute "not_letting_itself_be_detroyed?" and returns "true"
+  Then all the matching outcomes are "true, false"
+
+Scenario: To get all matching outcomes from a rule without root node default result
+  Given the rule is:
+  """
+    group :may_not_injure_human do
+      condition { not_injure_human? }
+
+      group :obey_human do
+        condition { do_as_human_told? }
+        result(true)
+
+        define :protect_its_own_existence do
+          condition { in_danger? && not_letting_itself_be_detroyed? }
+          result(true)
+        end
+      end
+    end
+  """
+  When the record has attribute "not_injure_human?" and returns "true"
+  When the record has attribute "do_as_human_told?" and returns "true"
+  When the record has attribute "in_dangert?" and returns "true"
+  When the record has attribute "not_letting_itself_be_detroyed?" and returns "true"
+  Then all the matching outcomes are "true"
 
 Scenario: Support Module
   Given the rule class name is "FruitRule"
@@ -227,7 +274,7 @@ Scenario Outline: Validate the presence of attributes
     | apple, orange | does not         |                           |
 
 
-Scenario: Rule return nil if no rule is defined Given the rule is:
+Scenario: Rule return nil if no rule is defined
   Given the rule is:
     """
     """

data/spec/features/step_definitions/rulezilla_dsl_framework_steps.rb

@@ -1,40 +1,25 @@
-step 'the gherkin is:' do |gherkin|
-  @rule_klass_name = 'DummyRule'
-  @rule_klass = Rulezilla::RuleBuilder.new(@rule_klass_name, gherkin).build
-end
-
-step 'the incorrect gherkin is:' do |gherkin|
-  @gherkin = gherkin
-end
-
-step 'it raises exception :exception' do |exception|
-  @record ||= {}
-
-  result = result == 'nil' ? nil : result
-
-  expect{ @rule_klass.apply(@record) }.to raise_error{ RuntimeError.new(exception) }
-end
+# frozen_string_literal: true
 
 step 'the rule class name is :klass_name' do |klass_name|
   @rule_klass_name = klass_name
 end
 
 step 'the rule is:' do |rules|
-  @rule_klass = Object.const_set(@rule_klass_name || "DummyRule", Class.new)
-  @rule_klass.class_eval('include Rulezilla::DSL')
+  @rule_klass = Object.const_set(@rule_klass_name || 'DummyRule', Class.new)
+  @rule_klass.class_eval('include Rulezilla::DSL', __FILE__, __LINE__)
   @rule_klass.class_eval(rules.to_s)
 end
 
 step 'our rule is:' do |rules|
-  @rule_klass = Object.const_set("DummyRule", Class.new)
-  @rule_klass.class_eval('include Rulezilla::DSL')
+  @rule_klass = Object.const_set('DummyRule', Class.new)
+  @rule_klass.class_eval('include Rulezilla::DSL', __FILE__, __LINE__)
   @rule_klass.class_eval(rules.to_s)
 end
 
 step 'there is a rule called :rule_name:' do |rule_name, rules|
   send 'the rule class name is :klass_name', rule_name
-  @rule_klass = Object.const_set(@rule_klass_name || "DummyRule", Class.new)
-  @rule_klass.class_eval('include Rulezilla::DSL')
+  @rule_klass = Object.const_set(@rule_klass_name || 'DummyRule', Class.new)
+  @rule_klass.class_eval('include Rulezilla::DSL', __FILE__, __LINE__)
   @rule_klass.class_eval(rules.to_s)
 end
 
@@ -47,15 +32,15 @@ end
 step 'the record has attribute :method and returns :value' do |method, value|
   @record ||= {}
   value = case value
-    when 'true'
-      true
-    when 'false'
-      false
-    when 'nil'
-      nil
-    else
-      value
-    end
+          when 'true'
+            true
+          when 'false'
+            false
+          when 'nil'
+            nil
+          else
+            value
+          end
   @record[method] = value
 end
 
@@ -71,15 +56,15 @@ step 'the result is :result' do |result|
   @record ||= {}
 
   result = case result
-    when 'true'
-      true
-    when 'false'
-      false
-    when 'nil'
-      nil
-    else
-      result
-    end
+           when 'true'
+             true
+           when 'false'
+             false
+           when 'nil'
+             nil
+           else
+             result
+           end
 
   expect(@rule_klass.apply(@record)).to eq result
 end
@@ -90,26 +75,23 @@ step 'all the outcomes are :outcomes' do |outcomes|
 end
 
 step 'all the matching outcomes are :outcomes' do |outcomes|
-  outcomes = outcomes.split(',').map(&:strip)
+  outcomes = outcomes.split(',').map(&:strip).map do |o|
+    if o == 'true'
+      true
+    else
+      (o == 'false' ? false : o)
+    end
+  end
   expect(@rule_klass.all(@record)).to match_array outcomes
 end
 
-step ':does_or_does_not raise the exception :exception' do |does_or_does_not, exception|
+step ':does_or_does_not raise the exception :exception' do |does_or_does_not, exception_message|
   if does_or_does_not == 'does'
-    expect{ @rule_klass.apply @record }.to raise_error do |exception|
-      expect(exception.message).to match /#{exception}/
+    expect { @rule_klass.apply @record }.to raise_error do |exception|
+      expect(exception.message).to match(/#{exception_message}/)
     end
   else
-    expect{ @rule_klass.apply @record }.not_to raise_error
-  end
-end
-
-step 'it raises exception :exception' do |exception|
-  expect {
-    @rule_klass_name = 'DummyRule'
-    @rule_klass = Rulezilla::RuleBuilder.new(@rule_klass_name, @gherkin).build
-    }.to raise_error do |exception|
-    expect(exception.message).to match /#{exception}/
+    expect { @rule_klass.apply @record }.not_to raise_error
   end
 end
 

data/spec/spec_helper.rb

@@ -1,21 +1,41 @@
+# frozen_string_literal: true
+
 require 'rulezilla'
 require 'pry'
 
-Dir.glob("spec/features/step_definitions/**/*steps.rb") { |f| load f, true }
-
-Rulezilla.gherkin_rules_path = File.join(Dir.pwd, 'spec/features/gherkin_rules')
+Dir.glob('spec/features/step_definitions/**/*steps.rb') { |f| load f, true }
 
 RSpec.configure do |config|
   config.after(:each) do
-    Object.send(:remove_const, ('DummyRule').to_sym)               rescue NameError
-    Object.send(:remove_const, 'DummyRuleRecord'.to_sym)           rescue NameError
-    Object.send(:remove_const, 'DummyRuleSupport'.to_sym)          rescue NameError
-    Object.send(:remove_const, (@rule_klass_name).to_sym)          rescue NameError
-    Object.send(:remove_const, "#{@rule_klass_name}Record".to_sym) rescue NameError
-    Object.send(:remove_const, "#{@support_name}Support".to_sym)   rescue NameError
-
-    Rulezilla.send(:remove_const, (@rule_klass_name    || 'DummyRule').to_sym) rescue NameError
-    Rulezilla.send(:remove_const, "#{(@rule_klass_name || 'DummyRule')}Record".to_sym) rescue NameError
-    Rulezilla.send(:remove_const, "#{(@support_name    || 'DummyRule')}Support".to_sym) rescue NameError
+    begin
+      Object.send(:remove_const, 'DummyRule'.to_sym)
+    rescue StandardError
+      NameError
+    end
+    begin
+      Object.send(:remove_const, 'DummyRuleRecord'.to_sym)
+    rescue StandardError
+      NameError
+    end
+    begin
+      Object.send(:remove_const, 'DummyRuleSupport'.to_sym)
+    rescue StandardError
+      NameError
+    end
+    begin
+      Object.send(:remove_const, @rule_klass_name.to_sym)
+    rescue StandardError
+      NameError
+    end
+    begin
+      Object.send(:remove_const, "#{@rule_klass_name}Record".to_sym)
+    rescue StandardError
+      NameError
+    end
+    begin
+      Object.send(:remove_const, "#{@support_name}Support".to_sym)
+    rescue StandardError
+      NameError
+    end
   end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: rulezilla
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.4.1
 platform: ruby
 authors:
-- Peter Wu
+- Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-19 00:00:00.000000000 Z
+date: 2022-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: gherkin
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -24,34 +24,93 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turnip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rules DSL
 email:
-- peter.wu@simplybusiness.com
+- tech@simplybusiness.co.uk
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yaml"
+- ".github/workflows/codeql-analysis.yaml"
+- ".github/workflows/dobby-actions.yml"
+- ".github/workflows/gem-publish.yaml"
+- ".github/workflows/version-forget-me-not.yaml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
+- CODEOWNERS
 - Gemfile
-- Gemfile.lock
+- LICENSE.txt
 - README.md
+- catalog-info.yaml
 - lib/rulezilla.rb
 - lib/rulezilla/basic_support.rb
 - lib/rulezilla/dsl.rb
 - lib/rulezilla/node.rb
-- lib/rulezilla/rule_builder.rb
-- lib/rulezilla/rule_builder/gherkin_to_condition_rule.rb
-- lib/rulezilla/rule_builder/gherkin_to_result_rule.rb
 - lib/rulezilla/tree.rb
 - lib/rulezilla/version.rb
 - rulezilla.gemspec
 - spec/features/default_support_methods.feature
-- spec/features/gherkin_dsl_framework.feature
-- spec/features/gherkin_rules/animal_rule.feature
-- spec/features/gherkin_rules/duration_rule.feature
-- spec/features/rulezilla_dsl_framwork.feature
-- spec/features/step_definitions/rule_steps.rb
+- spec/features/rulezilla_dsl_framework.feature
 - spec/features/step_definitions/rulezilla_dsl_framework_steps.rb
 - spec/spec_helper.rb
 homepage: https://github.com/simplybusiness/rulezilla
@@ -73,10 +132,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Rules DSL
 test_files: []
-has_rdoc: 

data/Gemfile.lock

@@ -1,44 +0,0 @@
-PATH
-  remote: .
-  specs:
-    rulezilla (0.1.4)
-      gherkin
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    coderay (1.1.0)
-    diff-lcs (1.2.5)
-    gherkin (2.12.2)
-      multi_json (~> 1.3)
-    method_source (0.8.2)
-    multi_json (1.10.1)
-    pry (0.9.12.6)
-      coderay (~> 1.0)
-      method_source (~> 0.8)
-      slop (~> 3.4)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.3)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.3)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.3)
-    slop (3.5.0)
-    turnip (1.2.2)
-      gherkin (>= 2.5)
-      rspec (>= 2.0, < 4.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  pry
-  rspec
-  rulezilla!
-  turnip

data/lib/rulezilla/rule_builder/gherkin_to_condition_rule.rb

@@ -1,63 +0,0 @@
-module Rulezilla
-  class RuleBuilder
-    class DefaultCondition; end
-
-    class GherkinToConditionRule
-      include Rulezilla::DSL
-
-      define :'this is a "field"' do
-        condition { name =~ /^this is\s?a?n? \"(.*)\"$/i }
-
-        result do
-          field = name.scan(/^this is\s?a?n? \"(.*)\"$/i).flatten.first
-          "#{field}?"
-        end
-      end
-
-      define :'the "field" is "value"' do
-        condition { name =~ /^the \"(.*)\" is \"(.*)\"$/i }
-
-        result do
-          field, value = name.scan(/^the \"(.*)\" is \"(.*)\"$/i).flatten
-          field = field.gsub(/\s/, '_').downcase
-
-          "#{field} == #{ConditionValueEvaluateRule.apply(value: value)}"
-        end
-      end
-
-      define :'the "field" is in: {table}' do
-        condition { name =~ /^the \"(.*)\" is in:$/i }
-
-        result do
-          field = name.scan(/^the \"(.*)\" is in:$/i).flatten.first
-          field = field.gsub(/\s/, '_').downcase
-
-          values = rows.map{ |row| "#{ConditionValueEvaluateRule.apply(value: row['cells'].first)}" }.join(', ')
-
-          "[#{values}].include?(#{field})"
-        end
-      end
-
-      define :'none of the above' do
-        condition { name == 'none of the above' }
-        result(DefaultCondition)
-      end
-
-      default { raise "Condition steps is not recognised: #{name}" }
-    end
-
-
-
-    class ConditionValueEvaluateRule
-      include Rulezilla::DSL
-
-      define :blank do
-        condition { value == 'blank'}
-        result("''")
-      end
-
-      default { "\"#{value}\"" }
-    end
-  end
-
-end