sidekiq-unique-jobs 6.0.8 → 6.0.9

data/lib/sidekiq_unique_jobs/on_conflict/raise.rb

@@ -10,7 +10,7 @@ module SidekiqUniqueJobs
       #   This will cause Sidekiq to retry the job
       # @raise [SidekiqUniqueJobs::Conflict]
       def call
-        fail SidekiqUniqueJobs::Conflict, item
+        raise SidekiqUniqueJobs::Conflict, item
       end
     end
   end

data/lib/sidekiq_unique_jobs/on_conflict/reject.rb

@@ -53,9 +53,9 @@ module SidekiqUniqueJobs
       def push_to_deadset
         Sidekiq.redis do |conn|
           conn.multi do
-            conn.zadd('dead', current_time, payload)
-            conn.zremrangebyscore('dead', '-inf', current_time - Sidekiq::DeadSet.timeout)
-            conn.zremrangebyrank('dead', 0, -Sidekiq::DeadSet.max_jobs)
+            conn.zadd("dead", current_time, payload)
+            conn.zremrangebyscore("dead", "-inf", current_time - Sidekiq::DeadSet.timeout)
+            conn.zremrangebyrank("dead", 0, -Sidekiq::DeadSet.max_jobs)
           end
         end
       end

data/lib/sidekiq_unique_jobs/on_conflict/strategy.rb

@@ -21,7 +21,7 @@ module SidekiqUniqueJobs
       # Use strategy on conflict
       # @raise [NotImplementedError] needs to be implemented in child class
       def call
-        fail NotImplementedError, 'needs to be implemented in child class'
+        raise NotImplementedError, "needs to be implemented in child class"
       end
 
       def replace?

data/lib/sidekiq_unique_jobs/options_with_fallback.rb

@@ -50,7 +50,7 @@ module SidekiqUniqueJobs
     def lock_class
       @lock_class ||= begin
         LOCKS.fetch(lock_type.to_sym) do
-          fail UnknownLock, "No implementation for `lock: :#{lock_type}`"
+          raise UnknownLock, "No implementation for `lock: :#{lock_type}`"
         end
       end
     end

data/lib/sidekiq_unique_jobs/scripts.rb

@@ -1,15 +1,15 @@
 # frozen_string_literal: true
 
-require 'pathname'
-require 'digest/sha1'
-require 'concurrent/map'
+require "pathname"
+require "digest/sha1"
+require "concurrent/map"
 
 module SidekiqUniqueJobs
   # Interface to dealing with .lua files
   #
   # @author Mikael Henriksson <mikael@zoolutions.se>
   module Scripts
-    LUA_PATHNAME ||= Pathname.new(__FILE__).dirname.join('../../redis').freeze
+    LUA_PATHNAME ||= Pathname.new(__FILE__).dirname.join("../../redis").freeze
     SCRIPT_SHAS ||= Concurrent::Map.new
 
     include SidekiqUniqueJobs::Connection
@@ -64,7 +64,7 @@ module SidekiqUniqueJobs
     # @param [Symbol] file_name the name of the lua script
     # @raise [ScriptError] when the error isn't handled
     def handle_error(ex, file_name)
-      if ex.message == 'NOSCRIPT No matching script. Please use EVAL.'
+      if ex.message == "NOSCRIPT No matching script. Please use EVAL."
         SCRIPT_SHAS.delete(file_name)
         return yield if block_given?
       end

data/lib/sidekiq_unique_jobs/sidekiq_unique_ext.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'sidekiq/api'
+require "sidekiq/api"
 
 module Sidekiq
   class SortedEntry

