mhenrixon/sidekiq-unique-jobs

View on GitHub
doc/SidekiqUniqueJobs/Deprecation.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::Deprecation
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::Deprecation";
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 (D)</a> &raquo;
<span class='title'><span class='object_link'><a href="../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span>
Expected an indentation at 6 instead of at 5.
Unexpected trailing spaces found.
&raquo;
<span class="title">Deprecation</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::Deprecation
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::Deprecation</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.
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
<dl>
<dt>Defined in:</dt>
<dd>lib/sidekiq_unique_jobs/deprecation.rb</dd>
</dl>
Unexpected trailing spaces found.
</div>
 
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Class Deprecation provides logging of deprecations</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>
 
 
 
 
 
 
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="#muted-class_method" title="muted (class method)">.<strong>muted</strong> &#x21d2; void </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>Mute warnings from this gem in a threaded context.</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="#muted%3F-class_method" title="muted? (class method)">.<strong>muted?</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>Check if deprecation warnings have been muted.</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="#warn-class_method" title="warn (class method)">.<strong>warn</strong>(msg) &#x21d2; void </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>Warn about deprecation.</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="#warn_with_backtrace-class_method" title="warn_with_backtrace (class method)">.<strong>warn_with_backtrace</strong>(msg) &#x21d2; void </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>Warn about deprecation and provide a context.</p>
</div></span>
Unexpected trailing spaces found.
</li>
 
Unexpected trailing spaces found.
</ul>
Unexpected trailing spaces found.
 
 
 
<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="muted-class_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
.<strong>muted</strong> &#x21d2; <tt>void</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Mute warnings from this gem in a threaded context</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.
</li>
Unexpected trailing spaces found.
</ul>
 
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
 
 
17
18
19
20
21
22
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/deprecation.rb', line 17</span>
 
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_muted'>muted</span>
<span class='id identifier rubyid_orig_val'>orig_val</span> <span class='op'>=</span> <span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_current'>current</span><span class='lbracket'>[</span><span class='symbol'>:uniquejobs_mute_deprecations</span><span class='rbracket'>]</span>
<span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_current'>current</span><span class='lbracket'>[</span><span class='symbol'>:uniquejobs_mute_deprecations</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='kw'>true</span>
<span class='kw'>yield</span>
<span class='kw'>ensure</span>
<span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_current'>current</span><span class='lbracket'>[</span><span class='symbol'>:uniquejobs_mute_deprecations</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_orig_val'>orig_val</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="muted?-class_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
.<strong>muted?</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>Check if deprecation warnings have been muted</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">
 
 
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/deprecation.rb', line 31</span>
 
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_muted?'>muted?</span>
<span class='const'>Thread</span><span class='period'>.</span><span class='id identifier rubyid_current'>current</span><span class='lbracket'>[</span><span class='symbol'>:uniquejobs_mute_deprecations</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='kw'>true</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="warn-class_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
.<strong>warn</strong>(msg) &#x21d2; <tt>void</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Warn about deprecation</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'>msg</span>
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 descriptive reason for why the deprecation</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
 
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
 
 
42
43
44
45
46
47</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/deprecation.rb', line 42</span>
 
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_warn'>warn</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="SidekiqUniqueJobs::Deprecation (class)">Deprecation</a></span></span><span class='period'>.</span><span class='id identifier rubyid_muted?'><span class='object_link'><a href="#muted%3F-class_method" title="SidekiqUniqueJobs::Deprecation.muted? (method)">muted?</a></span></span>
 
<span class='id identifier rubyid_warn'>warn</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>DEPRECATION WARNING: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_msg'>msg</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
Unexpected trailing spaces found.
<div class="method_details ">
<h3 class="signature " id="warn_with_backtrace-class_method">
Unexpected trailing spaces found.
Unexpected trailing spaces found.
.<strong>warn_with_backtrace</strong>(msg) &#x21d2; <tt>void</tt>
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
 
Unexpected trailing spaces found.
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Warn about deprecation and provide a context</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'>msg</span>
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 descriptive reason for why the deprecation</p>
</div>
Unexpected trailing spaces found.
</li>
Unexpected trailing spaces found.
</ul>
 
 
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
 
 
56
57
58
59
60
61
62
63</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/deprecation.rb', line 56</span>
 
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_warn_with_backtrace'>warn_with_backtrace</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="" title="SidekiqUniqueJobs::Deprecation (class)">Deprecation</a></span></span><span class='period'>.</span><span class='id identifier rubyid_muted?'><span class='object_link'><a href="#muted%3F-class_method" title="SidekiqUniqueJobs::Deprecation.muted? (method)">muted?</a></span></span>
 
<span class='id identifier rubyid_trace'>trace</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n\nCALLED FROM:\n</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_caller'>caller</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_warn'>warn</span><span class='lparen'>(</span><span class='id identifier rubyid_msg'>msg</span> <span class='op'>+</span> <span class='id identifier rubyid_trace'>trace</span><span class='rparen'>)</span>
 
<span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
Unexpected trailing spaces found.
</div>
 
</div>
 
<div id="footer">
Generated on Mon Sep 27 15:29:07 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>