predicate_scope 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4303a83687a4e642391b48835df15110a27b8332106b20c3862ae0bb3783cddf
+  data.tar.gz: 90f46bdeb4d84e7845cdba2b261950eb0f6ea307dc03dc6069801050e8d36b33
+SHA512:
+  metadata.gz: 5e866550daef989fa62270f6643d4bde7ef6c0d1a4c4bf873e5e64fa3712b8e33db1533e5cb3ff25ce0c8873d5dbcd5d5f7a2537f0904b53e9421b49b9748140
+  data.tar.gz: f297f94b3beb585607f0a7abb4b72561ecd8a75936d2f8ef8af06fad44b5d00c02546ce3540d096bdfff3fc2361a258ecb0786cdd91aa8d43c5917d0087e9592

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    predicate_scope (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.1.3.2)
+      activesupport (= 7.1.3.2)
+    activerecord (7.1.3.2)
+      activemodel (= 7.1.3.2)
+      activesupport (= 7.1.3.2)
+      timeout (>= 0.4.0)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.7)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.1)
+    drb (2.2.1)
+    i18n (1.14.4)
+      concurrent-ruby (~> 1.0)
+    minitest (5.22.3)
+    mutex_m (0.2.0)
+    rake (13.2.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    sqlite3 (1.7.3-aarch64-linux)
+    sqlite3 (1.7.3-arm-linux)
+    sqlite3 (1.7.3-arm64-darwin)
+    sqlite3 (1.7.3-x86-linux)
+    sqlite3 (1.7.3-x86_64-darwin)
+    sqlite3 (1.7.3-x86_64-linux)
+    timeout (0.4.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  aarch64-linux
+  arm-linux
+  arm64-darwin
+  x86-linux
+  x86_64-darwin
+  x86_64-linux
+
+DEPENDENCIES
+  activerecord (~> 7.1)
+  bundler (~> 2.5)
+  predicate_scope!
+  rake (~> 13.2)
+  rspec (~> 3.13)
+  sqlite3 (~> 1.4)
+
+BUNDLED WITH
+   2.5.10

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Chris Stadler
+
+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,93 @@
+# predicate_scope
+
+Have you ever written code like this?
+
+```rb
+class User < ActiveRecord::Base
+  scope :active, -> { where(deleted: false, state: "confirmed") }
+
+  def active?
+    !deleted && state == "confirmed"
+  end
+end
+```
+
+And noticed that the definition of an "active" user is duplicated? What if the
+definition changes, and you forget to update both places?
+
+With `predicate_scope` you can write it once:
+
+```rb
+class User < ActiveRecord::Base
+  include PredicateScope
+
+  predicate_scope :active, -> { where(deleted: false, state: "confirmed") }
+end
+```
+
+This defines two methods:
+- A `User.active` scope, as if you had used `scope` like normal.
+- A predicate instance method `User#active?`, which behaves just like the
+hand-written version of `active?` in the original example:
+
+```rb
+user = User.new(deleted: false, state: "confirmed")
+user.active? # true
+user.state = "unconfirmed"
+user.active? # false
+```
+
+The predicate method checks the conditions of the scope against the instance _in
+memory_, without querying the database. Again, just like the hand-written `active?`.
+
+## Implementation
+
+In addition to `predicate_scope`, this gem also defines a instance method
+`#satisfies_conditions_of?`. This takes an `ActiveRecord::Relation` and returns
+whether the instance it is called on satisfies its conditions. The predicate
+methods defined by `predicate_scope` call `satisfies_conditions_of?` with the
+relation from the scope. So in the above example `user.active?` is implemented
+as `user.satisfies_conditions_of?(User.active)`.
+
+`satisfies_conditions_of? ` extracts the `Arel` abstract syntax tree (AST)
+from the given `ActiveRecord::Relation` and interprets its conditions as Ruby
+predicates. These predicates are evaluated against the instance.
+
+## Limitations
+
+Not all `Arel` operations are implemented. If you define
+a `predicate_scope` that uses an unsupported operation
+`PredicateScope::Errors::UnsupportedOperation` will be raised when the predicate
+method is called. PRs to implement additional operations are appreciated!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```rb
+gem 'predicate_scope'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install predicate_scope
+
+In any models where you want to use `predicate_scope` add
+
+```rb
+include PredicateScope
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/CJStadler/predicate_scope.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

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/predicate_scope.rb

@@ -0,0 +1,144 @@
+module PredicateScope
+  VERSION = "0.1.0"
+
+  module Errors
+    class UnsupportedOperation < StandardError
+      def initialize(node)
+        super("Operation node type #{node.class} is not yet supported.")
+      end
+    end
+
+    class UnsupportedAttribute < StandardError
+      def initialize(attribute)
+        super("Attribute type #{attribute.class} is not yet supported.")
+      end
+    end
+
+    class UnsupportedInOperand < StandardError
+      def initialize(operand)
+        super("In operations with operand type #{operand.class} are not yet supported.")
+      end
+    end
+
+    class MissingAssociation < StandardError
+      def initialize(table)
+        super("Missing association for table \"#{table}\". You probably need to join it.")
+      end
+    end
+
+    class MultipleCores < StandardError
+      def initialize
+        super("More than one core is not yet supported.")
+      end
+    end
+  end
+
+  module ClassMethods
+    def predicate_scope(scope_name, relation_proc, ...)
+      # Add the scope to the class.
+      scope(scope_name, relation_proc, ...)
+
+      # Define the predicate instance method.
+      predicate_name = :"#{scope_name}?"
+      define_method(predicate_name) do |*predicate_args|
+        relation = relation_proc.call(*predicate_args)
+        satisfies_conditions_of?(relation)
+      end
+    end
+  end
+
+  class Evaluator
+    def initialize(relation, instance)
+      @relation = relation
+      @instance = instance
+
+      @instances_by_table = { instance.class.table_name => instance }
+      associations = relation.values[:joins].to_a.chain(relation.values[:includes].to_a)
+      associations.each do |association_name|
+        object = instance.public_send(association_name)
+        @instances_by_table[object.class.table_name] = object
+      end
+    end
+
+    def eval
+      cores = @relation.arel.ast.cores
+      if cores.length > 1
+        raise Errors::MultipleCores.new
+      end
+      root = cores.first
+      eval_node(root)
+    end
+
+    private
+
+    def eval_node(node)
+      case node
+      in Arel::Nodes::SelectCore
+        node.wheres.all? { |node| eval_node(node) }
+      in Arel::Nodes::Not
+        !eval_node(node.expr)
+      in Arel::Nodes::And
+        node.children.all? { |child| eval_node(child) }
+      in Arel::Nodes::Or
+        eval_node(node.left) || eval_node(node.right)
+      # This is used with `or` but I don't know what it represents.
+      in Arel::Nodes::Grouping
+        eval_node(node.expr)
+      in Arel::Nodes::In
+        attribute_value = eval_attribute(node.left)
+        if node.right.is_a?(Enumerable)
+          node.right.any? { |value| value == attribute_value }
+        else
+          raise Errors::UnsupportedInOperand.new(node.right)
+        end
+      in Arel::Nodes::HomogeneousIn
+        attribute_value = eval_attribute(node.attribute)
+        node.values.any? { |value| value == attribute_value }
+      in Arel::Nodes::Equality
+        eval_comparison(node, :==)
+      in Arel::Nodes::NotEqual
+        eval_comparison(node, :!=)
+      in Arel::Nodes::GreaterThan
+        eval_comparison(node, :>)
+      in Arel::Nodes::LessThan
+        eval_comparison(node, :<)
+      in Arel::Nodes::GreaterThanOrEqual
+        eval_comparison(node, :>=)
+      in Arel::Nodes::LessThanOrEqual
+        eval_comparison(node, :<=)
+      else
+        raise Errors::UnsupportedOperation.new(node)
+      end
+    end
+
+    def eval_comparison(node, operator)
+      eval_attribute(node.left).public_send(operator, eval_attribute(node.right))
+    end
+
+    def eval_attribute(attribute)
+      case attribute
+      in Arel::Attributes::Attribute
+        table_name = attribute.relation.name
+        instance = @instances_by_table[table_name]
+
+        if instance
+          instance.public_send(attribute.name)
+        else
+          raise Errors::MissingAssociation.new(table_name)
+        end
+      in ActiveRecord::Relation::QueryAttribute | Arel::Nodes::Casted
+        attribute.value
+      else
+        raise Errors::UnsupportedAttribute.new(attribute)
+      end
+    end
+  end
+
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+
+  def satisfies_conditions_of?(relation)
+    Evaluator.new(relation, self).eval
+  end
+end

data/predicate_scope.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "predicate_scope"
+
+Gem::Specification.new do |spec|
+  spec.name          = "predicate_scope"
+  spec.version       = PredicateScope::VERSION
+  spec.authors       = ["Chris Stadler"]
+  spec.email         = ["chrisstadler@gmail.com"]
+
+  spec.summary       = 'Check whether an ActiveRecord instance satisfies the conditions of a relation, in memory'
+  spec.homepage      = "https://github.com/CJStadler/predicate_scope"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 3.0"
+
+  spec.add_development_dependency "bundler", "~> 2.5"
+  spec.add_development_dependency "rake", "~> 13.2"
+  spec.add_development_dependency "rspec", "~> 3.13"
+  spec.add_development_dependency "activerecord", "~> 7.1"
+  spec.add_development_dependency "sqlite3", "~> 1.4" # activerecord seems to require this version.
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification
+name: predicate_scope
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Stadler
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: 
+email:
+- chrisstadler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/setup
+- lib/predicate_scope.rb
+- predicate_scope.gemspec
+homepage: https://github.com/CJStadler/predicate_scope
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.10
+signing_key: 
+specification_version: 4
+summary: Check whether an ActiveRecord instance satisfies the conditions of a relation,
+  in memory
+test_files: []