rulezilla 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a5437383cf683007f42c90a096f3428103cdc46
-  data.tar.gz: 0e3366b7fee344c1d5c1958ee1f8ffd54a2b402b
+  metadata.gz: 8de468c7423c8fb95e879491361d8587ced03b28
+  data.tar.gz: 9cbbd613deab120d67a6da93e81a4e7fc360ec38
 SHA512:
-  metadata.gz: abb77e8d80423a511e1ea78a0c4600bb103f628879268033e653573c5e264840aaacebe52512334597853991b9aee9e66b51ea49511c8cb4f7e2e65d58cd4271
-  data.tar.gz: 2c0100529a1032e5b02b12c522effc33d44cd8753cdfbd3541b9f1d83ab197e5864a098f44eab8238c9347f3657d1e0601d12dc2bf2ea17554b70f1d63fc034d
+  metadata.gz: 52adab9a3346e9cfb20b58a7197c2a724f823f04d647f2dc313f07cb01ed169c59c5a10c708fe2581a6c7914da33e88a3641f04b02ce337f8d2207dad181df51
+  data.tar.gz: 9fdf3bb8bf2b3366fec2e7d140ade30020113f8e3ef80bdd198720139152e6b3c81a3b816a2c292dcc315e01ed0b26a96687beccfbe25cb848569db8d3d47965

data/.gitignore

@@ -1 +1,5 @@
 .bundle
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+.idea/

data/Gemfile

@@ -1,6 +1,2 @@
 source 'https://rubygems.org'
 gemspec
-
-gem 'rspec'
-gem 'turnip'
-gem 'pry'

data/README.md

