rulezilla 0.1.5 → 0.4.0.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8de468c7423c8fb95e879491361d8587ced03b28
-  data.tar.gz: 9cbbd613deab120d67a6da93e81a4e7fc360ec38
+SHA256:
+  metadata.gz: 434691b52ebffd2edf76724590cc775c0e0e7f616ed842582d747981378d2d99
+  data.tar.gz: 871b3c69b51ac808f85c736f469be1e40d98e906df30e9e38e84c144a64fd862
 SHA512:
-  metadata.gz: 52adab9a3346e9cfb20b58a7197c2a724f823f04d647f2dc313f07cb01ed169c59c5a10c708fe2581a6c7914da33e88a3641f04b02ce337f8d2207dad181df51
-  data.tar.gz: 9fdf3bb8bf2b3366fec2e7d140ade30020113f8e3ef80bdd198720139152e6b3c81a3b816a2c292dcc315e01ed0b26a96687beccfbe25cb848569db8d3d47965
+  metadata.gz: a4a1888024fd3a1d3d6fb0a77340226f6e8882b264951a2e048db3a27b581f22cc0dffef460d4ebc2c6c5b06afdbe9f256b16de26ec3c16134787936a80a13e1
+  data.tar.gz: 192f8072af432fda8ed59f5ac485f9e068eff3aa5c88bba53f43bdc5ca3b026ce4deeb4ee6cfb8102a500a0a726d12860ff7fe6b4c01284d06d713a3647f93d3

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/.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,2 +1,4 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec

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

@@ -31,25 +31,7 @@ On your command line run the following:
 
 ### Rules
 
-Rules can be defined either using `Gherkin` or pure Ruby. In either case, rules are classes that include the `Rulezilla::DSL`.
-
-#### Gherkin (Beta)
-
-> *Note:* Currently, rulezilla Gherkin has only very limited support.
-
-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 to folder holding your feature files'
-
-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 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)
+Rules are defined in Ruby. Rules are classes that include the `Rulezilla::DSL`.
 
 #### Ruby
 

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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rulezilla
   class Node
     attr_accessor :children,
@@ -21,6 +23,7 @@ module Rulezilla
 
     def applies?(record)
       return true if condition.nil?
+
       !!record.instance_eval(&condition)
     end
 

data/lib/rulezilla/tree.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rulezilla
   class Tree
     attr_reader :current_node, :root_node
@@ -14,7 +16,7 @@ module Rulezilla
 
     # Returns all the result outcomes of all the matching nodes.
     #
-    def find_all(record, node=@root_node)
+    def find_all(record, node = @root_node)
       array = []
       if node.applies?(record)
         node.children.each do |child_node|
@@ -26,7 +28,7 @@ module Rulezilla
       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)
@@ -34,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)
@@ -57,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.5'
+  VERSION = '0.4.0.pre.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,22 +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', '~> 2.5')
   gem.add_runtime_dependency('rspec')
-  gem.add_runtime_dependency('turnip')
   gem.add_development_dependency('pry')
   gem.add_development_dependency('pry-doc')
+  gem.add_development_dependency('rubocop')
+  gem.add_development_dependency('turnip')
 end