makes_sense 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a2206b5da4722518a9ef5028e9e8fd3acdd6fdd98406927d76b776d5ad48cf05
+  data.tar.gz: b25d323b3d861b321598eba5bb6a43ccd7bed1fedb07282a9df1525f772f9763
+SHA512:
+  metadata.gz: f76f1bdbb6a42428e71c41e0e2413ac4b6d7d6cd5c61d6cbc9fd46291ef259ae46c0a2c7518994533265b2f7b687fff4eeaba92ea3b22e35a197bbe9e2ef4d31
+  data.tar.gz: 41bc9a922d55cbd1b5b01eabeea1313da3ab9aaef50a42bf40271f1c8ccd7dcc6379fecffe7f03234657c4192f1b0735e4f1bb3bc9e2430a472b602b1cd546c1

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at smizell@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in makes_sense.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    makes_sense (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.5.0)
+    method_source (1.0.0)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+
+PLATFORMS
+  arm64-darwin-20
+
+DEPENDENCIES
+  makes_sense!
+  pry
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.2.26

data/README.md

@@ -0,0 +1,37 @@
+# MakesSense
+
+Define a Decision Table in Ruby code, validate it, and execute a ruleset against it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'makes_sense'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install makes_sense
+
+## Usage
+
+This is a work in progress. Please see the [specs](./spec/) directory for now to see how to use this library
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/makes_sense. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/makes_sense/blob/master/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the MakesSense project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/makes_sense/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "makes_sense"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/makes_sense/decision_table.rb

@@ -0,0 +1,190 @@
+require_relative "result"
+require_relative "values"
+
+module MakesSense
+  Condition = Struct.new(:name, :values)
+  ResultTable = Struct.new(:rows)
+  Row = Struct.new(:conditions, :results, :row_index)
+
+  class DecisionTable
+    def initialize(name, conditions, result_table, args)
+      @name = name
+      @conditions = conditions
+      @result_table = result_table
+      @args = args
+    end
+
+    def self.define(name, &block)
+      dsl = DecisionTableDsl.new
+      dsl.instance_eval(&block)
+      new(name, dsl.conditions, dsl.result_table, dsl.args)
+    end
+
+    def validate
+      condition_values = @conditions.map(&:values)
+      possible_conditions = condition_values[0].product(*condition_values[1..])
+      expanded_rows = expand_rows
+      expanded_row_conditions = expanded_rows.map(&:conditions)
+
+      errors = []
+
+      possible_conditions.each do |possible_condition|
+        unless expanded_row_conditions.include?(possible_condition)
+          errors << {
+            type: :missing,
+            message: "Missing result condition: #{possible_condition}",
+            expected_conditions: possible_condition,
+            expected: {}.tap do |condition_map|
+              @conditions.each_with_index do |condition, index|
+                condition_map[condition.name] = possible_condition[index]
+              end
+            end
+          }
+        end
+      end
+
+      visited = []
+
+      expanded_rows.each do |row|
+        found_index = visited.find_index(row.conditions)
+        if found_index
+          errors << {
+            type: :duplicate,
+            message: "Duplicate result #{row.conditions} for rows #{found_index} and #{row.row_index}",
+            row: row,
+            duplicate_index: found_index
+          }
+        end
+
+        visited << row.conditions
+      end
+
+      if !errors.empty?
+        Failure.new(errors)
+      else
+        Success.new(self)
+      end
+    end
+
+    def with_ruleset(ruleset)
+      ->(**kwargs) do
+        expanded_rows = expand_rows
+
+        ruleset_results = @conditions.map do |condition|
+          method_kwarg_names = ruleset.method(condition.name).parameters.map { |parameter| parameter[1] }
+          args = method_kwarg_names.map { |kwarg_name| kwargs[kwarg_name] }
+          ruleset.public_send(condition.name, *args)
+        end
+
+        result_row = @result_table.rows.find do |row|
+          row.conditions == ruleset_results
+        end
+
+        if result_row.results.respond_to?(:call)
+          method_kwarg_names = result_row.results.parameters.map { |parameter| parameter[1] }
+          args = method_kwarg_names.map { |kwarg_name| kwargs[kwarg_name] }
+          result_row.results.call(*args)
+        else
+          result_row.results
+        end
+      end
+    end
+
+    private
+
+    # Expands rows where `any` is used
+    # It will replace an `any` with an array of the respective values.
+    # It will then take the product of those to create the correct number of new rows.
+    def expand_rows
+      new_rows = []
+
+      @result_table.rows.each_with_index do |row, row_index|
+        needs_expansion = row.conditions.any? { |condition| condition.is_a?(Values::Any) }
+
+        unless needs_expansion
+          new_rows << row
+          next
+        end
+
+        collected = []
+        current = []
+
+        row.conditions.each_with_index do |condition, index|
+          case condition
+          when Values::Any
+            unless current.empty?
+              collected << current
+              current = []
+            end
+
+            collected << @conditions[index].values
+          else
+            current << condition
+          end
+        end
+
+        collected << current unless current.empty?
+
+        # When the `collected` length is `1`, it results in unexpected values with `#reduce`
+        # Checking for the length and only reducing when it's greater than one causes the
+        # resulting value to be as expected.
+        new_conditions =
+          if collected.length > 1
+            collected.reduce { |a, b| a.product(b) }
+          else
+            collected[0].map { |v| [v] }
+          end
+
+        new_conditions.each do |conditions|
+          new_rows << Row.new(conditions, row.results, row_index)
+        end
+      end
+
+      new_rows
+    end
+  end
+
+  class DecisionTableDsl
+    include Values
+
+    attr_reader :args, :conditions, :result_table
+
+    def initialize
+      @args = []
+      @conditions = []
+      @result_table = nil
+    end
+
+    def arg(name)
+      @args << name
+    end
+
+    def condition(name, type)
+      values =
+        case type
+        when :bool then [t, f]
+        end
+
+      @conditions << Condition.new(name, values)
+    end
+
+    def table(&block)
+      result_table = ResultTable.new([])
+      dsl = ResultTableDsl.new(result_table)
+      dsl.instance_eval(&block)
+      @result_table = result_table
+    end
+  end
+
+  class ResultTableDsl
+    include Values
+
+    def initialize(result_table)
+      @result_table = result_table
+    end
+
+    def row(conditions, results)
+      @result_table.rows << Row.new(conditions, results, @result_table.rows.length)
+    end
+  end
+end