data/lib/sidekiq_unique_jobs/sidekiq_unique_jobs.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+#
+# Contains configuration and utility methods that belongs top level
+#
+# @author Mikael Henriksson <mikael@zoolutions.se>
+module SidekiqUniqueJobs
+  include SidekiqUniqueJobs::Connection
+
+  module_function
+
+  Config = Concurrent::MutableStruct.new(
+    :default_lock_timeout,
+    :enabled,
+    :unique_prefix,
+    :logger,
+  )
+
+  # The current configuration (See: {.configure} on how to configure)
+  def config
+    # Arguments here need to match the definition of the new class (see above)
+    @config ||= Config.new(
+      0,
+      true,
+      "uniquejobs",
+      Sidekiq.logger,
+    )
+  end
+
+  # The current logger
+  # @return [Logger] the configured logger
+  def logger
+    config.logger
+  end
+
+  # Set a new logger
+  # @param [Logger] other a new logger
+  def logger=(other)
+    config.logger = other
+  end
+
+  # Change global configuration while yielding
+  # @yield control to the caller
+  def use_config(tmp_config)
+    raise ::ArgumentError, "#{name}.#{__method__} needs a block" unless block_given?
+
+    old_config = config.to_h
+    configure(tmp_config)
+    yield
+    configure(old_config)
+  end
+
+  # Configure the gem
+  #
+  # This is usually called once at startup of an application
+  # @param [Hash] options global gem options
+  # @option options [Integer] :default_lock_timeout (default is 0)
+  # @option options [true,false] :enabled (default is true)
+  # @option options [String] :unique_prefix (default is 'uniquejobs')
+  # @option options [Logger] :logger (default is Sidekiq.logger)
+  # @yield control to the caller when given block
+  def configure(options = {})
+    if block_given?
+      yield config
+    else
+      options.each do |key, val|
+        config.send("#{key}=", val)
+      end
+    end
+  end
+
+  def redis_version
+    @redis_version ||= redis { |conn| conn.info("server")["redis_version"] }
+  end
+end

data/lib/sidekiq_unique_jobs/testing.rb

@@ -2,8 +2,8 @@
 
 # :nocov:
 
-require 'sidekiq'
-require 'sidekiq/testing'
+require "sidekiq"
+require "sidekiq/testing"
 
 module Sidekiq
   def self.use_options(tmp_config = {})
@@ -52,7 +52,7 @@ module Sidekiq
       module Testing
         def clear_all_ext
           clear_all_orig
-          SidekiqUniqueJobs::Util.del('*', 1000)
+          SidekiqUniqueJobs::Util.del("*", 1000)
         end
       end
     end

data/lib/sidekiq_unique_jobs/timeout.rb

@@ -5,4 +5,4 @@ module SidekiqUniqueJobs
   end
 end
 
-require 'sidekiq_unique_jobs/timeout/calculator'
+require "sidekiq_unique_jobs/timeout/calculator"

data/lib/sidekiq_unique_jobs/unique_args.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'digest'
-require 'sidekiq_unique_jobs/normalizer'
+require "digest"
+require "sidekiq_unique_jobs/normalizer"
 
 module SidekiqUniqueJobs
   # Handles uniqueness of sidekiq arguments

data/lib/sidekiq_unique_jobs/util.rb

@@ -7,7 +7,7 @@ module SidekiqUniqueJobs
   # @author Mikael Henriksson <mikael@zoolutions.se>
   module Util
     DEFAULT_COUNT     = 1_000
-    SCAN_PATTERN      = '*'
+    SCAN_PATTERN      = "*"
 
     include SidekiqUniqueJobs::Logging
     include SidekiqUniqueJobs::Connection
@@ -44,7 +44,7 @@ module SidekiqUniqueJobs
     # @param [Integer] count the maximum number of keys to delete
     # @return [Integer] the number of keys deleted
     def del(pattern = SCAN_PATTERN, count = 0)
-      raise ArgumentError, 'Please provide a number of keys to delete greater than zero' if count.zero?
+      raise ArgumentError, "Please provide a number of keys to delete greater than zero" if count.zero?
 
       pattern = suffix(pattern)
 
@@ -91,7 +91,7 @@ module SidekiqUniqueJobs
     end
 
     def suffix(key)
-      return "#{key}*" unless key.end_with?(':*')
+      return "#{key}*" unless key.end_with?(":*")
 
       key
     end

data/lib/sidekiq_unique_jobs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqUniqueJobs
-  VERSION = '6.0.8'
+  VERSION = "6.0.9"
 end

data/lib/sidekiq_unique_jobs/web.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 begin
-  require 'sidekiq/web'
+  require "sidekiq/web"
 rescue LoadError # rubocop:disable Lint/HandleExceptions
   # client-only usage
 end
 
-require_relative 'web/helpers'
+require_relative "web/helpers"
 
 module SidekiqUniqueJobs
   # Utility module to help manage unique keys in redis.
@@ -19,9 +19,9 @@ module SidekiqUniqueJobs
         include Web::Helpers
       end
 
