job-iteration 1.10.0 → 1.12.0

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-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.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at shatrov@me.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in job-iteration.gemspec
-gemspec
-
-# for integration testing
-gem "sidekiq"
-gem "resque"
-gem "delayed_job"
-
-if defined?(@rails_gems_requirements) && @rails_gems_requirements
-  # We avoid the `gem "..."` syntax here so Dependabot doesn't try to update these gems.
-  [
-    "activejob",
-    "activerecord",
-    "railties",
-  ].each { |name| gem name, @rails_gems_requirements }
-else
-  # gem "activejob" # Set in gemspec
-  gem "activerecord"
-  gem "railties"
-end
-
-gem "mysql2", github: "brianmario/mysql2"
-gem "globalid"
-gem "i18n"
-gem "redis"
-
-gem "pry"
-gem "mocha"
-
-gem "rubocop-shopify", require: false
-gem "yard"
-gem "rake"
-gem "csv" # required for Ruby 3.4+
-
-# for unit testing optional sorbet support
-gem "sorbet-runtime"
-gem "tapioca"
-
-gem "logger"

data/Gemfile.lock

@@ -1,266 +0,0 @@
-GIT
-  remote: https://github.com/brianmario/mysql2
-  revision: 57b8df188c963ae0e4d4e1123d3e9de2bbcab637
-  specs:
-    mysql2 (0.5.6)
-      bigdecimal
-
-PATH
-  remote: .
-  specs:
-    job-iteration (1.10.0)
-      activejob (>= 6.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionpack (8.0.1)
-      actionview (= 8.0.1)
-      activesupport (= 8.0.1)
-      nokogiri (>= 1.8.5)
-      rack (>= 2.2.4)
-      rack-session (>= 1.0.1)
-      rack-test (>= 0.6.3)
-      rails-dom-testing (~> 2.2)
-      rails-html-sanitizer (~> 1.6)
-      useragent (~> 0.16)
-    actionview (8.0.1)
-      activesupport (= 8.0.1)
-      builder (~> 3.1)
-      erubi (~> 1.11)
-      rails-dom-testing (~> 2.2)
-      rails-html-sanitizer (~> 1.6)
-    activejob (8.0.1)
-      activesupport (= 8.0.1)
-      globalid (>= 0.3.6)
-    activemodel (8.0.1)
-      activesupport (= 8.0.1)
-    activerecord (8.0.1)
-      activemodel (= 8.0.1)
-      activesupport (= 8.0.1)
-      timeout (>= 0.4.0)
-    activesupport (8.0.1)
-      base64
-      benchmark (>= 0.3)
-      bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.3.1)
-      connection_pool (>= 2.2.5)
-      drb
-      i18n (>= 1.6, < 2)
-      logger (>= 1.4.2)
-      minitest (>= 5.1)
-      securerandom (>= 0.3)
-      tzinfo (~> 2.0, >= 2.0.5)
-      uri (>= 0.13.1)
-    ast (2.4.2)
-    base64 (0.2.0)
-    benchmark (0.4.0)
-    bigdecimal (3.1.9)
-    builder (3.3.0)
-    coderay (1.1.3)
-    concurrent-ruby (1.3.5)
-    connection_pool (2.5.0)
-    crass (1.0.6)
-    csv (3.3.2)
-    date (3.4.1)
-    delayed_job (4.1.13)
-      activesupport (>= 3.0, < 9.0)
-    drb (2.2.1)
-    erubi (1.13.1)
-    globalid (1.2.1)
-      activesupport (>= 6.1)
-    i18n (1.14.7)
-      concurrent-ruby (~> 1.0)
-    io-console (0.8.0)
-    irb (1.15.1)
-      pp (>= 0.6.0)
-      rdoc (>= 4.0.0)
-      reline (>= 0.4.2)
-    json (2.10.1)
-    language_server-protocol (3.17.0.4)
-    lint_roller (1.1.0)
-    logger (1.6.6)
-    loofah (2.24.0)
-      crass (~> 1.0.2)
-      nokogiri (>= 1.12.0)
-    method_source (1.1.0)
-    minitest (5.25.4)
-    mocha (2.7.1)
-      ruby2_keywords (>= 0.0.5)
-    mono_logger (1.1.2)
-    multi_json (1.15.0)
-    mustermann (3.0.3)
-      ruby2_keywords (~> 0.0.1)
-    netrc (0.11.0)
-    nokogiri (1.18.3-arm64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.18.3-x86_64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.18.3-x86_64-linux-gnu)
-      racc (~> 1.4)
-    parallel (1.26.3)
-    parser (3.3.7.1)
-      ast (~> 2.4.1)
-      racc
-    pp (0.6.2)
-      prettyprint
-    prettyprint (0.2.0)
-    prism (1.3.0)
-    pry (0.15.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    psych (5.2.3)
-      date
-      stringio
-    racc (1.8.1)
-    rack (3.1.12)
-    rack-protection (4.1.1)
-      base64 (>= 0.1.0)
-      logger (>= 1.6.0)
-      rack (>= 3.0.0, < 4)
-    rack-session (2.1.0)
-      base64 (>= 0.1.0)
-      rack (>= 3.0.0)
-    rack-test (2.2.0)
-      rack (>= 1.3)
-    rackup (2.2.1)
-      rack (>= 3)
-    rails-dom-testing (2.2.0)
-      activesupport (>= 5.0.0)
-      minitest
-      nokogiri (>= 1.6)
-    rails-html-sanitizer (1.6.2)
-      loofah (~> 2.21)
-      nokogiri (>= 1.15.7, != 1.16.7, != 1.16.6, != 1.16.5, != 1.16.4, != 1.16.3, != 1.16.2, != 1.16.1, != 1.16.0.rc1, != 1.16.0)
-    railties (8.0.1)
-      actionpack (= 8.0.1)
-      activesupport (= 8.0.1)
-      irb (~> 1.13)
-      rackup (>= 1.0.0)
-      rake (>= 12.2)
-      thor (~> 1.0, >= 1.2.2)
-      zeitwerk (~> 2.6)
-    rainbow (3.1.1)
-    rake (13.2.1)
-    rbi (0.3.0)
-      prism (~> 1.0)
-      rbs (>= 3.4.4)
-      sorbet-runtime (>= 0.5.9204)
-    rbs (3.8.1)
-      logger
-    rdoc (6.12.0)
-      psych (>= 4.0.0)
-    redis (5.4.0)
-      redis-client (>= 0.22.0)
-    redis-client (0.24.0)
-      connection_pool
-    redis-namespace (1.11.0)
-      redis (>= 4)
-    regexp_parser (2.10.0)
-    reline (0.6.0)
-      io-console (~> 0.5)
-    resque (2.7.0)
-      mono_logger (~> 1)
-      multi_json (~> 1.0)
-      redis-namespace (~> 1.6)
-      sinatra (>= 0.9.2)
-    rubocop (1.73.2)
-      json (~> 2.3)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.1.0)
-      parallel (~> 1.10)
-      parser (>= 3.3.0.2)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.38.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.38.1)
-      parser (>= 3.3.1.0)
-    rubocop-shopify (2.16.0)
-      rubocop (~> 1.62)
-    ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
-    securerandom (0.4.1)
-    sidekiq (8.0.1)
-      connection_pool (>= 2.5.0)
-      json (>= 2.9.0)
-      logger (>= 1.6.2)
-      rack (>= 3.1.0)
-      redis-client (>= 0.23.2)
-    sinatra (4.1.1)
-      logger (>= 1.6.0)
-      mustermann (~> 3.0)
-      rack (>= 3.0.0, < 4)
-      rack-protection (= 4.1.1)
-      rack-session (>= 2.0.0, < 3)
-      tilt (~> 2.0)
-    sorbet (0.5.11915)
-      sorbet-static (= 0.5.11915)
-    sorbet-runtime (0.5.11915)
-    sorbet-static (0.5.11915-universal-darwin)
-    sorbet-static (0.5.11915-x86_64-linux)
-    sorbet-static-and-runtime (0.5.11915)
-      sorbet (= 0.5.11915)
-      sorbet-runtime (= 0.5.11915)
-    spoom (1.6.0)
-      erubi (>= 1.10.0)
-      prism (>= 0.28.0)
-      rbi (>= 0.2.3)
-      sorbet-static-and-runtime (>= 0.5.10187)
-      thor (>= 0.19.2)
-    stringio (3.1.5)
-    tapioca (0.16.11)
-      benchmark
-      bundler (>= 2.2.25)
-      netrc (>= 0.11.0)
-      parallel (>= 1.21.0)
-      rbi (~> 0.2)
-      sorbet-static-and-runtime (>= 0.5.11087)
-      spoom (>= 1.2.0)
-      thor (>= 1.2.0)
-      yard-sorbet
-    thor (1.3.2)
-    tilt (2.6.0)
-    timeout (0.4.3)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (3.1.4)
-      unicode-emoji (~> 4.0, >= 4.0.4)
-    unicode-emoji (4.0.4)
-    uri (1.0.3)
-    useragent (0.16.11)
-    yard (0.9.37)
-    yard-sorbet (0.9.0)
-      sorbet-runtime
-      yard
-    zeitwerk (2.7.2)
-
-PLATFORMS
-  arm64-darwin
-  x86_64-darwin
-  x86_64-linux
-
-DEPENDENCIES
-  activerecord
-  csv
-  delayed_job
-  globalid
-  i18n
-  job-iteration!
-  logger
-  mocha
-  mysql2!
-  pry
-  railties
-  rake
-  redis
-  resque
-  rubocop-shopify
-  sidekiq
-  sorbet-runtime
-  tapioca
-  yard
-
-BUNDLED WITH
-   2.6.1