@@ -1,43 +1,61 @@
-[![Semaphore](https://semaphoreapp.com/api/v1/projects/e488365d-9c57-4431-916a-72aea091d1b5/229083/shields_badge.png)](https://semaphoreapp.com/simplybusiness/rulezilla)
+[![Build Status](https://semaphoreci.com/api/v1/projects/e488365d-9c57-4431-916a-72aea091d1b5/229083/shields_badge.svg)](https://semaphoreci.com/simplybusiness/rulezilla)
 [![Code Climate](https://codeclimate.com/repos/53ecc0416956800c1d01f6bf/badges/76b47eaeffc33e312508/gpa.svg)](https://codeclimate.com/repos/53ecc0416956800c1d01f6bf/feed)
-
+[![Gem Version](https://badge.fury.io/rb/rulezilla.svg)](http://badge.fury.io/rb/rulezilla)
 
 rulezilla
 =========
 
-This provide a DSL to implement rules for various tasks. In the current version we are still rely user to have a certain level of Ruby knowledge to be able to use this DSL. The ultimate goal is for people without prior Ruby knowledge can change and even write the Rule.
+This provides a DSL to implement rules for various tasks. In the current version we are still relying on user to have a certain level of Ruby knowledge
+in order to be able to use this DSL. The ultimate goal is for people without prior Ruby knowledge to be able to change and even write the Rule.
 
 
 # Installation
 
-    gem 'rulezilla', git: 'git@github.com:simplybusiness/rulezilla.git'
+## Using `Gemfile`
+
+Add the following line to your `Gemfile`:
+
+    gem 'rulezilla'
+
+Then run:
+
+    bundle install
+
+## Without `Gemfile`
 
-## Implementation
+On your command line run the following:
+
+    gem install 'rulezilla'
+
+## Usage
 
 ### Rules
 
+Rules can be defined either using `Gherkin` or pure Ruby. In either case, rules are classes that include the `Rulezilla::DSL`.
+
 #### Gherkin (Beta)
 
-rulezilla Gherkin has only very limited support now
+> *Note:* Currently, rulezilla Gherkin has only very limited support.
 
-First set the path of which rulezilla can load the feature files from:
+Rules are defined inside `.feature` files which should be organized under a specific directory. In order to be able to use these rules, you need to first
+set the path that rulezilla can use in order to load them.
 
-    Rulezilla.gherkin_rules_path = 'absolute path'
+    Rulezilla.gherkin_rules_path = 'absolute path to folder holding your feature files'
 
-The filename will then converted to the name of the class, e.g. `invalid_number_rule.feature` will generate `Rulezilla::InvalidNumberRule` class
+Rulezilla will load all the feature files and for each one will create a rule class. The filename will be used to build the name of the rule class. For example,
+the file with name `invalid_number_rule.feature` will generate rule class `Rulezilla::InvalidNumberRule`.
 
-We currently only support a very limited steps, please refer to:
+We currently support a very limited type of steps. Please refer to:
 
 [True / False](spec/features/gherkin_rules/animal_rule.feature)
 
 [Duration](spec/features/gherkin_rules/duration_rule.feature)
 
-
 #### Ruby
 
-Please refer to the [feature](spec/features/rulezilla_dsl_framwork.feature) for further details
+You can use plain Ruby to define the rule classes. But you will need to include the `Rulezilla::DSL` module. That will give you access to the DSL used to define rules.
 
-To use rulezilla, please include `Rulezilla::DSL` in your class:
+Here is an example:
 
     class RoboticsRule
       include Rulezilla::DSL
@@ -59,6 +77,8 @@ To use rulezilla, please include `Rulezilla::DSL` in your class:
 
     end
 
+Please refer to the [feature](spec/features/rulezilla_dsl_framework.feature) for further details of the DSL.
+
 ### Support Module
 
 The support module will be automatically included if its name is `"#{rule_class_name}Support"`
@@ -73,24 +93,28 @@ e.g. if the rule class name is `RoboticsRule`, then the support would be `Roboti
 
 ### How to execute the rule
 
-if the entity is:
+If the entity is:
 
-    {
-      not_injure_human?: true,
-      do_as_human_told?: true,
-      in_danger?:        true,
+    entity = {
+      not_injure_human?:               true,
+      do_as_human_told?:               true,
+      in_danger?:                      true,
       not_letting_itself_be_detroyed?: true
     }
 
-#### To get the first matching result
+#### To get the first matching result output
 
     RoboticsRule.apply(entity) #=> true
 
-#### To get all matching results
+#### To get all matching result outputs
 
-    RoboticsRule.all(entity) #=> [true]
+    RoboticsRule.all(entity) #=> [true, false]
+    
+Note that `false` is the result outcome coming out from `default(false)` on top level, which is also called `root node`. The `root` node does not have any condition and hence
+it is considered to be matching. This means, by consequence, that its result (`default(false)`) is included in the list of matching result outputs which `#all(entity)` above
+returns.
 
-#### To get the trace of all node
+#### To get the trace of all nodes
 
     RoboticsRule.trace(entity)
     #=> all the nodes instance: [root, may_not_injure_human, obey_human, protect_its_own_existence] in sequence order.
@@ -100,10 +124,10 @@ if the entity is:
     RoboticsRule.results #=> [true, false]
 
 
-# Syntax
+### Syntax
 
 Please refer to the features for DSL syntax:
 
-[DSL Feature](spec/features/rulezilla_dsl_framwork.feature),
+[DSL Feature](spec/features/rulezilla_dsl_framework.feature),
 
 [Default Support Methods Feature](spec/features/default_support_methods.feature)

data/lib/rulezilla/node.rb

@@ -1,7 +1,11 @@
 module Rulezilla
   class Node
-    attr_accessor :parent, :children
-    attr_reader   :condition, :default, :name
+    attr_accessor :children,
+                  :condition,
+                  :parent
+
+    attr_reader   :default, :name
+    attr_writer   :result
 
     def initialize
       @children = []
@@ -17,25 +21,17 @@ module Rulezilla
 
     def applies?(record)
       return true if condition.nil?
-      record.instance_eval(&condition)
+      !!record.instance_eval(&condition)
     end
 
     def result(record)
       @result.is_a?(Proc) ? record.instance_eval(&@result) : @result
     end
 
-    def condition=(block)
-      @condition = block
-    end
-
     def name=(value)
       @name = value.to_s
     end
 
-    def result=(block)
-      @result = block
-    end
-
     def add_child(node)
       node.parent = self
       children << node

data/lib/rulezilla/tree.rb

@@ -12,6 +12,8 @@ module Rulezilla
       @current_node = is_root? ? @root_node : @current_node.parent
     end
 
+    # Returns all the result outcomes of all the matching nodes.
+    #
     def find_all(record, node=@root_node)
       array = []
       if node.applies?(record)
@@ -21,7 +23,7 @@ module Rulezilla
 
         return node.has_result? ? array + [node] : array
       end
-      return array
+      array
     end
 
     def trace(record, node=@root_node)

data/lib/rulezilla/version.rb

@@ -1,3 +1,3 @@
 module Rulezilla
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/rulezilla.gemspec

@@ -14,5 +14,9 @@ Gem::Specification.new do |gem|
   gem.version       = Rulezilla::VERSION
   gem.license       = 'MIT'
 
-  gem.add_runtime_dependency('gherkin')
+  gem.add_runtime_dependency('gherkin', '~> 2.5')
+  gem.add_runtime_dependency('rspec')
+  gem.add_runtime_dependency('turnip')
+  gem.add_development_dependency('pry')
+  gem.add_development_dependency('pry-doc')
 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

@@ -90,7 +90,7 @@ 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 {|o| o == 'true' ? true : (o == 'false' ? false : o)}
   expect(@rule_klass.all(@record)).to match_array outcomes
 end
 

metadata

@@ -1,17 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: rulezilla
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Peter Wu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-19 00:00:00.000000000 Z
+date: 2016-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gherkin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -24,6 +38,48 @@ dependencies:
     - - ">="
       - !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: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !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'
 description: Rules DSL
 email:
 - peter.wu@simplybusiness.com
@@ -34,7 +90,6 @@ files:
 - ".gitignore"
 - ".rspec"
 - Gemfile
-- Gemfile.lock
 - README.md
 - lib/rulezilla.rb
 - lib/rulezilla/basic_support.rb
@@ -50,7 +105,7 @@ files:
 - 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/rulezilla_dsl_framework.feature
 - spec/features/step_definitions/rule_steps.rb
 - spec/features/step_definitions/rulezilla_dsl_framework_steps.rb
 - spec/spec_helper.rb

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