mhenrixon/sidekiq-unique-jobs

View on GitHub
doc/SidekiqUniqueJobs/LockDigest.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: SidekiqUniqueJobs::LockDigest
Unexpected trailing spaces found.
&mdash; Documentation by YARD 0.9.26
Unexpected trailing spaces found.
</title>
 
<link rel="stylesheet" href="../css/style.css" type="text/css" />
 
<link rel="stylesheet" href="../css/common.css" type="text/css" />
 
<script type="text/javascript">
pathId = "SidekiqUniqueJobs::LockDigest";
relpath = '../';
</script>
 
 
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
 
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
 
 
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
 
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
Unexpected trailing spaces found.
<a href="../_index.html">Index (L)</a> &raquo;
<span class='title'><span class='object_link'><a href="../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span>
Unexpected trailing spaces found.
Expected an indentation at 6 instead of at 5.
&raquo;
<span class="title">LockDigest</span>
Unexpected trailing spaces found.
</div>
 
<div id="search">
Unexpected trailing spaces found.
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
 
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
Unexpected trailing spaces found.
</div>
<div class="clear"></div>
</div>
 
<div id="content"><h1>Class: SidekiqUniqueJobs::LockDigest
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
</h1>
<div class="box_info">
Unexpected trailing spaces found.
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
Unexpected trailing spaces found.
<ul class="fullTree">
<li>Object</li>
Unexpected trailing spaces found.
<li class="next">SidekiqUniqueJobs::LockDigest</li>
Unexpected trailing spaces found.
</ul>
<a href="#" class="inheritanceTree">show all</a>
Unexpected trailing spaces found.
</dd>
</dl>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<dl>
<dt>Includes:</dt>
<dd><span class='object_link'><a href="JSON.html" title="SidekiqUniqueJobs::JSON (module)">JSON</a></span>, <span class='object_link'><a href="Logging.html" title="SidekiqUniqueJobs::Logging (module)">Logging</a></span>, <span class='object_link'><a href="SidekiqWorkerMethods.html" title="SidekiqUniqueJobs::SidekiqWorkerMethods (module)">SidekiqWorkerMethods</a></span></dd>
</dl>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<dl>
<dt>Defined in:</dt>
<dd>lib/sidekiq_unique_jobs/lock_digest.rb</dd>
</dl>
Unexpected trailing spaces found.
</div>
 
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Handles uniqueness of sidekiq arguments</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
<p class="tag_title">Author:</p>
<ul class="author">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<div class='inline'><p>Mikael Henriksson <a href="mailto:mikael@mhenrixon.com">mikael@mhenrixon.com</a></p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div>
 
 
 
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#args-instance_method" title="#args (instance method)">#<strong>args</strong> &#x21d2; String </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class="note title readonly">readonly</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>The prefix for the unique key.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#item-instance_method" title="#item (instance method)">#<strong>item</strong> &#x21d2; Hash </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class="note title readonly">readonly</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>The sidekiq job hash.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#lock_args-instance_method" title="#lock_args (instance method)">#<strong>lock_args</strong> &#x21d2; Object </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class="note title readonly">readonly</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute lock_args.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#lock_prefix-instance_method" title="#lock_prefix (instance method)">#<strong>lock_prefix</strong> &#x21d2; Object </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class="note title readonly">readonly</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute lock_prefix.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
</ul>
 
 
 
 
Unexpected trailing spaces found.
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
 
<ul class="summary">
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#call-class_method" title="call (class method)">.<strong>call</strong>(item) &#x21d2; String </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Generates a new digest.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
</ul>
Unexpected trailing spaces found.
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
 