data/Rakefile

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-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/bin/setup

@@ -1,23 +0,0 @@
-#!/bin/bash
-
-if ! [ -x "$(command -v mysql)" ];
-then
-  echo "Error: mysql is not installed." >&2
-  echo "You need to install mysql"
-  exit 1
-else
-  echo "Installing dependencies"
-  bundle install --quiet
-
-  mysql.server start > /dev/null 2>&1
-  mysql -uroot job_iteration_test -e exit > /dev/null 2>&1
-
-  if [ $? -eq 0 ];
-  then
-    echo "Setup completed!"
-  else
-    echo "Creating job_iteration_test database"
-    mysql -uroot -e "CREATE DATABASE job_iteration_test" > /dev/null 2>&1
-    echo "Setup completed!"
-  fi
-fi

data/bin/test

@@ -1,32 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-def main
-  begin
-    command = create_command
-  rescue ArgumentError => e
-    abort(e.message)
-  end
-  puts "Running #{command.join(" ")}"
-  system(*command)
-end
-
-def create_command
-  case ARGV.length
-  when 0
-    ["bundle", "exec", "rake", "test"]
-  when 1
-    filename = ARGV[0]
-    ["bundle", "exec", "rake", "test", "TEST=#{filename}"]
-  when 2
-    filename = ARGV[0]
-    test_name = ARGV[1]
-    test_name_with_underscores = test_name.tr(" ", "_")
-    test_name_pattern = "/#{Regexp.escape(test_name_with_underscores)}/"
-    ["bundle", "exec", "rake", "test", "TEST=#{filename}", "TESTOPTS=\"--name=#{test_name_pattern} -v\""]
-  else
-    raise ArgumentError, "Too many arguments. Did you forget to put the test name in quotes?"
-  end
-end
-
-main

