activerecord-find_each_ordered 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 749762b9588483129fbd592903401c8d09420708d17265df2566bf94c25c5bc5
+  data.tar.gz: 31c93153183fd4a025fda20eec4274586057abe904d04ed693c120cd9fd3e6e3
+SHA512:
+  metadata.gz: c4ee8236887c06b6dbcea2fa79ebe22ebc0e75f7a714e0e055383a521eaec58971a6cdbc71806556f841958087c6b9c687da35ca06a51479f62077e3edc9af57
+  data.tar.gz: 136faf9bf86850edd8708df31ba30651267bdbc8a61bc1952419feac0ab9144ac63ba500d99618cc5e55408796100984cf43169f6fe77c9071c95bc079f2e2da

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Joshua Flanagan
+
+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,52 @@
+# ActiveRecord::FindEachOrdered
+
+Behave's like ActiveRecord's [#find_each](https://api.rubyonrails.org/classes/ActiveRecord/Batches.html#method-i-find_each) method,
+but allows sorting by a column other than the primary key.
+
+There are times when you need to load a large number of records, but sorting
+by the primary key is undesired, or prohibitely expensive. Sorting by the
+primary key may cause the database planner to avoid an index that would otherwise
+be more helpful.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerecord-find_each_ordered'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-find_each_ordered
+
+## Usage
+
+```
+yesterday = 1.day.ago
+Item.
+  where(purchased_at: (yesterday.beginning_of_day..yesterday.end_of_day)).
+  find_each_ordered(:purchased_at, batch_size: 500) do |item|
+
+  # work with each item instance
+end
+```
+
+## 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 the gemspec, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, 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/joshuaflanagan/activerecord-find_each_ordered.
+
+## 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/activerecord-find_each_ordered.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-find_each_ordered"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Joshua Flanagan"]
+  spec.email         = ["joshuaflanagan@gmail.com"]
+
+  spec.summary       = %q{Allow custom sort order with find_each behavior}
+  spec.description   = %q{Allow custom sort order with find_each behavior}
+  spec.homepage      = "https://github.com/joshuaflanagan/activerecord-find_each_ordered"
+  spec.license       = "MIT"
+
+  # 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_dependency "activerecord"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord/find_each_ordered"
+
+# 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/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/active_record/find_each_ordered.rb

@@ -0,0 +1,56 @@
+module ActiveRecord
+  module FindEachOrdered
+    # Behaves like find_each, but allows a custom sort order.
+    #
+    # #find_each forces the records to be returned sorted by 'id'.
+    #
+    # Make sure none of the returned records have a NULL value for the sort key,
+    # or this may fail with an UnsortableNullValue error.
+    # If the column is nullable, you may want to add something like:
+    #  .where.not(last_name: nil) # assuming a sort_key of :last_name
+    # or other criteria that will ensure no NULL values are encountered.
+    def find_each_ordered(sort_key, batch_size: 1000)
+      return to_enum(:find_each_ordered, sort_key, batch_size: batch_size) unless block_given?
+      relation = self
+      batch_order = arel_attribute(sort_key).asc
+      relation = relation.reorder(batch_order).limit(batch_size)
+      records = relation.to_a
+
+      last_offset = nil
+      seen_ids = []
+      while records.any?
+        records_size = records.size
+        last_record = records.last
+        unless last_record.has_attribute?(sort_key)
+          raise ArgumentError.new("Sort key '#{sort_key}' not included in the custom select clause")
+        end
+        batch_offset = last_record.public_send(sort_key)
+        if batch_offset.nil?
+          raise UnsortableNullValue, "#{last_record.class} with id #{last_record.id} has a NULL value for sort_key '#{sort_key}'"
+        end
+        if batch_offset != last_offset
+          seen_ids.clear
+        end
+        last_offset = batch_offset
+        # since more than one order could have the same sort_key value, we
+        # need to exclude the ones we've seen from the next query
+        new_excludes = records.select{|r|
+          r.public_send(sort_key) == batch_offset
+        }.map(&:id)
+        seen_ids.concat(new_excludes)
+
+        records.each{|r| yield r}
+
+        break if records_size < batch_size
+
+        records = relation.where(
+          relation.table[sort_key].gteq(batch_offset)
+        ).where.not(id: seen_ids).to_a
+      end
+    end
+
+    class UnsortableNullValue < StandardError; end
+  end
+
+  Relation.include(FindEachOrdered)
+end

data/lib/activerecord/find_each_ordered.rb

@@ -0,0 +1,5 @@
+require "active_support"
+
+ActiveSupport.on_load(:active_record) do
+  require "active_record/find_each_ordered"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-find_each_ordered
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joshua Flanagan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: 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: 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'
+description: Allow custom sort order with find_each behavior
+email:
+- joshuaflanagan@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-find_each_ordered.gemspec
+- bin/console
+- bin/setup
+- lib/active_record/find_each_ordered.rb
+- lib/activerecord/find_each_ordered.rb
+homepage: https://github.com/joshuaflanagan/activerecord-find_each_ordered
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Allow custom sort order with find_each behavior
+test_files: []