nucleon 0.2.0 → 0.2.1

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