rulezilla 0.4.5 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8ee7727cfe6615645b0684d845b89a12acb2f2c67791ce3a0804500ee5e2ab9
-  data.tar.gz: d087ce428c000b31fb7c5a63fd0fbfa63de0784103cb08792724977d59a1855b
+  metadata.gz: 6941c7f485cc90010f97357c0662d7dd36c363be4067e02dd83d2e0aa034ab32
+  data.tar.gz: e87b673510615deeb29977215da82d056d17b33870d12982637b9af5f027374d
 SHA512:
-  metadata.gz: be36cd5e03915645c49ac0ed3abcd893ae54c3a33cf650635bbe82457b45cd8499e1beb72816d2e1feedb1829177f9fc89dd5e7e9790c144a3e333255b4f90d3
-  data.tar.gz: 16f3705107ff1e3d9ad3e0a45740b90ad60b4aad80d340a0bf97ab0ef2a38ee800deca1480f0ba6c71acceb1fd7fd9056703811c53fb18f538fc87edfa19ee02
+  metadata.gz: d0dd7029f354b0d45e13a300367cb56c34754e5df15985cef57c4e6c704805b3d1f3474f19c4d38ee83c0df33267cd7c0487e91aedeb711b2763e8c1f18df8a7
+  data.tar.gz: fab0af6a0152a830c58ef882c625e6e25861a3ffcd1a076d407a7592da96ad7abf3d22209cf9ed1575a85d5960fa462549a4cf6a6611cad373103907751540a3

data/.github/workflows/ci.yaml

@@ -18,7 +18,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby-version: [2.7, 3.0, 3.1]
+        ruby-version: [3.2, 3.3, 3.4]
 
     steps:
     - uses: actions/checkout@v3

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

@@ -0,0 +1,30 @@
+name: Huxley TechDocs
+
+on:
+  workflow_dispatch:
+  push:
+    branches: master
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - ".github/workflows/publish-docs.yaml"
+  pull_request:
+    branches: master
+    paths:
+      - "docs/**"
+      - "mkdocs.yaml"
+      - ".github/workflows/publish-docs.yaml"
+  schedule:
+    - cron: "15 3 1 * *"
+
+concurrency: huxley-techdocs-${{ github.ref }}
+
+jobs:
+  publish-techdocs:
+    uses: simplybusiness/github-action-reusable-workflows/.github/workflows/techdocs.yaml@v1
+    with:
+      repo: "github-action-reusable-workflows"
+    secrets:
+      region: ${{ secrets.AWS_LIVE_CICD_REGION }}
+      aws-access-key-id: ${{ secrets.AWS_LIVE_CICD_ACCESS_KEY_ID }}
+      aws-secret-access-key: ${{ secrets.AWS_LIVE_CICD_SECRET_ACCESS_KEY }}

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

@@ -13,7 +13,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: simplybusiness/version-forget-me-not@v2.3.0
+      - uses: simplybusiness/version-forget-me-not@v2
         env:
           ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           VERSION_FILE_PATH: "lib/rulezilla/version.rb"

data/.gitignore

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

data/.rubocop_todo.yml

@@ -1,36 +1,36 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-07-06 10:13:12 UTC using RuboCop version 1.31.1.
+# on 2025-02-28 15:35:40 UTC using RuboCop version 1.73.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.
+# Configuration parameters: Severity, Include.
 # Include: **/*.gemspec
 Gemspec/RequiredRubyVersion:
   Exclude:
     - 'rulezilla.gemspec'
 
 # Offense count: 1
-# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 20
 
 # Offense count: 2
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
-# IgnoredMethods: refine
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
 Metrics/BlockLength:
   Max: 32
 
 # Offense count: 2
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 19
 
 # Offense count: 3
-# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros.
+# Configuration parameters: NamePrefix, ForbiddenPrefixes, AllowedMethods, MethodDefinitionMacros, UseSorbetSigs.
 # NamePrefix: is_, has_, have_
 # ForbiddenPrefixes: is_, has_, have_
 # AllowedMethods: is_a?
@@ -41,7 +41,7 @@ Naming/PredicateName:
     - 'lib/rulezilla/node.rb'
     - 'lib/rulezilla/tree.rb'
 
-# Offense count: 6
+# Offense count: 5
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Exclude:
@@ -51,11 +51,10 @@ Style/Documentation:
     - 'lib/rulezilla/dsl.rb'
     - 'lib/rulezilla/node.rb'
     - 'lib/rulezilla/tree.rb'
-    - 'lib/rulezilla/version.rb'
 
-# Offense count: 3
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: MinBodyLength, AllowConsecutiveConditionals.
 Style/GuardClause:
   Exclude:
     - 'lib/rulezilla/dsl.rb'
-    - 'rulezilla.gemspec'

data/.ruby-version

@@ -1 +1 @@
-3.1.2
+3.4.1

data/README.md

@@ -1,115 +1 @@
-[![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 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
-
-## Using `Gemfile`
-
-Add the following line to your `Gemfile`:
-
-    gem 'rulezilla'
-
-Then run:
-
-    bundle install
-
-## Without `Gemfile`
-
-On your command line run the following:
-
-    gem install 'rulezilla'
-
-## Usage
-
-### Rules
-
-Rules are defined in Ruby. Rules are classes that include the `Rulezilla::DSL`.
-
-#### Ruby
-
-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.
-
-Here is an example:
-
-    class RoboticsRule
-      include Rulezilla::DSL
-
-      group :may_not_injure_human do
-        condition { not_injure_human? }
-
-        group :obey_human do
-          condition { do_as_human_told? }
-
-          define :protect_its_own_existence do
-            condition { protect_itself? }
-            result(true)
-          end
-        end
-      end
-
-      default(false)
-
-    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"`
-
-e.g. if the rule class name is `RoboticsRule`, then the support would be `RoboticsRuleSupport`
-
-    module RoboticsRuleSupport
-      def protect_itself?
-        in_danger? && not_letting_itself_be_detroyed?
-      end
-    end
-
-### How to execute the rule
-
-If the entity is:
-
-    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 output
-
-    RoboticsRule.apply(entity) #=> true
-
-#### To get all matching result outputs
-
-    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 nodes
-
-    RoboticsRule.trace(entity)
-    #=> all the nodes instance: [root, may_not_injure_human, obey_human, protect_its_own_existence] in sequence order.
-
-#### To get all results from the Rule
-
-    RoboticsRule.results #=> [true, false]
-
-
-### Syntax
-
-Please refer to the features for DSL syntax:
-
-[DSL Feature](spec/features/rulezilla_dsl_framework.feature),
-
-[Default Support Methods Feature](spec/features/default_support_methods.feature)
+All documentation is now in the `docs/` subdirectory, or can be viewed in rendered form on Backstage. Start with the [index](docs/index.md)

data/_pipeline/stage_publishdocs.yml

@@ -0,0 +1,9 @@
+version: 0.2
+
+phases:
+  install:
+    commands:
+      - docker_setup
+  build:
+    commands:
+      - run_huxley publish_backstage_docs

data/catalog-info.yaml

@@ -2,7 +2,9 @@ apiVersion: backstage.io/v1alpha1
 kind: Component
 metadata:
   name: rulezilla
-  description:  Rule DSL 
+  description:  Rule DSL
+  annotations:
+    backstage.io/techdocs-ref: dir:. 
 spec:
   type: library
   lifecycle: production

data/docs/index.md

@@ -0,0 +1,115 @@
+[![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 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
+
+## Using `Gemfile`
+
+Add the following line to your `Gemfile`:
+
+    gem 'rulezilla'
+
+Then run:
+
+    bundle install
+
+## Without `Gemfile`
+
+On your command line run the following:
+
+    gem install 'rulezilla'
+
+## Usage
+
+### Rules
+
+Rules are defined in Ruby. Rules are classes that include the `Rulezilla::DSL`.
+
+#### Ruby
+
+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.
+
+Here is an example:
+
+    class RoboticsRule
+      include Rulezilla::DSL
+
+      group :may_not_injure_human do
+        condition { not_injure_human? }
+
+        group :obey_human do
+          condition { do_as_human_told? }
+
+          define :protect_its_own_existence do
+            condition { protect_itself? }
+            result(true)
+          end
+        end
+      end
+
+      default(false)
+
+    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"`
+
+e.g. if the rule class name is `RoboticsRule`, then the support would be `RoboticsRuleSupport`
+
+    module RoboticsRuleSupport
+      def protect_itself?
+        in_danger? && not_letting_itself_be_detroyed?
+      end
+    end
+
+### How to execute the rule
+
+If the entity is:
+
+    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 output
+
+    RoboticsRule.apply(entity) #=> true
+
+#### To get all matching result outputs
+
+    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 nodes
+
+    RoboticsRule.trace(entity)
+    #=> all the nodes instance: [root, may_not_injure_human, obey_human, protect_its_own_existence] in sequence order.
+
+#### To get all results from the Rule
+
+    RoboticsRule.results #=> [true, false]
+
+
+### Syntax
+
+Please refer to the features for DSL syntax:
+
+[DSL Feature](spec/features/rulezilla_dsl_framework.feature),
+
+[Default Support Methods Feature](spec/features/default_support_methods.feature)

data/lib/rulezilla/dsl.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'ostruct'
+
 module Rulezilla
   module DSL
     def self.included(base)

data/lib/rulezilla/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rulezilla
-  VERSION = '0.4.5'
+  VERSION = '0.4.7'
 end

data/mkdocs.yaml

@@ -0,0 +1,8 @@
+site_name: Rulezilla Docs
+repo_url: https://github.com/simplybusiness/rulezilla
+edit_uri: blob/master/docs/
+docs_dir: "docs"
+nav:
+  - Home: index.md
+plugins:
+  - techdocs-core

data/rulezilla.gemspec

@@ -17,6 +17,7 @@ Gem::Specification.new do |gem|
   gem.version       = Rulezilla::VERSION
   gem.license       = 'MIT'
 
+  gem.add_runtime_dependency('ostruct')
   gem.add_runtime_dependency('rspec')
   gem.add_development_dependency('pry')
   gem.add_development_dependency('pry-doc')

metadata

@@ -1,15 +1,28 @@
 --- !ruby/object:Gem::Specification
 name: rulezilla
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.7
 platform: ruby
 authors:
 - Simply Business
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-04 00:00:00.000000000 Z
+date: 2025-02-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +104,7 @@ files:
 - ".github/workflows/codeql-analysis.yaml"
 - ".github/workflows/dobby-actions.yml"
 - ".github/workflows/gem-publish.yaml"
+- ".github/workflows/publish-docs.yaml"
 - ".github/workflows/version-forget-me-not.yaml"
 - ".gitignore"
 - ".rspec"
@@ -101,13 +115,16 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- _pipeline/stage_publishdocs.yml
 - catalog-info.yaml
+- docs/index.md
 - lib/rulezilla.rb
 - lib/rulezilla/basic_support.rb
 - lib/rulezilla/dsl.rb
 - lib/rulezilla/node.rb
 - lib/rulezilla/tree.rb
 - lib/rulezilla/version.rb
+- mkdocs.yaml
 - rulezilla.gemspec
 - spec/features/default_support_methods.feature
 - spec/features/rulezilla_dsl_framework.feature
@@ -117,7 +134,6 @@ homepage: https://github.com/simplybusiness/rulezilla
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -132,8 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Rules DSL
 test_files: []