activerecord-pretty-comparator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0d0a276c6bc57bf58455e2750accf54fc6337a123478ca10f15178a8c8be69a0
+  data.tar.gz: 848f9be30dfcd6a3fc8e445fdeb9ca0eff50764a490d7479706e68e2a6c0007d
+SHA512:
+  metadata.gz: 718434cdf54fdff58c6bca95136dc1114fb3b0a5c4a2cb4ce3b4599a8c5139ff3943e26fc912a0ab5c81b0f1158c9e6a90aa41fd852bb33f130aee9d25157c06
+  data.tar.gz: 7c15cb186815b80290bf251cf75be55a4752b899ed298e0a8538737f3126c20f5b8fcd36649cb760428a6c9dda756ea8943144a9985e2605ab1500f99a1c5b20

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,28 @@
+require: rubocop-rspec
+AllCops:
+  TargetRubyVersion: 3.0
+  Exclude:
+    - 'activerecord-pretty-comparator.gemspec'
+    - 'lib/activerecord-pretty-comparator.rb'
+    - 'vendor/**/*'
+  RespectGitIgnore: true
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+RSpec/IndexedLet:
+  Enabled: false
+
+RSpec/MultipleExpectations:
+  Max: 4
+
+RSpec/ExampleLength:
+  Max: 6
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/*.rb

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-07-17
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 technuma
+
+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,100 @@
+# ActiveRecord::Pretty::Comparator
+
+A simple ActiveRecord extension to support `where` with comparison operators (`>`, `>=`, `<`, and `<=`).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-pretty-comparator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-pretty-comparator
+
+
+## Usage
+```ruby
+posts = Post.order(:id)
+
+posts.where("id >": 9).pluck(:id)  # => [10, 11]
+posts.where("id >=": 9).pluck(:id) # => [9, 10, 11]
+posts.where("id <": 3).pluck(:id)  # => [1, 2]
+posts.where("id <=": 3).pluck(:id) # => [1, 2, 3]
+```
+
+## Why not `Post.where("id > ?", 1)` ?
+
+As a main contributor of the predicate builder area, [@kamipo](https://github.com/kamipo) recommends
+using the hash syntax, the hash syntax also have other useful
+effects (making boundable queries, unscopeable queries, hash-like
+relation merging friendly, automatic other table references detection).  
+ref: https://github.com/rails/rails/pull/39863#issue-659298581
+
+### Merge examples
+```ruby
+# it doesn't work
+# SELECT `posts`.`id` FROM `posts` WHERE (id > 1) AND `posts`.`id` = ?  [["id", 1]]
+Post.where("id > ?", 1).merge(Post.where(id: 1)).pluck(:id) # []
+
+# it works
+# SELECT `posts`.`id` FROM `posts` WHERE `posts`.`id` = ?  [["id", 1]]
+Post.where("id >": 1).merge(Post.where(id: 1)).pluck(:id) # [1]
+```
+
+### Unscope examples
+```ruby
+# it doesn't work
+# SELECT `posts`.* FROM `posts` WHERE (id > 1)
+Post.where("id > ?", 1).unscope(where: :id)
+
+# it works
+# SELECT `posts`.* FROM `posts`
+Post.where("id >": 1).unscope(where: :id)
+```
+
+### Precision examples
+From type casting and table/column name resolution's point of view,
+`where("created_at >=": time)` is better alternative than `where("created_at >= ?", time)`.
+
+```ruby
+class Post < ActiveRecord::Base
+  attribute :created_at, :datetime, precision: 3
+end
+
+time = Time.now.utc # => 2020-06-24 10:11:12.123456 UTC
+
+Post.create!(created_at: time) # => #<Post id: 1, created_at: "2020-06-24 10:11:12.123000">
+
+# SELECT `posts`.* FROM `posts` WHERE (created_at >= '2020-06-24 10:11:12.123456')
+Post.where("created_at >= ?", time) # => []
+
+# SELECT `posts`.* FROM `posts` WHERE `posts`.`created_at` >= '2020-06-24 10:11:12.123000'
+Post.where("created_at >=": time) # => [#<Post id: 1, created_at: "2020-06-24 10:11:12.123000">]
+```
+
+## 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/technuma/activerecord-pretty-comparator.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Special thanks
+
+[@kamipo](https://github.com/kamipo) :bow:
+
+Original idea: https://blog.kamipo.net/entry/2021/01/14/191753 (ja)

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/lib/active_record/pretty/comparator/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Pretty
+    module Comparator
+      VERSION = "0.1.0"
+    end
+  end
+end

data/lib/active_record/pretty/comparator.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "comparator/version"
+require "active_record"
+
+module ActiveRecord
+  module Pretty
+    # :nodoc:
+    module Comparator
+      class Error < StandardError; end
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::PredicateBuilder.prepend(Module.new do
+          def [](attr_name, value, operator = nil)
+            if !operator && attr_name.end_with?(">", ">=", "<", "<=")
+              /\A(?<attr_name>.+?)\s*(?<operator>>|>=|<|<=)\z/ =~ attr_name
+              operator = OPERATORS[operator]
+            end
+
+            super
+          end
+
+          OPERATORS = { ">" => :gt, ">=" => :gteq, "<" => :lt, "<=" => :lteq }.freeze # rubocop:disable Lint/ConstantDefinitionInBlock
+        end)
+      end
+    end
+  end
+end

data/lib/activerecord-pretty-comparator.rb

@@ -0,0 +1 @@
+require "active_record/pretty/comparator"

data/sig/activerecord/pretty/comparator.rbs

@@ -0,0 +1,8 @@
+module ActiveRecord
+  module Pretty
+    module Comparator
+      VERSION: String
+      # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+    end
+  end
+end

metadata

@@ -0,0 +1,155 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-pretty-comparator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kazuya Onuma
+- Ryuta Kamizono
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  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: rake
+  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: rspec
+  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: rubocop
+  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: rubocop-rspec
+  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'
+description: A simple ActiveRecord extension to support where with comparison operators
+  (`>`, `>=`, `<`, and `<=`).
+email:
+- technuma@gmail.com
+- kamipo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/active_record/pretty/comparator.rb
+- lib/active_record/pretty/comparator/version.rb
+- lib/activerecord-pretty-comparator.rb
+- sig/activerecord/pretty/comparator.rbs
+homepage: https://github.com/technuma/activerecord-pretty-comparator
+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.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: A simple ActiveRecord extension to support where with comparison operators
+  (`>`, `>=`, `<`, and `<=`).
+test_files: []