0.01
No release in over 3 years
Low commit activity in last 3 years
Batch Processing of Records with Blocks in Rails
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Development

~> 10.0
~> 3.2

Runtime

< 5.0, >= 3.2
 Project Readme

Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0 ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5 each_in_batches Logo by Aboling0, CC BY-SA 4.0

๐Ÿงบ EachInBatches

Version License: MIT Downloads Rank Open Source Helpers Coveralls Test Coverage CodeCov Test Coverage QLTY Test Coverage QLTY Maintainability

Liberapay Goal Progress Donate on PayPal Sponsor Me on Github Buy me a coffee Donate to my FLOSS or refugee efforts at ko-fi.com โ†’ more funding options

๐ŸŒป Synopsis

Better than Rails Batching. Can you batch backwards for destructive tasks? each_in_batches can.

๐Ÿšš Amazing test matrix was brought to you by ๐Ÿ”Ž appraisal2 ๐Ÿ”Ž
๐Ÿ‘Ÿ Check it out! โœจ github.com/appraisal-rb/appraisal2 โœจ

๐Ÿ’ก Info you can shake a stick at

Federated DVCS

Find this repo on other forges (Coming soon!)
Federated DVCS Repository Status Issues PRs Wiki CI Discussions
๐Ÿงช galtzo-floss/each_in_batches on GitLab The Truth ๐Ÿ’š ๐Ÿ’š ๐Ÿ’š ๐Ÿ€ Tiny Matrix โž–
๐ŸงŠ galtzo-floss/each_in_batches on CodeBerg An Ethical Mirror (Donate) ๐Ÿ’š ๐Ÿ’š โž– โญ•๏ธ No Matrix โž–
๐Ÿ™ galtzo-floss/each_in_batches on GitHub A Dirty Mirror ๐Ÿ’š ๐Ÿ’š โž– ๐Ÿ’ฏ Full Matrix ๐Ÿ’š
๐ŸŽฎ๏ธ Discord Server Live Chat on Discord Let's talk about this library!

Enterprise Support Tidelift

Need enterprise-level guarantees?

Get help from me on Tidelift

  • ๐Ÿ’กSubscribe for support guarantees covering all FLOSS dependencies
  • ๐Ÿ’กTidelift is part of Sonar
  • ๐Ÿ’กTidelift pays maintainers to maintain the software you depend on!
    ๐Ÿ“Š@Pointy Haired Boss: An enterprise support subscription is "never gonna let you down", and supports open source maintainers

Alternatively:

  • Live Chat on Discord
  • Get help from me on Upwork
  • Get help from me on Codementor
Tokens to Remember Gem name Gem namespace
Works with JRuby JRuby 9.1 Compat JRuby 9.2 Compat JRuby 9.3 Compat JRuby 9.4 Compat JRuby 10.0 Compat JRuby HEAD Compat
Works with Truffle Ruby Truffle Ruby 22.3 Compat Truffle Ruby 23.0 Compat Truffle Ruby 23.1 Compat Truffle Ruby 24.1 Compat
Works with MRI Ruby 3 Ruby 3.0 Compat Ruby 3.1 Compat Ruby 3.2 Compat Ruby 3.3 Compat Ruby 3.4 Compat Ruby HEAD Compat
Works with MRI Ruby 2 Ruby 2.0 Compat Ruby 2.1 Compat Ruby 2.2 Compat Ruby 2.3 Compat Ruby 2.4 Compat Ruby 2.5 Compat Ruby 2.6 Compat Ruby 2.7 Compat
Works with MRI Ruby 1 Ruby 1.9 Compat
Source Source on GitLab.com Source on CodeBerg.org Source on Github.com The best SHA: dQw4w9WgXcQ!
Documentation Current release on RubyDoc.info YARD on Galtzo.com Maintainer Blog Wiki
Compliance License: MIT ๐Ÿ“„ilo-declaration-img Security Policy Contributor Covenant 2.1 SemVer 2.0.0
Style Enforced Code Style Linter Keep-A-Changelog 1.0.0 Gitmoji Commits Compatibility appraised by: appraisal2
Support Live Chat on Discord Get help from me on Upwork Get help from me on Codementor
Maintainer ๐ŸŽ–๏ธ Follow Me on LinkedIn Follow Me on Ruby.Social Follow Me on Bluesky Contact Maintainer My technical writing
... ๐Ÿ’– Find Me on WellFound: Find Me on CrunchBase My LinkTree More About Me ๐ŸงŠ ๐Ÿ™ ๐Ÿ›– ๐Ÿงช