<ul class="summary">
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#after_unlock_hook-instance_method" title="#after_unlock_hook (instance method)">#<strong>after_unlock_hook</strong> &#x21d2; Proc </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="SidekiqWorkerMethods.html#after_unlock_hook-instance_method" title="SidekiqUniqueJobs::SidekiqWorkerMethods#after_unlock_hook (method)">SidekiqWorkerMethods</a></span>
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>The hook to call after a successful unlock.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#build_message-instance_method" title="#build_message (instance method)">#<strong>build_message</strong>(message_or_exception, item = nil) &#x21d2; String </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="Logging.html#build_message-instance_method" title="SidekiqUniqueJobs::Logging#build_message (method)">Logging</a></span>
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Build a log message.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#create_digest-instance_method" title="#create_digest (instance method)">#<strong>create_digest</strong> &#x21d2; String </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Creates a namespaced unique digest based on the <span class='object_link'><a href="#digestable_hash-instance_method" title="SidekiqUniqueJobs::LockDigest#digestable_hash (method)">#digestable_hash</a></span> and the <span class='object_link'><a href="#lock_prefix-instance_method" title="SidekiqUniqueJobs::LockDigest#lock_prefix (method)">#lock_prefix</a></span>.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#default_worker_options-instance_method" title="#default_worker_options (instance method)">#<strong>default_worker_options</strong> &#x21d2; Hash&lt;Symbol, Object&gt; </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="SidekiqWorkerMethods.html#default_worker_options-instance_method" title="SidekiqUniqueJobs::SidekiqWorkerMethods#default_worker_options (method)">SidekiqWorkerMethods</a></span>
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Returns the default worker options from Sidekiq.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#digestable_hash-instance_method" title="#digestable_hash (instance method)">#<strong>digestable_hash</strong> &#x21d2; Hash </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Filter a hash to use for digest.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(item) &#x21d2; LockDigest </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class="note title constructor">constructor</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>A new instance of LockDigest.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#lock_digest-instance_method" title="#lock_digest (instance method)">#<strong>lock_digest</strong> &#x21d2; String </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Memoized lock_digest.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#log_debug-instance_method" title="#log_debug (instance method)">#<strong>log_debug</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } &#x21d2; void </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="Logging.html#log_debug-instance_method" title="SidekiqUniqueJobs::Logging#log_debug (method)">Logging</a></span>
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Logs a message at debug level.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#log_error-instance_method" title="#log_error (instance method)">#<strong>log_error</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } &#x21d2; void </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="Logging.html#log_error-instance_method" title="SidekiqUniqueJobs::Logging#log_error (method)">Logging</a></span>
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Logs a message at error level.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#log_fatal-instance_method" title="#log_fatal (instance method)">#<strong>log_fatal</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } &#x21d2; void </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="Logging.html#log_fatal-instance_method" title="SidekiqUniqueJobs::Logging#log_fatal (method)">Logging</a></span>
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Logs a message at fatal level.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#log_info-instance_method" title="#log_info (instance method)">#<strong>log_info</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } &#x21d2; void </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="Logging.html#log_info-instance_method" title="SidekiqUniqueJobs::Logging#log_info (method)">Logging</a></span>
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Logs a message at info level.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#log_warn-instance_method" title="#log_warn (instance method)">#<strong>log_warn</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } &#x21d2; void </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="Logging.html#log_warn-instance_method" title="SidekiqUniqueJobs::Logging#log_warn (method)">Logging</a></span>
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Logs a message at warn level.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#logger-instance_method" title="#logger (instance method)">#<strong>logger</strong> &#x21d2; Logger </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="Logging.html#logger-instance_method" title="SidekiqUniqueJobs::Logging#logger (method)">Logging</a></span>
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>A convenience method for using the configured gem logger.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#logging_context-instance_method" title="#logging_context (instance method)">#<strong>logging_context</strong> &#x21d2; Hash </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="Logging.html#logging_context-instance_method" title="SidekiqUniqueJobs::Logging#logging_context (method)">Logging</a></span>
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Setup some variables to add to each log line.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#sidekiq_worker_class%3F-instance_method" title="#sidekiq_worker_class? (instance method)">#<strong>sidekiq_worker_class?</strong> &#x21d2; true, false </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="SidekiqWorkerMethods.html#sidekiq_worker_class%3F-instance_method" title="SidekiqUniqueJobs::SidekiqWorkerMethods#sidekiq_worker_class? (method)">SidekiqWorkerMethods</a></span>
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Tests that the.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#unique_across_queues%3F-instance_method" title="#unique_across_queues? (instance method)">#<strong>unique_across_queues?</strong> &#x21d2; true, false </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Checks if we should disregard the queue when creating the unique digest.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#unique_across_workers%3F-instance_method" title="#unique_across_workers? (instance method)">#<strong>unique_across_workers?</strong> &#x21d2; true, false </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Checks if we should disregard the worker when creating the unique digest.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#with_configured_loggers_context-instance_method" title="#with_configured_loggers_context (instance method)">#<strong>with_configured_loggers_context</strong> { ... } &#x21d2; void </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="Logging.html#with_configured_loggers_context-instance_method" title="SidekiqUniqueJobs::Logging#with_configured_loggers_context (method)">Logging</a></span>
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Attempt to setup context aware logging for the given logger.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#with_logging_context-instance_method" title="#with_logging_context (instance method)">#<strong>with_logging_context</strong> &#x21d2; void </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="Logging.html#with_logging_context-instance_method" title="SidekiqUniqueJobs::Logging#with_logging_context (method)">Logging</a></span>
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Wraps the middleware logic with context aware logging.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#worker_class-instance_method" title="#worker_class (instance method)">#<strong>worker_class</strong> &#x21d2; Sidekiq::Worker </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="SidekiqWorkerMethods.html#worker_class-instance_method" title="SidekiqUniqueJobs::SidekiqWorkerMethods#worker_class (method)">SidekiqWorkerMethods</a></span>
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>The Sidekiq::Worker implementation.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#worker_class_constantize-instance_method" title="#worker_class_constantize (instance method)">#<strong>worker_class_constantize</strong>(klazz = @worker_class) &#x21d2; Sidekiq::Worker </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="SidekiqWorkerMethods.html#worker_class_constantize-instance_method" title="SidekiqUniqueJobs::SidekiqWorkerMethods#worker_class_constantize (method)">SidekiqWorkerMethods</a></span>
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Attempt to constantize a string worker_class argument, always failing back to the original argument when the constant can&#39;t be found.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#worker_method_defined%3F-instance_method" title="#worker_method_defined? (instance method)">#<strong>worker_method_defined?</strong>(method_sym) &#x21d2; true, false </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="SidekiqWorkerMethods.html#worker_method_defined%3F-instance_method" title="SidekiqUniqueJobs::SidekiqWorkerMethods#worker_method_defined? (method)">SidekiqWorkerMethods</a></span>
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Avoids duplicating worker_class.respond_to? in multiple places.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
<li class="public ">
<span class="summary_signature">
Unexpected trailing spaces found.
<a href="#worker_options-instance_method" title="#worker_options (instance method)">#<strong>worker_options</strong> &#x21d2; Hash </a>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</span>
Unexpected trailing spaces found.
<span class="note title not_defined_here">
included
from <span class='object_link'><a href="SidekiqWorkerMethods.html#worker_options-instance_method" title="SidekiqUniqueJobs::SidekiqWorkerMethods#worker_options (method)">SidekiqWorkerMethods</a></span>
</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="summary_desc"><div class='inline'><p>Wraps #get_sidekiq_options to always work with a hash.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
</ul>
Unexpected trailing spaces found.
 
 
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
Unexpected trailing spaces found.
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>initialize</strong>(item) &#x21d2; <tt><span class='object_link'><a href="" title="SidekiqUniqueJobs::LockDigest (class)">LockDigest</a></span></tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of LockDigest.</p>
 
 
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
<span class='name'>item</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>a Sidekiq job hash</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
 
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
 
 
38
39
40
41
42
43</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock_digest.rb', line 38</span>
 
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span>
<span class='ivar'>@item</span> <span class='op'>=</span> <span class='id identifier rubyid_item'>item</span>
<span class='ivar'>@worker_class</span> <span class='op'>=</span> <span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="../SidekiqUniqueJobs.html#CLASS-constant" title="SidekiqUniqueJobs::CLASS (constant)">CLASS</a></span></span><span class='rbracket'>]</span>
TODO found
<span class='ivar'>@lock_args</span> <span class='op'>=</span> <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_slice'>slice</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../SidekiqUniqueJobs.html#LOCK_ARGS-constant" title="SidekiqUniqueJobs::LOCK_ARGS (constant)">LOCK_ARGS</a></span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../SidekiqUniqueJobs.html#UNIQUE_ARGS-constant" title="SidekiqUniqueJobs::UNIQUE_ARGS (constant)">UNIQUE_ARGS</a></span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span> <span class='comment'># TODO: Deprecate UNIQUE_ARGS
TODO found
</span> <span class='ivar'>@lock_prefix</span> <span class='op'>=</span> <span class='id identifier rubyid_item'>item</span><span class='period'>.</span><span class='id identifier rubyid_slice'>slice</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../SidekiqUniqueJobs.html#LOCK_PREFIX-constant" title="SidekiqUniqueJobs::LOCK_PREFIX (constant)">LOCK_PREFIX</a></span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../SidekiqUniqueJobs.html#UNIQUE_PREFIX-constant" title="SidekiqUniqueJobs::UNIQUE_PREFIX (constant)">UNIQUE_PREFIX</a></span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_values'>values</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span> <span class='comment'># TODO: Deprecate UNIQUE_PREFIX
</span><span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
Unexpected trailing spaces found.
</div>
 
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="args-instance_method">
Unexpected trailing spaces found.
#<strong>args</strong> &#x21d2; <tt>String</tt> <span class="extras">(readonly)</span>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>Returns the prefix for the unique key.</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
<p class="tag_title">Returns:</p>
<ul class="return">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>String</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>the prefix for the unique key</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
 
 
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock_digest.rb', line 31</span>
 
