doing 2.0.9.pre → 2.0.10
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.yardoc/checksums +20 -0
- data/.yardoc/complete +0 -0
- data/.yardoc/object_types +0 -0
- data/.yardoc/objects/root.dat +0 -0
- data/.yardoc/proxy_types +0 -0
- data/.yardopts +1 -0
- data/CHANGELOG.md +1 -1
- data/Gemfile.lock +30 -10
- data/README.md +1 -1
- data/Rakefile +8 -1
- data/bin/doing +76 -30
- data/doc/Array.html +135 -0
- data/doc/Doing/Color.html +506 -0
- data/doc/Doing/Configuration.html +680 -0
- data/doc/Doing/Errors/DoingNoTraceError.html +186 -0
- data/doc/Doing/Errors/DoingRuntimeError.html +186 -0
- data/doc/Doing/Errors/DoingStandardError.html +186 -0
- data/doc/Doing/Errors/EmptyInput.html +186 -0
- data/doc/Doing/Errors/NoResults.html +186 -0
- data/doc/Doing/Errors/PluginException.html +248 -0
- data/doc/Doing/Errors/UserCancelled.html +186 -0
- data/doc/Doing/Errors/WrongCommand.html +186 -0
- data/doc/Doing/Errors.html +191 -0
- data/doc/Doing/Hooks.html +364 -0
- data/doc/Doing/Item.html +1385 -0
- data/doc/Doing/Items.html +393 -0
- data/doc/Doing/LogAdapter.html +1650 -0
- data/doc/Doing/Note.html +535 -0
- data/doc/Doing/Pager.html +268 -0
- data/doc/Doing/Plugins.html +849 -0
- data/doc/Doing/Util.html +870 -0
- data/doc/Doing/WWID.html +4827 -0
- data/doc/Doing.html +145 -0
- data/doc/GLI/Commands/MarkdownDocumentListener.html +763 -0
- data/doc/GLI/Commands.html +115 -0
- data/doc/GLI.html +115 -0
- data/doc/Hash.html +332 -0
- data/doc/Status.html +292 -0
- data/doc/String.html +1714 -0
- data/doc/Symbol.html +250 -0
- data/doc/Time.html +182 -0
- data/doc/_index.html +411 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +497 -0
- data/doc/file.README.html +123 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +123 -0
- data/doc/js/app.js +314 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +1867 -0
- data/doc/top-level-namespace.html +112 -0
- data/doing.gemspec +5 -1
- data/doing.rdoc +86 -16
- data/example_plugin.rb +6 -6
- data/lib/doing/array.rb +1 -1
- data/lib/doing/configuration.rb +14 -12
- data/lib/doing/hash.rb +1 -1
- data/lib/doing/item.rb +101 -17
- data/lib/doing/log_adapter.rb +123 -113
- data/lib/doing/note.rb +1 -1
- data/lib/doing/plugin_manager.rb +5 -5
- data/lib/doing/plugins/export/csv_export.rb +1 -1
- data/lib/doing/plugins/export/template_export.rb +5 -7
- data/lib/doing/plugins/import/calendar_import.rb +1 -1
- data/lib/doing/plugins/import/doing_import.rb +4 -4
- data/lib/doing/plugins/import/timing_import.rb +5 -3
- data/lib/doing/string.rb +75 -22
- data/lib/doing/symbol.rb +9 -5
- data/lib/doing/time.rb +1 -1
- data/lib/doing/util.rb +18 -11
- data/lib/doing/version.rb +1 -1
- data/lib/doing/wwid.rb +419 -326
- data/lib/doing/wwidfile.rb +5 -5
- data/lib/doing.rb +2 -1
- data/lib/examples/plugins/say_export.rb +6 -6
- data/rdocfixer.rb +1 -1
- data/yard_templates/default/method_details/setup.rb +3 -0
- metadata +117 -4
data/doc/Doing/Item.html
ADDED
|
@@ -0,0 +1,1385 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: Doing::Item
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.26
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "Doing::Item";
|
|
19
|
+
relpath = '../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../_index.html">Index (I)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../Doing.html" title="Doing (module)">Doing</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Item</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: Doing::Item
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">Doing::Item</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/doing/item.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
<p>This class describes a single WWID item</p>
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
</div>
|
|
108
|
+
</div>
|
|
109
|
+
<div class="tags">
|
|
110
|
+
|
|
111
|
+
|
|
112
|
+
</div>
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
117
|
+
<ul class="summary">
|
|
118
|
+
|
|
119
|
+
<li class="public ">
|
|
120
|
+
<span class="summary_signature">
|
|
121
|
+
|
|
122
|
+
<a href="#date-instance_method" title="#date (instance method)">#<strong>date</strong> ⇒ Object </a>
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
</span>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute date.</p>
|
|
140
|
+
</div></span>
|
|
141
|
+
|
|
142
|
+
</li>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
<li class="public ">
|
|
146
|
+
<span class="summary_signature">
|
|
147
|
+
|
|
148
|
+
<a href="#note-instance_method" title="#note (instance method)">#<strong>note</strong> ⇒ Object </a>
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
</span>
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute note.</p>
|
|
166
|
+
</div></span>
|
|
167
|
+
|
|
168
|
+
</li>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
<li class="public ">
|
|
172
|
+
<span class="summary_signature">
|
|
173
|
+
|
|
174
|
+
<a href="#section-instance_method" title="#section (instance method)">#<strong>section</strong> ⇒ Object </a>
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
</span>
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute section.</p>
|
|
192
|
+
</div></span>
|
|
193
|
+
|
|
194
|
+
</li>
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
<li class="public ">
|
|
198
|
+
<span class="summary_signature">
|
|
199
|
+
|
|
200
|
+
<a href="#title-instance_method" title="#title (instance method)">#<strong>title</strong> ⇒ Object </a>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
</span>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute title.</p>
|
|
218
|
+
</div></span>
|
|
219
|
+
|
|
220
|
+
</li>
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
</ul>
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
<h2>
|
|
230
|
+
Instance Method Summary
|
|
231
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
232
|
+
</h2>
|
|
233
|
+
|
|
234
|
+
<ul class="summary">
|
|
235
|
+
|
|
236
|
+
<li class="public ">
|
|
237
|
+
<span class="summary_signature">
|
|
238
|
+
|
|
239
|
+
<a href="#end_date-instance_method" title="#end_date (instance method)">#<strong>end_date</strong> ⇒ Time </a>
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
</span>
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
<span class="summary_desc"><div class='inline'><p>Get the value of the item's @done tag.</p>
|
|
254
|
+
</div></span>
|
|
255
|
+
|
|
256
|
+
</li>
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
<li class="public ">
|
|
260
|
+
<span class="summary_signature">
|
|
261
|
+
|
|
262
|
+
<a href="#equal%3F-instance_method" title="#equal? (instance method)">#<strong>equal?</strong>(other) ⇒ Boolean </a>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
</span>
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
<span class="summary_desc"><div class='inline'><p>Test for equality between items.</p>
|
|
277
|
+
</div></span>
|
|
278
|
+
|
|
279
|
+
</li>
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
<li class="public ">
|
|
283
|
+
<span class="summary_signature">
|
|
284
|
+
|
|
285
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(date, title, section, note = nil) ⇒ Item </a>
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
</span>
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
<span class="note title constructor">constructor</span>
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
<span class="summary_desc"><div class='inline'><p>Initialize an item with date, title, section, and optional note.</p>
|
|
302
|
+
</div></span>
|
|
303
|
+
|
|
304
|
+
</li>
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
<li class="public ">
|
|
308
|
+
<span class="summary_signature">
|
|
309
|
+
|
|
310
|
+
<a href="#interval-instance_method" title="#interval (instance method)">#<strong>interval</strong> ⇒ Object </a>
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
</span>
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
<span class="summary_desc"><div class='inline'><p>Get the difference between the item's start date and the value of its @done tag (if present).</p>
|
|
325
|
+
</div></span>
|
|
326
|
+
|
|
327
|
+
</li>
|
|
328
|
+
|
|
329
|
+
|
|
330
|
+
<li class="public ">
|
|
331
|
+
<span class="summary_signature">
|
|
332
|
+
|
|
333
|
+
<a href="#overlapping_time%3F-instance_method" title="#overlapping_time? (instance method)">#<strong>overlapping_time?</strong>(item_b) ⇒ Boolean </a>
|
|
334
|
+
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
</span>
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
<span class="summary_desc"><div class='inline'><p>Test if the interval between start date and @done value overlaps with another item's.</p>
|
|
348
|
+
</div></span>
|
|
349
|
+
|
|
350
|
+
</li>
|
|
351
|
+
|
|
352
|
+
|
|
353
|
+
<li class="public ">
|
|
354
|
+
<span class="summary_signature">
|
|
355
|
+
|
|
356
|
+
<a href="#same_time%3F-instance_method" title="#same_time? (instance method)">#<strong>same_time?</strong>(item_b) ⇒ Boolean </a>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
</span>
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
<span class="summary_desc"><div class='inline'><p>Test if two items occur at the same time (same start date and equal duration).</p>
|
|
371
|
+
</div></span>
|
|
372
|
+
|
|
373
|
+
</li>
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
<li class="public ">
|
|
377
|
+
<span class="summary_signature">
|
|
378
|
+
|
|
379
|
+
<a href="#search-instance_method" title="#search (instance method)">#<strong>search</strong>(search, negate: false, case_type: :smart) ⇒ Boolean </a>
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
</span>
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
<span class="summary_desc"><div class='inline'><p>Test if item matches search string.</p>
|
|
394
|
+
</div></span>
|
|
395
|
+
|
|
396
|
+
</li>
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
<li class="public ">
|
|
400
|
+
<span class="summary_signature">
|
|
401
|
+
|
|
402
|
+
<a href="#should_finish%3F-instance_method" title="#should_finish? (instance method)">#<strong>should_finish?</strong> ⇒ Boolean </a>
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
</span>
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
417
|
+
|
|
418
|
+
</li>
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
<li class="public ">
|
|
422
|
+
<span class="summary_signature">
|
|
423
|
+
|
|
424
|
+
<a href="#should_time%3F-instance_method" title="#should_time? (instance method)">#<strong>should_time?</strong> ⇒ Boolean </a>
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
|
|
428
|
+
</span>
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
439
|
+
|
|
440
|
+
</li>
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
<li class="public ">
|
|
444
|
+
<span class="summary_signature">
|
|
445
|
+
|
|
446
|
+
<a href="#tag-instance_method" title="#tag (instance method)">#<strong>tag</strong>(tag, value: nil, remove: false, rename_to: nil, regex: false) ⇒ Object </a>
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
</span>
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
<span class="summary_desc"><div class='inline'><p>Add (or remove) tags from the title of the item.</p>
|
|
461
|
+
</div></span>
|
|
462
|
+
|
|
463
|
+
</li>
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
<li class="public ">
|
|
467
|
+
<span class="summary_signature">
|
|
468
|
+
|
|
469
|
+
<a href="#tags-instance_method" title="#tags (instance method)">#<strong>tags</strong> ⇒ Array </a>
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
</span>
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
<span class="summary_desc"><div class='inline'><p>Get a list of tags on the item.</p>
|
|
484
|
+
</div></span>
|
|
485
|
+
|
|
486
|
+
</li>
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
<li class="public ">
|
|
490
|
+
<span class="summary_signature">
|
|
491
|
+
|
|
492
|
+
<a href="#tags%3F-instance_method" title="#tags? (instance method)">#<strong>tags?</strong>(tags, bool = :and, negate: false) ⇒ Boolean </a>
|
|
493
|
+
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
</span>
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
|
|
506
|
+
<span class="summary_desc"><div class='inline'><p>Test if item contains tag(s).</p>
|
|
507
|
+
</div></span>
|
|
508
|
+
|
|
509
|
+
</li>
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
</ul>
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
<div id="constructor_details" class="method_details_list">
|
|
516
|
+
<h2>Constructor Details</h2>
|
|
517
|
+
|
|
518
|
+
<div class="method_details first">
|
|
519
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
520
|
+
|
|
521
|
+
#<strong>initialize</strong>(date, title, section, note = nil) ⇒ <tt><span class='object_link'><a href="" title="Doing::Item (class)">Item</a></span></tt>
|
|
522
|
+
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
</h3><div class="docstring">
|
|
528
|
+
<div class="discussion">
|
|
529
|
+
<p>Initialize an item with date, title, section, and
|
|
530
|
+
optional note</p>
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
</div>
|
|
534
|
+
</div>
|
|
535
|
+
<div class="tags">
|
|
536
|
+
<p class="tag_title">Parameters:</p>
|
|
537
|
+
<ul class="param">
|
|
538
|
+
|
|
539
|
+
<li>
|
|
540
|
+
|
|
541
|
+
<span class='name'>date</span>
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Time.html" title="Time (class)">Time</a></span></tt>)</span>
|
|
545
|
+
|
|
546
|
+
|
|
547
|
+
|
|
548
|
+
—
|
|
549
|
+
<div class='inline'><p>The item's start date</p>
|
|
550
|
+
</div>
|
|
551
|
+
|
|
552
|
+
</li>
|
|
553
|
+
|
|
554
|
+
<li>
|
|
555
|
+
|
|
556
|
+
<span class='name'>title</span>
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
|
|
560
|
+
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
—
|
|
564
|
+
<div class='inline'><p>The title</p>
|
|
565
|
+
</div>
|
|
566
|
+
|
|
567
|
+
</li>
|
|
568
|
+
|
|
569
|
+
<li>
|
|
570
|
+
|
|
571
|
+
<span class='name'>section</span>
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
—
|
|
579
|
+
<div class='inline'><p>The section to which
|
|
580
|
+
the item belongs</p>
|
|
581
|
+
</div>
|
|
582
|
+
|
|
583
|
+
</li>
|
|
584
|
+
|
|
585
|
+
<li>
|
|
586
|
+
|
|
587
|
+
<span class='name'>note</span>
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span> or <span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
—
|
|
597
|
+
<div class='inline'><p>The note
|
|
598
|
+
(optional)</p>
|
|
599
|
+
</div>
|
|
600
|
+
|
|
601
|
+
</li>
|
|
602
|
+
|
|
603
|
+
</ul>
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
</div>
|
|
607
|
+
</div>
|
|
608
|
+
|
|
609
|
+
</div>
|
|
610
|
+
|
|
611
|
+
<div id="instance_attr_details" class="attr_details">
|
|
612
|
+
<h2>Instance Attribute Details</h2>
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
<span id="date=-instance_method"></span>
|
|
616
|
+
<div class="method_details first">
|
|
617
|
+
<h3 class="signature first" id="date-instance_method">
|
|
618
|
+
|
|
619
|
+
#<strong>date</strong> ⇒ <tt>Object</tt>
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
</h3><div class="docstring">
|
|
626
|
+
<div class="discussion">
|
|
627
|
+
<p>Returns the value of attribute date.</p>
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
</div>
|
|
631
|
+
</div>
|
|
632
|
+
<div class="tags">
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
</div>
|
|
636
|
+
</div>
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
<span id="note=-instance_method"></span>
|
|
640
|
+
<div class="method_details ">
|
|
641
|
+
<h3 class="signature " id="note-instance_method">
|
|
642
|
+
|
|
643
|
+
#<strong>note</strong> ⇒ <tt>Object</tt>
|
|
644
|
+
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
</h3><div class="docstring">
|
|
650
|
+
<div class="discussion">
|
|
651
|
+
<p>Returns the value of attribute note.</p>
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
</div>
|
|
655
|
+
</div>
|
|
656
|
+
<div class="tags">
|
|
657
|
+
|
|
658
|
+
|
|
659
|
+
</div>
|
|
660
|
+
</div>
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
<span id="section=-instance_method"></span>
|
|
664
|
+
<div class="method_details ">
|
|
665
|
+
<h3 class="signature " id="section-instance_method">
|
|
666
|
+
|
|
667
|
+
#<strong>section</strong> ⇒ <tt>Object</tt>
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
</h3><div class="docstring">
|
|
674
|
+
<div class="discussion">
|
|
675
|
+
<p>Returns the value of attribute section.</p>
|
|
676
|
+
|
|
677
|
+
|
|
678
|
+
</div>
|
|
679
|
+
</div>
|
|
680
|
+
<div class="tags">
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
</div>
|
|
684
|
+
</div>
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
<span id="title=-instance_method"></span>
|
|
688
|
+
<div class="method_details ">
|
|
689
|
+
<h3 class="signature " id="title-instance_method">
|
|
690
|
+
|
|
691
|
+
#<strong>title</strong> ⇒ <tt>Object</tt>
|
|
692
|
+
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
</h3><div class="docstring">
|
|
698
|
+
<div class="discussion">
|
|
699
|
+
<p>Returns the value of attribute title.</p>
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
</div>
|
|
703
|
+
</div>
|
|
704
|
+
<div class="tags">
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
</div>
|
|
708
|
+
</div>
|
|
709
|
+
|
|
710
|
+
</div>
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
<div id="instance_method_details" class="method_details_list">
|
|
714
|
+
<h2>Instance Method Details</h2>
|
|
715
|
+
|
|
716
|
+
|
|
717
|
+
<div class="method_details first">
|
|
718
|
+
<h3 class="signature first" id="end_date-instance_method">
|
|
719
|
+
|
|
720
|
+
#<strong>end_date</strong> ⇒ <tt><span class='object_link'><a href="../Time.html" title="Time (class)">Time</a></span></tt>
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
</h3><div class="docstring">
|
|
727
|
+
<div class="discussion">
|
|
728
|
+
<p>Get the value of the item's @done tag</p>
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
</div>
|
|
732
|
+
</div>
|
|
733
|
+
<div class="tags">
|
|
734
|
+
|
|
735
|
+
<p class="tag_title">Returns:</p>
|
|
736
|
+
<ul class="return">
|
|
737
|
+
|
|
738
|
+
<li>
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Time.html" title="Time (class)">Time</a></span></tt>)</span>
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
—
|
|
746
|
+
<div class='inline'><p>@done value</p>
|
|
747
|
+
</div>
|
|
748
|
+
|
|
749
|
+
</li>
|
|
750
|
+
|
|
751
|
+
</ul>
|
|
752
|
+
|
|
753
|
+
</div>
|
|
754
|
+
</div>
|
|
755
|
+
|
|
756
|
+
<div class="method_details ">
|
|
757
|
+
<h3 class="signature " id="equal?-instance_method">
|
|
758
|
+
|
|
759
|
+
#<strong>equal?</strong>(other) ⇒ <tt>Boolean</tt>
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
</h3><div class="docstring">
|
|
766
|
+
<div class="discussion">
|
|
767
|
+
<p>Test for equality between items</p>
|
|
768
|
+
|
|
769
|
+
|
|
770
|
+
</div>
|
|
771
|
+
</div>
|
|
772
|
+
<div class="tags">
|
|
773
|
+
<p class="tag_title">Parameters:</p>
|
|
774
|
+
<ul class="param">
|
|
775
|
+
|
|
776
|
+
<li>
|
|
777
|
+
|
|
778
|
+
<span class='name'>other</span>
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Doing::Item (class)">Item</a></span></tt>)</span>
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
—
|
|
786
|
+
<div class='inline'><p>The other item</p>
|
|
787
|
+
</div>
|
|
788
|
+
|
|
789
|
+
</li>
|
|
790
|
+
|
|
791
|
+
</ul>
|
|
792
|
+
|
|
793
|
+
<p class="tag_title">Returns:</p>
|
|
794
|
+
<ul class="return">
|
|
795
|
+
|
|
796
|
+
<li>
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
—
|
|
804
|
+
<div class='inline'><p>is equal?</p>
|
|
805
|
+
</div>
|
|
806
|
+
|
|
807
|
+
</li>
|
|
808
|
+
|
|
809
|
+
</ul>
|
|
810
|
+
|
|
811
|
+
</div>
|
|
812
|
+
</div>
|
|
813
|
+
|
|
814
|
+
<div class="method_details ">
|
|
815
|
+
<h3 class="signature " id="interval-instance_method">
|
|
816
|
+
|
|
817
|
+
#<strong>interval</strong> ⇒ <tt>Object</tt>
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
</h3><div class="docstring">
|
|
824
|
+
<div class="discussion">
|
|
825
|
+
<p>Get the difference between the item's start date and
|
|
826
|
+
the value of its @done tag (if present)</p>
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
</div>
|
|
830
|
+
</div>
|
|
831
|
+
<div class="tags">
|
|
832
|
+
|
|
833
|
+
<p class="tag_title">Returns:</p>
|
|
834
|
+
<ul class="return">
|
|
835
|
+
|
|
836
|
+
<li>
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
<span class='type'></span>
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
<div class='inline'><p>Interval in seconds</p>
|
|
845
|
+
</div>
|
|
846
|
+
|
|
847
|
+
</li>
|
|
848
|
+
|
|
849
|
+
</ul>
|
|
850
|
+
|
|
851
|
+
</div>
|
|
852
|
+
</div>
|
|
853
|
+
|
|
854
|
+
<div class="method_details ">
|
|
855
|
+
<h3 class="signature " id="overlapping_time?-instance_method">
|
|
856
|
+
|
|
857
|
+
#<strong>overlapping_time?</strong>(item_b) ⇒ <tt>Boolean</tt>
|
|
858
|
+
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
</h3><div class="docstring">
|
|
864
|
+
<div class="discussion">
|
|
865
|
+
<p>Test if the interval between start date and @done
|
|
866
|
+
value overlaps with another item's</p>
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
</div>
|
|
870
|
+
</div>
|
|
871
|
+
<div class="tags">
|
|
872
|
+
<p class="tag_title">Parameters:</p>
|
|
873
|
+
<ul class="param">
|
|
874
|
+
|
|
875
|
+
<li>
|
|
876
|
+
|
|
877
|
+
<span class='name'>item_b</span>
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Doing::Item (class)">Item</a></span></tt>)</span>
|
|
881
|
+
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
—
|
|
885
|
+
<div class='inline'><p>The item to compare</p>
|
|
886
|
+
</div>
|
|
887
|
+
|
|
888
|
+
</li>
|
|
889
|
+
|
|
890
|
+
</ul>
|
|
891
|
+
|
|
892
|
+
<p class="tag_title">Returns:</p>
|
|
893
|
+
<ul class="return">
|
|
894
|
+
|
|
895
|
+
<li>
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
|
|
902
|
+
—
|
|
903
|
+
<div class='inline'><p>overlaps?</p>
|
|
904
|
+
</div>
|
|
905
|
+
|
|
906
|
+
</li>
|
|
907
|
+
|
|
908
|
+
</ul>
|
|
909
|
+
|
|
910
|
+
</div>
|
|
911
|
+
</div>
|
|
912
|
+
|
|
913
|
+
<div class="method_details ">
|
|
914
|
+
<h3 class="signature " id="same_time?-instance_method">
|
|
915
|
+
|
|
916
|
+
#<strong>same_time?</strong>(item_b) ⇒ <tt>Boolean</tt>
|
|
917
|
+
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
</h3><div class="docstring">
|
|
923
|
+
<div class="discussion">
|
|
924
|
+
<p>Test if two items occur at the same time (same start date and equal duration)</p>
|
|
925
|
+
|
|
926
|
+
|
|
927
|
+
</div>
|
|
928
|
+
</div>
|
|
929
|
+
<div class="tags">
|
|
930
|
+
<p class="tag_title">Parameters:</p>
|
|
931
|
+
<ul class="param">
|
|
932
|
+
|
|
933
|
+
<li>
|
|
934
|
+
|
|
935
|
+
<span class='name'>item_b</span>
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
<span class='type'>(<tt><span class='object_link'><a href="" title="Doing::Item (class)">Item</a></span></tt>)</span>
|
|
939
|
+
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
—
|
|
943
|
+
<div class='inline'><p>The item to compare</p>
|
|
944
|
+
</div>
|
|
945
|
+
|
|
946
|
+
</li>
|
|
947
|
+
|
|
948
|
+
</ul>
|
|
949
|
+
|
|
950
|
+
<p class="tag_title">Returns:</p>
|
|
951
|
+
<ul class="return">
|
|
952
|
+
|
|
953
|
+
<li>
|
|
954
|
+
|
|
955
|
+
|
|
956
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
957
|
+
|
|
958
|
+
|
|
959
|
+
|
|
960
|
+
—
|
|
961
|
+
<div class='inline'><p>is equal?</p>
|
|
962
|
+
</div>
|
|
963
|
+
|
|
964
|
+
</li>
|
|
965
|
+
|
|
966
|
+
</ul>
|
|
967
|
+
|
|
968
|
+
</div>
|
|
969
|
+
</div>
|
|
970
|
+
|
|
971
|
+
<div class="method_details ">
|
|
972
|
+
<h3 class="signature " id="search-instance_method">
|
|
973
|
+
|
|
974
|
+
#<strong>search</strong>(search, negate: false, case_type: :smart) ⇒ <tt>Boolean</tt>
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
</h3><div class="docstring">
|
|
981
|
+
<div class="discussion">
|
|
982
|
+
<p>Test if item matches search string</p>
|
|
983
|
+
|
|
984
|
+
|
|
985
|
+
</div>
|
|
986
|
+
</div>
|
|
987
|
+
<div class="tags">
|
|
988
|
+
<p class="tag_title">Parameters:</p>
|
|
989
|
+
<ul class="param">
|
|
990
|
+
|
|
991
|
+
<li>
|
|
992
|
+
|
|
993
|
+
<span class='name'>search</span>
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
|
|
997
|
+
|
|
998
|
+
|
|
999
|
+
|
|
1000
|
+
—
|
|
1001
|
+
<div class='inline'><p>The search string</p>
|
|
1002
|
+
</div>
|
|
1003
|
+
|
|
1004
|
+
</li>
|
|
1005
|
+
|
|
1006
|
+
<li>
|
|
1007
|
+
|
|
1008
|
+
<span class='name'>negate</span>
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1012
|
+
|
|
1013
|
+
|
|
1014
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
|
1015
|
+
|
|
1016
|
+
|
|
1017
|
+
—
|
|
1018
|
+
<div class='inline'><p>negate results</p>
|
|
1019
|
+
</div>
|
|
1020
|
+
|
|
1021
|
+
</li>
|
|
1022
|
+
|
|
1023
|
+
<li>
|
|
1024
|
+
|
|
1025
|
+
<span class='name'>case_type</span>
|
|
1026
|
+
|
|
1027
|
+
|
|
1028
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
|
|
1029
|
+
|
|
1030
|
+
|
|
1031
|
+
<em class="default">(defaults to: <tt>:smart</tt>)</em>
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
—
|
|
1035
|
+
<div class='inline'><p>The case-sensitivity
|
|
1036
|
+
type (:sensitive,
|
|
1037
|
+
:insensitive, :smart)</p>
|
|
1038
|
+
</div>
|
|
1039
|
+
|
|
1040
|
+
</li>
|
|
1041
|
+
|
|
1042
|
+
</ul>
|
|
1043
|
+
|
|
1044
|
+
<p class="tag_title">Returns:</p>
|
|
1045
|
+
<ul class="return">
|
|
1046
|
+
|
|
1047
|
+
<li>
|
|
1048
|
+
|
|
1049
|
+
|
|
1050
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1051
|
+
|
|
1052
|
+
|
|
1053
|
+
|
|
1054
|
+
—
|
|
1055
|
+
<div class='inline'><p>matches search criteria</p>
|
|
1056
|
+
</div>
|
|
1057
|
+
|
|
1058
|
+
</li>
|
|
1059
|
+
|
|
1060
|
+
</ul>
|
|
1061
|
+
|
|
1062
|
+
</div>
|
|
1063
|
+
</div>
|
|
1064
|
+
|
|
1065
|
+
<div class="method_details ">
|
|
1066
|
+
<h3 class="signature " id="should_finish?-instance_method">
|
|
1067
|
+
|
|
1068
|
+
#<strong>should_finish?</strong> ⇒ <tt>Boolean</tt>
|
|
1069
|
+
|
|
1070
|
+
|
|
1071
|
+
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
</h3><div class="docstring">
|
|
1075
|
+
<div class="discussion">
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
</div>
|
|
1079
|
+
</div>
|
|
1080
|
+
<div class="tags">
|
|
1081
|
+
|
|
1082
|
+
<p class="tag_title">Returns:</p>
|
|
1083
|
+
<ul class="return">
|
|
1084
|
+
|
|
1085
|
+
<li>
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
</li>
|
|
1093
|
+
|
|
1094
|
+
</ul>
|
|
1095
|
+
|
|
1096
|
+
</div>
|
|
1097
|
+
</div>
|
|
1098
|
+
|
|
1099
|
+
<div class="method_details ">
|
|
1100
|
+
<h3 class="signature " id="should_time?-instance_method">
|
|
1101
|
+
|
|
1102
|
+
#<strong>should_time?</strong> ⇒ <tt>Boolean</tt>
|
|
1103
|
+
|
|
1104
|
+
|
|
1105
|
+
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
</h3><div class="docstring">
|
|
1109
|
+
<div class="discussion">
|
|
1110
|
+
|
|
1111
|
+
|
|
1112
|
+
</div>
|
|
1113
|
+
</div>
|
|
1114
|
+
<div class="tags">
|
|
1115
|
+
|
|
1116
|
+
<p class="tag_title">Returns:</p>
|
|
1117
|
+
<ul class="return">
|
|
1118
|
+
|
|
1119
|
+
<li>
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
|
|
1126
|
+
</li>
|
|
1127
|
+
|
|
1128
|
+
</ul>
|
|
1129
|
+
|
|
1130
|
+
</div>
|
|
1131
|
+
</div>
|
|
1132
|
+
|
|
1133
|
+
<div class="method_details ">
|
|
1134
|
+
<h3 class="signature " id="tag-instance_method">
|
|
1135
|
+
|
|
1136
|
+
#<strong>tag</strong>(tag, value: nil, remove: false, rename_to: nil, regex: false) ⇒ <tt>Object</tt>
|
|
1137
|
+
|
|
1138
|
+
|
|
1139
|
+
|
|
1140
|
+
|
|
1141
|
+
|
|
1142
|
+
</h3><div class="docstring">
|
|
1143
|
+
<div class="discussion">
|
|
1144
|
+
<p>Add (or remove) tags from the title of the item</p>
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
</div>
|
|
1148
|
+
</div>
|
|
1149
|
+
<div class="tags">
|
|
1150
|
+
<p class="tag_title">Parameters:</p>
|
|
1151
|
+
<ul class="param">
|
|
1152
|
+
|
|
1153
|
+
<li>
|
|
1154
|
+
|
|
1155
|
+
<span class='name'>tag</span>
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
|
|
1159
|
+
|
|
1160
|
+
|
|
1161
|
+
|
|
1162
|
+
—
|
|
1163
|
+
<div class='inline'><p>The tag to add</p>
|
|
1164
|
+
</div>
|
|
1165
|
+
|
|
1166
|
+
</li>
|
|
1167
|
+
|
|
1168
|
+
<li>
|
|
1169
|
+
|
|
1170
|
+
<span class='name'>value</span>
|
|
1171
|
+
|
|
1172
|
+
|
|
1173
|
+
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
|
|
1174
|
+
|
|
1175
|
+
|
|
1176
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1177
|
+
|
|
1178
|
+
|
|
1179
|
+
—
|
|
1180
|
+
<div class='inline'><p>A value to include as @tag(value)</p>
|
|
1181
|
+
</div>
|
|
1182
|
+
|
|
1183
|
+
</li>
|
|
1184
|
+
|
|
1185
|
+
<li>
|
|
1186
|
+
|
|
1187
|
+
<span class='name'>remove</span>
|
|
1188
|
+
|
|
1189
|
+
|
|
1190
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1191
|
+
|
|
1192
|
+
|
|
1193
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
|
1194
|
+
|
|
1195
|
+
|
|
1196
|
+
—
|
|
1197
|
+
<div class='inline'><p>if true remove instead of adding</p>
|
|
1198
|
+
</div>
|
|
1199
|
+
|
|
1200
|
+
</li>
|
|
1201
|
+
|
|
1202
|
+
<li>
|
|
1203
|
+
|
|
1204
|
+
<span class='name'>rename_to</span>
|
|
1205
|
+
|
|
1206
|
+
|
|
1207
|
+
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
|
|
1208
|
+
|
|
1209
|
+
|
|
1210
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1211
|
+
|
|
1212
|
+
|
|
1213
|
+
—
|
|
1214
|
+
<div class='inline'><p>if not nil, rename target tag to this tag name</p>
|
|
1215
|
+
</div>
|
|
1216
|
+
|
|
1217
|
+
</li>
|
|
1218
|
+
|
|
1219
|
+
<li>
|
|
1220
|
+
|
|
1221
|
+
<span class='name'>regex</span>
|
|
1222
|
+
|
|
1223
|
+
|
|
1224
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
—
|
|
1231
|
+
<div class='inline'><p>treat target tag string as regex pattern</p>
|
|
1232
|
+
</div>
|
|
1233
|
+
|
|
1234
|
+
</li>
|
|
1235
|
+
|
|
1236
|
+
</ul>
|
|
1237
|
+
|
|
1238
|
+
|
|
1239
|
+
</div>
|
|
1240
|
+
</div>
|
|
1241
|
+
|
|
1242
|
+
<div class="method_details ">
|
|
1243
|
+
<h3 class="signature " id="tags-instance_method">
|
|
1244
|
+
|
|
1245
|
+
#<strong>tags</strong> ⇒ <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>
|
|
1246
|
+
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
|
|
1250
|
+
|
|
1251
|
+
</h3><div class="docstring">
|
|
1252
|
+
<div class="discussion">
|
|
1253
|
+
<p>Get a list of tags on the item</p>
|
|
1254
|
+
|
|
1255
|
+
|
|
1256
|
+
</div>
|
|
1257
|
+
</div>
|
|
1258
|
+
<div class="tags">
|
|
1259
|
+
|
|
1260
|
+
<p class="tag_title">Returns:</p>
|
|
1261
|
+
<ul class="return">
|
|
1262
|
+
|
|
1263
|
+
<li>
|
|
1264
|
+
|
|
1265
|
+
|
|
1266
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
|
|
1267
|
+
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
—
|
|
1271
|
+
<div class='inline'><p>array of tags (no values)</p>
|
|
1272
|
+
</div>
|
|
1273
|
+
|
|
1274
|
+
</li>
|
|
1275
|
+
|
|
1276
|
+
</ul>
|
|
1277
|
+
|
|
1278
|
+
</div>
|
|
1279
|
+
</div>
|
|
1280
|
+
|
|
1281
|
+
<div class="method_details ">
|
|
1282
|
+
<h3 class="signature " id="tags?-instance_method">
|
|
1283
|
+
|
|
1284
|
+
#<strong>tags?</strong>(tags, bool = :and, negate: false) ⇒ <tt>Boolean</tt>
|
|
1285
|
+
|
|
1286
|
+
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
|
|
1290
|
+
</h3><div class="docstring">
|
|
1291
|
+
<div class="discussion">
|
|
1292
|
+
<p>Test if item contains tag(s)</p>
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
</div>
|
|
1296
|
+
</div>
|
|
1297
|
+
<div class="tags">
|
|
1298
|
+
<p class="tag_title">Parameters:</p>
|
|
1299
|
+
<ul class="param">
|
|
1300
|
+
|
|
1301
|
+
<li>
|
|
1302
|
+
|
|
1303
|
+
<span class='name'>tags</span>
|
|
1304
|
+
|
|
1305
|
+
|
|
1306
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span> or <span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
|
|
1307
|
+
|
|
1308
|
+
|
|
1309
|
+
|
|
1310
|
+
—
|
|
1311
|
+
<div class='inline'><p>The tags to test. Can be an array or a comma-separated string.</p>
|
|
1312
|
+
</div>
|
|
1313
|
+
|
|
1314
|
+
</li>
|
|
1315
|
+
|
|
1316
|
+
<li>
|
|
1317
|
+
|
|
1318
|
+
<span class='name'>bool</span>
|
|
1319
|
+
|
|
1320
|
+
|
|
1321
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
|
|
1322
|
+
|
|
1323
|
+
|
|
1324
|
+
<em class="default">(defaults to: <tt>:and</tt>)</em>
|
|
1325
|
+
|
|
1326
|
+
|
|
1327
|
+
—
|
|
1328
|
+
<div class='inline'><p>The boolean to use for multiple tags (:and, :or, :not)</p>
|
|
1329
|
+
</div>
|
|
1330
|
+
|
|
1331
|
+
</li>
|
|
1332
|
+
|
|
1333
|
+
<li>
|
|
1334
|
+
|
|
1335
|
+
<span class='name'>negate</span>
|
|
1336
|
+
|
|
1337
|
+
|
|
1338
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1339
|
+
|
|
1340
|
+
|
|
1341
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
|
1342
|
+
|
|
1343
|
+
|
|
1344
|
+
—
|
|
1345
|
+
<div class='inline'><p>negate the result?</p>
|
|
1346
|
+
</div>
|
|
1347
|
+
|
|
1348
|
+
</li>
|
|
1349
|
+
|
|
1350
|
+
</ul>
|
|
1351
|
+
|
|
1352
|
+
<p class="tag_title">Returns:</p>
|
|
1353
|
+
<ul class="return">
|
|
1354
|
+
|
|
1355
|
+
<li>
|
|
1356
|
+
|
|
1357
|
+
|
|
1358
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
1359
|
+
|
|
1360
|
+
|
|
1361
|
+
|
|
1362
|
+
—
|
|
1363
|
+
<div class='inline'><p>true if tag/bool combination passes</p>
|
|
1364
|
+
</div>
|
|
1365
|
+
|
|
1366
|
+
</li>
|
|
1367
|
+
|
|
1368
|
+
</ul>
|
|
1369
|
+
|
|
1370
|
+
</div>
|
|
1371
|
+
</div>
|
|
1372
|
+
|
|
1373
|
+
</div>
|
|
1374
|
+
|
|
1375
|
+
</div>
|
|
1376
|
+
|
|
1377
|
+
<div id="footer">
|
|
1378
|
+
Generated on Thu Nov 18 16:39:11 2021 by
|
|
1379
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1380
|
+
0.9.26 (ruby-3.0.1).
|
|
1381
|
+
</div>
|
|
1382
|
+
|
|
1383
|
+
</div>
|
|
1384
|
+
</body>
|
|
1385
|
+
</html>
|