doc/SidekiqUniqueJobs/Web/Helpers.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: SidekiqUniqueJobs::Web::Helpers
— Documentation by YARD 0.9.26
</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::Web::Helpers";
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">
<a href="../../_index.html">Index (H)</a> »
<span class='title'><span class='object_link'><a href="../../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span> » <span class='title'><span class='object_link'><a href="../Web.html" title="SidekiqUniqueJobs::Web (module)">Web</a></span></span>
»
<span class="title">Helpers</span>
</div>
<div id="search">
<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>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: SidekiqUniqueJobs::Web::Helpers
</h1>
<div class="box_info">
<dl>
<dt>Extended by:</dt>
<dd><span class='object_link'><a href="" title="SidekiqUniqueJobs::Web::Helpers (module)">Helpers</a></span></dd>
</dl>
<dl>
<dt>Included in:</dt>
<dd><span class='object_link'><a href="" title="SidekiqUniqueJobs::Web::Helpers (module)">Helpers</a></span></dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/sidekiq_unique_jobs/web/helpers.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Provides view helpers for the Sidekiq::Web extension</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Author:</p>
<ul class="author">
<li>
<div class='inline'><p>Mikael Henriksson <a href="mailto:mikael@mhenrixon.com">mikael@mhenrixon.com</a></p>
</div>
</li>
</ul>
</div>
<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>
<dl class="constants">
<dt id="VIEW_PATH-constant" class="">VIEW_PATH =
<div class="docstring">
<div class="discussion">
<p>Returns the path to gem specific views.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>the path to gem specific views</p>
</div>
</li>
</ul>
</div>
</dt>
<dd><pre class="code"><span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_expand_path'>expand_path</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>../web/views</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id identifier rubyid___dir__'>__dir__</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
<dt id="SAFE_CPARAMS-constant" class="">SAFE_CPARAMS =
<div class="docstring">
<div class="discussion">
<p>Returns safe params.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../../Array.html" title="Array (class)">Array</a></span><String></tt>)</span>
—
<div class='inline'><p>safe params</p>
</div>
</li>
</ul>
</div>
</dt>
<dd><pre class="code"><span class='qwords_beg'>%w[</span><span class='words_sep'>
</span><span class='tstring_content'>filter</span><span class='words_sep'> </span><span class='tstring_content'>count</span><span class='words_sep'> </span><span class='tstring_content'>cursor</span><span class='words_sep'> </span><span class='tstring_content'>prev_cursor</span><span class='words_sep'> </span><span class='tstring_content'>poll</span><span class='words_sep'> </span><span class='tstring_content'>direction</span><span class='words_sep'>
</span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
</dl>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#changelog-class_method" title="#changelog (class method)">.<strong>changelog</strong> ⇒ SidekiqUniqueJobs::Digests </a>
</span>
<span class="summary_desc"><div class='inline'><p>The collection of changelog entries.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#cparams-class_method" title="#cparams (class method)">.<strong>cparams</strong>(options) ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Creates url safe parameters.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#digests-class_method" title="#digests (class method)">.<strong>digests</strong> ⇒ SidekiqUniqueJobs::Digests </a>
</span>
<span class="summary_desc"><div class='inline'><p>The collection of digests.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#display_lock_args-class_method" title="#display_lock_args (class method)">.<strong>display_lock_args</strong>(args, truncate_after_chars = 2000) ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Used to avoid incompatibility with older sidekiq versions.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#parse_time-class_method" title="#parse_time (class method)">.<strong>parse_time</strong>(time) ⇒ Time </a>
</span>
<span class="summary_desc"><div class='inline'><p>Constructs a time from a number of different types.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#redirect_to-class_method" title="#redirect_to (class method)">.<strong>redirect_to</strong>(subpath) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Redirect to with falback.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#relative_time-class_method" title="#relative_time (class method)">.<strong>relative_time</strong>(time) ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Gets a relative time as html.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#safe_relative_time-class_method" title="#safe_relative_time (class method)">.<strong>safe_relative_time</strong>(time) ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Gets a relative time as html without crashing.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#unique_filename-class_method" title="#unique_filename (class method)">.<strong>unique_filename</strong>(name) ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Construct template file name.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#unique_template-class_method" title="#unique_template (class method)">.<strong>unique_template</strong>(name) ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Opens a template file contained within this gem.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#changelog-instance_method" title="#changelog (instance method)">#<strong>changelog</strong> ⇒ SidekiqUniqueJobs::Digests </a>
</span>
<span class="summary_desc"><div class='inline'><p>The collection of changelog entries.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#cparams-instance_method" title="#cparams (instance method)">#<strong>cparams</strong>(options) ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Creates url safe parameters.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#digests-instance_method" title="#digests (instance method)">#<strong>digests</strong> ⇒ SidekiqUniqueJobs::Digests </a>
</span>
<span class="summary_desc"><div class='inline'><p>The collection of digests.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#display_lock_args-instance_method" title="#display_lock_args (instance method)">#<strong>display_lock_args</strong>(args, truncate_after_chars = 2000) ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Used to avoid incompatibility with older sidekiq versions.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#parse_time-instance_method" title="#parse_time (instance method)">#<strong>parse_time</strong>(time) ⇒ Time </a>
</span>
<span class="summary_desc"><div class='inline'><p>Constructs a time from a number of different types.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#redirect_to-instance_method" title="#redirect_to (instance method)">#<strong>redirect_to</strong>(subpath) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Redirect to with falback.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#relative_time-instance_method" title="#relative_time (instance method)">#<strong>relative_time</strong>(time) ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Gets a relative time as html.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#safe_relative_time-instance_method" title="#safe_relative_time (instance method)">#<strong>safe_relative_time</strong>(time) ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Gets a relative time as html without crashing.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#unique_filename-instance_method" title="#unique_filename (instance method)">#<strong>unique_filename</strong>(name) ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Construct template file name.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#unique_template-instance_method" title="#unique_template (instance method)">#<strong>unique_template</strong>(name) ⇒ String </a>
</span>
<span class="summary_desc"><div class='inline'><p>Opens a template file contained within this gem.</p>
</div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="changelog-class_method">
.<strong>changelog</strong> ⇒ <tt><span class='object_link'><a href="../Digests.html" title="SidekiqUniqueJobs::Digests (class)">SidekiqUniqueJobs::Digests</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>The collection of changelog entries</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Digests.html" title="SidekiqUniqueJobs::Digests (class)">SidekiqUniqueJobs::Digests</a></span></tt>)</span>
—
<div class='inline'><p>the sorted set with digests</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
60
61
62</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/web/helpers.rb', line 60</span>
<span class='kw'>def</span> <span class='id identifier rubyid_changelog'>changelog</span>
<span class='ivar'>@changelog</span> <span class='op'>||=</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="../Changelog.html" title="SidekiqUniqueJobs::Changelog (class)">Changelog</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Changelog.html#initialize-instance_method" title="SidekiqUniqueJobs::Changelog#initialize (method)">new</a></span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="cparams-class_method">
.<strong>cparams</strong>(options) ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Creates url safe parameters</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>options</span>
<span class='type'>(<tt><span class='object_link'><a href="../../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>the key/value to parameterize</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>a url safe parameter string</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
71
72
73
74
75
76
77
78</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/web/helpers.rb', line 71</span>
<span class='kw'>def</span> <span class='id identifier rubyid_cparams'>cparams</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='id identifier rubyid_stringified_options'>stringified_options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_transform_keys'>transform_keys</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:to_s</span><span class='rparen'>)</span>
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_stringified_options'>stringified_options</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
<span class='kw'>next</span> <span class='kw'>unless</span> <span class='const'><span class='object_link'><a href="#SAFE_CPARAMS-constant" title="SidekiqUniqueJobs::Web::Helpers::SAFE_CPARAMS (constant)">SAFE_CPARAMS</a></span></span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='embexpr_beg'>#{</span><span class='const'>CGI</span><span class='period'>.</span><span class='id identifier rubyid_escape'>escape</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>&</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="digests-class_method">
.<strong>digests</strong> ⇒ <tt><span class='object_link'><a href="../Digests.html" title="SidekiqUniqueJobs::Digests (class)">SidekiqUniqueJobs::Digests</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>The collection of digests</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Digests.html" title="SidekiqUniqueJobs::Digests (class)">SidekiqUniqueJobs::Digests</a></span></tt>)</span>
—
<div class='inline'><p>the sorted set with digests</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
50
51
52</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/web/helpers.rb', line 50</span>
<span class='kw'>def</span> <span class='id identifier rubyid_digests'>digests</span>
<span class='ivar'>@digests</span> <span class='op'>||=</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="../Digests.html" title="SidekiqUniqueJobs::Digests (class)">Digests</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Digests.html#initialize-instance_method" title="SidekiqUniqueJobs::Digests#initialize (method)">new</a></span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="display_lock_args-class_method">
.<strong>display_lock_args</strong>(args, truncate_after_chars = 2000) ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Used to avoid incompatibility with older sidekiq versions</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>args</span>
<span class='type'>(<tt><span class='object_link'><a href="../../Array.html" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>the unique arguments to display</p>
</div>
</li>
<li>
<span class='name'>truncate_after_chars</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>2000</tt>)</em>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>a string containing all non-truncated arguments</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
89
90
91
92
93
94
95
96
97
98
99
100</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/web/helpers.rb', line 89</span>
<span class='kw'>def</span> <span class='id identifier rubyid_display_lock_args'>display_lock_args</span><span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='id identifier rubyid_truncate_after_chars'>truncate_after_chars</span> <span class='op'>=</span> <span class='int'>2000</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Invalid job payload, args is nil</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>return</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Invalid job payload, args must be an Array, not </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Array.html" title="Array (class)">Array</a></span></span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_arg'>arg</span><span class='op'>|</span>
<span class='id identifier rubyid_h'>h</span><span class='lparen'>(</span><span class='id identifier rubyid_truncate'>truncate</span><span class='lparen'>(</span><span class='id identifier rubyid_to_display'>to_display</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_truncate_after_chars'>truncate_after_chars</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>, </span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>rescue</span> <span class='const'>StandardError</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Illegal job arguments: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_h'>h</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="parse_time-class_method">
.<strong>parse_time</strong>(time) ⇒ <tt>Time</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Constructs a time from a number of different types</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>time</span>
<span class='type'>(<tt>Float</tt>, <tt>Integer</tt>, <tt>String</tt>, <tt>Time</tt>)</span>
—
<div class='inline'><p>a representation of a timestamp</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Time</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
151
152
153
154
155
156
157
158
159
160</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/web/helpers.rb', line 151</span>
<span class='kw'>def</span> <span class='id identifier rubyid_parse_time'>parse_time</span><span class='lparen'>(</span><span class='id identifier rubyid_time'>time</span><span class='rparen'>)</span>
<span class='kw'>case</span> <span class='id identifier rubyid_time'>time</span>
<span class='kw'>when</span> <span class='const'>Time</span>
<span class='id identifier rubyid_time'>time</span>
<span class='kw'>when</span> <span class='const'>Integer</span><span class='comma'>,</span> <span class='const'>Float</span>
<span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_at'>at</span><span class='lparen'>(</span><span class='id identifier rubyid_time'>time</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_time'>time</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="redirect_to-class_method">
.<strong>redirect_to</strong>(subpath) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Redirect to with falback</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>subpath</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>the path to redirect to</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>a redirect to the new subpath</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
109
110
111
112
113
114
115
116
117</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/web/helpers.rb', line 109</span>
<span class='kw'>def</span> <span class='id identifier rubyid_redirect_to'>redirect_to</span><span class='lparen'>(</span><span class='id identifier rubyid_subpath'>subpath</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:to</span><span class='rparen'>)</span>
<span class='comment'># Sinatra-based web UI
</span> <span class='id identifier rubyid_redirect'>redirect</span> <span class='id identifier rubyid_to'>to</span><span class='lparen'>(</span><span class='id identifier rubyid_subpath'>subpath</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='comment'># Non-Sinatra based web UI (Sidekiq 4.2+)
</span> <span class='id identifier rubyid_redirect'>redirect</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_root_path'>root_path</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_subpath'>subpath</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="relative_time-class_method">
.<strong>relative_time</strong>(time) ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Gets a relative time as html</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>time</span>
<span class='type'>(<tt>Time</tt>)</span>
—
<div class='inline'><p>an instance of Time</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>a html safe string with relative time information</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
126
127
128
129</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/web/helpers.rb', line 126</span>
<span class='kw'>def</span> <span class='id identifier rubyid_relative_time'>relative_time</span><span class='lparen'>(</span><span class='id identifier rubyid_time'>time</span><span class='rparen'>)</span>
<span class='id identifier rubyid_stamp'>stamp</span> <span class='op'>=</span> <span class='id identifier rubyid_time'>time</span><span class='period'>.</span><span class='id identifier rubyid_getutc'>getutc</span><span class='period'>.</span><span class='id identifier rubyid_iso8601'>iso8601</span>
<span class='tstring'><span class='tstring_beg'>%(</span><span class='tstring_content'><time class="ltr" dir="ltr" title="</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_stamp'>stamp</span><span class='embexpr_end'>}</span><span class='tstring_content'>" datetime="</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_stamp'>stamp</span><span class='embexpr_end'>}</span><span class='tstring_content'>"></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_time'>time</span><span class='embexpr_end'>}</span><span class='tstring_content'></time></span><span class='tstring_end'>)</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="safe_relative_time-class_method">
.<strong>safe_relative_time</strong>(time) ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Gets a relative time as html without crashing</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>time</span>
<span class='type'>(<tt>Float</tt>, <tt>Integer</tt>, <tt>String</tt>, <tt>Time</tt>)</span>
—
<div class='inline'><p>a representation of a timestamp</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>a html safe string with relative time information</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
138
139
140
141
142</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/web/helpers.rb', line 138</span>
<span class='kw'>def</span> <span class='id identifier rubyid_safe_relative_time'>safe_relative_time</span><span class='lparen'>(</span><span class='id identifier rubyid_time'>time</span><span class='rparen'>)</span>
<span class='id identifier rubyid_time'>time</span> <span class='op'>=</span> <span class='id identifier rubyid_parse_time'>parse_time</span><span class='lparen'>(</span><span class='id identifier rubyid_time'>time</span><span class='rparen'>)</span>
<span class='id identifier rubyid_relative_time'>relative_time</span><span class='lparen'>(</span><span class='id identifier rubyid_time'>time</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="unique_filename-class_method">
.<strong>unique_filename</strong>(name) ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Construct template file name</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'><p>the name of the template</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>the full name of the file</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
40
41
42</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/web/helpers.rb', line 40</span>
<span class='kw'>def</span> <span class='id identifier rubyid_unique_filename'>unique_filename</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#VIEW_PATH-constant" title="SidekiqUniqueJobs::Web::Helpers::VIEW_PATH (constant)">VIEW_PATH</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>.erb</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="unique_template-class_method">
.<strong>unique_template</strong>(name) ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Opens a template file contained within this gem</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'><p>the name of the template</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>the file contents of the template</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
29
30
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/web/helpers.rb', line 29</span>
<span class='kw'>def</span> <span class='id identifier rubyid_unique_template'>unique_template</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_unique_filename'>unique_filename</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="changelog-instance_method">
#<strong>changelog</strong> ⇒ <tt><span class='object_link'><a href="../Digests.html" title="SidekiqUniqueJobs::Digests (class)">SidekiqUniqueJobs::Digests</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>The collection of changelog entries</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Digests.html" title="SidekiqUniqueJobs::Digests (class)">SidekiqUniqueJobs::Digests</a></span></tt>)</span>
—
<div class='inline'><p>the sorted set with digests</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
60
61
62</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/web/helpers.rb', line 60</span>
<span class='kw'>def</span> <span class='id identifier rubyid_changelog'>changelog</span>
<span class='ivar'>@changelog</span> <span class='op'>||=</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="../Changelog.html" title="SidekiqUniqueJobs::Changelog (class)">Changelog</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Changelog.html#initialize-instance_method" title="SidekiqUniqueJobs::Changelog#initialize (method)">new</a></span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="cparams-instance_method">
#<strong>cparams</strong>(options) ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Creates url safe parameters</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>options</span>
<span class='type'>(<tt><span class='object_link'><a href="../../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
—
<div class='inline'><p>the key/value to parameterize</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>a url safe parameter string</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
71
72
73
74
75
76
77
78</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/web/helpers.rb', line 71</span>
<span class='kw'>def</span> <span class='id identifier rubyid_cparams'>cparams</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='id identifier rubyid_stringified_options'>stringified_options</span> <span class='op'>=</span> <span class='id identifier rubyid_options'>options</span><span class='period'>.</span><span class='id identifier rubyid_transform_keys'>transform_keys</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:to_s</span><span class='rparen'>)</span>
<span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span><span class='lparen'>(</span><span class='id identifier rubyid_stringified_options'>stringified_options</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='op'>|</span>
<span class='kw'>next</span> <span class='kw'>unless</span> <span class='const'><span class='object_link'><a href="#SAFE_CPARAMS-constant" title="SidekiqUniqueJobs::Web::Helpers::SAFE_CPARAMS (constant)">SAFE_CPARAMS</a></span></span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_key'>key</span><span class='embexpr_end'>}</span><span class='tstring_content'>=</span><span class='embexpr_beg'>#{</span><span class='const'>CGI</span><span class='period'>.</span><span class='id identifier rubyid_escape'>escape</span><span class='lparen'>(</span><span class='id identifier rubyid_value'>value</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>&</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="digests-instance_method">
#<strong>digests</strong> ⇒ <tt><span class='object_link'><a href="../Digests.html" title="SidekiqUniqueJobs::Digests (class)">SidekiqUniqueJobs::Digests</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>The collection of digests</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt><span class='object_link'><a href="../Digests.html" title="SidekiqUniqueJobs::Digests (class)">SidekiqUniqueJobs::Digests</a></span></tt>)</span>
—
<div class='inline'><p>the sorted set with digests</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
50
51
52</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/web/helpers.rb', line 50</span>
<span class='kw'>def</span> <span class='id identifier rubyid_digests'>digests</span>
<span class='ivar'>@digests</span> <span class='op'>||=</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="../Digests.html" title="SidekiqUniqueJobs::Digests (class)">Digests</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Digests.html#initialize-instance_method" title="SidekiqUniqueJobs::Digests#initialize (method)">new</a></span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="display_lock_args-instance_method">
#<strong>display_lock_args</strong>(args, truncate_after_chars = 2000) ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Used to avoid incompatibility with older sidekiq versions</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>args</span>
<span class='type'>(<tt><span class='object_link'><a href="../../Array.html" title="Array (class)">Array</a></span></tt>)</span>
—
<div class='inline'><p>the unique arguments to display</p>
</div>
</li>
<li>
<span class='name'>truncate_after_chars</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>2000</tt>)</em>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>a string containing all non-truncated arguments</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
89
90
91
92
93
94
95
96
97
98
99
100</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/web/helpers.rb', line 89</span>
<span class='kw'>def</span> <span class='id identifier rubyid_display_lock_args'>display_lock_args</span><span class='lparen'>(</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='id identifier rubyid_truncate_after_chars'>truncate_after_chars</span> <span class='op'>=</span> <span class='int'>2000</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Invalid job payload, args is nil</span><span class='tstring_end'>"</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>return</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Invalid job payload, args must be an Array, not </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../Array.html" title="Array (class)">Array</a></span></span><span class='rparen'>)</span>
<span class='kw'>begin</span>
<span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_arg'>arg</span><span class='op'>|</span>
<span class='id identifier rubyid_h'>h</span><span class='lparen'>(</span><span class='id identifier rubyid_truncate'>truncate</span><span class='lparen'>(</span><span class='id identifier rubyid_to_display'>to_display</span><span class='lparen'>(</span><span class='id identifier rubyid_arg'>arg</span><span class='rparen'>)</span><span class='comma'>,</span> <span class='id identifier rubyid_truncate_after_chars'>truncate_after_chars</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>, </span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>rescue</span> <span class='const'>StandardError</span>
<span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Illegal job arguments: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_h'>h</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_inspect'>inspect</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="parse_time-instance_method">
#<strong>parse_time</strong>(time) ⇒ <tt>Time</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Constructs a time from a number of different types</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>time</span>
<span class='type'>(<tt>Float</tt>, <tt>Integer</tt>, <tt>String</tt>, <tt>Time</tt>)</span>
—
<div class='inline'><p>a representation of a timestamp</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Time</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
151
152
153
154
155
156
157
158
159
160</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/web/helpers.rb', line 151</span>
<span class='kw'>def</span> <span class='id identifier rubyid_parse_time'>parse_time</span><span class='lparen'>(</span><span class='id identifier rubyid_time'>time</span><span class='rparen'>)</span>
<span class='kw'>case</span> <span class='id identifier rubyid_time'>time</span>
<span class='kw'>when</span> <span class='const'>Time</span>
<span class='id identifier rubyid_time'>time</span>
<span class='kw'>when</span> <span class='const'>Integer</span><span class='comma'>,</span> <span class='const'>Float</span>
<span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_at'>at</span><span class='lparen'>(</span><span class='id identifier rubyid_time'>time</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='const'>Time</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='id identifier rubyid_time'>time</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="redirect_to-instance_method">
#<strong>redirect_to</strong>(subpath) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Redirect to with falback</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>subpath</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>the path to redirect to</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'><p>a redirect to the new subpath</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
109
110
111
112
113
114
115
116
117</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/web/helpers.rb', line 109</span>
<span class='kw'>def</span> <span class='id identifier rubyid_redirect_to'>redirect_to</span><span class='lparen'>(</span><span class='id identifier rubyid_subpath'>subpath</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:to</span><span class='rparen'>)</span>
<span class='comment'># Sinatra-based web UI
</span> <span class='id identifier rubyid_redirect'>redirect</span> <span class='id identifier rubyid_to'>to</span><span class='lparen'>(</span><span class='id identifier rubyid_subpath'>subpath</span><span class='rparen'>)</span>
<span class='kw'>else</span>
<span class='comment'># Non-Sinatra based web UI (Sidekiq 4.2+)
</span> <span class='id identifier rubyid_redirect'>redirect</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_root_path'>root_path</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_subpath'>subpath</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="relative_time-instance_method">
#<strong>relative_time</strong>(time) ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Gets a relative time as html</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>time</span>
<span class='type'>(<tt>Time</tt>)</span>
—
<div class='inline'><p>an instance of Time</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>a html safe string with relative time information</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
126
127
128
129</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/web/helpers.rb', line 126</span>
<span class='kw'>def</span> <span class='id identifier rubyid_relative_time'>relative_time</span><span class='lparen'>(</span><span class='id identifier rubyid_time'>time</span><span class='rparen'>)</span>
<span class='id identifier rubyid_stamp'>stamp</span> <span class='op'>=</span> <span class='id identifier rubyid_time'>time</span><span class='period'>.</span><span class='id identifier rubyid_getutc'>getutc</span><span class='period'>.</span><span class='id identifier rubyid_iso8601'>iso8601</span>
<span class='tstring'><span class='tstring_beg'>%(</span><span class='tstring_content'><time class="ltr" dir="ltr" title="</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_stamp'>stamp</span><span class='embexpr_end'>}</span><span class='tstring_content'>" datetime="</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_stamp'>stamp</span><span class='embexpr_end'>}</span><span class='tstring_content'>"></span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_time'>time</span><span class='embexpr_end'>}</span><span class='tstring_content'></time></span><span class='tstring_end'>)</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="safe_relative_time-instance_method">
#<strong>safe_relative_time</strong>(time) ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Gets a relative time as html without crashing</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>time</span>
<span class='type'>(<tt>Float</tt>, <tt>Integer</tt>, <tt>String</tt>, <tt>Time</tt>)</span>
—
<div class='inline'><p>a representation of a timestamp</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>a html safe string with relative time information</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
138
139
140
141
142</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/web/helpers.rb', line 138</span>
<span class='kw'>def</span> <span class='id identifier rubyid_safe_relative_time'>safe_relative_time</span><span class='lparen'>(</span><span class='id identifier rubyid_time'>time</span><span class='rparen'>)</span>
<span class='id identifier rubyid_time'>time</span> <span class='op'>=</span> <span class='id identifier rubyid_parse_time'>parse_time</span><span class='lparen'>(</span><span class='id identifier rubyid_time'>time</span><span class='rparen'>)</span>
<span class='id identifier rubyid_relative_time'>relative_time</span><span class='lparen'>(</span><span class='id identifier rubyid_time'>time</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="unique_filename-instance_method">
#<strong>unique_filename</strong>(name) ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Construct template file name</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'><p>the name of the template</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>the full name of the file</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
40
41
42</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/web/helpers.rb', line 40</span>
<span class='kw'>def</span> <span class='id identifier rubyid_unique_filename'>unique_filename</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_join'>join</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#VIEW_PATH-constant" title="SidekiqUniqueJobs::Web::Helpers::VIEW_PATH (constant)">VIEW_PATH</a></span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_name'>name</span><span class='embexpr_end'>}</span><span class='tstring_content'>.erb</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="unique_template-instance_method">
#<strong>unique_template</strong>(name) ⇒ <tt>String</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Opens a template file contained within this gem</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>name</span>
<span class='type'>(<tt>Symbol</tt>)</span>
—
<div class='inline'><p>the name of the template</p>
</div>
</li>
</ul>
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>the file contents of the template</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
29
30
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/web/helpers.rb', line 29</span>
<span class='kw'>def</span> <span class='id identifier rubyid_unique_template'>unique_template</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
<span class='const'>File</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='id identifier rubyid_unique_filename'>unique_filename</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_read'>read</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Sep 27 15:29:05 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>
</html>