resque-unique_by_arity 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: afaba7f0ac02c1b80d222b733d7caf16ce7b2d42
-  data.tar.gz: 1d6cc14ca863aa92d5f736d4741e479a6abc3759
+  metadata.gz: 06ef1c526f5dea1a56e51bbf8053e41854ec9e94
+  data.tar.gz: 8bbd6cae274b5a245019e88b6297672eb66bfb92
 SHA512:
-  metadata.gz: 37655993edb61c5c6f26880e41519374ff4913b67ec32ac7979a108be31aec8773bb67d06b0485b55e648b442a43a993fb774a5665c284ef522f747f73492d84
-  data.tar.gz: 1b0019d9c73ae0e1e504d90871b4603474071d4c03f44d7dbcce1b7d1d5824a74d9bd68a46237e9064b009be588e99c6e08bd148857ec0b3c0c26c28c0f9ea67
+  metadata.gz: '08fec6b73c8f0cb6d28a82d4b0b639835088dbe180f3f28ec86201b2256687dc92839d2added60f36a64b7930c2d0bea132412e2c7787e17ab8251c37f500f5f'
+  data.tar.gz: bd024532330e4b82dac8e41f6b26c5747ec68f36a3a3a7db468c027a9e369dc003836ab150c20d18c36628dddc3b7ebc9ad33f568c508ae51378002937759df8

data/README.md

@@ -12,6 +12,7 @@ class MyJob
   include UniqueByArity::Cop.new(
     arity_for_uniqueness: 1,
     lock_after_execution_period: 60,
+    runtime_lock_timeout: 60 * 60 * 24 * 5, # 5 days
     unique_at_runtime: true,
     unique_in_queue: true
   )
@@ -52,6 +53,28 @@ class MyJob
 end
 ```
 
+#### Arity For Uniqueness Validation
+
+Want this gem to tell you when it is misconfigured?  It can.
+
+```ruby
+class MyJob
+  include UniqueByArity::Cop.new(
+    arity_for_uniqueness: 3,
+    arity_validation: :warning, # or :skip, :error, or an error class to be raised, e.g. RuntimeError
+    unique_at_runtime: true
+  )
+  def self.perform(my, cat, opts = {})
+    # Because the third argument is optional the arity valdiation will not approve.
+    # Arguments to be considered for uniqueness should be required arguments.
+    # The warning log might look like:
+    # 
+    #    MyJob.perform has the following required parameters: [:my, :cat], which is not enough to satisfy the configured arity_for_uniqueness of 3
+  end
+end
+```
+
+
 ### Lock After Execution
 
 Give the job a break after it finishes running, and don't allow another of the same, with matching args @ configured arity, to start within X seconds.
@@ -66,6 +89,20 @@ class MyJob
 end
 ```
 
+### Runtime Lock Timeout
+
+If runtime lock keys get stale, they will expire on their own after some period.  You can set the expiration period on a per class basis.
+
+```ruby
+class MyJob
+  include UniqueByArity::Cop.new(
+    arity_for_uniqueness: 1,
+    runtime_lock_timeout: 60 * 60 * 24 * 5, # 5 days
+    unique_at_runtime: true
+  )
+end
+```
+
 ### Unique At Runtime (across all queues)
 
 Prevent your app from running a job that is already running.
@@ -119,6 +156,7 @@ class MyJob
   include UniqueByArity::Cop.new(
     arity_for_uniqueness: 1,
     unique_at_runtime: true,
+    runtime_lock_timeout: 60 * 60 * 24 * 5, # 5 days
     unique_in_queue: true
   )
 end
@@ -134,6 +172,7 @@ class MyJob
   include UniqueByArity::Cop.new(
     arity_for_uniqueness: 1,
     unique_at_runtime: true,
+    runtime_lock_timeout: 60 * 60 * 24 * 5, # 5 days
     unique_across_queues: true
   )
 end

data/lib/resque/unique_by_arity/configuration.rb

@@ -8,6 +8,7 @@ module Resque
       attr_accessor :arity_for_uniqueness
       attr_accessor :arity_validation
       attr_accessor :lock_after_execution_period
+      attr_accessor :runtime_lock_timeout
       attr_accessor :unique_at_runtime
       attr_accessor :unique_in_queue
       attr_accessor :unique_across_queues
@@ -15,9 +16,10 @@ module Resque
         @logger = options.key?(:logger) ? options[:logger] : Logger.new(STDOUT)
         @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] : false
+        @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)
         @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
         @unique_in_queue = options.key?(:unique_in_queue) ? options[:unique_in_queue] : false
         @unique_across_queues = options.key?(:unique_across_queues) ? options[:unique_across_queues] : false
@@ -47,14 +49,19 @@ module Resque
             log_level: log_level,
             arity_for_uniqueness: arity_for_uniqueness,
             lock_after_execution_period: lock_after_execution_period,
+            runtime_lock_timeout: runtime_lock_timeout,
             unique_at_runtime: unique_at_runtime,
             unique_in_queue: unique_in_queue,
             unique_across_queues: unique_across_queues
         }
       end
 
+      def skip_arity_validation?
+        arity_validation == :skip
+      end
+
       def validate_arity(klass_string, perform_method)
