<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Repository::Base::Internals::RecordSaver
— 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::RecordSaver";
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 (R)</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">RecordSaver</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::RecordSaver
</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::RecordSaver</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/record_saver.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Reports on the success or failure of saving a *DAO record*, using the
`Repository::Support::StoreResult` instance returned from `#result`.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>0.0.1</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="#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="#record-instance_method" title="#record (instance method)">#<strong>record</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="#error_hashes-instance_method" title="#error_hashes (instance method)">#<strong>error_hashes</strong> ⇒ Object </a>
</span>
<span class="note title private">private</span>
<span class="summary_desc"><div class='inline'>
<p>Represent error data sourced from an `ActiveModel::Errors` object as an
Array of `'field', message: 'message'` hashes.</p>
</div></span>
</li>
<li class="private ">
<span class="summary_signature">
<a href="#failed_result-instance_method" title="#failed_result (instance method)">#<strong>failed_result</strong> ⇒ Object </a>
</span>
<span class="note title private">private</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(record:, factory:) ⇒ RecordSaver </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>Sets instance variable(s) on a new `RecordSaver` instanace.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#result-instance_method" title="#result (instance method)">#<strong>result</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Command-pattern method returning indication of success or failure of
attempt to save record.</p>
</div></span>
</li>
<li class="private ">
<span class="summary_signature">
<a href="#successful_result-instance_method" title="#successful_result (instance method)">#<strong>successful_result</strong> ⇒ Object </a>
</span>
<span class="note title private">private</span>
<span class="summary_desc"><div class='inline'></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>(record:, factory:) ⇒ <tt><span class='object_link'><a href="" title="Repository::Base::Internals::RecordSaver (class)">RecordSaver</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Sets instance variable(s) on a new `RecordSaver` instanace.</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 attempt to save.</p>
</div>
</li>
</ul>
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>0.0.1</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
19
20
21
22</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/repository/base/internals/record_saver.rb', line 19</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>record:</span><span class='comma'>,</span> <span class='label'>factory:</span><span class='rparen'>)</span>
<span class='ivar'>@record</span> <span class='op'>=</span> <span class='id identifier rubyid_record'>record</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="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.1</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/repository/base/internals/record_saver.rb', line 39</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="record-instance_method">
#<strong>record</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.1</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/repository/base/internals/record_saver.rb', line 39</span>
<span class='kw'>def</span> <span class='id identifier rubyid_record'>record</span>
<span class='ivar'>@record</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="error_hashes-instance_method">
#<strong>error_hashes</strong> ⇒ <tt>Object</tt> <span class="extras">(private)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Represent error data sourced from an `ActiveModel::Errors` object as an
Array of `'field', message: 'message'` hashes.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>0.0.1</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
43
44
45</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/repository/base/internals/record_saver.rb', line 43</span>
<span class='kw'>def</span> <span class='id identifier rubyid_error_hashes'>error_hashes</span>
<span class='const'>ErrorFactory</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span> <span class='id identifier rubyid_record'>record</span><span class='period'>.</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="failed_result-instance_method">
#<strong>failed_result</strong> ⇒ <tt>Object</tt> <span class="extras">(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.1</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
47
48
49</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/repository/base/internals/record_saver.rb', line 47</span>
<span class='kw'>def</span> <span class='id identifier rubyid_failed_result'>failed_result</span>
<span class='const'>StoreResult</span><span class='op'>::</span><span class='const'>Failure</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_error_hashes'>error_hashes</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="result-instance_method">
#<strong>result</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Command-pattern method returning indication of success or failure of
attempt to save record.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'></span>
<div class='inline'>
<p>Repository::Support::StoreResult</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><span class='object_link'><a href="#failed_result-instance_method" title="Repository::Base::Internals::RecordSaver#failed_result (method)">#failed_result</a></span></li>
<li><span class='object_link'><a href="#successful_result-instance_method" title="Repository::Base::Internals::RecordSaver#successful_result (method)">#successful_result</a></span></li>
</ul>
<p class="tag_title">Since:</p>
<ul class="since">
<li>
<div class='inline'>
<p>0.0.1</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
29
30
31
32
33
34
35</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/repository/base/internals/record_saver.rb', line 29</span>
<span class='kw'>def</span> <span class='id identifier rubyid_result'>result</span>
<span class='kw'>if</span> <span class='id identifier rubyid_record'>record</span><span class='period'>.</span><span class='id identifier rubyid_save'>save</span>
<span class='id identifier rubyid_successful_result'>successful_result</span>
<span class='kw'>else</span>
<span class='id identifier rubyid_failed_result'>failed_result</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="successful_result-instance_method">
#<strong>successful_result</strong> ⇒ <tt>Object</tt> <span class="extras">(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.1</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
51
52
53
54</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/repository/base/internals/record_saver.rb', line 51</span>
<span class='kw'>def</span> <span class='id identifier rubyid_successful_result'>successful_result</span>
<span class='id identifier rubyid_entity'>entity</span> <span class='op'>=</span> <span class='id identifier rubyid_factory'>factory</span><span class='period'>.</span><span class='id identifier rubyid_create'>create</span> <span class='id identifier rubyid_record'>record</span>
<span class='const'>StoreResult</span><span class='op'>::</span><span class='const'>Success</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='id identifier rubyid_entity'>entity</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>