<span class='id identifier rubyid_attr_reader'>attr_reader</span> <span class='symbol'>:lock_args</span></pre>
</td>
</tr>
</table>
</div>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="item-instance_method">
Unexpected trailing spaces found.
#<strong>item</strong> &#x21d2; <tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt> <span class="extras">(readonly)</span>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>The sidekiq job hash</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
<p class="tag_title">Returns:</p>
<ul class="return">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>the Sidekiq job hash</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
 
 
27
28
29</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock_digest.rb', line 27</span>
 
<span class='kw'>def</span> <span class='id identifier rubyid_item'>item</span>
<span class='ivar'>@item</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="lock_args-instance_method">
Unexpected trailing spaces found.
#<strong>lock_args</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute lock_args.</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
 
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
 
 
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock_digest.rb', line 31</span>
 
<span class='kw'>def</span> <span class='id identifier rubyid_lock_args'>lock_args</span>
<span class='ivar'>@lock_args</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="lock_prefix-instance_method">
Unexpected trailing spaces found.
#<strong>lock_prefix</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute lock_prefix.</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
 
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
 
 
35
36
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock_digest.rb', line 35</span>
 
<span class='kw'>def</span> <span class='id identifier rubyid_lock_prefix'>lock_prefix</span>
<span class='ivar'>@lock_prefix</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
Unexpected trailing spaces found.
</div>
 
 
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
 
