term_utils 0.4.0 → 0.5.0
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/CHANGELOG.md +7 -0
- data/COPYING +1 -1
- data/Rakefile +6 -0
- data/doc/TermUtils/AP/Article.html +13 -13
- data/doc/TermUtils/AP/ArticleResult.html +4 -4
- data/doc/TermUtils/AP/Flag.html +8 -8
- data/doc/TermUtils/AP/Parameter.html +9 -9
- data/doc/TermUtils/AP/ParameterResult.html +4 -4
- data/doc/TermUtils/AP/ParameterWalkerHooks.html +4 -4
- data/doc/TermUtils/AP/ParseError.html +646 -14
- data/doc/TermUtils/AP/Parser.html +43 -15
- data/doc/TermUtils/AP/Result.html +4 -4
- data/doc/TermUtils/AP/Syntax.html +4 -4
- data/doc/TermUtils/AP/SyntaxError.html +4 -86
- data/doc/TermUtils/AP/Walker.html +4 -4
- data/doc/TermUtils/AP.html +16 -16
- data/doc/TermUtils/FF/Config.html +8 -8
- data/doc/TermUtils/FF/Context.html +4 -4
- data/doc/TermUtils/FF/Entry.html +4 -4
- data/doc/TermUtils/FF/Finder.html +850 -0
- data/doc/TermUtils/FF/FinderEntry.html +1191 -0
- data/doc/TermUtils/FF/FinderQuery.html +946 -0
- data/doc/TermUtils/FF/Query.html +11 -15
- data/doc/TermUtils/FF.html +131 -7
- data/doc/TermUtils/PropertyTreeNode.html +6 -6
- data/doc/TermUtils/Tab/Column.html +44 -44
- data/doc/TermUtils/Tab/Header.html +19 -19
- data/doc/TermUtils/Tab/Holder.html +40 -40
- data/doc/TermUtils/Tab/Printer.html +4 -4
- data/doc/TermUtils/Tab/Table.html +59 -59
- data/doc/TermUtils/Tab/TableError.html +4 -86
- data/doc/TermUtils/Tab.html +42 -42
- data/doc/TermUtils.html +6 -6
- data/doc/_index.html +29 -23
- data/doc/class_list.html +1 -1
- data/doc/css/style.css +1 -0
- data/doc/file.README.html +25 -21
- data/doc/frames.html +1 -1
- data/doc/index.html +25 -21
- data/doc/method_list.html +385 -89
- data/doc/top-level-namespace.html +4 -4
- data/lib/term_utils/ap/article.rb +2 -2
- data/lib/term_utils/ap/flag.rb +2 -2
- data/lib/term_utils/ap/parameter.rb +2 -2
- data/lib/term_utils/ap/parser.rb +16 -15
- data/lib/term_utils/ap/result.rb +2 -2
- data/lib/term_utils/ap/syntax.rb +2 -2
- data/lib/term_utils/ap.rb +66 -22
- data/lib/term_utils/ff/config.rb +3 -3
- data/lib/term_utils/ff/entry.rb +2 -2
- data/lib/term_utils/ff/finder.rb +255 -0
- data/lib/term_utils/ff/query.rb +6 -8
- data/lib/term_utils/ff.rb +4 -3
- data/lib/term_utils/property_tree_node.rb +3 -3
- data/lib/term_utils/tab.rb +14 -13
- data/lib/term_utils.rb +2 -2
- data/term_utils.gemspec +2 -2
- metadata +8 -5
- data/doc/TermUtils/AP/NoSuchValueError.html +0 -217
data/doc/index.html
CHANGED
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
File: README
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.34
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -57,26 +57,27 @@
|
|
57
57
|
<div class="clear"></div>
|
58
58
|
</div>
|
59
59
|
|
60
|
-
<div id="content"><div id='filecontents'>
|
61
|
-
<h1 id="term_utils">term_utils</h1>
|
60
|
+
<div id="content"><div id='filecontents'><h1 id="termutils">term_utils</h1>
|
62
61
|
|
63
62
|
<h2 id="purpose">Purpose</h2>
|
64
63
|
|
65
64
|
<p>Provides utilities like argument parsing, table formatting and file finding.</p>
|
66
65
|
|
67
|
-
<h2 id="
|
66
|
+
<h2 id="getting-started">Getting Started</h2>
|
68
67
|
|
69
68
|
<p>Install term_utils at the command prompt:</p>
|
70
69
|
|
71
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_term_utils'>term_utils</span
|
70
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_term_utils'>term_utils</span>
|
71
|
+
</code></pre>
|
72
72
|
|
73
73
|
<p>Require term_utils in the source file:</p>
|
74
74
|
|
75
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>term_utils</span><span class='tstring_end'>'</span></span
|
75
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>term_utils</span><span class='tstring_end'>'</span></span>
|
76
|
+
</code></pre>
|
76
77
|
|
77
78
|
<h2 id="content">Content</h2>
|
78
79
|
|
79
|
-
<h3 id="
|
80
|
+
<h3 id="argument-parsing">Argument Parsing</h3>
|
80
81
|
|
81
82
|
<p>Exmaple:</p>
|
82
83
|
|
@@ -103,21 +104,23 @@
|
|
103
104
|
<span class='kw'>end</span>
|
104
105
|
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>limit: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_limit'>limit</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
105
106
|
<span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>paths:</span><span class='tstring_end'>"</span></span>
|
106
|
-
<span class='id identifier rubyid_paths'>paths</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_p'>p</span><span class='op'>|</span> <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_p'>p</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span
|
107
|
+
<span class='id identifier rubyid_paths'>paths</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_p'>p</span><span class='op'>|</span> <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_p'>p</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span> <span class='rbrace'>}</span>
|
108
|
+
</code></pre>
|
107
109
|
|
108
110
|
<p>See the <a href="manual/ARGUMENT_PARSING.md">manual</a> for more details.</p>
|
109
111
|
|
110
|
-
<h3 id="
|
112
|
+
<h3 id="table-formatting">Table Formatting</h3>
|
111
113
|
|
112
114
|
<p>Take the following table:</p>
|
113
115
|
|
114
|
-
<pre class="code ruby"><code class="ruby">
|
115
|
-
|
116
|
-
|
116
|
+
<pre class="code ruby"><code class="ruby"> id string8 string16
|
117
|
+
---- -------- ----------------
|
118
|
+
1 Fiat Lux Fiat Lux
|
117
119
|
2 Alea ... Alea jacta est
|
118
|
-
3 Audac... Audaces fortuna juvat
|
119
|
-
|
120
|
-
|
120
|
+
3 Audac... Audaces fortuna juvat
|
121
|
+
---- -------- ----------------
|
122
|
+
id string8 string16
|
123
|
+
</code></pre>
|
121
124
|
|
122
125
|
<p>You can produce it with the following code:</p>
|
123
126
|
|
@@ -144,13 +147,14 @@
|
|
144
147
|
<span class='id identifier rubyid_tpr'>tpr</span><span class='period'>.</span><span class='id identifier rubyid_separator'>separator</span>
|
145
148
|
<span class='id identifier rubyid_tpr'>tpr</span><span class='period'>.</span><span class='id identifier rubyid_header'>header</span>
|
146
149
|
<span class='id identifier rubyid_tpr'>tpr</span><span class='period'>.</span><span class='id identifier rubyid_line'>line</span>
|
147
|
-
<span class='kw'>end</span
|
150
|
+
<span class='kw'>end</span>
|
151
|
+
</code></pre>
|
148
152
|
|
149
|
-
<h3 id="
|
153
|
+
<h3 id="file-finding">File Finding</h3>
|
150
154
|
|
151
155
|
<p>The File Finding module provides a way to query the filesystem.</p>
|
152
156
|
|
153
|
-
<h2 id="
|
157
|
+
<h2 id="version-history">Version History</h2>
|
154
158
|
|
155
159
|
<p><a href="CHANGELOG.md">CHANGELOG</a></p>
|
156
160
|
|
@@ -160,9 +164,9 @@
|
|
160
164
|
</div></div>
|
161
165
|
|
162
166
|
<div id="footer">
|
163
|
-
Generated on
|
164
|
-
<a href="
|
165
|
-
0.9.
|
167
|
+
Generated on Wed Aug 9 17:34:25 2023 by
|
168
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
169
|
+
0.9.34 (ruby-3.2.2).
|
166
170
|
</div>
|
167
171
|
|
168
172
|
</div>
|