sidekiq-unique-jobs 6.0.0.rc6 → 6.0.0.rc7

data/examples/just_a_worker.rb

@@ -5,7 +5,7 @@
 class JustAWorker
   include Sidekiq::Worker
 
-  sidekiq_options unique: :until_executed, queue: :testqueue
+  sidekiq_options lock: :until_executed, queue: :testqueue
 
   def perform(options = {})
     options

data/examples/long_running_job.rb

@@ -4,8 +4,10 @@
 
 class LongRunningJob
   include Sidekiq::Worker
-  sidekiq_options queue: :customqueue, retry: true, unique: :until_and_while_executing,
-                  lock_expiration: 7_200, retry_count: 10
+  sidekiq_options lock: :until_and_while_executing,
+                  lock_expiration: 7_200,
+                  queue: :customqueue,
+                  retry: 10
   def perform(one, two)
     [one, two]
   end

data/examples/main_job.rb

@@ -4,8 +4,9 @@
 
 class MainJob
   include Sidekiq::Worker
-  sidekiq_options queue: :customqueue, unique: :until_executed,
-                  log_duplicate_payload: true
+  sidekiq_options lock: :until_executed,
+                  log_duplicate_payload: true,
+                  queue: :customqueue
 
   def perform(arg)
     [arg]

data/examples/my_unique_job.rb

@@ -4,11 +4,10 @@
 
 class MyUniqueJob
   include Sidekiq::Worker
-  sidekiq_options queue: :customqueue,
-                  retry: true,
-                  retry_count: 10,
-                  unique: :until_executed,
-                  lock_expiration: 7_200
+  sidekiq_options lock: :until_executed,
+                  lock_expiration: 7_200,
+                  queue: :customqueue,
+                  retry: 10
 
   def perform(one, two)
     [one, two]

data/examples/my_unique_job_with_filter_method.rb

@@ -4,10 +4,10 @@
 
 class MyUniqueJobWithFilterMethod
   include Sidekiq::Worker
-  sidekiq_options queue: :customqueue,
+  sidekiq_options backtrace: true,
+                  lock: :until_executed,
+                  queue: :customqueue,
                   retry: true,
-                  backtrace: true,
-                  unique: :until_executed,
                   unique_args: :filtered_args
 
   def perform(*)

data/examples/my_unique_job_with_filter_proc.rb

@@ -4,10 +4,10 @@
 
 class MyUniqueJobWithFilterProc
   include Sidekiq::Worker
-  sidekiq_options queue: :customqueue,
+  sidekiq_options backtrace: true,
+                  lock: :until_executed,
+                  queue: :customqueue,
                   retry: true,
