resque-unique_by_arity 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4444b6a7c6bf4b6a8d24ba5d6ecda5b0626e702e
-  data.tar.gz: db5347bfc38db54129cae0afb7af62b0d9596d80
+  metadata.gz: 74a015294d4c2dfa38a26395f3c83747c49cc380
+  data.tar.gz: 3a2aa2f9318deaab45185805561efde660c2dda0
 SHA512:
-  metadata.gz: 4ba38bc31db1ac84cc2665a7443265ba98d55377abfc346b65218a81e4d6df174496b7361c48ef6c3a94b89a7030b599ca1b52a1aa01e88396d35d5428709a06
-  data.tar.gz: 0546e76f497598b47b8769159c2ea644ee3f840e482717be9433dbb16a9c2171283ec537d10a7495a30cb455079311e03b818d9ef960a433e85bc68135204d56
+  metadata.gz: f811ec7c91598ddd783b69c1eeedb6ca7f5bf0b2b75b04c5d637bd6cd143c4f3f292cb16f82cca03d2b72227c201a9690bbbe5f0dcd2ef45bd69e129859741e2
+  data.tar.gz: 7be024ae58c1a2a70c12add6f5b24d471bc7b85c6ac26db7c20b9d7236a7e3ee3d54a645d953ca350ca37a077a88460e2aca7655be8ad0f0f3cb8451d1774f40

data/README.md

@@ -158,7 +158,7 @@ class MyJob
   def self.redis_unique_hash(payload)
     # ... See source @ lib/resque/unique_by_arity/cop_modulizer.rb 
     #       for how the built-in version works
-    # uniqueness_args = payload["args"] # over simplified - this ignores the arity
+    # uniqueness_args = payload["args"] # over simplified & ignoring arity
     # args = { class: job, args: uniqueness_args }
     # return [Digest::MD5.hexdigest(Resque.encode(args)), uniqueness_args]
   end

data/lib/resque/unique_by_arity.rb

@@ -9,12 +9,14 @@ require "resque/unique_by_arity/version"
 require "resque/unique_by_arity/configuration"
 require "resque/unique_by_arity/cop"
 require "resque/unique_by_arity/cop_modulizer"
+require "resque/unique_by_arity/validation"
 
 # Usage:
 #
 # class MyJob
 #   include UniqueByArity::Cop.new(
 #     arity_for_uniqueness: 1,
+#     arity_for_validation: :warning, # or nil, false, or :error
 #     unique_at_runtime: true,
 #     unique_in_queue: true
 #   )
@@ -58,6 +60,12 @@ module Resque
     def uniqueness_arity_for_uniqueness=(arity_for_uniqueness)
       @uniqueness_configuration.arity_for_uniqueness = arity_for_uniqueness
     end
+    def uniqueness_arity_for_validation
+      @uniqueness_configuration.arity_validation
+    end
+    def uniqueness_arity_for_validation=(arity_validation)
+      @uniqueness_configuration.arity_validation = arity_validation
+    end
     def uniqueness_lock_after_execution_period
       @uniqueness_configuration.lock_after_execution_period
     end

data/lib/resque/unique_by_arity/configuration.rb

@@ -2,9 +2,11 @@ require 'logger'
 module Resque
   module UniqueByArity
     class Configuration
+      VALID_ARITY_VALIDATION_LEVELS = [ :warning, :error, nil, false ]
       attr_accessor :logger
       attr_accessor :log_level
       attr_accessor :arity_for_uniqueness
+      attr_accessor :arity_validation
       attr_accessor :lock_after_execution_period
       attr_accessor :unique_at_runtime
       attr_accessor :unique_in_queue
@@ -13,17 +15,20 @@ 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] : :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
         @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
         # The default config initialization shouldn't trigger any warnings.
-        if options.keys.length > 0
-          warn ":arity_for_uniqueness is set to #{@arity_for_uniqueness}, but no uniqueness enforcement was turned on [:unique_at_runtime, :unique_in_queue, :unique_across_queues]" unless @unique_at_runtime || @unique_in_queue || @unique_across_queues
-          warn ":lock_after_execution_period is set to #{@lock_after_execution_period}, but :unique_at_runtime is not set" if @lock_after_execution_period && !@unique_at_runtime
-          warn ":unique_in_queue and :unique_across_queues should not be set at the same time, as :unique_across_queues will always supercede :unique_in_queue" if @unique_in_queue && @unique_across_queues
+        if options.keys.length > 0 && @logger
+          Resque::UniqueByArity.unique_log ":arity_for_uniqueness is set to #{@arity_for_uniqueness}, but no uniqueness enforcement was turned on [:unique_at_runtime, :unique_in_queue, :unique_across_queues]" unless @unique_at_runtime || @unique_in_queue || @unique_across_queues
+          Resque::UniqueByArity.unique_log ":lock_after_execution_period is set to #{@lock_after_execution_period}, but :unique_at_runtime is not set" if @lock_after_execution_period && !@unique_at_runtime
+          Resque::UniqueByArity.unique_log ":unique_in_queue and :unique_across_queues should not be set at the same time, as :unique_across_queues will always supercede :unique_in_queue" if @unique_in_queue && @unique_across_queues
         end
       end
+
       def to_hash
         {
             logger: logger,
@@ -35,6 +40,31 @@ module Resque
             unique_across_queues: unique_across_queues
         }
       end
+
+      def validate_arity(klass_string, perform_method)
+        return true unless 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.
+        #   For Ruby methods that take a variable number of arguments, returns -n-1, where n is the number of required arguments.
+        #   For methods written in C, returns -1 if the call takes a variable number of arguments.
+        # 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}"
+              end
+        case arity_validation
+          when :warning then
+            Resque::UniqueByArity.unique_log(msg)
+          when :error then
+            raise ArgumentError, msg
+          else
+            raise arity_validation, msg
+        end if msg
+      end
     end
   end
 end

