sidekiq-unique-jobs 5.0.2 → 5.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ca11c77223ec339ed2dba0bbfa3630c17db88df
-  data.tar.gz: 8ac3ea5ed96f4303663cd7a43b3b70e93ece13c5
+  metadata.gz: 11b1c4aca9391461a5744ff361b1bd1d549a5d1e
+  data.tar.gz: d336770bd8f907edab6805a2f394b4d2bc26ef08
 SHA512:
-  metadata.gz: ab6f325ea2633be2150c15f9441133901ec42fa767a5777328df8c44438fab1e8eddbb674a4f11132028899f7fab6c2a19dc1541dd9e2acea257e58bb96b3aca
-  data.tar.gz: ece51ecdb1244507c06a5336d78106b92423b13d026d4c1f8a0ebadad778526522ce52efc7199b41530295fd2865f1732e53029ad929c51f70ef62ab944d79c3
+  metadata.gz: 87ac16889831fe0a6c072091cc4becc17e1e988867c8474788bf8f3d369ff2f6b83519b563080761727ffc13e9dd1b1559daf761779019fbcb1a8225c129299e
+  data.tar.gz: ecc7c5c08bfa9f2aab973e30d6ad3c044de0a8da5bd5a6b39c87273509b758795882c8a1ee0707d5c8fb31c776f725210dbe8029c9c96d8c13ca08478df5b643

data/.rubocop.yml

@@ -42,7 +42,7 @@ Style/ConstantName:
   Enabled: true
 
 Style/FrozenStringLiteralComment:
-  Enabled: false
+  Enabled: true
 
 Style/Documentation:
   Enabled: false
@@ -51,6 +51,9 @@ Style/FileName:
   Enabled: true
   Exclude:
     - 'lib/sidekiq-unique-jobs.rb'
+    - '**/Gemfile'
+    - '**/Appraisals'
+    - '**/*.gemspec'
 
 Style/GlobalVars:
   Enabled: true

data/Appraisals

@@ -1,4 +1,4 @@
-# rubocop:disable Style/FileName
+# frozen_string_literal: true
 
 appraise 'sidekiq-develop' do
   gem 'sidekiq', github: 'mperham/sidekiq'

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## v5.0.4
+- Fixes a problem with installing the gem
+
+## v5.0.3
+- Removes test files and appraisals and such from the released gem version to speed up gem installs 
+
+## v5.0.2
+- Added more helpful debug, warning and error messages for failures to collect unique arghuments
+
 ## v5.0.1
 
 - Added a command line util for cleaning out expired keys

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mikael@zoolutions.se. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,4 +1,4 @@
-# rubocop:disable Style/FileName
+# frozen_string_literal: true
 
 source 'https://rubygems.org'
 gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Mikael Henriksson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/bin/bench

@@ -14,7 +14,7 @@ ITERATIONS ||= 10_000
 Benchmark.ips do |x|
   x.config(time: 5, warmup: 2)
   x.report('new_shit') do |_times|
-    SidekiqUniqueJobs::Scripts.call(:acquire_lock, nil, keys: [SecureRandom.hex], argv: [SecureRandom.hex])
+    SidekiqUniqueJobs::Scripts::AcquireLock.execute(nil, SecureRandom.hex, SecureRandom.hex)
   end
   x.compare!
 end

data/lib/sidekiq-unique-jobs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yaml' if RUBY_VERSION.include?('2.0.0')
 require 'forwardable'
 require 'sidekiq_unique_jobs/version'
@@ -66,7 +68,7 @@ module SidekiqUniqueJobs
   end
 
   def redis_version
-    @redis_version ||= connection { |c| c.info('server'.freeze)['redis_version'.freeze] }
+    @redis_version ||= connection { |c| c.info('server')['redis_version'] }
   end
 
   def connection(redis_pool = nil)

data/lib/sidekiq/simulator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sidekiq/launcher'
 require 'timeout'
 
@@ -38,19 +40,11 @@ module Sidekiq
     end
 
     def terminate_launcher