data/dev.yml

@@ -1,54 +0,0 @@
-# This file is for Shopify employees development environment.
-# If you are an external contributor you don't have to bother with it.
-name: job-iteration
-
-up:
-  - packages:
-      - mysql_client
-  - ruby
-  - bundler
-  - mysql
-  - redis
-  - custom:
-      name: Create Job Iteration database
-      meet: mysql -uroot -h $MYSQL_HOST -P $MYSQL_PORT -e "CREATE DATABASE job_iteration_test"
-      met?: mysql -uroot -h $MYSQL_HOST -P $MYSQL_PORT job_iteration_test -e "SELECT 1" &> /dev/null
-
-commands:
-  test:
-    run:  bin/test "$@"
-    syntax:
-      optional: filename testnamepattern
-    aliases: [t]
-    desc: run tests
-    long_desc: |
-      {{bold:Default}}
-      =======
-      Run the entire test suite.
-
-        Examples:
-        {{command:dev test}}
-        {{command:dev t}}
-
-      {{bold:Run all tests in a file}}
-      ========================
-      Include the file path.
-
-        Example:
-        {{command:dev test test/unit/iteration_test.rb}}
-
-      {{bold:Run a single test in a given file}}
-      ========================
-      Include the file path and the name of the test you'd like to run.
-
-        Example:
-        {{command:dev test test/unit/iteration_test.rb test_that_it_has_a_version_number}}
-
-      {{bold:Run all tests in a given file whose name contains a string}}
-      ========================
-      Include the file path and the string that the test names should contain.
-
-        Example:
-        {{command:dev test test/unit/iteration_test.rb version_number}}
-  style:
-    run: bundle exec rubocop -a

data/gemfiles/rails_gems.gemfile

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-rails_version = ENV.fetch("RAILS_VERSION")
-@rails_gems_requirements = case rails_version
-when "edge"         then { github: "rails/rails", branch: "main" }
-when /\A\d+\.\d+\z/ then "~> #{rails_version}.0"
-else                raise "Unsupported RAILS_VERSION: #{rails_version}"
-end
-
-eval_gemfile "../Gemfile"
-
-# https://github.com/rails/rails/pull/44083
-if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.1") &&
-    rails_version != "edge" && Gem::Version.new(rails_version) < Gem::Version.new("7")
-  gem "net-imap", require: false
-  gem "net-pop", require: false
-  gem "net-smtp", require: false
-end

data/guides/argument-semantics.md

