resque-unique_by_arity 1.0.9 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06ef1c526f5dea1a56e51bbf8053e41854ec9e94
-  data.tar.gz: 8bbd6cae274b5a245019e88b6297672eb66bfb92
+  metadata.gz: f633f3ff4e8bb0f3e870227767fa1354624387ae
+  data.tar.gz: 997bbaa637fd611baa63d107759df5c64c8e9dda
 SHA512:
-  metadata.gz: '08fec6b73c8f0cb6d28a82d4b0b639835088dbe180f3f28ec86201b2256687dc92839d2added60f36a64b7930c2d0bea132412e2c7787e17ab8251c37f500f5f'
-  data.tar.gz: bd024532330e4b82dac8e41f6b26c5747ec68f36a3a3a7db468c027a9e369dc003836ab150c20d18c36628dddc3b7ebc9ad33f568c508ae51378002937759df8
+  metadata.gz: 7697b2036bc838b6be804f30cf1c0d5e40b9566e9d4f21b8d6722449777bf0937724b8fcb5806b44296a3e7f36d22f08b8aa41729b2aab02beaad6b75b86d703
+  data.tar.gz: cc13bf8f10a09ca98ee1fc75d6f14a8519872d1d3df1a10fe6dacc399eabf9df20dd109f7dd84fcde7648e81f7a4c8f36a3b4eb8ba810088b0dc5362f01a6589

data/README.md

@@ -5,10 +5,15 @@ NOTE:
 Requires `resque_solo` gem, and `resque-unique_at_runtime` gem; the latter is a fork of `resque-lonely_job`.
 Why? `resque-lonely_job` and `resque_solo` can't be used together, because their `redis_key` methods conflict.
 
+Also - you must configure this gem *after* you define the perform class method in your job or the arity validation will not work properly.
+
 Example:
 
 ```ruby
 class MyJob
+  def self.perform(arg)
+    # do stuff
+  end
   include UniqueByArity::Cop.new(
     arity_for_uniqueness: 1,
     lock_after_execution_period: 60,
@@ -43,6 +48,9 @@ Some jobs have parameters that you do not want to consider for determination of
 
 ```ruby
 class MyJob
