sidecloq 0.4.7 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 369b9ecaad14a3f613c3c2a4afef4d3b439ceed861525ca99286668293fa61c8
-  data.tar.gz: 75f2d86e8ccaea4b089407eef5cf834f9ee7c0f31251b6a1acb72c5b43a15e78
+  metadata.gz: 9a045d77686f36ac1c35ea972467fddd1255e1c62ac7e48ec2a43dc1224411dc
+  data.tar.gz: a8b247df8cb7a55bcb1beedd90ef444b03fe9953b77f930c790a19315d63299b
 SHA512:
-  metadata.gz: 3b60ac764c22dbff7d9519a0f9ce8b8484da0b775e3b875506332d71d17bf377ab6655c92f966a3140a258fb684a440638d8941e0eba0a72e3b58d4dbbd75c2f
-  data.tar.gz: f5877e191dd1cbca6650e3f293c3a601aee96029a8034ecc6490bfd9badc3492d340b75aa2d508b6270decf8da75f46a3dce28d739ca75fe759d14a01e74bbc0
+  metadata.gz: e72331acbc6f275a9223bc8618f4accc78be11f0f82f98864a45de87ee294e3961dcba3eb11944920ff0f4a5467dc7727198389a57098c1d896bc36bb0838b21
+  data.tar.gz: 8997cef497985bec676d32aec8cac53e104ca24ab1543bc7ef366aba28d7cf2f2a9f1f24ec48565f04316d515f8ab8bf040b6b86894288a83667f172f2bac9a4

data/.github/workflows/ci.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version:
+        - "2.7"
+        - "3.0"
+        - "3.1"
+        - "3.2"
+        - jruby-9.4
+        sidekiq-version:
+        - "6.4"
+        - "6.5"
+        - "7.0"
+        - "7.1"
+        - main
+    services:
+      redis:
+        image: redis
+        options: --health-cmd "redis-cli ping" --health-interval 10s --health-timeout 5s --health-retries 5
+        ports:
+        - 6379:6379
+    env:
+      sidekiq: ${{ matrix.sidekiq-version }}
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Run tests
+      run: bundle exec rake
+      timeout-minutes: 5

data/.gitignore

@@ -9,3 +9,5 @@
 /tmp/
 /.ruby-version
 /.ruby-gemset