Unexpected trailing spaces found.
<div class="method_details first">
<h3 class="signature first" id="call-class_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
.<strong>call</strong>(item) &#x21d2; <tt>String</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>Generates a new digest</p>
 
 
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
<span class='name'>item</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>a sidekiq job hash</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
<p class="tag_title">Returns:</p>
<ul class="return">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>String</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>a unique digest for the given arguments</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
 
 
21
22
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock_digest.rb', line 21</span>
 
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_call'>call</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span>
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_item'>item</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_lock_digest'>lock_digest</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
Unexpected trailing spaces found.
</div>
 
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
 
Unexpected trailing spaces found.
<div class="method_details first">
<h3 class="signature first" id="after_unlock_hook-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>after_unlock_hook</strong> &#x21d2; <tt>Proc</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="SidekiqWorkerMethods.html#after_unlock_hook-instance_method" title="SidekiqUniqueJobs::SidekiqWorkerMethods#after_unlock_hook (method)">SidekiqWorkerMethods</a></span>
</span>
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>The hook to call after a successful unlock</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
<p class="tag_title">Returns:</p>
<ul class="return">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>Proc</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="build_message-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>build_message</strong>(message_or_exception, item = nil) &#x21d2; <tt>String</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="Logging.html#build_message-instance_method" title="SidekiqUniqueJobs::Logging#build_message (method)">Logging</a></span>
</span>
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>Build a log message</p>
 
 
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
<span class='name'>message_or_exception</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>an entry to log</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
<span class='name'>item</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<em class="default">(defaults to: <tt>nil</tt>)</em>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>the sidekiq job hash</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
<p class="tag_title">Returns:</p>
<ul class="return">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>String</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>a complete log entry</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="create_digest-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>create_digest</strong> &#x21d2; <tt>String</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>Creates a namespaced unique digest based on the <span class='object_link'><a href="#digestable_hash-instance_method" title="SidekiqUniqueJobs::LockDigest#digestable_hash (method)">#digestable_hash</a></span> and the <span class='object_link'><a href="#lock_prefix-instance_method" title="SidekiqUniqueJobs::LockDigest#lock_prefix (method)">#lock_prefix</a></span></p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
<p class="tag_title">Returns:</p>
<ul class="return">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>String</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>a unique digest</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
 
 
53
54
55
56</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock_digest.rb', line 53</span>
 
