where_any 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8720b83377ca8b8f8b55981a951157a5d800e4029fc61ec0786036e47915c841
+  data.tar.gz: 8c7db28c73611593239ba7385d8b51be63e3c8ff5da25392db8e323276a67e99
+SHA512:
+  metadata.gz: f112f2ba41d11a6db21f6636eb820bf2731a2b8691cf232d2389ce4d73b9a4094a6d6749538f47cd553a96d9c1fd8b6878ca86343341d08deb673ed208760a28
+  data.tar.gz: '03830003bbeb718a747906b12d718780c74b9aa0c1e2be07c6a96013f0265dd47cbcf8e0acab852d5b971bf7db92c39e4f0a76218f03d1c507d8496f50edb8aa'

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.0.1
+          bundler-cache: true
+      - name: Rubocop
+        run: bin/rubocop
+      - name: RSpec
+        run: bin/rspec

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/.rubocop.yml

@@ -0,0 +1,21 @@
+require:
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.5
+  NewCops: enable
+  SuggestExtensions: false
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in where_any_of.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.23'
+gem 'rubocop-rspec', '~> 2.6'

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    where_any (0.1.0)
+      activerecord (>= 5.2.0, < 8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.4)
+    parallel (1.21.0)
+    parser (3.0.3.2)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rubocop (1.23.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.0)
+      parser (>= 3.0.1.1)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.5.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.23)
+  rubocop-rspec (~> 2.6)
+  where_any!
+
+BUNDLED WITH
+   2.2.17

data/README.md

@@ -0,0 +1,144 @@
+# Where Any
+
+Helpers for using the PostgreSQL `ANY()` and `ALL()` expressions in ActiveRecord queries. This provides the functionality of WHERE IN, but in a more prepared statement friendly way.
+
+Tested and validated only for PostgreSQL.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'where_any'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install where_any
+
+Then in any of your models:
+
+```ruby
+class User < ApplicationRecord
+  extend WhereAny
+
+  # ...
+end
+```
+
+Or, to install these helpers for your entire application:
+
+```ruby
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+
+  extend WhereAny
+
+  # ...
+end
+```
+
+## Usage
+
+To make a where `ANY()` query, use the `where_any` method:
+
+```ruby
+User.where_any(:id, [1, 2, 3, 4, 5])
+```
+
+The first argument of `where_any` refers to the column being tested, and the second argument is a list of values to include in the condition.
+
+Which would produce the following SQL:
+
+```sql
+SELECT "users".* FROM "users" WHERE "users"."id" = ANY($1)  [["id", "{1,2,3,4,5}"]
+```
+
+It's also possible to construct a negated where `ANY()` query, like so:
+
+```ruby
+User.where_none(:id, [1, 2, 3, 4, 5])
+```
+
+Which would produce the following SQL:
+
+```sql
+SELECT "users".* FROM "users" WHERE "users"."id" != ALL($1)  [["id", "{1,2,3,4,5}"]]
+```
+
+### Where ANY vs. Where IN
+
+The advantage of using where `where_any` over ActiveRecord's built-in WHERE IN support is that it produces the same SQL statement regardless of the number of elements supplied. This is advantageous when using prepared statements, as the same statement can be reused regardless of the number of inputs supplied.
+
+Consider for example:
+
+```ruby
+User.where(id: [1, 2, 3])
+User.where(id: [1, 2, 3, 4])
+User.where(id: [1, 2, 3, 4, 5])
+
+# Versus
+
+User.where_any(:id, [1, 2, 3])
+User.where_any(:id, [1, 2, 3, 4])
+User.where_any(:id, [1, 2, 3, 4, 5])
+```
+
+These sets of queries produce the following sets of SQL respectively:
+
+```sql
+SELECT "users".* FROM "users" WHERE "users"."id" IN ($1, $2, $3)  [["id", 1], ["id", 2], ["id", 3]]
+SELECT "users".* FROM "users" WHERE "users"."id" IN ($1, $2, $3, $4)  [["id", 1], ["id", 2], ["id", 3], ["id", 4]]
+SELECT "users".* FROM "users" WHERE "users"."id" IN ($1, $2, $3, $4, $5)  [["id", 1], ["id", 2], ["id", 3], ["id", 4], ["id", 5]]
+
+-- Versus
+
+SELECT "users".* FROM "users" WHERE "users"."id" = ANY($1)  [["id", "{1,2,3}"]]
+SELECT "users".* FROM "users" WHERE "users"."id" = ANY($1)  [["id", "{1,2,3,4}"]]
+SELECT "users".* FROM "users" WHERE "users"."id" = ANY($1)  [["id", "{1,2,3,4,5}"]]
+```
+
+Using the `ANY()` notation allows us to reuse the same query with the same number of parameter binds regardless of what number of inputs are supplied.
+
+### Performance
+
+Using modern version of Postgres, there is no disadvantage to using `ANY()` from a query plan perspective.
+
+Here is an example query plan when using `where_any()`:
+
+```sql
+EXPLAIN for: SELECT "users".* FROM "users" WHERE "users"."id" = ANY($1) [["id", "{1,2,3,4,5}"]]
+                                 QUERY PLAN
+----------------------------------------------------------------------------
+ Index Scan using users_pkey on users
+   Index Cond: (id = ANY ('{1,2,3,4,5}'::integer[]))
+(2 rows)
+```
+
+And here is the query plan when using ActiveRecord's WHERE IN:
+
+```sql
+EXPLAIN for: SELECT "users".* FROM "users" WHERE "users"."id" IN ($1, $2, $3, $4, $5) [["id", 1], ["id", 2], ["id", 3], ["id", 4], ["id", 5]]
+                                 QUERY PLAN
+----------------------------------------------------------------------------
+ Index Scan using users_pkey on users
+   Index Cond: (id = ANY ('{1,2,3,4,5}'::integer[]))
+(2 rows)
+```
+
+Note how these two queries produced the exact same query plan. According to the PostgreSQL manual, these operations are equivalent:
+https://www.postgresql.org/docs/current/functions-subquery.html#FUNCTIONS-SUBQUERY-ANY-SOME
+
+## 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/thriver/where_any.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'where_any'
+
+# 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/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile',
+                                           Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

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/where_any/version.rb

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

