Debian Codegraph @

doc-api/classes/Kwalify/Main.html

raw
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE html
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <head>
8 <title>Class: Kwalify::Main</title>
9 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
10 <meta http-equiv="Content-Script-Type" content="text/javascript" />
11 <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
12 <script type="text/javascript">
13 // <![CDATA[
14
15 function popupCode( url ) {
16 window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
17 }
18
19 function toggleCode( id ) {
20 if ( document.getElementById )
21 elem = document.getElementById( id );
22 else if ( document.all )
23 elem = eval( "document.all." + id );
24 else
25 return false;
26
27 elemStyle = elem.style;
28
29 if ( elemStyle.display != "block" ) {
30 elemStyle.display = "block"
31 } else {
32 elemStyle.display = "none"
33 }
34
35 return true;
36 }
37
38 // Make codeblocks hidden by default
39 document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
40
41 // ]]>
42 </script>
43
44 </head>
45 <body>
46
47
48
49 <div id="classHeader">
50 <table class="header-table">
51 <tr class="top-aligned-row">
52 <td><strong>Class</strong></td>
53 <td class="class-name-in-header">Kwalify::Main</td>
54 </tr>
55 <tr class="top-aligned-row">
56 <td><strong>In:</strong></td>
57 <td>
58 <a href="../../files/kwalify/main_rb.html">
59 kwalify/main.rb
60 </a>
61 <br />
62 </td>
63 </tr>
64
65 <tr class="top-aligned-row">
66 <td><strong>Parent:</strong></td>
67 <td>
68 Object
69 </td>
70 </tr>
71 </table>
72 </div>
73 <!-- banner header -->
74
75 <div id="bodyContent">
76
77
78
79 <div id="contextContent">
80
81 <div id="description">
82 <p>
83 ex.
84 </p>
85 <pre>
86 command = File.basename($0)
87 begin
88 main = Kwalify::Main.new(command)
89 s = main.execute
90 print s if s
91 rescue Kwalify::CommandOptionError =&gt; ex
92 $stderr.puts &quot;ERROR: #{ex.message}&quot;
93 exit 1
94 rescue Kwalify::KwalifyError =&gt; ex
95 $stderr.puts &quot;ERROR: #{ex.message}&quot;
96 exit 1
97 end
98 </pre>
99
100 </div>
101
102
103 </div>
104
105 <div id="method-list">
106 <h3 class="section-bar">Methods</h3>
107
108 <div class="name-list">
109 <a href="#M000078">_inspect</a>&nbsp;&nbsp;
110 <a href="#M000077">debug?</a>&nbsp;&nbsp;
111 <a href="#M000079">execute</a>&nbsp;&nbsp;
112 <a href="#M000080">main</a>&nbsp;&nbsp;
113 <a href="#M000076">new</a>&nbsp;&nbsp;
114 </div>
115 </div>
116
117 </div>
118
119
120 <!-- if includes -->
121
122 <div id="section">
123
124
125
126
127
128
129
130
131 <!-- if method_list -->
132 <div id="methods">
133 <h3 class="section-bar">Public Class methods</h3>
134
135 <div id="method-M000080" class="method-detail">
136 <a name="M000080"></a>
137
138 <div class="method-heading">
139 <a href="#M000080" class="method-signature">
140 <span class="method-name">main</span><span class="method-args">(command, argv=ARGV)</span>
141 </a>
142 </div>
143
144 <div class="method-description">
145 <p><a class="source-toggle" href="#"
146 onclick="toggleCode('M000080-source');return false;">[Source]</a></p>
147 <div class="method-source-code" id="M000080-source">
148 <pre>
149 <span class="ruby-comment cmt"># File kwalify/main.rb, line 121</span>
150 <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">main</span>(<span class="ruby-identifier">command</span>, <span class="ruby-identifier">argv</span>=<span class="ruby-constant">ARGV</span>)
151 <span class="ruby-keyword kw">begin</span>
152 <span class="ruby-identifier">main</span> = <span class="ruby-constant">Kwalify</span><span class="ruby-operator">::</span><span class="ruby-constant">Main</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">command</span>)
153 <span class="ruby-identifier">s</span> = <span class="ruby-identifier">main</span>.<span class="ruby-identifier">execute</span>(<span class="ruby-identifier">argv</span>)
154 <span class="ruby-identifier">print</span> <span class="ruby-identifier">s</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">s</span>
155 <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Kwalify</span><span class="ruby-operator">::</span><span class="ruby-constant">CommandOptionError</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">ex</span>
156 <span class="ruby-identifier">raise</span> <span class="ruby-identifier">ex</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">main</span>.<span class="ruby-identifier">debug?</span>
157 <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">ex</span>.<span class="ruby-identifier">message</span>
158 <span class="ruby-identifier">exit</span> <span class="ruby-value">1</span>
159 <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Kwalify</span><span class="ruby-operator">::</span><span class="ruby-constant">KwalifyError</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">ex</span>
160 <span class="ruby-identifier">raise</span> <span class="ruby-identifier">ex</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">main</span>.<span class="ruby-identifier">debug?</span>
161 <span class="ruby-identifier">$stderr</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;ERROR: #{ex.to_s}&quot;</span>
162 <span class="ruby-identifier">exit</span> <span class="ruby-value">1</span>
163 <span class="ruby-comment cmt">#rescue =&gt; ex</span>
164 <span class="ruby-comment cmt"># if main.debug?</span>
165 <span class="ruby-comment cmt"># raise ex</span>
166 <span class="ruby-comment cmt"># else</span>
167 <span class="ruby-comment cmt"># $stderr.puts ex.message</span>
168 <span class="ruby-comment cmt"># exit 1</span>
169 <span class="ruby-comment cmt"># end</span>
170 <span class="ruby-keyword kw">end</span>
171 <span class="ruby-keyword kw">end</span>
172 </pre>
173 </div>
174 </div>
175 </div>
176
177 <div id="method-M000076" class="method-detail">
178 <a name="M000076"></a>
179
180 <div class="method-heading">
181 <a href="#M000076" class="method-signature">
182 <span class="method-name">new</span><span class="method-args">(command=nil)</span>
183 </a>
184 </div>
185
186 <div class="method-description">
187 <p><a class="source-toggle" href="#"
188 onclick="toggleCode('M000076-source');return false;">[Source]</a></p>
189 <div class="method-source-code" id="M000076-source">
190 <pre>
191 <span class="ruby-comment cmt"># File kwalify/main.rb, line 45</span>
192 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">command</span>=<span class="ruby-keyword kw">nil</span>)
193 <span class="ruby-ivar">@command</span> = <span class="ruby-identifier">command</span> <span class="ruby-operator">||</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">basename</span>(<span class="ruby-identifier">$0</span>)
194 <span class="ruby-ivar">@options</span> = {}
195 <span class="ruby-ivar">@properties</span> = {}
196 <span class="ruby-ivar">@template_path</span> = []
197 <span class="ruby-identifier">$:</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span>
198 <span class="ruby-identifier">tpath</span> = <span class="ruby-node">&quot;#{path}/kwalify/templates&quot;</span>
199 <span class="ruby-ivar">@template_path</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">tpath</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">test</span>(<span class="ruby-value">?d</span>, <span class="ruby-identifier">tpath</span>)
200 <span class="ruby-keyword kw">end</span>
201 <span class="ruby-keyword kw">end</span>
202 </pre>
203 </div>
204 </div>
205 </div>
206
207 <h3 class="section-bar">Public Instance methods</h3>
208
209 <div id="method-M000078" class="method-detail">
210 <a name="M000078"></a>
211
212 <div class="method-heading">
213 <a href="#M000078" class="method-signature">
214 <span class="method-name">_inspect</span><span class="method-args">()</span>
215 </a>
216 </div>
217
218 <div class="method-description">
219 <p><a class="source-toggle" href="#"
220 onclick="toggleCode('M000078-source');return false;">[Source]</a></p>
221 <div class="method-source-code" id="M000078-source">
222 <pre>
223 <span class="ruby-comment cmt"># File kwalify/main.rb, line 62</span>
224 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">_inspect</span>()
225 <span class="ruby-identifier">sb</span> = []
226 <span class="ruby-identifier">sb</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot;command: #{@command}\n&quot;</span>
227 <span class="ruby-identifier">sb</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">&quot;options:\n&quot;</span>
228 <span class="ruby-ivar">@options</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">sort</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">k1</span>,<span class="ruby-identifier">k2</span><span class="ruby-operator">|</span> <span class="ruby-identifier">k1</span>.<span class="ruby-identifier">to_s</span><span class="ruby-operator">&lt;=&gt;</span><span class="ruby-identifier">k2</span>.<span class="ruby-identifier">to_s</span> }.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span>
229 <span class="ruby-identifier">sb</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot; - #{key}: #{@options[key]}\n&quot;</span>
230 <span class="ruby-keyword kw">end</span>
231 <span class="ruby-identifier">sb</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">&quot;properties:\n&quot;</span>
232 <span class="ruby-ivar">@properties</span>.<span class="ruby-identifier">keys</span>.<span class="ruby-identifier">sort_by</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">k</span><span class="ruby-operator">|</span> <span class="ruby-identifier">k</span>.<span class="ruby-identifier">to_s</span>}.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span><span class="ruby-operator">|</span>
233 <span class="ruby-identifier">sb</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-node">&quot; - #{key}: #{@properties[key]}\n&quot;</span>
234 <span class="ruby-keyword kw">end</span>
235 <span class="ruby-comment cmt">#sb &lt;&lt; &quot;template_path:\n&quot;</span>
236 <span class="ruby-comment cmt">#@template_path.each do |path|</span>
237 <span class="ruby-comment cmt"># sb &lt;&lt; &quot; - #{path}\n&quot;</span>
238 <span class="ruby-comment cmt">#end</span>
239 <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">sb</span>.<span class="ruby-identifier">join</span>
240 <span class="ruby-keyword kw">end</span>
241 </pre>
242 </div>
243 </div>
244 </div>
245
246 <div id="method-M000077" class="method-detail">
247 <a name="M000077"></a>
248
249 <div class="method-heading">
250 <a href="#M000077" class="method-signature">
251 <span class="method-name">debug?</span><span class="method-args">()</span>
252 </a>
253 </div>
254
255 <div class="method-description">
256 <p><a class="source-toggle" href="#"
257 onclick="toggleCode('M000077-source');return false;">[Source]</a></p>
258 <div class="method-source-code" id="M000077-source">
259 <pre>
260 <span class="ruby-comment cmt"># File kwalify/main.rb, line 57</span>
261 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">debug?</span>
262 <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:debug</span>]
263 <span class="ruby-keyword kw">end</span>
264 </pre>
265 </div>
266 </div>
267 </div>
268
269 <div id="method-M000079" class="method-detail">
270 <a name="M000079"></a>
271
272 <div class="method-heading">
273 <a href="#M000079" class="method-signature">
274 <span class="method-name">execute</span><span class="method-args">(argv=ARGV)</span>
275 </a>
276 </div>
277
278 <div class="method-description">
279 <p><a class="source-toggle" href="#"
280 onclick="toggleCode('M000079-source');return false;">[Source]</a></p>
281 <div class="method-source-code" id="M000079-source">
282 <pre>
283 <span class="ruby-comment cmt"># File kwalify/main.rb, line 81</span>
284 <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">execute</span>(<span class="ruby-identifier">argv</span>=<span class="ruby-constant">ARGV</span>)
285 <span class="ruby-comment cmt">## parse command-line options</span>
286 <span class="ruby-identifier">filenames</span> = <span class="ruby-identifier">_parse_argv</span>(<span class="ruby-identifier">argv</span>)
287
288 <span class="ruby-comment cmt">## help or version</span>
289 <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:help</span>] <span class="ruby-operator">||</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:version</span>]
290 <span class="ruby-identifier">action</span> = <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:action</span>]
291 <span class="ruby-identifier">s</span> = <span class="ruby-value str">''</span>
292 <span class="ruby-identifier">s</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">_version</span>() <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">&quot;\n&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:version</span>]
293 <span class="ruby-identifier">s</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">_usage</span>() <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:help</span>] <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">action</span>
294 <span class="ruby-identifier">s</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">_describe_properties</span>(<span class="ruby-identifier">action</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:help</span>] <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-identifier">action</span>
295 <span class="ruby-identifier">puts</span> <span class="ruby-identifier">s</span>
296 <span class="ruby-keyword kw">return</span>
297 <span class="ruby-keyword kw">end</span>
298
299 <span class="ruby-comment cmt"># validation</span>
300 <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:meta2</span>]
301 <span class="ruby-identifier">validate_schemafiles2</span>(<span class="ruby-identifier">filenames</span>)
302 <span class="ruby-keyword kw">elsif</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:meta</span>]
303 <span class="ruby-identifier">validate_schemafiles</span>(<span class="ruby-identifier">filenames</span>)
304 <span class="ruby-keyword kw">elsif</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:action</span>]
305 <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:schema</span>]
306 <span class="ruby-comment cmt">#* key=:command_option_actionnoschema msg=&quot;schema filename is not specified.&quot;</span>
307 <span class="ruby-identifier">raise</span> <span class="ruby-identifier">option_error</span>(<span class="ruby-identifier">:command_option_actionnoschema</span>, <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:action</span>])
308 <span class="ruby-keyword kw">end</span>
309 <span class="ruby-identifier">perform_action</span>(<span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:action</span>], <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:schema</span>])
310 <span class="ruby-keyword kw">elsif</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:schema</span>]
311 <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:debug</span>]
312 <span class="ruby-identifier">inspect_schema</span>(<span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:schema</span>])
313 <span class="ruby-keyword kw">else</span>
314 <span class="ruby-identifier">validate_files</span>(<span class="ruby-identifier">filenames</span>, <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:schema</span>])
315 <span class="ruby-keyword kw">end</span>
316 <span class="ruby-keyword kw">else</span>
317 <span class="ruby-comment cmt">#* key=:command_option_noaction msg=&quot;command-line option '-f' or '-m' required.&quot;</span>
318 <span class="ruby-identifier">raise</span> <span class="ruby-identifier">option_error</span>(<span class="ruby-identifier">:command_option_noaction</span>, <span class="ruby-ivar">@command</span>)
319 <span class="ruby-keyword kw">end</span>
320 <span class="ruby-keyword kw">return</span>
321 <span class="ruby-keyword kw">end</span>
322 </pre>
323 </div>
324 </div>
325 </div>
326
327
328 </div>
329
330
331 </div>
332
333
334 <div id="validator-badges">
335 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
336 </div>
337
338 </body>
339 </html>