sidekiq-bulk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4467f6dfbb08aded4d1920854812a0e841415af
+  data.tar.gz: 540bcd05a47d04fff7fbf2def5000d69a5c0f80c
+SHA512:
+  metadata.gz: ee2fe544d0d934e5fe7b5cdd9bc9dccfea9e6825f13ed4fa5f210cb1e70dcde9a8fe390222276841f1c89c3b081c5e406b27d64b499cc5793cb9c6bd2dc92360
+  data.tar.gz: 6c5c5b6ed37b46bde6e7b29ee797611934d10687fe201b43f5ade1d26fb66e4cc19de3d106742864ddcf7a0a979d52d2f00ec9d16d7b62b3768be23d4f98b9d0

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format ReRunFriendlyFormatter
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,18 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - ruby-head
+gemfile:
+  - gemfiles/sidekiq_2_x.gemfile
+  - gemfiles/sidekiq_3_x.gemfile
+  - gemfiles/sidekiq_edge.gemfile
+script:
+  - bundle exec rspec
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - gemfile: gemfiles/sidekiq_edge.gemfile

data/Appraisals

@@ -0,0 +1,11 @@
+appraise "sidekiq-2-x" do
+  gem "sidekiq", "~> 2.0"
+end
+
+appraise "sidekiq-3-x" do
+  gem "sidekiq", "~> 3.0"
+end
+
+appraise "sidekiq-edge" do
+  gem "sidekiq", github: "mperham/sidekiq"
+end

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org/"
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+(MIT License)
+
+Copyright (c) 2015 Adam Prescott
+
+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,81 @@
+# sidekiq-bulk
+
+[![Build Status](https://travis-ci.org/aprescott/sidekiq-bulk.svg?branch=master)](https://travis-ci.org/aprescott/sidekiq-bulk)
+
+Give your workers more to do!
+
+Augments Sidekiq job classes with a `push_bulk` method for easier bulk pushing.
+
+Sidekiq comes with `Sidekiq::Client.push_bulk` which can be faster than `perform_async` if you have lots and lots of jobs to enqueue.
+
+This gem provides a wrapper around it so that instead of
+
+```ruby
+Sidekiq::Client.push_bulk("class" => FooJob, "args" => [[1], [2], [3])
+```
+
+You can write
+
+```ruby
+FooJob.push_bulk([1, 2, 3])
+```
+
+More stuff is supported!
+
+### Installing
+
+With Bundler:
+
+```ruby
+# in Gemfile
+gem "sidekiq-bulk"
+```
+
+Either `require "sidekiq-bulk"` or `require "sidekiq/bulk"`.
+
+### To use
+
+To enqueue an array of single elements:
+
+```ruby
+FooJob.push_bulk([1, 2, 3]) # enqueues 3 jobs for FooJob, each with 1 argument
+```
+
+To enqueue jobs with more than one argument:
+
+```ruby
+FooJob.push_bulk(all_users) do |user|
+  [user.id, "foobar"]
+end
+
+# enqueues one job for each element of `all_users`, where each job
+# has two arguments: the user ID and the string "foobar".
+#
+# equivalent to, but faster than:
+
+all_users.each do |user|
+  FooJob.perform_async(user.id, "foobar")
+end
+```
+
+### License
+
+Copyright (c) 2015 Adam Prescott, licensed under the MIT license. See LICENSE.
+
+### Development
+
+Issues (bugs, questions, etc.) should be opened with [the GitHub project](https://github.com/aprescott/sidekiq-bulk).
+
+To contribute changes:
+
+1. Visit the [GitHub repository for `sidekiq-bulk`](https://github.com/aprescott/sidekiq-bulk).
+2. [Fork the repository](https://help.github.com/articles/fork-a-repo).
+3. Make new feature branch: `git checkout -b master new-feature` (do not add on top of `master`!)
+4. Implement the feature, along with tests.
+5. [Send a pull request](https://help.github.com/articles/fork-a-repo).
+
+Make sure to `bundle install`.
+
+Tests live in `spec/`. Run them with `bundle exec rspec`.
+
+To run tests against various Sidekiq versions, use `appraisal rspec`, after `appraisal bundle` if necessary. (See the [Appraisal](https://github.com/thoughtbot/appraisal) project and the `Appraisals` file for more details.)

data/gemfiles/sidekiq_2_x.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org/"
+
+gemspec :path => "../"
+
+gem "sidekiq", "~> 2.0"

data/gemfiles/sidekiq_3_x.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org/"
+
+gemspec :path => "../"
+
+gem "sidekiq", "~> 3.0"

data/gemfiles/sidekiq_edge.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org/"
+
+gemspec :path => "../"
+
+gem "sidekiq", github: "mperham/sidekiq"

data/lib/sidekiq-bulk.rb

@@ -0,0 +1 @@
+require "sidekiq/bulk"

data/lib/sidekiq/bulk.rb

@@ -0,0 +1,15 @@
+puts Sidekiq::VERSION
+
+module SidekiqBulk
+  def push_bulk(items, &block)
+    if block
+      args = items.map(&block)
+    else
+      args = items.map { |el| [el] }
+    end
+
+    Sidekiq::Client.push_bulk("class" => self, "args" => args)
+  end
+end
+
+Sidekiq::Worker::ClassMethods.include SidekiqBulk

data/sidekiq-bulk.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name         = "sidekiq-bulk"
+  s.version      = "0.0.1"
+  s.authors      = ["Adam Prescott"]
+  s.email        = ["adam@aprescott.com"]
+  s.homepage     = "https://github.com/aprescott/sidekiq-bulk"
+  s.summary      = "Give your workers more to do!"
+  s.description  = "Augments Sidekiq job classes with a push_bulk method for easier bulk pushing."
+  s.files        = Dir["{lib/**/*,spec/**/*,gemfiles/*.gemfile}"] + %w[sidekiq-bulk.gemspec .rspec .travis.yml LICENSE Gemfile Appraisals README.md]
+  s.require_path = "lib"
+  s.test_files   = Dir["spec/*"]
+  s.required_ruby_version = ">= 2.0.0"
+  s.licenses = ["MIT"]
+
+  s.add_dependency("sidekiq")
+  s.add_development_dependency("rspec", ">= 3.3")
+  s.add_development_dependency("rspec-sidekiq")
+  s.add_development_dependency("pry-byebug")
+  s.add_development_dependency("appraisal")
+end

data/spec/examples.txt

@@ -0,0 +1,8 @@
+example_id                         | status | run_time        |
+---------------------------------- | ------ | --------------- |
+./spec/sidekiq_bulk_spec.rb[1:1]   | passed | 0.00109 seconds |
+./spec/sidekiq_bulk_spec.rb[1:2]   | passed | 0.0005 seconds  |
+./spec/sidekiq_bulk_spec.rb[1:3]   | passed | 0.01235 seconds |
+./spec/sidekiq_bulk_spec.rb[1:4]   | passed | 0.00035 seconds |
+./spec/sidekiq_bulk_spec.rb[1:5]   | passed | 0.00376 seconds |
+./spec/sidekiq_bulk_spec.rb[1:6:1] | passed | 0.00211 seconds |

data/spec/re_run_friendly_formatter.rb

@@ -0,0 +1,31 @@
+require "rspec/core/formatters/progress_formatter"
+
+class ReRunFriendlyFormatter < RSpec::Core::Formatters::ProgressFormatter
+  RSpec::Core::Formatters.register self, :dump_summary
+
+  def dump_summary(summary)
+    super
+
+    failed_files = summary.failed_examples.map { |e| RSpec::Core::Metadata::relative_path(e.file_path) }.uniq
+
+    return if summary.failed_examples.empty? || failed_files.length > 10
+
+    output.puts
+    output.puts "Rerun all failed examples:"
+    output.puts
+
+    output.puts failure_colored("rspec #{summary.failed_examples.map { |e| RSpec::Core::Metadata::relative_path(e.location) }.uniq.join(" ")}")
+
+    output.puts
+    output.puts "Rerun all files containing failures:"
+    output.puts
+
+    output.puts failure_colored("rspec #{failed_files.uniq.join(" ")}")
+  end
+
+  private
+
+  def failure_colored(str)
+    RSpec::Core::Formatters::ConsoleCodes.wrap(str, :failure)
+  end
+end

data/spec/sidekiq_bulk_spec.rb

@@ -0,0 +1,50 @@
+RSpec.describe SidekiqBulk do
+  class FooJob
+    include Sidekiq::Worker
+
+    def perform(x, *args)
+      raise x.to_s
+    end
+  end
+
+  class BarJob < FooJob
+  end
+
+  it "provides a push_bulk method on job classes" do
+    expect(FooJob).to respond_to(:push_bulk)
+  end
+
+  it "enqueues the job" do
+    FooJob.push_bulk([1, 2, 3]) { |el| [el, "some-value"] }
+
+    expect(FooJob.jobs.length).to eq(3)
+    expect(FooJob).to have_enqueued_job(1, "some-value")
+    expect(FooJob).to have_enqueued_job(2, "some-value")
+    expect(FooJob).to have_enqueued_job(3, "some-value")
+  end
+
+  it "goes through the Sidekiq::Client interface" do
+    expect(Sidekiq::Client).to receive(:push_bulk).with("class" => FooJob, "args" => [[1], [2], [3]])
+
+    FooJob.push_bulk([1, 2, 3])
+  end
+
+  it "uses the correct class name for subclasses" do
+    expect(Sidekiq::Client).to receive(:push_bulk).with("class" => BarJob, "args" => [[1], [2], [3]])
+
+    BarJob.push_bulk([1, 2, 3])
+  end
+
+  it "defaults to the identity function with no block given" do
+    FooJob.push_bulk([1, 2, 3])
+
+    expect(FooJob.jobs.length).to eq(3)
+    expect(FooJob).to have_enqueued_job(1)
+    expect(FooJob).to have_enqueued_job(2)
+    expect(FooJob).to have_enqueued_job(3)
+  end
+
+  describe "inline test", sidekiq: :inline do
+    specify { expect { FooJob.push_bulk([1, 2, 3]) }.to raise_error(RuntimeError, "1") }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,99 @@
+require "sidekiq"
+require "sidekiq/bulk"
+require "sidekiq/testing"
+require "rspec"
+require "rspec-sidekiq"
+require "pry-byebug"
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = false
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end
+
+# sidekiq test configuration
+RSpec.configure do |config|
+  config.before(:each) do |example_method|
+    # Clears out the jobs for tests using the fake testing
+    Sidekiq::Worker.clear_all
+  end
+
+  # use an around to allow each test to specify
+  # its own around block and override the testing
+  # context.
+  config.before(:each) do |example_method|
+    # Clears out the jobs for tests using the fake testing
+    Sidekiq::Worker.clear_all
+  end
+
+  # use an around to allow each test to specify
+  # its own around block and override the testing
+  # context.
+  config.around(:each) do |example|
+    # acceptance tests run the jobs immediately.
+    if example.metadata[:type] == :feature || example.metadata[:sidekiq] == :inline
+      Sidekiq::Testing.inline!(&example)
+    else
+      Sidekiq::Testing.fake!(&example)
+    end
+  end
+end
+
+# rspec-sidekiq
+RSpec::Sidekiq.configure do |config|
+  config.warn_when_jobs_not_processed_by_sidekiq = false
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-bulk
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adam Prescott
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rspec-sidekiq
+  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: pry-byebug
+  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: appraisal
+  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: Augments Sidekiq job classes with a push_bulk method for easier bulk
+  pushing.
+email:
+- adam@aprescott.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE
+- README.md
+- gemfiles/sidekiq_2_x.gemfile
+- gemfiles/sidekiq_3_x.gemfile
+- gemfiles/sidekiq_edge.gemfile
+- lib/sidekiq-bulk.rb
+- lib/sidekiq/bulk.rb
+- sidekiq-bulk.gemspec
+- spec/examples.txt
+- spec/re_run_friendly_formatter.rb
+- spec/sidekiq_bulk_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/aprescott/sidekiq-bulk
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Give your workers more to do!
+test_files:
+- spec/examples.txt
+- spec/re_run_friendly_formatter.rb
+- spec/sidekiq_bulk_spec.rb
+- spec/spec_helper.rb