doc/SidekiqUniqueJobs/Changelog.html
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: SidekiqUniqueJobs::Changelog
— 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::Changelog";
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 (C)</a> »
<span class='title'><span class='object_link'><a href="../SidekiqUniqueJobs.html" title="SidekiqUniqueJobs (module)">SidekiqUniqueJobs</a></span></span>
»
<span class="title">Changelog</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>Class: SidekiqUniqueJobs::Changelog
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Redis/SortedSet.html" title="SidekiqUniqueJobs::Redis::SortedSet (class)">Redis::SortedSet</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Redis/Entity.html" title="SidekiqUniqueJobs::Redis::Entity (class)">Redis::Entity</a></span></li>
<li class="next"><span class='object_link'><a href="Redis/SortedSet.html" title="SidekiqUniqueJobs::Redis::SortedSet (class)">Redis::SortedSet</a></span></li>
<li class="next">SidekiqUniqueJobs::Changelog</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/sidekiq_unique_jobs/changelog.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Class Changelogs provides access to the changelog entries</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="DEFAULT_COUNT-constant" class="">DEFAULT_COUNT =
<div class="docstring">
<div class="discussion">
<p>Returns the number of matches to return by default.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Integer</tt>)</span>
—
<div class='inline'><p>the number of matches to return by default</p>
</div>
</li>
</ul>
</div>
</dt>
<dd><pre class="code"><span class='int'>1_000</span></pre></dd>
<dt id="SCAN_PATTERN-constant" class="">SCAN_PATTERN =
<div class="docstring">
<div class="discussion">
<p>Returns the default pattern to use for matching.</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 default pattern to use for matching</p>
</div>
</li>
</ul>
</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>*</span><span class='tstring_end'>"</span></span></pre></dd>
</dl>
<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="#add-instance_method" title="#add (instance method)">#<strong>add</strong>(message:, digest:, job_id:, script:) ⇒ void </a>
</span>
<span class="summary_desc"><div class='inline'><p>Adds a new changelog entry.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#entries-instance_method" title="#entries (instance method)">#<strong>entries</strong>(pattern: SCAN_PATTERN, count: DEFAULT_COUNT) ⇒ Array<Hash> </a>
</span>
<span class="summary_desc"><div class='inline'><p>The change log entries.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong> ⇒ Changelog </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'><p>A new instance of Changelog.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#page-instance_method" title="#page (instance method)">#<strong>page</strong>(cursor: 0, pattern: "*", page_size: 100) ⇒ Array<Integer, Integer, Array<Hash>] the total size, next cursor and changelog entries </a>
</span>
<span class="summary_desc"><div class='inline'><p>Paginate the changelog entries.</p>
</div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong> ⇒ <tt><span class='object_link'><a href="" title="SidekiqUniqueJobs::Changelog (class)">Changelog</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Changelog.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
17
18
19</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/changelog.rb', line 17</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
<span class='kw'>super</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../SidekiqUniqueJobs.html#CHANGELOGS-constant" title="SidekiqUniqueJobs::CHANGELOGS (constant)">CHANGELOGS</a></span></span><span class='rparen'>)</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="add-instance_method">
#<strong>add</strong>(message:, digest:, job_id:, script:) ⇒ <tt>void</tt>
</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p><p>Adds a new changelog entry</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>message</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>a descriptive message about the entry</p>
</div>
</li>
<li>
<span class='name'>digest</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>a unique digest</p>
</div>
</li>
<li>
<span class='name'>job_id</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>a Sidekiq JID</p>
</div>
</li>
<li>
<span class='name'>script</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'><p>the name of the script adding the entry</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
31
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/changelog.rb', line 31</span>
<span class='kw'>def</span> <span class='id identifier rubyid_add'>add</span><span class='lparen'>(</span><span class='label'>message:</span><span class='comma'>,</span> <span class='label'>digest:</span><span class='comma'>,</span> <span class='label'>job_id:</span><span class='comma'>,</span> <span class='label'>script:</span><span class='rparen'>)</span>
<span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='id identifier rubyid_dump_json'>dump_json</span><span class='lparen'>(</span><span class='label'>message:</span> <span class='id identifier rubyid_message'>message</span><span class='comma'>,</span> <span class='label'>digest:</span> <span class='id identifier rubyid_digest'>digest</span><span class='comma'>,</span> <span class='label'>job_id:</span> <span class='id identifier rubyid_job_id'>job_id</span><span class='comma'>,</span> <span class='label'>script:</span> <span class='id identifier rubyid_script'>script</span><span class='rparen'>)</span>
<span class='id identifier rubyid_redis'>redis</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_conn'>conn</span><span class='op'>|</span> <span class='id identifier rubyid_conn'>conn</span><span class='period'>.</span><span class='id identifier rubyid_zadd'>zadd</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_now_f'>now_f</span><span class='comma'>,</span> <span class='id identifier rubyid_message'>message</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="entries-instance_method">
#<strong>entries</strong>(pattern: SCAN_PATTERN, count: DEFAULT_COUNT) ⇒ <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span><<span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span>></tt>
</h3><div class="docstring">
<div class="discussion">
<p>The change log entries</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>pattern</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>SCAN_PATTERN</tt>)</em>
—
<div class='inline'><p>the pattern to match</p>
</div>
</li>
<li>
<span class='name'>count</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>DEFAULT_COUNT</tt>)</em>
—
<div class='inline'><p>the number of matches to return</p>
</div>
</li>
</ul>
<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><<span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span>></tt>)</span>
—
<div class='inline'><p>an array of entries</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
44
45
46
47
48
49
50
51
52</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/changelog.rb', line 44</span>
<span class='kw'>def</span> <span class='id identifier rubyid_entries'>entries</span><span class='lparen'>(</span><span class='label'>pattern:</span> <span class='const'><span class='object_link'><a href="#SCAN_PATTERN-constant" title="SidekiqUniqueJobs::Changelog::SCAN_PATTERN (constant)">SCAN_PATTERN</a></span></span><span class='comma'>,</span> <span class='label'>count:</span> <span class='const'><span class='object_link'><a href="#DEFAULT_COUNT-constant" title="SidekiqUniqueJobs::Changelog::DEFAULT_COUNT (constant)">DEFAULT_COUNT</a></span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:match</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_pattern'>pattern</span>
<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:count</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_count'>count</span>
<span class='id identifier rubyid_redis'>redis</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_conn'>conn</span><span class='op'>|</span>
<span class='id identifier rubyid_conn'>conn</span><span class='period'>.</span><span class='id identifier rubyid_zscan_each'>zscan_each</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_a'>to_a</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_entry'>entry</span><span class='op'>|</span> <span class='id identifier rubyid_load_json'>load_json</span><span class='lparen'>(</span><span class='id identifier rubyid_entry'>entry</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='rbrace'>}</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="page-instance_method">
#<strong>page</strong>(cursor: 0, pattern: "*", page_size: 100) ⇒ <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span><Integer, Integer, <span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span><<span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span>>] the total size</tt>, <tt>next cursor and changelog <span class='object_link'><a href="#entries-instance_method" title="SidekiqUniqueJobs::Changelog#entries (method)">entries</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Paginate the changelog entries</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>cursor</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>0</tt>)</em>
—
<div class='inline'><p>the cursor for this iteration</p>
</div>
</li>
<li>
<span class='name'>pattern</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>"*"</tt>)</em>
—
<div class='inline'><p>"*" the pattern to match</p>
</div>
</li>
<li>
<span class='name'>page_size</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>100</tt>)</em>
—
<div class='inline'><p>100 the number of matches to return</p>
</div>
</li>
</ul>
<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><Integer, Integer, <span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span><<span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span>>] the total size</tt>, <tt>next cursor and changelog <span class='object_link'><a href="#entries-instance_method" title="SidekiqUniqueJobs::Changelog#entries (method)">entries</a></span></tt>)</span>
—
<div class='inline'><p>Array<Integer, Integer, Array<Hash>] the total size, next cursor and changelog entries</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
63
64
65
66
67
68
69
70
71
72
73
74
75
76</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/sidekiq_unique_jobs/changelog.rb', line 63</span>
<span class='kw'>def</span> <span class='id identifier rubyid_page'>page</span><span class='lparen'>(</span><span class='label'>cursor:</span> <span class='int'>0</span><span class='comma'>,</span> <span class='label'>pattern:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>*</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>page_size:</span> <span class='int'>100</span><span class='rparen'>)</span>
<span class='id identifier rubyid_redis'>redis</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_conn'>conn</span><span class='op'>|</span>
<span class='id identifier rubyid_total_size'>total_size</span><span class='comma'>,</span> <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='id identifier rubyid_conn'>conn</span><span class='period'>.</span><span class='id identifier rubyid_multi'>multi</span> <span class='kw'>do</span>
<span class='id identifier rubyid_conn'>conn</span><span class='period'>.</span><span class='id identifier rubyid_zcard'>zcard</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
<span class='id identifier rubyid_conn'>conn</span><span class='period'>.</span><span class='id identifier rubyid_zscan'>zscan</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_cursor'>cursor</span><span class='comma'>,</span> <span class='label'>match:</span> <span class='id identifier rubyid_pattern'>pattern</span><span class='comma'>,</span> <span class='label'>count:</span> <span class='id identifier rubyid_page_size'>page_size</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='lbracket'>[</span>
<span class='id identifier rubyid_total_size'>total_size</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='comma'>,</span>
<span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='comma'>,</span> <span class='comment'># next_cursor
</span> <span class='id identifier rubyid_result'>result</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_entry'>entry</span><span class='op'>|</span> <span class='id identifier rubyid_load_json'>load_json</span><span class='lparen'>(</span><span class='id identifier rubyid_entry'>entry</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='comma'>,</span> <span class='comment'># entries
</span> <span class='rbracket'>]</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</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>
</html>