-                  backtrace: true,
-                  unique: :until_executed,
                   unique_args: (lambda do |args|
                     options = args.extract_options!
                     [args.first, options['type']]

data/examples/notify_worker.rb

@@ -5,8 +5,8 @@
 class NotifyWorker
   include Sidekiq::Worker
 
-  sidekiq_options queue: :notify_worker,
-                  unique: :until_executed
+  sidekiq_options lock: :until_executed,
+                  queue: :notify_worker
 
   def perform(pid, blob)
     [pid, blob]

data/examples/simple_worker.rb

@@ -4,8 +4,8 @@
 
 class SimpleWorker
   include Sidekiq::Worker
-  sidekiq_options queue: :default,
-                  unique: :until_executed,
+  sidekiq_options lock: :until_executed,
+                  queue: :default,
                   unique_args: ->(args) { [args.first] }
 
   def perform(args)

data/examples/unique_across_workers_job.rb

@@ -12,7 +12,7 @@
 #   - https://github.com/mhenrixon/sidekiq-unique-jobs/blob/master/spec/lib/sidekiq_unique_jobs/unique_args_spec.rb
 class UniqueAcrossWorkersJob
   include Sidekiq::Worker
-  sidekiq_options unique: :until_executed, unique_across_workers: true
+  sidekiq_options lock: :until_executed, unique_across_workers: true
 
   def perform(one, two)
     [one, two]

data/examples/unique_job_on_conflict_raise.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# :nocov:
+
+class UniqueJobOnConflictRaise
+  include Sidekiq::Worker
+  sidekiq_options lock: :while_executing,
+                  queue: :customqueue,
+                  on_conflict: :raise
+
+  def perform(one, two)
+    [one, two]
+  end
+end

data/examples/unique_job_on_conflict_reject.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# :nocov:
+
+class UniqueJobOnConflictReject
+  include Sidekiq::Worker
+  sidekiq_options lock: :while_executing,
+                  queue: :customqueue,
+                  on_conflict: :reject
+
+  def perform(one, two)
+    [one, two]
+  end
+end

data/examples/unique_job_on_conflict_reschedule.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# :nocov:
+
+class UniqueJobOnConflictReschedule
+  include Sidekiq::Worker
+  sidekiq_options lock: :while_executing,
+                  queue: :customqueue,
+                  on_conflict: :reschedule
+
+  def perform(one, two)
+    [one, two]
+  end
+end

data/examples/unique_job_with_conditional_parameter.rb

@@ -4,10 +4,10 @@
 
 class UniqueJobWithoutUniqueArgsParameter
   include Sidekiq::Worker
-  sidekiq_options queue: :customqueue,
+  sidekiq_options backtrace: true,
+                  lock: :until_executed,
+                  queue: :customqueue,
                   retry: true,
-                  backtrace: true,
-                  unique: :until_executed,
                   unique_args: :unique_args
 
   def perform(conditional = nil)

data/examples/unique_job_with_filter_method.rb

@@ -4,8 +4,11 @@
 
 class UniqueJobWithFilterMethod
   include Sidekiq::Worker
-  sidekiq_options queue: :customqueue, retry: 1, backtrace: 10,
-                  unique: :while_executing, unique_args: :filtered_args
+  sidekiq_options backtrace: 10,
+                  lock: :while_executing,
+                  queue: :customqueue,
+                  retry: 1,
+                  unique_args: :filtered_args
 
   def perform(*)
     # NO-OP

data/examples/unique_job_with_nil_unique_args.rb

@@ -4,10 +4,10 @@
 
 class UniqueJobWithNilUniqueArgs
   include Sidekiq::Worker
-  sidekiq_options queue: :customqueue,
+  sidekiq_options backtrace: true,
+                  lock: :until_executed,
+                  queue: :customqueue,
                   retry: true,
-                  backtrace: true,
-                  unique: :until_executed,
                   unique_args: :unique_args
 
   def perform(args)

data/examples/unique_job_with_no_unique_args_method.rb

@@ -4,10 +4,10 @@
 
 class UniqueJobWithNoUniqueArgsMethod
   include Sidekiq::Worker
-  sidekiq_options queue: :customqueue,
+  sidekiq_options backtrace: true,
+                  lock: :until_executed,
+                  queue: :customqueue,
                   retry: true,
-                  backtrace: true,
-                  unique: :until_executed,
                   unique_args: :filtered_args
 
   def perform(one, two)

data/examples/unique_job_withthout_unique_args_parameter.rb

@@ -4,10 +4,10 @@
 
 class UniqueJobWithoutUniqueArgsParameter
   include Sidekiq::Worker
-  sidekiq_options queue: :customqueue,
+  sidekiq_options backtrace: true,
+                  lock: :until_executed,
+                  queue: :customqueue,
                   retry: true,
-                  backtrace: true,
-                  unique: :until_executed,
                   unique_args: :unique_args
 
   def perform(optional = true)

data/examples/unique_on_all_queues_job.rb

@@ -8,7 +8,7 @@
 # queue removed it won't work.
 class UniqueOnAllQueuesJob
   include Sidekiq::Worker
-  sidekiq_options unique: :until_executed, unique_on_all_queues: true
+  sidekiq_options lock: :until_executed, unique_on_all_queues: true
 
   def perform(one, two, three = nil)
     [one, two, three]

data/examples/until_and_while_executing_job.rb

@@ -5,7 +5,10 @@
 class UntilAndWhileExecutingJob
   include Sidekiq::Worker
 
-  sidekiq_options queue: :working, unique: :until_and_while_executing, lock_timeout: 0, lock_expiration: nil
+  sidekiq_options lock: :until_and_while_executing,
+                  lock_expiration: nil,
+                  lock_timeout: 0,
+                  queue: :working
 
   def perform(sleepy_time)
     sleep(sleepy_time)

data/examples/until_executed_2_job.rb

@@ -8,11 +8,11 @@
 #
 class UntilExecuted2Job
   include Sidekiq::Worker
-  sidekiq_options queue: :working,
-                  retry: 1,
-                  backtrace: 10,
-                  unique: :until_executed,
-                  lock_timeout: 0
+  sidekiq_options backtrace: 10,
+                  lock: :until_executed,
+                  lock_timeout: 0,
+                  queue: :working,
+                  retry: 1
 
   def perform(one, two)
     [one, two]

data/examples/until_executed_job.rb

@@ -8,12 +8,12 @@
 #
 class UntilExecutedJob
   include Sidekiq::Worker
-  sidekiq_options queue: :working,
-                  retry: 1,
-                  backtrace: 10,
-                  unique: :until_executed,
+  sidekiq_options backtrace: 10,
+                  lock: :until_executed,
+                  lock_expiration: 5_000,
                   lock_timeout: 0,
-                  lock_expiration: 5000
+                  queue: :working,
+                  retry: 1
 
   def perform(one, two = nil)
     [one, two]

data/examples/until_executing_job.rb

@@ -5,7 +5,7 @@
 class UntilExecutingJob
   include Sidekiq::Worker
 
-  sidekiq_options queue: :working, unique: :until_executing
+  sidekiq_options lock: :until_executing, queue: :working
 
   def perform; end
 end

data/examples/until_expired_job.rb

@@ -4,7 +4,7 @@
 
 class UntilExpiredJob
   include Sidekiq::Worker
-  sidekiq_options unique: :until_expired, lock_expiration: 1, lock_timeout: 0
+  sidekiq_options lock: :until_expired, lock_expiration: 1, lock_timeout: 0
 
   def perform(one)
     TestClass.run(one)

data/examples/until_global_expired_job.rb

@@ -4,7 +4,7 @@
 
 class UntilGlobalExpiredJob
   include Sidekiq::Worker
-  sidekiq_options unique: :until_expired
+  sidekiq_options lock: :until_expired
 
   def perform(arg)
     TestClass.run(arg)

data/examples/while_executing_job.rb

@@ -5,9 +5,9 @@
 class WhileExecutingJob
   include Sidekiq::Worker
   sidekiq_options backtrace: 10,
+                  lock: :while_executing,
                   queue: :working,
-                  retry: 1,
-                  unique: :while_executing
+                  retry: 1
 
   def perform(args)
     [args]

data/examples/while_executing_reject_job.rb

@@ -4,8 +4,8 @@
 
 class WhileExecutingRejectJob
   include Sidekiq::Worker
-  sidekiq_options queue: :rejecting,
-                  unique: :while_executing_reject
+  sidekiq_options lock: :while_executing_reject,
+                  queue: :rejecting
 
   def perform(args)
     sleep 5

data/examples/without_argument_job.rb

@@ -4,7 +4,7 @@
 
 class WithoutArgumentJob
   include Sidekiq::Worker
-  sidekiq_options unique: :until_executed,
+  sidekiq_options lock: :until_executed,
                   log_duplicate_payload: true
 
   def perform

data/lib/sidekiq_unique_jobs.rb

@@ -12,6 +12,7 @@ require 'sidekiq_unique_jobs/sidekiq_worker_methods'
 require 'sidekiq_unique_jobs/connection'
 require 'sidekiq_unique_jobs/exceptions'
 require 'sidekiq_unique_jobs/util'
+require 'sidekiq_unique_jobs/digests'
 require 'sidekiq_unique_jobs/cli'
 require 'sidekiq_unique_jobs/core_ext'
 require 'sidekiq_unique_jobs/timeout'
@@ -19,10 +20,23 @@ require 'sidekiq_unique_jobs/scripts'
 require 'sidekiq_unique_jobs/unique_args'
 require 'sidekiq_unique_jobs/unlockable'
 require 'sidekiq_unique_jobs/locksmith'
+require 'sidekiq_unique_jobs/lock/base_lock'
+require 'sidekiq_unique_jobs/lock/until_executed'
+require 'sidekiq_unique_jobs/lock/until_executing'
+require 'sidekiq_unique_jobs/lock/until_expired'
+require 'sidekiq_unique_jobs/lock/while_executing'
+require 'sidekiq_unique_jobs/lock/while_executing_reject'
+require 'sidekiq_unique_jobs/lock/until_and_while_executing'
 require 'sidekiq_unique_jobs/options_with_fallback'
 require 'sidekiq_unique_jobs/middleware'
 require 'sidekiq_unique_jobs/sidekiq_unique_ext'
+require 'sidekiq_unique_jobs/on_conflict'
 
+# Namespace for this gem
+#
+# Contains configuration and utility methods that belongs top level
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
 module SidekiqUniqueJobs
   include SidekiqUniqueJobs::Connection
 
@@ -36,6 +50,7 @@ module SidekiqUniqueJobs
     :logger,
   )
 
+  # The current configuration (See: {.configure} on how to configure)
   def config
     # Arguments here need to match the definition of the new class (see above)
     @config ||= Concurrent::MutableStruct::Config.new(
@@ -46,14 +61,20 @@ module SidekiqUniqueJobs
     )
   end
 
+  # The current logger
+  # @return [Logger] the configured logger
   def logger
     config.logger
   end
 
+  # Set a new logger
+  # @param [Logger] other a new logger
   def logger=(other)
     config.logger = other
   end
 
+  # Change global configuration while yielding
+  # @yield control to the caller
   def use_config(tmp_config)
     fail ::ArgumentError, "#{name}.#{__method__} needs a block" unless block_given?
 
@@ -63,6 +84,15 @@ module SidekiqUniqueJobs
     configure(old_config)
   end
 
+  # Configure the gem
+  #
+  # This is usually called once at startup of an application
+  # @param [Hash] options global gem options
+  # @option options [Integer] :default_lock_timeout (default is 0)
+  # @option options [true,false] :enabled (default is true)
+  # @option options [String] :unique_prefix (default is 'uniquejobs')
+  # @option options [Logger] :logger (default is Sidekiq.logger)
+  # @yield control to the caller when given block
   def configure(options = {})
     if block_given?
       yield config