sidekiq-deferred_jobs 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 74140b3a7726b81f99deb8eee4f6b12cbe306a89fc47ee7c1f9c1498b6b39588
-  data.tar.gz: aefb420df0176f907074fdbce0a1a6c40f85209b5143ae41342f2cc78ddcf66a
+  metadata.gz: e4232cb827ec1a6bd2f218f34ac5b7f3a0b175a0a4dd34841633605d669bfb16
+  data.tar.gz: 3db11095242ca521612cae0b91e1b20abf5fb0676b5fa8f75d0220ab9fa8e8c6
 SHA512:
-  metadata.gz: fd4ef0a5ead779291359d18c8388ddc5fa1ee8a5615bf4e1d11add7f0ed605919979380cba966ed8c8422e35d03e4d5910470c405145f31c1f5d299a7e07747e
-  data.tar.gz: f1ea50c549baea07d8b8388455c948d052060ee7e68effe12e85e261aa1b6c330702819b84c42ecfa4d11b95a4c7af74bf031d154a372f097461342b6c3f002a
+  metadata.gz: 2d8f9ebdad90e5641e6d96c8356ce83e9aad680203f51eb3f0ca933a5d2384f5a52c29d55af0b1fb51ee5e67de9e9a51e085408ce2e56be90b834d95ffdf7279
+  data.tar.gz: 6ee5fc3e3a76a7cd4e7fd96d642fab6664a831d5801240fb0614fe03738f43c0ab6108628478191a9f9a3cd231b7d6dffeb4e9c2d25ba76cd917c19b14223090

data/CHANGELOG.md

@@ -4,7 +4,14 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.0.1
+
+### Changed
+
+- Update code to override Sidekiq::Job if it is defined, otherwise override Sidekiq::Worker. This doesn't impact functionality, but is more compatible with modern Sidekiq versions since Sidekiq::Worker is discouraged since version 6.3.
+
 ## 1.0.0
 
 ### Added
+
 - Add behavior to Sidekiq to allow deferring enqueing jobs until after a block of code finishes.

data/README.md

