doing 2.0.25 → 2.1.0pre
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardoc/checksums +18 -15
- data/.yardoc/object_types +0 -0
- data/.yardoc/objects/root.dat +0 -0
- data/CHANGELOG.md +28 -0
- data/Gemfile.lock +8 -1
- data/README.md +1 -1
- data/Rakefile +23 -4
- data/bin/doing +205 -127
- data/doc/Array.html +354 -1
- data/doc/Doing/Color.html +104 -92
- data/doc/Doing/Completion.html +216 -0
- data/doc/Doing/Configuration.html +340 -5
- data/doc/Doing/Content.html +229 -0
- data/doc/Doing/Errors/DoingNoTraceError.html +1 -1
- data/doc/Doing/Errors/DoingRuntimeError.html +1 -1
- data/doc/Doing/Errors/DoingStandardError.html +1 -1
- data/doc/Doing/Errors/EmptyInput.html +1 -1
- data/doc/Doing/Errors/NoResults.html +1 -1
- data/doc/Doing/Errors/PluginException.html +1 -1
- data/doc/Doing/Errors/UserCancelled.html +1 -1
- data/doc/Doing/Errors/WrongCommand.html +1 -1
- data/doc/Doing/Errors.html +1 -1
- data/doc/Doing/Hooks.html +1 -1
- data/doc/Doing/Item.html +337 -49
- data/doc/Doing/Items.html +444 -35
- data/doc/Doing/LogAdapter.html +139 -51
- data/doc/Doing/Note.html +253 -22
- data/doc/Doing/Pager.html +74 -36
- data/doc/Doing/Plugins.html +1 -1
- data/doc/Doing/Prompt.html +674 -0
- data/doc/Doing/Section.html +354 -0
- data/doc/Doing/Util.html +57 -1
- data/doc/Doing/WWID.html +477 -670
- data/doc/Doing/WWIDFile.html +398 -0
- data/doc/Doing.html +5 -5
- data/doc/GLI/Commands/MarkdownDocumentListener.html +1 -1
- data/doc/GLI/Commands.html +1 -1
- data/doc/GLI.html +1 -1
- data/doc/Hash.html +97 -1
- data/doc/Status.html +37 -3
- data/doc/String.html +599 -23
- data/doc/Symbol.html +3 -3
- data/doc/Time.html +1 -1
- data/doc/_index.html +22 -1
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +8 -2
- data/doc/index.html +8 -2
- data/doc/method_list.html +453 -173
- data/doc/top-level-namespace.html +1 -1
- data/doing.gemspec +3 -0
- data/doing.rdoc +40 -12
- data/example_plugin.rb +3 -3
- data/lib/completion/_doing.zsh +1 -1
- data/lib/completion/doing.bash +8 -8
- data/lib/completion/doing.fish +1 -1
- data/lib/doing/array.rb +36 -0
- data/lib/doing/colors.rb +70 -66
- data/lib/doing/completion.rb +6 -0
- data/lib/doing/configuration.rb +69 -28
- data/lib/doing/hash.rb +37 -0
- data/lib/doing/item.rb +77 -12
- data/lib/doing/items.rb +125 -0
- data/lib/doing/log_adapter.rb +55 -3
- data/lib/doing/note.rb +53 -1
- data/lib/doing/pager.rb +49 -38
- data/lib/doing/plugins/export/markdown_export.rb +4 -4
- data/lib/doing/plugins/export/template_export.rb +2 -2
- data/lib/doing/plugins/import/calendar_import.rb +4 -4
- data/lib/doing/plugins/import/doing_import.rb +5 -7
- data/lib/doing/plugins/import/timing_import.rb +3 -3
- data/lib/doing/prompt.rb +206 -0
- data/lib/doing/section.rb +30 -0
- data/lib/doing/string.rb +103 -27
- data/lib/doing/util.rb +14 -6
- data/lib/doing/version.rb +1 -1
- data/lib/doing/wwid.rb +306 -621
- data/lib/doing.rb +6 -2
- data/lib/examples/plugins/capture_thing_import.rb +162 -0
- metadata +73 -5
- data/lib/doing/wwidfile.rb +0 -117
data/doc/Doing/Color.html
CHANGED
|
@@ -81,7 +81,7 @@
|
|
|
81
81
|
|
|
82
82
|
<dl>
|
|
83
83
|
<dt>Included in:</dt>
|
|
84
|
-
<dd><span class='object_link'><a href="" title="Doing::Color (module)">Color</a></span>, <span class='object_link'><a href="../String.html" title="String (class)">String</a></span></dd>
|
|
84
|
+
<dd><span class='object_link'><a href="" title="Doing::Color (module)">Color</a></span>, <span class='object_link'><a href="Prompt.html" title="Doing::Prompt (module)">Prompt</a></span>, <span class='object_link'><a href="WWID.html" title="Doing::WWID (class)">WWID</a></span>, <span class='object_link'><a href="../String.html" title="String (class)">String</a></span></dd>
|
|
85
85
|
</dl>
|
|
86
86
|
|
|
87
87
|
|
|
@@ -93,7 +93,17 @@
|
|
|
93
93
|
|
|
94
94
|
</div>
|
|
95
95
|
|
|
96
|
+
<h2>Overview</h2><div class="docstring">
|
|
97
|
+
<div class="discussion">
|
|
98
|
+
<p>Terminal color functions</p>
|
|
99
|
+
|
|
96
100
|
|
|
101
|
+
</div>
|
|
102
|
+
</div>
|
|
103
|
+
<div class="tags">
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
</div>
|
|
97
107
|
|
|
98
108
|
<h2>
|
|
99
109
|
Constant Summary
|
|
@@ -116,58 +126,58 @@
|
|
|
116
126
|
</div>
|
|
117
127
|
</dt>
|
|
118
128
|
<dd><pre class="code"><span class='lbracket'>[</span>
|
|
119
|
-
<span class='lbracket'>[</span
|
|
120
|
-
</span> <span class='lbracket'>[</span
|
|
121
|
-
</span> <span class='lbracket'>[</span
|
|
122
|
-
<span class='lbracket'>[</span
|
|
123
|
-
<span class='lbracket'>[</span
|
|
124
|
-
</span> <span class='lbracket'>[</span
|
|
125
|
-
<span class='lbracket'>[</span
|
|
126
|
-
</span> <span class='lbracket'>[</span
|
|
127
|
-
<span class='lbracket'>[</span
|
|
128
|
-
</span> <span class='lbracket'>[</span
|
|
129
|
-
</span> <span class='lbracket'>[</span
|
|
130
|
-
<span class='lbracket'>[</span
|
|
131
|
-
</span> <span class='lbracket'>[</span
|
|
132
|
-
<span class='lbracket'>[</span
|
|
133
|
-
<span class='lbracket'>[</span
|
|
134
|
-
<span class='lbracket'>[</span
|
|
135
|
-
<span class='lbracket'>[</span
|
|
136
|
-
<span class='lbracket'>[</span
|
|
137
|
-
<span class='lbracket'>[</span
|
|
138
|
-
<span class='lbracket'>[</span
|
|
139
|
-
<span class='lbracket'>[</span
|
|
140
|
-
<span class='lbracket'>[</span
|
|
141
|
-
<span class='lbracket'>[</span
|
|
142
|
-
<span class='lbracket'>[</span
|
|
143
|
-
<span class='lbracket'>[</span
|
|
144
|
-
<span class='lbracket'>[</span
|
|
145
|
-
<span class='lbracket'>[</span
|
|
146
|
-
<span class='lbracket'>[</span
|
|
147
|
-
<span class='lbracket'>[</span
|
|
148
|
-
</span> <span class='lbracket'>[</span
|
|
149
|
-
<span class='lbracket'>[</span
|
|
150
|
-
<span class='lbracket'>[</span
|
|
151
|
-
<span class='lbracket'>[</span
|
|
152
|
-
<span class='lbracket'>[</span
|
|
153
|
-
<span class='lbracket'>[</span
|
|
154
|
-
<span class='lbracket'>[</span
|
|
155
|
-
<span class='lbracket'>[</span
|
|
156
|
-
</span> <span class='lbracket'>[</span
|
|
157
|
-
<span class='lbracket'>[</span
|
|
158
|
-
<span class='lbracket'>[</span
|
|
159
|
-
<span class='lbracket'>[</span
|
|
160
|
-
<span class='lbracket'>[</span
|
|
161
|
-
<span class='lbracket'>[</span
|
|
162
|
-
<span class='lbracket'>[</span
|
|
163
|
-
<span class='lbracket'>[</span
|
|
164
|
-
<span class='lbracket'>[</span
|
|
165
|
-
<span class='lbracket'>[</span
|
|
166
|
-
<span class='lbracket'>[</span
|
|
167
|
-
<span class='lbracket'>[</span
|
|
168
|
-
<span class='lbracket'>[</span
|
|
169
|
-
<span class='lbracket'>[</span
|
|
170
|
-
<span class='rbracket'>]</span></pre></dd>
|
|
129
|
+
<span class='lbracket'>[</span><span class='symbol'>:clear</span><span class='comma'>,</span> <span class='int'>0</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='comment'># String#clear is already used to empty string in Ruby 1.9
|
|
130
|
+
</span> <span class='lbracket'>[</span><span class='symbol'>:reset</span><span class='comma'>,</span> <span class='int'>0</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='comment'># synonym for :clear
|
|
131
|
+
</span> <span class='lbracket'>[</span><span class='symbol'>:bold</span><span class='comma'>,</span> <span class='int'>1</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
132
|
+
<span class='lbracket'>[</span><span class='symbol'>:dark</span><span class='comma'>,</span> <span class='int'>2</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
133
|
+
<span class='lbracket'>[</span><span class='symbol'>:italic</span><span class='comma'>,</span> <span class='int'>3</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='comment'># not widely implemented
|
|
134
|
+
</span> <span class='lbracket'>[</span><span class='symbol'>:underline</span><span class='comma'>,</span> <span class='int'>4</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
135
|
+
<span class='lbracket'>[</span><span class='symbol'>:underscore</span><span class='comma'>,</span> <span class='int'>4</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='comment'># synonym for :underline
|
|
136
|
+
</span> <span class='lbracket'>[</span><span class='symbol'>:blink</span><span class='comma'>,</span> <span class='int'>5</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
137
|
+
<span class='lbracket'>[</span><span class='symbol'>:rapid_blink</span><span class='comma'>,</span> <span class='int'>6</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='comment'># not widely implemented
|
|
138
|
+
</span> <span class='lbracket'>[</span><span class='symbol'>:negative</span><span class='comma'>,</span> <span class='int'>7</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='comment'># no reverse because of String#reverse
|
|
139
|
+
</span> <span class='lbracket'>[</span><span class='symbol'>:concealed</span><span class='comma'>,</span> <span class='int'>8</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
140
|
+
<span class='lbracket'>[</span><span class='symbol'>:strikethrough</span><span class='comma'>,</span> <span class='int'>9</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='comment'># not widely implemented
|
|
141
|
+
</span> <span class='lbracket'>[</span><span class='symbol'>:black</span><span class='comma'>,</span> <span class='int'>30</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
142
|
+
<span class='lbracket'>[</span><span class='symbol'>:red</span><span class='comma'>,</span> <span class='int'>31</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
143
|
+
<span class='lbracket'>[</span><span class='symbol'>:green</span><span class='comma'>,</span> <span class='int'>32</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
144
|
+
<span class='lbracket'>[</span><span class='symbol'>:yellow</span><span class='comma'>,</span> <span class='int'>33</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
145
|
+
<span class='lbracket'>[</span><span class='symbol'>:blue</span><span class='comma'>,</span> <span class='int'>34</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
146
|
+
<span class='lbracket'>[</span><span class='symbol'>:magenta</span><span class='comma'>,</span> <span class='int'>35</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
147
|
+
<span class='lbracket'>[</span><span class='symbol'>:cyan</span><span class='comma'>,</span> <span class='int'>36</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
148
|
+
<span class='lbracket'>[</span><span class='symbol'>:white</span><span class='comma'>,</span> <span class='int'>37</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
149
|
+
<span class='lbracket'>[</span><span class='symbol'>:bgblack</span><span class='comma'>,</span> <span class='int'>40</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
150
|
+
<span class='lbracket'>[</span><span class='symbol'>:bgred</span><span class='comma'>,</span> <span class='int'>41</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
151
|
+
<span class='lbracket'>[</span><span class='symbol'>:bggreen</span><span class='comma'>,</span> <span class='int'>42</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
152
|
+
<span class='lbracket'>[</span><span class='symbol'>:bgyellow</span><span class='comma'>,</span> <span class='int'>43</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
153
|
+
<span class='lbracket'>[</span><span class='symbol'>:bgblue</span><span class='comma'>,</span> <span class='int'>44</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
154
|
+
<span class='lbracket'>[</span><span class='symbol'>:bgmagenta</span><span class='comma'>,</span> <span class='int'>45</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
155
|
+
<span class='lbracket'>[</span><span class='symbol'>:bgcyan</span><span class='comma'>,</span> <span class='int'>46</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
156
|
+
<span class='lbracket'>[</span><span class='symbol'>:bgwhite</span><span class='comma'>,</span> <span class='int'>47</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
157
|
+
<span class='lbracket'>[</span><span class='symbol'>:boldblack</span><span class='comma'>,</span> <span class='int'>90</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='comment'># High intensity, aixterm (works in OS X)
|
|
158
|
+
</span> <span class='lbracket'>[</span><span class='symbol'>:boldred</span><span class='comma'>,</span> <span class='int'>91</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
159
|
+
<span class='lbracket'>[</span><span class='symbol'>:boldgreen</span><span class='comma'>,</span> <span class='int'>92</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
160
|
+
<span class='lbracket'>[</span><span class='symbol'>:boldyellow</span><span class='comma'>,</span> <span class='int'>93</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
161
|
+
<span class='lbracket'>[</span><span class='symbol'>:boldblue</span><span class='comma'>,</span> <span class='int'>94</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
162
|
+
<span class='lbracket'>[</span><span class='symbol'>:boldmagenta</span><span class='comma'>,</span> <span class='int'>95</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
163
|
+
<span class='lbracket'>[</span><span class='symbol'>:boldcyan</span><span class='comma'>,</span> <span class='int'>96</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
164
|
+
<span class='lbracket'>[</span><span class='symbol'>:boldwhite</span><span class='comma'>,</span> <span class='int'>97</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
165
|
+
<span class='lbracket'>[</span><span class='symbol'>:boldbgblack</span><span class='comma'>,</span> <span class='int'>100</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='comment'># High intensity background, aixterm (works in OS X)
|
|
166
|
+
</span> <span class='lbracket'>[</span><span class='symbol'>:boldbgred</span><span class='comma'>,</span> <span class='int'>101</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
167
|
+
<span class='lbracket'>[</span><span class='symbol'>:boldbggreen</span><span class='comma'>,</span> <span class='int'>102</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
168
|
+
<span class='lbracket'>[</span><span class='symbol'>:boldbgyellow</span><span class='comma'>,</span> <span class='int'>103</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
169
|
+
<span class='lbracket'>[</span><span class='symbol'>:boldbgblue</span><span class='comma'>,</span> <span class='int'>104</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
170
|
+
<span class='lbracket'>[</span><span class='symbol'>:boldbgmagenta</span><span class='comma'>,</span> <span class='int'>105</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
171
|
+
<span class='lbracket'>[</span><span class='symbol'>:boldbgcyan</span><span class='comma'>,</span> <span class='int'>106</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
172
|
+
<span class='lbracket'>[</span><span class='symbol'>:boldbgwhite</span><span class='comma'>,</span> <span class='int'>107</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
173
|
+
<span class='lbracket'>[</span><span class='symbol'>:softpurple</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>0;35;40</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
174
|
+
<span class='lbracket'>[</span><span class='symbol'>:hotpants</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>7;34;40</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
175
|
+
<span class='lbracket'>[</span><span class='symbol'>:knightrider</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>7;30;40</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
176
|
+
<span class='lbracket'>[</span><span class='symbol'>:flamingo</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>7;31;47</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
177
|
+
<span class='lbracket'>[</span><span class='symbol'>:yeller</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>1;37;43</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
178
|
+
<span class='lbracket'>[</span><span class='symbol'>:whiteboard</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>1;30;47</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
179
|
+
<span class='lbracket'>[</span><span class='symbol'>:default</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>0;39</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
|
180
|
+
<span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&</span><span class='symbol'>:freeze</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span></pre></dd>
|
|
171
181
|
|
|
172
182
|
<dt id="ATTRIBUTE_NAMES-constant" class="">ATTRIBUTE_NAMES =
|
|
173
183
|
|
|
@@ -196,21 +206,13 @@ uncoloring strings.</p>
|
|
|
196
206
|
|
|
197
207
|
|
|
198
208
|
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
<h2>
|
|
204
|
-
Class Method Summary
|
|
205
|
-
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
206
|
-
</h2>
|
|
207
|
-
|
|
208
|
-
<ul class="summary">
|
|
209
|
-
|
|
210
|
-
<li class="public ">
|
|
209
|
+
<h2>Class Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
210
|
+
<ul class="summary">
|
|
211
|
+
|
|
212
|
+
<li class="public ">
|
|
211
213
|
<span class="summary_signature">
|
|
212
214
|
|
|
213
|
-
<a href="#
|
|
215
|
+
<a href="#coloring-class_method" title="coloring (class method)">.<strong>coloring</strong> ⇒ Object </a>
|
|
214
216
|
|
|
215
217
|
|
|
216
218
|
|
|
@@ -218,22 +220,37 @@ uncoloring strings.</p>
|
|
|
218
220
|
|
|
219
221
|
|
|
220
222
|
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
221
226
|
|
|
222
227
|
|
|
223
228
|
|
|
224
229
|
|
|
225
230
|
|
|
226
231
|
|
|
227
|
-
<span class="summary_desc"><div class='inline'
|
|
228
|
-
</div></span>
|
|
232
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
229
233
|
|
|
230
234
|
</li>
|
|
231
235
|
|
|
236
|
+
|
|
237
|
+
</ul>
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
<h2>
|
|
244
|
+
Class Method Summary
|
|
245
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
246
|
+
</h2>
|
|
247
|
+
|
|
248
|
+
<ul class="summary">
|
|
232
249
|
|
|
233
250
|
<li class="public ">
|
|
234
251
|
<span class="summary_signature">
|
|
235
252
|
|
|
236
|
-
<a href="#
|
|
253
|
+
<a href="#attributes-class_method" title="attributes (class method)">.<strong>attributes</strong> ⇒ Object </a>
|
|
237
254
|
|
|
238
255
|
|
|
239
256
|
|
|
@@ -247,7 +264,7 @@ uncoloring strings.</p>
|
|
|
247
264
|
|
|
248
265
|
|
|
249
266
|
|
|
250
|
-
<span class="summary_desc"><div class='inline'><p>
|
|
267
|
+
<span class="summary_desc"><div class='inline'><p>Returns an array of all Doing::Color attributes as symbols.</p>
|
|
251
268
|
</div></span>
|
|
252
269
|
|
|
253
270
|
</li>
|
|
@@ -335,37 +352,34 @@ uncoloring strings.</p>
|
|
|
335
352
|
|
|
336
353
|
|
|
337
354
|
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
<h2>Class Method Details</h2>
|
|
341
|
-
|
|
355
|
+
<div id="class_attr_details" class="attr_details">
|
|
356
|
+
<h2>Class Attribute Details</h2>
|
|
342
357
|
|
|
358
|
+
|
|
359
|
+
<span id="coloring=-class_method"></span>
|
|
343
360
|
<div class="method_details first">
|
|
344
|
-
<h3 class="signature first" id="
|
|
361
|
+
<h3 class="signature first" id="coloring-class_method">
|
|
345
362
|
|
|
346
|
-
.<strong>
|
|
363
|
+
.<strong>coloring</strong> ⇒ <tt>Object</tt>
|
|
347
364
|
|
|
348
365
|
|
|
349
366
|
|
|
350
367
|
|
|
351
368
|
|
|
352
|
-
</h3
|
|
353
|
-
|
|
354
|
-
|
|
369
|
+
</h3>
|
|
370
|
+
</div>
|
|
371
|
+
|
|
372
|
+
</div>
|
|
355
373
|
|
|
356
374
|
|
|
357
|
-
|
|
358
|
-
</
|
|
359
|
-
<div class="tags">
|
|
360
|
-
|
|
375
|
+
<div id="class_method_details" class="method_details_list">
|
|
376
|
+
<h2>Class Method Details</h2>
|
|
361
377
|
|
|
362
|
-
</div>
|
|
363
|
-
</div>
|
|
364
378
|
|
|
365
|
-
<div class="method_details ">
|
|
366
|
-
<h3 class="signature " id="
|
|
379
|
+
<div class="method_details first">
|
|
380
|
+
<h3 class="signature first" id="attributes-class_method">
|
|
367
381
|
|
|
368
|
-
.<strong>
|
|
382
|
+
.<strong>attributes</strong> ⇒ <tt>Object</tt>
|
|
369
383
|
|
|
370
384
|
|
|
371
385
|
|
|
@@ -373,9 +387,7 @@ uncoloring strings.</p>
|
|
|
373
387
|
|
|
374
388
|
</h3><div class="docstring">
|
|
375
389
|
<div class="discussion">
|
|
376
|
-
<p>
|
|
377
|
-
this for example:
|
|
378
|
-
Doing::Color::coloring = STDOUT.isatty</p>
|
|
390
|
+
<p>Returns an array of all Doing::Color attributes as symbols.</p>
|
|
379
391
|
|
|
380
392
|
|
|
381
393
|
</div>
|
|
@@ -496,7 +508,7 @@ ANSI-sequences are stripped from the string.</p>
|
|
|
496
508
|
</div>
|
|
497
509
|
|
|
498
510
|
<div id="footer">
|
|
499
|
-
Generated on
|
|
511
|
+
Generated on Sat Nov 27 10:06:03 2021 by
|
|
500
512
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
501
513
|
0.9.26 (ruby-3.0.1).
|
|
502
514
|
</div>
|
|
@@ -0,0 +1,216 @@
|
|
|
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::Completion
|
|
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::Completion";
|
|
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 (C)</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">Completion</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::Completion
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
|
|
71
|
+
|
|
72
|
+
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
<dl>
|
|
80
|
+
<dt>Defined in:</dt>
|
|
81
|
+
<dd>lib/doing/completion.rb</dd>
|
|
82
|
+
</dl>
|
|
83
|
+
|
|
84
|
+
</div>
|
|
85
|
+
|
|
86
|
+
<h2>Overview</h2><div class="docstring">
|
|
87
|
+
<div class="discussion">
|
|
88
|
+
<p>Completion script generator</p>
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
</div>
|
|
92
|
+
</div>
|
|
93
|
+
<div class="tags">
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
</div>
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
<h2>
|
|
105
|
+
Class Method Summary
|
|
106
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
107
|
+
</h2>
|
|
108
|
+
|
|
109
|
+
<ul class="summary">
|
|
110
|
+
|
|
111
|
+
<li class="public ">
|
|
112
|
+
<span class="summary_signature">
|
|
113
|
+
|
|
114
|
+
<a href="#generate_completion-class_method" title="generate_completion (class method)">.<strong>generate_completion</strong>(type: 'zsh', file: 'stdout') ⇒ Object </a>
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
</span>
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
<span class="summary_desc"><div class='inline'><p>Generate a completion script and output to file or stdout.</p>
|
|
129
|
+
</div></span>
|
|
130
|
+
|
|
131
|
+
</li>
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
</ul>
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
<div id="class_method_details" class="method_details_list">
|
|
140
|
+
<h2>Class Method Details</h2>
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
<div class="method_details first">
|
|
144
|
+
<h3 class="signature first" id="generate_completion-class_method">
|
|
145
|
+
|
|
146
|
+
.<strong>generate_completion</strong>(type: 'zsh', file: 'stdout') ⇒ <tt>Object</tt>
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
</h3><div class="docstring">
|
|
153
|
+
<div class="discussion">
|
|
154
|
+
<p>Generate a completion script and output to file or
|
|
155
|
+
stdout</p>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
</div>
|
|
159
|
+
</div>
|
|
160
|
+
<div class="tags">
|
|
161
|
+
<p class="tag_title">Parameters:</p>
|
|
162
|
+
<ul class="param">
|
|
163
|
+
|
|
164
|
+
<li>
|
|
165
|
+
|
|
166
|
+
<span class='name'>type</span>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
<em class="default">(defaults to: <tt>'zsh'</tt>)</em>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
—
|
|
176
|
+
<div class='inline'><p>shell to generate for (zsh|bash|fish)</p>
|
|
177
|
+
</div>
|
|
178
|
+
|
|
179
|
+
</li>
|
|
180
|
+
|
|
181
|
+
<li>
|
|
182
|
+
|
|
183
|
+
<span class='name'>file</span>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
<em class="default">(defaults to: <tt>'stdout'</tt>)</em>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
—
|
|
193
|
+
<div class='inline'><p>Path to save to, or 'stdout'</p>
|
|
194
|
+
</div>
|
|
195
|
+
|
|
196
|
+
</li>
|
|
197
|
+
|
|
198
|
+
</ul>
|
|
199
|
+
|
|
200
|
+
|
|
201
|
+
</div>
|
|
202
|
+
</div>
|
|
203
|
+
|
|
204
|
+
</div>
|
|
205
|
+
|
|
206
|
+
</div>
|
|
207
|
+
|
|
208
|
+
<div id="footer">
|
|
209
|
+
Generated on Sat Nov 27 10:06:03 2021 by
|
|
210
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
211
|
+
0.9.26 (ruby-3.0.1).
|
|
212
|
+
</div>
|
|
213
|
+
|
|
214
|
+
</div>
|
|
215
|
+
</body>
|
|
216
|
+
</html>
|