-      if launcher.respond_to?(:alive?)
-        launcher.terminate # Better to be fast than graceful for our purposes
-      else
-        launcher.stop # New sidekiq works better
-      end
+      launcher.stop
     end
 
     def alive?
-      if launcher.respond_to?(:alive?)
-        launcher.alive?
-      else
-        launcher.manager.workers.any?
-      end
+      launcher.manager.workers.any?
     end
 
     def stopped?

data/lib/sidekiq_unique_jobs/cli.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thor'
 
 module SidekiqUniqueJobs

data/lib/sidekiq_unique_jobs/client/middleware.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sidekiq_unique_jobs/server/middleware'
 
 module SidekiqUniqueJobs

data/lib/sidekiq_unique_jobs/config.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SidekiqUniqueJobs
   class Config < OpenStruct
     def inline_testing_enabled?

data/lib/sidekiq_unique_jobs/constants.rb

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 module SidekiqUniqueJobs
-  ARGS_KEY ||= 'args'.freeze
-  AT_KEY ||= 'at'.freeze
-  CLASS_KEY ||= 'class'.freeze
-  JID_KEY ||= 'jid'.freeze
-  LOG_DUPLICATE_KEY ||= 'log_duplicate_payload'.freeze
-  QUEUE_KEY ||= 'queue'.freeze
-  HASH_KEY ||= 'uniquejobs'.freeze
-  QUEUE_LOCK_TIMEOUT_KEY ||= 'unique_expiration'.freeze
-  RUN_LOCK_TIMEOUT_KEY ||= 'run_lock_expiration'.freeze
-  TESTING_CONSTANT ||= 'Testing'.freeze
-  UNIQUE_KEY ||= 'unique'.freeze
-  UNIQUE_LOCK_KEY ||= 'unique_lock'.freeze
-  UNIQUE_ARGS_KEY ||= 'unique_args'.freeze
-  UNIQUE_PREFIX_KEY ||= 'unique_prefix'.freeze
-  UNIQUE_DIGEST_KEY ||= 'unique_digest'.freeze
-  UNIQUE_ON_ALL_QUEUES_KEY ||= 'unique_on_all_queues'.freeze
-  UNIQUE_ARGS_ENABLED_KEY ||= 'unique_args_enabled'.freeze
+  ARGS_KEY ||= 'args'
+  AT_KEY ||= 'at'
+  CLASS_KEY ||= 'class'
+  JID_KEY ||= 'jid'
+  LOG_DUPLICATE_KEY ||= 'log_duplicate_payload'
+  QUEUE_KEY ||= 'queue'
+  HASH_KEY ||= 'uniquejobs'
+  QUEUE_LOCK_TIMEOUT_KEY ||= 'unique_expiration'
+  RUN_LOCK_TIMEOUT_KEY ||= 'run_lock_expiration'
+  TESTING_CONSTANT ||= 'Testing'
+  UNIQUE_KEY ||= 'unique'
+  UNIQUE_LOCK_KEY ||= 'unique_lock'
+  UNIQUE_ARGS_KEY ||= 'unique_args'
+  UNIQUE_PREFIX_KEY ||= 'unique_prefix'
+  UNIQUE_DIGEST_KEY ||= 'unique_digest'
+  UNIQUE_ON_ALL_QUEUES_KEY ||= 'unique_on_all_queues'
+  UNIQUE_ARGS_ENABLED_KEY ||= 'unique_args_enabled'
 end

data/lib/sidekiq_unique_jobs/core_ext.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 begin
   require 'active_support/core_ext/hash/keys'
   require 'active_support/core_ext/hash/deep_merge'

data/lib/sidekiq_unique_jobs/lock.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sidekiq_unique_jobs/lock/until_executed'
 require 'sidekiq_unique_jobs/lock/until_executing'
 require 'sidekiq_unique_jobs/lock/while_executing'

data/lib/sidekiq_unique_jobs/lock/until_and_while_executing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SidekiqUniqueJobs
   module Lock
     class UntilAndWhileExecuting < UntilExecuting

