doing 2.1.40 → 2.1.41
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/.yardopts +1 -1
- data/CHANGELOG.md +22 -0
- data/Gemfile.lock +1 -1
- data/Rakefile +4 -4
- data/bin/commands/changes.rb +1 -1
- data/bin/commands/tag_dir.rb +49 -15
- data/{Dockerfile → docker/Dockerfile} +3 -1
- data/{Dockerfile-2.6 → docker/Dockerfile-2.6} +2 -2
- data/{Dockerfile-2.7 → docker/Dockerfile-2.7} +2 -2
- data/{Dockerfile-3.0 → docker/Dockerfile-3.0} +2 -2
- data/{bash_profile → docker/bash_profile} +0 -0
- data/{inputrc → docker/inputrc} +0 -0
- data/docs/doc/Array.html +84 -2
- data/docs/doc/BooleanTermParser/Clause.html +1 -1
- data/docs/doc/BooleanTermParser/Operator.html +1 -1
- data/docs/doc/BooleanTermParser/Query.html +1 -1
- data/docs/doc/BooleanTermParser/QueryParser.html +1 -1
- data/docs/doc/BooleanTermParser/QueryTransformer.html +1 -1
- data/docs/doc/BooleanTermParser.html +1 -1
- data/docs/doc/Doing/ArrayNestedHash.html +198 -0
- data/docs/doc/Doing/ArrayTags.html +424 -0
- data/docs/doc/Doing/CSVExport.html +266 -0
- data/docs/doc/Doing/CalendarImport.html +232 -0
- data/docs/doc/Doing/Change.html +617 -0
- data/docs/doc/Doing/Changes.html +468 -0
- data/docs/doc/Doing/ChronifyArray.html +347 -0
- data/docs/doc/Doing/ChronifyNumeric.html +271 -0
- data/docs/doc/Doing/ChronifyString.html +682 -0
- data/docs/doc/Doing/Color.html +2 -2
- data/docs/doc/Doing/Completion/BashCompletions.html +445 -0
- data/docs/doc/Doing/Completion/FishCompletions.html +445 -0
- data/docs/doc/Doing/Completion/StringUtils.html +229 -0
- data/docs/doc/Doing/Completion/ZshCompletions.html +445 -0
- data/docs/doc/Doing/Completion.html +17 -3
- data/docs/doc/Doing/Configuration.html +1 -1
- data/docs/doc/Doing/DayOneRenderer.html +383 -0
- data/docs/doc/Doing/DayoneExport.html +290 -0
- data/docs/doc/Doing/DoingImport.html +391 -0
- data/docs/doc/Doing/Entry.html +381 -0
- data/docs/doc/Doing/Errors/DoingNoTraceError.html +1 -1
- data/docs/doc/Doing/Errors/DoingRuntimeError.html +1 -1
- data/docs/doc/Doing/Errors/DoingStandardError.html +1 -1
- data/docs/doc/Doing/Errors/EmptyInput.html +1 -1
- data/docs/doc/Doing/Errors/HistoryLimitError.html +1 -1
- data/docs/doc/Doing/Errors/InvalidPlugin.html +1 -1
- data/docs/doc/Doing/Errors/MissingBackupFile.html +1 -1
- data/docs/doc/Doing/Errors/NoResults.html +1 -1
- data/docs/doc/Doing/Errors/PluginException.html +1 -1
- data/docs/doc/Doing/Errors/UserCancelled.html +1 -1
- data/docs/doc/Doing/Errors/WrongCommand.html +1 -1
- data/docs/doc/Doing/Errors.html +1 -1
- data/docs/doc/Doing/HTMLExport.html +256 -0
- data/docs/doc/Doing/Hooks.html +1 -1
- data/docs/doc/Doing/Item.html +47 -3
- data/docs/doc/Doing/ItemDates.html +564 -0
- data/docs/doc/Doing/ItemQuery.html +614 -0
- data/docs/doc/Doing/ItemState.html +387 -0
- data/docs/doc/Doing/ItemTags.html +498 -0
- data/docs/doc/Doing/Items.html +460 -11
- data/docs/doc/Doing/JSONExport.html +222 -0
- data/docs/doc/Doing/Logger.html +1 -1
- data/docs/doc/Doing/MarkdownExport.html +266 -0
- data/docs/doc/Doing/MarkdownRenderer.html +383 -0
- data/docs/doc/Doing/Note.html +16 -3
- data/docs/doc/Doing/Pager.html +1 -1
- data/docs/doc/Doing/Plugins.html +1 -1
- data/docs/doc/Doing/Prompt.html +31 -682
- data/docs/doc/Doing/PromptChoose.html +484 -0
- data/docs/doc/Doing/PromptFZF.html +391 -0
- data/docs/doc/Doing/PromptInput.html +572 -0
- data/docs/doc/Doing/PromptSTD.html +293 -0
- data/docs/doc/Doing/PromptYN.html +237 -0
- data/docs/doc/Doing/Section.html +58 -2
- data/docs/doc/Doing/StringHighlight.html +533 -0
- data/docs/doc/Doing/StringNormalize.html +929 -0
- data/docs/doc/Doing/StringQuery.html +725 -0
- data/docs/doc/Doing/StringTags.html +884 -0
- data/docs/doc/Doing/StringTransform.html +565 -0
- data/docs/doc/Doing/StringTruncate.html +448 -0
- data/docs/doc/Doing/StringURL.html +409 -0
- data/docs/doc/Doing/SymbolNormalize.html +341 -0
- data/docs/doc/Doing/TaskPaperExport.html +222 -0
- data/docs/doc/Doing/TemplateExport.html +249 -0
- data/docs/doc/Doing/TemplateString.html +101 -2
- data/docs/doc/Doing/TimingImport.html +285 -0
- data/docs/doc/Doing/Types.html +1 -1
- data/docs/doc/Doing/Util/Backup.html +9 -7
- data/docs/doc/Doing/Util.html +2 -2
- data/docs/doc/Doing/Version.html +523 -0
- data/docs/doc/Doing/WWID/WWIDUtil.html +510 -0
- data/docs/doc/Doing/WWID.html +4377 -217
- data/docs/doc/Doing/WWIDDisplay.html +865 -0
- data/docs/doc/Doing/WWIDEditor.html +466 -0
- data/docs/doc/Doing/WWIDFileTools.html +359 -0
- data/docs/doc/Doing/WWIDFilter.html +466 -0
- data/docs/doc/Doing/WWIDGuess.html +299 -0
- data/docs/doc/Doing/WWIDInteractive.html +752 -0
- data/docs/doc/Doing/WWIDModify.html +1078 -0
- data/docs/doc/Doing/WWIDTags.html +302 -0
- data/docs/doc/Doing/WWIDTimers.html +359 -0
- data/docs/doc/Doing/WWIDUtil.html +510 -0
- data/docs/doc/Doing.html +9 -6
- data/docs/doc/FalseClass.html +1 -1
- data/docs/doc/GLI/Commands/Help.html +1 -1
- data/docs/doc/GLI/Commands/MarkdownDocumentListener.html +1 -1
- data/docs/doc/GLI/Commands.html +1 -1
- data/docs/doc/GLI.html +1 -1
- data/docs/doc/Hash.html +1 -1
- data/docs/doc/Numeric.html +23 -78
- data/docs/doc/Object.html +1 -1
- data/docs/doc/PhraseParser/Operator.html +1 -1
- data/docs/doc/PhraseParser/PhraseClause.html +1 -1
- data/docs/doc/PhraseParser/Query.html +1 -1
- data/docs/doc/PhraseParser/QueryParser.html +1 -1
- data/docs/doc/PhraseParser/QueryTransformer.html +1 -1
- data/docs/doc/PhraseParser/TermClause.html +1 -1
- data/docs/doc/PhraseParser.html +1 -1
- data/docs/doc/Status.html +1 -1
- data/docs/doc/String.html +58 -633
- data/docs/doc/Symbol.html +9 -224
- data/docs/doc/Time.html +119 -13
- data/docs/doc/TrueClass.html +1 -1
- data/docs/doc/_index.html +324 -8
- data/docs/doc/class_list.html +1 -1
- data/docs/doc/file.README.html +1 -1
- data/docs/doc/index.html +1 -1
- data/docs/doc/method_list.html +2326 -542
- data/docs/doc/top-level-namespace.html +2 -2
- data/doing.rdoc +13 -3
- data/lib/completion/_doing.zsh +1 -1
- data/lib/completion/doing.bash +2 -2
- data/lib/completion/doing.fish +3 -1
- data/lib/doing/array/array.rb +16 -12
- data/lib/doing/array/nested_hash.rb +1 -1
- data/lib/doing/array/tags.rb +6 -5
- data/lib/doing/changelog/changelog.rb +6 -0
- data/lib/doing/chronify/array.rb +1 -3
- data/lib/doing/chronify/chronify.rb +12 -0
- data/lib/doing/chronify/numeric.rb +3 -2
- data/lib/doing/chronify/string.rb +1 -1
- data/lib/doing/completion/completion_string.rb +25 -0
- data/lib/doing/completion.rb +1 -1
- data/lib/doing/good.rb +8 -0
- data/lib/doing/item/dates.rb +1 -1
- data/lib/doing/{item.rb → item/item.rb} +10 -5
- data/lib/doing/item/query.rb +1 -1
- data/lib/doing/item/state.rb +1 -1
- data/lib/doing/item/tags.rb +1 -1
- data/lib/doing/items/filter.rb +67 -0
- data/lib/doing/items/items.rb +57 -0
- data/lib/doing/items/modify.rb +36 -0
- data/lib/doing/items/sections.rb +83 -0
- data/lib/doing/items/util.rb +74 -0
- data/lib/doing/normalize.rb +10 -2
- data/lib/doing/plugins/export/markdown_export.rb +4 -2
- data/lib/doing/plugins/import/doing_import.rb +1 -1
- data/lib/doing/prompt/choose.rb +118 -0
- data/lib/doing/prompt/fzf.rb +84 -0
- data/lib/doing/prompt/input.rb +129 -0
- data/lib/doing/prompt/prompt.rb +41 -0
- data/lib/doing/prompt/std.rb +32 -0
- data/lib/doing/prompt/yn.rb +64 -0
- data/lib/doing/section.rb +4 -0
- data/lib/doing/string/highlight.rb +1 -1
- data/lib/doing/string/query.rb +1 -1
- data/lib/doing/string/string.rb +18 -7
- data/lib/doing/string/tags.rb +14 -3
- data/lib/doing/string/transform.rb +1 -1
- data/lib/doing/string/truncate.rb +1 -1
- data/lib/doing/string/url.rb +1 -1
- data/lib/doing/time.rb +19 -1
- data/lib/doing/util_backup.rb +2 -2
- data/lib/doing/version.rb +1 -1
- data/lib/doing/wwid/display.rb +357 -360
- data/lib/doing/wwid/editor.rb +173 -176
- data/lib/doing/wwid/filetools.rb +156 -159
- data/lib/doing/wwid/filter.rb +191 -183
- data/lib/doing/wwid/guess.rb +58 -60
- data/lib/doing/wwid/interactive.rb +332 -330
- data/lib/doing/wwid/modify.rb +509 -512
- data/lib/doing/wwid/tags.rb +38 -41
- data/lib/doing/wwid/timers.rb +293 -296
- data/lib/doing/{wwid.rb → wwid/wwid.rb} +32 -23
- data/lib/doing/wwid/wwidutil.rb +79 -82
- data/lib/doing.rb +5 -5
- data/lib/helpers/threaded_tests.rb +1 -0
- metadata +76 -14
- data/lib/doing/changelog.rb +0 -6
- data/lib/doing/completion/string.rb +0 -17
- data/lib/doing/items.rb +0 -221
- data/lib/doing/prompt.rb +0 -330
|
@@ -0,0 +1,302 @@
|
|
|
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
|
+
Module: Doing::WWIDTags
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.27
|
|
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::WWIDTags";
|
|
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 (W)</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">WWIDTags</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>Module: Doing::WWIDTags
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
<dl>
|
|
78
|
+
<dt>Included in:</dt>
|
|
79
|
+
<dd><span class='object_link'><a href="WWID.html" title="Doing::WWID (class)">WWID</a></span></dd>
|
|
80
|
+
</dl>
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
<dl>
|
|
85
|
+
<dt>Defined in:</dt>
|
|
86
|
+
<dd>lib/doing/wwid/tags.rb</dd>
|
|
87
|
+
</dl>
|
|
88
|
+
|
|
89
|
+
</div>
|
|
90
|
+
|
|
91
|
+
<h2>Overview</h2><div class="docstring">
|
|
92
|
+
<div class="discussion">
|
|
93
|
+
<p>Tag methods for WWID class</p>
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
</div>
|
|
97
|
+
</div>
|
|
98
|
+
<div class="tags">
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
</div>
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
<h2>
|
|
110
|
+
Instance Method Summary
|
|
111
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
112
|
+
</h2>
|
|
113
|
+
|
|
114
|
+
<ul class="summary">
|
|
115
|
+
|
|
116
|
+
<li class="public ">
|
|
117
|
+
<span class="summary_signature">
|
|
118
|
+
|
|
119
|
+
<a href="#all_tags-instance_method" title="#all_tags (instance method)">#<strong>all_tags</strong>(items, opt: {}, counts: false) ⇒ Hash, Array </a>
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
</span>
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
<span class="summary_desc"><div class='inline'><p>List all tags that exist on given items.</p>
|
|
134
|
+
</div></span>
|
|
135
|
+
|
|
136
|
+
</li>
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
<li class="public ">
|
|
140
|
+
<span class="summary_signature">
|
|
141
|
+
|
|
142
|
+
<a href="#tag_groups-instance_method" title="#tag_groups (instance method)">#<strong>tag_groups</strong>(items, opt: {}) ⇒ Object </a>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
</span>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
157
|
+
|
|
158
|
+
</li>
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
</ul>
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
<div id="instance_method_details" class="method_details_list">
|
|
167
|
+
<h2>Instance Method Details</h2>
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
<div class="method_details first">
|
|
171
|
+
<h3 class="signature first" id="all_tags-instance_method">
|
|
172
|
+
|
|
173
|
+
#<strong>all_tags</strong>(items, opt: {}, counts: false) ⇒ <tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>, <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
</h3><div class="docstring">
|
|
180
|
+
<div class="discussion">
|
|
181
|
+
<p>List all tags that exist on given items</p>
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
</div>
|
|
185
|
+
</div>
|
|
186
|
+
<div class="tags">
|
|
187
|
+
<p class="tag_title">Parameters:</p>
|
|
188
|
+
<ul class="param">
|
|
189
|
+
|
|
190
|
+
<li>
|
|
191
|
+
|
|
192
|
+
<span class='name'>items</span>
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
—
|
|
200
|
+
<div class='inline'><p>array of Item</p>
|
|
201
|
+
</div>
|
|
202
|
+
|
|
203
|
+
</li>
|
|
204
|
+
|
|
205
|
+
<li>
|
|
206
|
+
|
|
207
|
+
<span class='name'>opt</span>
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
—
|
|
217
|
+
<div class='inline'><p>additional options</p>
|
|
218
|
+
</div>
|
|
219
|
+
|
|
220
|
+
</li>
|
|
221
|
+
|
|
222
|
+
<li>
|
|
223
|
+
|
|
224
|
+
<span class='name'>counts</span>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
<em class="default">(defaults to: <tt>false</tt>)</em>
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
—
|
|
234
|
+
<div class='inline'><p>Include tag counts in
|
|
235
|
+
results</p>
|
|
236
|
+
</div>
|
|
237
|
+
|
|
238
|
+
</li>
|
|
239
|
+
|
|
240
|
+
</ul>
|
|
241
|
+
|
|
242
|
+
<p class="tag_title">Returns:</p>
|
|
243
|
+
<ul class="return">
|
|
244
|
+
|
|
245
|
+
<li>
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Hash.html" title="Hash (class)">Hash</a></span></tt>)</span>
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
—
|
|
253
|
+
<div class='inline'><p>if counts is true, returns a hash with {
|
|
254
|
+
tag: count }.</p>
|
|
255
|
+
</div>
|
|
256
|
+
|
|
257
|
+
</li>
|
|
258
|
+
|
|
259
|
+
<li>
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span></tt>)</span>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
—
|
|
267
|
+
<div class='inline'><p>If counts is false, returns a simple
|
|
268
|
+
array of tags.</p>
|
|
269
|
+
</div>
|
|
270
|
+
|
|
271
|
+
</li>
|
|
272
|
+
|
|
273
|
+
</ul>
|
|
274
|
+
|
|
275
|
+
</div>
|
|
276
|
+
</div>
|
|
277
|
+
|
|
278
|
+
<div class="method_details ">
|
|
279
|
+
<h3 class="signature " id="tag_groups-instance_method">
|
|
280
|
+
|
|
281
|
+
#<strong>tag_groups</strong>(items, opt: {}) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
</h3>
|
|
288
|
+
</div>
|
|
289
|
+
|
|
290
|
+
</div>
|
|
291
|
+
|
|
292
|
+
</div>
|
|
293
|
+
|
|
294
|
+
<div id="footer">
|
|
295
|
+
Generated on Tue Mar 15 17:54:05 2022 by
|
|
296
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
297
|
+
0.9.27 (ruby-3.0.1).
|
|
298
|
+
</div>
|
|
299
|
+
|
|
300
|
+
</div>
|
|
301
|
+
</body>
|
|
302
|
+
</html>
|
|
@@ -0,0 +1,359 @@
|
|
|
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
|
+
Module: Doing::WWIDTimers
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.27
|
|
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::WWIDTimers";
|
|
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 (W)</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">WWIDTimers</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>Module: Doing::WWIDTimers
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
<dl>
|
|
78
|
+
<dt>Included in:</dt>
|
|
79
|
+
<dd><span class='object_link'><a href="WWID.html" title="Doing::WWID (class)">WWID</a></span></dd>
|
|
80
|
+
</dl>
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
<dl>
|
|
85
|
+
<dt>Defined in:</dt>
|
|
86
|
+
<dd>lib/doing/wwid/timers.rb</dd>
|
|
87
|
+
</dl>
|
|
88
|
+
|
|
89
|
+
</div>
|
|
90
|
+
|
|
91
|
+
<h2>Overview</h2><div class="docstring">
|
|
92
|
+
<div class="discussion">
|
|
93
|
+
<p>Timer methods for WWID class</p>
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
</div>
|
|
97
|
+
</div>
|
|
98
|
+
<div class="tags">
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
</div>
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
<h2>
|
|
110
|
+
Instance Method Summary
|
|
111
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
112
|
+
</h2>
|
|
113
|
+
|
|
114
|
+
<ul class="summary">
|
|
115
|
+
|
|
116
|
+
<li class="public ">
|
|
117
|
+
<span class="summary_signature">
|
|
118
|
+
|
|
119
|
+
<a href="#get_interval-instance_method" title="#get_interval (instance method)">#<strong>get_interval</strong>(item, formatted: true, record: true) ⇒ Object </a>
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
</span>
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
<span class="summary_desc"><div class='inline'><p>Gets the interval between entry's start date and @done date.</p>
|
|
134
|
+
</div></span>
|
|
135
|
+
|
|
136
|
+
</li>
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
<li class="public ">
|
|
140
|
+
<span class="summary_signature">
|
|
141
|
+
|
|
142
|
+
<a href="#tag_times-instance_method" title="#tag_times (instance method)">#<strong>tag_times</strong>(format: :text, sort_by: :time, sort_order: :asc) ⇒ Object </a>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
</span>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
<span class="summary_desc"><div class='inline'><p>Get total elapsed time for all tags in selection.</p>
|
|
157
|
+
</div></span>
|
|
158
|
+
|
|
159
|
+
</li>
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
</ul>
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
<div id="instance_method_details" class="method_details_list">
|
|
168
|
+
<h2>Instance Method Details</h2>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
<div class="method_details first">
|
|
172
|
+
<h3 class="signature first" id="get_interval-instance_method">
|
|
173
|
+
|
|
174
|
+
#<strong>get_interval</strong>(item, formatted: true, record: true) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
</h3><div class="docstring">
|
|
181
|
+
<div class="discussion">
|
|
182
|
+
<p>Gets the interval between entry's start
|
|
183
|
+
date and @done date</p>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
</div>
|
|
187
|
+
</div>
|
|
188
|
+
<div class="tags">
|
|
189
|
+
<p class="tag_title">Parameters:</p>
|
|
190
|
+
<ul class="param">
|
|
191
|
+
|
|
192
|
+
<li>
|
|
193
|
+
|
|
194
|
+
<span class='name'>item</span>
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
<span class='type'>(<tt><span class='object_link'><a href="Item.html" title="Doing::Item (class)">Item</a></span></tt>)</span>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
—
|
|
202
|
+
<div class='inline'><p>The entry</p>
|
|
203
|
+
</div>
|
|
204
|
+
|
|
205
|
+
</li>
|
|
206
|
+
|
|
207
|
+
<li>
|
|
208
|
+
|
|
209
|
+
<span class='name'>formatted</span>
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
<em class="default">(defaults to: <tt>true</tt>)</em>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
—
|
|
219
|
+
<div class='inline'><p>Return human readable
|
|
220
|
+
time (default seconds)</p>
|
|
221
|
+
</div>
|
|
222
|
+
|
|
223
|
+
</li>
|
|
224
|
+
|
|
225
|
+
<li>
|
|
226
|
+
|
|
227
|
+
<span class='name'>record</span>
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
<em class="default">(defaults to: <tt>true</tt>)</em>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
—
|
|
237
|
+
<div class='inline'><p>Add the interval to the
|
|
238
|
+
total for each tag</p>
|
|
239
|
+
</div>
|
|
240
|
+
|
|
241
|
+
</li>
|
|
242
|
+
|
|
243
|
+
</ul>
|
|
244
|
+
|
|
245
|
+
<p class="tag_title">Returns:</p>
|
|
246
|
+
<ul class="return">
|
|
247
|
+
|
|
248
|
+
<li>
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
<span class='type'></span>
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
<div class='inline'><p>Interval in seconds, or [d, h, m] array if
|
|
257
|
+
formatted is true. False if no end date or
|
|
258
|
+
interval is 0</p>
|
|
259
|
+
</div>
|
|
260
|
+
|
|
261
|
+
</li>
|
|
262
|
+
|
|
263
|
+
</ul>
|
|
264
|
+
|
|
265
|
+
</div>
|
|
266
|
+
</div>
|
|
267
|
+
|
|
268
|
+
<div class="method_details ">
|
|
269
|
+
<h3 class="signature " id="tag_times-instance_method">
|
|
270
|
+
|
|
271
|
+
#<strong>tag_times</strong>(format: :text, sort_by: :time, sort_order: :asc) ⇒ <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
</h3><div class="docstring">
|
|
278
|
+
<div class="discussion">
|
|
279
|
+
<p>Get total elapsed time for all tags in
|
|
280
|
+
selection</p>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
</div>
|
|
284
|
+
</div>
|
|
285
|
+
<div class="tags">
|
|
286
|
+
<p class="tag_title">Parameters:</p>
|
|
287
|
+
<ul class="param">
|
|
288
|
+
|
|
289
|
+
<li>
|
|
290
|
+
|
|
291
|
+
<span class='name'>format</span>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
<em class="default">(defaults to: <tt>:text</tt>)</em>
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
—
|
|
301
|
+
<div class='inline'><p>return format (html,
|
|
302
|
+
json, or text)</p>
|
|
303
|
+
</div>
|
|
304
|
+
|
|
305
|
+
</li>
|
|
306
|
+
|
|
307
|
+
<li>
|
|
308
|
+
|
|
309
|
+
<span class='name'>sort_by</span>
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
<em class="default">(defaults to: <tt>:time</tt>)</em>
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
—
|
|
319
|
+
<div class='inline'><p>Sort by :name or :time</p>
|
|
320
|
+
</div>
|
|
321
|
+
|
|
322
|
+
</li>
|
|
323
|
+
|
|
324
|
+
<li>
|
|
325
|
+
|
|
326
|
+
<span class='name'>sort_order</span>
|
|
327
|
+
|
|
328
|
+
|
|
329
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span></tt>)</span>
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
<em class="default">(defaults to: <tt>:asc</tt>)</em>
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
—
|
|
336
|
+
<div class='inline'><p>The sort order (:asc or :desc)</p>
|
|
337
|
+
</div>
|
|
338
|
+
|
|
339
|
+
</li>
|
|
340
|
+
|
|
341
|
+
</ul>
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
</div>
|
|
345
|
+
</div>
|
|
346
|
+
|
|
347
|
+
</div>
|
|
348
|
+
|
|
349
|
+
</div>
|
|
350
|
+
|
|
351
|
+
<div id="footer">
|
|
352
|
+
Generated on Tue Mar 15 17:54:06 2022 by
|
|
353
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
354
|
+
0.9.27 (ruby-3.0.1).
|
|
355
|
+
</div>
|
|
356
|
+
|
|
357
|
+
</div>
|
|
358
|
+
</body>
|
|
359
|
+
</html>
|