portable_expressions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d220e43573965935526913968ea27b528aed8eda49f98411f532b9f8c6d134da
+  data.tar.gz: 87bacf2336c7bee890f8dedb7a14db1d79bd87d4678acc33be9a79cf93cd76e8
+SHA512:
+  metadata.gz: 64009910d3f1eab111f64c7c211ed02b4e3a27c94108bcc7cf8f98b7f8548255a1215185a46b0a70c021e18d8b6301dfcccbe3af625764258fe7e0515a2c8783
+  data.tar.gz: eeda6228dbdd334fef7e3f87089e910073e3405d77f0bb426f7e6a56390a89bb0faff70ea2a38a4fe924087fe7f88adbc23e6d0dd1f7177a0ae918e2f5fc8b56

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-03-27
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Omkar Moghe
+
+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

@@ -0,0 +1,304 @@
+# PortableExpressions 🍱
+
+A simple and flexible pure Ruby library for building and evaluating expressions. Expressions can be serialized to and built from JSON strings for portability.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+  `bundle add portable_expressions`
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+  `gem install portable_expressions`
+
+## Usage
+
+> [!IMPORTANT]
+> When using the gem, all references to the models below must be prefixed with `PortableExpressions::`. This is omitted in the README for simplicity.
+
+### Scalar
+
+A `Scalar` is the simplest object that can be evaluated. It holds a single `value`. When used in an `Expression`, this `value` must respond to the symbol (i.e. support the method) defined by the `Expression#operator`.
+
+```ruby
+Scalar.new(1)
+Scalar.new("some string")
+```
+
+### Variable
+
+A `Variable` represents a named value stored in the `Environment`. Unlike `Scalars`, `Variables` have no value until they are evaluated by an `Environment`. Evaluating a `Variable` that isn't present in the `Environment` will result in a `MissingVariableError`.
+
+```ruby
+variable_a = Variable.new("variable_a")
+variable_b = Variable.new("variable_b")
+
+environment = Environment.new(
+  "variable_a" => 1
+)
+environment.evaluate(variable_a) #=> 1
+environment.evaluate(variable_b) #=> MissingVariableError
+```
+
+### Expression
+
+An expression represents 2 or more `operands` that are reduced using a defined `operator`. The `operands` of an `Expression` can be `Scalars`, `Variables`, or other `Expressions`. All `operands` must respond to the symbol (i.e. support the method) defined by the `Expression#operator`. Just like `Variables`, `Expressions` have non value until they're evaluated by an `Environment`.
+
+Evaluating an `Expression` does the following:
+1. all `operands` are first evaluated in order
+1. all resulting _values_ are reduced using the symbol defined by the `operator`
+
+In this way evaluation is "lazy"; it won't evaluate a `Variable` or `Expression` until the `operand` is about to be used.
+
+An `Expression` can store its result back into the `Environment` by defining an `output`.
+
+```ruby
+# addition
+addition = Expression.new(:+, Scalar.new(1), Scalar.new(2))
+
+# multiplication
+multiplication = Expression.new(:*, Variable.new("variable_a"), Scalar.new(2))
+
+# storing output
+storing_output = Expression.new(:+, Scalar.new(1), Scalar.new(2), output: "one_plus_two")
+
+environment = Environment.new(
+  "variable_a" => 2
+)
+environment.evaluate(addition) #=> 3
+environment.evaluate(multiplication) #=> 4
+environment.evaluate(storing_output) #=> 3
+
+environment.variables
+#=> { "variable_a" => 2, "one_plus_two" => 3 }
+```
+
+#### Special `operators`
+
+Some operators, like logical `&&` and `||` are not methods in Ruby, so we pass a special string/symbol that PortableExpressions understands.
+- `&&` is represented by `:and`
+- `||` is represented by `:or`
+
+### Environment
+
+The `Environment` holds state in the form of a `variables` hash and can evaluate `Expressions`, `Scalars`, and `Variables` within a context. The environment handles updates to the state as `Expressions` run.
+
+```ruby
+environment = Environment.new(
+  "variable_a" => 1,
+  "variable_b" => 2,
+)
+
+environment.evaluate(Variable.new("variable_a"))
+#=> 1
+environment.evaluate(Variable.new("variable_c"))
+#=> MissingVariableError "Environment missing variable variable_c."
+
+environment.evaluate(
+  Expression.new(
+    :+,
+    Variable.new("variable_a"),
+    Variable.new("variable_b"),
+    output: "variable_c" # defines where to store the result value
+  )
+)
+#=> 3
+
+environment.variables
+#=> { "variable_a" => 1, "variable_b" => 2, "variable_c" => 3 }
+```
+
+When evaluating multiple objects at a time, the value of the **last** object will be returned.
+
+```ruby
+environment = Environment.new
+environment.evaluate(
+  Scalar.new(1),
+  Expression.new(:+, Scalar.new(1), Scalar.new(2))
+)
+#=> 3
+```
+
+You can update or modify the `variables` hash directly at any time.
+
+```ruby
+environment = Environment.new(
+  "variable_a" => 1
+)
+
+environment.evaluate(Variable.new("variable_a")) # => 1
+environment.variables["variable_a"] = 2
+environment.evaluate(Variable.new("variable_a")) # => 2
+```
+
+### Serialization (to JSON)
+
+All models including the `Environment` support serialization via:
+- `as_json`: builds a serializable `Hash` representation of the object
+- `to_json`: builds a JSON `String` representing the object
+
+All models have a **required** `object` key that indicates the type of object.
+
+### Building (from JSON)
+
+To parse a JSON string, use the `PortableExpressions.from_json` method.
+
+```ruby
+environment_json = <<~JSON
+  {
+    "object": "PortableExpressions::Environment",
+    "variables": {
+      "score_a": 100
+    }
+  }
+JSON
+variable_json = <<~JSON
+  {
+    "object": "PortableExpressions::Variable",
+    "name": "score_a"
+  }
+JSON
+
+environment = PortableExpressions.from_json(environment_json)
+variable_score_a = PortableExpressions.from_json(variable_json)
+environment.evaluate(variable_score_a) #=> 100
+```
+
+### Beyond math
+
+The examples throughout the README show simple arithmetic to illustrate the mechanics of the library. However, `Scalars` and `Variables` can hold any type of value that's JSON serializable, which allows for more complex use cases such as:
+
+#### Logical statements
+
+```ruby
+# variable_a > variable_b && variable_c
+a_greater_than_b = Expression.new(
+  :>,
+  Variable.new("variable_a"),
+  Variable.new("variable_b"),
+)
+conditional = Expression.new(
+  :and,
+  a_greater_than_b,
+  Variable.new("variable_c"),
+)
+Environment.new(
+  "variable_a" => 2,
+  "variable_b" => 1,
+  "variable_c" => "truthy",
+).evaluate(conditional)
+#=> true
+```
+
+> [!TIP]
+> Some operators have special symbols, see [special operators](#special-operators) for more details.
+
+#### String manipulation
+
+```ruby
+# Define a reusable `Expression` using `Variables`.
+repeat_count = Variable.new("repeat")
+string_to_repeat = Variable.new("user_input")
+repeater = Expression.new(:*, string_to_repeat, repeat_count)
+
+# Get inputs from some HTTP controller (e.g. Rails)
+
+# GET /repeater?repeat=3&user_input=cool
+Environment.new(**params).evaluate(repeater) #=> "coolcoolcool"
+# GET /repeater?repeat=3&user_input=alright
+Environment.new(**params).evaluate(repeater) #=> "alrightalrightalright"
+```
+
+#### Authorization policies
+
+First, we define a portable and reusable policies.
+
+```ruby
+# This is a composable policy that checks if a user has permissions for a requested resource and action.
+user_permissions = Variable.new("user_permissions")
+resource = Variable.new("resource")
+action = Variable.new("action")
+requested_permission = Expression.new(:+, resource, Scalar.new("."), action)
+user_has_permission = Expression.new(:include?, user_permissions, requested_permission, output: "user_has_permission")
+
+# Another composable policy that checks if the resource belongs to a user.
+resource_owner = Variable.new("resource_owner")
+user_id = Variable.new("user_id")
+user_owns_resource = Expression.new(:==, resource_owner, user_id, output: "user_owns_resource")
+```
+
+We might decide to combine the policies into a single one:
+
+```ruby
+user_owns_resource_and_has_permission = Expression.new(:and, user_owns_resource, user_has_permission)
+
+# Write to a JSON file
+File.write("user_owns_resource_and_has_permission.json", user_owns_resource_and_has_permission.to_json)
+```
+
+Or we might define a policy the relies on the `output` of other policies. This means that the `Environment` must run the dependencies first in order for their `output` to be available in the `Environment#variables`.
+
+```ruby
+user_owns_resource_and_has_permission = Expression.new(
+  :and,
+  Variable.new("user_owns_resource"),
+  Variable.new("user_has_permission")
+)
+
+# Each of these can be individually run
+File.write("user_has_permission.json", user_has_permission.to_json)
+File.write("user_owns_resource.json", user_owns_resource.to_json)
+# This one relies on the previous 2 being run, or the corresponding variables being set in the `Environment`.
+File.write("user_owns_resource_and_has_permission.json", user_owns_resource_and_has_permission.to_json)
+```
+
+These examples demonstrate portability via JSON files, but we can just as easily serve the policy directly to anyone who needs it via some HTTP controller:
+
+```ruby
+# E.g. Rails via an `ActionController`
+render json: user_owns_resource_and_has_permission.as_json, :ok
+
+# Elsewhere, in the requesting service
+user_owns_resource_and_has_permission = PortableExpressions.from_json(response.body.to_s)
+```
+
+Then, some consumer with access to the user's permissions and context around the requested `resource` and `action` can execute the policy.
+
+```ruby
+environment = Environment.new(
+  "user_permissions" => user.permissions #=> ["blog.read", "blog.write", "comment.read", "comment.write"]
+  "resource" => some_model.resource_name #=> "comment"
+  "action" => "read"
+  "resource_owner" => some_model.user_id
+  "user_id" => user.id
+)
+
+# Combined policy
+user_owns_resource_and_has_permission = PortableExpressions.from_json(
+  File.read("user_owns_resource_and_has_permission.json")
+)
+environment.evaluate(user_owns_resource_and_has_permission) #=> true
+
+# Individual policies
+user_has_permission = PortableExpressions.from_json(File.read("user_has_permission.json"))
+user_owns_resource = PortableExpressions.from_json(File.read("user_owns_resource.json"))
+user_owns_resource_and_has_permission = PortableExpressions.from_json(
+  File.read("user_owns_resource_and_has_permission.json")
+)
+environment.evaluate(user_has_permission, user_owns_resource, user_owns_resource_and_has_permission) #=> true
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/omkarmoghe/portable_expressions.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/portable_expressions/environment.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module PortableExpressions
+  # The `Environment` holds state in the form of a `variables` hash and can evaluate `Expressions`, `Scalars`, and
+  # `Variables` within a context.
+  class Environment
+    include Serializable
+
+    attr_reader :variables
+
+    # @param variables [Hash]
+    def initialize(**variables)
+      @variables = variables
+    end
+
+    # Evaluates each object. Returns the value of the last object
+    # @param objects [Expression, Variable, Scalar] 1 or more object to evaluate.
+    def evaluate(*objects)
+      objects.map { |object| evaluate_one(object) }.last
+    end
+
+    def as_json
+      super.merge(
+        variables: variables
+      )
+    end
+
+    private
+
+    def evaluate_one(object) # rubocop:disable Metrics/MethodLength
+      case object
+      when Scalar
+        object.value
+      when Variable
+        variables.fetch(object.name) do |key|
+          raise MissingVariableError, "Environment missing variable #{key}."
+        end
+      when Expression
+        value = object.operands
+                      .map { |operand| Evaluator.new(evaluate(operand)) }
+                      .reduce(object.operator)
+
+        variables[object.output] = value if object.output
+
+        value
+      end
+    end
+  end
+end

data/lib/portable_expressions/evaluator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module PortableExpressions
+  # Used to wrap `operands` when evaluating an `Expression`. This allows us to "extend" the functionality of an object
+  # without polluting the app wide definition.
+  class Evaluator < SimpleDelegator
+    def and(other)
+      __getobj__ && other.__getobj__
+    end
+
+    def or(other)
+      __getobj__ || other.__getobj__
+    end
+  end
+end

data/lib/portable_expressions/expression.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module PortableExpressions
+  # An expression represents 2 or more `operands` that are reduced using a defined `operator`. The `operands` of an
+  # `Expression` can be `Scalars`, `Variables`, or other `Expressions`. All `operands` must respond to the symbol (i.e.
+  # support the method) defined by the `Expression#operator`.
+  class Expression
+    include Serializable
+
+    ALLOWED_OPERANDS = [
+      Expression,
+      Scalar,
+      Variable
+    ].freeze
+
+    attr_reader :operator, :operands
+    attr_accessor :output # Sometimes you may want to conditionally set an `output` after initialization.
+
+    # @param operator [String, Symbol] Mathematical operator to `reduce` the `operands` array with.
+    # @param *operands [Variable, Expressions] 2 or more Variables, Scalars, or Expressions
+    # @param output [String] The variable to write the expressions output to
+    def initialize(operator, *operands, output: nil)
+      @operator = operator.to_sym
+      @operands = operands
+      @output = output
+
+      validate!
+    end
+
+    # TODO(@omkarmoghe): This string representation might not make the most sense for non-math expressions.
+    def to_s
+      "(#{operands.join(" #{operator} ")})"
+    end
+
+    def as_json
+      super.merge(
+        operator: operator.to_s,
+        operands: operands.map(&:as_json),
+        output: output
+      )
+    end
+
+    private
+
+    def validate!
+      raise InvalidOperandError, "Must provide 2 or more operands." unless operands.length >= 2
+
+      unless (operands.map(&:class) - ALLOWED_OPERANDS).empty?
+        raise InvalidOperandError, "Operands must be one of #{ALLOWED_OPERANDS.inspect}."
+      end
+
+      nil
+    end
+  end
+end

data/lib/portable_expressions/modules/serializable.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module PortableExpressions
+  module Serializable
+    def as_json
+      {
+        object: self.class.name
+      }
+    end
+
+    def to_json(pretty: false)
+      if pretty
+        JSON.pretty_generate(as_json)
+      else
+        JSON.generate(as_json)
+      end
+    end
+  end
+end

data/lib/portable_expressions/scalar.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module PortableExpressions
+  # A `Scalar` is the simplest object that can be evaluated. It holds a single `value`. When used in an `Expression`,
+  # this `value` must respond to the symbol (i.e. support the method) defined by the `Expression#operator`.
+  class Scalar
+    include Serializable
+
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+    end
+
+    def to_s
+      value.to_s
+    end
+
+    def as_json
+      super.merge(
+        value: value
+      )
+    end
+  end
+end

data/lib/portable_expressions/variable.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module PortableExpressions
+  # A `Variable` represents a named value stored in the `Environment`. Unlike `Scalars`, `Variables` have no value
+  # until they are evaluated by an `Environment`. Evaluating a `Variable` that isn't present in the `Environment` will
+  # result in a `MissingVariableError`.
+  class Variable
+    include Serializable
+
+    attr_reader :name
+
+    def initialize(name)
+      @name = name
+    end
+
+    def to_s
+      name
+    end
+
+    def as_json
+      super.merge(
+        name: name
+      )
+    end
+  end
+end

data/lib/portable_expressions/version.rb

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

data/lib/portable_expressions.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+# Ruby lib
+require "delegate"
+require "json"
+
+require_relative "portable_expressions/version"
+require_relative "portable_expressions/modules/serializable"
+require_relative "portable_expressions/evaluator"
+require_relative "portable_expressions/scalar"
+require_relative "portable_expressions/variable"
+require_relative "portable_expressions/expression"
+require_relative "portable_expressions/environment"
+
+module PortableExpressions
+  Error = Class.new(StandardError)
+
+  DeserializationError = Class.new(Error)
+  InvalidOperandError = Class.new(Error)
+  InvalidOperatorError = Class.new(Error)
+  MissingVariableError = Class.new(Error)
+
+  # @param json [String, Hash]
+  # @return [Expression, Scalar, Variable, Environment]
+  def self.from_json(json)
+    json = JSON.parse(json) if json.is_a?(String)
+
+    case json["object"]
+    when Environment.name
+      Environment.new(**json["variables"])
+    when Expression.name
+      operator = json["operator"].to_sym
+      operands_json = json["operands"]
+      operands = operands_json.map { |operand_json| from_json(operand_json) }
+
+      Expression.new(operator, *operands)
+    when Variable.name
+      Variable.new(json["name"])
+    when Scalar.name
+      Scalar.new(json["value"])
+    else
+      raise DeserializationError, "Object class #{json["object"]} does not support deserialization."
+    end
+  rescue JSON::ParserError => e
+    raise DeserializationError, "Unable to parse JSON: #{e.message}."
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: portable_expressions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Omkar Moghe
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.16'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description:
+email:
+- yo@omkr.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/portable_expressions.rb
+- lib/portable_expressions/environment.rb
+- lib/portable_expressions/evaluator.rb
+- lib/portable_expressions/expression.rb
+- lib/portable_expressions/modules/serializable.rb
+- lib/portable_expressions/scalar.rb
+- lib/portable_expressions/variable.rb
+- lib/portable_expressions/version.rb
+homepage: https://github.com/omkarmoghe/portable_expressions
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/omkarmoghe/portable_expressions
+  source_code_uri: https://github.com/omkarmoghe/portable_expressions
+  changelog_uri: https://github.com/omkarmoghe/portable_expressions/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key:
+specification_version: 4
+summary: A simple and flexible pure Ruby library for building and evaluating expressions.
+test_files: []