data/lib/sidekiq_unique_jobs/lock/until_executed.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module SidekiqUniqueJobs
   module Lock
     class UntilExecuted
-      OK ||= 'OK'.freeze
+      OK ||= 'OK'
 
       include SidekiqUniqueJobs::Unlockable
 

data/lib/sidekiq_unique_jobs/lock/until_executing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SidekiqUniqueJobs
   module Lock
     class UntilExecuting < UntilExecuted

data/lib/sidekiq_unique_jobs/lock/until_timeout.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SidekiqUniqueJobs
   module Lock
     class UntilTimeout < UntilExecuted

data/lib/sidekiq_unique_jobs/lock/while_executing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SidekiqUniqueJobs
   module Lock
     class WhileExecuting

data/lib/sidekiq_unique_jobs/middleware.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sidekiq'
 
 module SidekiqUniqueJobs

data/lib/sidekiq_unique_jobs/normalizer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'json'
 
 module SidekiqUniqueJobs

data/lib/sidekiq_unique_jobs/options_with_fallback.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SidekiqUniqueJobs
   module OptionsWithFallback
     def self.included(base)

data/lib/sidekiq_unique_jobs/run_lock_failed.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 SidekiqUniqueJobs::RunLockFailed = Class.new(StandardError)

data/lib/sidekiq_unique_jobs/script_mock.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'digest/sha1'
 

data/lib/sidekiq_unique_jobs/scripts.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 require 'digest/sha1'
 require 'concurrent/map'
@@ -22,22 +24,25 @@ module SidekiqUniqueJobs
     extend SingleForwardable
     def_delegators :SidekiqUniqueJobs, :connection, :logger
 
-    def call(file_name, redis_pool, options = {}) # rubocop:disable MethodLength
+    def call(file_name, redis_pool, options = {})
+      internal_call(file_name, redis_pool, options)
+    rescue Redis::CommandError => ex
+      handle_error(ex, file_name, redis_pool, options)
+    end
+
+    def internal_call(file_name, redis_pool, options = {})
       connection(redis_pool) do |redis|
-        if SCRIPT_SHAS[file_name].nil?
-          SCRIPT_SHAS[file_name] = redis.script(:load, script_source(file_name))
-        end
+        SCRIPT_SHAS[file_name] = redis.script(:load, script_source(file_name)) if SCRIPT_SHAS[file_name].nil?
         redis.evalsha(SCRIPT_SHAS[file_name], options)
       end
-    rescue Redis::CommandError => ex
-      if ex.message == 'NOSCRIPT No matching script. Please use EVAL.'
+    end
+
+    def handle_error(ex, file_name, redis_pool, options = {})
+      if ex.message == 'NOSCRIPT No matching script. Please use EVAL.' # rubocop:disable Style/GuardClause
         SCRIPT_SHAS.delete(file_name)
         call(file_name, redis_pool, options)
-        raise
       else
-        raise ScriptError,
-              "#{file_name}.lua\n\n#{ex.message}\n\n#{script_source(file_name)}" \
-              "#{ex.backtrace.join("\n")}"
+        raise ScriptError, "Problem compiling #{file_name}. Invalid LUA syntax?"
       end
     end
 

data/lib/sidekiq_unique_jobs/scripts/acquire_lock.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SidekiqUniqueJobs
   module Scripts
     class AcquireLock

data/lib/sidekiq_unique_jobs/scripts/release_lock.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SidekiqUniqueJobs
   module Scripts
     class ReleaseLock

data/lib/sidekiq_unique_jobs/server/middleware.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SidekiqUniqueJobs
   module Server
     class Middleware

data/lib/sidekiq_unique_jobs/sidekiq_unique_ext.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sidekiq/api'
 
 module Sidekiq

data/lib/sidekiq_unique_jobs/testing.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sidekiq_unique_jobs/testing/sidekiq_overrides'
 require 'sidekiq_unique_jobs/script_mock'
 

data/lib/sidekiq_unique_jobs/testing/sidekiq_overrides.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sidekiq/testing'
 
 module Sidekiq