<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Repository::Base::Internals::SlugFinder
— Documentation by YARD 0.9.12
</title>
<link rel="stylesheet" href="../../../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../../../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
pathId = "Repository::Base::Internals::SlugFinder";
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 (S)</a> »
<span class='title'><span class='object_link'><a href="../../../Repository.html" title="Repository (module)">Repository</a></span></span> » <span class='title'><span class='object_link'><a href="../../Base.html" title="Repository::Base (class)">Base</a></span></span> » <span class='title'><span class='object_link'><a href="../Internals.html" title="Repository::Base::Internals (module)">Internals</a></span></span>
»
<span class="title">SlugFinder</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: Repository::Base::Internals::SlugFinder
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Repository::Base::Internals::SlugFinder</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Includes:</dt>
<dd>Support</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/repository/base/internals/slug_finder.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Find a slug in the DAO, reporting errors if not successful.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>0.0.3</p>
</div>
</li>
</ul>
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="private ">
<span class="summary_signature">
<a href="#dao-instance_method" title="#dao (instance method)">#<strong>dao</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="note title private">private</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="private ">
<span class="summary_signature">
<a href="#factory-instance_method" title="#factory (instance method)">#<strong>factory</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="note title private">private</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="private ">
<span class="summary_signature">
<a href="#slug-instance_method" title="#slug (instance method)">#<strong>slug</strong> ⇒ Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="note title private">private</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="private ">
<span class="summary_signature">
<a href="#entity_for_slug-instance_method" title="#entity_for_slug (instance method)">#<strong>entity_for_slug</strong> ⇒ Object </a>
</span>
<span class="note title private">private</span>
<span class="summary_desc"><div class='inline'>
<p>Builds an entity from an existing DAO record matching the slug.</p>
</div></span>
</li>
<li class="private ">
<span class="summary_signature">
<a href="#errors_for_slug-instance_method" title="#errors_for_slug (instance method)">#<strong>errors_for_slug</strong> ⇒ ActiveModel::Errors </a>
</span>
<span class="note title private">private</span>
<span class="summary_desc"><div class='inline'>
<p>Builds an [`ActiveModel::Errors`](<a
href="http://api.rubyonrails.org/classes/ActiveModel/Errors.html">api.rubyonrails.org/classes/ActiveModel/Errors.html</a>)
instance and adds a slug-not-found message to it.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#find-instance_method" title="#find (instance method)">#<strong>find</strong> ⇒ Repository::Support::StoreResult </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Command-pattern method to search underlying DAO for record matching slug.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(slug:, dao:, factory:) ⇒ SlugFinder </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Initializes a new instance of `SlugFinder`.</p>
</div></span>
</li>
<li class="private ">
<span class="summary_signature">
<a href="#result_builder-instance_method" title="#result_builder (instance method)">#<strong>result_builder</strong>(record) ⇒ Object </a>
</span>
<span class="note title private">private</span>
<span class="summary_desc"><div class='inline'>
<p>Returns a new `Repository::Support::ResultBuilder` instance, passing the
parameter specified to this method as its `#initialize` parameter.</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>(slug:, dao:, factory:) ⇒ <tt><span class='object_link'><a href="" title="Repository::Base::Internals::SlugFinder (class)">SlugFinder</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Initializes a new instance of `SlugFinder`.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>slug</span>
<span class='type'>(<tt>String</tt>)</span>
—
<div class='inline'>
<p>[Slug](<a
href="http://en.wikipedia.org/wiki/Semantic_URL#Slug">en.wikipedia.org/wiki/Semantic_URL#Slug</a>)
for record to be deleted.</p>
</div>
</li>
<li>
<span class='name'>dao</span>
<span class='type'></span>
—
<div class='inline'>
<p>Data Access Object implements persistence without business logic.</p>
</div>
</li>
</ul>
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>0.0.3</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
20
21
22
23
24</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/repository/base/internals/slug_finder.rb', line 20</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>slug:</span><span class='comma'>,</span> <span class='label'>dao:</span><span class='comma'>,</span> <span class='label'>factory:</span><span class='rparen'>)</span>
<span class='ivar'>@slug</span> <span class='op'>=</span> <span class='id identifier rubyid_slug'>slug</span>
<span class='ivar'>@dao</span> <span class='op'>=</span> <span class='id identifier rubyid_dao'>dao</span>
<span class='ivar'>@factory</span> <span class='op'>=</span> <span class='id identifier rubyid_factory'>factory</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id=""></span>
<div class="method_details first">
<h3 class="signature first" id="dao-instance_method">
#<strong>dao</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly, private)</span>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>0.0.3</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
41
42
43</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/repository/base/internals/slug_finder.rb', line 41</span>
<span class='kw'>def</span> <span class='id identifier rubyid_dao'>dao</span>
<span class='ivar'>@dao</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="factory-instance_method">
#<strong>factory</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly, private)</span>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>0.0.3</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
41
42
43</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/repository/base/internals/slug_finder.rb', line 41</span>
<span class='kw'>def</span> <span class='id identifier rubyid_factory'>factory</span>
<span class='ivar'>@factory</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="slug-instance_method">
#<strong>slug</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly, private)</span>
</h3><div class="docstring">
<div class="discussion">
</div>
</div>
<div class="tags">
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>0.0.3</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
41
42
43</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/repository/base/internals/slug_finder.rb', line 41</span>
<span class='kw'>def</span> <span class='id identifier rubyid_slug'>slug</span>
<span class='ivar'>@slug</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="entity_for_slug-instance_method">
#<strong>entity_for_slug</strong> ⇒ <tt>Object</tt> <span class="extras">(private)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Builds an entity from an existing DAO record matching the slug.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'>
<p>If the slug matches an existing DAO record, returns an entity as built from
that record, otherwise returns `nil`.</p>
</div>
</li>
</ul>
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>0.0.3</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
46
47
48
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/repository/base/internals/slug_finder.rb', line 46</span>
<span class='kw'>def</span> <span class='id identifier rubyid_entity_for_slug'>entity_for_slug</span>
<span class='id identifier rubyid_record'>record</span> <span class='op'>=</span> <span class='id identifier rubyid_dao'>dao</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='label'>slug:</span> <span class='id identifier rubyid_slug'>slug</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='id identifier rubyid_factory'>factory</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='id identifier rubyid_record'>record</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_record'>record</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="errors_for_slug-instance_method">
#<strong>errors_for_slug</strong> ⇒ <tt>ActiveModel::Errors</tt> <span class="extras">(private)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Builds an [`ActiveModel::Errors`](<a
href="http://api.rubyonrails.org/classes/ActiveModel/Errors.html">api.rubyonrails.org/classes/ActiveModel/Errors.html</a>)
instance and adds a slug-not-found message to it.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>ActiveModel::Errors</tt>)</span>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#find-instance_method" title="Repository::Base::Internals::SlugFinder#find (method)">#find</a></span></li>
</ul>
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>0.0.3</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
55
56
57
58
59</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/repository/base/internals/slug_finder.rb', line 55</span>
<span class='kw'>def</span> <span class='id identifier rubyid_errors_for_slug'>errors_for_slug</span>
<span class='id identifier rubyid_errors'>errors</span> <span class='op'>=</span> <span class='const'>ActiveModel</span><span class='op'>::</span><span class='const'>Errors</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_dao'>dao</span>
<span class='id identifier rubyid_errors'>errors</span><span class='period'>.</span><span class='id identifier rubyid_add'>add</span> <span class='symbol'>:slug</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>not found: '</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_slug'>slug</span><span class='embexpr_end'>}</span><span class='tstring_content'>'</span><span class='tstring_end'>"</span></span>
<span class='id identifier rubyid_errors'>errors</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="find-instance_method">
#<strong>find</strong> ⇒ <tt>Repository::Support::StoreResult</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Command-pattern method to search underlying DAO for record matching slug.
Returns a `Repository::Support::StoreResult` instance with the
corresponding entity on success, or with the error hash built by
`Repository::Support::ErrorFactory.create` on failure.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Repository::Support::StoreResult</tt>)</span>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#errors_for_slug-instance_method" title="Repository::Base::Internals::SlugFinder#errors_for_slug (method)">#errors_for_slug</a></span></li>
<li><span class='object_link'><a href="#result_builder-instance_method" title="Repository::Base::Internals::SlugFinder#result_builder (method)">#result_builder</a></span></li>
</ul>
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>0.0.3</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
33
34
35
36
37</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/repository/base/internals/slug_finder.rb', line 33</span>
<span class='kw'>def</span> <span class='id identifier rubyid_find'>find</span>
<span class='id identifier rubyid_result_builder'>result_builder</span><span class='lparen'>(</span><span class='id identifier rubyid_entity_for_slug'>entity_for_slug</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_build'>build</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid__failed_record'>_failed_record</span><span class='op'>|</span>
<span class='const'>ErrorFactory</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span> <span class='id identifier rubyid_errors_for_slug'>errors_for_slug</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="result_builder-instance_method">
#<strong>result_builder</strong>(record) ⇒ <tt>Object</tt> <span class="extras">(private)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new `Repository::Support::ResultBuilder` instance, passing the
parameter specified to this method as its `#initialize` parameter.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>record</span>
<span class='type'></span>
—
<div class='inline'>
<p>DAO record to pass to `ResultBuilder#initialize`.</p>
</div>
</li>
</ul>
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>0.0.3</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
64
65
66</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/repository/base/internals/slug_finder.rb', line 64</span>
<span class='kw'>def</span> <span class='id identifier rubyid_result_builder'>result_builder</span><span class='lparen'>(</span><span class='id identifier rubyid_record'>record</span><span class='rparen'>)</span>
<span class='const'>ResultBuilder</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_record'>record</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Sun Feb 4 17:34:40 2018 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.12 (ruby-2.5.0).
</div>
</div>
</body>
</html>