@@ -1,128 +0,0 @@
-`job-iteration` overrides the `perform` method of `ActiveJob::Base` to allow for iteration. The `perform` method preserves all the standard calling conventions of the original, but the way the subsequent methods work might differ from what one expects from an ActiveJob subclass.
-
-The call sequence is usually 3 methods:
-
-`perform -> build_enumerator -> each_iteration|each_batch`
-
-In that sense `job-iteration` works like a framework (it calls your code) rather than like a library (that you call). When using jobs with parameters, the following rules of thumb are good to keep in mind.
-
-### Jobs without arguments
-
-Jobs without arguments do not pass anything into either `build_enumerator` or `each_iteration` except for the `cursor` which `job-iteration` persists by itself:
-
-```ruby
-class ArglessJob < ActiveJob::Base
-  include JobIteration::Iteration
-
-  def build_enumerator(cursor:)
-    # ...
-  end
-
-  def each_iteration(single_object_yielded_from_enumerator)
-    # ...
-  end
-end
-```
-
-To enqueue the job:
-
-```ruby
-ArglessJob.perform_later
-```
-
-### Jobs with positional arguments
-
-Jobs with positional arguments will have those arguments available to both `build_enumerator` and `each_iteration`:
-
-```ruby
-class ArgumentativeJob < ActiveJob::Base
-  include JobIteration::Iteration
-
-  def build_enumerator(arg1, arg2, arg3, cursor:)
-    # ...
-  end
-
-  def each_iteration(single_object_yielded_from_enumerator, arg1, arg2, arg3)
-    # ...
-  end
-end
-```
-
-To enqueue the job:
-
-```ruby
-ArgumentativeJob.perform_later(_arg1 = "One", _arg2 = "Two", _arg3 = "Three")
-```
-
-### Jobs with keyword arguments
-
-Jobs with keyword arguments will have the keyword arguments available to both `build_enumerator` and `each_iteration`, but these arguments come packaged into a Hash in both cases. You will need to `fetch` or `[]` your parameter from the `Hash` you get passed in:
-
-```ruby
-class ParameterizedJob < ActiveJob::Base
-  include JobIteration::Iteration
-
-  def build_enumerator(kwargs, cursor:)
-    name = kwargs.fetch(:name)
-    email = kwargs.fetch(:email)
-    # ...
-  end
-
-  def each_iteration(object_yielded_from_enumerator, kwargs)
-    name = kwargs.fetch(:name)
-    email = kwargs.fetch(:email)
-    # ...
-  end
-end
-```
-
-To enqueue the job:
-
-```ruby
-ParameterizedJob.perform_later(name: "Jane", email: "jane@host.example")
-```
-
-Note that you cannot use `ruby2_keywords` at present, and the keyword arguments syntax is not supported in `each_iteration` / `build_enumerator`.
-
-### Jobs with both positional and keyword arguments
-
-Jobs with keyword arguments will have the keyword arguments available to both `build_enumerator` and `each_iteration`, but these arguments come packaged into a Hash in both cases. You will need to `fetch` or `[]` your parameter from the `Hash` you get passed in. Positional arguments get passed first and "unsplatted" (not combined into an array), the `Hash` containing keyword arguments comes after:
-
-```ruby
-class HighlyConfigurableGreetingJob < ActiveJob::Base
-  include JobIteration::Iteration
-
-  def build_enumerator(subject_line, kwargs, cursor:)
-    name = kwargs.fetch(:sender_name)
-    email = kwargs.fetch(:sender_email)
-    # ...
-  end
-
-  def each_iteration(object_yielded_from_enumerator, subject_line, kwargs)
-    name = kwargs.fetch(:sender_name)
-    email = kwargs.fetch(:sender_email)
-    # ...
-  end
-end
-```
-
-To enqueue the job:
-
-```ruby
-HighlyConfigurableGreetingJob.perform_later(_subject_line = "Greetings everybody!", sender_name: "Jane", sender_email: "jane@host.example")
-```
-
-Note that you cannot use `ruby2_keywords` at present, and the keyword arguments syntax is not supported in `each_iteration` / `build_enumerator`.
-
-### Returning (yielding) from enumerators
-
-When defining a custom enumerator (see the [custom enumerator guide](custom-enumerator.md)) you need to yield two positional arguments from it: the object that will be the value for the current iteration (like a single ActiveModel instance, a single number...) and the value you want to be persisted as the `cursor` value should `job-iteration` decide to interrupt you after this iteration. Calling the enumerator with that cursor should return the next object after the one returned in this iteration. That new `cursor` value does not get passed to `each_iteration`:
-
-```ruby
-Enumerator.new do |yielder|
-  # In this case `cursor` is an Integer
-  cursor.upto(99999) do |offset|
-    yielder.yield(fetch_record_at(offset), offset)
-  end
-end
-```