resque-unique_by_arity 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46b8b154183e7fdb261702e84799094abd563819cfdbc3119a44af2e6a6e9ed5
-  data.tar.gz: f13999d5b0c4cf2986b4fd81662ce38d11121e455e479a1175a26524fc0d9c6e
+  metadata.gz: 3ab7e18a0ccb64d7ed0045aa0047e0ffc7594c1688ccbdae986e098a9e53c7ec
+  data.tar.gz: d699f5cbb3caf4364fe6160227c64d920827ed597417ac40dce745d337f9fecf
 SHA512:
-  metadata.gz: b46b9eea89f5e8be264d120d43bb05b2b53cc5821053c292cef3fd1c025f5e248ae5841d42313d9e487c9f9cded5c521309ba02f0a50df95192a4100bdfd3766
-  data.tar.gz: c00bad5e1f1d1a8eac039ff72b90bb66a761a943a2e4bc28e5269d1a149000f6da82f8f498f739a3da048328948c3ea1a98b17f830074dea81136f1fa1102c0d
+  metadata.gz: 2888fff88866a0a5c51c20b842571c7b664681bba2b978229b2e1bc088a673b1d68a7a28765868f66f10aebe6e0cf18b3a401863899073d609a0c841442a7572
+  data.tar.gz: 990f6432863e2c847919cc96025cd7f56b27844b1dee41839352d312950eae6331fc7b3ee433515229f0fb5dc11bf3647cbb2abdd666dd8274998bd0b95f2fec

data/README.md

@@ -74,6 +74,36 @@ Or install it yourself as:
 
 ## Usage
 
+### Global Configuration
+
+The following is showing the default values.  These global configs are copied into each per-class config unless they are overridden by the class config.
+
+
+Create an initializer (e.g. `config/initializers/resque-unique_by_arity.rb` for rails) and customize the following:
+
+```ruby
+  Resque::UniqueByArity.configure do |config|
+    config.logger = nil
+    config.log_level = :debug
+    config.arity_for_uniqueness = 0
+    config.unique_at_runtime = false
+    config.unique_in_queue = false
+    # No need to do the following if keeping default values
+    config.runtime_lock_timeout = 60 * 60 * 24 * 5
+    config.runtime_requeue_interval = 1
+    config.unique_at_runtime_key_base = 'r-uar'.freeze
+    config.lock_after_execution_period = 0
+    config.ttl = -1
+    config.unique_in_queue_key_base = 'r-uiq'.freeze
+    # Debug Mode is preferably set via an environment variable:
+    #   to one of 'true', 'arity', or 'arity,queue,runtime' for all three tools:
+    #     ENV['RESQUE_DEBUG'] = 'true'
+    # config.debug_mode = true
+  end
+```
+
+### Per Job Class Configuration
+
 This gem will take care to set the class instance variables (similar to the
  familiar `@queue` class instance variable) that are utilized by 
  `resque-unique_in_queue` and `resque-unique_at_runtime` (default values shown):
