in_batches 1.0.0

data/.travis.yml

@@ -0,0 +1,26 @@
+sudo: false
+env:
+  global:
+    - CC_TEST_REPORTER_ID=40baf981249c1b343bee386c0794f2f83087ddb2fbb706199ad9b13ba4da7107
+language: ruby
+rvm:
+  - 2.2
+  - 2.3
+gemfile:
+  - gemfiles/3.2.gemfile
+  - gemfiles/4.2.gemfile
+  - gemfiles/5.0.gemfile
+  - gemfiles/5.1.gemfile
+  - gemfiles/5.2.gemfile
+before_install:
+  - gem i rubygems-update -v '<3' && update_rubygems
+  - gem install bundler -v 1.17.3
+  - gem --version
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rake test
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at mrtmrt15xn@yahoo.com.tw. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Rumble Huang
+
+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,41 @@
+# in_batches
+
+[![Gem Version](https://img.shields.io/gem/v/in_batches.svg?style=flat)](https://rubygems.org/gems/in_batches)
+[![Build Status](https://api.travis-ci.com/khiav223577/in_batches.svg?branch=master)](https://travis-ci.com/khiav223577/in_batches)
+[![RubyGems](http://img.shields.io/gem/dt/in_batches.svg?style=flat)](https://rubygems.org/gems/in_batches)
+[![Code Climate](https://codeclimate.com/github/khiav223577/in_batches/badges/gpa.svg)](https://codeclimate.com/github/khiav223577/in_batches)
+[![Test Coverage](https://codeclimate.com/github/khiav223577/in_batches/badges/coverage.svg)](https://codeclimate.com/github/khiav223577/in_batches/coverage)
+
+Backport `in_batches` from Rails 5 for Rails 3 and 4.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'in_batches'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install in_batches
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 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/khiav223577/in_batches. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/atomically.gemspec

@@ -0,0 +1,43 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'in_batches/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'in_batches'
+  spec.version       = InBatches::VERSION
+  spec.authors       = ['khiav reoy']
+  spec.email         = ['mrtmrt15xn@yahoo.com.tw']
+
+  spec.summary       = 'Backport in_batches from Rails 5 for Rails 3 and 4.'
+  spec.description   = 'Backport in_batches from Rails 5 for Rails 3 and 4.'
+  spec.homepage      = 'https://github.com/khiav223577/in_batches'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject{|f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}){|f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.metadata    = {
+    'homepage_uri'      => 'https://github.com/khiav223577/in_batches',
+    'changelog_uri'     => 'https://github.com/khiav223577/in_batches/blob/master/CHANGELOG.md',
+    'source_code_uri'   => 'https://github.com/khiav223577/in_batches',
+    'documentation_uri' => 'http://www.rubydoc.info/gems/in_batches',
+    'bug_tracker_uri'   => 'https://github.com/khiav223577/in_batches/issues',
+  }
+
+  spec.add_development_dependency 'bundler', '>= 1.17', '< 3.x'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'sqlite3', '~> 1.3'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+
+  spec.add_dependency 'activerecord', '>= 3'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'in_batches'
+
+# 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

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install --gemfile=gemfiles/4.2.gemfile
+
+# Do any other automated setup that you need to do here

data/gemfiles/3.2.gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 3.2.0'
+
+group :test do
+  gem 'simplecov'
+  gem 'sqlite3', '~> 1.3.6'
+end
+
+gemspec path: '../'

data/gemfiles/4.2.gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 4.2.0'
+
+group :test do
+  gem 'simplecov'
+  gem 'sqlite3', '~> 1.3.6'
+end
+
+gemspec path: '../'

data/gemfiles/5.0.gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 5.0.0'
+
+group :test do
+  gem 'simplecov'
+  gem 'sqlite3', '~> 1.3.6'
+end
+
+gemspec path: '../'

data/gemfiles/5.1.gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 5.1.0'
+
+group :test do
+  gem 'simplecov'
+  gem 'sqlite3', '~> 1.3.6'
+end
+
+gemspec path: '../'

data/gemfiles/5.2.gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 5.2.0'
+
+group :test do
+  gem 'simplecov'
+  gem 'sqlite3', '~> 1.3.6'
+end
+
+gemspec path: '../'

data/lib/in_batches/active_record/batches.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module ActiveRecord
+  module Batches
+    def in_batches(of: 1000, begin_at: nil, end_at: nil, load: false)
+      relation = self
+      unless block_given?
+        return BatchEnumerator.new(of: of, begin_at: begin_at, end_at: end_at, relation: self)
+      end
+
+      if logger && (arel.orders.present? || arel.taken.present?)
+        logger.warn("Scoped order and limit are ignored, it's forced to be batch order and batch size")
+      end
+
+      relation = relation.reorder(batch_order).limit(of)
+      relation = apply_limits(relation, begin_at, end_at)
+      batch_relation = relation
+
+      loop do
+        if load
+          records = batch_relation.to_a
+          ids = batch_relation.pluck(primary_key)
+          relation_yielded = self.where(primary_key => ids).reorder(batch_order)
+          relation_yielded.load_records(records)
+        else
+          ids = batch_relation.pluck(primary_key)
+          relation_yielded = self.where(primary_key => ids).reorder(batch_order)
+        end
+
+        break if ids.empty?
+
+        primary_key_offset = ids.last
+        raise ArgumentError.new("Primary key not included in the custom select clause") unless primary_key_offset
+
+        yield relation_yielded
+
+        break if ids.length < of
+        batch_relation = relation.where(table[primary_key].gt(primary_key_offset))
+      end
+    end
+
+    private
+
+    def apply_limits(relation, begin_at, end_at)
+      relation = relation.where(table[primary_key].gteq(begin_at)) if begin_at
+      relation = relation.where(table[primary_key].lteq(end_at)) if end_at
+      relation
+    end
+
+    def batch_order
+      "#{quoted_table_name}.#{quoted_primary_key} ASC"
+    end
+  end
+end

data/lib/in_batches/active_record/relation/batch_enumerator.rb

@@ -0,0 +1,67 @@
+module ActiveRecord
+  module Batches
+    class BatchEnumerator
+      include Enumerable
+
+      def initialize(of: 1000, begin_at: nil, end_at: nil, relation:) #:nodoc:
+        @of       = of
+        @relation = relation
+        @begin_at = begin_at
+        @end_at   = end_at
+      end
+
+      # Looping through a collection of records from the database (using the
+      # +all+ method, for example) is very inefficient since it will try to
+      # instantiate all the objects at once.
+      #
+      # In that case, batch processing methods allow you to work with the
+      # records in batches, thereby greatly reducing memory consumption.
+      #
+      #   Person.in_batches.each_record do |person|
+      #     person.do_awesome_stuff
+      #   end
+      #
+      #   Person.where("age > 21").in_batches(of: 10).each_record do |person|
+      #     person.party_all_night!
+      #   end
+      #
+      # If you do not provide a block to #each_record, it will return an Enumerator
+      # for chaining with other methods:
+      #
+      #   Person.in_batches.each_record.with_index do |person, index|
+      #     person.award_trophy(index + 1)
+      #   end
+      def each_record
+        return to_enum(:each_record) unless block_given?
+
+        @relation.to_enum(:in_batches, of: @of, begin_at: @begin_at, end_at: @end_at, load: true).each do |relation|
+          relation.to_a.each { |record| yield record }
+        end
+      end
+
+      # Delegates #delete_all, #update_all, #destroy_all methods to each batch.
+      #
+      #   People.in_batches.delete_all
+      #   People.in_batches.destroy_all('age < 10')
+      #   People.in_batches.update_all('age = age + 1')
+      [:delete_all, :update_all, :destroy_all].each do |method|
+        define_method(method) do |*args, &block|
+          @relation.to_enum(:in_batches, of: @of, begin_at: @begin_at, end_at: @end_at, load: false).each do |relation|
+            relation.send(method, *args, &block)
+          end
+        end
+      end
+
+      # Yields an ActiveRecord::Relation object for each batch of records.
+      #
+      #   Person.in_batches.each do |relation|
+      #     relation.update_all(awesome: true)
+      #   end
+      def each
+        enum = @relation.to_enum(:in_batches, of: @of, begin_at: @begin_at, end_at: @end_at, load: false)
+        return enum.each { |relation| yield relation } if block_given?
+        enum
+      end
+    end
+  end
+end

data/lib/in_batches/active_record_extensions.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'in_batches/active_record/relation/batch_enumerator'
+require 'in_batches/active_record/batches'
+
+class ActiveRecord::Base
+  def self.in_batches(*args)
+    where('').in_batches(*args)
+  end
+end

data/lib/in_batches/version.rb

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

data/lib/in_batches.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'in_batches/version'
+require 'active_record'
+require 'in_batches/active_record_extensions' if not defined?(ActiveRecord::Batches::BatchEnumerator)

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: in_batches
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- khiav reoy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.x
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.x
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Backport in_batches from Rails 5 for Rails 3 and 4.
+email:
+- mrtmrt15xn@yahoo.com.tw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- Rakefile
+- atomically.gemspec
+- bin/console
+- bin/setup
+- gemfiles/3.2.gemfile
+- gemfiles/4.2.gemfile
+- gemfiles/5.0.gemfile
+- gemfiles/5.1.gemfile
+- gemfiles/5.2.gemfile
+- lib/in_batches.rb
+- lib/in_batches/active_record/batches.rb
+- lib/in_batches/active_record/relation/batch_enumerator.rb
+- lib/in_batches/active_record_extensions.rb
+- lib/in_batches/version.rb
+homepage: https://github.com/khiav223577/in_batches
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/khiav223577/in_batches
+  changelog_uri: https://github.com/khiav223577/in_batches/blob/master/CHANGELOG.md
+  source_code_uri: https://github.com/khiav223577/in_batches
+  documentation_uri: http://www.rubydoc.info/gems/in_batches
+  bug_tracker_uri: https://github.com/khiav223577/in_batches/issues
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Backport in_batches from Rails 5 for Rails 3 and 4.
+test_files: []