-        return true unless arity_validation
+        return true if skip_arity_validation?
         # method.arity -
         #   Returns an indication of the number of arguments accepted by a method.
         #   Returns a non-negative integer for methods that take a fixed number of arguments.
@@ -63,14 +70,24 @@ module Resque
         # Example:
         #   for perform(opts = {}), method(:perform).arity # => -1
         #   which means that the only valid arity_for_uniqueness is 0
-        msg = if perform_method.arity < (arity_for_uniqueness - 1)
-                "#{klass_string}.#{perform_method.name} has arity of #{perform_method.arity} which will not work with arity_for_uniqueness of #{arity_for_uniqueness}"
-              elsif (required_parameter_names = perform_method.parameters.take_while { |a| a[0] == :req }.map { |b| b[1] }).length < arity_for_uniqueness
-                "#{klass_string}.#{perform_method.name} has the following required parameters: #{required_parameter_names}, which is not enough to satisfy the configured arity_for_uniqueness of #{arity_for_uniqueness}"
+        msg = if perform_method.arity >= 0
+                # takes a fixed number of arguments
+                # parform(a, b, c) # => arity == 3, so arity for uniqueness can be 0, 1, 2, or 3
+                if perform_method.arity < arity_for_uniqueness
+                  "#{klass_string}.#{perform_method.name} has arity of #{perform_method.arity} which will not work with arity_for_uniqueness of #{arity_for_uniqueness}"
+                end
+              else
+                if (perform_method.arity).abs < arity_for_uniqueness
+                  # parform(a, b, c, opts = {}) # => arity == -4
+                  #   and in this case arity for uniqueness can be 0, 1, 2, or 3, because 4 of the arguments are required
+                  "#{klass_string}.#{perform_method.name} has arity of #{perform_method.arity} which will not work with arity_for_uniqueness of #{arity_for_uniqueness}"
+                elsif (required_parameter_names = perform_method.parameters.take_while { |a| a[0] == :req }.map { |b| b[1] }).length < arity_for_uniqueness
+                  "#{klass_string}.#{perform_method.name} has the following required parameters: #{required_parameter_names}, which is not enough to satisfy the configured arity_for_uniqueness of #{arity_for_uniqueness}"
+                end
               end
         case arity_validation
           when :warning then
-            log(msg)
+            log(ColorizedString[msg].red)
           when :error then
             raise ArgumentError, msg
           else

data/lib/resque/unique_by_arity/cop.rb

@@ -22,7 +22,7 @@ module Resque
         # This will override methods from both plugins above, if configured for both
         base.send(:extend, uniqueness_cop_module)
         
-        base.include Resque::UniqueByArity::Validation if @configuration.arity_validation
+        base.include Resque::UniqueByArity::Validation unless @configuration.skip_arity_validation?
       end
     end
   end

data/lib/resque/unique_by_arity/cop_modulizer.rb

@@ -25,7 +25,11 @@ module Resque
           if configuration.lock_after_execution_period
             self.instance_variable_set(:@lock_after_execution_period, configuration.lock_after_execution_period)
           end
-          
+
+          if configuration.runtime_lock_timeout
+            self.instance_variable_set(:@runtime_lock_timeout, configuration.runtime_lock_timeout)
+          end
+
           if configuration.unique_in_queue || configuration.unique_across_queues
             ### Gem: resque_solo
             ### Plugin Name: Resque::Plugins::UniqueJob
@@ -76,6 +80,7 @@ module Resque
           if configuration.unique_at_runtime
             # @return [String] the Redis namespace of the key used to enforce uniqueness (at runtime)
             define_method(:runtime_key_namespace) do
+              puts "runtime_key_namespace for #{self}"
               "unique_at_runtime:#{self}"
             end
             # Returns a string, used by Resque::Plugins::UniqueAtRuntime, that will be used as the redis key

data/lib/resque/unique_by_arity/validation.rb

@@ -2,8 +2,10 @@ module Resque
   module UniqueByArity
     module Validation
       def self.included(base)
-        @um = base.method(:perform)
-        base.uniq_config.validate_arity(base.to_s, @um) if base.uniq_config.arity_validation
+        unless base.uniq_config.skip_arity_validation?
+          um = base.method(:perform)
+          base.uniq_config.validate_arity(base.to_s, um)
+        end
       end
     end
   end

data/lib/resque/unique_by_arity/version.rb

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

data/lib/resque/unique_by_arity.rb

@@ -25,7 +25,7 @@ require "resque/unique_by_arity/validation"
 module Resque
   module UniqueByArity
     def unique_log(message, config_proxy = nil)
-      config_proxy ||= self
+      config_proxy ||= uniqueness_configuration
       config_proxy.unique_logger.send(config_proxy.unique_log_level, message) if config_proxy.unique_logger
     end
 
@@ -72,6 +72,12 @@ module Resque
     def uniqueness_lock_after_execution_period=(lock_after_execution_period)
       @uniqueness_configuration.lock_after_execution_period = lock_after_execution_period
     end
+    def uniqueness_runtime_lock_timeout
+      @uniqueness_configuration.runtime_lock_timeout
+    end
+    def uniqueness_runtime_lock_timeout=(runtime_lock_timeout)
+      @uniqueness_configuration.runtime_lock_timeout = runtime_lock_timeout
+    end
     def uniqueness_unique_at_runtime
       @uniqueness_configuration.unique_at_runtime
     end

metadata

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