nucleon 0.1.19 → 0.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (159) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +1 -0
  3. data/Gemfile.lock +1 -0
  4. data/TODO.rdoc +0 -3
  5. data/VERSION +1 -1
  6. data/bin/nucleon +19 -0
  7. data/lib/core/config.rb +11 -7
  8. data/lib/core/environment.rb +338 -0
  9. data/lib/core/facade.rb +150 -98
  10. data/lib/core/manager.rb +160 -249
  11. data/lib/core/mixin/action/project.rb +2 -2
  12. data/lib/core/mixin/macro/plugin_interface.rb +11 -11
  13. data/lib/core/plugin/action.rb +277 -24
  14. data/lib/core/plugin/base.rb +22 -14
  15. data/lib/core/plugin/command.rb +1 -1
  16. data/lib/core/plugin/event.rb +3 -3
  17. data/lib/core/plugin/extension.rb +1 -1
  18. data/lib/core/plugin/project.rb +15 -15
  19. data/lib/core/plugin/template.rb +1 -1
  20. data/lib/core/plugin/translator.rb +1 -1
  21. data/lib/core/util/cache.rb +1 -1
  22. data/lib/core/util/cli.rb +32 -3
  23. data/lib/core/util/console.rb +30 -10
  24. data/lib/core/util/data.rb +11 -3
  25. data/lib/core/util/logger.rb +1 -1
  26. data/lib/core/util/shell.rb +6 -3
  27. data/lib/core/util/ssh.rb +148 -24
  28. data/lib/nucleon/action/extract.rb +11 -4
  29. data/lib/nucleon/action/{add.rb → project/add.rb} +13 -4
  30. data/lib/nucleon/action/{create.rb → project/create.rb} +12 -3
  31. data/lib/nucleon/action/{remove.rb → project/remove.rb} +11 -2
  32. data/lib/nucleon/action/{save.rb → project/save.rb} +11 -2
  33. data/lib/nucleon/action/{update.rb → project/update.rb} +11 -2
  34. data/lib/nucleon/command/bash.rb +1 -1
  35. data/lib/nucleon/event/regex.rb +1 -1
  36. data/lib/nucleon/project/git.rb +3 -3
  37. data/lib/nucleon/template/{json.rb → JSON.rb} +1 -1
  38. data/lib/nucleon/template/{yaml.rb → YAML.rb} +1 -1
  39. data/lib/nucleon/template/wrapper.rb +1 -1
  40. data/lib/nucleon/translator/{json.rb → JSON.rb} +1 -1
  41. data/lib/nucleon/translator/{yaml.rb → YAML.rb} +1 -1
  42. data/lib/nucleon_base.rb +26 -15
  43. data/locales/en.yml +69 -44
  44. data/nucleon.gemspec +129 -11
  45. data/rdoc/site/0.1.19/ARCHITECTURE_rdoc.html +634 -0
  46. data/rdoc/site/0.1.19/Hash.html +347 -0
  47. data/rdoc/site/0.1.19/Kernel.html +413 -0
  48. data/rdoc/site/0.1.19/Nucleon.html +570 -0
  49. data/rdoc/site/0.1.19/Nucleon/Action.html +280 -0
  50. data/rdoc/site/0.1.19/Nucleon/Action/Add.html +458 -0
  51. data/rdoc/site/0.1.19/Nucleon/Action/Create.html +415 -0
  52. data/rdoc/site/0.1.19/Nucleon/Action/Extract.html +413 -0
  53. data/rdoc/site/0.1.19/Nucleon/Action/Remove.html +461 -0
  54. data/rdoc/site/0.1.19/Nucleon/Action/Save.html +434 -0
  55. data/rdoc/site/0.1.19/Nucleon/Action/Update.html +381 -0
  56. data/rdoc/site/0.1.19/Nucleon/Codes.html +563 -0
  57. data/rdoc/site/0.1.19/Nucleon/Command.html +275 -0
  58. data/rdoc/site/0.1.19/Nucleon/Command/Bash.html +544 -0
  59. data/rdoc/site/0.1.19/Nucleon/Config.html +1623 -0
  60. data/rdoc/site/0.1.19/Nucleon/Config/Collection.html +509 -0
  61. data/rdoc/site/0.1.19/Nucleon/Config/Options.html +489 -0
  62. data/rdoc/site/0.1.19/Nucleon/Core.html +635 -0
  63. data/rdoc/site/0.1.19/Nucleon/Errors.html +275 -0
  64. data/rdoc/site/0.1.19/Nucleon/Errors/BatchError.html +281 -0
  65. data/rdoc/site/0.1.19/Nucleon/Errors/NucleonError.html +657 -0
  66. data/rdoc/site/0.1.19/Nucleon/Errors/SSHUnavailable.html +281 -0
  67. data/rdoc/site/0.1.19/Nucleon/Event.html +275 -0
  68. data/rdoc/site/0.1.19/Nucleon/Event/Regex.html +467 -0
  69. data/rdoc/site/0.1.19/Nucleon/Facade.html +2336 -0
  70. data/rdoc/site/0.1.19/Nucleon/Gems.html +635 -0
  71. data/rdoc/site/0.1.19/Nucleon/Manager.html +1828 -0
  72. data/rdoc/site/0.1.19/Nucleon/Mixin.html +284 -0
  73. data/rdoc/site/0.1.19/Nucleon/Mixin/Action.html +277 -0
  74. data/rdoc/site/0.1.19/Nucleon/Mixin/Action/Commit.html +381 -0
  75. data/rdoc/site/0.1.19/Nucleon/Mixin/Action/Project.html +395 -0
  76. data/rdoc/site/0.1.19/Nucleon/Mixin/Action/Push.html +371 -0
  77. data/rdoc/site/0.1.19/Nucleon/Mixin/Colors.html +545 -0
  78. data/rdoc/site/0.1.19/Nucleon/Mixin/ConfigCollection.html +481 -0
  79. data/rdoc/site/0.1.19/Nucleon/Mixin/ConfigOptions.html +449 -0
  80. data/rdoc/site/0.1.19/Nucleon/Mixin/Macro.html +276 -0
  81. data/rdoc/site/0.1.19/Nucleon/Mixin/Macro/ObjectInterface.html +695 -0
  82. data/rdoc/site/0.1.19/Nucleon/Mixin/Macro/PluginInterface.html +682 -0
  83. data/rdoc/site/0.1.19/Nucleon/Mixin/Settings.html +481 -0
  84. data/rdoc/site/0.1.19/Nucleon/Mixin/SubConfig.html +887 -0
  85. data/rdoc/site/0.1.19/Nucleon/Parallel.html +325 -0
  86. data/rdoc/site/0.1.19/Nucleon/Parallel/ClassMethods.html +325 -0
  87. data/rdoc/site/0.1.19/Nucleon/Parallel/InstanceMethods.html +334 -0
  88. data/rdoc/site/0.1.19/Nucleon/Plugin.html +282 -0
  89. data/rdoc/site/0.1.19/Nucleon/Plugin/Action.html +1368 -0
  90. data/rdoc/site/0.1.19/Nucleon/Plugin/Action/Option.html +459 -0
  91. data/rdoc/site/0.1.19/Nucleon/Plugin/Base.html +1737 -0
  92. data/rdoc/site/0.1.19/Nucleon/Plugin/Command.html +721 -0
  93. data/rdoc/site/0.1.19/Nucleon/Plugin/Event.html +442 -0
  94. data/rdoc/site/0.1.19/Nucleon/Plugin/Extension.html +281 -0
  95. data/rdoc/site/0.1.19/Nucleon/Plugin/Project.html +2864 -0
  96. data/rdoc/site/0.1.19/Nucleon/Plugin/Template.html +476 -0
  97. data/rdoc/site/0.1.19/Nucleon/Plugin/Translator.html +371 -0
  98. data/rdoc/site/0.1.19/Nucleon/Project.html +276 -0
  99. data/rdoc/site/0.1.19/Nucleon/Project/Git.html +1801 -0
  100. data/rdoc/site/0.1.19/Nucleon/Project/Github.html +549 -0
  101. data/rdoc/site/0.1.19/Nucleon/Template.html +277 -0
  102. data/rdoc/site/0.1.19/Nucleon/Template/Json.html +329 -0
  103. data/rdoc/site/0.1.19/Nucleon/Template/Wrapper.html +329 -0
  104. data/rdoc/site/0.1.19/Nucleon/Template/Yaml.html +329 -0
  105. data/rdoc/site/0.1.19/Nucleon/Translator.html +276 -0
  106. data/rdoc/site/0.1.19/Nucleon/Translator/Json.html +366 -0
  107. data/rdoc/site/0.1.19/Nucleon/Translator/Yaml.html +366 -0
  108. data/rdoc/site/0.1.19/Nucleon/Util.html +285 -0
  109. data/rdoc/site/0.1.19/Nucleon/Util/CLI.html +388 -0
  110. data/rdoc/site/0.1.19/Nucleon/Util/CLI/Parser.html +1183 -0
  111. data/rdoc/site/0.1.19/Nucleon/Util/Cache.html +780 -0
  112. data/rdoc/site/0.1.19/Nucleon/Util/Console.html +1294 -0
  113. data/rdoc/site/0.1.19/Nucleon/Util/Data.html +1399 -0
  114. data/rdoc/site/0.1.19/Nucleon/Util/Disk.html +522 -0
  115. data/rdoc/site/0.1.19/Nucleon/Util/Git.html +361 -0
  116. data/rdoc/site/0.1.19/Nucleon/Util/Liquid.html +365 -0
  117. data/rdoc/site/0.1.19/Nucleon/Util/Logger.html +806 -0
  118. data/rdoc/site/0.1.19/Nucleon/Util/Package.html +558 -0
  119. data/rdoc/site/0.1.19/Nucleon/Util/SSH.html +910 -0
  120. data/rdoc/site/0.1.19/Nucleon/Util/SSH/Keypair.html +453 -0
  121. data/rdoc/site/0.1.19/Nucleon/Util/Shell.html +686 -0
  122. data/rdoc/site/0.1.19/Nucleon/Util/Shell/Result.html +497 -0
  123. data/rdoc/site/0.1.19/README_rdoc.html +312 -0
  124. data/rdoc/site/0.1.19/TODO_rdoc.html +267 -0
  125. data/rdoc/site/0.1.19/created.rid +60 -0
  126. data/rdoc/site/0.1.19/images/add.png +0 -0
  127. data/rdoc/site/0.1.19/images/brick.png +0 -0
  128. data/rdoc/site/0.1.19/images/brick_link.png +0 -0
  129. data/rdoc/site/0.1.19/images/bug.png +0 -0
  130. data/rdoc/site/0.1.19/images/bullet_black.png +0 -0
  131. data/rdoc/site/0.1.19/images/bullet_toggle_minus.png +0 -0
  132. data/rdoc/site/0.1.19/images/bullet_toggle_plus.png +0 -0
  133. data/rdoc/site/0.1.19/images/date.png +0 -0
  134. data/rdoc/site/0.1.19/images/delete.png +0 -0
  135. data/rdoc/site/0.1.19/images/find.png +0 -0
  136. data/rdoc/site/0.1.19/images/loadingAnimation.gif +0 -0
  137. data/rdoc/site/0.1.19/images/macFFBgHack.png +0 -0
  138. data/rdoc/site/0.1.19/images/package.png +0 -0
  139. data/rdoc/site/0.1.19/images/page_green.png +0 -0
  140. data/rdoc/site/0.1.19/images/page_white_text.png +0 -0
  141. data/rdoc/site/0.1.19/images/page_white_width.png +0 -0
  142. data/rdoc/site/0.1.19/images/plugin.png +0 -0
  143. data/rdoc/site/0.1.19/images/ruby.png +0 -0
  144. data/rdoc/site/0.1.19/images/tag_blue.png +0 -0
  145. data/rdoc/site/0.1.19/images/tag_green.png +0 -0
  146. data/rdoc/site/0.1.19/images/transparent.png +0 -0
  147. data/rdoc/site/0.1.19/images/wrench.png +0 -0
  148. data/rdoc/site/0.1.19/images/wrench_orange.png +0 -0
  149. data/rdoc/site/0.1.19/images/zoom.png +0 -0
  150. data/rdoc/site/0.1.19/index.html +311 -0
  151. data/rdoc/site/0.1.19/js/darkfish.js +155 -0
  152. data/rdoc/site/0.1.19/js/jquery.js +18 -0
  153. data/rdoc/site/0.1.19/js/navigation.js +142 -0
  154. data/rdoc/site/0.1.19/js/search.js +94 -0
  155. data/rdoc/site/0.1.19/js/search_index.js +1 -0
  156. data/rdoc/site/0.1.19/js/searcher.js +228 -0
  157. data/rdoc/site/0.1.19/rdoc.css +543 -0
  158. data/rdoc/site/0.1.19/table_of_contents.html +1541 -0
  159. metadata +140 -11
