where_row 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a268067ae2cd7fad7fd98ea9045e77177da3cf2d947e4afeb8fae3c1ecb67faa
+  data.tar.gz: 2766f2ef380e2c8ce905c5e66afdf566dc844c8f1e593ecfe59781a9e378123e
+SHA512:
+  metadata.gz: e13710f2b6f696b0d4d159f66f1f8aa14b52394b69383b0e1a4569c8e2705157e40f02f1f56822df3d04ebed9bb01afd160587d0c5f084acc31d2a2ac4c586ee
+  data.tar.gz: bb7c6db0fc15cce4947768add34dd18fb86c1d7f76fc00d530296a269a10ac33297f3e5b61d2cc966fbbd67569794cb43e927169ad896eb0ba4ca7973fb0797c

data/.gitignore

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

data/.rspec

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

data/Appraisals

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+appraise "active_record_52" do
+  gem "activerecord", "~> 5.2.0", require: "active_record"
+end
+
+appraise "active_record_60" do
+  gem "activerecord", "~> 6.0.0", require: "active_record"
+end
+
+appraise "active_record_61" do
+  gem "activerecord", "~> 6.1.0", require: "active_record"
+end
+
+appraise "active_record_70" do
+  gem "activerecord", "~> 7.0.0", require: "active_record"
+end

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in where_row.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,66 @@
+PATH
+  remote: .
+  specs:
+    where_row (0.1.0)
+      activerecord (>= 5.2, < 7.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.7.3)
+      activesupport (= 6.1.7.3)
+    activerecord (6.1.7.3)
+      activemodel (= 6.1.7.3)
+      activesupport (= 6.1.7.3)
+    activesupport (6.1.7.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    appraisal (2.4.1)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    i18n (1.14.0)
+      concurrent-ruby (~> 1.0)
+    mini_portile2 (2.8.2)
+    minitest (5.15.0)
+    rake (10.5.0)
+    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)
+    sqlite3 (1.6.3)
+      mini_portile2 (~> 2.8.0)
+    thor (1.2.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    yard (0.9.34)
+    zeitwerk (2.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  bundler (~> 1.17)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  sqlite3
+  where_row!
+  yard
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Odysseas Doumas
+
+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,97 @@
+# WhereRow
+
+A minimalistic Rails gem to allow easy use of SQL row value syntax.
+
+Sometimes, the classic offset method to paginate results can be very inneficient, and not the best approach for some problems such as infinite scrolling. The seek method is a good alternative for these cases.
+
+Consider the following example, as it appears on [Use The Index Luke](https://use-the-index-luke.com/sql/partial-results/fetch-next-page)
+
+```SQL
+CREATE INDEX sl_dtid ON sales (sale_date, sale_id)
+
+SELECT *
+  FROM sales
+ WHERE (sale_date, sale_id) < (?, ?)
+ ORDER BY sale_date DESC, sale_id DESC
+ FETCH FIRST 10 ROWS ONLY
+```
+
+The Row Value syntax is straigth not supported in Rails in any way. Furthermore, some databases still don't support this syntax as well, or
+maybe there is partial support (for example, the index is not properly utilized).
+
+Thankfully, the same results can be achieved with plain-old logical expressions and comparisons. The equivalent query would look like this:
+
+```SQL
+ SELECT *
+  FROM sales
+ WHERE sale_date <= ?
+ AND NOT (sale_date = ? AND sale_id >= ?)
+ ORDER BY sale_date DESC, sale_id DESC
+ FETCH FIRST 10 ROWS ONLY
+```
+
+This is something that can be directly expressed in Rails/ One possible way is the following:
+
+```ruby
+    Sales.
+        where(sale_date: (..date_offset)).
+        where.not(sale_date: date_offset, sale_id: (sale_id_offset..)).
+        order(sale_date: :desc, sale_id: :desc).
+        limit(10)
+```
+
+However, the intent of this query is not clear at all when reading through this piece of code. Furthermore, if for any reason we need more than two columns, this will blow up pretty quickly. This gem allows us to generate this query/relation with a more explicit syntax.
+
+```ruby
+    Sales.
+        where_row(:sale_date, :sale_id).lt(date_offset, sale_id_offset).
+        order(sale_date: :desc, sale_id: :desc).
+        limit(10)
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'where_row'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install where_row
+
+## Usage
+
+A single `where_row` method is made available for all relations.
+
+```ruby
+date = Date.new(2021, 4, 5)
+
+Sales.where_row(:sale_date, :sale_id).eq(date, 42)
+Sales.where_row(:sale_date, :sale_id).in([date, 42], [date + 1.day, 43])
+Sales.where_row(:sale_date, :sale_id).lt(date, 42)
+Sales.where_row(:sale_date, :sale_id).gt(date, 42)
+Sales.where_row(:sale_date, :sale_id).gte(date, 42)
+Sales.where_row(:sale_date, :sale_id).lte(date, 42)
+```
+
+There is also a `not` method for negated queries.
+
+```ruby
+Sales.where_row(:sale_date, :sale_id).not.eq(date, 42)
+```
+
+The result is also a relation, so it can be chained with regular Rails query methods.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/odydoum/where_row.
+
+## 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/lib/where_row/active_record/base.rb

@@ -0,0 +1,9 @@
+module WhereRow
+  module ActiveRecord
+    module Base
+      def where_row(*args)
+        all.where_row(*args)
+      end
+    end
+  end
+end

data/lib/where_row/active_record/relation.rb

@@ -0,0 +1,11 @@
+require 'where_row/query_builder_fascade'
+
+module WhereRow
+  module ActiveRecord
+    module Relation
+      def where_row(key, *keys)
+        ::WhereRow::QueryBuilderFascade.new(self, [key] + keys)
+      end
+    end
+  end
+end

data/lib/where_row/active_record.rb

@@ -0,0 +1 @@
+module WhereRow::ActiveRecord; end

data/lib/where_row/query_builder.rb

@@ -0,0 +1,128 @@
+module WhereRow
+  class QueryBuilder
+    def initialize(relation, keys, operator, values)
+      @relation = relation
+      @keys = keys.map(&:to_s)
+      @operator = operator
+      @values = values
+    end
+
+    REVERSE_OP_MAP = {
+      lt: :gteq,
+      gt: :lteq,
+      lteq: :gt,
+      gteq: :lt
+    }.freeze
+    private_constant :REVERSE_OP_MAP
+
+    COMPARISON_OPERATORS = REVERSE_OP_MAP.keys
+    private_constant :COMPARISON_OPERATORS
+
+    def build
+      return relation if keys.blank?
+
+      case operator
+      when :eq
+        validate_single(values)
+        relation.where(keys.zip(values).to_h)
+      when :not_eq
+        validate_single(values)
+        build_not_eq_clause(relation, keys.zip(values))
+      when :in
+        validate_multiple(values)
+        build_in_clause
+      when :not_in
+        validate_multiple(values)
+        build_not_in_clause
+      when *COMPARISON_OPERATORS
+        validate_single(values)
+        build_comparison_clause
+      else
+        raise ArgumentError, 'Invalid operator'
+      end
+    end
+
+    private
+
+    attr_reader :relation, :keys, :operator, :values
+
+    def build_not_eq_clause(rel, key_value_pairs)
+      key, value = key_value_pairs.first
+
+      base_relation = rel.where.not(key => value)
+
+      return base_relation if key_value_pairs.length == 1
+
+      key_value_pairs[1..-1].reduce(base_relation) do |r, (k, v)|
+        r.or!(rel.where.not(k => v))
+      end
+    end
+
+    def build_in_clause
+      in_relation = relation.unscoped.where!(keys.zip(values.first).to_h)
+
+      values[1..-1].each do |v|
+        in_relation.or!(relation.unscoped.where!(keys.zip(v).to_h))
+      end
+
+      relation.merge(in_relation)
+    end
+
+    def build_not_in_clause
+      base_relation = build_not_eq_clause(relation, keys.zip(values.first))
+
+      return base_relation if values.length == 1
+
+      values[1..-1].reduce(base_relation) do |r, v|
+        base_relation.merge!(build_not_eq_clause(relation, keys.zip(v)))
+      end
+    end
+
+    def build_comparison_clause
+      relation.where(build_comparison_predicate)
+    end
+
+    def build_comparison_predicate
+      last_idx = keys.size - 1
+      reversed_op = REVERSE_OP_MAP[operator]
+      last_pred = build_predicate_for_key(relation, last_idx, reversed_op)
+
+      return last_pred if last_idx.zero?
+
+      first_keys_op = :lt if reversed_op == :lteq
+      first_keys_op = :gt if reversed_op == :gteq
+      first_keys_op ||= reversed_op
+
+      (0...last_idx).
+        map { |i| build_predicate_for_key(relation, i, first_keys_op) }.
+        reduce(:and).
+        and(last_pred)
+    end
+
+    def build_predicate_for_key(relation, idx, op)
+      last_pred = build_predicate(relation, keys[idx], values[idx], op)
+
+      return last_pred.not if idx == 0
+
+      (0...idx).
+        map { |j| build_predicate(relation, keys[j], values[j], :eq) }.
+        reduce(:and).
+        and(last_pred).
+        not
+    end
+
+    def build_predicate(relation, attr_name, value, operator)
+      relation.arel_table[attr_name].public_send(operator, value)
+    end
+
+    def validate_single(values)
+      if keys.length != values.length
+        raise ArgumentError, 'Argument lengths do not match'
+      end
+    end
+
+    def validate_multiple(values)
+      values.each { |v| validate_single(v) }
+    end
+  end
+end

data/lib/where_row/query_builder_fascade.rb

@@ -0,0 +1,122 @@
+require 'where_row/query_builder'
+
+module WhereRow
+  class QueryBuilderFascade
+    def initialize(relation, keys, negated = false)
+      @relation = relation
+      @keys = keys
+      @negated = negated
+    end
+
+    #
+    # Negate the where_row condition that follows
+    #
+    # @example
+    #   Rel.where_row(:c1, c2).eq(v1, v2) # Generates the equivalent of (c1, c2) = (v1, v2)
+    #   Rel.where_row(:c1, c2).not.eq(v1, v2) # Generates the equivalent of (c1, c2) != (v1, v2)
+    #
+    # @return [WhereRow::QueryBuilderFascade]
+    #
+    def not
+      self.class.new(@relation, @keys, true)
+    end
+
+    #
+    # Generates the equivalent clause of (c1, c2, c3, ...) = (v1, v2, v3, ...)
+    #
+    # @param [Array<Object>] values The values to compare against
+    #
+    # @return [ActiveRecord::Relation] The resulting relation
+    #
+    def eq(*values)
+      op = @negated ? :not_eq : :eq
+
+      QueryBuilder.new(@relation, @keys, op, values).build
+    end
+
+    #
+    # Generates the equivalent clause of (c1, c2, c3, ...) IN ((a1, a2, a3, ...), (b1, b2, b3, ...))
+    #
+    # @param [Array<Array<Object>>] values The values to compare against. Each element is itself an array of values.
+    #
+    # @return [ActiveRecord::Relation] The resulting relation
+    #
+    def in(*values)
+      op = @negated ? :not_in : :in
+
+      QueryBuilder.new(@relation, @keys, op, values).build
+    end
+
+    def in_range(range)
+      if @negated
+        result = @relation.where_row(@keys).lt(range.begin)
+
+        if range.exclude_end?
+          result.or(@relation.where_row(@keys).gte(range.end))
+        else
+          result.or(@relation.where_row(@keys).gt(range.end))
+        end
+      else
+        result = @relation.where_row(@keys).gte(range.begin)
+
+        if range.exclude_end?
+          result.where_row(@keys).lt(range.end)
+        else
+          result.where_row(@keys).lte(range.end)
+        end
+      end
+    end
+
+    #
+    # Generates the equivalent clause of (c1, c2, c3, ...) > (v1, v2, v3, ...)
+    #
+    # @param [Array<Object>] values The values to compare against
+    #
+    # @return [ActiveRecord::Relation] The resulting relation
+    #
+    def gt(*values)
+      op = @negated ? :lteq : :gt
+
+      QueryBuilder.new(@relation, @keys, op, values).build
+    end
+
+    #
+    # Generates the equivalent clause of (c1, c2, c3, ...) >= (v1, v2, v3, ...)
+    #
+    # @param [Array<Object>] values The values to compare against
+    #
+    # @return [ActiveRecord::Relation] The resulting relation
+    #
+    def gte(*values)
+      op = @negated ? :lt : :gteq
+
+      QueryBuilder.new(@relation, @keys, op, values).build
+    end
+
+    #
+    # Generates the equivalent clause of (c1, c2, c3, ...) < (v1, v2, v3, ...)
+    #
+    # @param [Array<Object>] values The values to compare against
+    #
+    # @return [ActiveRecord::Relation] The resulting relation
+    #
+    def lt(*values)
+      op = @negated ? :gteq : :lt
+
+      QueryBuilder.new(@relation, @keys, op, values).build
+    end
+
+    #
+    # Generates the equivalent clause of (c1, c2, c3, ...) <= (v1, v2, v3, ...)
+    #
+    # @param [Array<Object>] values The values to compare against
+    #
+    # @return [ActiveRecord::Relation] The resulting relation
+    #
+    def lte(*values)
+      op = @negated ? :gt : :lteq
+
+      QueryBuilder.new(@relation, @keys, op, values).build
+    end
+  end
+end

data/lib/where_row/version.rb

@@ -0,0 +1,3 @@
+module WhereRow
+  VERSION = "0.1.0"
+end

data/lib/where_row.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+require "where_row/version"
+require "where_row/active_record/relation"
+require "where_row/active_record/base"
+
+require "active_record"
+
+module WhereRow; end
+
+ActiveRecord::Relation.prepend ::WhereRow::ActiveRecord::Relation
+ActiveRecord::Base.extend ::WhereRow::ActiveRecord::Base

data/where_row.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "where_row/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "where_row"
+  spec.version       = WhereRow::VERSION
+  spec.authors       = ["Odysseas Doumas"]
+  spec.email         = ["odydoum@gmail.com"]
+
+  spec.summary       = 'Write row value queries in active record'
+  spec.description   = 'Write row value queries in active record'
+  spec.homepage      = "https://github.com/odoumas/where_row"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.5.0"
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "activerecord", ">= 5.2", "< 7.1"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "yard"
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: where_row
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Odysseas Doumas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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 row value queries in active record
+email:
+- odydoum@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Appraisals
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/where_row.rb
+- lib/where_row/active_record.rb
+- lib/where_row/active_record/base.rb
+- lib/where_row/active_record/relation.rb
+- lib/where_row/query_builder.rb
+- lib/where_row/query_builder_fascade.rb
+- lib/where_row/version.rb
+- where_row.gemspec
+homepage: https://github.com/odoumas/where_row
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Write row value queries in active record
+test_files: []