-      app.get '/unique_digests' do
-        @filter         = params[:filter] || '*'
-        @filter         = '*' if @filter == ''
+      app.get "/unique_digests" do
+        @filter         = params[:filter] || "*"
+        @filter         = "*" if @filter == ""
         @count          = (params[:count] || 100).to_i
         @current_cursor = params[:cursor]
         @prev_cursor    = params[:prev_cursor]
@@ -31,14 +31,19 @@ module SidekiqUniqueJobs
         erb(unique_template(:unique_digests))
       end
 
-      app.get '/unique_digests/:digest' do
+      app.get "/unique_digests/delete_all" do
+        Digests.del(pattern: "*", count: Digests.count)
+        redirect_to :unique_digests
+      end
+
+      app.get "/unique_digests/:digest" do
         @digest = params[:digest]
         @unique_keys = Util.keys("#{@digest}*", 1000)
 
         erb(unique_template(:unique_digest))
       end
 
-      app.get '/unique_digests/:digest/delete' do
+      app.get "/unique_digests/:digest/delete" do
         Digests.del(digest: params[:digest])
         redirect_to :unique_digests
       end
@@ -48,6 +53,6 @@ end
 
 if defined?(Sidekiq::Web)
   Sidekiq::Web.register SidekiqUniqueJobs::Web
-  Sidekiq::Web.tabs['Unique Digests'] = 'unique_digests'
+  Sidekiq::Web.tabs["Unique Digests"] = "unique_digests"
   # Sidekiq::Web.settings.locales << File.join(File.dirname(__FILE__), 'locales')
 end

data/lib/sidekiq_unique_jobs/web/helpers.rb

@@ -3,7 +3,7 @@
 module SidekiqUniqueJobs
   module Web
     module Helpers
-      VIEW_PATH = File.expand_path('../web/views', __dir__)
+      VIEW_PATH = File.expand_path("../web/views", __dir__)
 
       def unique_template(name)
         File.open(File.join(VIEW_PATH, "#{name}.erb")).read
@@ -21,7 +21,7 @@ module SidekiqUniqueJobs
           next unless SAFE_CPARAMS.include?(key)
 
           "#{key}=#{CGI.escape(value.to_s)}"
-        end.compact.join('&')
+        end.compact.join("&")
       end
 
       def redirect_to(subpath)

data/lib/sidekiq_unique_jobs/web/views/unique_digests.erb

@@ -38,5 +38,9 @@
         </tr>
       <% end %>
     </table>
+
+    <form action="<%= root_path %>unique_digests/delete_all" method="get">
+      <input class="btn btn-danger btn-xs" type="submit" name="delete_all" value="<%= t('DeleteAll') %>" data-confirm="<%= t('AreYouSure') %>" />
+    </form>
   </div>
 <% end %>

data/lib/tasks/changelog.rake

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+desc "Generate a Changelog"
+task :changelog do
+  # rubocop:disable Style/MutableConstant
+  CHANGELOG_CMD ||= %w[
+    github_changelog_generator
+    -u
+    mhenrixon
+    -p
+    sidekiq-unique-jobs
+    --no-verbose
+    --token
+  ]
+  ADD_CHANGELOG_CMD      ||= "git add --all"
+  COMMIT_CHANGELOG_CMD   ||= "git commit -a -m 'Update changelog'"
+  # rubocop:enable Style/MutableConstant
+
+  sh("git checkout master")
+  sh(*CHANGELOG_CMD.push(ENV["CHANGELOG_GITHUB_TOKEN"]))
+  sh(ADD_CHANGELOG_CMD)
+  sh(COMMIT_CHANGELOG_CMD)
+end

data/sidekiq-unique-jobs.gemspec