<span class='kw'>def</span> <span class='id identifier rubyid_create_digest'>create_digest</span>
<span class='id identifier rubyid_digest'>digest</span> <span class='op'>=</span> <span class='const'>OpenSSL</span><span class='op'>::</span><span class='const'>Digest</span><span class='op'>::</span><span class='const'>MD5</span><span class='period'>.</span><span class='id identifier rubyid_hexdigest'>hexdigest</span><span class='lparen'>(</span><span class='id identifier rubyid_dump_json'>dump_json</span><span class='lparen'>(</span><span class='id identifier rubyid_digestable_hash'>digestable_hash</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_lock_prefix'>lock_prefix</span><span class='embexpr_end'>}</span><span class='tstring_content'>:</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_digest'>digest</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="default_worker_options-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>default_worker_options</strong> &#x21d2; <tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span>&lt;Symbol, Object&gt;</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="SidekiqWorkerMethods.html#default_worker_options-instance_method" title="SidekiqUniqueJobs::SidekiqWorkerMethods#default_worker_options (method)">SidekiqWorkerMethods</a></span>
</span>
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>Returns the default worker options from Sidekiq</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
<p class="tag_title">Returns:</p>
<ul class="return">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span>&lt;Symbol, Object&gt;</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="digestable_hash-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>digestable_hash</strong> &#x21d2; <tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>Filter a hash to use for digest</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
<p class="tag_title">Returns:</p>
<ul class="return">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>to use for digest</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
 
 
60
61
62
63
64
65</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock_digest.rb', line 60</span>
 
<span class='kw'>def</span> <span class='id identifier rubyid_digestable_hash'>digestable_hash</span>
<span class='ivar'>@item</span><span class='period'>.</span><span class='id identifier rubyid_slice'>slice</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../SidekiqUniqueJobs.html#CLASS-constant" title="SidekiqUniqueJobs::CLASS (constant)">CLASS</a></span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../SidekiqUniqueJobs.html#QUEUE-constant" title="SidekiqUniqueJobs::QUEUE (constant)">QUEUE</a></span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../SidekiqUniqueJobs.html#LOCK_ARGS-constant" title="SidekiqUniqueJobs::LOCK_ARGS (constant)">LOCK_ARGS</a></span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../SidekiqUniqueJobs.html#APARTMENT-constant" title="SidekiqUniqueJobs::APARTMENT (constant)">APARTMENT</a></span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_hash'>hash</span><span class='op'>|</span>
<span class='id identifier rubyid_hash'>hash</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../SidekiqUniqueJobs.html#QUEUE-constant" title="SidekiqUniqueJobs::QUEUE (constant)">QUEUE</a></span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_unique_across_queues?'>unique_across_queues?</span>
<span class='id identifier rubyid_hash'>hash</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../SidekiqUniqueJobs.html#CLASS-constant" title="SidekiqUniqueJobs::CLASS (constant)">CLASS</a></span></span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_unique_across_workers?'>unique_across_workers?</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="lock_digest-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>lock_digest</strong> &#x21d2; <tt>String</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>Memoized lock_digest</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
<p class="tag_title">Returns:</p>
<ul class="return">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>String</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>a unique digest</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
 
 
47
48
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock_digest.rb', line 47</span>
 
<span class='kw'>def</span> <span class='id identifier rubyid_lock_digest'>lock_digest</span>
<span class='ivar'>@lock_digest</span> <span class='op'>||=</span> <span class='id identifier rubyid_create_digest'>create_digest</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="log_debug-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>log_debug</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } &#x21d2; <tt>void</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="Logging.html#log_debug-instance_method" title="SidekiqUniqueJobs::Logging#log_debug (method)">Logging</a></span>
</span>
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Logs a message at debug level</p>
 
 
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
<span class='name'>message_or_exception</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<em class="default">(defaults to: <tt>nil</tt>)</em>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>the message or exception to log</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
<p class="tag_title">Yields:</p>
<ul class="yield">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>the message or exception to use for log message</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="log_error-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>log_error</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } &#x21d2; <tt>void</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="Logging.html#log_error-instance_method" title="SidekiqUniqueJobs::Logging#log_error (method)">Logging</a></span>
</span>
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Logs a message at error level</p>
 
 
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
<span class='name'>message_or_exception</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<em class="default">(defaults to: <tt>nil</tt>)</em>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>the message or exception to log</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
<p class="tag_title">Yields:</p>
<ul class="yield">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>the message or exception to use for log message</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="log_fatal-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>log_fatal</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } &#x21d2; <tt>void</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="Logging.html#log_fatal-instance_method" title="SidekiqUniqueJobs::Logging#log_fatal (method)">Logging</a></span>
</span>
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Logs a message at fatal level</p>
 
 
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
<span class='name'>message_or_exception</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<em class="default">(defaults to: <tt>nil</tt>)</em>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>the message or exception to log</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
<p class="tag_title">Yields:</p>
<ul class="yield">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>the message or exception to use for log message</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="log_info-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>log_info</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } &#x21d2; <tt>void</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="Logging.html#log_info-instance_method" title="SidekiqUniqueJobs::Logging#log_info (method)">Logging</a></span>
</span>
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Logs a message at info level</p>
 
 
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
<span class='name'>message_or_exception</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<em class="default">(defaults to: <tt>nil</tt>)</em>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>the message or exception to log</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
<p class="tag_title">Yields:</p>
<ul class="yield">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>the message or exception to use for log message</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="log_warn-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>log_warn</strong>(message_or_exception = nil, item = nil) {|String, Exception| ... } &#x21d2; <tt>void</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="Logging.html#log_warn-instance_method" title="SidekiqUniqueJobs::Logging#log_warn (method)">Logging</a></span>
</span>
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Logs a message at warn level</p>
 
 
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
<span class='name'>message_or_exception</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<em class="default">(defaults to: <tt>nil</tt>)</em>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>the message or exception to log</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
<p class="tag_title">Yields:</p>
<ul class="yield">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>String</tt>, <tt>Exception</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>the message or exception to use for log message</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="logger-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>logger</strong> &#x21d2; <tt>Logger</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="Logging.html#logger-instance_method" title="SidekiqUniqueJobs::Logging#logger (method)">Logging</a></span>
</span>
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>A convenience method for using the configured gem logger</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
<p class="tag_title">Returns:</p>
<ul class="return">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>Logger</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
<p class="tag_title">See Also:</p>
<ul class="see">
Unexpected trailing spaces found.
<li>SidekiqUniqueJobs#.logger</li>
Unexpected trailing spaces found.
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="logging_context-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>logging_context</strong> &#x21d2; <tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="Logging.html#logging_context-instance_method" title="SidekiqUniqueJobs::Logging#logging_context (method)">Logging</a></span>
</span>
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>Setup some variables to add to each log line</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
<p class="tag_title">Returns:</p>
<ul class="return">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>the context to use for each log line</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
<p class="tag_title">Raises:</p>
<ul class="raise">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>NotImplementedError</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="sidekiq_worker_class?-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>sidekiq_worker_class?</strong> &#x21d2; <tt>true</tt>, <tt>false</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="SidekiqWorkerMethods.html#sidekiq_worker_class%3F-instance_method" title="SidekiqUniqueJobs::SidekiqWorkerMethods#sidekiq_worker_class? (method)">SidekiqWorkerMethods</a></span>
</span>
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>Tests that the</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
<p class="tag_title">Returns:</p>
<ul class="return">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>true</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>if worker_class responds to get_sidekiq_options</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>false</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>if worker_class does not respond to get_sidekiq_options</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="unique_across_queues?-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>unique_across_queues?</strong> &#x21d2; <tt>true</tt>, <tt>false</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>Checks if we should disregard the queue when creating the unique digest</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
<p class="tag_title">Returns:</p>
<ul class="return">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
 
 
69
70
71</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock_digest.rb', line 69</span>
 
<span class='kw'>def</span> <span class='id identifier rubyid_unique_across_queues?'>unique_across_queues?</span>
<span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="../SidekiqUniqueJobs.html#UNIQUE_ACROSS_QUEUES-constant" title="SidekiqUniqueJobs::UNIQUE_ACROSS_QUEUES (constant)">UNIQUE_ACROSS_QUEUES</a></span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_worker_options'>worker_options</span><span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="../SidekiqUniqueJobs.html#UNIQUE_ACROSS_QUEUES-constant" title="SidekiqUniqueJobs::UNIQUE_ACROSS_QUEUES (constant)">UNIQUE_ACROSS_QUEUES</a></span></span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="unique_across_workers?-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>unique_across_workers?</strong> &#x21d2; <tt>true</tt>, <tt>false</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>Checks if we should disregard the worker when creating the unique digest</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
<p class="tag_title">Returns:</p>
<ul class="return">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
 
 
75
76
77</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/lock_digest.rb', line 75</span>
 
<span class='kw'>def</span> <span class='id identifier rubyid_unique_across_workers?'>unique_across_workers?</span>
<span class='id identifier rubyid_item'>item</span><span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="../SidekiqUniqueJobs.html#UNIQUE_ACROSS_WORKERS-constant" title="SidekiqUniqueJobs::UNIQUE_ACROSS_WORKERS (constant)">UNIQUE_ACROSS_WORKERS</a></span></span><span class='rbracket'>]</span> <span class='op'>||</span> <span class='id identifier rubyid_worker_options'>worker_options</span><span class='lbracket'>[</span><span class='const'><span class='object_link'><a href="../SidekiqUniqueJobs.html#UNIQUE_ACROSS_WORKERS-constant" title="SidekiqUniqueJobs::UNIQUE_ACROSS_WORKERS (constant)">UNIQUE_ACROSS_WORKERS</a></span></span><span class='rbracket'>]</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="with_configured_loggers_context-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>with_configured_loggers_context</strong> { ... } &#x21d2; <tt>void</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="Logging.html#with_configured_loggers_context-instance_method" title="SidekiqUniqueJobs::Logging#with_configured_loggers_context (method)">Logging</a></span>
</span>
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Attempt to setup context aware logging for the given logger</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
<p class="tag_title">Yields:</p>
<ul class="yield">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'></span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="with_logging_context-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>with_logging_context</strong> &#x21d2; <tt>void</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="Logging.html#with_logging_context-instance_method" title="SidekiqUniqueJobs::Logging#with_logging_context (method)">Logging</a></span>
</span>
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Wraps the middleware logic with context aware logging</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
<p class="tag_title">Yield Returns:</p>
<ul class="yieldreturn">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>void</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>yield to the middleware instance</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="worker_class-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>worker_class</strong> &#x21d2; <tt><span class='object_link'><a href="../Sidekiq/Worker.html" title="Sidekiq::Worker (module)">Sidekiq::Worker</a></span></tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="SidekiqWorkerMethods.html#worker_class-instance_method" title="SidekiqUniqueJobs::SidekiqWorkerMethods#worker_class (method)">SidekiqWorkerMethods</a></span>
</span>
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>The Sidekiq::Worker implementation</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
<p class="tag_title">Returns:</p>
<ul class="return">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt><span class='object_link'><a href="../Sidekiq/Worker.html" title="Sidekiq::Worker (module)">Sidekiq::Worker</a></span></tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="worker_class_constantize-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>worker_class_constantize</strong>(klazz = @worker_class) &#x21d2; <tt><span class='object_link'><a href="../Sidekiq/Worker.html" title="Sidekiq::Worker (module)">Sidekiq::Worker</a></span></tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="SidekiqWorkerMethods.html#worker_class_constantize-instance_method" title="SidekiqUniqueJobs::SidekiqWorkerMethods#worker_class_constantize (method)">SidekiqWorkerMethods</a></span>
</span>
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>Attempt to constantize a string worker_class argument, always
failing back to the original argument when the constant can&#39;t be found</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
<p class="tag_title">Returns:</p>
<ul class="return">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt><span class='object_link'><a href="../Sidekiq/Worker.html" title="Sidekiq::Worker (module)">Sidekiq::Worker</a></span></tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="worker_method_defined?-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>worker_method_defined?</strong>(method_sym) &#x21d2; <tt>true</tt>, <tt>false</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="SidekiqWorkerMethods.html#worker_method_defined%3F-instance_method" title="SidekiqUniqueJobs::SidekiqWorkerMethods#worker_method_defined? (method)">SidekiqWorkerMethods</a></span>
</span>
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>Avoids duplicating worker_class.respond_to? in multiple places</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
<p class="tag_title">Returns:</p>
<ul class="return">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt>true</tt>, <tt>false</tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="worker_options-instance_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
#<strong>worker_options</strong> &#x21d2; <tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<span class="not_defined_here">
Originally defined in module
<span class='object_link'><a href="SidekiqWorkerMethods.html#worker_options-instance_method" title="SidekiqUniqueJobs::SidekiqWorkerMethods#worker_options (method)">SidekiqWorkerMethods</a></span>
</span>
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p>Wraps #get_sidekiq_options to always work with a hash</p>
 
 
</div>
</div>
<div class="tags">
Unexpected trailing spaces found.
<p class="tag_title">Returns:</p>
<ul class="return">
Unexpected trailing spaces found.
<li>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
Unexpected trailing spaces found.
Unexpected trailing spaces found.
Unexpected trailing spaces found.
&mdash;
<div class='inline'><p>of the worker class sidekiq options</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
</div>
</div>
Unexpected trailing spaces found.
</div>
 
</div>
 
<div id="footer">
Generated on Mon Sep 27 15:29:08 2021 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.26 (ruby-3.0.2).
</div>
 
</div>
</body>
Expected a newline at the end of the file.
</html>