sidekiq-recursive 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f8039623c6e6890c840050a797e2d2a4a336d0e
+  data.tar.gz: a34b1e3f4f7385f3286e0e6dffc997f54e6cd94e
+SHA512:
+  metadata.gz: 7d1b745ac1162cb03dc27c89d2e9e87674ff395b235d22ff75d3795d6da994470f4bf603cb3ff019fc684df1858b2a0d875bb45c3604be1c583e8ebd3f18bf18
+  data.tar.gz: 25f1d7fe4856aa606bb73935b3ae3580ff10e354bf6d12a1f096e2ba8bfb4af0bdccb85e923912528318a188737da6884913498fa78c3b47a70c42810a8e5386

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*gem
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.16.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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 justas.kazakauskas@vinted.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

@@ -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-recursive.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: .
+  specs:
+    sidekiq-recursive (0.1.0)
+      sidekiq (~> 5.1, >= 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    connection_pool (2.2.1)
+    diff-lcs (1.3)
+    fakeredis (0.7.0)
+      redis (>= 3.2, < 5.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.0.4)
+    rack-protection (2.0.1)
+      rack
+    rake (12.3.1)
+    redis (4.0.1)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    sidekiq (5.1.2)
+      concurrent-ruby (~> 1.0)
+      connection_pool (~> 2.2, >= 2.2.0)
+      rack-protection (>= 1.5.0)
+      redis (>= 3.3.5, < 5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  fakeredis (~> 0.7.0)
+  pry (~> 0.11.3)
+  rake (~> 12.3)
+  rspec (~> 3.7)
+  sidekiq-recursive!
+
+BUNDLED WITH
+   1.16.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Justas Kazakauskas
+
+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/Makefile

@@ -0,0 +1,13 @@
+test:
+	@ rspec
+
+build: clear
+	@ bundle
+	@ gem build *.gemspec
+
+release: test build
+	@ gem push *.gem
+
+clear:
+	@ rm -rf pkg
+	@ rm -rf *.gem

data/README.md

@@ -0,0 +1,54 @@
+# Sidekiq::Recursive
+Use simple recursion to limit sidekiq workers per job
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sidekiq-recursive'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sidekiq-recursive
+
+## Usage
+
+```ruby
+class CleanUpOldUsers
+  include Sidekiq::Worker
+  include Sidekiq::Recursive::Worker
+
+  recursive_worker_count 5
+
+  def process(user_id)
+    User.destroy(user_id)
+  end
+end
+
+user_ids = User.where(is_old: true).ids
+CleanUpOldUsers.run(user_ids)
+```
+
+## 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/justaskz/sidekiq-recursive. 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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Sidekiq::Recursive project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/justaskz/sidekiq-recursive/blob/master/CODE_OF_CONDUCT.md).

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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sidekiq/recursive"
+
+# 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(__FILE__)

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/lib/sidekiq/recursive/argument_queue.rb

@@ -0,0 +1,25 @@
+class Sidekiq::Recursive::ArgumentQueue
+  class << self
+    def push(worker, arguments)
+      arguments_queue_name = generate_arguments_queue_name(worker)
+      redis_client.rpush(arguments_queue_name, arguments)
+
+      true
+    end
+
+    def pop(worker)
+      arguments_queue_name = generate_arguments_queue_name(worker)
+      redis_client.lpop(arguments_queue_name)
+    end
+
+    private
+
+    def generate_arguments_queue_name(worker)
+      worker.to_s
+    end
+
+    def redis_client
+      Sidekiq.redis { |conn| conn }
+    end
+  end
+end

data/lib/sidekiq/recursive/perform.rb

@@ -0,0 +1,18 @@
+class Sidekiq::Recursive::Perform
+  def self.run(worker_instance, worker_id, argument)
+    worker = worker_instance.class
+    return worker_instance.process(argument) if worker_id == :failed_worker
+    safe_process(worker_instance, argument)
+    next_argument = Sidekiq::Recursive::ArgumentQueue.pop(worker)
+    return unless next_argument
+    worker.perform_async(worker_id, next_argument)
+
+    true
+  end
+
+  def self.safe_process(worker_instance, argument)
+    worker_instance.process(argument)
+  rescue
+    worker_instance.class.perform_async(:failed_worker, argument)
+  end
+end

data/lib/sidekiq/recursive/start.rb

@@ -0,0 +1,12 @@
+class Sidekiq::Recursive::Start
+  def self.run(worker, arguments)
+    Sidekiq::Recursive::ArgumentQueue.push(worker, arguments)
+
+    1.upto(worker.recursive_worker_count) do |worker_id|
+      argument = Sidekiq::Recursive::ArgumentQueue.pop(worker)
+      worker.perform_async(worker_id, argument)
+    end
+
+    true
+  end
+end

data/lib/sidekiq/recursive/version.rb

@@ -0,0 +1,5 @@
+module Sidekiq
+  module Recursive
+    VERSION = "0.1.0"
+  end
+end

data/lib/sidekiq/recursive/worker.rb

@@ -0,0 +1,25 @@
+module Sidekiq::Recursive::Worker
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.include(InstanceMethods)
+  end
+
+  module ClassMethods
+    def run(arguments)
+      Sidekiq::Recursive::Start.run(self, arguments)
+      true
+    end
+
+    def recursive_worker_count(count = nil)
+      raise Sidekiq::Recursive::UndefinedWorkerCountError if count.nil? && @worker_count.nil?
+      @worker_count ||= count
+    end
+  end
+
+  module InstanceMethods
+    def perform(worker_id, argument)
+      Sidekiq::Recursive::Perform.run(self, worker_id, argument)
+      true
+    end
+  end
+end

data/lib/sidekiq/recursive.rb

@@ -0,0 +1,11 @@
+require 'sidekiq/recursive/argument_queue'
+require 'sidekiq/recursive/perform'
+require 'sidekiq/recursive/start'
+require 'sidekiq/recursive/version'
+require 'sidekiq/recursive/worker'
+
+module Sidekiq
+  module Recursive
+    class UndefinedWorkerCountError < StandardError; end
+  end
+end

data/sidekiq-recursive.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sidekiq/recursive/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sidekiq-recursive'
+  spec.version       = Sidekiq::Recursive::VERSION
+  spec.authors       = 'Justas Kazakauskas'
+  spec.email         = 'leakymirror@gmail.com'
+
+  spec.summary       = 'Use simple recursion to limit sidekiq workers per job'
+  spec.description   = 'Use simple recursion to limit sidekiq workers per job.'
+  spec.homepage      = 'https://github.com/justaskz/sidekiq-recursive'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 2.0'
+
+  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_runtime_dependency 'sidekiq', '>= 3.0', '~> 5.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'fakeredis', '~> 0.7.0'
+  spec.add_development_dependency 'pry', '~> 0.11.3'
+  spec.add_development_dependency 'rake', '~> 12.3'
+  spec.add_development_dependency 'rspec', '~> 3.7'
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: sidekiq-recursive
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Justas Kazakauskas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.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: fakeredis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: Use simple recursion to limit sidekiq workers per job.
+email: leakymirror@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sidekiq/recursive.rb
+- lib/sidekiq/recursive/argument_queue.rb
+- lib/sidekiq/recursive/perform.rb
+- lib/sidekiq/recursive/start.rb
+- lib/sidekiq/recursive/version.rb
+- lib/sidekiq/recursive/worker.rb
+- sidekiq-recursive.gemspec
+homepage: https://github.com/justaskz/sidekiq-recursive
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Use simple recursion to limit sidekiq workers per job
+test_files: []