ar-find-in-batches-with-order 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a925a70757e5aba077a829c8390721aafb758e6
+  data.tar.gz: 6662ce7e8fb81f22f807be5e5b3c7fbd42759258
+SHA512:
+  metadata.gz: 4ba8c62855896049ebf287bf1b5435e40bf11570561360e20ce1bd5af543c216a7ae817b31a7d67339ebd21b1c496922887a8b381183510e2df7b72d7b5a3d2a
+  data.tar.gz: 68704bce9b02c094c168ae4320fc575f7091056c0f462d8061bdae449e7921d8a444250caf9cd6f876bd4acc3439579075623536b2f70bda7289431c44bb8d3e

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ar-find-in-batches-with-order.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nam Chu Hoai
+
+MIT License
+
+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,35 @@
+# ar-find-in-batches-with-order
+
+Allows you to use find_each and find_each_in_batches with custom ordering.
+
+This is useful if your domain knowledge allows youo to make assumptions about the order of your records. In the vanilla find_each/find_each_in_batches implementation, Rails disables custom ordering to ensure consistency in case ordering changes between batchings.
+
+However, in many cases you know that this would never happen. For example, in acitivity feeds, you might want to batch-find activitites sorted by newest items. You know that new items cannot disrupt the ordering once batching started.
+
+That being said, depending on your data model, deletions of records might screw you over during the batch-overlap detection, so use with caution.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ar-find-in-batches-with-order'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ar-find-in-batches-with-order
+
+## Usage
+
+Usage is pretty much identical to find_each/find_each_in_batches, you'd just want to use the `:property_key` and `:direction` options to specify the ordering explicitly.
+
+## Contributing
+
+1. Fork it ( http://github.com/nambrot/ar-find-in-batches-with-order/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/ar-find-in-batches-with-order.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ar-find-in-batches-with-order/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ar-find-in-batches-with-order"
+  spec.version       = ActiveRecord::FindInBatchesWithOrder::VERSION
+  spec.authors       = ["Nam Chu Hoai"]
+  spec.email         = ["nambrot@googlemail.com"]
+  spec.summary       = "Allow find_in_batches with custom order property"
+  spec.description   = "Allow find_in_batches with custom order property"
+  spec.homepage      = "https://github.com/nambrot/ar-find-in-batches-with-order"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/ar-find-in-batches-with-order.rb

@@ -0,0 +1,62 @@
+require "ar-find-in-batches-with-order/version"
+
+module ActiveRecord
+  module FindInBatchesWithOrder
+    def find_in_batches_with_order(options = {})
+      relation = self
+
+      # we have to be explicit about the options to ensure proper ordering and retrieval
+
+      direction = options.delete(:direction) || (arel.orders.first.try(:ascending?) ? :asc : nil) || (arel.orders.first.try(:descending?) ? :desc : nil) || :desc
+      start = options.delete(:start)
+      batch_size = options.delete(:batch_size) || 1000
+
+      # try to deduct the property_key, but safer to specificy directly
+      property_key = options.delete(:property_key) || arel.orders.first.try(:value).try(:name)
+      relation = relation.limit(batch_size)
+
+      # in strictmode, we return records with same values as the last record of the last batch
+      strict_mode = options.delete(:strict_mode) || true
+
+
+      records = start ? (direction == :desc ? relation.where(table[property_key].lteq(start)).to_a : relation.where(table[property_key].gteq(start)).to_a)  : relation.to_a
+
+       while records.any?
+        records_size = records.size
+  
+        yield records
+
+
+        break if records_size < batch_size
+        
+        start = records.last.try(property_key)
+
+        records = strict_mode ? (direction == :desc ? relation.where(table[property_key].lteq(start)).to_a : relation.where(table[property_key].gteq(start)).to_a) : (direction == :desc ? relation.where(table[property_key].lt(start)).to_a : relation.where(table[property_key].gt(start)).to_a)
+      end
+    end
+
+    # note that in strict mode we might itereate perpetually if the overlap in values is too high in relation to the batch size
+    def find_each_with_order(options = {})
+      last_record = nil
+      find_in_batches_with_order(options) do |records|
+
+        records.each do |record| 
+          # we need to find the last record of the previous batch
+          next if last_record and (record != last_record)
+          if last_record 
+            last_record = nil
+            next
+          end
+          yield record
+        end
+        last_record = records.last
+      end
+    end
+
+
+  end
+
+  class Relation
+    include FindInBatchesWithOrder
+  end
+end

data/lib/ar-find-in-batches-with-order/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module FindInBatchesWithOrder
+    VERSION = "0.0.1"
+  end
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: ar-find-in-batches-with-order
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nam Chu Hoai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+description: Allow find_in_batches with custom order property
+email:
+- nambrot@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ar-find-in-batches-with-order.gemspec
+- lib/ar-find-in-batches-with-order.rb
+- lib/ar-find-in-batches-with-order/version.rb
+homepage: https://github.com/nambrot/ar-find-in-batches-with-order
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Allow find_in_batches with custom order property
+test_files: []