data/lib/makes_sense/result.rb

@@ -0,0 +1,47 @@
+module MakesSense
+  class Success
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+    end
+
+    def success?
+      true
+    end
+
+    def failure?
+      false
+    end
+
+    def value!
+      @value
+    end
+
+    def failure
+      raise "Not a failure"
+    end
+  end
+
+  class Failure
+    def initialize(value)
+      @value = value
+    end
+
+    def success?
+      false
+    end
+
+    def failure?
+      true
+    end
+
+    def value!
+      raise "Not successful"
+    end
+
+    def failure
+      @value
+    end
+  end
+end

data/lib/makes_sense/values.rb

@@ -0,0 +1,17 @@
+module MakesSense
+  module Values
+    def t
+      true
+    end
+
+    def f
+      false
+    end
+
+    class Any; end
+
+    def any
+      Any.new
+    end
+  end
+end

data/lib/makes_sense/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MakesSense
+  VERSION = "0.1.0"
+end

data/lib/makes_sense.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "makes_sense/version"
+require_relative "makes_sense/decision_table"
+
+module MakesSense
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/makes_sense.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/makes_sense/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "makes_sense"
+  spec.version = MakesSense::VERSION
+  spec.authors = ["Stephen Mizell"]
+
+  spec.summary = "Write, validate, and use decision tables for logic"
+  spec.description = "Write, validate, and use decision tables for logic"
+  spec.homepage = "https://github.com/smizell/makes_sense"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  # spec.metadata["allowed_push_host"] = "https://mygemserver.com"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/smizell/makes_sense"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_development_dependency "pry"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: makes_sense
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephen Mizell
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-06 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: Write, validate, and use decision tables for logic
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/makes_sense.rb
+- lib/makes_sense/decision_table.rb
+- lib/makes_sense/result.rb
+- lib/makes_sense/values.rb
+- lib/makes_sense/version.rb
+- makes_sense.gemspec
+homepage: https://github.com/smizell/makes_sense
+licenses: []
+metadata:
+  homepage_uri: https://github.com/smizell/makes_sense
+  source_code_uri: https://github.com/smizell/makes_sense
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Write, validate, and use decision tables for logic
+test_files: []