dirt-core 2.2.3
Sign up to get free protection for your applications and to get access to all the features.
- data/Gemfile +8 -0
- data/Gemfile.lock +46 -0
- data/MIT-LICENSE +23 -0
- data/README +14 -0
- data/doc/BlockValidator.html +272 -0
- data/doc/ClosureValidator.html +276 -0
- data/doc/Dirt.html +158 -0
- data/doc/Dirt/FooBar.html +167 -0
- data/doc/Dirt/HerpZerp.html +161 -0
- data/doc/Dirt/HerpZerp/DerpGerp.html +161 -0
- data/doc/Dirt/HerpZerp/DerpGerp/FooBar.html +167 -0
- data/doc/Dirt/MemoryPersister.html +453 -0
- data/doc/Dirt/MemoryRecord.html +157 -0
- data/doc/Dirt/MissingRecordError.html +157 -0
- data/doc/Dirt/Model.html +320 -0
- data/doc/Dirt/NoPersisterError.html +157 -0
- data/doc/Dirt/Relation.html +338 -0
- data/doc/Dirt/Role.html +345 -0
- data/doc/Dirt/TooManyRecordsError.html +157 -0
- data/doc/Dirt/TransactionError.html +157 -0
- data/doc/ExistenceValidator.html +316 -0
- data/doc/FooBar.html +153 -0
- data/doc/Gemfile.html +131 -0
- data/doc/HerpZerp.html +147 -0
- data/doc/HerpZerp/DerpGerp.html +147 -0
- data/doc/HerpZerp/DerpGerp/FooBar.html +153 -0
- data/doc/Persister.html +311 -0
- data/doc/Persisting.html +413 -0
- data/doc/PresenceValidator.html +281 -0
- data/doc/README.html +132 -0
- data/doc/Role.html +309 -0
- data/doc/Scheduler.html +147 -0
- data/doc/SelfExistenceValidator.html +278 -0
- data/doc/TestPersister.html +411 -0
- data/doc/Validating.html +293 -0
- data/doc/created.rid +18 -0
- data/doc/images/add.png +0 -0
- data/doc/images/brick.png +0 -0
- data/doc/images/brick_link.png +0 -0
- data/doc/images/bug.png +0 -0
- data/doc/images/bullet_black.png +0 -0
- data/doc/images/bullet_toggle_minus.png +0 -0
- data/doc/images/bullet_toggle_plus.png +0 -0
- data/doc/images/date.png +0 -0
- data/doc/images/delete.png +0 -0
- data/doc/images/find.png +0 -0
- data/doc/images/loadingAnimation.gif +0 -0
- data/doc/images/macFFBgHack.png +0 -0
- data/doc/images/package.png +0 -0
- data/doc/images/page_green.png +0 -0
- data/doc/images/page_white_text.png +0 -0
- data/doc/images/page_white_width.png +0 -0
- data/doc/images/plugin.png +0 -0
- data/doc/images/ruby.png +0 -0
- data/doc/images/tag_blue.png +0 -0
- data/doc/images/tag_green.png +0 -0
- data/doc/images/transparent.png +0 -0
- data/doc/images/wrench.png +0 -0
- data/doc/images/wrench_orange.png +0 -0
- data/doc/images/zoom.png +0 -0
- data/doc/index.html +110 -0
- data/doc/js/darkfish.js +155 -0
- data/doc/js/jquery.js +18 -0
- data/doc/js/navigation.js +142 -0
- data/doc/js/search.js +94 -0
- data/doc/js/search_index.js +1 -0
- data/doc/js/searcher.js +228 -0
- data/doc/rdoc.css +543 -0
- data/doc/table_of_contents.html +203 -0
- data/lib/dirt/bdd/matchers.rb +10 -0
- data/lib/dirt/bdd/persister_spec_helper.rb +213 -0
- data/lib/dirt/bdd/shared_examples.rb +29 -0
- data/lib/dirt/contexts/context.rb +15 -0
- data/lib/dirt/core.rb +36 -0
- data/lib/dirt/errors/missing_record_error.rb +4 -0
- data/lib/dirt/errors/no_persister_error.rb +4 -0
- data/lib/dirt/errors/too_many_records_error.rb +4 -0
- data/lib/dirt/errors/transaction_error.rb +4 -0
- data/lib/dirt/models/model_behaviour.rb +47 -0
- data/lib/dirt/persisters/memory_persister.rb +86 -0
- data/lib/dirt/persisters/persister.rb +54 -0
- data/lib/dirt/persisters/relation.rb +38 -0
- data/lib/dirt/roles/persisting.rb +73 -0
- data/lib/dirt/roles/role.rb +32 -0
- data/lib/dirt/roles/validating.rb +27 -0
- data/lib/dirt/roles/validation/closure_validator.rb +15 -0
- data/lib/dirt/roles/validation/existence_validator.rb +53 -0
- data/lib/dirt/roles/validation/presence_validator.rb +21 -0
- data/lib/dirt/roles/validation/self_existence_validator.rb +18 -0
- data/spec/isolations/closure_validator_spec.rb +57 -0
- data/spec/isolations/context_spec.rb +54 -0
- data/spec/isolations/existence_validator_spec.rb +151 -0
- data/spec/isolations/memory_persister_spec.rb +175 -0
- data/spec/isolations/model_spec.rb +91 -0
- data/spec/isolations/persister_spec.rb +113 -0
- data/spec/isolations/persisting_spec.rb +266 -0
- data/spec/isolations/presence_validator_spec.rb +63 -0
- data/spec/isolations/role_spec.rb +116 -0
- data/spec/isolations/self_existence_validator_spec.rb +64 -0
- data/spec/isolations/spec_helper.rb +26 -0
- data/spec/isolations/validating_spec.rb +88 -0
- metadata +161 -0
data/doc/Persisting.html
ADDED
|
@@ -0,0 +1,413 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
|
6
|
+
|
|
7
|
+
<title>class Persisting - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
|
|
10
|
+
|
|
11
|
+
<script type="text/javascript">
|
|
12
|
+
var rdoc_rel_prefix = "./";
|
|
13
|
+
</script>
|
|
14
|
+
|
|
15
|
+
<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
|
|
16
|
+
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
|
|
17
|
+
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
|
|
18
|
+
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
|
|
19
|
+
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
|
|
20
|
+
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<body id="top" class="class">
|
|
24
|
+
<nav id="metadata">
|
|
25
|
+
<nav id="home-section" class="section">
|
|
26
|
+
<h3 class="section-header">
|
|
27
|
+
<a href="./index.html">Home</a>
|
|
28
|
+
<a href="./table_of_contents.html#classes">Classes</a>
|
|
29
|
+
<a href="./table_of_contents.html#methods">Methods</a>
|
|
30
|
+
</h3>
|
|
31
|
+
</nav>
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
<nav id="search-section" class="section project-section" class="initially-hidden">
|
|
35
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
36
|
+
<h3 class="section-header">
|
|
37
|
+
<input type="text" name="search" placeholder="Search" id="search-field"
|
|
38
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
39
|
+
</h3>
|
|
40
|
+
</form>
|
|
41
|
+
|
|
42
|
+
<ul id="search-results" class="initially-hidden"></ul>
|
|
43
|
+
</nav>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
<div id="file-metadata">
|
|
47
|
+
<nav id="file-list-section" class="section">
|
|
48
|
+
<h3 class="section-header">Defined In</h3>
|
|
49
|
+
<ul>
|
|
50
|
+
<li>lib/roles/persisting.rb
|
|
51
|
+
</ul>
|
|
52
|
+
</nav>
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
</div>
|
|
56
|
+
|
|
57
|
+
<div id="class-metadata">
|
|
58
|
+
|
|
59
|
+
<nav id="parent-class-section" class="section">
|
|
60
|
+
<h3 class="section-header">Parent</h3>
|
|
61
|
+
|
|
62
|
+
<p class="link"><a href="Dirt/Role.html">Dirt::Role</a>
|
|
63
|
+
|
|
64
|
+
</nav>
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
<!-- Method Quickref -->
|
|
68
|
+
<nav id="method-list-section" class="section">
|
|
69
|
+
<h3 class="section-header">Methods</h3>
|
|
70
|
+
|
|
71
|
+
<ul class="link-list">
|
|
72
|
+
|
|
73
|
+
<li><a href="#method-c-new">::new</a>
|
|
74
|
+
|
|
75
|
+
<li><a href="#method-i-3D-3D">#==</a>
|
|
76
|
+
|
|
77
|
+
<li><a href="#method-i-delete">#delete</a>
|
|
78
|
+
|
|
79
|
+
<li><a href="#method-i-load">#load</a>
|
|
80
|
+
|
|
81
|
+
<li><a href="#method-i-load_by">#load_by</a>
|
|
82
|
+
|
|
83
|
+
<li><a href="#method-i-save">#save</a>
|
|
84
|
+
|
|
85
|
+
</ul>
|
|
86
|
+
</nav>
|
|
87
|
+
|
|
88
|
+
</div>
|
|
89
|
+
|
|
90
|
+
<div id="project-metadata">
|
|
91
|
+
<nav id="fileindex-section" class="section project-section">
|
|
92
|
+
<h3 class="section-header">Pages</h3>
|
|
93
|
+
|
|
94
|
+
<ul>
|
|
95
|
+
|
|
96
|
+
<li class="file"><a href="./README.html">README</a>
|
|
97
|
+
|
|
98
|
+
</ul>
|
|
99
|
+
</nav>
|
|
100
|
+
|
|
101
|
+
<nav id="classindex-section" class="section project-section">
|
|
102
|
+
<h3 class="section-header">Class and Module Index</h3>
|
|
103
|
+
|
|
104
|
+
<ul class="link-list">
|
|
105
|
+
|
|
106
|
+
<li><a href="./Dirt.html">Dirt</a>
|
|
107
|
+
|
|
108
|
+
<li><a href="./Dirt/MemoryPersister.html">Dirt::MemoryPersister</a>
|
|
109
|
+
|
|
110
|
+
<li><a href="./Dirt/MemoryRecord.html">Dirt::MemoryRecord</a>
|
|
111
|
+
|
|
112
|
+
<li><a href="./Dirt/MissingRecordError.html">Dirt::MissingRecordError</a>
|
|
113
|
+
|
|
114
|
+
<li><a href="./Dirt/Model.html">Dirt::Model</a>
|
|
115
|
+
|
|
116
|
+
<li><a href="./Dirt/NoPersisterError.html">Dirt::NoPersisterError</a>
|
|
117
|
+
|
|
118
|
+
<li><a href="./Dirt/Relation.html">Dirt::Relation</a>
|
|
119
|
+
|
|
120
|
+
<li><a href="./Dirt/Role.html">Dirt::Role</a>
|
|
121
|
+
|
|
122
|
+
<li><a href="./Dirt/TooManyRecordsError.html">Dirt::TooManyRecordsError</a>
|
|
123
|
+
|
|
124
|
+
<li><a href="./Dirt/TransactionError.html">Dirt::TransactionError</a>
|
|
125
|
+
|
|
126
|
+
<li><a href="./ClosureValidator.html">ClosureValidator</a>
|
|
127
|
+
|
|
128
|
+
<li><a href="./ExistenceValidator.html">ExistenceValidator</a>
|
|
129
|
+
|
|
130
|
+
<li><a href="./Persister.html">Persister</a>
|
|
131
|
+
|
|
132
|
+
<li><a href="./Persisting.html">Persisting</a>
|
|
133
|
+
|
|
134
|
+
<li><a href="./PresenceValidator.html">PresenceValidator</a>
|
|
135
|
+
|
|
136
|
+
<li><a href="./SelfExistenceValidator.html">SelfExistenceValidator</a>
|
|
137
|
+
|
|
138
|
+
<li><a href="./Validating.html">Validating</a>
|
|
139
|
+
|
|
140
|
+
</ul>
|
|
141
|
+
</nav>
|
|
142
|
+
|
|
143
|
+
</div>
|
|
144
|
+
</nav>
|
|
145
|
+
|
|
146
|
+
<div id="documentation">
|
|
147
|
+
<h1 class="class">class Persisting</h1>
|
|
148
|
+
|
|
149
|
+
<div id="description" class="description">
|
|
150
|
+
|
|
151
|
+
<p>Role for adding persistability to model objects.</p>
|
|
152
|
+
|
|
153
|
+
</div><!-- description -->
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
<!-- Attributes -->
|
|
167
|
+
<section id="attribute-method-details" class="method-section section">
|
|
168
|
+
<h3 class="section-header">Attributes</h3>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
<div id="attribute-i-id" class="method-detail">
|
|
172
|
+
<div class="method-heading attribute-method-heading">
|
|
173
|
+
<span class="method-name">id</span><span
|
|
174
|
+
class="attribute-access-type">[R]</span>
|
|
175
|
+
</div>
|
|
176
|
+
|
|
177
|
+
<div class="method-description">
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
</div>
|
|
182
|
+
</div>
|
|
183
|
+
|
|
184
|
+
</section><!-- attribute-method-details -->
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
<!-- Methods -->
|
|
188
|
+
|
|
189
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
|
|
190
|
+
<h3 class="section-header">Public Class Methods</h3>
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
<div id="method-c-new" class="method-detail ">
|
|
194
|
+
|
|
195
|
+
<div class="method-heading">
|
|
196
|
+
<span class="method-name">new</span><span
|
|
197
|
+
class="method-args">(decorated, id=nil)</span>
|
|
198
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
199
|
+
</div>
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
<div class="method-description">
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
<div class="method-source-code" id="new-source">
|
|
209
|
+
<pre><span class="ruby-comment"># File lib/roles/persisting.rb, line 8</span>
|
|
210
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">decorated</span>, <span class="ruby-identifier">id</span>=<span class="ruby-keyword">nil</span>)
|
|
211
|
+
<span class="ruby-keyword">super</span>(<span class="ruby-identifier">decorated</span>)
|
|
212
|
+
<span class="ruby-ivar">@id</span> = <span class="ruby-identifier">id</span>
|
|
213
|
+
<span class="ruby-keyword">end</span></pre>
|
|
214
|
+
</div><!-- new-source -->
|
|
215
|
+
|
|
216
|
+
</div>
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
</div><!-- new-method -->
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
</section><!-- public-class-method-details -->
|
|
225
|
+
|
|
226
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
|
|
227
|
+
<h3 class="section-header">Public Instance Methods</h3>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
<div id="method-i-3D-3D" class="method-detail ">
|
|
231
|
+
|
|
232
|
+
<div class="method-heading">
|
|
233
|
+
<span class="method-name">==</span><span
|
|
234
|
+
class="method-args">(other)</span>
|
|
235
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
236
|
+
</div>
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
<div class="method-description">
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
<div class="method-source-code" id="3D-3D-source">
|
|
246
|
+
<pre><span class="ruby-comment"># File lib/roles/persisting.rb, line 54</span>
|
|
247
|
+
<span class="ruby-keyword">def</span> <span class="ruby-operator">==</span>(<span class="ruby-identifier">other</span>)
|
|
248
|
+
<span class="ruby-keyword">super</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">other</span>.<span class="ruby-identifier">id</span> <span class="ruby-operator">==</span> <span class="ruby-ivar">@id</span>
|
|
249
|
+
<span class="ruby-keyword">end</span></pre>
|
|
250
|
+
</div><!-- 3D-3D-source -->
|
|
251
|
+
|
|
252
|
+
</div>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
</div><!-- 3D-3D-method -->
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
<div id="method-i-delete" class="method-detail ">
|
|
261
|
+
|
|
262
|
+
<div class="method-heading">
|
|
263
|
+
<span class="method-name">delete</span><span
|
|
264
|
+
class="method-args">(id)</span>
|
|
265
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
266
|
+
</div>
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
<div class="method-description">
|
|
270
|
+
|
|
271
|
+
<p>Removes the decorated object from the appropriate persister.</p>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
<div class="method-source-code" id="delete-source">
|
|
276
|
+
<pre><span class="ruby-comment"># File lib/roles/persisting.rb, line 48</span>
|
|
277
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">delete</span>(<span class="ruby-identifier">id</span>)
|
|
278
|
+
<span class="ruby-identifier">assert_exists</span>(<span class="ruby-identifier">id</span>)
|
|
279
|
+
|
|
280
|
+
<span class="ruby-identifier">persister</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">id</span>)
|
|
281
|
+
<span class="ruby-keyword">end</span></pre>
|
|
282
|
+
</div><!-- delete-source -->
|
|
283
|
+
|
|
284
|
+
</div>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
</div><!-- delete-method -->
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
<div id="method-i-load" class="method-detail ">
|
|
293
|
+
|
|
294
|
+
<div class="method-heading">
|
|
295
|
+
<span class="method-name">load</span><span
|
|
296
|
+
class="method-args">(id)</span>
|
|
297
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
298
|
+
</div>
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
<div class="method-description">
|
|
302
|
+
|
|
303
|
+
<p>Loads persisted data into the decorated object</p>
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
<div class="method-source-code" id="load-source">
|
|
308
|
+
<pre><span class="ruby-comment"># File lib/roles/persisting.rb, line 24</span>
|
|
309
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">load</span>(<span class="ruby-identifier">id</span>)
|
|
310
|
+
<span class="ruby-identifier">assert_exists</span>(<span class="ruby-identifier">id</span>)
|
|
311
|
+
|
|
312
|
+
<span class="ruby-identifier">loaded</span> = <span class="ruby-identifier">persister</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">id</span>)
|
|
313
|
+
|
|
314
|
+
<span class="ruby-identifier">chameleonize</span>(<span class="ruby-identifier">loaded</span>)
|
|
315
|
+
|
|
316
|
+
<span class="ruby-keyword">self</span>
|
|
317
|
+
<span class="ruby-keyword">end</span></pre>
|
|
318
|
+
</div><!-- load-source -->
|
|
319
|
+
|
|
320
|
+
</div>
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
</div><!-- load-method -->
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
<div id="method-i-load_by" class="method-detail ">
|
|
329
|
+
|
|
330
|
+
<div class="method-heading">
|
|
331
|
+
<span class="method-name">load_by</span><span
|
|
332
|
+
class="method-args">(attrs)</span>
|
|
333
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
334
|
+
</div>
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
<div class="method-description">
|
|
338
|
+
|
|
339
|
+
<p>Loads from the first record that matches the given attributes.</p>
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
<div class="method-source-code" id="load_by-source">
|
|
344
|
+
<pre><span class="ruby-comment"># File lib/roles/persisting.rb, line 35</span>
|
|
345
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">load_by</span>(<span class="ruby-identifier">attrs</span>)
|
|
346
|
+
<span class="ruby-identifier">record</span> = <span class="ruby-constant">Persister</span>.<span class="ruby-identifier">for</span>(<span class="ruby-ivar">@decorated</span>.<span class="ruby-identifier">class</span>).<span class="ruby-identifier">find</span>(<span class="ruby-identifier">attrs</span>)
|
|
347
|
+
|
|
348
|
+
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">record</span>
|
|
349
|
+
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Dirt</span><span class="ruby-operator">::</span><span class="ruby-constant">MissingRecordError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-node">"No record matches #{attrs.collect { |pair| pair.join(' == ') }.join(', ')}."</span>)
|
|
350
|
+
<span class="ruby-keyword">end</span>
|
|
351
|
+
|
|
352
|
+
<span class="ruby-identifier">chameleonize</span>(<span class="ruby-identifier">record</span>)
|
|
353
|
+
|
|
354
|
+
<span class="ruby-keyword">self</span>
|
|
355
|
+
<span class="ruby-keyword">end</span></pre>
|
|
356
|
+
</div><!-- load_by-source -->
|
|
357
|
+
|
|
358
|
+
</div>
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
</div><!-- load_by-method -->
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
<div id="method-i-save" class="method-detail ">
|
|
367
|
+
|
|
368
|
+
<div class="method-heading">
|
|
369
|
+
<span class="method-name">save</span><span
|
|
370
|
+
class="method-args">(id=nil)</span>
|
|
371
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
372
|
+
</div>
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<div class="method-description">
|
|
376
|
+
|
|
377
|
+
<p>Saves the decorated object with the appropriate persister.</p>
|
|
378
|
+
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
<div class="method-source-code" id="save-source">
|
|
382
|
+
<pre><span class="ruby-comment"># File lib/roles/persisting.rb, line 14</span>
|
|
383
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">save</span>(<span class="ruby-identifier">id</span>=<span class="ruby-keyword">nil</span>)
|
|
384
|
+
<span class="ruby-identifier">saved</span> = <span class="ruby-identifier">persister</span>.<span class="ruby-identifier">save</span>(<span class="ruby-ivar">@decorated</span>, <span class="ruby-identifier">id</span>)
|
|
385
|
+
|
|
386
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">saved</span>
|
|
387
|
+
<span class="ruby-ivar">@id</span> = <span class="ruby-identifier">saved</span>.<span class="ruby-identifier">id</span>
|
|
388
|
+
<span class="ruby-keyword">self</span>
|
|
389
|
+
<span class="ruby-keyword">end</span>
|
|
390
|
+
<span class="ruby-keyword">end</span></pre>
|
|
391
|
+
</div><!-- save-source -->
|
|
392
|
+
|
|
393
|
+
</div>
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
</div><!-- save-method -->
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
</section><!-- public-instance-method-details -->
|
|
402
|
+
|
|
403
|
+
</section><!-- 5Buntitled-5D -->
|
|
404
|
+
|
|
405
|
+
</div><!-- documentation -->
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
<footer id="validator-badges">
|
|
409
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
|
410
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.2.
|
|
411
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
|
412
|
+
</footer>
|
|
413
|
+
|
|
@@ -0,0 +1,281 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
|
|
3
|
+
<html>
|
|
4
|
+
<head>
|
|
5
|
+
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
|
6
|
+
|
|
7
|
+
<title>class PresenceValidator - RDoc Documentation</title>
|
|
8
|
+
|
|
9
|
+
<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
|
|
10
|
+
|
|
11
|
+
<script type="text/javascript">
|
|
12
|
+
var rdoc_rel_prefix = "./";
|
|
13
|
+
</script>
|
|
14
|
+
|
|
15
|
+
<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
|
|
16
|
+
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
|
|
17
|
+
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
|
|
18
|
+
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
|
|
19
|
+
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
|
|
20
|
+
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<body id="top" class="class">
|
|
24
|
+
<nav id="metadata">
|
|
25
|
+
<nav id="home-section" class="section">
|
|
26
|
+
<h3 class="section-header">
|
|
27
|
+
<a href="./index.html">Home</a>
|
|
28
|
+
<a href="./table_of_contents.html#classes">Classes</a>
|
|
29
|
+
<a href="./table_of_contents.html#methods">Methods</a>
|
|
30
|
+
</h3>
|
|
31
|
+
</nav>
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
<nav id="search-section" class="section project-section" class="initially-hidden">
|
|
35
|
+
<form action="#" method="get" accept-charset="utf-8">
|
|
36
|
+
<h3 class="section-header">
|
|
37
|
+
<input type="text" name="search" placeholder="Search" id="search-field"
|
|
38
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
|
39
|
+
</h3>
|
|
40
|
+
</form>
|
|
41
|
+
|
|
42
|
+
<ul id="search-results" class="initially-hidden"></ul>
|
|
43
|
+
</nav>
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
<div id="file-metadata">
|
|
47
|
+
<nav id="file-list-section" class="section">
|
|
48
|
+
<h3 class="section-header">Defined In</h3>
|
|
49
|
+
<ul>
|
|
50
|
+
<li>lib/roles/validation/presence_validator.rb
|
|
51
|
+
</ul>
|
|
52
|
+
</nav>
|
|
53
|
+
|
|
54
|
+
|
|
55
|
+
</div>
|
|
56
|
+
|
|
57
|
+
<div id="class-metadata">
|
|
58
|
+
|
|
59
|
+
<nav id="parent-class-section" class="section">
|
|
60
|
+
<h3 class="section-header">Parent</h3>
|
|
61
|
+
|
|
62
|
+
<p class="link">Object
|
|
63
|
+
|
|
64
|
+
</nav>
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
<!-- Method Quickref -->
|
|
68
|
+
<nav id="method-list-section" class="section">
|
|
69
|
+
<h3 class="section-header">Methods</h3>
|
|
70
|
+
|
|
71
|
+
<ul class="link-list">
|
|
72
|
+
|
|
73
|
+
<li><a href="#method-c-new">::new</a>
|
|
74
|
+
|
|
75
|
+
<li><a href="#method-i-error_message">#error_message</a>
|
|
76
|
+
|
|
77
|
+
<li><a href="#method-i-valid-3F">#valid?</a>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
</nav>
|
|
81
|
+
|
|
82
|
+
</div>
|
|
83
|
+
|
|
84
|
+
<div id="project-metadata">
|
|
85
|
+
<nav id="fileindex-section" class="section project-section">
|
|
86
|
+
<h3 class="section-header">Pages</h3>
|
|
87
|
+
|
|
88
|
+
<ul>
|
|
89
|
+
|
|
90
|
+
<li class="file"><a href="./README.html">README</a>
|
|
91
|
+
|
|
92
|
+
</ul>
|
|
93
|
+
</nav>
|
|
94
|
+
|
|
95
|
+
<nav id="classindex-section" class="section project-section">
|
|
96
|
+
<h3 class="section-header">Class and Module Index</h3>
|
|
97
|
+
|
|
98
|
+
<ul class="link-list">
|
|
99
|
+
|
|
100
|
+
<li><a href="./Dirt.html">Dirt</a>
|
|
101
|
+
|
|
102
|
+
<li><a href="./Dirt/MemoryPersister.html">Dirt::MemoryPersister</a>
|
|
103
|
+
|
|
104
|
+
<li><a href="./Dirt/MemoryRecord.html">Dirt::MemoryRecord</a>
|
|
105
|
+
|
|
106
|
+
<li><a href="./Dirt/MissingRecordError.html">Dirt::MissingRecordError</a>
|
|
107
|
+
|
|
108
|
+
<li><a href="./Dirt/Model.html">Dirt::Model</a>
|
|
109
|
+
|
|
110
|
+
<li><a href="./Dirt/NoPersisterError.html">Dirt::NoPersisterError</a>
|
|
111
|
+
|
|
112
|
+
<li><a href="./Dirt/Relation.html">Dirt::Relation</a>
|
|
113
|
+
|
|
114
|
+
<li><a href="./Dirt/Role.html">Dirt::Role</a>
|
|
115
|
+
|
|
116
|
+
<li><a href="./Dirt/TooManyRecordsError.html">Dirt::TooManyRecordsError</a>
|
|
117
|
+
|
|
118
|
+
<li><a href="./Dirt/TransactionError.html">Dirt::TransactionError</a>
|
|
119
|
+
|
|
120
|
+
<li><a href="./ClosureValidator.html">ClosureValidator</a>
|
|
121
|
+
|
|
122
|
+
<li><a href="./ExistenceValidator.html">ExistenceValidator</a>
|
|
123
|
+
|
|
124
|
+
<li><a href="./Persister.html">Persister</a>
|
|
125
|
+
|
|
126
|
+
<li><a href="./Persisting.html">Persisting</a>
|
|
127
|
+
|
|
128
|
+
<li><a href="./PresenceValidator.html">PresenceValidator</a>
|
|
129
|
+
|
|
130
|
+
<li><a href="./SelfExistenceValidator.html">SelfExistenceValidator</a>
|
|
131
|
+
|
|
132
|
+
<li><a href="./Validating.html">Validating</a>
|
|
133
|
+
|
|
134
|
+
</ul>
|
|
135
|
+
</nav>
|
|
136
|
+
|
|
137
|
+
</div>
|
|
138
|
+
</nav>
|
|
139
|
+
|
|
140
|
+
<div id="documentation">
|
|
141
|
+
<h1 class="class">class PresenceValidator</h1>
|
|
142
|
+
|
|
143
|
+
<div id="description" class="description">
|
|
144
|
+
|
|
145
|
+
<p>Tests whether the given property is set (ie non-nil)</p>
|
|
146
|
+
|
|
147
|
+
<p>For more about validation, see <a href="Validating.html">Validating</a></p>
|
|
148
|
+
|
|
149
|
+
</div><!-- description -->
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
<!-- Methods -->
|
|
164
|
+
|
|
165
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
|
|
166
|
+
<h3 class="section-header">Public Class Methods</h3>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
<div id="method-c-new" class="method-detail ">
|
|
170
|
+
|
|
171
|
+
<div class="method-heading">
|
|
172
|
+
<span class="method-name">new</span><span
|
|
173
|
+
class="method-args">(property)</span>
|
|
174
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
175
|
+
</div>
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
<div class="method-description">
|
|
179
|
+
|
|
180
|
+
<p>Takes the property name as symbol</p>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
<div class="method-source-code" id="new-source">
|
|
185
|
+
<pre><span class="ruby-comment"># File lib/roles/validation/presence_validator.rb, line 6</span>
|
|
186
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">property</span>)
|
|
187
|
+
<span class="ruby-ivar">@property</span> = <span class="ruby-identifier">property</span>
|
|
188
|
+
<span class="ruby-keyword">end</span></pre>
|
|
189
|
+
</div><!-- new-source -->
|
|
190
|
+
|
|
191
|
+
</div>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
</div><!-- new-method -->
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
</section><!-- public-class-method-details -->
|
|
200
|
+
|
|
201
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
|
|
202
|
+
<h3 class="section-header">Public Instance Methods</h3>
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
<div id="method-i-error_message" class="method-detail ">
|
|
206
|
+
|
|
207
|
+
<div class="method-heading">
|
|
208
|
+
<span class="method-name">error_message</span><span
|
|
209
|
+
class="method-args">(validated)</span>
|
|
210
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
211
|
+
</div>
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
<div class="method-description">
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
<div class="method-source-code" id="error_message-source">
|
|
221
|
+
<pre><span class="ruby-comment"># File lib/roles/validation/presence_validator.rb, line 18</span>
|
|
222
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">error_message</span>(<span class="ruby-identifier">validated</span>)
|
|
223
|
+
<span class="ruby-node">"#{validated.class.to_s.demodulize} #{@property} must be provided."</span>
|
|
224
|
+
<span class="ruby-keyword">end</span></pre>
|
|
225
|
+
</div><!-- error_message-source -->
|
|
226
|
+
|
|
227
|
+
</div>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
</div><!-- error_message-method -->
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
<div id="method-i-valid-3F" class="method-detail ">
|
|
236
|
+
|
|
237
|
+
<div class="method-heading">
|
|
238
|
+
<span class="method-name">valid?</span><span
|
|
239
|
+
class="method-args">(validated)</span>
|
|
240
|
+
<span class="method-click-advice">click to toggle source</span>
|
|
241
|
+
</div>
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<div class="method-description">
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
<div class="method-source-code" id="valid-3F-source">
|
|
251
|
+
<pre><span class="ruby-comment"># File lib/roles/validation/presence_validator.rb, line 10</span>
|
|
252
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">valid?</span>(<span class="ruby-identifier">validated</span>)
|
|
253
|
+
<span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">validated</span>
|
|
254
|
+
|
|
255
|
+
<span class="ruby-identifier">value</span> = <span class="ruby-identifier">validated</span>.<span class="ruby-identifier">send</span>(<span class="ruby-ivar">@property</span>)
|
|
256
|
+
|
|
257
|
+
<span class="ruby-identifier">value</span>.<span class="ruby-identifier">present?</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span>(<span class="ruby-identifier">value</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp">/\A\s*\Z/</span>)
|
|
258
|
+
<span class="ruby-keyword">end</span></pre>
|
|
259
|
+
</div><!-- valid-3F-source -->
|
|
260
|
+
|
|
261
|
+
</div>
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
</div><!-- valid-3F-method -->
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
</section><!-- public-instance-method-details -->
|
|
270
|
+
|
|
271
|
+
</section><!-- 5Buntitled-5D -->
|
|
272
|
+
|
|
273
|
+
</div><!-- documentation -->
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
<footer id="validator-badges">
|
|
277
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
|
278
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.2.
|
|
279
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
|
280
|
+
</footer>
|
|
281
|
+
|