@@ -0,0 +1,1737 @@
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::Plugin::Base - nucleon 0.1.19</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/plugin/base.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"><a href="../Core.html">Nucleon::Core</a>
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="../Parallel.html">Nucleon::Parallel</a>
74
+
75
+
76
+
77
+ <li><a class="include" href="../Mixin/Settings.html">Nucleon::Mixin::Settings</a>
78
+
79
+
80
+
81
+ <li><a class="include" href="../Mixin/SubConfig.html">Nucleon::Mixin::SubConfig</a>
82
+
83
+
84
+ </ul>
85
+ </nav>
86
+
87
+ <!-- Method Quickref -->
88
+ <nav id="method-list-section" class="section">
89
+ <h3 class="section-header">Methods</h3>
90
+
91
+ <ul class="link-list">
92
+
93
+ <li><a href="#method-c-build_info">::build_info</a>
94
+
95
+ <li><a href="#method-c-init_plugin_collection">::init_plugin_collection</a>
96
+
97
+ <li><a href="#method-c-new">::new</a>
98
+
99
+ <li><a href="#method-c-translate">::translate</a>
100
+
101
+ <li><a href="#method-i-admin_exec">#admin_exec</a>
102
+
103
+ <li><a href="#method-i-alert">#alert</a>
104
+
105
+ <li><a href="#method-i-code">#code</a>
106
+
107
+ <li><a href="#method-i-codes">#codes</a>
108
+
109
+ <li><a href="#method-i-error">#error</a>
110
+
111
+ <li><a href="#method-i-extended_config">#extended_config</a>
112
+
113
+ <li><a href="#method-i-extension">#extension</a>
114
+
115
+ <li><a href="#method-i-extension_check">#extension_check</a>
116
+
117
+ <li><a href="#method-i-extension_collect">#extension_collect</a>
118
+
119
+ <li><a href="#method-i-extension_set">#extension_set</a>
120
+
121
+ <li><a href="#method-i-hook_method">#hook_method</a>
122
+
123
+ <li><a href="#method-i-info">#info</a>
124
+
125
+ <li><a href="#method-i-me">#me</a>
126
+
127
+ <li><a href="#method-i-meta">#meta</a>
128
+
129
+ <li><a href="#method-i-method_missing">#method_missing</a>
130
+
131
+ <li><a href="#method-i-myself">#myself</a>
132
+
133
+ <li><a href="#method-i-normalize">#normalize</a>
134
+
135
+ <li><a href="#method-i-plugin_directory">#plugin_directory</a>
136
+
137
+ <li><a href="#method-i-plugin_file">#plugin_file</a>
138
+
139
+ <li><a href="#method-i-plugin_instance_name">#plugin_instance_name</a>
140
+
141
+ <li><a href="#method-i-plugin_name">#plugin_name</a>
142
+
143
+ <li><a href="#method-i-plugin_name-3D">#plugin_name=</a>
144
+
145
+ <li><a href="#method-i-plugin_namespace">#plugin_namespace</a>
146
+
147
+ <li><a href="#method-i-plugin_parent">#plugin_parent</a>
148
+
149
+ <li><a href="#method-i-plugin_parent-3D">#plugin_parent=</a>
150
+
151
+ <li><a href="#method-i-plugin_provider">#plugin_provider</a>
152
+
153
+ <li><a href="#method-i-plugin_type">#plugin_type</a>
154
+
155
+ <li><a href="#method-i-quiet-3D">#quiet=</a>
156
+
157
+ <li><a href="#method-i-quiet-3F">#quiet?</a>
158
+
159
+ <li><a href="#method-i-remove_plugin">#remove_plugin</a>
160
+
161
+ <li><a href="#method-i-render">#render</a>
162
+
163
+ <li><a href="#method-i-render_options">#render_options</a>
164
+
165
+ <li><a href="#method-i-safe_exec">#safe_exec</a>
166
+
167
+ <li><a href="#method-i-set_meta">#set_meta</a>
168
+
169
+ <li><a href="#method-i-status">#status</a>
170
+
171
+ <li><a href="#method-i-status-3D">#status=</a>
172
+
173
+ <li><a href="#method-i-success">#success</a>
174
+
175
+ <li><a href="#method-i-warn">#warn</a>
176
+
177
+ </ul>
178
+ </nav>
179
+
180
+ </div>
181
+
182
+ <div id="project-metadata">
183
+ <nav id="fileindex-section" class="section project-section">
184
+ <h3 class="section-header">Pages</h3>
185
+
186
+ <ul>
187
+
188
+ <li class="file"><a href="../../ARCHITECTURE_rdoc.html">ARCHITECTURE</a>
189
+
190
+ <li class="file"><a href="../../README_rdoc.html">README</a>
191
+
192
+ <li class="file"><a href="../../TODO_rdoc.html">TODO</a>
193
+
194
+ </ul>
195
+ </nav>
196
+
197
+ <nav id="classindex-section" class="section project-section">
198
+ <h3 class="section-header">Class and Module Index</h3>
199
+
200
+ <ul class="link-list">
201
+
202
+ <li><a href="../../Nucleon.html">Nucleon</a>
203
+
204
+ <li><a href="../../Nucleon/Action.html">Nucleon::Action</a>
205
+
206
+ <li><a href="../../Nucleon/Action/Add.html">Nucleon::Action::Add</a>
207
+
208
+ <li><a href="../../Nucleon/Action/Create.html">Nucleon::Action::Create</a>
209
+
210
+ <li><a href="../../Nucleon/Action/Extract.html">Nucleon::Action::Extract</a>
211
+
212
+ <li><a href="../../Nucleon/Action/Remove.html">Nucleon::Action::Remove</a>
213
+
214
+ <li><a href="../../Nucleon/Action/Save.html">Nucleon::Action::Save</a>
215
+
216
+ <li><a href="../../Nucleon/Action/Update.html">Nucleon::Action::Update</a>
217
+
218
+ <li><a href="../../Nucleon/Codes.html">Nucleon::Codes</a>
219
+
220
+ <li><a href="../../Nucleon/Command.html">Nucleon::Command</a>
221
+
222
+ <li><a href="../../Nucleon/Command/Bash.html">Nucleon::Command::Bash</a>
223
+
224
+ <li><a href="../../Nucleon/Config.html">Nucleon::Config</a>
225
+
226
+ <li><a href="../../Nucleon/Config/Collection.html">Nucleon::Config::Collection</a>
227
+
228
+ <li><a href="../../Nucleon/Config/Options.html">Nucleon::Config::Options</a>
229
+
230
+ <li><a href="../../Nucleon/Core.html">Nucleon::Core</a>
231
+
232
+ <li><a href="../../Nucleon/Errors.html">Nucleon::Errors</a>
233
+
234
+ <li><a href="../../Nucleon/Errors/BatchError.html">Nucleon::Errors::BatchError</a>
235
+
236
+ <li><a href="../../Nucleon/Errors/NucleonError.html">Nucleon::Errors::NucleonError</a>
237
+
238
+ <li><a href="../../Nucleon/Errors/SSHUnavailable.html">Nucleon::Errors::SSHUnavailable</a>
239
+
240
+ <li><a href="../../Nucleon/Event.html">Nucleon::Event</a>
241
+
242
+ <li><a href="../../Nucleon/Event/Regex.html">Nucleon::Event::Regex</a>
243
+
244
+ <li><a href="../../Nucleon/Facade.html">Nucleon::Facade</a>
245
+
246
+ <li><a href="../../Nucleon/Gems.html">Nucleon::Gems</a>
247
+
248
+ <li><a href="../../Nucleon/Manager.html">Nucleon::Manager</a>
249
+
250
+ <li><a href="../../Nucleon/Mixin.html">Nucleon::Mixin</a>
251
+
252
+ <li><a href="../../Nucleon/Mixin/Action.html">Nucleon::Mixin::Action</a>
253
+
254
+ <li><a href="../../Nucleon/Mixin/Action/Commit.html">Nucleon::Mixin::Action::Commit</a>
255
+
256
+ <li><a href="../../Nucleon/Mixin/Action/Project.html">Nucleon::Mixin::Action::Project</a>
257
+
258
+ <li><a href="../../Nucleon/Mixin/Action/Push.html">Nucleon::Mixin::Action::Push</a>
259
+
260
+ <li><a href="../../Nucleon/Mixin/Colors.html">Nucleon::Mixin::Colors</a>
261
+
262
+ <li><a href="../../Nucleon/Mixin/ConfigCollection.html">Nucleon::Mixin::ConfigCollection</a>
263
+
264
+ <li><a href="../../Nucleon/Mixin/ConfigOptions.html">Nucleon::Mixin::ConfigOptions</a>
265
+
266
+ <li><a href="../../Nucleon/Mixin/Macro.html">Nucleon::Mixin::Macro</a>
267
+
268
+ <li><a href="../../Nucleon/Mixin/Macro/ObjectInterface.html">Nucleon::Mixin::Macro::ObjectInterface</a>
269
+
270
+ <li><a href="../../Nucleon/Mixin/Macro/PluginInterface.html">Nucleon::Mixin::Macro::PluginInterface</a>
271
+
272
+ <li><a href="../../Nucleon/Mixin/Settings.html">Nucleon::Mixin::Settings</a>
273
+
274
+ <li><a href="../../Nucleon/Mixin/SubConfig.html">Nucleon::Mixin::SubConfig</a>
275
+
276
+ <li><a href="../../Nucleon/Parallel.html">Nucleon::Parallel</a>
277
+
278
+ <li><a href="../../Nucleon/Parallel/ClassMethods.html">Nucleon::Parallel::ClassMethods</a>
279
+
280
+ <li><a href="../../Nucleon/Parallel/InstanceMethods.html">Nucleon::Parallel::InstanceMethods</a>
281
+
282
+ <li><a href="../../Nucleon/Plugin.html">Nucleon::Plugin</a>
283
+
284
+ <li><a href="../../Nucleon/Plugin/Action.html">Nucleon::Plugin::Action</a>
285
+
286
+ <li><a href="../../Nucleon/Plugin/Action/Option.html">Nucleon::Plugin::Action::Option</a>
287
+
288
+ <li><a href="../../Nucleon/Plugin/Base.html">Nucleon::Plugin::Base</a>
289
+
290
+ <li><a href="../../Nucleon/Plugin/Command.html">Nucleon::Plugin::Command</a>
291
+
292
+ <li><a href="../../Nucleon/Plugin/Event.html">Nucleon::Plugin::Event</a>
293
+
294
+ <li><a href="../../Nucleon/Plugin/Extension.html">Nucleon::Plugin::Extension</a>
295
+
296
+ <li><a href="../../Nucleon/Plugin/Project.html">Nucleon::Plugin::Project</a>
297
+
298
+ <li><a href="../../Nucleon/Plugin/Template.html">Nucleon::Plugin::Template</a>
299
+
300
+ <li><a href="../../Nucleon/Plugin/Translator.html">Nucleon::Plugin::Translator</a>
301
+
302
+ <li><a href="../../Nucleon/Project.html">Nucleon::Project</a>
303
+
304
+ <li><a href="../../Nucleon/Project/Git.html">Nucleon::Project::Git</a>
305
+
306
+ <li><a href="../../Nucleon/Project/Github.html">Nucleon::Project::Github</a>
307
+
308
+ <li><a href="../../Nucleon/Template.html">Nucleon::Template</a>
309
+
310
+ <li><a href="../../Nucleon/Template/Json.html">Nucleon::Template::Json</a>
311
+
312
+ <li><a href="../../Nucleon/Template/Wrapper.html">Nucleon::Template::Wrapper</a>
313
+
314
+ <li><a href="../../Nucleon/Template/Yaml.html">Nucleon::Template::Yaml</a>
315
+
316
+ <li><a href="../../Nucleon/Translator.html">Nucleon::Translator</a>
317
+
318
+ <li><a href="../../Nucleon/Translator/Json.html">Nucleon::Translator::Json</a>
319
+
320
+ <li><a href="../../Nucleon/Translator/Yaml.html">Nucleon::Translator::Yaml</a>
321
+
322
+ <li><a href="../../Nucleon/Util.html">Nucleon::Util</a>
323
+
324
+ <li><a href="../../Nucleon/Util/CLI.html">Nucleon::Util::CLI</a>
325
+
326
+ <li><a href="../../Nucleon/Util/CLI/Parser.html">Nucleon::Util::CLI::Parser</a>
327
+
328
+ <li><a href="../../Nucleon/Util/Cache.html">Nucleon::Util::Cache</a>
329
+
330
+ <li><a href="../../Nucleon/Util/Console.html">Nucleon::Util::Console</a>
331
+
332
+ <li><a href="../../Nucleon/Util/Data.html">Nucleon::Util::Data</a>
333
+
334
+ <li><a href="../../Nucleon/Util/Disk.html">Nucleon::Util::Disk</a>
335
+
336
+ <li><a href="../../Nucleon/Util/Git.html">Nucleon::Util::Git</a>
337
+
338
+ <li><a href="../../Nucleon/Util/Liquid.html">Nucleon::Util::Liquid</a>
339
+
340
+ <li><a href="../../Nucleon/Util/Logger.html">Nucleon::Util::Logger</a>
341
+
342
+ <li><a href="../../Nucleon/Util/Package.html">Nucleon::Util::Package</a>
343
+
344
+ <li><a href="../../Nucleon/Util/SSH.html">Nucleon::Util::SSH</a>
345
+
346
+ <li><a href="../../Nucleon/Util/SSH/Keypair.html">Nucleon::Util::SSH::Keypair</a>
347
+
348
+ <li><a href="../../Nucleon/Util/Shell.html">Nucleon::Util::Shell</a>
349
+
350
+ <li><a href="../../Nucleon/Util/Shell/Result.html">Nucleon::Util::Shell::Result</a>
351
+
352
+ <li><a href="../../Hash.html">Hash</a>
353
+
354
+ <li><a href="../../Kernel.html">Kernel</a>
355
+
356
+ </ul>
357
+ </nav>
358
+
359
+ </div>
360
+ </nav>
361
+
362
+ <div id="documentation">
363
+ <h1 class="class">class Nucleon::Plugin::Base</h1>
364
+
365
+ <div id="description" class="description">
366
+
367
+ </div><!-- description -->
368
+
369
+
370
+
371
+
372
+ <section id="5Buntitled-5D" class="documentation-section">
373
+
374
+
375
+
376
+
377
+
378
+
379
+
380
+
381
+ <!-- Methods -->
382
+
383
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
384
+ <h3 class="section-header">Public Class Methods</h3>
385
+
386
+
387
+ <div id="method-c-build_info" class="method-detail ">
388
+
389
+ <div class="method-heading">
390
+ <span class="method-name">build_info</span><span
391
+ class="method-args">(type, data)</span>
392
+ <span class="method-click-advice">click to toggle source</span>
393
+ </div>
394
+
395
+
396
+ <div class="method-description">
397
+
398
+
399
+
400
+
401
+
402
+ <div class="method-source-code" id="build_info-source">
403
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 241</span>
404
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">build_info</span>(<span class="ruby-identifier">type</span>, <span class="ruby-identifier">data</span>)
405
+ <span class="ruby-identifier">plugins</span> = []
406
+
407
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>)
408
+ <span class="ruby-identifier">data</span> = [ <span class="ruby-identifier">data</span> ]
409
+ <span class="ruby-keyword">end</span>
410
+
411
+ <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">&quot;Building plugin list of #{type} from data: #{data.inspect}&quot;</span>)
412
+
413
+ <span class="ruby-keyword">if</span> <span class="ruby-identifier">data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Array</span>)
414
+ <span class="ruby-identifier">data</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">info</span><span class="ruby-operator">|</span>
415
+ <span class="ruby-keyword">unless</span> <span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">empty?</span>(<span class="ruby-identifier">info</span>)
416
+ <span class="ruby-identifier">info</span> = <span class="ruby-identifier">translate</span>(<span class="ruby-identifier">info</span>)
417
+
418
+ <span class="ruby-keyword">if</span> <span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">empty?</span>(<span class="ruby-identifier">info</span>[<span class="ruby-value">:provider</span>])
419
+ <span class="ruby-identifier">info</span>[<span class="ruby-value">:provider</span>] = <span class="ruby-constant">Nucleon</span>.<span class="ruby-identifier">type_default</span>(<span class="ruby-identifier">type</span>)
420
+ <span class="ruby-keyword">end</span>
421
+
422
+ <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">&quot;Translated plugin info: #{info.inspect}&quot;</span>)
423
+
424
+ <span class="ruby-identifier">plugins</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">info</span>
425
+ <span class="ruby-keyword">end</span>
426
+ <span class="ruby-keyword">end</span>
427
+ <span class="ruby-keyword">end</span>
428
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">plugins</span>
429
+ <span class="ruby-keyword">end</span></pre>
430
+ </div><!-- build_info-source -->
431
+
432
+ </div>
433
+
434
+
435
+
436
+
437
+ </div><!-- build_info-method -->
438
+
439
+
440
+ <div id="method-c-init_plugin_collection" class="method-detail ">
441
+
442
+ <div class="method-heading">
443
+ <span class="method-name">init_plugin_collection</span><span
444
+ class="method-args">(*external_block_methods)</span>
445
+ <span class="method-click-advice">click to toggle source</span>
446
+ </div>
447
+
448
+
449
+ <div class="method-description">
450
+
451
+
452
+
453
+
454
+
455
+ <div class="method-source-code" id="init_plugin_collection-source">
456
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 277</span>
457
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">init_plugin_collection</span>(*<span class="ruby-identifier">external_block_methods</span>)
458
+ <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">&quot;Initializing plugin collection interface at #{Time.now}&quot;</span>)
459
+
460
+ <span class="ruby-identifier">include</span> <span class="ruby-constant">Parallel</span>
461
+ <span class="ruby-identifier">external_block_exec</span>(*<span class="ruby-identifier">external_block_methods</span>)
462
+
463
+ <span class="ruby-identifier">include</span> <span class="ruby-constant">Mixin</span><span class="ruby-operator">::</span><span class="ruby-constant">Settings</span>
464
+ <span class="ruby-identifier">include</span> <span class="ruby-constant">Mixin</span><span class="ruby-operator">::</span><span class="ruby-constant">SubConfig</span>
465
+
466
+ <span class="ruby-identifier">extend</span> <span class="ruby-constant">Mixin</span><span class="ruby-operator">::</span><span class="ruby-constant">Macro</span><span class="ruby-operator">::</span><span class="ruby-constant">PluginInterface</span>
467
+ <span class="ruby-keyword">end</span></pre>
468
+ </div><!-- init_plugin_collection-source -->
469
+
470
+ </div>
471
+
472
+
473
+
474
+
475
+ </div><!-- init_plugin_collection-method -->
476
+
477
+
478
+ <div id="method-c-new" class="method-detail ">
479
+
480
+ <div class="method-heading">
481
+ <span class="method-name">new</span><span
482
+ class="method-args">(type, provider, options)</span>
483
+ <span class="method-click-advice">click to toggle source</span>
484
+ </div>
485
+
486
+
487
+ <div class="method-description">
488
+
489
+ <p>All <a href="../Plugin.html">Plugin</a> classes should directly or
490
+ indirectly extend <a href="Base.html">Base</a></p>
491
+
492
+
493
+
494
+ <div class="method-source-code" id="new-source">
495
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 8</span>
496
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">type</span>, <span class="ruby-identifier">provider</span>, <span class="ruby-identifier">options</span>)
497
+ <span class="ruby-identifier">config</span> = <span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">clean</span>(<span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">options</span>), <span class="ruby-keyword">false</span>)
498
+ <span class="ruby-identifier">name</span> = <span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">ensure_value</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:plugin_name</span>), <span class="ruby-identifier">config</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:name</span>, <span class="ruby-identifier">provider</span>))
499
+
500
+ <span class="ruby-ivar">@quiet</span> = <span class="ruby-identifier">config</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:quiet</span>, <span class="ruby-keyword">false</span>)
501
+
502
+ <span class="ruby-identifier">set_meta</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:meta</span>, <span class="ruby-constant">Config</span>.<span class="ruby-identifier">new</span>))
503
+
504
+ <span class="ruby-comment"># No logging statements aove this line!!</span>
505
+ <span class="ruby-keyword">super</span>(<span class="ruby-identifier">config</span>.<span class="ruby-identifier">import</span>({ <span class="ruby-value">:logger</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-node">&quot;#{plugin_type}-&gt;#{plugin_provider}&quot;</span> }), {}, <span class="ruby-keyword">true</span>, <span class="ruby-keyword">false</span>)
506
+ <span class="ruby-identifier">myself</span>.<span class="ruby-identifier">plugin_name</span> = <span class="ruby-identifier">name</span>
507
+
508
+ <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">&quot;Normalizing #{plugin_type} plugin #{plugin_name} with meta data: #{meta.inspect}&quot;</span>)
509
+ <span class="ruby-identifier">normalize</span>(<span class="ruby-keyword">false</span>)
510
+
511
+ <span class="ruby-ivar">@initialized</span> = <span class="ruby-keyword">true</span>
512
+ <span class="ruby-keyword">end</span></pre>
513
+ </div><!-- new-source -->
514
+
515
+ </div>
516
+
517
+
518
+
519
+
520
+ </div><!-- new-method -->
521
+
522
+
523
+ <div id="method-c-translate" class="method-detail ">
524
+
525
+ <div class="method-heading">
526
+ <span class="method-name">translate</span><span
527
+ class="method-args">(data)</span>
528
+ <span class="method-click-advice">click to toggle source</span>
529
+ </div>
530
+
531
+
532
+ <div class="method-description">
533
+
534
+
535
+
536
+
537
+
538
+ <div class="method-source-code" id="translate-source">
539
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 270</span>
540
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">translate</span>(<span class="ruby-identifier">data</span>)
541
+ <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">debug</span>(<span class="ruby-node">&quot;Translating data to internal plugin structure: #{data.inspect}&quot;</span>)
542
+ <span class="ruby-keyword">return</span> ( <span class="ruby-identifier">data</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Hash</span>) <span class="ruby-operator">?</span> <span class="ruby-identifier">symbol_map</span>(<span class="ruby-identifier">data</span>) <span class="ruby-operator">:</span> <span class="ruby-identifier">data</span> )
543
+ <span class="ruby-keyword">end</span></pre>
544
+ </div><!-- translate-source -->
545
+
546
+ </div>
547
+
548
+
549
+
550
+
551
+ </div><!-- translate-method -->
552
+
553
+
554
+ </section><!-- public-class-method-details -->
555
+
556
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
557
+ <h3 class="section-header">Public Instance Methods</h3>
558
+
559
+
560
+ <div id="method-i-admin_exec" class="method-detail ">
561
+
562
+ <div class="method-heading">
563
+ <span class="method-name">admin_exec</span><span
564
+ class="method-args">(return_result = true, &block)</span>
565
+ <span class="method-click-advice">click to toggle source</span>
566
+ </div>
567
+
568
+
569
+ <div class="method-description">
570
+
571
+
572
+
573
+
574
+
575
+ <div class="method-source-code" id="admin_exec-source">
576
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 308</span>
577
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">admin_exec</span>(<span class="ruby-identifier">return_result</span> = <span class="ruby-keyword">true</span>, &amp;<span class="ruby-identifier">block</span>)
578
+ <span class="ruby-keyword">if</span> <span class="ruby-constant">Nucleon</span>.<span class="ruby-identifier">admin?</span>
579
+ <span class="ruby-identifier">safe_exec</span>(<span class="ruby-identifier">return_result</span>, &amp;<span class="ruby-identifier">block</span>)
580
+ <span class="ruby-keyword">else</span>
581
+ <span class="ruby-identifier">ui</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-node">&quot;The #{plugin_provider} action must be run as a machine administrator&quot;</span>)
582
+ <span class="ruby-identifier">myself</span>.<span class="ruby-identifier">status</span> = <span class="ruby-identifier">code</span>.<span class="ruby-identifier">access_denied</span>
583
+ <span class="ruby-keyword">end</span>
584
+ <span class="ruby-keyword">end</span></pre>
585
+ </div><!-- admin_exec-source -->
586
+
587
+ </div>
588
+
589
+
590
+
591
+
592
+ </div><!-- admin_exec-method -->
593
+
594
+
595
+ <div id="method-i-alert" class="method-detail ">
596
+
597
+ <div class="method-heading">
598
+ <span class="method-name">alert</span><span
599
+ class="method-args">(display, options = {})</span>
600
+ <span class="method-click-advice">click to toggle source</span>
601
+ </div>
602
+
603
+
604
+ <div class="method-description">
605
+
606
+
607
+
608
+
609
+
610
+ <div class="method-source-code" id="alert-source">
611
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 216</span>
612
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">alert</span>(<span class="ruby-identifier">display</span>, <span class="ruby-identifier">options</span> = {})
613
+ <span class="ruby-identifier">ui</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-identifier">display</span>.<span class="ruby-identifier">strip</span>, <span class="ruby-identifier">options</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">quiet?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">display</span>.<span class="ruby-identifier">strip</span>.<span class="ruby-identifier">empty?</span>
614
+ <span class="ruby-keyword">end</span></pre>
615
+ </div><!-- alert-source -->
616
+
617
+ </div>
618
+
619
+
620
+
621
+
622
+ </div><!-- alert-method -->
623
+
624
+
625
+ <div id="method-i-code" class="method-detail ">
626
+
627
+ <div class="method-heading">
628
+ <span class="method-name">code</span><span
629
+ class="method-args">()</span>
630
+ <span class="method-click-advice">click to toggle source</span>
631
+ </div>
632
+
633
+
634
+ <div class="method-description">
635
+
636
+
637
+
638
+
639
+
640
+ <div class="method-source-code" id="code-source">
641
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 130</span>
642
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">code</span>
643
+ <span class="ruby-constant">CORL</span>.<span class="ruby-identifier">code</span>
644
+ <span class="ruby-keyword">end</span></pre>
645
+ </div><!-- code-source -->
646
+
647
+ </div>
648
+
649
+
650
+
651
+
652
+ </div><!-- code-method -->
653
+
654
+
655
+ <div id="method-i-codes" class="method-detail ">
656
+
657
+ <div class="method-heading">
658
+ <span class="method-name">codes</span><span
659
+ class="method-args">(*codes)</span>
660
+ <span class="method-click-advice">click to toggle source</span>
661
+ </div>
662
+
663
+
664
+ <div class="method-description">
665
+
666
+
667
+
668
+
669
+
670
+ <div class="method-source-code" id="codes-source">
671
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 134</span>
672
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">codes</span>(*<span class="ruby-identifier">codes</span>)
673
+ <span class="ruby-constant">CORL</span>.<span class="ruby-identifier">codes</span>(*<span class="ruby-identifier">codes</span>)
674
+ <span class="ruby-keyword">end</span></pre>
675
+ </div><!-- codes-source -->
676
+
677
+ </div>
678
+
679
+
680
+
681
+
682
+ </div><!-- codes-method -->
683
+
684
+
685
+ <div id="method-i-error" class="method-detail ">
686
+
687
+ <div class="method-heading">
688
+ <span class="method-name">error</span><span
689
+ class="method-args">(name, options = {})</span>
690
+ <span class="method-click-advice">click to toggle source</span>
691
+ </div>
692
+
693
+
694
+ <div class="method-description">
695
+
696
+
697
+
698
+
699
+
700
+ <div class="method-source-code" id="error-source">
701
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 228</span>
702
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">error</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span> = {})
703
+ <span class="ruby-identifier">ui</span>.<span class="ruby-identifier">error</span>(<span class="ruby-constant">I18n</span>.<span class="ruby-identifier">t</span>(<span class="ruby-identifier">name</span>, <span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">merge</span>([ <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">render_options</span>).<span class="ruby-identifier">export</span>, <span class="ruby-identifier">options</span> ], <span class="ruby-keyword">true</span>))) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">quiet?</span>
704
+ <span class="ruby-keyword">end</span></pre>
705
+ </div><!-- error-source -->
706
+
707
+ </div>
708
+
709
+
710
+
711
+
712
+ </div><!-- error-method -->
713
+
714
+
715
+ <div id="method-i-extended_config" class="method-detail ">
716
+
717
+ <div class="method-heading">
718
+ <span class="method-name">extended_config</span><span
719
+ class="method-args">(type, options = {})</span>
720
+ <span class="method-click-advice">click to toggle source</span>
721
+ </div>
722
+
723
+
724
+ <div class="method-description">
725
+
726
+
727
+
728
+
729
+
730
+ <div class="method-source-code" id="extended_config-source">
731
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 170</span>
732
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">extended_config</span>(<span class="ruby-identifier">type</span>, <span class="ruby-identifier">options</span> = {})
733
+ <span class="ruby-identifier">config</span> = <span class="ruby-constant">Nucleon</span>.<span class="ruby-identifier">config</span>(<span class="ruby-identifier">type</span>, <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">options</span>).<span class="ruby-identifier">import</span>({ <span class="ruby-value">:plugin</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">myself</span> }))
734
+ <span class="ruby-identifier">config</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:plugin</span>)
735
+ <span class="ruby-identifier">config</span>
736
+ <span class="ruby-keyword">end</span></pre>
737
+ </div><!-- extended_config-source -->
738
+
739
+ </div>
740
+
741
+
742
+
743
+
744
+ </div><!-- extended_config-method -->
745
+
746
+
747
+ <div id="method-i-extension" class="method-detail ">
748
+
749
+ <div class="method-heading">
750
+ <span class="method-name">extension</span><span
751
+ class="method-args">(hook, options = {}, &code)</span>
752
+ <span class="method-click-advice">click to toggle source</span>
753
+ </div>
754
+
755
+
756
+ <div class="method-description">
757
+
758
+
759
+
760
+
761
+
762
+ <div class="method-source-code" id="extension-source">
763
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 164</span>
764
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">extension</span>(<span class="ruby-identifier">hook</span>, <span class="ruby-identifier">options</span> = {}, &amp;<span class="ruby-identifier">code</span>)
765
+ <span class="ruby-constant">Nucleon</span>.<span class="ruby-identifier">exec</span>(<span class="ruby-identifier">hook_method</span>(<span class="ruby-identifier">hook</span>), <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">options</span>).<span class="ruby-identifier">import</span>({ <span class="ruby-value">:plugin</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">myself</span> }), &amp;<span class="ruby-identifier">code</span>)
766
+ <span class="ruby-keyword">end</span></pre>
767
+ </div><!-- extension-source -->
768
+
769
+ </div>
770
+
771
+
772
+
773
+
774
+ </div><!-- extension-method -->
775
+
776
+
777
+ <div id="method-i-extension_check" class="method-detail ">
778
+
779
+ <div class="method-heading">
780
+ <span class="method-name">extension_check</span><span
781
+ class="method-args">(hook, options = {})</span>
782
+ <span class="method-click-advice">click to toggle source</span>
783
+ </div>
784
+
785
+
786
+ <div class="method-description">
787
+
788
+
789
+
790
+
791
+
792
+ <div class="method-source-code" id="extension_check-source">
793
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 178</span>
794
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">extension_check</span>(<span class="ruby-identifier">hook</span>, <span class="ruby-identifier">options</span> = {})
795
+ <span class="ruby-constant">Nucleon</span>.<span class="ruby-identifier">check</span>(<span class="ruby-identifier">hook_method</span>(<span class="ruby-identifier">hook</span>), <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">options</span>).<span class="ruby-identifier">import</span>({ <span class="ruby-value">:plugin</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">myself</span> }))
796
+ <span class="ruby-keyword">end</span></pre>
797
+ </div><!-- extension_check-source -->
798
+
799
+ </div>
800
+
801
+
802
+
803
+
804
+ </div><!-- extension_check-method -->
805
+
806
+
807
+ <div id="method-i-extension_collect" class="method-detail ">
808
+
809
+ <div class="method-heading">
810
+ <span class="method-name">extension_collect</span><span
811
+ class="method-args">(hook, options = {})</span>
812
+ <span class="method-click-advice">click to toggle source</span>
813
+ </div>
814
+
815
+
816
+ <div class="method-description">
817
+
818
+
819
+
820
+
821
+
822
+ <div class="method-source-code" id="extension_collect-source">
823
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 190</span>
824
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">extension_collect</span>(<span class="ruby-identifier">hook</span>, <span class="ruby-identifier">options</span> = {})
825
+ <span class="ruby-constant">Nucleon</span>.<span class="ruby-identifier">collect</span>(<span class="ruby-identifier">hook_method</span>(<span class="ruby-identifier">hook</span>), <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">options</span>).<span class="ruby-identifier">import</span>({ <span class="ruby-value">:plugin</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">myself</span> }))
826
+ <span class="ruby-keyword">end</span></pre>
827
+ </div><!-- extension_collect-source -->
828
+
829
+ </div>
830
+
831
+
832
+
833
+
834
+ </div><!-- extension_collect-method -->
835
+
836
+
837
+ <div id="method-i-extension_set" class="method-detail ">
838
+
839
+ <div class="method-heading">
840
+ <span class="method-name">extension_set</span><span
841
+ class="method-args">(hook, value, options = {})</span>
842
+ <span class="method-click-advice">click to toggle source</span>
843
+ </div>
844
+
845
+
846
+ <div class="method-description">
847
+
848
+
849
+
850
+
851
+
852
+ <div class="method-source-code" id="extension_set-source">
853
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 184</span>
854
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">extension_set</span>(<span class="ruby-identifier">hook</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">options</span> = {})
855
+ <span class="ruby-constant">Nucleon</span>.<span class="ruby-identifier">value</span>(<span class="ruby-identifier">hook_method</span>(<span class="ruby-identifier">hook</span>), <span class="ruby-identifier">value</span>, <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">options</span>).<span class="ruby-identifier">import</span>({ <span class="ruby-value">:plugin</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">myself</span> }))
856
+ <span class="ruby-keyword">end</span></pre>
857
+ </div><!-- extension_set-source -->
858
+
859
+ </div>
860
+
861
+
862
+
863
+
864
+ </div><!-- extension_set-method -->
865
+
866
+
867
+ <div id="method-i-hook_method" class="method-detail ">
868
+
869
+ <div class="method-heading">
870
+ <span class="method-name">hook_method</span><span
871
+ class="method-args">(hook)</span>
872
+ <span class="method-click-advice">click to toggle source</span>
873
+ </div>
874
+
875
+
876
+ <div class="method-description">
877
+
878
+
879
+
880
+
881
+
882
+ <div class="method-source-code" id="hook_method-source">
883
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 158</span>
884
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">hook_method</span>(<span class="ruby-identifier">hook</span>)
885
+ <span class="ruby-node">&quot;#{plugin_type}_#{plugin_provider}_#{hook}&quot;</span>
886
+ <span class="ruby-keyword">end</span></pre>
887
+ </div><!-- hook_method-source -->
888
+
889
+ </div>
890
+
891
+
892
+
893
+
894
+ </div><!-- hook_method-method -->
895
+
896
+
897
+ <div id="method-i-info" class="method-detail ">
898
+
899
+ <div class="method-heading">
900
+ <span class="method-name">info</span><span
901
+ class="method-args">(name, options = {})</span>
902
+ <span class="method-click-advice">click to toggle source</span>
903
+ </div>
904
+
905
+
906
+ <div class="method-description">
907
+
908
+
909
+
910
+
911
+
912
+ <div class="method-source-code" id="info-source">
913
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 210</span>
914
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">info</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span> = {})
915
+ <span class="ruby-identifier">ui</span>.<span class="ruby-identifier">info</span>(<span class="ruby-constant">I18n</span>.<span class="ruby-identifier">t</span>(<span class="ruby-identifier">name</span>, <span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">merge</span>([ <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">render_options</span>).<span class="ruby-identifier">export</span>, <span class="ruby-identifier">options</span> ], <span class="ruby-keyword">true</span>))) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">quiet?</span>
916
+ <span class="ruby-keyword">end</span></pre>
917
+ </div><!-- info-source -->
918
+
919
+ </div>
920
+
921
+
922
+
923
+
924
+ </div><!-- info-method -->
925
+
926
+
927
+ <div id="method-i-me" class="method-detail method-alias">
928
+
929
+ <div class="method-heading">
930
+ <span class="method-name">me</span><span
931
+ class="method-args">()</span>
932
+ <span class="method-click-advice">click to toggle source</span>
933
+ </div>
934
+
935
+
936
+ <div class="method-description">
937
+
938
+
939
+
940
+
941
+
942
+ </div>
943
+
944
+
945
+
946
+
947
+ <div class="aliases">
948
+ Alias for: <a href="Base.html#method-i-myself">myself</a>
949
+ </div>
950
+
951
+ </div><!-- me-method -->
952
+
953
+
954
+ <div id="method-i-meta" class="method-detail ">
955
+
956
+ <div class="method-heading">
957
+ <span class="method-name">meta</span><span
958
+ class="method-args">()</span>
959
+ <span class="method-click-advice">click to toggle source</span>
960
+ </div>
961
+
962
+
963
+ <div class="method-description">
964
+
965
+
966
+
967
+
968
+
969
+ <div class="method-source-code" id="meta-source">
970
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 61</span>
971
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">meta</span>
972
+ <span class="ruby-keyword">return</span> <span class="ruby-ivar">@meta</span>
973
+ <span class="ruby-keyword">end</span></pre>
974
+ </div><!-- meta-source -->
975
+
976
+ </div>
977
+
978
+
979
+
980
+
981
+ </div><!-- meta-method -->
982
+
983
+
984
+ <div id="method-i-method_missing" class="method-detail ">
985
+
986
+ <div class="method-heading">
987
+ <span class="method-name">method_missing</span><span
988
+ class="method-args">(method, *args, &block)</span>
989
+ <span class="method-click-advice">click to toggle source</span>
990
+ </div>
991
+
992
+
993
+ <div class="method-description">
994
+
995
+
996
+
997
+
998
+
999
+ <div class="method-source-code" id="method_missing-source">
1000
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 28</span>
1001
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">method_missing</span>(<span class="ruby-identifier">method</span>, *<span class="ruby-identifier">args</span>, &amp;<span class="ruby-identifier">block</span>)
1002
+ <span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span>
1003
+ <span class="ruby-keyword">end</span></pre>
1004
+ </div><!-- method_missing-source -->
1005
+
1006
+ </div>
1007
+
1008
+
1009
+
1010
+
1011
+ </div><!-- method_missing-method -->
1012
+
1013
+
1014
+ <div id="method-i-myself" class="method-detail ">
1015
+
1016
+ <div class="method-heading">
1017
+ <span class="method-name">myself</span><span
1018
+ class="method-args">()</span>
1019
+ <span class="method-click-advice">click to toggle source</span>
1020
+ </div>
1021
+
1022
+
1023
+ <div class="method-description">
1024
+
1025
+
1026
+
1027
+
1028
+
1029
+ <div class="method-source-code" id="myself-source">
1030
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 48</span>
1031
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">myself</span>
1032
+ <span class="ruby-constant">Nucleon</span>.<span class="ruby-identifier">handle</span>(<span class="ruby-keyword">self</span>)
1033
+ <span class="ruby-keyword">end</span></pre>
1034
+ </div><!-- myself-source -->
1035
+
1036
+ </div>
1037
+
1038
+
1039
+ <div class="aliases">
1040
+ Also aliased as: <a href="Base.html#method-i-me">me</a>
1041
+ </div>
1042
+
1043
+
1044
+
1045
+ </div><!-- myself-method -->
1046
+
1047
+
1048
+ <div id="method-i-normalize" class="method-detail ">
1049
+
1050
+ <div class="method-heading">
1051
+ <span class="method-name">normalize</span><span
1052
+ class="method-args">(reload)</span>
1053
+ <span class="method-click-advice">click to toggle source</span>
1054
+ </div>
1055
+
1056
+
1057
+ <div class="method-description">
1058
+
1059
+
1060
+
1061
+
1062
+
1063
+ <div class="method-source-code" id="normalize-source">
1064
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 151</span>
1065
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">normalize</span>(<span class="ruby-identifier">reload</span>)
1066
+ <span class="ruby-comment"># Implement in sub classes</span>
1067
+ <span class="ruby-keyword">end</span></pre>
1068
+ </div><!-- normalize-source -->
1069
+
1070
+ </div>
1071
+
1072
+
1073
+
1074
+
1075
+ </div><!-- normalize-method -->
1076
+
1077
+
1078
+ <div id="method-i-plugin_directory" class="method-detail ">
1079
+
1080
+ <div class="method-heading">
1081
+ <span class="method-name">plugin_directory</span><span
1082
+ class="method-args">()</span>
1083
+ <span class="method-click-advice">click to toggle source</span>
1084
+ </div>
1085
+
1086
+
1087
+ <div class="method-description">
1088
+
1089
+
1090
+
1091
+
1092
+
1093
+ <div class="method-source-code" id="plugin_directory-source">
1094
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 101</span>
1095
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">plugin_directory</span>
1096
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">meta</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:directory</span>)
1097
+ <span class="ruby-keyword">end</span></pre>
1098
+ </div><!-- plugin_directory-source -->
1099
+
1100
+ </div>
1101
+
1102
+
1103
+
1104
+
1105
+ </div><!-- plugin_directory-method -->
1106
+
1107
+
1108
+ <div id="method-i-plugin_file" class="method-detail ">
1109
+
1110
+ <div class="method-heading">
1111
+ <span class="method-name">plugin_file</span><span
1112
+ class="method-args">()</span>
1113
+ <span class="method-click-advice">click to toggle source</span>
1114
+ </div>
1115
+
1116
+
1117
+ <div class="method-description">
1118
+
1119
+
1120
+
1121
+
1122
+
1123
+ <div class="method-source-code" id="plugin_file-source">
1124
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 107</span>
1125
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">plugin_file</span>
1126
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">meta</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:file</span>)
1127
+ <span class="ruby-keyword">end</span></pre>
1128
+ </div><!-- plugin_file-source -->
1129
+
1130
+ </div>
1131
+
1132
+
1133
+
1134
+
1135
+ </div><!-- plugin_file-method -->
1136
+
1137
+
1138
+ <div id="method-i-plugin_instance_name" class="method-detail ">
1139
+
1140
+ <div class="method-heading">
1141
+ <span class="method-name">plugin_instance_name</span><span
1142
+ class="method-args">()</span>
1143
+ <span class="method-click-advice">click to toggle source</span>
1144
+ </div>
1145
+
1146
+
1147
+ <div class="method-description">
1148
+
1149
+
1150
+
1151
+
1152
+
1153
+ <div class="method-source-code" id="plugin_instance_name-source">
1154
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 113</span>
1155
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">plugin_instance_name</span>
1156
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">meta</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:instance_name</span>)
1157
+ <span class="ruby-keyword">end</span></pre>
1158
+ </div><!-- plugin_instance_name-source -->
1159
+
1160
+ </div>
1161
+
1162
+
1163
+
1164
+
1165
+ </div><!-- plugin_instance_name-method -->
1166
+
1167
+
1168
+ <div id="method-i-plugin_name" class="method-detail ">
1169
+
1170
+ <div class="method-heading">
1171
+ <span class="method-name">plugin_name</span><span
1172
+ class="method-args">()</span>
1173
+ <span class="method-click-advice">click to toggle source</span>
1174
+ </div>
1175
+
1176
+
1177
+ <div class="method-description">
1178
+
1179
+
1180
+
1181
+
1182
+
1183
+ <div class="method-source-code" id="plugin_name-source">
1184
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 91</span>
1185
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">plugin_name</span>
1186
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">meta</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:name</span>)
1187
+ <span class="ruby-keyword">end</span></pre>
1188
+ </div><!-- plugin_name-source -->
1189
+
1190
+ </div>
1191
+
1192
+
1193
+
1194
+
1195
+ </div><!-- plugin_name-method -->
1196
+
1197
+
1198
+ <div id="method-i-plugin_name-3D" class="method-detail ">
1199
+
1200
+ <div class="method-heading">
1201
+ <span class="method-name">plugin_name=</span><span
1202
+ class="method-args">(plugin_name)</span>
1203
+ <span class="method-click-advice">click to toggle source</span>
1204
+ </div>
1205
+
1206
+
1207
+ <div class="method-description">
1208
+
1209
+
1210
+
1211
+
1212
+
1213
+ <div class="method-source-code" id="plugin_name-3D-source">
1214
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 95</span>
1215
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">plugin_name=</span><span class="ruby-identifier">plugin_name</span>
1216
+ <span class="ruby-identifier">meta</span>.<span class="ruby-identifier">set</span>(<span class="ruby-value">:name</span>, <span class="ruby-identifier">string</span>(<span class="ruby-identifier">plugin_name</span>))
1217
+ <span class="ruby-keyword">end</span></pre>
1218
+ </div><!-- plugin_name-3D-source -->
1219
+
1220
+ </div>
1221
+
1222
+
1223
+
1224
+
1225
+ </div><!-- plugin_name-3D-method -->
1226
+
1227
+
1228
+ <div id="method-i-plugin_namespace" class="method-detail ">
1229
+
1230
+ <div class="method-heading">
1231
+ <span class="method-name">plugin_namespace</span><span
1232
+ class="method-args">()</span>
1233
+ <span class="method-click-advice">click to toggle source</span>
1234
+ </div>
1235
+
1236
+
1237
+ <div class="method-description">
1238
+
1239
+
1240
+
1241
+
1242
+
1243
+ <div class="method-source-code" id="plugin_namespace-source">
1244
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 73</span>
1245
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">plugin_namespace</span>
1246
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">meta</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:namespace</span>)
1247
+ <span class="ruby-keyword">end</span></pre>
1248
+ </div><!-- plugin_namespace-source -->
1249
+
1250
+ </div>
1251
+
1252
+
1253
+
1254
+
1255
+ </div><!-- plugin_namespace-method -->
1256
+
1257
+
1258
+ <div id="method-i-plugin_parent" class="method-detail ">
1259
+
1260
+ <div class="method-heading">
1261
+ <span class="method-name">plugin_parent</span><span
1262
+ class="method-args">()</span>
1263
+ <span class="method-click-advice">click to toggle source</span>
1264
+ </div>
1265
+
1266
+
1267
+ <div class="method-description">
1268
+
1269
+
1270
+
1271
+
1272
+
1273
+ <div class="method-source-code" id="plugin_parent-source">
1274
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 123</span>
1275
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">plugin_parent</span>
1276
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">meta</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:parent</span>)
1277
+ <span class="ruby-keyword">end</span></pre>
1278
+ </div><!-- plugin_parent-source -->
1279
+
1280
+ </div>
1281
+
1282
+
1283
+
1284
+
1285
+ </div><!-- plugin_parent-method -->
1286
+
1287
+
1288
+ <div id="method-i-plugin_parent-3D" class="method-detail ">
1289
+
1290
+ <div class="method-heading">
1291
+ <span class="method-name">plugin_parent=</span><span
1292
+ class="method-args">(parent)</span>
1293
+ <span class="method-click-advice">click to toggle source</span>
1294
+ </div>
1295
+
1296
+
1297
+ <div class="method-description">
1298
+
1299
+
1300
+
1301
+
1302
+
1303
+ <div class="method-source-code" id="plugin_parent-3D-source">
1304
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 119</span>
1305
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">plugin_parent=</span><span class="ruby-identifier">parent</span>
1306
+ <span class="ruby-identifier">meta</span>.<span class="ruby-identifier">set</span>(<span class="ruby-value">:parent</span>, <span class="ruby-identifier">parent</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">parent</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Nucleon</span><span class="ruby-operator">::</span><span class="ruby-constant">Plugin</span><span class="ruby-operator">::</span><span class="ruby-constant">Base</span>)
1307
+ <span class="ruby-keyword">end</span></pre>
1308
+ </div><!-- plugin_parent-3D-source -->
1309
+
1310
+ </div>
1311
+
1312
+
1313
+
1314
+
1315
+ </div><!-- plugin_parent-3D-method -->
1316
+
1317
+
1318
+ <div id="method-i-plugin_provider" class="method-detail ">
1319
+
1320
+ <div class="method-heading">
1321
+ <span class="method-name">plugin_provider</span><span
1322
+ class="method-args">()</span>
1323
+ <span class="method-click-advice">click to toggle source</span>
1324
+ </div>
1325
+
1326
+
1327
+ <div class="method-description">
1328
+
1329
+
1330
+
1331
+
1332
+
1333
+ <div class="method-source-code" id="plugin_provider-source">
1334
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 85</span>
1335
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">plugin_provider</span>
1336
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">meta</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:provider</span>)
1337
+ <span class="ruby-keyword">end</span></pre>
1338
+ </div><!-- plugin_provider-source -->
1339
+
1340
+ </div>
1341
+
1342
+
1343
+
1344
+
1345
+ </div><!-- plugin_provider-method -->
1346
+
1347
+
1348
+ <div id="method-i-plugin_type" class="method-detail ">
1349
+
1350
+ <div class="method-heading">
1351
+ <span class="method-name">plugin_type</span><span
1352
+ class="method-args">()</span>
1353
+ <span class="method-click-advice">click to toggle source</span>
1354
+ </div>
1355
+
1356
+
1357
+ <div class="method-description">
1358
+
1359
+
1360
+
1361
+
1362
+
1363
+ <div class="method-source-code" id="plugin_type-source">
1364
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 79</span>
1365
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">plugin_type</span>
1366
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">meta</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:type</span>)
1367
+ <span class="ruby-keyword">end</span></pre>
1368
+ </div><!-- plugin_type-source -->
1369
+
1370
+ </div>
1371
+
1372
+
1373
+
1374
+
1375
+ </div><!-- plugin_type-method -->
1376
+
1377
+
1378
+ <div id="method-i-quiet-3D" class="method-detail ">
1379
+
1380
+ <div class="method-heading">
1381
+ <span class="method-name">quiet=</span><span
1382
+ class="method-args">(quiet)</span>
1383
+ <span class="method-click-advice">click to toggle source</span>
1384
+ </div>
1385
+
1386
+
1387
+ <div class="method-description">
1388
+
1389
+
1390
+
1391
+
1392
+
1393
+ <div class="method-source-code" id="quiet-3D-source">
1394
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 55</span>
1395
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">quiet=</span><span class="ruby-identifier">quiet</span>
1396
+ <span class="ruby-ivar">@quiet</span> = <span class="ruby-identifier">quiet</span>
1397
+ <span class="ruby-keyword">end</span></pre>
1398
+ </div><!-- quiet-3D-source -->
1399
+
1400
+ </div>
1401
+
1402
+
1403
+
1404
+
1405
+ </div><!-- quiet-3D-method -->
1406
+
1407
+
1408
+ <div id="method-i-quiet-3F" class="method-detail ">
1409
+
1410
+ <div class="method-heading">
1411
+ <span class="method-name">quiet?</span><span
1412
+ class="method-args">()</span>
1413
+ <span class="method-click-advice">click to toggle source</span>
1414
+ </div>
1415
+
1416
+
1417
+ <div class="method-description">
1418
+
1419
+
1420
+
1421
+
1422
+
1423
+ <div class="method-source-code" id="quiet-3F-source">
1424
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 41</span>
1425
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">quiet?</span>
1426
+ <span class="ruby-ivar">@quiet</span>
1427
+ <span class="ruby-keyword">end</span></pre>
1428
+ </div><!-- quiet-3F-source -->
1429
+
1430
+ </div>
1431
+
1432
+
1433
+
1434
+
1435
+ </div><!-- quiet-3F-method -->
1436
+
1437
+
1438
+ <div id="method-i-remove_plugin" class="method-detail ">
1439
+
1440
+ <div class="method-heading">
1441
+ <span class="method-name">remove_plugin</span><span
1442
+ class="method-args">()</span>
1443
+ <span class="method-click-advice">click to toggle source</span>
1444
+ </div>
1445
+
1446
+
1447
+ <div class="method-description">
1448
+
1449
+
1450
+
1451
+
1452
+
1453
+ <div class="method-source-code" id="remove_plugin-source">
1454
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 34</span>
1455
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">remove_plugin</span>
1456
+ <span class="ruby-comment"># Implement in sub classes if needed for cleanup</span>
1457
+ <span class="ruby-keyword">end</span></pre>
1458
+ </div><!-- remove_plugin-source -->
1459
+
1460
+ </div>
1461
+
1462
+
1463
+
1464
+
1465
+ </div><!-- remove_plugin-method -->
1466
+
1467
+
1468
+ <div id="method-i-render" class="method-detail ">
1469
+
1470
+ <div class="method-heading">
1471
+ <span class="method-name">render</span><span
1472
+ class="method-args">(display, options = {})</span>
1473
+ <span class="method-click-advice">click to toggle source</span>
1474
+ </div>
1475
+
1476
+
1477
+ <div class="method-description">
1478
+
1479
+
1480
+
1481
+
1482
+
1483
+ <div class="method-source-code" id="render-source">
1484
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 204</span>
1485
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">render</span>(<span class="ruby-identifier">display</span>, <span class="ruby-identifier">options</span> = {})
1486
+ <span class="ruby-identifier">ui</span>.<span class="ruby-identifier">info</span>(<span class="ruby-identifier">display</span>.<span class="ruby-identifier">strip</span>, <span class="ruby-identifier">options</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">quiet?</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">display</span>.<span class="ruby-identifier">strip</span>.<span class="ruby-identifier">empty?</span>
1487
+ <span class="ruby-keyword">end</span></pre>
1488
+ </div><!-- render-source -->
1489
+
1490
+ </div>
1491
+
1492
+
1493
+
1494
+
1495
+ </div><!-- render-method -->
1496
+
1497
+
1498
+ <div id="method-i-safe_exec" class="method-detail ">
1499
+
1500
+ <div class="method-heading">
1501
+ <span class="method-name">safe_exec</span><span
1502
+ class="method-args">(return_result = true, &code)</span>
1503
+ <span class="method-click-advice">click to toggle source</span>
1504
+ </div>
1505
+
1506
+
1507
+ <div class="method-description">
1508
+
1509
+
1510
+
1511
+
1512
+
1513
+ <div class="method-source-code" id="safe_exec-source">
1514
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 291</span>
1515
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">safe_exec</span>(<span class="ruby-identifier">return_result</span> = <span class="ruby-keyword">true</span>, &amp;<span class="ruby-identifier">code</span>)
1516
+ <span class="ruby-keyword">begin</span>
1517
+ <span class="ruby-identifier">result</span> = <span class="ruby-identifier">code</span>.<span class="ruby-identifier">call</span>
1518
+ <span class="ruby-keyword">return</span> <span class="ruby-identifier">result</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">return_result</span>
1519
+ <span class="ruby-keyword">return</span> <span class="ruby-keyword">true</span>
1520
+
1521
+ <span class="ruby-keyword">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">error</span>
1522
+ <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">error</span>.<span class="ruby-identifier">inspect</span>)
1523
+ <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">error</span>.<span class="ruby-identifier">message</span>)
1524
+
1525
+ <span class="ruby-identifier">ui</span>.<span class="ruby-identifier">error</span>(<span class="ruby-identifier">error</span>.<span class="ruby-identifier">message</span>, { <span class="ruby-value">:prefix</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-keyword">false</span> }) <span class="ruby-keyword">if</span> <span class="ruby-identifier">error</span>.<span class="ruby-identifier">message</span>
1526
+ <span class="ruby-keyword">end</span>
1527
+ <span class="ruby-keyword">return</span> <span class="ruby-keyword">false</span>
1528
+ <span class="ruby-keyword">end</span></pre>
1529
+ </div><!-- safe_exec-source -->
1530
+
1531
+ </div>
1532
+
1533
+
1534
+
1535
+
1536
+ </div><!-- safe_exec-method -->
1537
+
1538
+
1539
+ <div id="method-i-set_meta" class="method-detail ">
1540
+
1541
+ <div class="method-heading">
1542
+ <span class="method-name">set_meta</span><span
1543
+ class="method-args">(meta)</span>
1544
+ <span class="method-click-advice">click to toggle source</span>
1545
+ </div>
1546
+
1547
+
1548
+ <div class="method-description">
1549
+
1550
+
1551
+
1552
+
1553
+
1554
+ <div class="method-source-code" id="set_meta-source">
1555
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 67</span>
1556
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">set_meta</span>(<span class="ruby-identifier">meta</span>)
1557
+ <span class="ruby-ivar">@meta</span> = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">meta</span>)
1558
+ <span class="ruby-keyword">end</span></pre>
1559
+ </div><!-- set_meta-source -->
1560
+
1561
+ </div>
1562
+
1563
+
1564
+
1565
+
1566
+ </div><!-- set_meta-method -->
1567
+
1568
+
1569
+ <div id="method-i-status" class="method-detail ">
1570
+
1571
+ <div class="method-heading">
1572
+ <span class="method-name">status</span><span
1573
+ class="method-args">()</span>
1574
+ <span class="method-click-advice">click to toggle source</span>
1575
+ </div>
1576
+
1577
+
1578
+ <div class="method-description">
1579
+
1580
+
1581
+
1582
+
1583
+
1584
+ <div class="method-source-code" id="status-source">
1585
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 144</span>
1586
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">status</span>
1587
+ <span class="ruby-identifier">meta</span>.<span class="ruby-identifier">get</span>(<span class="ruby-value">:status</span>, <span class="ruby-identifier">code</span>.<span class="ruby-identifier">unknown_status</span>)
1588
+ <span class="ruby-keyword">end</span></pre>
1589
+ </div><!-- status-source -->
1590
+
1591
+ </div>
1592
+
1593
+
1594
+
1595
+
1596
+ </div><!-- status-method -->
1597
+
1598
+
1599
+ <div id="method-i-status-3D" class="method-detail ">
1600
+
1601
+ <div class="method-heading">
1602
+ <span class="method-name">status=</span><span
1603
+ class="method-args">(status)</span>
1604
+ <span class="method-click-advice">click to toggle source</span>
1605
+ </div>
1606
+
1607
+
1608
+ <div class="method-description">
1609
+
1610
+
1611
+
1612
+
1613
+
1614
+ <div class="method-source-code" id="status-3D-source">
1615
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 140</span>
1616
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">status=</span><span class="ruby-identifier">status</span>
1617
+ <span class="ruby-identifier">meta</span>.<span class="ruby-identifier">set</span>(<span class="ruby-value">:status</span>, <span class="ruby-identifier">status</span>)
1618
+ <span class="ruby-keyword">end</span></pre>
1619
+ </div><!-- status-3D-source -->
1620
+
1621
+ </div>
1622
+
1623
+
1624
+
1625
+
1626
+ </div><!-- status-3D-method -->
1627
+
1628
+
1629
+ <div id="method-i-success" class="method-detail ">
1630
+
1631
+ <div class="method-heading">
1632
+ <span class="method-name">success</span><span
1633
+ class="method-args">(name, options = {})</span>
1634
+ <span class="method-click-advice">click to toggle source</span>
1635
+ </div>
1636
+
1637
+
1638
+ <div class="method-description">
1639
+
1640
+
1641
+
1642
+
1643
+
1644
+ <div class="method-source-code" id="success-source">
1645
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 234</span>
1646
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">success</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span> = {})
1647
+ <span class="ruby-identifier">ui</span>.<span class="ruby-identifier">success</span>(<span class="ruby-constant">I18n</span>.<span class="ruby-identifier">t</span>(<span class="ruby-identifier">name</span>, <span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">merge</span>([ <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">render_options</span>).<span class="ruby-identifier">export</span>, <span class="ruby-identifier">options</span> ], <span class="ruby-keyword">true</span>))) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">quiet?</span>
1648
+ <span class="ruby-keyword">end</span></pre>
1649
+ </div><!-- success-source -->
1650
+
1651
+ </div>
1652
+
1653
+
1654
+
1655
+
1656
+ </div><!-- success-method -->
1657
+
1658
+
1659
+ <div id="method-i-warn" class="method-detail ">
1660
+
1661
+ <div class="method-heading">
1662
+ <span class="method-name">warn</span><span
1663
+ class="method-args">(name, options = {})</span>
1664
+ <span class="method-click-advice">click to toggle source</span>
1665
+ </div>
1666
+
1667
+
1668
+ <div class="method-description">
1669
+
1670
+
1671
+
1672
+
1673
+
1674
+ <div class="method-source-code" id="warn-source">
1675
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 222</span>
1676
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">warn</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">options</span> = {})
1677
+ <span class="ruby-identifier">ui</span>.<span class="ruby-identifier">warn</span>(<span class="ruby-constant">I18n</span>.<span class="ruby-identifier">t</span>(<span class="ruby-identifier">name</span>, <span class="ruby-constant">Util</span><span class="ruby-operator">::</span><span class="ruby-constant">Data</span>.<span class="ruby-identifier">merge</span>([ <span class="ruby-constant">Config</span>.<span class="ruby-identifier">ensure</span>(<span class="ruby-identifier">render_options</span>).<span class="ruby-identifier">export</span>, <span class="ruby-identifier">options</span> ], <span class="ruby-keyword">true</span>))) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">quiet?</span>
1678
+ <span class="ruby-keyword">end</span></pre>
1679
+ </div><!-- warn-source -->
1680
+
1681
+ </div>
1682
+
1683
+
1684
+
1685
+
1686
+ </div><!-- warn-method -->
1687
+
1688
+
1689
+ </section><!-- public-instance-method-details -->
1690
+
1691
+ <section id="protected-instance-5Buntitled-5D-method-details" class="method-section section">
1692
+ <h3 class="section-header">Protected Instance Methods</h3>
1693
+
1694
+
1695
+ <div id="method-i-render_options" class="method-detail ">
1696
+
1697
+ <div class="method-heading">
1698
+ <span class="method-name">render_options</span><span
1699
+ class="method-args">()</span>
1700
+ <span class="method-click-advice">click to toggle source</span>
1701
+ </div>
1702
+
1703
+
1704
+ <div class="method-description">
1705
+
1706
+
1707
+
1708
+
1709
+
1710
+ <div class="method-source-code" id="render_options-source">
1711
+ <pre><span class="ruby-comment"># File lib/core/plugin/base.rb, line 197</span>
1712
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">render_options</span>
1713
+ <span class="ruby-identifier">export</span>
1714
+ <span class="ruby-keyword">end</span></pre>
1715
+ </div><!-- render_options-source -->
1716
+
1717
+ </div>
1718
+
1719
+
1720
+
1721
+
1722
+ </div><!-- render_options-method -->
1723
+
1724
+
1725
+ </section><!-- protected-instance-method-details -->
1726
+
1727
+ </section><!-- 5Buntitled-5D -->
1728
+
1729
+ </div><!-- documentation -->
1730
+
1731
+
1732
+ <footer id="validator-badges">
1733
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
1734
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.2.
1735
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
1736
+ </footer>
1737
+