+  def self.perform(arg1, arg2, arg3)
+    # do stuff
+  end
   include UniqueByArity::Cop.new(
     arity_for_uniqueness: 3,
     unique_at_runtime: true
@@ -59,6 +67,9 @@ Want this gem to tell you when it is misconfigured?  It can.
 
 ```ruby
 class MyJob
+  def self.perform(arg1, arg2, arg3)
+    # do stuff
+  end
   include UniqueByArity::Cop.new(
     arity_for_uniqueness: 3,
     arity_validation: :warning, # or :skip, :error, or an error class to be raised, e.g. RuntimeError
@@ -81,6 +92,9 @@ Give the job a break after it finishes running, and don't allow another of the s
 
 ```ruby
 class MyJob
+  def self.perform(arg1)
+    # do stuff
+  end
   include UniqueByArity::Cop.new(
     arity_for_uniqueness: 1,
     lock_after_execution_period: 60,
@@ -95,6 +109,9 @@ If runtime lock keys get stale, they will expire on their own after some period.
 
 ```ruby
 class MyJob
+  def self.perform(arg1)
+    # do stuff
+  end
   include UniqueByArity::Cop.new(
     arity_for_uniqueness: 1,
     runtime_lock_timeout: 60 * 60 * 24 * 5, # 5 days
@@ -109,6 +126,9 @@ Prevent your app from running a job that is already running.
 
 ```ruby
 class MyJob
+  def self.perform(arg1)
+    # do stuff
+  end
   include UniqueByArity::Cop.new(
     arity_for_uniqueness: 1,
     unique_at_runtime: true
@@ -124,6 +144,9 @@ Prevent your app from queueing a job that is already queued in the same queue.
 
 ```ruby
 class MyJob
+  def self.perform(arg1)
+    # do stuff
+  end
   include UniqueByArity::Cop.new(
     arity_for_uniqueness: 1,
     unique_in_queue: true
@@ -137,6 +160,9 @@ Prevent your app from queueing a job that is already queued in *any* queue.
 
 ```ruby
 class MyJob
+  def self.perform(arg1)
+    # do stuff
+  end
   include UniqueByArity::Cop.new(
     arity_for_uniqueness: 1,
     unique_across_queues: true
@@ -153,6 +179,9 @@ prevent your app from queueing a job that is already queued in the same queue.
 
 ```ruby
 class MyJob
+  def self.perform(arg1)
+    # do stuff
+  end
   include UniqueByArity::Cop.new(
     arity_for_uniqueness: 1,
     unique_at_runtime: true,
@@ -169,6 +198,9 @@ prevent your app from queueing a job that is already queued in *any* queue.
 
 ```ruby
 class MyJob
+  def self.perform(arg1)
+    # do stuff
+  end
   include UniqueByArity::Cop.new(
     arity_for_uniqueness: 1,
     unique_at_runtime: true,
@@ -188,6 +220,9 @@ Redefine methods to customize all the things.  Warning: This might be crazy-maki
 
 ```ruby
 class MyJob
+  def self.perform(arg1)
+    # do stuff
+  end
   include UniqueByArity::Cop.new(
     #...
   )

data/lib/resque/unique_by_arity.rb

@@ -16,7 +16,7 @@ require "resque/unique_by_arity/validation"
 # class MyJob
 #   include UniqueByArity::Cop.new(
 #     arity_for_uniqueness: 1,
-#     arity_for_validation: :warning, # or nil, false, or :error
+#     arity_validation: :warning, # or nil, false, or :error
 #     unique_at_runtime: true,
 #     unique_in_queue: true
 #   )
@@ -60,10 +60,10 @@ module Resque
     def uniqueness_arity_for_uniqueness=(arity_for_uniqueness)
       @uniqueness_configuration.arity_for_uniqueness = arity_for_uniqueness
     end
-    def uniqueness_arity_for_validation
+    def uniqueness_arity_validation
       @uniqueness_configuration.arity_validation
     end
-    def uniqueness_arity_for_validation=(arity_validation)
+    def uniqueness_arity_validation=(arity_validation)
       @uniqueness_configuration.arity_validation = arity_validation
     end
     def uniqueness_lock_after_execution_period

data/lib/resque/unique_by_arity/configuration.rb

@@ -2,7 +2,8 @@ require 'logger'
 module Resque
   module UniqueByArity
     class Configuration
-      VALID_ARITY_VALIDATION_LEVELS = [ :warning, :error, nil, false ]
+      VALID_ARITY_VALIDATION_LEVELS = [ :warning, :error, :skip, nil, false ]
+      SKIPPED_ARITY_VALIDATION_LEVELS = [ :skip, nil, false ]
       attr_accessor :logger
       attr_accessor :log_level
       attr_accessor :arity_for_uniqueness
@@ -17,7 +18,7 @@ module Resque
         @log_level = options.key?(:log_level) ? options[:log_level] : :debug
         @arity_for_uniqueness = options.key?(:arity_for_uniqueness) ? options[:arity_for_uniqueness] : 1
         @arity_validation = options.key?(:arity_validation) ? options[:arity_validation] : :warning
-        raise ArgumentError, "UniqueByArity::Cop.new requires arity_validation values of nil, false, :warning, :error, or an class descending from Exception but the value is #{@arity_validation} (#{@arity_validation.class})" unless VALID_ARITY_VALIDATION_LEVELS.include?(@arity_validation) || @arity_validation.ancestors.include?(Exception)
+        raise ArgumentError, "UniqueByArity::Cop.new requires arity_validation values of #{arity_validation.inspect}, or a class inheriting from Exception, but the value is #{@arity_validation} (#{@arity_validation.class})" unless VALID_ARITY_VALIDATION_LEVELS.include?(@arity_validation) || !@arity_validation.respond_to?(:ancestors) || @arity_validation.ancestors.include?(Exception)
         @lock_after_execution_period = options.key?(:lock_after_execution_period) ? options[:lock_after_execution_period] : nil
         @runtime_lock_timeout = options.key?(:runtime_lock_timeout) ? options[:runtime_lock_timeout] : nil
         @unique_at_runtime = options.key?(:unique_at_runtime) ? options[:unique_at_runtime] : false
@@ -48,6 +49,7 @@ module Resque
             logger: logger,
             log_level: log_level,
             arity_for_uniqueness: arity_for_uniqueness,
+            arity_validation: arity_validation,
             lock_after_execution_period: lock_after_execution_period,
             runtime_lock_timeout: runtime_lock_timeout,
             unique_at_runtime: unique_at_runtime,
@@ -57,7 +59,7 @@ module Resque
       end
 
       def skip_arity_validation?
-        arity_validation == :skip
+        SKIPPED_ARITY_VALIDATION_LEVELS.include?(arity_validation)
       end
 
       def validate_arity(klass_string, perform_method)

data/lib/resque/unique_by_arity/version.rb

@@ -1,5 +1,5 @@
 module Resque
   module UniqueByArity
-    VERSION = "1.0.9"
+    VERSION = "1.0.10"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resque-unique_by_arity
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.10
 platform: ruby
 authors:
 - Peter Boling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-17 00:00:00.000000000 Z
+date: 2017-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque-unique_at_runtime