rulezilla 0.1.4 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0a5437383cf683007f42c90a096f3428103cdc46
-  data.tar.gz: 0e3366b7fee344c1d5c1958ee1f8ffd54a2b402b
+SHA256:
+  metadata.gz: 43dfbbf1981a5b2dfa4fc2f479115160b280ef929216fffbe1bb724a580e300d
+  data.tar.gz: fe5f3f26f62751725db9e629447e90032b3a946d0894389df8b0d2b445dc7934
 SHA512:
-  metadata.gz: abb77e8d80423a511e1ea78a0c4600bb103f628879268033e653573c5e264840aaacebe52512334597853991b9aee9e66b51ea49511c8cb4f7e2e65d58cd4271
-  data.tar.gz: 2c0100529a1032e5b02b12c522effc33d44cd8753cdfbd3541b9f1d83ab197e5864a098f44eab8238c9347f3657d1e0601d12dc2bf2ea17554b70f1d63fc034d
+  metadata.gz: b4fa1e6b4b54040a5323a01662e88d32f981a1278dcc1475c07b3743ed56839445c44cd57efa629ca5398bf6bf2e4f1add1605b36d8f728de3d91c02400d286f
+  data.tar.gz: b1c7b5222c8c0329d45da874cf5c076087751019e573853be2d69c89ace8c763e73ad9d18e5ae1354619b9d3adacd5a5378f2febb6c8fa02fc092df65f944725

data/.github/workflows/ci.yaml

@@ -0,0 +1,36 @@
+name: Ruby CI
+
+on:
+  push:
+
+env:
+  CI: true
+permissions:
+  contents: read
+  statuses: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./
+
+    strategy:
+      matrix:
+        ruby-version: [2.7, 3.0, 3.1]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+
+    - name: Install dependencies
+      run: bundle install
+    - name: Rubocop Check
+      run: bundle exec rubocop
+    - name: Run all tests
+      run: bundle exec rspec
+      shell: bash

data/.github/workflows/codeql-analysis.yaml

@@ -0,0 +1,70 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '42 8 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'ruby' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

data/.github/workflows/dobby-actions.yml

@@ -0,0 +1,29 @@
+
+name: "Dobby action"
+on:
+  issue_comment:
+    types: [created]
+permissions:
+  contents: read
+jobs:
+  pr_commented:
+    runs-on: ubuntu-20.04
+    if: startsWith(github.event.comment.body, '/dobby')
+    env:
+      BUNDLE_WITHOUT: "development:test"
+    steps:
+      - name: Checkout action
+        uses: actions/checkout@v2
+        with:
+          repository: 'simplybusiness/dobby'
+          ref: 'v3.0.0'
+      - name: Set up ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - name: Bump version
+        uses: simplybusiness/dobby@v3.0.0
+        env:
+          DOBBY_APP_ID: ${{ secrets.DOBBY_APP_ID }}
+          DOBBY_PRIVATE_KEY: ${{ secrets.DOBBY_PRIVATE_KEY }}
+          VERSION_FILE_PATH: lib/rulezilla/version.rb

data/.github/workflows/gem-publish.yaml

@@ -0,0 +1,46 @@
+name: Publish Ruby Gem
+
+on:
+  push:
+    branches: [ master ]
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    name: Build and Publish
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - name: Publish to RubyGems
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push *.gem
+        env:
+          GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
+      - name: Get Gem Version
+        id: get-gem-version
+        run: echo "::set-output name=GEM_VERSION::$(bundle exec ruby -e 'puts Rulezilla::VERSION')"
+      - name: Create Release
+        uses: actions/github-script@v6
+        env:
+          GEM_VERSION: ${{ steps.get-gem-version.outputs.GEM_VERSION }}
+        with:
+          result-encoding: string
+          script: |
+            const { GEM_VERSION } = process.env
+            github.rest.repos.createRelease({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              tag_name: GEM_VERSION,
+              generate_release_notes: true,
+            })

data/.github/workflows/version-forget-me-not.yaml

@@ -0,0 +1,19 @@
+name: Check version
+
+on:
+  pull_request:
+    branches:
+      - master
+    types: [opened, synchronize]
+permissions:
+  contents: read
+  statuses: write
+jobs:
+  version-check:
+    runs-on: ubuntu-18.04
+
+    steps:
+      - uses: simplybusiness/version-forget-me-not@v2.3.0
+        env:
+          ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          VERSION_FILE_PATH: "lib/rulezilla/version.rb"

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,61 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2022-07-06 10:13:12 UTC using RuboCop version 1.31.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'rulezilla.gemspec'
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 20
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
+Metrics/BlockLength:
+  Max: 32
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+Metrics/MethodLength:
+  Max: 19
+
+# Offense count: 3
+# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.
+# NamePrefix: is_, has_, have_
+# ForbiddenPrefixes: is_, has_, have_
+# AllowedMethods: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
+Naming/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/rulezilla/node.rb'
+    - 'lib/rulezilla/tree.rb'
+
+# Offense count: 6
+# Configuration parameters: AllowedConstants.
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/rulezilla/basic_support.rb'
+    - 'lib/rulezilla/dsl.rb'
+    - 'lib/rulezilla/node.rb'
+    - 'lib/rulezilla/tree.rb'
+    - 'lib/rulezilla/version.rb'
+
+# Offense count: 3
+# Configuration parameters: MinBodyLength, AllowConsecutiveConditionals.
+Style/GuardClause:
+  Exclude:
+    - 'lib/rulezilla/dsl.rb'
+    - 'rulezilla.gemspec'

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/CODEOWNERS