+gemfiles/*.lock
+.bundle/

data/Appraisals

@@ -0,0 +1,15 @@
+appraise "sidekiq-6.4" do
+  gem "sidekiq", "~> 6.4.0"
+end
+
+appraise "sidekiq-6.5" do
+  gem "sidekiq", "~> 6.5.0"
+end
+
+appraise "sidekiq-7.0" do
+  gem "sidekiq", "~> 7.0.0"
+end
+
+appraise "sidekiq-7.1" do
+  gem "sidekiq", "~> 7.1.0"
+end

data/Gemfile

@@ -7,23 +7,14 @@ platforms :mri, :rbx do
   gem 'minitest-utils'
 end
 
-# https://github.com/sinatra/sinatra/blob/master/Gemfile
 sidekiq_dep =
-  case ENV['sidekiq']
-  when /(\d+\.)+\d+/ then "~> " + ENV['sidekiq'].sub("sidekiq-", '')
+  case ENV['sidekiq'].to_s.sub('sidekiq-', '')
+  when /(?:\d+\.)+\d+/ then "~> #{$&}#{'.0' if Gem::Version.new($&).segments.size == 2}"
   else {github: 'mperham/sidekiq', branch: ENV['sidekiq']}
   end
 
 gem 'sidekiq', sidekiq_dep
 
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.2.2")
-  # rack >= 2.0 requires ruby >= 2.2.2
-  gem 'rack', '< 2.0'
-  # activejob >= 5 requires ruby >= 2.2.2
-  gem 'activejob', '< 5'
-end
-
 group :test do
   gem "simplecov"
-  gem "codeclimate-test-reporter", "~> 1.0.0"
 end

data/README.md

@@ -2,11 +2,9 @@
 
 # Sidecloq
 
-[![Build Status](https://travis-ci.org/mattyr/sidecloq.svg)](https://travis-ci.org/mattyr/sidecloq)
+[![CI](https://github.com/mattyr/sidecloq/actions/workflows/ci.yml/badge.svg)](https://github.com/mattyr/sidecloq/actions/workflows/ci.yml)
 [![Gem Version](https://badge.fury.io/rb/sidecloq.svg)](https://badge.fury.io/rb/sidecloq)
-[![Code Climate](https://codeclimate.com/github/mattyr/sidecloq/badges/gpa.svg)](https://codeclimate.com/github/mattyr/sidecloq)
 [![Test Coverage](https://codeclimate.com/github/mattyr/sidecloq/badges/coverage.svg)](https://codeclimate.com/github/mattyr/sidecloq/coverage)
-[![Dependency Status](https://gemnasium.com/mattyr/sidecloq.svg)](https://gemnasium.com/mattyr/sidecloq)
 
 Recurring / Periodic / Scheduled / Cron job extension for
 [Sidekiq](https://github.com/mperham/sidekiq)
@@ -25,8 +23,6 @@ you.
 
 Sidecloq is:
 
-- **Lightweight:** Celluloid is not required.  This coincides well with
-  Sidekiq 4/5, which no longer use Celluloid.
 - **Clean:** Sidecloq leverages only the public API of Sidekiq, and does
   not pollute the Sidekiq namespace.
 - **Easy to deploy:** Sidecloq boots with all Sidekiq processes,
@@ -44,9 +40,7 @@ Add this line to your application's Gemfile:
 gem 'sidecloq'
 ```
 
-Tested on MRI > 2 and JRuby 9k.  Basically, if you can run
-Sidekiq, you can run Sidecloq.  Note that Sidekiq >= 5 does not support
-MRI ruby < 2.2.2.
+Requires sidekiq version >= 6.4.  MRI < 2.7 and jruby < 9.4 are not supported.
 
 ## Configuration
 
@@ -127,18 +121,6 @@ it's corresponding "Enqueue now" button.
 
 ![Sidecloq web ui extension screenshot](assets/screenshot.png)
 
-## Notes
-
-If you are running MRI < 2.2.2, you will need to make sure you are using
-rack < 2.0.  You can do this by adding:
-
-```ruby
-gem 'rack', '< 2.0'
-```
-
-To your app's Gemfile.  (This will also keep you from using the 5.x
-series of Sidekiq, as it requires MRI > 2.2.2).
-
 ## Contributing
 
 Bug reports and pull requests are welcome.

data/Rakefile

@@ -17,8 +17,7 @@ task :web do
   Sidekiq.configure_client do |config|
     config.redis = {
       url: 'redis://localhost:6379/0',
-      size: 1,
-      namespace: 'sidecloq'
+      size: 1
     }
   end
 
@@ -36,12 +35,20 @@ task :web do
   end
 
   class DoWork
+    include Sidekiq::Worker
   end
 
+  require 'rack/server'
+  require 'rack/session/cookie'
   require 'sidekiq/web'
   require 'sidecloq/web'
 
   Rack::Server.start(
-    app: Sidekiq::Web
+    app: Rack::Session::Cookie.new(
+      Sidekiq::Web,
+      secret: SecureRandom.hex(32),
+      same_site: true,
+      max_age: 86400
+    )
   )
 end

data/gemfiles/sidekiq_6.4.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 6.4.0"
+
+group :test do
+  gem "simplecov"
+end
+
+platforms :mri, :rbx do
+  gem "pry"
+  gem "minitest-utils"
+end
+
+gemspec path: "../"

data/gemfiles/sidekiq_6.5.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 6.5.0"
+
+group :test do
+  gem "simplecov"
+end
+
+platforms :mri, :rbx do
+  gem "pry"
+  gem "minitest-utils"
+end
+
+gemspec path: "../"

data/gemfiles/sidekiq_7.0.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 7.0.0"
+
+group :test do
+  gem "simplecov"
+end
+
+platforms :mri, :rbx do
+  gem "pry"
+  gem "minitest-utils"
+end
+
+gemspec path: "../"

data/gemfiles/sidekiq_7.1.gemfile

@@ -0,0 +1,16 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "sidekiq", "~> 7.1.0"
+
+group :test do
+  gem "simplecov"
+end
+
+platforms :mri, :rbx do
+  gem "pry"
+  gem "minitest-utils"
+end
+
+gemspec path: "../"

data/lib/sidecloq/locker.rb

@@ -1,3 +1,5 @@
+require 'redis-client'
+
 module Sidecloq
   # Locker obtains or waits for an exclusive lock on a key in redis
   class Locker
@@ -8,6 +10,11 @@ module Sidecloq
     def initialize(options = {})
       # we keep a connection from the pool by default
       @redis = options[:redis] || Sidekiq.redis_pool.checkout
+      # for compatibility with sidekiq < 7, we need to convert the Redis
+      # instance to a RedisClient instance, which redlock requires
+      if defined?(Redis) && @redis.instance_of?(Redis)
+        @redis = RedisClient.new(@redis.connection.except(:location))
+      end
       @key = options[:lock_key] || DEFAULT_LOCK_KEY
       @ttl = options[:ttl] || 60
       @check_interval = options[:check_interval] || 15

data/lib/sidecloq/schedule.rb

@@ -34,7 +34,7 @@ module Sidecloq
     def self.from_hash(hash)
       hash = hash[env] if hash.key?(env)
 
-      specs = hash.each_with_object({}) do |(name, spec), memo|
+      specs = (hash || []).each_with_object({}) do |(name, spec), memo|
         memo[name] = spec.dup.tap do |s|
           s['class'] = name unless spec.key?('class') || spec.key?(:class)
           s['args'] = s['args'] || s[:args] || []
@@ -78,7 +78,7 @@ module Sidecloq
     end
 
     def self.rails_env
-      Rails.env if defined?(Rails)
+      Rails.env if defined?(Rails::Engine)
     end
 
     def self.rack_env

data/lib/sidecloq/utils.rb

@@ -8,15 +8,34 @@ module Sidecloq
         @context = ctx
       end
 
+      def sidekiq_logging_context_method
+        @sidekiq_logging_context_method ||=
+          begin
+            if defined? Sidekiq::Logging
+              # sidekiq < 6
+              Sidekiq::Logging.method(:with_context)
+            elsif defined?(Sidekiq::Context)
+              # sidekiq 6, <= 6.0.1
+              Sidekiq::Context.method(:with)
+            else
+              # sidekiq 6, master
+              Sidekiq.logger.method(:with_context)
+            end
+          end
+      end
+
       def method_missing(meth, *args)
-        Sidekiq::Logging.with_context(@context) do
+        sidekiq_logging_context_method.call(@context) do
           Sidekiq.logger.send(meth, *args)
         end
       end
     end
 
+
     def logger
-      @logger ||= ContextLogger.new('Sidecloq')
+      @logger ||= ContextLogger.new(
+        defined?(Sidekiq::Logging) ? 'Sidecloq' : {sidecloq: true}
+      )
     end
 
     def redis(&block)

data/lib/sidecloq/version.rb

@@ -1,3 +1,3 @@
 module Sidecloq
-  VERSION = '0.4.7'
+  VERSION = '0.5.0'
 end

data/lib/sidecloq/web.rb

@@ -2,6 +2,7 @@ module Sidecloq
   # Plugin for sidekiq-web
   module Web
     VIEW_PATH = File.expand_path('../../../web/views', __FILE__)
+    LOCALES = File.expand_path('../../../web/locales', __FILE__)
 
     def self.registered(app)
       app.get '/recurring' do
@@ -24,5 +25,7 @@ module Sidecloq
   end
 end
 
+Sidekiq::Web.locales << Sidecloq::Web::LOCALES
+
 Sidekiq::Web.register(Sidecloq::Web)
 Sidekiq::Web.tabs['Recurring'] = 'recurring'

data/lib/sidecloq.rb

@@ -66,7 +66,7 @@ module Sidecloq
 
     if File.exist?(options[:schedule_file])
       return Schedule.from_yaml(options[:schedule_file])
-    elsif defined?(Rails)
+    elsif defined?(Rails::Engine)
       # try rails-root-relative
       full_path = File.join(Rails.root, options[:schedule_file])
       if File.exist?(full_path)

data/sidecloq.gemspec

@@ -19,14 +19,18 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'sidekiq', '>= 3.5.4', '< 6'
-  spec.add_dependency 'redlock', '>= 0.2.0', '< 2'
+  spec.add_dependency 'sidekiq', '>= 6.0.0', '< 8'
+  spec.add_dependency 'redlock', '>= 2.0.0', '< 3'
+  # redlock needs redis-client
+  spec.add_dependency 'redis-client', '>= 0.14.0'
   # mimics some dev dependencies of sidekiq:
   spec.add_dependency 'concurrent-ruby'
-  spec.add_dependency 'rufus-scheduler', '~> 3.1', '>= 3.1.10'
+  spec.add_dependency 'rufus-scheduler', '~> 3.9'
 
   spec.add_development_dependency 'rake', '>= 10.0'
   spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'redis-namespace', '~> 1.5', '>= 1.5.3'
+  spec.add_development_dependency "appraisal"
   spec.add_development_dependency 'activejob'
+  spec.add_development_dependency 'rack', '< 3'
+  spec.add_development_dependency 'webrick'
 end

data/web/locales/en.yml

@@ -0,0 +1,6 @@
+en:
+  RecurringJobs: Recurring Jobs
+  Recurring: Recurring
+  Name: Name
+  Cron: Cron
+  EnqueueNow: Enqueue Now

data/web/locales/es.yml

@@ -0,0 +1,6 @@
+es:
+  RecurringJobs: Trabajos recurrentes
+  Recurring: Recurrentes
+  Name: Nombre
+  Cron: Cron
+  EnqueueNow: Poner en la cola ahora

data/web/views/recurring.erb

@@ -1,15 +1,15 @@
-<h3>Recurring Jobs</h3>
+<h3><%= t('RecurringJobs') %></h3>
 
 <div class="table_container">
   <table class="table table-hover table-bordered table-striped table-white">
     <thead>
       <tr>
-        <th>Name</th>
-        <th>Cron</th>
-        <th>Class</th>
-        <th>Queue</th>
-        <th>Arguments</th>
-        <th>Actions</th>
+        <th><%= t('Name') %></th>
+        <th><%= t('Cron') %></th>
+        <th><%= t('Job') %></th>
+        <th><%= t('Queue') %></th>
+        <th><%= t('Arguments') %></th>
+        <th><%= t('Actions') %></th>
       </tr>
     </thead>
 
@@ -26,7 +26,7 @@
           <td>
             <form action="<%= root_path %>recurring/<%= CGI.escape(name).gsub('+', '%20') %>/enqueue" method="post">
               <%= csrf_tag if respond_to?(:csrf_tag) %>
-              <input class='btn btn-xs pull-left' type="submit" name="enque" value="<%= t('Enqueue Now') %>"/>
+              <input class='btn btn-primary btn-xs' type="submit" name="enque" value="<%= t('EnqueueNow') %>"/>
             </form>
           </td>
         </tr>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidecloq
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.5.0
 platform: ruby
 authors:
 - Matt Robinson
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-01 00:00:00.000000000 Z
+date: 2023-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -16,40 +16,54 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.4
+        version: 6.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.5.4
+        version: 6.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: redlock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 2.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 2.0.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: redis-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -70,20 +84,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.10
+        version: '3.9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.1.10
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -113,25 +121,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redis-namespace
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.3
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: activejob
   requirement: !ruby/object:Gem::Requirement
@@ -146,6 +148,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  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: Recurring / Periodic / Scheduled / Cron job extension for Sidekiq
 email:
 - robinson.matty@gmail.com
@@ -153,12 +183,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
-- ".travis.yml"
+- Appraisals
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- gemfiles/sidekiq_6.4.gemfile
+- gemfiles/sidekiq_6.5.gemfile
+- gemfiles/sidekiq_7.0.gemfile
+- gemfiles/sidekiq_7.1.gemfile
 - lib/sidecloq.rb
 - lib/sidecloq/job_enqueuer.rb
 - lib/sidecloq/locker.rb
@@ -169,12 +204,14 @@ files:
 - lib/sidecloq/version.rb
 - lib/sidecloq/web.rb
 - sidecloq.gemspec
+- web/locales/en.yml
+- web/locales/es.yml
 - web/views/recurring.erb
 homepage: http://github.com/mattyr/sidecloq
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -189,8 +226,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.4.12
+signing_key:
 specification_version: 4
 summary: Recurring / Periodic / Scheduled / Cron job extension for Sidekiq
 test_files: []

data/.travis.yml

@@ -1,42 +0,0 @@
-dist: bionic
-language: ruby
-sudo: false
-cache: bundler
-services:
-  - redis-server
-rvm:
-  - 2.0.0
-  - 2.1.10
-  - 2.2.10
-  - 2.3.8
-  - 2.4.5
-  - 2.5.3
-  - 2.6.1
-  - jruby-9.1.17.0
-  - jruby-9.2.5.0
-env:
-  - "sidekiq=3.5.4"
-  - "sidekiq=4.2.10"
-  - "sidekiq=5.1.3"
-  - "sidekiq=5.2.5"
-  - "sidekiq=master"
-matrix:
-  allow_failures:
-    - env: "sidekiq=master"
-  exclude:
-    # sidekiq 5 does not support < ruby 2.2.2
-    - rvm: 2.0.0
-      env: sidekiq=master
-    - rvm: 2.0.0
-      env: sidekiq=5.1.3
-    - rvm: 2.0.0
-      env: sidekiq=5.2.5
-    - rvm: 2.1.10
-      env: sidekiq=master
-    - rvm: 2.1.10
-      env: sidekiq=5.1.3
-    - rvm: 2.1.10
-      env: sidekiq=5.2.5
-  fast_finish: true
-after_success:
-  - bundle exec codeclimate-test-reporter