@@ -1,42 +1,63 @@
 # frozen_string_literal: true
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
-require 'sidekiq_unique_jobs/version'
+require "sidekiq_unique_jobs/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'sidekiq-unique-jobs'
-  spec.version       = SidekiqUniqueJobs::VERSION
-  spec.authors       = ['Mikael Henriksson']
-  spec.email         = ['mikael@zoolutions.se']
-
-  spec.summary       = 'Uniqueness for Sidekiq Jobs'
-  spec.description   = 'Handles various types of unique jobs for Sidekiq'
-  spec.homepage      = 'https://github.com/mhenrixon/sidekiq-unique-jobs'
-  spec.license       = 'MIT'
+  spec.name        = "sidekiq-unique-jobs"
+  spec.version     = SidekiqUniqueJobs::VERSION
+  spec.authors     = ["Mikael Henriksson"]
+  spec.email       = ["mikael@zoolutions.se"]
+  spec.homepage    = "https://mhenrixon.github.io/sidekiq-unique-jobs"
+  spec.license     = "MIT"
+  spec.summary     = <<~SUMMARY
+                       Sidekiq middleware that prevents duplicates jobs
+                     SUMMARY
+  spec.description = <<~DESCRIPTION
+                       Prevents simultaneous Sidekiq jobs with the same unique arguments to run.
+                       Highly configurable to suite your specific needs.
+                     DESCRIPTION
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"]      = spec.homepage
+    spec.metadata["bug_tracker_uri"]   = "https://github.com/mhenrixon/sidekiq-unique-jobs/issues"
+    spec.metadata["documentation_uri"] = "https://mhenrixon.github.io/sidekiq-unique-jobs"
+    spec.metadata["source_code_uri"]   = "https://github.com/mhenrixon/sidekiq-unique-jobs"
+    spec.metadata["changelog_uri"]     = "https://github.com/mhenrixon/sidekiq-unique-jobs/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
 
-  spec.bindir        = 'bin'
+  spec.bindir        = "bin"
   spec.executables   = %w[uniquejobs]
 
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |file|
       file.match(%r{^(test|spec|features|gemfiles|pkg|rails_example|tmp)/})
     end
   end
 
-  spec.require_paths = ['lib']
-  spec.add_dependency 'concurrent-ruby', '~> 1.0', '>= 1.0.5'
-  spec.add_dependency 'sidekiq', '>= 4.0', '< 6.0'
-  spec.add_dependency 'thor', '~> 0'
-
-  spec.add_development_dependency 'bundler', '>= 1.16'
-  spec.add_development_dependency 'rspec', '~> 3.7'
-  spec.add_development_dependency 'rake', '~> 12.3'
-  spec.add_development_dependency 'timecop', '~> 0.9'
-  spec.add_development_dependency 'yard', '~> 0.9'
-  spec.add_development_dependency 'gem-release', '~> 1.0'
-  spec.add_development_dependency 'awesome_print', '~> 1.8'
-  spec.add_development_dependency 'rack-test'
-  spec.add_development_dependency 'sinatra'
+  spec.require_paths = ["lib"]
+  spec.add_dependency "concurrent-ruby", "~> 1.0", ">= 1.0.5"
+  spec.add_dependency "sidekiq", ">= 4.0", "< 6.0"
+  spec.add_dependency "thor", "~> 0"
+
+  spec.add_development_dependency "bundler", ">= 2.0"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.7"
+  spec.add_development_dependency "sinatra"
+  spec.add_development_dependency "timecop", "~> 0.9"
+
+  # ===== Documentation =====
+  spec.add_development_dependency "yard",          "~> 0.9.18"
+  spec.add_development_dependency "redcarpet",     "~> 3.4"
+  spec.add_development_dependency "github-markup", "~> 3.0"
+  spec.add_development_dependency "github_changelog_generator", "~> 1.14"
+
+  # ===== Release Management =====
+  spec.add_development_dependency "gem-release", ">= 2.0"
 end

data/update_docs.sh

@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+
+git checkout master
+git fetch
+stash_created=0
+
+if [[ "$(git diff --stat)" != "" ]]; then
+  stash_created=1
+  git stash push -u -a -m "Before updating docs"
+fi;
+
+git pull --rebase
+
+rake yard
+
+git checkout gh-pages
+
+if [[ "$(git branch | grep \* | cut -d ' ' -f2)" !=  "gh-pages" ]]; then
+  git checkout -b gh-pages
+fi;
+
+echo "Cleaning up current documentation"
+find . ! -path '*/.git*' ! -path '*/doc*' ! -path '*/update_docs.sh*' ! -path '*/_config.yml*' ! -path '*/_index.html*' ! -path '.' | xargs rm -rf
+
+echo "Copying new documentation"
+mv doc/* ./
+
+echo "Sending new documentation to github"
+git add --all
+git commit -a -m 'Update documentation'
+git push --set-upstream origin gh-pages --force
+
+if [[ $stash_created == 1 ]]; then
+  git stash pop
+fi;
+
+git checkout master