nucleon 0.2.0 → 0.2.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +1 -0
- data/Gemfile.lock +2 -0
- data/VERSION +1 -1
- data/lib/core/config.rb +21 -20
- data/lib/core/environment.rb +2 -2
- data/lib/core/facade.rb +15 -0
- data/lib/core/mixin/action/registration.rb +84 -0
- data/lib/core/mixin/sub_config.rb +5 -5
- data/lib/core/plugin/action.rb +66 -10
- data/lib/core/plugin/base.rb +100 -19
- data/lib/core/plugin/command.rb +4 -0
- data/lib/core/util/cache.rb +13 -1
- data/lib/core/util/cli.rb +77 -11
- data/lib/core/util/console.rb +55 -72
- data/lib/core/util/data.rb +19 -9
- data/lib/core/util/logger.rb +16 -6
- data/lib/core/util/shell.rb +3 -1
- data/lib/core/util/ssh.rb +28 -25
- data/lib/nucleon/translator/JSON.rb +2 -2
- data/lib/nucleon/translator/YAML.rb +2 -2
- data/lib/nucleon_base.rb +22 -8
- data/nucleon.gemspec +122 -2
- data/rdoc/site/0.2.0/ARCHITECTURE_rdoc.html +638 -0
- data/rdoc/site/0.2.0/Hash.html +351 -0
- data/rdoc/site/0.2.0/Kernel.html +416 -0
- data/rdoc/site/0.2.0/Nucleon.html +607 -0
- data/rdoc/site/0.2.0/Nucleon/Action.html +284 -0
- data/rdoc/site/0.2.0/Nucleon/Action/Extract.html +455 -0
- data/rdoc/site/0.2.0/Nucleon/Action/Project.html +283 -0
- data/rdoc/site/0.2.0/Nucleon/Action/Project/Add.html +500 -0
- data/rdoc/site/0.2.0/Nucleon/Action/Project/Create.html +457 -0
- data/rdoc/site/0.2.0/Nucleon/Action/Project/Remove.html +503 -0
- data/rdoc/site/0.2.0/Nucleon/Action/Project/Save.html +476 -0
- data/rdoc/site/0.2.0/Nucleon/Action/Project/Update.html +423 -0
- data/rdoc/site/0.2.0/Nucleon/Codes.html +567 -0
- data/rdoc/site/0.2.0/Nucleon/Command.html +279 -0
- data/rdoc/site/0.2.0/Nucleon/Command/Bash.html +548 -0
- data/rdoc/site/0.2.0/Nucleon/Config.html +1631 -0
- data/rdoc/site/0.2.0/Nucleon/Config/Collection.html +513 -0
- data/rdoc/site/0.2.0/Nucleon/Config/Options.html +493 -0
- data/rdoc/site/0.2.0/Nucleon/Core.html +639 -0
- data/rdoc/site/0.2.0/Nucleon/Environment.html +1208 -0
- data/rdoc/site/0.2.0/Nucleon/Errors.html +279 -0
- data/rdoc/site/0.2.0/Nucleon/Errors/BatchError.html +285 -0
- data/rdoc/site/0.2.0/Nucleon/Errors/NucleonError.html +661 -0
- data/rdoc/site/0.2.0/Nucleon/Errors/SSHUnavailable.html +285 -0
- data/rdoc/site/0.2.0/Nucleon/Event.html +279 -0
- data/rdoc/site/0.2.0/Nucleon/Event/Regex.html +471 -0
- data/rdoc/site/0.2.0/Nucleon/Facade.html +2409 -0
- data/rdoc/site/0.2.0/Nucleon/Gems.html +639 -0
- data/rdoc/site/0.2.0/Nucleon/Manager.html +1860 -0
- data/rdoc/site/0.2.0/Nucleon/Mixin.html +288 -0
- data/rdoc/site/0.2.0/Nucleon/Mixin/Action.html +281 -0
- data/rdoc/site/0.2.0/Nucleon/Mixin/Action/Commit.html +385 -0
- data/rdoc/site/0.2.0/Nucleon/Mixin/Action/Project.html +399 -0
- data/rdoc/site/0.2.0/Nucleon/Mixin/Action/Push.html +375 -0
- data/rdoc/site/0.2.0/Nucleon/Mixin/Colors.html +549 -0
- data/rdoc/site/0.2.0/Nucleon/Mixin/ConfigCollection.html +485 -0
- data/rdoc/site/0.2.0/Nucleon/Mixin/ConfigOptions.html +453 -0
- data/rdoc/site/0.2.0/Nucleon/Mixin/Macro.html +280 -0
- data/rdoc/site/0.2.0/Nucleon/Mixin/Macro/ObjectInterface.html +699 -0
- data/rdoc/site/0.2.0/Nucleon/Mixin/Macro/PluginInterface.html +686 -0
- data/rdoc/site/0.2.0/Nucleon/Mixin/Settings.html +485 -0
- data/rdoc/site/0.2.0/Nucleon/Mixin/SubConfig.html +891 -0
- data/rdoc/site/0.2.0/Nucleon/Parallel.html +330 -0
- data/rdoc/site/0.2.0/Nucleon/Parallel/ClassMethods.html +329 -0
- data/rdoc/site/0.2.0/Nucleon/Parallel/InstanceMethods.html +456 -0
- data/rdoc/site/0.2.0/Nucleon/Plugin.html +286 -0
- data/rdoc/site/0.2.0/Nucleon/Plugin/Action.html +1829 -0
- data/rdoc/site/0.2.0/Nucleon/Plugin/Action/Option.html +463 -0
- data/rdoc/site/0.2.0/Nucleon/Plugin/Base.html +1803 -0
- data/rdoc/site/0.2.0/Nucleon/Plugin/Command.html +725 -0
- data/rdoc/site/0.2.0/Nucleon/Plugin/Event.html +446 -0
- data/rdoc/site/0.2.0/Nucleon/Plugin/Extension.html +285 -0
- data/rdoc/site/0.2.0/Nucleon/Plugin/Project.html +2898 -0
- data/rdoc/site/0.2.0/Nucleon/Plugin/Template.html +480 -0
- data/rdoc/site/0.2.0/Nucleon/Plugin/Translator.html +375 -0
- data/rdoc/site/0.2.0/Nucleon/Project.html +280 -0
- data/rdoc/site/0.2.0/Nucleon/Project/Git.html +1805 -0
- data/rdoc/site/0.2.0/Nucleon/Project/Github.html +553 -0
- data/rdoc/site/0.2.0/Nucleon/Template.html +281 -0
- data/rdoc/site/0.2.0/Nucleon/Template/JSON.html +333 -0
- data/rdoc/site/0.2.0/Nucleon/Template/Wrapper.html +333 -0
- data/rdoc/site/0.2.0/Nucleon/Template/YAML.html +333 -0
- data/rdoc/site/0.2.0/Nucleon/Translator.html +280 -0
- data/rdoc/site/0.2.0/Nucleon/Translator/JSON.html +370 -0
- data/rdoc/site/0.2.0/Nucleon/Translator/YAML.html +370 -0
- data/rdoc/site/0.2.0/Nucleon/Util.html +289 -0
- data/rdoc/site/0.2.0/Nucleon/Util/CLI.html +392 -0
- data/rdoc/site/0.2.0/Nucleon/Util/CLI/Parser.html +1250 -0
- data/rdoc/site/0.2.0/Nucleon/Util/Cache.html +784 -0
- data/rdoc/site/0.2.0/Nucleon/Util/Console.html +1318 -0
- data/rdoc/site/0.2.0/Nucleon/Util/Data.html +1411 -0
- data/rdoc/site/0.2.0/Nucleon/Util/Disk.html +526 -0
- data/rdoc/site/0.2.0/Nucleon/Util/Git.html +365 -0
- data/rdoc/site/0.2.0/Nucleon/Util/Liquid.html +369 -0
- data/rdoc/site/0.2.0/Nucleon/Util/Logger.html +810 -0
- data/rdoc/site/0.2.0/Nucleon/Util/Package.html +562 -0
- data/rdoc/site/0.2.0/Nucleon/Util/SSH.html +1033 -0
- data/rdoc/site/0.2.0/Nucleon/Util/SSH/Keypair.html +605 -0
- data/rdoc/site/0.2.0/Nucleon/Util/Shell.html +693 -0
- data/rdoc/site/0.2.0/Nucleon/Util/Shell/Result.html +501 -0
- data/rdoc/site/0.2.0/README_rdoc.html +316 -0
- data/rdoc/site/0.2.0/TODO_rdoc.html +265 -0
- data/rdoc/site/0.2.0/created.rid +61 -0
- data/rdoc/site/0.2.0/images/add.png +0 -0
- data/rdoc/site/0.2.0/images/brick.png +0 -0
- data/rdoc/site/0.2.0/images/brick_link.png +0 -0
- data/rdoc/site/0.2.0/images/bug.png +0 -0
- data/rdoc/site/0.2.0/images/bullet_black.png +0 -0
- data/rdoc/site/0.2.0/images/bullet_toggle_minus.png +0 -0
- data/rdoc/site/0.2.0/images/bullet_toggle_plus.png +0 -0
- data/rdoc/site/0.2.0/images/date.png +0 -0
- data/rdoc/site/0.2.0/images/delete.png +0 -0
- data/rdoc/site/0.2.0/images/find.png +0 -0
- data/rdoc/site/0.2.0/images/loadingAnimation.gif +0 -0
- data/rdoc/site/0.2.0/images/macFFBgHack.png +0 -0
- data/rdoc/site/0.2.0/images/package.png +0 -0
- data/rdoc/site/0.2.0/images/page_green.png +0 -0
- data/rdoc/site/0.2.0/images/page_white_text.png +0 -0
- data/rdoc/site/0.2.0/images/page_white_width.png +0 -0
- data/rdoc/site/0.2.0/images/plugin.png +0 -0
- data/rdoc/site/0.2.0/images/ruby.png +0 -0
- data/rdoc/site/0.2.0/images/tag_blue.png +0 -0
- data/rdoc/site/0.2.0/images/tag_green.png +0 -0
- data/rdoc/site/0.2.0/images/transparent.png +0 -0
- data/rdoc/site/0.2.0/images/wrench.png +0 -0
- data/rdoc/site/0.2.0/images/wrench_orange.png +0 -0
- data/rdoc/site/0.2.0/images/zoom.png +0 -0
- data/rdoc/site/0.2.0/index.html +315 -0
- data/rdoc/site/0.2.0/js/darkfish.js +155 -0
- data/rdoc/site/0.2.0/js/jquery.js +18 -0
- data/rdoc/site/0.2.0/js/navigation.js +142 -0
- data/rdoc/site/0.2.0/js/search.js +94 -0
- data/rdoc/site/0.2.0/js/search_index.js +1 -0
- data/rdoc/site/0.2.0/js/searcher.js +228 -0
- data/rdoc/site/0.2.0/rdoc.css +543 -0
- data/rdoc/site/0.2.0/table_of_contents.html +1657 -0
- data/spec/core/util/console_spec.rb +50 -18
- metadata +133 -2
@@ -0,0 +1,392 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
6
|
+
|
7
|
+
<title>module Nucleon::Util::CLI - nucleon 0.2.0</title>
|
8
|
+
|
9
|
+
<link type="text/css" media="screen" href="../../rdoc.css" rel="stylesheet">
|
10
|
+
|
11
|
+
<script type="text/javascript">
|
12
|
+
var rdoc_rel_prefix = "../../";
|
13
|
+
</script>
|
14
|
+
|
15
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
16
|
+
<script type="text/javascript" charset="utf-8" src="../../js/navigation.js"></script>
|
17
|
+
<script type="text/javascript" charset="utf-8" src="../../js/search_index.js"></script>
|
18
|
+
<script type="text/javascript" charset="utf-8" src="../../js/search.js"></script>
|
19
|
+
<script type="text/javascript" charset="utf-8" src="../../js/searcher.js"></script>
|
20
|
+
<script type="text/javascript" charset="utf-8" src="../../js/darkfish.js"></script>
|
21
|
+
|
22
|
+
|
23
|
+
<body id="top" class="module">
|
24
|
+
<nav id="metadata">
|
25
|
+
<nav id="home-section" class="section">
|
26
|
+
<h3 class="section-header">
|
27
|
+
<a href="../../index.html">Home</a>
|
28
|
+
<a href="../../table_of_contents.html#classes">Classes</a>
|
29
|
+
<a href="../../table_of_contents.html#methods">Methods</a>
|
30
|
+
</h3>
|
31
|
+
</nav>
|
32
|
+
|
33
|
+
|
34
|
+
<nav id="search-section" class="section project-section" class="initially-hidden">
|
35
|
+
<form action="#" method="get" accept-charset="utf-8">
|
36
|
+
<h3 class="section-header">
|
37
|
+
<input type="text" name="search" placeholder="Search" id="search-field"
|
38
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
39
|
+
</h3>
|
40
|
+
</form>
|
41
|
+
|
42
|
+
<ul id="search-results" class="initially-hidden"></ul>
|
43
|
+
</nav>
|
44
|
+
|
45
|
+
|
46
|
+
<div id="file-metadata">
|
47
|
+
<nav id="file-list-section" class="section">
|
48
|
+
<h3 class="section-header">Defined In</h3>
|
49
|
+
<ul>
|
50
|
+
<li>lib/core/util/cli.rb
|
51
|
+
</ul>
|
52
|
+
</nav>
|
53
|
+
|
54
|
+
|
55
|
+
</div>
|
56
|
+
|
57
|
+
<div id="class-metadata">
|
58
|
+
|
59
|
+
|
60
|
+
|
61
|
+
<!-- Method Quickref -->
|
62
|
+
<nav id="method-list-section" class="section">
|
63
|
+
<h3 class="section-header">Methods</h3>
|
64
|
+
|
65
|
+
<ul class="link-list">
|
66
|
+
|
67
|
+
<li><a href="#method-c-decode">::decode</a>
|
68
|
+
|
69
|
+
<li><a href="#method-c-encode">::encode</a>
|
70
|
+
|
71
|
+
<li><a href="#method-c-message">::message</a>
|
72
|
+
|
73
|
+
</ul>
|
74
|
+
</nav>
|
75
|
+
|
76
|
+
</div>
|
77
|
+
|
78
|
+
<div id="project-metadata">
|
79
|
+
<nav id="fileindex-section" class="section project-section">
|
80
|
+
<h3 class="section-header">Pages</h3>
|
81
|
+
|
82
|
+
<ul>
|
83
|
+
|
84
|
+
<li class="file"><a href="../../ARCHITECTURE_rdoc.html">ARCHITECTURE</a>
|
85
|
+
|
86
|
+
<li class="file"><a href="../../README_rdoc.html">README</a>
|
87
|
+
|
88
|
+
<li class="file"><a href="../../TODO_rdoc.html">TODO</a>
|
89
|
+
|
90
|
+
</ul>
|
91
|
+
</nav>
|
92
|
+
|
93
|
+
<nav id="classindex-section" class="section project-section">
|
94
|
+
<h3 class="section-header">Class and Module Index</h3>
|
95
|
+
|
96
|
+
<ul class="link-list">
|
97
|
+
|
98
|
+
<li><a href="../../Nucleon.html">Nucleon</a>
|
99
|
+
|
100
|
+
<li><a href="../../Nucleon/Action.html">Nucleon::Action</a>
|
101
|
+
|
102
|
+
<li><a href="../../Nucleon/Action/Extract.html">Nucleon::Action::Extract</a>
|
103
|
+
|
104
|
+
<li><a href="../../Nucleon/Action/Project.html">Nucleon::Action::Project</a>
|
105
|
+
|
106
|
+
<li><a href="../../Nucleon/Action/Project/Add.html">Nucleon::Action::Project::Add</a>
|
107
|
+
|
108
|
+
<li><a href="../../Nucleon/Action/Project/Create.html">Nucleon::Action::Project::Create</a>
|
109
|
+
|
110
|
+
<li><a href="../../Nucleon/Action/Project/Remove.html">Nucleon::Action::Project::Remove</a>
|
111
|
+
|
112
|
+
<li><a href="../../Nucleon/Action/Project/Save.html">Nucleon::Action::Project::Save</a>
|
113
|
+
|
114
|
+
<li><a href="../../Nucleon/Action/Project/Update.html">Nucleon::Action::Project::Update</a>
|
115
|
+
|
116
|
+
<li><a href="../../Nucleon/Codes.html">Nucleon::Codes</a>
|
117
|
+
|
118
|
+
<li><a href="../../Nucleon/Command.html">Nucleon::Command</a>
|
119
|
+
|
120
|
+
<li><a href="../../Nucleon/Command/Bash.html">Nucleon::Command::Bash</a>
|
121
|
+
|
122
|
+
<li><a href="../../Nucleon/Config.html">Nucleon::Config</a>
|
123
|
+
|
124
|
+
<li><a href="../../Nucleon/Config/Collection.html">Nucleon::Config::Collection</a>
|
125
|
+
|
126
|
+
<li><a href="../../Nucleon/Config/Options.html">Nucleon::Config::Options</a>
|
127
|
+
|
128
|
+
<li><a href="../../Nucleon/Core.html">Nucleon::Core</a>
|
129
|
+
|
130
|
+
<li><a href="../../Nucleon/Environment.html">Nucleon::Environment</a>
|
131
|
+
|
132
|
+
<li><a href="../../Nucleon/Errors.html">Nucleon::Errors</a>
|
133
|
+
|
134
|
+
<li><a href="../../Nucleon/Errors/BatchError.html">Nucleon::Errors::BatchError</a>
|
135
|
+
|
136
|
+
<li><a href="../../Nucleon/Errors/NucleonError.html">Nucleon::Errors::NucleonError</a>
|
137
|
+
|
138
|
+
<li><a href="../../Nucleon/Errors/SSHUnavailable.html">Nucleon::Errors::SSHUnavailable</a>
|
139
|
+
|
140
|
+
<li><a href="../../Nucleon/Event.html">Nucleon::Event</a>
|
141
|
+
|
142
|
+
<li><a href="../../Nucleon/Event/Regex.html">Nucleon::Event::Regex</a>
|
143
|
+
|
144
|
+
<li><a href="../../Nucleon/Facade.html">Nucleon::Facade</a>
|
145
|
+
|
146
|
+
<li><a href="../../Nucleon/Gems.html">Nucleon::Gems</a>
|
147
|
+
|
148
|
+
<li><a href="../../Nucleon/Manager.html">Nucleon::Manager</a>
|
149
|
+
|
150
|
+
<li><a href="../../Nucleon/Mixin.html">Nucleon::Mixin</a>
|
151
|
+
|
152
|
+
<li><a href="../../Nucleon/Mixin/Action.html">Nucleon::Mixin::Action</a>
|
153
|
+
|
154
|
+
<li><a href="../../Nucleon/Mixin/Action/Commit.html">Nucleon::Mixin::Action::Commit</a>
|
155
|
+
|
156
|
+
<li><a href="../../Nucleon/Mixin/Action/Project.html">Nucleon::Mixin::Action::Project</a>
|
157
|
+
|
158
|
+
<li><a href="../../Nucleon/Mixin/Action/Push.html">Nucleon::Mixin::Action::Push</a>
|
159
|
+
|
160
|
+
<li><a href="../../Nucleon/Mixin/Colors.html">Nucleon::Mixin::Colors</a>
|
161
|
+
|
162
|
+
<li><a href="../../Nucleon/Mixin/ConfigCollection.html">Nucleon::Mixin::ConfigCollection</a>
|
163
|
+
|
164
|
+
<li><a href="../../Nucleon/Mixin/ConfigOptions.html">Nucleon::Mixin::ConfigOptions</a>
|
165
|
+
|
166
|
+
<li><a href="../../Nucleon/Mixin/Macro.html">Nucleon::Mixin::Macro</a>
|
167
|
+
|
168
|
+
<li><a href="../../Nucleon/Mixin/Macro/ObjectInterface.html">Nucleon::Mixin::Macro::ObjectInterface</a>
|
169
|
+
|
170
|
+
<li><a href="../../Nucleon/Mixin/Macro/PluginInterface.html">Nucleon::Mixin::Macro::PluginInterface</a>
|
171
|
+
|
172
|
+
<li><a href="../../Nucleon/Mixin/Settings.html">Nucleon::Mixin::Settings</a>
|
173
|
+
|
174
|
+
<li><a href="../../Nucleon/Mixin/SubConfig.html">Nucleon::Mixin::SubConfig</a>
|
175
|
+
|
176
|
+
<li><a href="../../Nucleon/Parallel.html">Nucleon::Parallel</a>
|
177
|
+
|
178
|
+
<li><a href="../../Nucleon/Parallel/ClassMethods.html">Nucleon::Parallel::ClassMethods</a>
|
179
|
+
|
180
|
+
<li><a href="../../Nucleon/Parallel/InstanceMethods.html">Nucleon::Parallel::InstanceMethods</a>
|
181
|
+
|
182
|
+
<li><a href="../../Nucleon/Plugin.html">Nucleon::Plugin</a>
|
183
|
+
|
184
|
+
<li><a href="../../Nucleon/Plugin/Action.html">Nucleon::Plugin::Action</a>
|
185
|
+
|
186
|
+
<li><a href="../../Nucleon/Plugin/Action/Option.html">Nucleon::Plugin::Action::Option</a>
|
187
|
+
|
188
|
+
<li><a href="../../Nucleon/Plugin/Base.html">Nucleon::Plugin::Base</a>
|
189
|
+
|
190
|
+
<li><a href="../../Nucleon/Plugin/Command.html">Nucleon::Plugin::Command</a>
|
191
|
+
|
192
|
+
<li><a href="../../Nucleon/Plugin/Event.html">Nucleon::Plugin::Event</a>
|
193
|
+
|
194
|
+
<li><a href="../../Nucleon/Plugin/Extension.html">Nucleon::Plugin::Extension</a>
|
195
|
+
|
196
|
+
<li><a href="../../Nucleon/Plugin/Project.html">Nucleon::Plugin::Project</a>
|
197
|
+
|
198
|
+
<li><a href="../../Nucleon/Plugin/Template.html">Nucleon::Plugin::Template</a>
|
199
|
+
|
200
|
+
<li><a href="../../Nucleon/Plugin/Translator.html">Nucleon::Plugin::Translator</a>
|
201
|
+
|
202
|
+
<li><a href="../../Nucleon/Project.html">Nucleon::Project</a>
|
203
|
+
|
204
|
+
<li><a href="../../Nucleon/Project/Git.html">Nucleon::Project::Git</a>
|
205
|
+
|
206
|
+
<li><a href="../../Nucleon/Project/Github.html">Nucleon::Project::Github</a>
|
207
|
+
|
208
|
+
<li><a href="../../Nucleon/Template.html">Nucleon::Template</a>
|
209
|
+
|
210
|
+
<li><a href="../../Nucleon/Template/JSON.html">Nucleon::Template::JSON</a>
|
211
|
+
|
212
|
+
<li><a href="../../Nucleon/Template/Wrapper.html">Nucleon::Template::Wrapper</a>
|
213
|
+
|
214
|
+
<li><a href="../../Nucleon/Template/YAML.html">Nucleon::Template::YAML</a>
|
215
|
+
|
216
|
+
<li><a href="../../Nucleon/Translator.html">Nucleon::Translator</a>
|
217
|
+
|
218
|
+
<li><a href="../../Nucleon/Translator/JSON.html">Nucleon::Translator::JSON</a>
|
219
|
+
|
220
|
+
<li><a href="../../Nucleon/Translator/YAML.html">Nucleon::Translator::YAML</a>
|
221
|
+
|
222
|
+
<li><a href="../../Nucleon/Util.html">Nucleon::Util</a>
|
223
|
+
|
224
|
+
<li><a href="../../Nucleon/Util/CLI.html">Nucleon::Util::CLI</a>
|
225
|
+
|
226
|
+
<li><a href="../../Nucleon/Util/CLI/Parser.html">Nucleon::Util::CLI::Parser</a>
|
227
|
+
|
228
|
+
<li><a href="../../Nucleon/Util/Cache.html">Nucleon::Util::Cache</a>
|
229
|
+
|
230
|
+
<li><a href="../../Nucleon/Util/Console.html">Nucleon::Util::Console</a>
|
231
|
+
|
232
|
+
<li><a href="../../Nucleon/Util/Data.html">Nucleon::Util::Data</a>
|
233
|
+
|
234
|
+
<li><a href="../../Nucleon/Util/Disk.html">Nucleon::Util::Disk</a>
|
235
|
+
|
236
|
+
<li><a href="../../Nucleon/Util/Git.html">Nucleon::Util::Git</a>
|
237
|
+
|
238
|
+
<li><a href="../../Nucleon/Util/Liquid.html">Nucleon::Util::Liquid</a>
|
239
|
+
|
240
|
+
<li><a href="../../Nucleon/Util/Logger.html">Nucleon::Util::Logger</a>
|
241
|
+
|
242
|
+
<li><a href="../../Nucleon/Util/Package.html">Nucleon::Util::Package</a>
|
243
|
+
|
244
|
+
<li><a href="../../Nucleon/Util/SSH.html">Nucleon::Util::SSH</a>
|
245
|
+
|
246
|
+
<li><a href="../../Nucleon/Util/SSH/Keypair.html">Nucleon::Util::SSH::Keypair</a>
|
247
|
+
|
248
|
+
<li><a href="../../Nucleon/Util/Shell.html">Nucleon::Util::Shell</a>
|
249
|
+
|
250
|
+
<li><a href="../../Nucleon/Util/Shell/Result.html">Nucleon::Util::Shell::Result</a>
|
251
|
+
|
252
|
+
<li><a href="../../Hash.html">Hash</a>
|
253
|
+
|
254
|
+
<li><a href="../../Kernel.html">Kernel</a>
|
255
|
+
|
256
|
+
</ul>
|
257
|
+
</nav>
|
258
|
+
|
259
|
+
</div>
|
260
|
+
</nav>
|
261
|
+
|
262
|
+
<div id="documentation">
|
263
|
+
<h1 class="module">module Nucleon::Util::CLI</h1>
|
264
|
+
|
265
|
+
<div id="description" class="description">
|
266
|
+
|
267
|
+
</div><!-- description -->
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
273
|
+
|
274
|
+
|
275
|
+
|
276
|
+
|
277
|
+
|
278
|
+
|
279
|
+
|
280
|
+
|
281
|
+
<!-- Methods -->
|
282
|
+
|
283
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
|
284
|
+
<h3 class="section-header">Public Class Methods</h3>
|
285
|
+
|
286
|
+
|
287
|
+
<div id="method-c-decode" class="method-detail ">
|
288
|
+
|
289
|
+
<div class="method-heading">
|
290
|
+
<span class="method-name">decode</span><span
|
291
|
+
class="method-args">(encoded_string)</span>
|
292
|
+
<span class="method-click-advice">click to toggle source</span>
|
293
|
+
</div>
|
294
|
+
|
295
|
+
|
296
|
+
<div class="method-description">
|
297
|
+
|
298
|
+
|
299
|
+
|
300
|
+
|
301
|
+
|
302
|
+
<div class="method-source-code" id="decode-source">
|
303
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 22</span>
|
304
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">decode</span>(<span class="ruby-identifier">encoded_string</span>)
|
305
|
+
<span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">symbol_map</span>(<span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">parse_json</span>(<span class="ruby-constant">Base64</span>.<span class="ruby-identifier">urlsafe_decode64</span>(<span class="ruby-identifier">encoded_string</span>)))
|
306
|
+
<span class="ruby-keyword">end</span></pre>
|
307
|
+
</div><!-- decode-source -->
|
308
|
+
|
309
|
+
</div>
|
310
|
+
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
</div><!-- decode-method -->
|
315
|
+
|
316
|
+
|
317
|
+
<div id="method-c-encode" class="method-detail ">
|
318
|
+
|
319
|
+
<div class="method-heading">
|
320
|
+
<span class="method-name">encode</span><span
|
321
|
+
class="method-args">(data)</span>
|
322
|
+
<span class="method-click-advice">click to toggle source</span>
|
323
|
+
</div>
|
324
|
+
|
325
|
+
|
326
|
+
<div class="method-description">
|
327
|
+
|
328
|
+
|
329
|
+
|
330
|
+
|
331
|
+
|
332
|
+
<div class="method-source-code" id="encode-source">
|
333
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 18</span>
|
334
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">encode</span>(<span class="ruby-identifier">data</span>)
|
335
|
+
<span class="ruby-constant">Base64</span>.<span class="ruby-identifier">urlsafe_encode64</span>(<span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">to_json</span>(<span class="ruby-identifier">data</span>, <span class="ruby-keyword">false</span>))
|
336
|
+
<span class="ruby-keyword">end</span></pre>
|
337
|
+
</div><!-- encode-source -->
|
338
|
+
|
339
|
+
</div>
|
340
|
+
|
341
|
+
|
342
|
+
|
343
|
+
|
344
|
+
</div><!-- encode-method -->
|
345
|
+
|
346
|
+
|
347
|
+
<div id="method-c-message" class="method-detail ">
|
348
|
+
|
349
|
+
<div class="method-heading">
|
350
|
+
<span class="method-name">message</span><span
|
351
|
+
class="method-args">(name, default = nil)</span>
|
352
|
+
<span class="method-click-advice">click to toggle source</span>
|
353
|
+
</div>
|
354
|
+
|
355
|
+
|
356
|
+
<div class="method-description">
|
357
|
+
|
358
|
+
|
359
|
+
|
360
|
+
|
361
|
+
|
362
|
+
<div class="method-source-code" id="message-source">
|
363
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 9</span>
|
364
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">message</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span> = <span class="ruby-keyword">nil</span>)
|
365
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">default</span>.<span class="ruby-identifier">nil?</span>
|
366
|
+
<span class="ruby-identifier">default</span> = <span class="ruby-value">:none</span>
|
367
|
+
<span class="ruby-keyword">end</span>
|
368
|
+
<span class="ruby-keyword">return</span> <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">t</span>(<span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span>, <span class="ruby-value">:default_value</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">default</span>.<span class="ruby-identifier">to_s</span>)
|
369
|
+
<span class="ruby-keyword">end</span></pre>
|
370
|
+
</div><!-- message-source -->
|
371
|
+
|
372
|
+
</div>
|
373
|
+
|
374
|
+
|
375
|
+
|
376
|
+
|
377
|
+
</div><!-- message-method -->
|
378
|
+
|
379
|
+
|
380
|
+
</section><!-- public-class-method-details -->
|
381
|
+
|
382
|
+
</section><!-- 5Buntitled-5D -->
|
383
|
+
|
384
|
+
</div><!-- documentation -->
|
385
|
+
|
386
|
+
|
387
|
+
<footer id="validator-badges">
|
388
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
389
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.2.
|
390
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
391
|
+
</footer>
|
392
|
+
|
@@ -0,0 +1,1250 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
|
3
|
+
<html>
|
4
|
+
<head>
|
5
|
+
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
|
6
|
+
|
7
|
+
<title>class Nucleon::Util::CLI::Parser - nucleon 0.2.0</title>
|
8
|
+
|
9
|
+
<link type="text/css" media="screen" href="../../../rdoc.css" rel="stylesheet">
|
10
|
+
|
11
|
+
<script type="text/javascript">
|
12
|
+
var rdoc_rel_prefix = "../../../";
|
13
|
+
</script>
|
14
|
+
|
15
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
|
16
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/navigation.js"></script>
|
17
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/search_index.js"></script>
|
18
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/search.js"></script>
|
19
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/searcher.js"></script>
|
20
|
+
<script type="text/javascript" charset="utf-8" src="../../../js/darkfish.js"></script>
|
21
|
+
|
22
|
+
|
23
|
+
<body id="top" class="class">
|
24
|
+
<nav id="metadata">
|
25
|
+
<nav id="home-section" class="section">
|
26
|
+
<h3 class="section-header">
|
27
|
+
<a href="../../../index.html">Home</a>
|
28
|
+
<a href="../../../table_of_contents.html#classes">Classes</a>
|
29
|
+
<a href="../../../table_of_contents.html#methods">Methods</a>
|
30
|
+
</h3>
|
31
|
+
</nav>
|
32
|
+
|
33
|
+
|
34
|
+
<nav id="search-section" class="section project-section" class="initially-hidden">
|
35
|
+
<form action="#" method="get" accept-charset="utf-8">
|
36
|
+
<h3 class="section-header">
|
37
|
+
<input type="text" name="search" placeholder="Search" id="search-field"
|
38
|
+
title="Type to search, Up and Down to navigate, Enter to load">
|
39
|
+
</h3>
|
40
|
+
</form>
|
41
|
+
|
42
|
+
<ul id="search-results" class="initially-hidden"></ul>
|
43
|
+
</nav>
|
44
|
+
|
45
|
+
|
46
|
+
<div id="file-metadata">
|
47
|
+
<nav id="file-list-section" class="section">
|
48
|
+
<h3 class="section-header">Defined In</h3>
|
49
|
+
<ul>
|
50
|
+
<li>lib/core/util/cli.rb
|
51
|
+
</ul>
|
52
|
+
</nav>
|
53
|
+
|
54
|
+
|
55
|
+
</div>
|
56
|
+
|
57
|
+
<div id="class-metadata">
|
58
|
+
|
59
|
+
<nav id="parent-class-section" class="section">
|
60
|
+
<h3 class="section-header">Parent</h3>
|
61
|
+
|
62
|
+
<p class="link">Object
|
63
|
+
|
64
|
+
</nav>
|
65
|
+
|
66
|
+
<!-- Included Modules -->
|
67
|
+
<nav id="includes-section" class="section">
|
68
|
+
<h3 class="section-header">Included Modules</h3>
|
69
|
+
|
70
|
+
<ul class="link-list">
|
71
|
+
|
72
|
+
|
73
|
+
<li><a class="include" href="../../Mixin/Colors.html">Nucleon::Mixin::Colors</a>
|
74
|
+
|
75
|
+
|
76
|
+
</ul>
|
77
|
+
</nav>
|
78
|
+
|
79
|
+
<!-- Method Quickref -->
|
80
|
+
<nav id="method-list-section" class="section">
|
81
|
+
<h3 class="section-header">Methods</h3>
|
82
|
+
|
83
|
+
<ul class="link-list">
|
84
|
+
|
85
|
+
<li><a href="#method-c-new">::new</a>
|
86
|
+
|
87
|
+
<li><a href="#method-c-split">::split</a>
|
88
|
+
|
89
|
+
<li><a href="#method-i-arg">#arg</a>
|
90
|
+
|
91
|
+
<li><a href="#method-i-arg_array">#arg_array</a>
|
92
|
+
|
93
|
+
<li><a href="#method-i-arg_bool">#arg_bool</a>
|
94
|
+
|
95
|
+
<li><a href="#method-i-arg_float">#arg_float</a>
|
96
|
+
|
97
|
+
<li><a href="#method-i-arg_int">#arg_int</a>
|
98
|
+
|
99
|
+
<li><a href="#method-i-arg_str">#arg_str</a>
|
100
|
+
|
101
|
+
<li><a href="#method-i-banner-3D">#banner=</a>
|
102
|
+
|
103
|
+
<li><a href="#method-i-help">#help</a>
|
104
|
+
|
105
|
+
<li><a href="#method-i-help-3D">#help=</a>
|
106
|
+
|
107
|
+
<li><a href="#method-i-option">#option</a>
|
108
|
+
|
109
|
+
<li><a href="#method-i-option_array">#option_array</a>
|
110
|
+
|
111
|
+
<li><a href="#method-i-option_bool">#option_bool</a>
|
112
|
+
|
113
|
+
<li><a href="#method-i-option_float">#option_float</a>
|
114
|
+
|
115
|
+
<li><a href="#method-i-option_int">#option_int</a>
|
116
|
+
|
117
|
+
<li><a href="#method-i-option_str">#option_str</a>
|
118
|
+
|
119
|
+
<li><a href="#method-i-parse_command">#parse_command</a>
|
120
|
+
|
121
|
+
<li><a href="#method-i-parse_encoded">#parse_encoded</a>
|
122
|
+
|
123
|
+
<li><a href="#method-i-version">#version</a>
|
124
|
+
|
125
|
+
</ul>
|
126
|
+
</nav>
|
127
|
+
|
128
|
+
</div>
|
129
|
+
|
130
|
+
<div id="project-metadata">
|
131
|
+
<nav id="fileindex-section" class="section project-section">
|
132
|
+
<h3 class="section-header">Pages</h3>
|
133
|
+
|
134
|
+
<ul>
|
135
|
+
|
136
|
+
<li class="file"><a href="../../../ARCHITECTURE_rdoc.html">ARCHITECTURE</a>
|
137
|
+
|
138
|
+
<li class="file"><a href="../../../README_rdoc.html">README</a>
|
139
|
+
|
140
|
+
<li class="file"><a href="../../../TODO_rdoc.html">TODO</a>
|
141
|
+
|
142
|
+
</ul>
|
143
|
+
</nav>
|
144
|
+
|
145
|
+
<nav id="classindex-section" class="section project-section">
|
146
|
+
<h3 class="section-header">Class and Module Index</h3>
|
147
|
+
|
148
|
+
<ul class="link-list">
|
149
|
+
|
150
|
+
<li><a href="../../../Nucleon.html">Nucleon</a>
|
151
|
+
|
152
|
+
<li><a href="../../../Nucleon/Action.html">Nucleon::Action</a>
|
153
|
+
|
154
|
+
<li><a href="../../../Nucleon/Action/Extract.html">Nucleon::Action::Extract</a>
|
155
|
+
|
156
|
+
<li><a href="../../../Nucleon/Action/Project.html">Nucleon::Action::Project</a>
|
157
|
+
|
158
|
+
<li><a href="../../../Nucleon/Action/Project/Add.html">Nucleon::Action::Project::Add</a>
|
159
|
+
|
160
|
+
<li><a href="../../../Nucleon/Action/Project/Create.html">Nucleon::Action::Project::Create</a>
|
161
|
+
|
162
|
+
<li><a href="../../../Nucleon/Action/Project/Remove.html">Nucleon::Action::Project::Remove</a>
|
163
|
+
|
164
|
+
<li><a href="../../../Nucleon/Action/Project/Save.html">Nucleon::Action::Project::Save</a>
|
165
|
+
|
166
|
+
<li><a href="../../../Nucleon/Action/Project/Update.html">Nucleon::Action::Project::Update</a>
|
167
|
+
|
168
|
+
<li><a href="../../../Nucleon/Codes.html">Nucleon::Codes</a>
|
169
|
+
|
170
|
+
<li><a href="../../../Nucleon/Command.html">Nucleon::Command</a>
|
171
|
+
|
172
|
+
<li><a href="../../../Nucleon/Command/Bash.html">Nucleon::Command::Bash</a>
|
173
|
+
|
174
|
+
<li><a href="../../../Nucleon/Config.html">Nucleon::Config</a>
|
175
|
+
|
176
|
+
<li><a href="../../../Nucleon/Config/Collection.html">Nucleon::Config::Collection</a>
|
177
|
+
|
178
|
+
<li><a href="../../../Nucleon/Config/Options.html">Nucleon::Config::Options</a>
|
179
|
+
|
180
|
+
<li><a href="../../../Nucleon/Core.html">Nucleon::Core</a>
|
181
|
+
|
182
|
+
<li><a href="../../../Nucleon/Environment.html">Nucleon::Environment</a>
|
183
|
+
|
184
|
+
<li><a href="../../../Nucleon/Errors.html">Nucleon::Errors</a>
|
185
|
+
|
186
|
+
<li><a href="../../../Nucleon/Errors/BatchError.html">Nucleon::Errors::BatchError</a>
|
187
|
+
|
188
|
+
<li><a href="../../../Nucleon/Errors/NucleonError.html">Nucleon::Errors::NucleonError</a>
|
189
|
+
|
190
|
+
<li><a href="../../../Nucleon/Errors/SSHUnavailable.html">Nucleon::Errors::SSHUnavailable</a>
|
191
|
+
|
192
|
+
<li><a href="../../../Nucleon/Event.html">Nucleon::Event</a>
|
193
|
+
|
194
|
+
<li><a href="../../../Nucleon/Event/Regex.html">Nucleon::Event::Regex</a>
|
195
|
+
|
196
|
+
<li><a href="../../../Nucleon/Facade.html">Nucleon::Facade</a>
|
197
|
+
|
198
|
+
<li><a href="../../../Nucleon/Gems.html">Nucleon::Gems</a>
|
199
|
+
|
200
|
+
<li><a href="../../../Nucleon/Manager.html">Nucleon::Manager</a>
|
201
|
+
|
202
|
+
<li><a href="../../../Nucleon/Mixin.html">Nucleon::Mixin</a>
|
203
|
+
|
204
|
+
<li><a href="../../../Nucleon/Mixin/Action.html">Nucleon::Mixin::Action</a>
|
205
|
+
|
206
|
+
<li><a href="../../../Nucleon/Mixin/Action/Commit.html">Nucleon::Mixin::Action::Commit</a>
|
207
|
+
|
208
|
+
<li><a href="../../../Nucleon/Mixin/Action/Project.html">Nucleon::Mixin::Action::Project</a>
|
209
|
+
|
210
|
+
<li><a href="../../../Nucleon/Mixin/Action/Push.html">Nucleon::Mixin::Action::Push</a>
|
211
|
+
|
212
|
+
<li><a href="../../../Nucleon/Mixin/Colors.html">Nucleon::Mixin::Colors</a>
|
213
|
+
|
214
|
+
<li><a href="../../../Nucleon/Mixin/ConfigCollection.html">Nucleon::Mixin::ConfigCollection</a>
|
215
|
+
|
216
|
+
<li><a href="../../../Nucleon/Mixin/ConfigOptions.html">Nucleon::Mixin::ConfigOptions</a>
|
217
|
+
|
218
|
+
<li><a href="../../../Nucleon/Mixin/Macro.html">Nucleon::Mixin::Macro</a>
|
219
|
+
|
220
|
+
<li><a href="../../../Nucleon/Mixin/Macro/ObjectInterface.html">Nucleon::Mixin::Macro::ObjectInterface</a>
|
221
|
+
|
222
|
+
<li><a href="../../../Nucleon/Mixin/Macro/PluginInterface.html">Nucleon::Mixin::Macro::PluginInterface</a>
|
223
|
+
|
224
|
+
<li><a href="../../../Nucleon/Mixin/Settings.html">Nucleon::Mixin::Settings</a>
|
225
|
+
|
226
|
+
<li><a href="../../../Nucleon/Mixin/SubConfig.html">Nucleon::Mixin::SubConfig</a>
|
227
|
+
|
228
|
+
<li><a href="../../../Nucleon/Parallel.html">Nucleon::Parallel</a>
|
229
|
+
|
230
|
+
<li><a href="../../../Nucleon/Parallel/ClassMethods.html">Nucleon::Parallel::ClassMethods</a>
|
231
|
+
|
232
|
+
<li><a href="../../../Nucleon/Parallel/InstanceMethods.html">Nucleon::Parallel::InstanceMethods</a>
|
233
|
+
|
234
|
+
<li><a href="../../../Nucleon/Plugin.html">Nucleon::Plugin</a>
|
235
|
+
|
236
|
+
<li><a href="../../../Nucleon/Plugin/Action.html">Nucleon::Plugin::Action</a>
|
237
|
+
|
238
|
+
<li><a href="../../../Nucleon/Plugin/Action/Option.html">Nucleon::Plugin::Action::Option</a>
|
239
|
+
|
240
|
+
<li><a href="../../../Nucleon/Plugin/Base.html">Nucleon::Plugin::Base</a>
|
241
|
+
|
242
|
+
<li><a href="../../../Nucleon/Plugin/Command.html">Nucleon::Plugin::Command</a>
|
243
|
+
|
244
|
+
<li><a href="../../../Nucleon/Plugin/Event.html">Nucleon::Plugin::Event</a>
|
245
|
+
|
246
|
+
<li><a href="../../../Nucleon/Plugin/Extension.html">Nucleon::Plugin::Extension</a>
|
247
|
+
|
248
|
+
<li><a href="../../../Nucleon/Plugin/Project.html">Nucleon::Plugin::Project</a>
|
249
|
+
|
250
|
+
<li><a href="../../../Nucleon/Plugin/Template.html">Nucleon::Plugin::Template</a>
|
251
|
+
|
252
|
+
<li><a href="../../../Nucleon/Plugin/Translator.html">Nucleon::Plugin::Translator</a>
|
253
|
+
|
254
|
+
<li><a href="../../../Nucleon/Project.html">Nucleon::Project</a>
|
255
|
+
|
256
|
+
<li><a href="../../../Nucleon/Project/Git.html">Nucleon::Project::Git</a>
|
257
|
+
|
258
|
+
<li><a href="../../../Nucleon/Project/Github.html">Nucleon::Project::Github</a>
|
259
|
+
|
260
|
+
<li><a href="../../../Nucleon/Template.html">Nucleon::Template</a>
|
261
|
+
|
262
|
+
<li><a href="../../../Nucleon/Template/JSON.html">Nucleon::Template::JSON</a>
|
263
|
+
|
264
|
+
<li><a href="../../../Nucleon/Template/Wrapper.html">Nucleon::Template::Wrapper</a>
|
265
|
+
|
266
|
+
<li><a href="../../../Nucleon/Template/YAML.html">Nucleon::Template::YAML</a>
|
267
|
+
|
268
|
+
<li><a href="../../../Nucleon/Translator.html">Nucleon::Translator</a>
|
269
|
+
|
270
|
+
<li><a href="../../../Nucleon/Translator/JSON.html">Nucleon::Translator::JSON</a>
|
271
|
+
|
272
|
+
<li><a href="../../../Nucleon/Translator/YAML.html">Nucleon::Translator::YAML</a>
|
273
|
+
|
274
|
+
<li><a href="../../../Nucleon/Util.html">Nucleon::Util</a>
|
275
|
+
|
276
|
+
<li><a href="../../../Nucleon/Util/CLI.html">Nucleon::Util::CLI</a>
|
277
|
+
|
278
|
+
<li><a href="../../../Nucleon/Util/CLI/Parser.html">Nucleon::Util::CLI::Parser</a>
|
279
|
+
|
280
|
+
<li><a href="../../../Nucleon/Util/Cache.html">Nucleon::Util::Cache</a>
|
281
|
+
|
282
|
+
<li><a href="../../../Nucleon/Util/Console.html">Nucleon::Util::Console</a>
|
283
|
+
|
284
|
+
<li><a href="../../../Nucleon/Util/Data.html">Nucleon::Util::Data</a>
|
285
|
+
|
286
|
+
<li><a href="../../../Nucleon/Util/Disk.html">Nucleon::Util::Disk</a>
|
287
|
+
|
288
|
+
<li><a href="../../../Nucleon/Util/Git.html">Nucleon::Util::Git</a>
|
289
|
+
|
290
|
+
<li><a href="../../../Nucleon/Util/Liquid.html">Nucleon::Util::Liquid</a>
|
291
|
+
|
292
|
+
<li><a href="../../../Nucleon/Util/Logger.html">Nucleon::Util::Logger</a>
|
293
|
+
|
294
|
+
<li><a href="../../../Nucleon/Util/Package.html">Nucleon::Util::Package</a>
|
295
|
+
|
296
|
+
<li><a href="../../../Nucleon/Util/SSH.html">Nucleon::Util::SSH</a>
|
297
|
+
|
298
|
+
<li><a href="../../../Nucleon/Util/SSH/Keypair.html">Nucleon::Util::SSH::Keypair</a>
|
299
|
+
|
300
|
+
<li><a href="../../../Nucleon/Util/Shell.html">Nucleon::Util::Shell</a>
|
301
|
+
|
302
|
+
<li><a href="../../../Nucleon/Util/Shell/Result.html">Nucleon::Util::Shell::Result</a>
|
303
|
+
|
304
|
+
<li><a href="../../../Hash.html">Hash</a>
|
305
|
+
|
306
|
+
<li><a href="../../../Kernel.html">Kernel</a>
|
307
|
+
|
308
|
+
</ul>
|
309
|
+
</nav>
|
310
|
+
|
311
|
+
</div>
|
312
|
+
</nav>
|
313
|
+
|
314
|
+
<div id="documentation">
|
315
|
+
<h1 class="class">class Nucleon::Util::CLI::Parser</h1>
|
316
|
+
|
317
|
+
<div id="description" class="description">
|
318
|
+
|
319
|
+
</div><!-- description -->
|
320
|
+
|
321
|
+
|
322
|
+
|
323
|
+
|
324
|
+
<section id="5Buntitled-5D" class="documentation-section">
|
325
|
+
|
326
|
+
|
327
|
+
|
328
|
+
|
329
|
+
|
330
|
+
|
331
|
+
|
332
|
+
<!-- Attributes -->
|
333
|
+
<section id="attribute-method-details" class="method-section section">
|
334
|
+
<h3 class="section-header">Attributes</h3>
|
335
|
+
|
336
|
+
|
337
|
+
<div id="attribute-i-arguments" class="method-detail">
|
338
|
+
<div class="method-heading attribute-method-heading">
|
339
|
+
<span class="method-name">arguments</span><span
|
340
|
+
class="attribute-access-type">[RW]</span>
|
341
|
+
</div>
|
342
|
+
|
343
|
+
<div class="method-description">
|
344
|
+
|
345
|
+
|
346
|
+
|
347
|
+
</div>
|
348
|
+
</div>
|
349
|
+
|
350
|
+
<div id="attribute-i-options" class="method-detail">
|
351
|
+
<div class="method-heading attribute-method-heading">
|
352
|
+
<span class="method-name">options</span><span
|
353
|
+
class="attribute-access-type">[RW]</span>
|
354
|
+
</div>
|
355
|
+
|
356
|
+
<div class="method-description">
|
357
|
+
|
358
|
+
|
359
|
+
|
360
|
+
</div>
|
361
|
+
</div>
|
362
|
+
|
363
|
+
<div id="attribute-i-parser" class="method-detail">
|
364
|
+
<div class="method-heading attribute-method-heading">
|
365
|
+
<span class="method-name">parser</span><span
|
366
|
+
class="attribute-access-type">[RW]</span>
|
367
|
+
</div>
|
368
|
+
|
369
|
+
<div class="method-description">
|
370
|
+
|
371
|
+
|
372
|
+
|
373
|
+
</div>
|
374
|
+
</div>
|
375
|
+
|
376
|
+
<div id="attribute-i-processed" class="method-detail">
|
377
|
+
<div class="method-heading attribute-method-heading">
|
378
|
+
<span class="method-name">processed</span><span
|
379
|
+
class="attribute-access-type">[RW]</span>
|
380
|
+
</div>
|
381
|
+
|
382
|
+
<div class="method-description">
|
383
|
+
|
384
|
+
|
385
|
+
|
386
|
+
</div>
|
387
|
+
</div>
|
388
|
+
|
389
|
+
</section><!-- attribute-method-details -->
|
390
|
+
|
391
|
+
|
392
|
+
<!-- Methods -->
|
393
|
+
|
394
|
+
<section id="public-class-5Buntitled-5D-method-details" class="method-section section">
|
395
|
+
<h3 class="section-header">Public Class Methods</h3>
|
396
|
+
|
397
|
+
|
398
|
+
<div id="method-c-new" class="method-detail ">
|
399
|
+
|
400
|
+
<div class="method-heading">
|
401
|
+
<span class="method-name">new</span><span
|
402
|
+
class="method-args">(args, banner = '', help = '', split_help = false) { |self| ... }</span>
|
403
|
+
<span class="method-click-advice">click to toggle source</span>
|
404
|
+
</div>
|
405
|
+
|
406
|
+
|
407
|
+
<div class="method-description">
|
408
|
+
|
409
|
+
|
410
|
+
|
411
|
+
|
412
|
+
|
413
|
+
<div class="method-source-code" id="new-source">
|
414
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 42</span>
|
415
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">args</span>, <span class="ruby-identifier">banner</span> = <span class="ruby-string">''</span>, <span class="ruby-identifier">help</span> = <span class="ruby-string">''</span>, <span class="ruby-identifier">split_help</span> = <span class="ruby-keyword">false</span>)
|
416
|
+
|
417
|
+
<span class="ruby-ivar">@parser</span> = <span class="ruby-constant">OptionParser</span>.<span class="ruby-identifier">new</span>
|
418
|
+
|
419
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">options</span> = {}
|
420
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">arguments</span> = {}
|
421
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">processed</span> = <span class="ruby-keyword">false</span>
|
422
|
+
|
423
|
+
<span class="ruby-ivar">@arg_settings</span> = []
|
424
|
+
|
425
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">banner</span> = <span class="ruby-identifier">banner</span>
|
426
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">help</span> = <span class="ruby-identifier">help</span>
|
427
|
+
|
428
|
+
<span class="ruby-keyword">yield</span>(<span class="ruby-keyword">self</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
|
429
|
+
|
430
|
+
<span class="ruby-identifier">parse_command</span>(<span class="ruby-identifier">args</span>, <span class="ruby-identifier">split_help</span>)
|
431
|
+
<span class="ruby-keyword">end</span></pre>
|
432
|
+
</div><!-- new-source -->
|
433
|
+
|
434
|
+
</div>
|
435
|
+
|
436
|
+
|
437
|
+
|
438
|
+
|
439
|
+
</div><!-- new-method -->
|
440
|
+
|
441
|
+
|
442
|
+
<div id="method-c-split" class="method-detail ">
|
443
|
+
|
444
|
+
<div class="method-heading">
|
445
|
+
<span class="method-name">split</span><span
|
446
|
+
class="method-args">(args, banner, separator = '')</span>
|
447
|
+
<span class="method-click-advice">click to toggle source</span>
|
448
|
+
</div>
|
449
|
+
|
450
|
+
|
451
|
+
<div class="method-description">
|
452
|
+
|
453
|
+
|
454
|
+
|
455
|
+
|
456
|
+
|
457
|
+
<div class="method-source-code" id="split-source">
|
458
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 62</span>
|
459
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">split</span>(<span class="ruby-identifier">args</span>, <span class="ruby-identifier">banner</span>, <span class="ruby-identifier">separator</span> = <span class="ruby-string">''</span>)
|
460
|
+
<span class="ruby-identifier">main_args</span> = <span class="ruby-keyword">nil</span>
|
461
|
+
<span class="ruby-identifier">sub_command</span> = <span class="ruby-keyword">nil</span>
|
462
|
+
<span class="ruby-identifier">sub_args</span> = []
|
463
|
+
|
464
|
+
<span class="ruby-identifier">args</span>.<span class="ruby-identifier">each_index</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">index</span><span class="ruby-operator">|</span>
|
465
|
+
<span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">args</span>[<span class="ruby-identifier">index</span>].<span class="ruby-identifier">start_with?</span>(<span class="ruby-string">'-'</span>)
|
466
|
+
<span class="ruby-identifier">main_args</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">0</span>, <span class="ruby-identifier">index</span>]
|
467
|
+
<span class="ruby-identifier">sub_command</span> = <span class="ruby-identifier">args</span>[<span class="ruby-identifier">index</span>]
|
468
|
+
<span class="ruby-identifier">sub_args</span> = <span class="ruby-identifier">args</span>[<span class="ruby-identifier">index</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>, <span class="ruby-identifier">args</span>.<span class="ruby-identifier">length</span> <span class="ruby-operator">-</span> <span class="ruby-identifier">index</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>]
|
469
|
+
<span class="ruby-keyword">break</span>
|
470
|
+
<span class="ruby-keyword">end</span>
|
471
|
+
<span class="ruby-keyword">end</span>
|
472
|
+
|
473
|
+
<span class="ruby-identifier">main_args</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">dup</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">main_args</span>.<span class="ruby-identifier">nil?</span>
|
474
|
+
<span class="ruby-identifier">results</span> = [ <span class="ruby-constant">Parser</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">main_args</span>, <span class="ruby-identifier">banner</span>, <span class="ruby-identifier">separator</span>, <span class="ruby-keyword">true</span>) ]
|
475
|
+
|
476
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">sub_command</span>
|
477
|
+
<span class="ruby-identifier">results</span> <span class="ruby-operator"><<</span> [ <span class="ruby-identifier">sub_command</span>, <span class="ruby-identifier">sub_args</span> ]
|
478
|
+
<span class="ruby-keyword">end</span>
|
479
|
+
|
480
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">results</span>.<span class="ruby-identifier">flatten</span>
|
481
|
+
<span class="ruby-keyword">end</span></pre>
|
482
|
+
</div><!-- split-source -->
|
483
|
+
|
484
|
+
</div>
|
485
|
+
|
486
|
+
|
487
|
+
|
488
|
+
|
489
|
+
</div><!-- split-method -->
|
490
|
+
|
491
|
+
|
492
|
+
</section><!-- public-class-method-details -->
|
493
|
+
|
494
|
+
<section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
|
495
|
+
<h3 class="section-header">Public Instance Methods</h3>
|
496
|
+
|
497
|
+
|
498
|
+
<div id="method-i-arg" class="method-detail ">
|
499
|
+
|
500
|
+
<div class="method-heading">
|
501
|
+
<span class="method-name">arg</span><span
|
502
|
+
class="method-args">(name, default, allowed_values, message_id, config = {}, &block)</span>
|
503
|
+
<span class="method-click-advice">click to toggle source</span>
|
504
|
+
</div>
|
505
|
+
|
506
|
+
|
507
|
+
<div class="method-description">
|
508
|
+
|
509
|
+
|
510
|
+
|
511
|
+
|
512
|
+
|
513
|
+
<div class="method-source-code" id="arg-source">
|
514
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 282</span>
|
515
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">arg</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">allowed_values</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span> = {}, &<span class="ruby-identifier">block</span>)
|
516
|
+
<span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">config</span>)
|
517
|
+
<span class="ruby-identifier">name</span> = <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>
|
518
|
+
|
519
|
+
<span class="ruby-identifier">message_name</span> = <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-string">'_message'</span>
|
520
|
+
<span class="ruby-identifier">message</span> = <span class="ruby-constant">CLI</span>.<span class="ruby-identifier">message</span>(<span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">arguments</span>[<span class="ruby-identifier">name</span>])
|
521
|
+
|
522
|
+
<span class="ruby-identifier">settings</span> = {
|
523
|
+
<span class="ruby-value">:name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">name</span>,
|
524
|
+
<span class="ruby-value">:default</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>),
|
525
|
+
<span class="ruby-value">:message</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">message_name</span>.<span class="ruby-identifier">to_sym</span>, <span class="ruby-identifier">message</span>)
|
526
|
+
}
|
527
|
+
<span class="ruby-identifier">settings</span>[<span class="ruby-value">:allowed</span>] = <span class="ruby-identifier">allowed_values</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">allowed_values</span>
|
528
|
+
<span class="ruby-identifier">settings</span>[<span class="ruby-value">:block</span>] = <span class="ruby-identifier">block</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>
|
529
|
+
|
530
|
+
<span class="ruby-identifier">settings</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:default</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">settings</span>[<span class="ruby-value">:default</span>].<span class="ruby-identifier">nil?</span>
|
531
|
+
|
532
|
+
<span class="ruby-ivar">@arg_settings</span> <span class="ruby-operator"><<</span> <span class="ruby-identifier">settings</span>
|
533
|
+
<span class="ruby-keyword">end</span></pre>
|
534
|
+
</div><!-- arg-source -->
|
535
|
+
|
536
|
+
</div>
|
537
|
+
|
538
|
+
|
539
|
+
|
540
|
+
|
541
|
+
</div><!-- arg-method -->
|
542
|
+
|
543
|
+
|
544
|
+
<div id="method-i-arg_array" class="method-detail ">
|
545
|
+
|
546
|
+
<div class="method-heading">
|
547
|
+
<span class="method-name">arg_array</span><span
|
548
|
+
class="method-args">(name, default, message_id, config = {}) { |value| ... }</span>
|
549
|
+
<span class="method-click-advice">click to toggle source</span>
|
550
|
+
</div>
|
551
|
+
|
552
|
+
|
553
|
+
<div class="method-description">
|
554
|
+
|
555
|
+
|
556
|
+
|
557
|
+
|
558
|
+
|
559
|
+
<div class="method-source-code" id="arg_array-source">
|
560
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 386</span>
|
561
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">arg_array</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span> = {})
|
562
|
+
<span class="ruby-identifier">arg</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-constant">Array</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
563
|
+
<span class="ruby-identifier">block_given?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">value</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">value</span>
|
564
|
+
<span class="ruby-keyword">end</span>
|
565
|
+
<span class="ruby-keyword">end</span></pre>
|
566
|
+
</div><!-- arg_array-source -->
|
567
|
+
|
568
|
+
</div>
|
569
|
+
|
570
|
+
|
571
|
+
|
572
|
+
|
573
|
+
</div><!-- arg_array-method -->
|
574
|
+
|
575
|
+
|
576
|
+
<div id="method-i-arg_bool" class="method-detail ">
|
577
|
+
|
578
|
+
<div class="method-heading">
|
579
|
+
<span class="method-name">arg_bool</span><span
|
580
|
+
class="method-args">(name, default, message_id, config = {}) { |value| ... }</span>
|
581
|
+
<span class="method-click-advice">click to toggle source</span>
|
582
|
+
</div>
|
583
|
+
|
584
|
+
|
585
|
+
<div class="method-description">
|
586
|
+
|
587
|
+
|
588
|
+
|
589
|
+
|
590
|
+
|
591
|
+
<div class="method-source-code" id="arg_bool-source">
|
592
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 317</span>
|
593
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">arg_bool</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span> = {})
|
594
|
+
<span class="ruby-identifier">arg</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
595
|
+
<span class="ruby-identifier">value</span> = <span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">value</span>(<span class="ruby-identifier">value</span>)
|
596
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">false</span>
|
597
|
+
<span class="ruby-identifier">block_given?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">value</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">value</span>
|
598
|
+
<span class="ruby-keyword">else</span>
|
599
|
+
<span class="ruby-keyword">nil</span>
|
600
|
+
<span class="ruby-keyword">end</span>
|
601
|
+
<span class="ruby-keyword">end</span>
|
602
|
+
<span class="ruby-keyword">end</span></pre>
|
603
|
+
</div><!-- arg_bool-source -->
|
604
|
+
|
605
|
+
</div>
|
606
|
+
|
607
|
+
|
608
|
+
|
609
|
+
|
610
|
+
</div><!-- arg_bool-method -->
|
611
|
+
|
612
|
+
|
613
|
+
<div id="method-i-arg_float" class="method-detail ">
|
614
|
+
|
615
|
+
<div class="method-heading">
|
616
|
+
<span class="method-name">arg_float</span><span
|
617
|
+
class="method-args">(name, default, message_id, config = {}) { |value| ... }</span>
|
618
|
+
<span class="method-click-advice">click to toggle source</span>
|
619
|
+
</div>
|
620
|
+
|
621
|
+
|
622
|
+
<div class="method-description">
|
623
|
+
|
624
|
+
|
625
|
+
|
626
|
+
|
627
|
+
|
628
|
+
<div class="method-source-code" id="arg_float-source">
|
629
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 354</span>
|
630
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">arg_float</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span> = {})
|
631
|
+
<span class="ruby-identifier">arg</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-constant">Float</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
632
|
+
<span class="ruby-identifier">block_given?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">value</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">value</span>
|
633
|
+
<span class="ruby-keyword">end</span>
|
634
|
+
<span class="ruby-keyword">end</span></pre>
|
635
|
+
</div><!-- arg_float-source -->
|
636
|
+
|
637
|
+
</div>
|
638
|
+
|
639
|
+
|
640
|
+
|
641
|
+
|
642
|
+
</div><!-- arg_float-method -->
|
643
|
+
|
644
|
+
|
645
|
+
<div id="method-i-arg_int" class="method-detail ">
|
646
|
+
|
647
|
+
<div class="method-heading">
|
648
|
+
<span class="method-name">arg_int</span><span
|
649
|
+
class="method-args">(name, default, message_id, config = {}) { |value| ... }</span>
|
650
|
+
<span class="method-click-advice">click to toggle source</span>
|
651
|
+
</div>
|
652
|
+
|
653
|
+
|
654
|
+
<div class="method-description">
|
655
|
+
|
656
|
+
|
657
|
+
|
658
|
+
|
659
|
+
|
660
|
+
<div class="method-source-code" id="arg_int-source">
|
661
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 338</span>
|
662
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">arg_int</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span> = {})
|
663
|
+
<span class="ruby-identifier">arg</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-constant">Integer</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
664
|
+
<span class="ruby-identifier">block_given?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">value</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">value</span>
|
665
|
+
<span class="ruby-keyword">end</span>
|
666
|
+
<span class="ruby-keyword">end</span></pre>
|
667
|
+
</div><!-- arg_int-source -->
|
668
|
+
|
669
|
+
</div>
|
670
|
+
|
671
|
+
|
672
|
+
|
673
|
+
|
674
|
+
</div><!-- arg_int-method -->
|
675
|
+
|
676
|
+
|
677
|
+
<div id="method-i-arg_str" class="method-detail ">
|
678
|
+
|
679
|
+
<div class="method-heading">
|
680
|
+
<span class="method-name">arg_str</span><span
|
681
|
+
class="method-args">(name, default, message_id, config = {}) { |value| ... }</span>
|
682
|
+
<span class="method-click-advice">click to toggle source</span>
|
683
|
+
</div>
|
684
|
+
|
685
|
+
|
686
|
+
<div class="method-description">
|
687
|
+
|
688
|
+
|
689
|
+
|
690
|
+
|
691
|
+
|
692
|
+
<div class="method-source-code" id="arg_str-source">
|
693
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 370</span>
|
694
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">arg_str</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span> = {})
|
695
|
+
<span class="ruby-identifier">arg</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
696
|
+
<span class="ruby-identifier">block_given?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">value</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">value</span>
|
697
|
+
<span class="ruby-keyword">end</span>
|
698
|
+
<span class="ruby-keyword">end</span></pre>
|
699
|
+
</div><!-- arg_str-source -->
|
700
|
+
|
701
|
+
</div>
|
702
|
+
|
703
|
+
|
704
|
+
|
705
|
+
|
706
|
+
</div><!-- arg_str-method -->
|
707
|
+
|
708
|
+
|
709
|
+
<div id="method-i-banner-3D" class="method-detail ">
|
710
|
+
|
711
|
+
<div class="method-heading">
|
712
|
+
<span class="method-name">banner=</span><span
|
713
|
+
class="method-args">(banner)</span>
|
714
|
+
<span class="method-click-advice">click to toggle source</span>
|
715
|
+
</div>
|
716
|
+
|
717
|
+
|
718
|
+
<div class="method-description">
|
719
|
+
|
720
|
+
|
721
|
+
|
722
|
+
|
723
|
+
|
724
|
+
<div class="method-source-code" id="banner-3D-source">
|
725
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 88</span>
|
726
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">banner=</span><span class="ruby-identifier">banner</span>
|
727
|
+
<span class="ruby-identifier">parser</span>.<span class="ruby-identifier">banner</span> = <span class="ruby-identifier">banner</span>
|
728
|
+
<span class="ruby-keyword">end</span></pre>
|
729
|
+
</div><!-- banner-3D-source -->
|
730
|
+
|
731
|
+
</div>
|
732
|
+
|
733
|
+
|
734
|
+
|
735
|
+
|
736
|
+
</div><!-- banner-3D-method -->
|
737
|
+
|
738
|
+
|
739
|
+
<div id="method-i-help" class="method-detail ">
|
740
|
+
|
741
|
+
<div class="method-heading">
|
742
|
+
<span class="method-name">help</span><span
|
743
|
+
class="method-args">()</span>
|
744
|
+
<span class="method-click-advice">click to toggle source</span>
|
745
|
+
</div>
|
746
|
+
|
747
|
+
|
748
|
+
<div class="method-description">
|
749
|
+
|
750
|
+
|
751
|
+
|
752
|
+
|
753
|
+
|
754
|
+
<div class="method-source-code" id="help-source">
|
755
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 94</span>
|
756
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">help</span>
|
757
|
+
<span class="ruby-keyword">return</span> <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">help</span>
|
758
|
+
<span class="ruby-keyword">end</span></pre>
|
759
|
+
</div><!-- help-source -->
|
760
|
+
|
761
|
+
</div>
|
762
|
+
|
763
|
+
|
764
|
+
|
765
|
+
|
766
|
+
</div><!-- help-method -->
|
767
|
+
|
768
|
+
|
769
|
+
<div id="method-i-help-3D" class="method-detail ">
|
770
|
+
|
771
|
+
<div class="method-heading">
|
772
|
+
<span class="method-name">help=</span><span
|
773
|
+
class="method-args">(help)</span>
|
774
|
+
<span class="method-click-advice">click to toggle source</span>
|
775
|
+
</div>
|
776
|
+
|
777
|
+
|
778
|
+
<div class="method-description">
|
779
|
+
|
780
|
+
|
781
|
+
|
782
|
+
|
783
|
+
|
784
|
+
<div class="method-source-code" id="help-3D-source">
|
785
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 98</span>
|
786
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">help=</span><span class="ruby-identifier">help</span>
|
787
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">help</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
|
788
|
+
<span class="ruby-identifier">help</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">line</span><span class="ruby-operator">|</span>
|
789
|
+
<span class="ruby-identifier">parser</span>.<span class="ruby-identifier">separator</span> <span class="ruby-identifier">line</span>
|
790
|
+
<span class="ruby-keyword">end</span>
|
791
|
+
<span class="ruby-keyword">else</span>
|
792
|
+
<span class="ruby-identifier">parser</span>.<span class="ruby-identifier">separator</span> <span class="ruby-identifier">help</span>
|
793
|
+
<span class="ruby-keyword">end</span>
|
794
|
+
<span class="ruby-keyword">end</span></pre>
|
795
|
+
</div><!-- help-3D-source -->
|
796
|
+
|
797
|
+
</div>
|
798
|
+
|
799
|
+
|
800
|
+
|
801
|
+
|
802
|
+
</div><!-- help-3D-method -->
|
803
|
+
|
804
|
+
|
805
|
+
<div id="method-i-option" class="method-detail ">
|
806
|
+
|
807
|
+
<div class="method-heading">
|
808
|
+
<span class="method-name">option</span><span
|
809
|
+
class="method-args">(name, default, option_str, allowed_values, message_id, config = {}) { |value| ... }</span>
|
810
|
+
<span class="method-click-advice">click to toggle source</span>
|
811
|
+
</div>
|
812
|
+
|
813
|
+
|
814
|
+
<div class="method-description">
|
815
|
+
|
816
|
+
|
817
|
+
|
818
|
+
|
819
|
+
|
820
|
+
<div class="method-source-code" id="option-source">
|
821
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 257</span>
|
822
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">option</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">option_str</span>, <span class="ruby-identifier">allowed_values</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span> = {})
|
823
|
+
<span class="ruby-identifier">config</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">config</span>)
|
824
|
+
<span class="ruby-identifier">name</span> = <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_sym</span>
|
825
|
+
<span class="ruby-identifier">options</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>)
|
826
|
+
|
827
|
+
<span class="ruby-identifier">message_name</span> = <span class="ruby-identifier">name</span>.<span class="ruby-identifier">to_s</span> <span class="ruby-operator">+</span> <span class="ruby-string">'_message'</span>
|
828
|
+
<span class="ruby-identifier">message</span> = <span class="ruby-constant">CLI</span>.<span class="ruby-identifier">message</span>(<span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">options</span>[<span class="ruby-identifier">name</span>])
|
829
|
+
|
830
|
+
<span class="ruby-identifier">option_str</span> = <span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">array</span>(<span class="ruby-identifier">option_str</span>)
|
831
|
+
|
832
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">allowed_values</span>
|
833
|
+
<span class="ruby-identifier">parser</span>.<span class="ruby-identifier">on</span>(*<span class="ruby-identifier">option_str</span>, <span class="ruby-identifier">allowed_values</span>, <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">message_name</span>.<span class="ruby-identifier">to_sym</span>, <span class="ruby-identifier">message</span>)) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
834
|
+
<span class="ruby-identifier">value</span> = <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">value</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
|
835
|
+
<span class="ruby-identifier">options</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">value</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">nil?</span>
|
836
|
+
<span class="ruby-keyword">end</span>
|
837
|
+
<span class="ruby-keyword">else</span>
|
838
|
+
<span class="ruby-identifier">parser</span>.<span class="ruby-identifier">on</span>(*<span class="ruby-identifier">option_str</span>, <span class="ruby-identifier">config</span>.<span class="ruby-identifier">get</span>(<span class="ruby-identifier">message_name</span>.<span class="ruby-identifier">to_sym</span>, <span class="ruby-identifier">message</span>)) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
839
|
+
<span class="ruby-identifier">value</span> = <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">value</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">block_given?</span>
|
840
|
+
<span class="ruby-identifier">options</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">value</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">nil?</span>
|
841
|
+
<span class="ruby-keyword">end</span>
|
842
|
+
<span class="ruby-keyword">end</span>
|
843
|
+
<span class="ruby-keyword">end</span></pre>
|
844
|
+
</div><!-- option-source -->
|
845
|
+
|
846
|
+
</div>
|
847
|
+
|
848
|
+
|
849
|
+
|
850
|
+
|
851
|
+
</div><!-- option-method -->
|
852
|
+
|
853
|
+
|
854
|
+
<div id="method-i-option_array" class="method-detail ">
|
855
|
+
|
856
|
+
<div class="method-heading">
|
857
|
+
<span class="method-name">option_array</span><span
|
858
|
+
class="method-args">(name, default, option_str, message_id, config = {}) { |value| ... }</span>
|
859
|
+
<span class="method-click-advice">click to toggle source</span>
|
860
|
+
</div>
|
861
|
+
|
862
|
+
|
863
|
+
<div class="method-description">
|
864
|
+
|
865
|
+
|
866
|
+
|
867
|
+
|
868
|
+
|
869
|
+
<div class="method-source-code" id="option_array-source">
|
870
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 378</span>
|
871
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">option_array</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">option_str</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span> = {})
|
872
|
+
<span class="ruby-identifier">option</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">option_str</span>, <span class="ruby-constant">Array</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
873
|
+
<span class="ruby-identifier">block_given?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">value</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">value</span>
|
874
|
+
<span class="ruby-keyword">end</span>
|
875
|
+
<span class="ruby-keyword">end</span></pre>
|
876
|
+
</div><!-- option_array-source -->
|
877
|
+
|
878
|
+
</div>
|
879
|
+
|
880
|
+
|
881
|
+
|
882
|
+
|
883
|
+
</div><!-- option_array-method -->
|
884
|
+
|
885
|
+
|
886
|
+
<div id="method-i-option_bool" class="method-detail ">
|
887
|
+
|
888
|
+
<div class="method-heading">
|
889
|
+
<span class="method-name">option_bool</span><span
|
890
|
+
class="method-args">(name, default, option_str, message_id, config = {}) { |value| ... }</span>
|
891
|
+
<span class="method-click-advice">click to toggle source</span>
|
892
|
+
</div>
|
893
|
+
|
894
|
+
|
895
|
+
<div class="method-description">
|
896
|
+
|
897
|
+
|
898
|
+
|
899
|
+
|
900
|
+
|
901
|
+
<div class="method-source-code" id="option_bool-source">
|
902
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 304</span>
|
903
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">option_bool</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">option_str</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span> = {})
|
904
|
+
<span class="ruby-identifier">option</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">option_str</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
905
|
+
<span class="ruby-identifier">value</span> = <span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">value</span>(<span class="ruby-identifier">value</span>)
|
906
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">true</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">value</span> <span class="ruby-operator">==</span> <span class="ruby-keyword">false</span>
|
907
|
+
<span class="ruby-identifier">block_given?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">value</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">value</span>
|
908
|
+
<span class="ruby-keyword">else</span>
|
909
|
+
<span class="ruby-keyword">nil</span>
|
910
|
+
<span class="ruby-keyword">end</span>
|
911
|
+
<span class="ruby-keyword">end</span>
|
912
|
+
<span class="ruby-keyword">end</span></pre>
|
913
|
+
</div><!-- option_bool-source -->
|
914
|
+
|
915
|
+
</div>
|
916
|
+
|
917
|
+
|
918
|
+
|
919
|
+
|
920
|
+
</div><!-- option_bool-method -->
|
921
|
+
|
922
|
+
|
923
|
+
<div id="method-i-option_float" class="method-detail ">
|
924
|
+
|
925
|
+
<div class="method-heading">
|
926
|
+
<span class="method-name">option_float</span><span
|
927
|
+
class="method-args">(name, default, option_str, message_id, config = {}) { |value| ... }</span>
|
928
|
+
<span class="method-click-advice">click to toggle source</span>
|
929
|
+
</div>
|
930
|
+
|
931
|
+
|
932
|
+
<div class="method-description">
|
933
|
+
|
934
|
+
|
935
|
+
|
936
|
+
|
937
|
+
|
938
|
+
<div class="method-source-code" id="option_float-source">
|
939
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 346</span>
|
940
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">option_float</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">option_str</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span> = {})
|
941
|
+
<span class="ruby-identifier">option</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">option_str</span>, <span class="ruby-constant">Float</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
942
|
+
<span class="ruby-identifier">block_given?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">value</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">value</span>
|
943
|
+
<span class="ruby-keyword">end</span>
|
944
|
+
<span class="ruby-keyword">end</span></pre>
|
945
|
+
</div><!-- option_float-source -->
|
946
|
+
|
947
|
+
</div>
|
948
|
+
|
949
|
+
|
950
|
+
|
951
|
+
|
952
|
+
</div><!-- option_float-method -->
|
953
|
+
|
954
|
+
|
955
|
+
<div id="method-i-option_int" class="method-detail ">
|
956
|
+
|
957
|
+
<div class="method-heading">
|
958
|
+
<span class="method-name">option_int</span><span
|
959
|
+
class="method-args">(name, default, option_str, message_id, config = {}) { |value| ... }</span>
|
960
|
+
<span class="method-click-advice">click to toggle source</span>
|
961
|
+
</div>
|
962
|
+
|
963
|
+
|
964
|
+
<div class="method-description">
|
965
|
+
|
966
|
+
|
967
|
+
|
968
|
+
|
969
|
+
|
970
|
+
<div class="method-source-code" id="option_int-source">
|
971
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 330</span>
|
972
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">option_int</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">option_str</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span> = {})
|
973
|
+
<span class="ruby-identifier">option</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">option_str</span>, <span class="ruby-constant">Integer</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
974
|
+
<span class="ruby-identifier">block_given?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">value</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">value</span>
|
975
|
+
<span class="ruby-keyword">end</span>
|
976
|
+
<span class="ruby-keyword">end</span></pre>
|
977
|
+
</div><!-- option_int-source -->
|
978
|
+
|
979
|
+
</div>
|
980
|
+
|
981
|
+
|
982
|
+
|
983
|
+
|
984
|
+
</div><!-- option_int-method -->
|
985
|
+
|
986
|
+
|
987
|
+
<div id="method-i-option_str" class="method-detail ">
|
988
|
+
|
989
|
+
<div class="method-heading">
|
990
|
+
<span class="method-name">option_str</span><span
|
991
|
+
class="method-args">(name, default, option_str, message_id, config = {}) { |value| ... }</span>
|
992
|
+
<span class="method-click-advice">click to toggle source</span>
|
993
|
+
</div>
|
994
|
+
|
995
|
+
|
996
|
+
<div class="method-description">
|
997
|
+
|
998
|
+
|
999
|
+
|
1000
|
+
|
1001
|
+
|
1002
|
+
<div class="method-source-code" id="option_str-source">
|
1003
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 362</span>
|
1004
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">option_str</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">option_str</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span> = {})
|
1005
|
+
<span class="ruby-identifier">option</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">default</span>, <span class="ruby-identifier">option_str</span>, <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">message_id</span>, <span class="ruby-identifier">config</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
1006
|
+
<span class="ruby-identifier">block_given?</span> <span class="ruby-operator">?</span> <span class="ruby-keyword">yield</span>(<span class="ruby-identifier">value</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">value</span>
|
1007
|
+
<span class="ruby-keyword">end</span>
|
1008
|
+
<span class="ruby-keyword">end</span></pre>
|
1009
|
+
</div><!-- option_str-source -->
|
1010
|
+
|
1011
|
+
</div>
|
1012
|
+
|
1013
|
+
|
1014
|
+
|
1015
|
+
|
1016
|
+
</div><!-- option_str-method -->
|
1017
|
+
|
1018
|
+
|
1019
|
+
<div id="method-i-parse_command" class="method-detail ">
|
1020
|
+
|
1021
|
+
<div class="method-heading">
|
1022
|
+
<span class="method-name">parse_command</span><span
|
1023
|
+
class="method-args">(args, split_help = false)</span>
|
1024
|
+
<span class="method-click-advice">click to toggle source</span>
|
1025
|
+
</div>
|
1026
|
+
|
1027
|
+
|
1028
|
+
<div class="method-description">
|
1029
|
+
|
1030
|
+
|
1031
|
+
|
1032
|
+
|
1033
|
+
|
1034
|
+
<div class="method-source-code" id="parse_command-source">
|
1035
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 116</span>
|
1036
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">parse_command</span>(<span class="ruby-identifier">args</span>, <span class="ruby-identifier">split_help</span> = <span class="ruby-keyword">false</span>)
|
1037
|
+
<span class="ruby-identifier">args</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">dup</span>
|
1038
|
+
<span class="ruby-identifier">error</span> = <span class="ruby-keyword">false</span>
|
1039
|
+
|
1040
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">processed</span> = <span class="ruby-keyword">false</span>
|
1041
|
+
|
1042
|
+
<span class="ruby-identifier">option_bool</span>(<span class="ruby-value">:version</span>, <span class="ruby-keyword">false</span>,
|
1043
|
+
<span class="ruby-string">'--version'</span>,
|
1044
|
+
<span class="ruby-string">'nucleon.core.util.cli.options.version'</span>
|
1045
|
+
)
|
1046
|
+
<span class="ruby-identifier">option_bool</span>(<span class="ruby-value">:color</span>, <span class="ruby-keyword">true</span>,
|
1047
|
+
<span class="ruby-string">'--[no]-color'</span>,
|
1048
|
+
<span class="ruby-string">'nucleon.core.util.cli.options.color'</span>
|
1049
|
+
)
|
1050
|
+
<span class="ruby-identifier">option_str</span>(<span class="ruby-value">:log_level</span>, <span class="ruby-keyword">nil</span>,
|
1051
|
+
<span class="ruby-string">'--log_level STR'</span>,
|
1052
|
+
<span class="ruby-string">'nucleon.core.util.cli.options.log_level'</span>
|
1053
|
+
)
|
1054
|
+
<span class="ruby-identifier">option_str</span>(<span class="ruby-value">:encoded_params</span>, <span class="ruby-keyword">false</span>,
|
1055
|
+
<span class="ruby-string">'--encoded STR'</span>,
|
1056
|
+
<span class="ruby-string">'nucleon.core.util.cli.options.encoded'</span>
|
1057
|
+
)
|
1058
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">split_help</span>
|
1059
|
+
<span class="ruby-identifier">parser</span>.<span class="ruby-identifier">on_tail</span>(<span class="ruby-string">'-h'</span>, <span class="ruby-constant">CLI</span>.<span class="ruby-identifier">message</span>(<span class="ruby-string">'nucleon.core.util.cli.options.short_help'</span>)) <span class="ruby-keyword">do</span>
|
1060
|
+
<span class="ruby-identifier">options</span>[<span class="ruby-value">:help</span>] = <span class="ruby-keyword">true</span>
|
1061
|
+
<span class="ruby-keyword">end</span>
|
1062
|
+
<span class="ruby-identifier">parser</span>.<span class="ruby-identifier">on_tail</span>(<span class="ruby-string">'--help'</span>, <span class="ruby-constant">CLI</span>.<span class="ruby-identifier">message</span>(<span class="ruby-string">'nucleon.core.util.cli.options.extended_help'</span>)) <span class="ruby-keyword">do</span>
|
1063
|
+
<span class="ruby-identifier">options</span>[<span class="ruby-value">:help</span>] = <span class="ruby-keyword">true</span>
|
1064
|
+
<span class="ruby-identifier">options</span>[<span class="ruby-value">:extended_help</span>] = <span class="ruby-keyword">true</span>
|
1065
|
+
<span class="ruby-keyword">end</span>
|
1066
|
+
<span class="ruby-keyword">else</span>
|
1067
|
+
<span class="ruby-identifier">parser</span>.<span class="ruby-identifier">on_tail</span>(<span class="ruby-string">'-h'</span>, <span class="ruby-string">'--help'</span>, <span class="ruby-constant">CLI</span>.<span class="ruby-identifier">message</span>(<span class="ruby-string">'nucleon.core.util.cli.options.short_help'</span>)) <span class="ruby-keyword">do</span>
|
1068
|
+
<span class="ruby-identifier">options</span>[<span class="ruby-value">:help</span>] = <span class="ruby-keyword">true</span>
|
1069
|
+
<span class="ruby-keyword">end</span>
|
1070
|
+
<span class="ruby-keyword">end</span>
|
1071
|
+
<span class="ruby-identifier">parser</span>.<span class="ruby-identifier">parse!</span>(<span class="ruby-identifier">args</span>)
|
1072
|
+
|
1073
|
+
<span class="ruby-comment"># Now we can act on options given</span>
|
1074
|
+
<span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Console</span>.<span class="ruby-identifier">use_colors</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:color</span>] <span class="ruby-keyword">unless</span> <span class="ruby-identifier">split_help</span>
|
1075
|
+
|
1076
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:version</span>]
|
1077
|
+
<span class="ruby-identifier">puts</span> <span class="ruby-identifier">version</span>
|
1078
|
+
<span class="ruby-identifier">exit</span> <span class="ruby-value">0</span>
|
1079
|
+
<span class="ruby-keyword">end</span>
|
1080
|
+
|
1081
|
+
<span class="ruby-keyword">return</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:help</span>]
|
1082
|
+
|
1083
|
+
<span class="ruby-identifier">parse_encoded</span>
|
1084
|
+
|
1085
|
+
<span class="ruby-constant">Nucleon</span>.<span class="ruby-identifier">log_level</span> = <span class="ruby-identifier">options</span>[<span class="ruby-value">:log_level</span>] <span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:log_level</span>]
|
1086
|
+
|
1087
|
+
<span class="ruby-identifier">remaining_args</span> = <span class="ruby-identifier">args</span>.<span class="ruby-identifier">dup</span>
|
1088
|
+
<span class="ruby-identifier">arg_messages</span> = []
|
1089
|
+
|
1090
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">empty?</span>
|
1091
|
+
<span class="ruby-ivar">@arg_settings</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">settings</span>, <span class="ruby-identifier">index</span><span class="ruby-operator">|</span>
|
1092
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">index</span> <span class="ruby-operator">>=</span> <span class="ruby-identifier">args</span>.<span class="ruby-identifier">length</span>
|
1093
|
+
<span class="ruby-identifier">value</span> = <span class="ruby-keyword">nil</span>
|
1094
|
+
<span class="ruby-keyword">else</span>
|
1095
|
+
<span class="ruby-identifier">value</span> = <span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">value</span>(<span class="ruby-identifier">args</span>[<span class="ruby-identifier">index</span>])
|
1096
|
+
<span class="ruby-keyword">end</span>
|
1097
|
+
|
1098
|
+
<span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">value</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">settings</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-value">:allowed</span>)
|
1099
|
+
<span class="ruby-identifier">allowed</span> = <span class="ruby-identifier">settings</span>[<span class="ruby-value">:allowed</span>]
|
1100
|
+
<span class="ruby-keyword">case</span> <span class="ruby-identifier">allowed</span>
|
1101
|
+
<span class="ruby-keyword">when</span> <span class="ruby-constant">Class</span>
|
1102
|
+
<span class="ruby-keyword">if</span> (<span class="ruby-identifier">allowed</span> <span class="ruby-operator">==</span> <span class="ruby-constant">Array</span>)
|
1103
|
+
<span class="ruby-identifier">value</span> = <span class="ruby-identifier">remaining_args</span>
|
1104
|
+
<span class="ruby-identifier">remaining_args</span> = []
|
1105
|
+
<span class="ruby-keyword">end</span>
|
1106
|
+
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-identifier">allowed</span>)
|
1107
|
+
<span class="ruby-identifier">arg_messages</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">CLI</span>.<span class="ruby-identifier">message</span>(<span class="ruby-identifier">settings</span>[<span class="ruby-value">:message</span>])
|
1108
|
+
<span class="ruby-identifier">error</span> = <span class="ruby-keyword">true</span>
|
1109
|
+
<span class="ruby-keyword">end</span>
|
1110
|
+
<span class="ruby-keyword">when</span> <span class="ruby-constant">Array</span>
|
1111
|
+
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">allowed</span>.<span class="ruby-identifier">include</span>(<span class="ruby-identifier">value</span>)
|
1112
|
+
<span class="ruby-identifier">arg_messages</span> <span class="ruby-operator"><<</span> <span class="ruby-constant">CLI</span>.<span class="ruby-identifier">message</span>(<span class="ruby-identifier">settings</span>[<span class="ruby-value">:message</span>])
|
1113
|
+
<span class="ruby-identifier">error</span> = <span class="ruby-keyword">true</span>
|
1114
|
+
<span class="ruby-keyword">end</span>
|
1115
|
+
<span class="ruby-keyword">end</span>
|
1116
|
+
<span class="ruby-keyword">end</span>
|
1117
|
+
|
1118
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">nil?</span>
|
1119
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">settings</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-value">:default</span>)
|
1120
|
+
<span class="ruby-identifier">value</span> = <span class="ruby-identifier">settings</span>[<span class="ruby-value">:default</span>]
|
1121
|
+
<span class="ruby-keyword">else</span>
|
1122
|
+
<span class="ruby-identifier">error</span> = <span class="ruby-keyword">true</span>
|
1123
|
+
<span class="ruby-keyword">end</span>
|
1124
|
+
<span class="ruby-keyword">end</span>
|
1125
|
+
|
1126
|
+
<span class="ruby-keyword">if</span> <span class="ruby-operator">!</span><span class="ruby-identifier">value</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-operator">&&</span> <span class="ruby-identifier">settings</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-value">:block</span>)
|
1127
|
+
<span class="ruby-identifier">value</span> = <span class="ruby-identifier">settings</span>[<span class="ruby-value">:block</span>].<span class="ruby-identifier">call</span>(<span class="ruby-identifier">value</span>)
|
1128
|
+
<span class="ruby-identifier">error</span> = <span class="ruby-keyword">true</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">value</span>.<span class="ruby-identifier">nil?</span>
|
1129
|
+
<span class="ruby-keyword">end</span>
|
1130
|
+
|
1131
|
+
<span class="ruby-keyword">break</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">error</span>
|
1132
|
+
|
1133
|
+
<span class="ruby-identifier">remaining_args</span>.<span class="ruby-identifier">shift</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">remaining_args</span>.<span class="ruby-identifier">empty?</span>
|
1134
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">arguments</span>[<span class="ruby-identifier">settings</span>[<span class="ruby-value">:name</span>]] = <span class="ruby-identifier">value</span>
|
1135
|
+
<span class="ruby-keyword">end</span>
|
1136
|
+
<span class="ruby-keyword">end</span>
|
1137
|
+
|
1138
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">error</span>
|
1139
|
+
<span class="ruby-keyword">if</span> <span class="ruby-operator">!</span> <span class="ruby-identifier">arg_messages</span>.<span class="ruby-identifier">empty?</span>
|
1140
|
+
<span class="ruby-identifier">parser</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-constant">CLI</span>.<span class="ruby-identifier">message</span>(<span class="ruby-string">'nucleon.core.util.cli.parse.error'</span>) <span class="ruby-operator">+</span> <span class="ruby-string">"\n\n"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">arg_messages</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">"\n"</span>) <span class="ruby-operator">+</span> <span class="ruby-string">"\n\n"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">help</span>)
|
1141
|
+
<span class="ruby-keyword">else</span>
|
1142
|
+
<span class="ruby-identifier">parser</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-constant">CLI</span>.<span class="ruby-identifier">message</span>(<span class="ruby-string">'nucleon.core.util.cli.parse.error'</span>) <span class="ruby-operator">+</span> <span class="ruby-string">"\n\n"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">help</span>)
|
1143
|
+
<span class="ruby-keyword">end</span>
|
1144
|
+
<span class="ruby-keyword">else</span>
|
1145
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">processed</span> = <span class="ruby-keyword">true</span>
|
1146
|
+
<span class="ruby-keyword">end</span>
|
1147
|
+
|
1148
|
+
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">OptionParser</span><span class="ruby-operator">::</span><span class="ruby-constant">InvalidOption</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
|
1149
|
+
<span class="ruby-identifier">parser</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-identifier">e</span>.<span class="ruby-identifier">message</span> <span class="ruby-operator">+</span> <span class="ruby-string">"\n\n"</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">parser</span>.<span class="ruby-identifier">help</span>)
|
1150
|
+
<span class="ruby-keyword">end</span></pre>
|
1151
|
+
</div><!-- parse_command-source -->
|
1152
|
+
|
1153
|
+
</div>
|
1154
|
+
|
1155
|
+
|
1156
|
+
|
1157
|
+
|
1158
|
+
</div><!-- parse_command-method -->
|
1159
|
+
|
1160
|
+
|
1161
|
+
<div id="method-i-parse_encoded" class="method-detail ">
|
1162
|
+
|
1163
|
+
<div class="method-heading">
|
1164
|
+
<span class="method-name">parse_encoded</span><span
|
1165
|
+
class="method-args">()</span>
|
1166
|
+
<span class="method-click-advice">click to toggle source</span>
|
1167
|
+
</div>
|
1168
|
+
|
1169
|
+
|
1170
|
+
<div class="method-description">
|
1171
|
+
|
1172
|
+
|
1173
|
+
|
1174
|
+
|
1175
|
+
|
1176
|
+
<div class="method-source-code" id="parse_encoded-source">
|
1177
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 234</span>
|
1178
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">parse_encoded</span>
|
1179
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:encoded_params</span>]
|
1180
|
+
<span class="ruby-identifier">encoded_properties</span> = <span class="ruby-constant">CLI</span>.<span class="ruby-identifier">decode</span>(<span class="ruby-identifier">options</span>[<span class="ruby-value">:encoded_params</span>])
|
1181
|
+
|
1182
|
+
<span class="ruby-ivar">@arg_settings</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">settings</span><span class="ruby-operator">|</span>
|
1183
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">encoded_properties</span>.<span class="ruby-identifier">has_key?</span>(<span class="ruby-identifier">settings</span>[<span class="ruby-value">:name</span>].<span class="ruby-identifier">to_sym</span>)
|
1184
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">arguments</span>[<span class="ruby-identifier">settings</span>[<span class="ruby-value">:name</span>]] = <span class="ruby-identifier">encoded_properties</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">settings</span>[<span class="ruby-value">:name</span>].<span class="ruby-identifier">to_sym</span>)
|
1185
|
+
<span class="ruby-keyword">end</span>
|
1186
|
+
<span class="ruby-keyword">end</span>
|
1187
|
+
|
1188
|
+
<span class="ruby-identifier">encoded_properties</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">name</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
|
1189
|
+
<span class="ruby-keyword">self</span>.<span class="ruby-identifier">options</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">value</span>
|
1190
|
+
|
1191
|
+
<span class="ruby-keyword">if</span> <span class="ruby-identifier">name</span> <span class="ruby-operator">==</span> <span class="ruby-value">:color</span>
|
1192
|
+
<span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Console</span>.<span class="ruby-identifier">use_colors</span> = <span class="ruby-identifier">value</span>
|
1193
|
+
<span class="ruby-keyword">end</span>
|
1194
|
+
<span class="ruby-keyword">end</span>
|
1195
|
+
<span class="ruby-keyword">end</span>
|
1196
|
+
<span class="ruby-identifier">options</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:encoded_params</span>)
|
1197
|
+
<span class="ruby-keyword">end</span></pre>
|
1198
|
+
</div><!-- parse_encoded-source -->
|
1199
|
+
|
1200
|
+
</div>
|
1201
|
+
|
1202
|
+
|
1203
|
+
|
1204
|
+
|
1205
|
+
</div><!-- parse_encoded-method -->
|
1206
|
+
|
1207
|
+
|
1208
|
+
<div id="method-i-version" class="method-detail ">
|
1209
|
+
|
1210
|
+
<div class="method-heading">
|
1211
|
+
<span class="method-name">version</span><span
|
1212
|
+
class="method-args">()</span>
|
1213
|
+
<span class="method-click-advice">click to toggle source</span>
|
1214
|
+
</div>
|
1215
|
+
|
1216
|
+
|
1217
|
+
<div class="method-description">
|
1218
|
+
|
1219
|
+
|
1220
|
+
|
1221
|
+
|
1222
|
+
|
1223
|
+
<div class="method-source-code" id="version-source">
|
1224
|
+
<pre><span class="ruby-comment"># File lib/core/util/cli.rb, line 110</span>
|
1225
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">version</span>
|
1226
|
+
<span class="ruby-comment"># Override in executable script</span>
|
1227
|
+
<span class="ruby-keyword">end</span></pre>
|
1228
|
+
</div><!-- version-source -->
|
1229
|
+
|
1230
|
+
</div>
|
1231
|
+
|
1232
|
+
|
1233
|
+
|
1234
|
+
|
1235
|
+
</div><!-- version-method -->
|
1236
|
+
|
1237
|
+
|
1238
|
+
</section><!-- public-instance-method-details -->
|
1239
|
+
|
1240
|
+
</section><!-- 5Buntitled-5D -->
|
1241
|
+
|
1242
|
+
</div><!-- documentation -->
|
1243
|
+
|
1244
|
+
|
1245
|
+
<footer id="validator-badges">
|
1246
|
+
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
|
1247
|
+
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.2.
|
1248
|
+
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
|
1249
|
+
</footer>
|
1250
|
+
|