data/lib/where_any.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative 'where_any/version'
+
+module WhereAny
+  # @param name [String]
+  # @param value [Object]
+  # @return [Arel::Nodes::Node]
+  def bind_param(name, value)
+    attribute_type  = type_for_attribute(name)
+    query_attribute = ActiveRecord::Relation::QueryAttribute.new(name.to_s, value, attribute_type)
+
+    Arel::Nodes::BindParam.new(query_attribute)
+  end
+
+  # @param name [String]
+  # @param value [Object]
+  # @return [Arel::Nodes::Node]
+  def bind_array(name, value)
+    element_type    = type_for_attribute(name)
+    attribute_type  = ActiveRecord::Type.lookup(element_type.type, array: true)
+    query_attribute = ActiveRecord::Relation::QueryAttribute.new(name.to_s, value, attribute_type)
+
+    Arel::Nodes::BindParam.new(query_attribute)
+  end
+
+  # @param column [String, Symbol]
+  # @param values [Array<Object>]
+  # @return [ActiveRecord::Relation]
+  def where_any(column, values)
+    return none if values.blank?
+
+    arel_column   = arel_table[column]
+    any_of_values = Arel::Nodes::NamedFunction.new('ANY', [bind_array(column, values)])
+
+    where(arel_column.eq(any_of_values))
+  end
+
+  # @param column [String, Symbol]
+  # @param values [Array<Object>]
+  # @return [ActiveRecord::Relation]
+  def where_none(column, values)
+    return all if values.blank?
+
+    arel_column   = arel_table[column]
+    all_of_values = Arel::Nodes::NamedFunction.new('ALL', [bind_array(column, values)])
+
+    where(arel_column.not_eq(all_of_values))
+  end
+end

data/where_any.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/where_any/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'where_any'
+  spec.version       = WhereAny::VERSION
+  spec.authors       = ['Minty Fresh']
+  spec.email         = ['7896757+mintyfresh@users.noreply.github.com']
+
+  spec.summary       = 'Postgres ANY() and ALL() expressions for ActiveRecord.'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/thriver/where_any'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.5.0')
+
+  spec.metadata['allowed_push_host']     = 'https://rubygems.org/'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.metadata['homepage_uri']    = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # 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 { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  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_dependency 'activerecord', '>= 5.2.0', '< 8'
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: where_any
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Minty Fresh
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-12-13 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.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+description: Postgres ANY() and ALL() expressions for ActiveRecord.
+email:
+- 7896757+mintyfresh@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/rubocop
+- bin/setup
+- lib/where_any.rb
+- lib/where_any/version.rb
+- where_any.gemspec
+homepage: https://github.com/thriver/where_any
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org/
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/thriver/where_any
+  source_code_uri: https://github.com/thriver/where_any
+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.2.15
+signing_key: 
+specification_version: 4
+summary: Postgres ANY() and ALL() expressions for ActiveRecord.
+test_files: []