@@ -0,0 +1,3 @@
+# Add your project owners info here
+# More information: https://help.github.com/articles/about-codeowners/
+* @simplybusiness/palm-trees

data/Gemfile

@@ -1,6 +1,4 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec
-
-gem 'rspec'
-gem 'turnip'
-gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,9 @@
+Copyright (c) 2013-2016 Simply Business
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,43 +1,43 @@
-[![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'
-
-## Implementation
+## Using `Gemfile`
 
-### Rules
+Add the following line to your `Gemfile`:
 
-#### Gherkin (Beta)
+    gem 'rulezilla'
 
-rulezilla Gherkin has only very limited support now
+Then run:
 
-First set the path of which rulezilla can load the feature files from:
+    bundle install
 
-    Rulezilla.gherkin_rules_path = 'absolute path'
+## Without `Gemfile`
 
-The filename will then converted to the name of the class, e.g. `invalid_number_rule.feature` will generate `Rulezilla::InvalidNumberRule` class
+On your command line run the following:
 
-We currently only support a very limited steps, please refer to:
+    gem install 'rulezilla'
 
-[True / False](spec/features/gherkin_rules/animal_rule.feature)
+## Usage
 
-[Duration](spec/features/gherkin_rules/duration_rule.feature)
+### Rules
 
+Rules are defined in Ruby. Rules are classes that include the `Rulezilla::DSL`.
 
 #### 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 +59,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 +75,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 +106,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/catalog-info.yaml

@@ -0,0 +1,8 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: rulezilla
+  description:  Rule DSL 
+spec:
+  type: library
+  lifecycle: production

data/lib/rulezilla/basic_support.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Rulezilla
   module BasicSupport
-
     def does_not?(value)
       value == false
     end
 
-    alias_method :is_not?, :does_not?
-
+    alias is_not? does_not?
   end
 end

data/lib/rulezilla/dsl.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rulezilla
   module DSL
     def self.included(base)
@@ -20,7 +22,11 @@ module Rulezilla
 
       klass.class_eval do
         include Rulezilla::BasicSupport
-        include Object.const_get("#{klass_name}Support") rescue NameError
+        begin
+          include Object.const_get("#{klass_name}Support")
+        rescue StandardError
+          NameError
+        end
 
         attr_reader :record
 
@@ -42,24 +48,24 @@ module Rulezilla
         @mandatory_attributes ||= []
       end
 
-      def apply(record={})
+      def apply(record = {})
         result_node = trace(record).last
 
         result_node.nil? ? nil : result_node.result(record_klass_instance(record))
       end
 
-      def all(record={})
+      def all(record = {})
         validate_missing_attributes(record)
         result_node = tree.find_all(record_klass_instance(record))
 
         result_node.nil? ? nil : result_node.map { |node| node.result(record_klass_instance(record)) }
       end
 
-      def results(record=nil)
+      def results(record = nil)
         tree.all_results(record_klass_instance(record)).uniq
       end
 
-      def trace(record=nil)
+      def trace(record = nil)
         validate_missing_attributes(record)
 
         tree.trace(record_klass_instance(record))
@@ -74,22 +80,29 @@ module Rulezilla
       end
 
       def tree
-        @tree ||= Tree.new(Node.new())
+        @tree ||= Tree.new(Node.new)
       end
 
       private
 
       def record_klass_instance(record)
-        Object.const_get("#{self.name}Record").new(record)
+        Object.const_get("#{name}Record").new(record)
       end
 
       def missing_attributes(record)
-        record = OpenStruct.new(record) if record.is_a?(Hash)
-        mandatory_attributes.map(&:to_sym) - record.methods
+        record_attributes = if record.is_a?(Hash) || record.is_a?(OpenStruct)
+                              record.to_h.keys.map(&:to_sym)
+                            else
+                              record.methods
+                            end
+
+        mandatory_attributes.map(&:to_sym) - record_attributes
       end
 
       def validate_missing_attributes(record)
-        raise "Missing #{missing_attributes(record).join(', ')} attributes from: #{record}" unless missing_attributes(record).empty?
+        unless missing_attributes(record).empty?
+          raise "Missing #{missing_attributes(record).join(', ')} attributes from: #{record}"
+        end
       end
 
       # DSL methods
@@ -97,22 +110,22 @@ module Rulezilla
         @mandatory_attributes = mandatory_attributes | fields
       end
 
-      def define(name=nil, &block)
+      def define(name = nil, &block)
         tree.create_and_move_to_child(name)
 
         instance_eval(&block)
         tree.go_up
       end
-      alias_method :group, :define
+      alias group define
 
       def condition(&block)
         tree.current_node.condition = block
       end
 
-      def result(value=nil, &block)
+      def result(value = nil, &block)
         tree.current_node.result = value.nil? ? block : value
       end
-      alias_method :default, :result
+      alias default result
 
       # End of DSL methods
     end

data/lib/rulezilla/node.rb

@@ -1,7 +1,13 @@
+# frozen_string_literal: true
+
 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 +23,18 @@ 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