@@ -1,9 +1,8 @@
+# Sidekiq Deferred Jobs
+
 [![Continuous Integration](https://github.com/bdurand/sidekiq-deferred_jobs/actions/workflows/continuous_integration.yml/badge.svg)](https://github.com/bdurand/sidekiq-deferred_jobs/actions/workflows/continuous_integration.yml)
-[![Maintainability](https://api.codeclimate.com/v1/badges/3f5fb49ca1d03f698d5b/maintainability)](https://codeclimate.com/github/bdurand/sidekiq-deferred_jobs/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/3f5fb49ca1d03f698d5b/test_coverage)](https://codeclimate.com/github/bdurand/sidekiq-deferred_jobs/test_coverage)
 [![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
-
-# Sidekiq Deferred Jobs
+[![Gem Version](https://badge.fury.io/rb/sidekiq-deferred_jobs.svg)](https://badge.fury.io/rb/sidekiq-deferred_jobs)
 
 This gem provides an enhancement to [Sidekiq](https://github.com/mperham/sidekiq) to defer enqueuing jobs until the end of a block of code. This is useful in situations where you need to better coordinate when jobs are enqueued to guard against race conditions or deduplicate jobs. In most cases, this provides no functional difference to your code; it just delays slightly when jobs are enqueued.
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/lib/sidekiq/deferred_jobs.rb

@@ -8,6 +8,7 @@ module Sidekiq
       # Defer enqueuing Sidekiq workers within the block until the end of the block.
       # Any workers that normally would have been enqueued with a `perform_async` call
       # will instead be queued up and run in an ensure clause at the end of the block.
+      #
       # @param filter [Array<Module>, Array<Hash>] An array of either classes, modules, or hashes.
       #        If this is provided, only workers that match either a class or module or which have
       #        sidekiq_options that match a hash will be deferred. All other worker will be enqueued as normal.
@@ -33,6 +34,7 @@ module Sidekiq
 
       # Disable deferred workers within the block. All workers will be enqueued normally
       # within the block.
+      #
       # @return [void]
       def undeferred(&block)
         save_val = Thread.current[:sidekiq_deferred_jobs_jobs]
@@ -45,6 +47,7 @@ module Sidekiq
       end
 
       # Return true if the specified class with optional options should be deferred.
+      #
       # @param klass [Class] A Sidekiq worker class
       # @param opts [Hash, Nil] Optionsl options set at runtime for the worker.
       # @return Boolean
@@ -55,6 +58,7 @@ module Sidekiq
       end
 
       # Schedule a worker to be run at the end of the outermost defer block.
+      #
       # @param klass [Class] Sidekiq worker class
       # @param args [Array] Sidekiq job arguments
       # @param opts [Hash, Nil] Optional sidekiq options specified for the job
@@ -73,7 +77,8 @@ module Sidekiq
       # Defer enqueuing Sidekiq workers within the block until the end of the block.
       # Any workers that normally would have been enqueued with a `perform_async` call
       # will instead be queued up and run in an ensure clause at the end of the block.
-      # @param *filter [Module>, Hash, FalseClass] Optional filter on which workers should be deferred.
+      #
+      # @param filter [Array<Module>, Hash, false] Optional filter on which workers should be deferred.
       #                If a filter is specified, only matching workers will be deferred. To match the
       #                filter, the worker must either be the class specfied or include the module or
       #                have sidekiq_options that match the specified hash. If the filter is `false`
@@ -89,7 +94,8 @@ module Sidekiq
 
       # Abort any already deferred Sidkiq workers in the current `defer_job` block.
       # If a filter is specified, then only matching Sidekiq jobs will be aborted.
-      # @param *filter See #defer_job for filter specification.
+      #
+      # @param filter [Array<Module>, Hash, false] See #defer_job for filter specification.
       # @return [Array<Sidekiq::DeferredJobs::Job>] the jobs that were aborted
       def abort_deferred_jobs!(*filter)
         jobs, _filters = Thread.current[:sidekiq_deferred_jobs_jobs]
@@ -102,7 +108,8 @@ module Sidekiq
 
       # Immediately enqueue any already deferred Sidkiq workers in the current `defer_job` block.
       # If a filter is specified, then only matching Sidekiq jobs will be enqueued.
-      # @param *filter See #defer_job for filter specification.
+      #
+      # @param filter [Array<Module>, Hash, false] See #defer_job for filter specification.
       # @return [void]
       def enqueue_deferred_jobs!(*filter)
         jobs, _filters = Thread.current[:sidekiq_deferred_jobs_jobs]
@@ -167,15 +174,19 @@ module Sidekiq
       end
 
       # Add a job to the deferred job list.
+      #
       # @param klass [Class] Sidekiq worker class.
       # @param args [Array] Sidekiq job arguments
       # @param opts [Hash, Nil] optional runtime jobs options
+      # @return [void]
       def defer(klass, args, opts = nil)
         @jobs << Job.new(klass, args&.dup, opts&.dup)
       end
 
       # Clear any deferred jobs that match the filter.
-      # @filter [Array<Module>, Array<Hash>] Filter for jobs to clear
+      #
+      # @param filters [Array<Module>, Array<Hash>] Filter for jobs to clear
+      # @return [Array<Sidekiq::DeferredJobs::Job>] the jobs that were cleared
       def clear!(filters = nil)
         filter = Filter.new(filters)
         cleared_jobs = @jobs.select { |job| filter.match?(job.klass, job.opts) }
@@ -184,7 +195,9 @@ module Sidekiq
       end
 
       # Enqueue any deferred jobs that match the filter.
-      # @filter [Array<Module>, Array<Hash>] Filter for jobs to clear
+      #
+      # @param filters [Array<Module>, Array<Hash>] Filter for jobs to clear
+      # @return [void]
       def enqueue!(filters = nil)
         filter = Filter.new(filters)
         remaining_jobs = []
@@ -238,6 +251,4 @@ module Sidekiq
   end
 end
 
-Sidekiq.extend(Sidekiq::DeferredJobs::DeferBlock)
-Sidekiq::Worker::ClassMethods.prepend(Sidekiq::DeferredJobs::DeferredWorker)
-Sidekiq::Worker::Setter.prepend(Sidekiq::DeferredJobs::DeferredSetter)
+require_relative "deferred_jobs_ext"

data/lib/sidekiq/deferred_jobs_ext.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# This file patches Sidekiq classes to add deferred job functionality.
+# It's separate from the main file to avoid YARD documentation warnings
+# for external gem classes.
+
+Sidekiq.extend(Sidekiq::DeferredJobs::DeferBlock)
+
+if defined?(Sidekiq::Job)
+  Sidekiq::Job::ClassMethods.prepend(Sidekiq::DeferredJobs::DeferredWorker)
+  Sidekiq::Job::Setter.prepend(Sidekiq::DeferredJobs::DeferredSetter)
+else
+  Sidekiq::Worker::ClassMethods.prepend(Sidekiq::DeferredJobs::DeferredWorker)
+  Sidekiq::Worker::Setter.prepend(Sidekiq::DeferredJobs::DeferredSetter)
+end

data/sidekiq-deferred_jobs.gemspec

@@ -5,9 +5,16 @@ Gem::Specification.new do |spec|
   spec.email = ["bbdurand@gmail.com"]
 
   spec.summary = "Adds ability to defer the enqueuing of Sidekiq workers until the end of a block of code."
+
   spec.homepage = "https://github.com/bdurand/sidekiq-deferred_jobs"
   spec.license = "MIT"
 
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => "#{spec.homepage}/blob/main/CHANGELOG.md"
+  }
+
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   ignore_files = %w[

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-deferred_jobs
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Brian Durand
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -38,7 +37,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
 email:
 - bbdurand@gmail.com
 executables: []
@@ -46,17 +44,20 @@ extensions: []
 extra_rdoc_files: []
 files:
 - CHANGELOG.md
-- MIT-LICENSE
+- MIT-LICENSE.txt
 - README.md
 - VERSION
 - lib/sidekiq-deferred_jobs.rb
 - lib/sidekiq/deferred_jobs.rb
+- lib/sidekiq/deferred_jobs_ext.rb
 - sidekiq-deferred_jobs.gemspec
 homepage: https://github.com/bdurand/sidekiq-deferred_jobs
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  homepage_uri: https://github.com/bdurand/sidekiq-deferred_jobs
+  source_code_uri: https://github.com/bdurand/sidekiq-deferred_jobs
+  changelog_uri: https://github.com/bdurand/sidekiq-deferred_jobs/blob/main/CHANGELOG.md
 rdoc_options: []
 require_paths:
 - lib
@@ -71,8 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Adds ability to defer the enqueuing of Sidekiq workers until the end of a
   block of code.