rulezilla 0.1.5 → 0.4.0.pre.1

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).map {|o| o == 'true' ? true : (o == 'false' ? false : o)}
+  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,37 +1,37 @@
 --- !ruby/object:Gem::Specification
 name: rulezilla
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.4.0.pre.1
 platform: ruby
 authors:
-- Peter Wu
+- Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-17 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:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -39,13 +39,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: turnip
+  name: pry-doc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-doc
+  name: turnip
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,31 +82,35 @@ dependencies:
         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
+- 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_framework.feature
-- spec/features/step_definitions/rule_steps.rb
 - spec/features/step_definitions/rulezilla_dsl_framework_steps.rb
 - spec/spec_helper.rb
 homepage: https://github.com/simplybusiness/rulezilla
@@ -124,14 +128,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 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/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

data/lib/rulezilla/rule_builder/gherkin_to_result_rule.rb

@@ -1,49 +0,0 @@
-module Rulezilla
-  class RuleBuilder
-    class GherkinToResultRule
-      include Rulezilla::DSL
-
-      group :keyword_is do
-        condition { name =~ /^the #{step_keyword} is/i }
-
-        define :value_is do
-          condition { name =~ /^the #{step_keyword} is \"(.*)\"$/i }
-          result    { "\"#{name.scan(/^the #{step_keyword} is \"(.*)\"$/i).flatten.first}\"" }
-        end
-
-        define :duration_is do
-          condition { name =~ /^the #{step_keyword} is \"(\d+)\" (days?|hours?|minutes?|seconds?)$/i }
-          result do
-            quantity, unit = name.scan(/^the #{step_keyword} is \"(\d+)\" (days?|hours?|minutes?|seconds?)$/i).flatten
-
-            multiplier = case unit
-            when /day/
-              86400
-            when /hour/
-              3600
-            when /minute/
-              60
-            when /second/
-              1
-            end
-
-            quantity.to_i * multiplier
-          end
-        end
-      end
-
-      define :start_with_this_is_a do
-        condition { name =~ /^this is an? #{step_keyword}$/i }
-        result("true")
-      end
-
-      define :start_with_this_is_not_a do
-        condition { name =~ /^this is not an? #{step_keyword}$/i }
-        result("false")
-      end
-
-      default { raise "Unrecognisable step: #{name}" }
-
-    end
-  end
-end

data/lib/rulezilla/rule_builder.rb

@@ -1,101 +0,0 @@
-require 'gherkin/parser/parser'
-require 'gherkin/formatter/json_formatter'
-require 'stringio'
-require 'json'
-require 'rulezilla/rule_builder/gherkin_to_result_rule'
-require 'rulezilla/rule_builder/gherkin_to_condition_rule'
-
-module Rulezilla
-  class RuleBuilder
-
-    def self.from_file(name, file)
-      new(name, IO.read(file))
-    end
-
-    attr_reader :name, :content
-
-    def initialize(name, content)
-      @name    = name
-      @content = content
-    end
-
-    def build
-      klass_definition = rules.map do |rule|
-        rule = RuleDefinition.new(rule, step_keyword)
-
-        condition_definition = rule.conditions.empty? ? "" : "condition { #{rule.conditions} }"
-
-        """
-          define \"#{rule.name}\" do
-            #{condition_definition}
-            result(#{rule.result})
-          end
-        """
-      end.join("\n")
-
-      klass = Rulezilla.const_set(name, Class.new)
-
-      klass.class_eval('include Rulezilla::DSL')
-      klass.class_eval(klass_definition)
-
-      klass
-    end
-
-
-    private
-
-    def step_keyword
-      gherkin_json.first['name'].gsub(/\s?rule/i, '')
-    end
-
-    def rules
-      gherkin_json.first['elements']
-    end
-
-    def gherkin_json
-      @gherkin_json ||= begin
-        io        = StringIO.new
-        formatter = Gherkin::Formatter::JSONFormatter.new(io)
-        parser    = Gherkin::Parser::Parser.new(formatter)
-
-        parser.parse(content, content, 0)
-        formatter.done
-
-        JSON.parse(io.string)
-      end
-    end
-
-
-    class RuleDefinition
-      def initialize(gherkin_json, step_keyword)
-        @gherkin_json = gherkin_json
-        @step_keyword = step_keyword
-      end
-
-      def name
-        @gherkin_json['name']
-      end
-
-      def conditions
-        condition_steps = steps.reject{|step| step['keyword'].strip.downcase == 'then'}
-        conditions = condition_steps.map do |step|
-          ::Rulezilla::RuleBuilder::GherkinToConditionRule.apply(record(step))
-        end.reject{|condition| condition == Rulezilla::RuleBuilder::DefaultCondition}.join(' && ')
-      end
-
-      def result
-        ::Rulezilla::RuleBuilder::GherkinToResultRule.apply record(steps.detect{|step| step['keyword'].strip.downcase == 'then'})
-      end
-
-      private
-
-      def steps
-        @steps ||= @gherkin_json['steps']
-      end
-
-      def record(step)
-        step.merge(step_keyword: @step_keyword)
-      end
-    end
-  end
-end

data/spec/features/gherkin_dsl_framework.feature

@@ -1,90 +0,0 @@
-Feature: Rulezilla Gherkin DSL
-
-  Scenario: Condition: something is something
-    Given the gherkin is:
-      """
-        Feature: Awesomeness Rule
-
-        Scenario: Robocop
-          When the "target" is "Robocop"
-          Then the awesomeness is "very awesome"
-      """
-    When the record has attribute "target" and returns "Robocop"
-    Then the result is "very awesome"
-
-
-  Scenario: Multiple Condition: something is something
-    Given the gherkin is:
-      """
-        Feature: Winner Rule
-
-        Scenario: Robocop vs Ironman
-          When the "target" is "Robocop"
-          And the "opponent" is "Ironman"
-          Then the winner is "Ironman"
-      """
-    When the record has attribute "target" and returns "Robocop"
-    And the record has attribute "opponent" and returns "Ironman"
-    Then the result is "Ironman"
-
-
-  Scenario: Default
-    Given the gherkin is:
-      """
-        Feature: Winner Rule
-
-        Scenario: Default
-          When none of the above
-          Then the winner is "Ironman"
-      """
-    Then the result is "Ironman"
-
-
-  Scenario: 'The :keyword is :value', Keyword mismatch
-    Given the incorrect gherkin is:
-      """
-        Feature: Winner Rule
-
-        Scenario: Default
-          When none of the above
-          Then the loser is "Hello kitty"
-      """
-    Then it raises exception "Unrecognisable step: the loser is 'Hello kitty'"
-
-
-  Scenario: True value
-    Given the gherkin is:
-      """
-        Feature: Dummy Rule
-
-        Scenario: Dummy
-          When the "name" is "007"
-          Then this is a dummy
-      """
-    When the record has attribute "name" and returns "007"
-    Then the result is "true"
-
-
-  Scenario: False value
-    Given the gherkin is:
-      """
-        Feature: Dummy Rule
-
-        Scenario: Not Dummy
-          When the "name" is "Tom"
-          Then this is not a dummy
-      """
-    When the record has attribute "name" and returns "Tom"
-    Then the result is "false"
-
-
-  Scenario: 'This is( not) a :keyword', Keyword mismatch
-    Given the incorrect gherkin is:
-      """
-        Feature: Winner Rule
-
-        Scenario: Not Dummy
-          When the "name" is "Tom"
-          Then this is not a cat
-      """
-    Then it raises exception "Unrecognisable step: this is not a 'cat'"

data/spec/features/gherkin_rules/animal_rule.feature

@@ -1,16 +0,0 @@
-@rule_steps
-Feature: Animal Rule
-
-  Scenario: entity is a cat
-    When this is a "cat"
-    Then this is an animal
-
-  Scenario: telephone number is dog or bird
-    When the "entity" is in:
-      | dog  |
-      | bird |
-    Then this is an animal
-
-  Scenario: default
-    When none of the above
-    Then this is not an animal

data/spec/features/gherkin_rules/duration_rule.feature

@@ -1,14 +0,0 @@
-@rule_steps
-Feature: Duration Rule
-
-  Scenario: Maths class
-    When the "name of the class" is "Maths"
-    Then the duration is "1" minute
-
-  Scenario: Science class
-    When the "name of the class" is "Science"
-    Then the duration is "10" hours
-
-  Scenario: PE
-    When the "name of the class" is "PE"
-    Then the duration is "2" days