โœจ Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add each_in_batches

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install each_in_batches

๐Ÿ”’ Secure Installation

For Medium or High Security Installations

This gem is cryptographically signed, and has verifiable SHA-256 and SHA-512 checksums by stone_checksums. Be sure the gem you install hasnโ€™t been tampered with by following the instructions below.

Add my public key (if you havenโ€™t already, expires 2045-04-29) as a trusted certificate:

gem cert --add <(curl -Ls https://raw.github.com/galtzo-floss/certs/main/pboling.pem)

You only need to do that once. Then proceed to install with:

gem install each_in_batches -P HighSecurity

The HighSecurity trust profile will verify signed gems, and not allow the installation of unsigned dependencies.

If you want to up your security game full-time:

bundle config set --global trust-policy MediumSecurity

MediumSecurity instead of HighSecurity is necessary if not all the gems you use are signed.

NOTE: Be prepared to track down certs for signed gems and add them the same way you added mine.

๐Ÿ”ง Basic Usage

To create a new Batch, call Batch#new pass it the class and any additional arguments (all as a hash).

batch = EachInBatches::Batch.new(:arel => Payment.canceled.order("transaction_id ASC"), :batch_size => 50)

To process the batched data, pass a block to Batch#run the same way you would to an object in a block like Klass.all.each {|x| x.do_something }. Batch#run will pass the data to your block, one at a time, in batches set by the :batch_size argument.

batch.run {|x| puts x.id; puts x.transaction_id}

Print the results!

batch.print_results

Or...

Consolidate your code if you prefer

EachInBatches::Batch.new(:arel => Payment.canceled.order("transaction_id ASC"), batch_size => 50, :show_results => true).run{|x| puts x.id; puts x.transaction_id}

Configuration

Arguements for the initializer (Batch.new) method are:

Required:

  :arel          - Usage: :arel => Payment.canceled.order("transaction_id ASC")
                    Required, as this is the class that will be batched

Optional:

  :verbose       - Usage: :verbose => true or false
                    Sets verbosity of output
                    Default: false (if not provided)

  :backwards     - Usage: :backwards => true or false
                    Using the order supplied for :arel (if any) figures out what the batch set looks like,
		and begins working from the end rather than the front.
                    Default: false (if not provided)
		Example: EachInBatches::Batch.new(:arel => Report.where(company_id: nil).order("id ASC"), :backwards => true, :batch_size => 50).run{|x| x.destroy }

  :batch_size    - Usage: :batch_size => x
                    Where x is some number.
                    How many AR Objects should be processed at once?
                    Default: 50 (if not provided)

  :last_batch    - Usage: :last_batch => x
                    Where x is some number.
                    Only process up to and including batch #x.
                      Batch numbers start at 0 for the first batch.
                    Default: won't be used (no limit if not provided)

  :first_batch   - Usage: first_batch => x
                    Where x is some number.
                    Begin processing batches beginning at batch #x.
                      Batch numbers start at 0 for the first batch.
                    Default: won't be used (no offset if not provided)

  :show_results  - Usage: :show_results => true or false
                    Prints statistics about the results of Batch#run.
                    Default: true if verbose is set to true and :show_results is not provided, otherwise false

Output

Interpreting the output:

'[O]' means the batch was skipped due to an offset.
'[L]' means the batch was skipped due to a limit.
'[P]' means the batch is processing.
'[C]' means the batch is complete.
and yes... it was a coincidence.  This class is not affiliated with 'one laptop per child'

FLOSS Funding

How wonderful it is that nobody need wait a single moment before starting to improve the world.
โ€”Anne Frank

Iโ€™m driven by a passion to foster a thriving open-source community โ€“ a space where people can tackle complex problems, no matter how small. Revitalizing libraries that have fallen into disrepair, and building new libraries focused on solving real-world challenges, are my passions โ€” totaling 79 hours of FLOSS coding over just the past seven days, a pretty regular week for me. I was recently affected by layoffs, and the tech jobs market is unwelcoming. Iโ€™m reaching out here because your support would significantly aid my efforts to provide for my family, and my farm (11 ๐Ÿ” chickens, 2 ๐Ÿถ dogs, 3 ๐Ÿฐ rabbits, 8 ๐Ÿˆโ€ cats).

If you work at a company that uses my work, please encourage them to support me as a corporate sponsor. My work on gems you use might show up in bundle fund.

Iโ€™m developing a new library, floss_funding, designed to empower open-source developers like myself to get paid for the work we do, in a sustainable way. Please give it a look.

Floss-Funding.dev: ๐Ÿ‘‰๏ธ No network calls. ๐Ÿ‘‰๏ธ No tracking. ๐Ÿ‘‰๏ธ No oversight. ๐Ÿ‘‰๏ธ Minimal crypto hashing. ๐Ÿ’ก Easily disabled nags

Liberapay Goal Progress Donate on PayPal Sponsor Me on Github Buy me a coffee Donate on Polar Donate to my FLOSS or refugee efforts at ko-fi.com Donate to my FLOSS or refugee efforts using Patreon

๐Ÿ” Security

See SECURITY.md.

๐Ÿค Contributing

If you need some ideas of where to help, you could work on adding more code coverage, or if it is already ๐Ÿ’ฏ (see below) check reek, issues, or PRs, or use the gem and think about how it could be better.

We Keep A Changelog so if you make changes, remember to update it.

See CONTRIBUTING.md for more detailed instructions.

๐Ÿš€ Release Instructions

See CONTRIBUTING.md.

Code Coverage

Coverage Graph

Coveralls Test Coverage

QLTY Test Coverage

๐Ÿช‡ Code of Conduct

Everyone interacting with this project's codebases, issue trackers, chat rooms and mailing lists agrees to follow the Contributor Covenant 2.1.

๐ŸŒˆ Contributors

Contributors

Made with contributors-img.

Also see GitLab Contributors: https://gitlab.com/galtzo-floss/each_in_batches/-/graphs/main

โญ๏ธ Star History

Star History Chart

๐Ÿ“Œ Versioning

This Library adheres to Semantic Versioning 2.0.0. Violations of this scheme should be reported as bugs. Specifically, if a minor or patch version is released that breaks backward compatibility, a new version should be immediately released that restores compatibility. Breaking changes to the public API will only be introduced with new major versions.

dropping support for a platform is both obviously and objectively a breaking change
โ€”Jordan Harband (@ljharb, maintainer of SemVer) in SemVer issue 716

I understand that policy doesn't work universally ("exceptions to every rule!"), but it is the policy here. As such, in many cases it is good to specify a dependency on this library using the Pessimistic Version Constraint with two digits of precision.

For example:

spec.add_dependency("each_in_batches", "~> 1.0")
๐Ÿ“Œ Is "Platform Support" part of the public API? More details inside.

SemVer should, but doesn't explicitly, say that dropping support for specific Platforms is a breaking change to an API. It is obvious to many, but not all, and since the spec is silent, the bike shedding is endless.

To get a better understanding of how SemVer is intended to work over a project's lifetime, read this article from the creator of SemVer:

See CHANGELOG.md for a list of releases.

๐Ÿ“„ License

The gem is available as open source under the terms of the MIT License License: MIT. See LICENSE.txt for the official Copyright Notice.

ยฉ Copyright

  • Copyright (c) 2008-2015, 2025 Peter H.ย Boling, of Galtzo.com Galtzo.com Logo (Wordless) by Aboling0, CC BY-SA 4.0 , Brian Kidd, and each_in_batches contributors

P.S. If you need help๏ธ or want to say thanks, ๐Ÿ‘‡ Join the Discord.

Live Chat on Discord