data/lib/resque/unique_by_arity/cop.rb

@@ -14,13 +14,15 @@ module Resque
         # defines a redis_key method, which we have to override.
         base.send(:include, Resque::Plugins::UniqueJob) if @configuration.unique_in_queue || @configuration.unique_across_queues
 
-        # gem is resque-unique_at_runtime
+        # gem is resque-unique_at_runtime, which is a rewrite of resque-lonely_job
         # see: https://github.com/pboling/resque-unique_at_runtime
         base.send(:extend, Resque::Plugins::UniqueAtRuntime) if @configuration.unique_at_runtime
 
         uniqueness_cop_module = Resque::UniqueByArity::CopModulizer.to_mod(@configuration)
         # This will override methods from both plugins above, if configured for both
         base.send(:extend, uniqueness_cop_module)
+        
+        base.singleton_class.prepend Resque::UniqueByArity::Validation
       end
     end
   end

data/lib/resque/unique_by_arity/cop_modulizer.rb

@@ -7,7 +7,7 @@ module Resque
             # @return [Array<String, arguments>] the key base hash used to enforce uniqueness, and the arguments from the payload used to calculate it
             define_method(:redis_unique_hash) do |payload|
               payload = Resque.decode(Resque.encode(payload))
-              puts "payload is #{payload.inspect}" if ENV['RESQUE_DEBUG'] == 'true'
+              Resque::UniqueByArity.unique_log "payload is #{payload.inspect}" if ENV['RESQUE_DEBUG'] == 'true'
               job  = payload["class"]
               # It seems possible that some jobs may not have an "args" key in the payload.
               args = payload["args"] || []
@@ -45,7 +45,7 @@ module Resque
             define_method(:unique_at_queue_time_redis_key) do |queue, payload|
               unique_hash, args_for_uniqueness = redis_unique_hash(payload)
               key = "#{solo_key_namespace(queue)}:#{solo_redis_key_prefix}:#{unique_hash}"
-              puts "#{ColorizedString['[Queue-Time]'].green} #{self}.unique_at_queue_time_redis_key for #{args_for_uniqueness} is: #{ColorizedString[key].green}" if ENV['RESQUE_DEBUG'] == 'true'
+              Resque::UniqueByArity.unique_log "#{ColorizedString['[Queue-Time]'].green} #{self}.unique_at_queue_time_redis_key for #{args_for_uniqueness} is: #{ColorizedString[key].green}" if ENV['RESQUE_DEBUG'] == 'true'
               key
             end
             #
@@ -54,7 +54,7 @@ module Resque
               # solo_key_namespace may or may not ignore the queue passed in, depending on config.
               key_match = "#{solo_key_namespace(self.instance_variable_get(:@queue))}:#{solo_redis_key_prefix}:*"
               keys = Resque.redis.keys(key_match)
-              puts "Purging #{keys.length} keys from #{ColorizedString[key_match].red}"
+              Resque::UniqueByArity.unique_log "Purging #{keys.length} keys from #{ColorizedString[key_match].red}"
               Resque.redis.del keys if keys.length > 0
             end
             if configuration.unique_in_queue
@@ -89,14 +89,14 @@ module Resque
             define_method(:unique_at_runtime_redis_key) do |*args|
               unique_hash, args_for_uniqueness = redis_unique_hash({"class" => self.to_s, "args" => args})
               key = "#{runtime_key_namespace}:#{unique_hash}"
-              puts "#{ColorizedString['[Run-Time]'].yellow} #{self}.unique_at_runtime_redis_key for #{args_for_uniqueness} is: #{ColorizedString[key].yellow}" if ENV['RESQUE_DEBUG'] == 'true'
+              Resque::UniqueByArity.unique_log "#{ColorizedString['[Run-Time]'].yellow} #{self}.unique_at_runtime_redis_key for #{args_for_uniqueness} is: #{ColorizedString[key].yellow}" if ENV['RESQUE_DEBUG'] == 'true'
               key
             end
             # @return [Fixnum] number of keys that were deleted
             define_method(:purge_unique_at_runtime_redis_keys) do
               key_match = "#{runtime_key_namespace}:*"
               keys = Resque.redis.keys(key_match)
-              puts "Purging #{keys.length} keys from #{ColorizedString[key_match].red}"
+              Resque::UniqueByArity.unique_log "Purging #{keys.length} keys from #{ColorizedString[key_match].red}"
               Resque.redis.del keys if keys.length > 0
             end
           end

data/lib/resque/unique_by_arity/validation.rb

@@ -0,0 +1,12 @@
+module Resque
+  module UniqueByArity
+    module Validation
+      def perform(*_)
+        puts "performed!"
+        uniq_config.validate_arity(self.to_s, self.method(:perform).super_method) if uniq_config.arity_validation
+        super
+      end
+    end
+  end
+end
+

data/lib/resque/unique_by_arity/version.rb

@@ -1,5 +1,5 @@
 module Resque
   module UniqueByArity
-    VERSION = "1.0.2"
+    VERSION = "1.0.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resque-unique_by_arity
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Peter Boling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-01 00:00:00.000000000 Z
+date: 2017-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: resque-unique_at_runtime
@@ -114,6 +114,7 @@ files:
 - lib/resque/unique_by_arity/configuration.rb
 - lib/resque/unique_by_arity/cop.rb
 - lib/resque/unique_by_arity/cop_modulizer.rb
+- lib/resque/unique_by_arity/validation.rb
 - lib/resque/unique_by_arity/version.rb
 - resque-unique_by_arity.gemspec
 homepage: https://github.com/pboling/resque-unique_by_arity