sidekiq-bunch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2235cb2837561e33624cf5879327982209465a1e94bf8c527893213824f25f26
+  data.tar.gz: 8c4c93d14c8efc4b9d5419a20f77145a913eab17c69263e6ef36cd7e52855a48
+SHA512:
+  metadata.gz: a5f6af39be6601ffa47d1246c5693a93c52c8955a70878cd8e94474a137cb6bfdb4d046db51e2aba4816288d79d01e631fec64ebea6411967baad9c6c2b8a2af
+  data.tar.gz: f03cea75ecd875b1fe3cac27f4d58ea843ffa3cb6475514ecc5e5335ee8f1ad2835901987525e67332d2e7d87cb294be55f175f7888fed5311e0cc7597a72454

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/gemfiles/*.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,29 @@
+language: ruby
+sudo: false
+services:
+  - redis-server
+rvm:
+  - 2.1
+  - 2.2
+  - 2.3
+  - 2.4
+  - 2.5
+gemfile:
+  - gemfiles/sidekiq_4.0.gemfile
+  - gemfiles/sidekiq_4.1.gemfile
+  - gemfiles/sidekiq_4.2.gemfile
+  - gemfiles/sidekiq_5.0.gemfile
+  - gemfiles/sidekiq_5.1.gemfile
+  - gemfiles/sidekiq_master.gemfile
+matrix:
+  fast_finish: true
+  exclude:
+    - gemfile: gemfiles/sidekiq_5.1.gemfile
+      rvm: 2.1
+    - gemfile: gemfiles/sidekiq_5.0.gemfile
+      rvm: 2.1
+    - gemfile: gemfiles/sidekiq_master.gemfile
+
+before_install: gem install bundler -v 1.15
+script:
+  - bundle exec rake spec

data/Appraisals

@@ -0,0 +1,23 @@
+appraise 'sidekiq-4.0' do
+  gem 'sidekiq', '~> 4.0.0'
+end
+
+appraise 'sidekiq-4.1' do
+  gem 'sidekiq', '~> 4.1.0'
+end
+
+appraise 'sidekiq-4.2' do
+  gem 'sidekiq', '~> 4.2.0'
+end
+
+appraise 'sidekiq-5.0' do
+  gem 'sidekiq', '~> 5.0.0'
+end
+
+appraise 'sidekiq-5.1' do
+  gem 'sidekiq', '~> 5.1.0'
+end
+
+appraise 'sidekiq-master' do
+  gem 'sidekiq', github: 'mperham/sidekiq'
+end

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in sidekiq-bunch.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Vladimir Kochnev
+
+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,51 @@
+[![Build Status](https://travis-ci.org/marshall-lee/sidekiq-bunch.svg?branch=master)](https://travis-ci.org/marshall-lee/sidekiq-bunch)
+
+# sidekiq-bunch
+
+Lightweight Sidekiq job bunches implemented with Redis set data structure.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-bunch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-bunch
+
+## Usage
+
+```ruby
+bunch = Sidekiq::Bunch.new
+bunch.hook_jobs do
+  1000.times do
+    MyWorker.perform_async
+  end
+end
+
+bunch.size # => 1000
+bunch.empty? # => false
+bunch.wait_for_empty # ...
+bunch.empty? # => true
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/marshall-lee/sidekiq-bunch.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq/bunch"
+
+require "pry"
+Pry.start

data/bin/setup

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

data/gemfiles/sidekiq_4.0.gemfile

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

data/gemfiles/sidekiq_4.1.gemfile

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

data/gemfiles/sidekiq_4.2.gemfile

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

data/gemfiles/sidekiq_5.0.gemfile

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

data/gemfiles/sidekiq_5.1.gemfile

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

data/gemfiles/sidekiq_master.gemfile

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

data/lib/sidekiq/bunch.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require 'sidekiq'
+require 'sidekiq/postpone'
+
+class Sidekiq::Bunch
+  require 'sidekiq/bunch/version'
+  require 'sidekiq/bunch/middleware'
+  require 'sidekiq/bunch/worker'
+
+  TimeoutError = Class.new(StandardError)
+
+  def self.generate_bunch_id
+    SecureRandom.hex(12)
+  end
+
+  def initialize(bunch_id = self.class.generate_bunch_id)
+    @bunch_id = bunch_id
+    @jids_key = build_jids_key
+  end
+
+  def hook(ignore: nil)
+    Thread.current[:sidekiq_bunch] = self
+    Sidekiq::Postpone.wrap(join_parent: false, flush: false) do |postpone|
+      yield
+      jids =
+        if ignore
+          postpone.all_jobs.reject(&ignore).map { |j| j['jid'] }
+        else
+          postpone.jids
+        end
+      multi do
+        add(jids)
+        postpone.flush!
+      end
+    end
+  ensure
+    Thread.current[:sidekiq_bunch] = nil
+  end
+
+  def on_success(job)
+    rem(job['jid'])
+  end
+
+  def add(jids)
+    jids = Array(jids)
+
+    redis do |r|
+      r.sadd(@jids_key, jids)
+    end
+  end
+
+  def rem(jids)
+    jids = Array(jids)
+
+    redis do |r|
+      r.srem(@jids_key, jids)
+    end
+  end
+
+  def size
+    redis { |r| r.scard(@jids_key) }
+  end
+
+  def empty?
+    0 == size
+  end
+
+  def wait_for_empty(poll_interval: 1.0, timeout: nil)
+    start_time = Time.now if timeout
+    loop do
+      break if empty?
+      raise TimeoutError if timeout && (Time.now - start_time) >= timeout
+      sleep(poll_interval)
+    end
+  end
+
+  attr_reader :bunch_id
+
+  private
+
+  def build_jids_key
+    "bunches:#{@bunch_id}-jids"
+  end
+
+  def redis
+    Sidekiq.redis { |r| yield r }
+  end
+
+  def multi
+    redis { |r| r.multi { |m| yield m } }
+  end
+end

data/lib/sidekiq/bunch/middleware.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Sidekiq::Bunch::Middleware
+  class Client
+    def call(_worker_class, msg, _queue, _redis_pool)
+      bunch = Thread.current[:sidekiq_bunch]
+      msg['bunch_id'] = bunch.bunch_id if bunch
+      yield
+    end
+  end
+
+  class Server
+    def call(worker, msg, _queue)
+      bunch_id = msg['bunch_id']
+      if bunch_id
+        worker.bunch_id = bunch_id
+        result = yield
+        Sidekiq::Bunch.new(bunch_id).on_success(msg)
+        result
+      else
+        yield
+      end
+    end
+  end
+
+  Sidekiq.configure_client do |config|
+    config.client_middleware do |chain|
+      chain.add Client
+    end
+  end
+
+  Sidekiq.configure_server do |config|
+    config.client_middleware do |chain|
+      chain.add Client
+    end
+
+    config.server_middleware do |chain|
+      chain.add Server
+    end
+  end
+end

data/lib/sidekiq/bunch/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  class Bunch
+    VERSION = '0.1.0'
+  end
+end

data/lib/sidekiq/bunch/worker.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'sidekiq/worker'
+
+class Sidekiq::Bunch
+  module Worker
+    attr_accessor :bunch_id
+
+    def bunch
+      @bunch ||= Sidekiq::Bunch.new(bunch_id) if bunch_id
+    end
+  end
+
+  Sidekiq::Worker.prepend Worker
+end

data/sidekiq-bunch.gemspec

@@ -0,0 +1,34 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/bunch/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sidekiq-bunch'
+  spec.version       = Sidekiq::Bunch::VERSION
+  spec.authors       = ['Vladimir Kochnev']
+  spec.email         = ['hashtable@yandex.ru']
+
+  spec.summary       = %q{Lightweight implementation of job bunches.}
+  spec.homepage      = 'https://github.com/marshall-lee/sidekiq-bunch'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'sidekiq', '>= 3'
+  spec.add_dependency 'sidekiq-postpone', '>= 0.3.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'appraisal', '~> 2.2.0'
+  spec.add_development_dependency 'redis-namespace', '~> 1.5.2'
+
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-bunch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vladimir Kochnev
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  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'
+- !ruby/object:Gem::Dependency
+  name: sidekiq-postpone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+description: 
+email:
+- hashtable@yandex.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/sidekiq_4.0.gemfile
+- gemfiles/sidekiq_4.1.gemfile
+- gemfiles/sidekiq_4.2.gemfile
+- gemfiles/sidekiq_5.0.gemfile
+- gemfiles/sidekiq_5.1.gemfile
+- gemfiles/sidekiq_master.gemfile
+- lib/sidekiq/bunch.rb
+- lib/sidekiq/bunch/middleware.rb
+- lib/sidekiq/bunch/version.rb
+- lib/sidekiq/bunch/worker.rb
+- sidekiq-bunch.gemspec
+homepage: https://github.com/marshall-lee/sidekiq-bunch
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Lightweight implementation of job bunches.
+test_files: []