@@ -93,16 +123,19 @@ This gem will take care to set the class instance variables (similar to the
 All you need to do is configure this gem accordingly:
 ```ruby
   include Resque::Plugins::UniqueByArity.new(
-    arity_for_uniqueness: 3,
-    unique_at_runtime: true,
-    unique_in_queue: true,
+    arity_for_uniqueness: 1,
+    # Turn on one or both of the following:
+    unique_at_runtime: false,
+    unique_in_queue: false,
     # No need to do the following if keeping default values
     runtime_lock_timeout: 60 * 60 * 24 * 5,
     runtime_requeue_interval: 1,
-    unique_at_runtime_key_base: 'r-uar'.freeze,
+    # would override the global setting, probably a bad idea.
+    # unique_at_runtime_key_base: 'r-uar'.freeze,
     lock_after_execution_period: 0,
-    ttl: 0,
-    unique_in_queue_key_base: 'r-uiq'.freeze
+    ttl: -1,
+    # would override the global setting, probably a bad idea.
+    # unique_in_queue_key_base: 'r-uiq'.freeze
   )
 ```
 
@@ -328,30 +361,27 @@ class MyJob
   # Core hashing algorithm for a job used for *all 3 types* of uniqueness 
   # @return [Array<String, arguments>], where the string is the unique digest, and arguments are the specific args that were used to calculate the digest 
   def self.redis_unique_hash(payload)
-    modulizer.rb
     #       for how the built-in version works
     # uniqueness_args = payload["args"] # over simplified & ignoring arity
     # args = { class: job, args: uniqueness_args }
     # return [Digest::MD5.hexdigest(Resque.encode(args)), uniqueness_args]
   end
 
-  unique_in_queue
-  def self.unique_at_runtime_redis_key_prefix
+  def self.unique_in_queue_redis_key_prefix
     # "unique_job:#{self}" # <= default value
   end
+  
+  def self.unique_in_queue_redis_key(queue, payload)
+    # unique_hash, _args_for_uniqueness = redis_unique_hash(payload)
+    # "#{unique_in_queue_key_namespace(queue)}:#{unique_in_queue_redis_key_prefix}:#{unique_hash}"
+  end
 
-  unique_in_queue
-  def self.unique_at_runtime_key_namespace(queue = nil)
+  def self.unique_in_queue_key_namespace(queue = nil)
     # definition depends on which type of uniqueness is chosen, be careful if you customize
     # "r-uiq:queue:#{queue}:job" # <= is for unique within queue at queue time
     # "r-uiq:across_queues:job" # <= is for unique across all queues at queue time
   end
   
-  def self.unique_in_queue_redis_key(queue, payload)
-    # unique_hash, _args_for_uniqueness = redis_unique_hash(payload)
-    # "#{unique_at_runtime_key_namespace(queue)}:#{unique_at_runtime_redis_key_prefix}:#{unique_hash}"
-  end
-  
   def self.runtime_key_namespace
     # "unique_at_runtime:#{self}"
   end

data/lib/resque/unique_by_arity.rb

@@ -21,6 +21,7 @@ module Resque
     def configure
       yield(@configuration)
     end
+    module_function(:configure)
 
     #### CONFIG ####
     # Access globally configured settings:

data/lib/resque/unique_by_arity/global_configuration.rb

@@ -6,22 +6,28 @@ module Resque
     # Will be used as the default settings for the per-job configs.
     class GlobalConfiguration < Configuration
       DEFAULT_LOG_LEVEL = :debug
-      DEFAULT_AT_RUNTIME_KEY_BASE = 'r-uar'.freeze
-      DEFAULT_IN_QUEUE_KEY_BASE = 'r-uiq'.freeze
 
       # For resque-unique_at_runtime
       DEFAULT_LOCK_TIMEOUT = 60 * 60 * 24 * 5
       DEFAULT_REQUEUE_INTERVAL = 1
-      DEFAULT_UNIQUE_AT_RUNTIME_KEY_BASE = 'r-uar'.freeze
+      DEFAULT_AT_RUNTIME_KEY_BASE = 'r-uar'.freeze
 
       # For resque-unique_in_queue
       DEFAULT_LOCK_AFTER_EXECUTION_PERIOD = 0
       DEFAULT_TTL = -1
-      DEFAULT_UNIQUE_IN_QUEUE_KEY_BASE = 'r-uiq'.freeze
+      DEFAULT_IN_QUEUE_KEY_BASE = 'r-uiq'.freeze
 
       include Singleton
 
       def initialize
+        reset
+      end
+
+      def defcon(sym)
+        self.send(sym)
+      end
+
+      def reset
         debug_mode_from_env
         @logger = nil
         @log_level = DEFAULT_LOG_LEVEL
@@ -33,8 +39,6 @@ module Resque
         @unique_at_runtime_key_base = DEFAULT_AT_RUNTIME_KEY_BASE
         @unique_in_queue_key_base = DEFAULT_IN_QUEUE_KEY_BASE
         @unique_at_runtime = false
-        @unique_at_runtime_key_base = DEFAULT_UNIQUE_AT_RUNTIME_KEY_BASE
-        @unique_in_queue_key_base = DEFAULT_UNIQUE_IN_QUEUE_KEY_BASE
         @unique_in_queue = false
         @unique_across_queues = false
         @ttl = DEFAULT_TTL
@@ -43,10 +47,6 @@ module Resque
           @logger ||= Logger.new(STDOUT)
         end
       end
-
-      def defcon(sym)
-        self.send(sym)
-      end
     end
   end
 end

data/lib/resque/unique_by_arity/modulizer.rb

@@ -53,7 +53,7 @@ module Resque
             #
             # @return [Fixnum] number of keys that were deleted
             define_method(:purge_unique_queued_redis_keys) do
-              # unique_at_runtime_key_namespace may or may not ignore the queue passed in, depending on config.
+              # unique_in_queue_key_namespace may or may not ignore the queue passed in, depending on config.
               key_match = "#{unique_in_queue_key_namespace(instance_variable_get(:@queue))}:#{unique_in_queue_redis_key_prefix}:*"
               keys = Resque.redis.keys(key_match)
               Resque::UniqueByArity.log("#{Resque::UniqueByArity::PLUGIN_TAG}#{Resque::UniqueInQueue::PLUGIN_TAG} #{ColorizedString['Purging'].red} #{keys.length} keys from #{ColorizedString[key_match].red}")

data/lib/resque/unique_by_arity/unique_job.rb

@@ -17,8 +17,6 @@
 module Resque
   module UniqueByArity
     module UniqueJob
-      PLUGIN_TAG = (ColorizedString['[R-UBA] '].green).freeze
-
       def uniq_log(message, config_proxy = nil)
         config_proxy ||= uniq_config
         config_proxy.logger&.send(config_proxy.log_level, message) if config_proxy.logger

data/lib/resque/unique_by_arity/version.rb

@@ -1,5 +1,5 @@
 module Resque
   module UniqueByArity
-    VERSION = '3.0.1'.freeze
+    VERSION = '3.0.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resque-unique_by_arity
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.0.2
 platform: ruby
 authors:
 - Peter H. Boling
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-15 00:00:00.000000000 Z
+date: 2018-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize