doc/MCollective/Generators/Base.html

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   3         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5 <head>
   6         <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
   7
   8         <title>Class: MCollective::Generators::Base</title>
   9
  10         <link rel="stylesheet" href="../../rdoc.css" type="text/css" media="screen" />
  11
  12         <script src="../../js/jquery.js" type="text/javascript"
  13                 charset="utf-8"></script>
  14         <script src="../../js/thickbox-compressed.js" type="text/javascript"
  15                 charset="utf-8"></script>
  16         <script src="../../js/quicksearch.js" type="text/javascript"
  17                 charset="utf-8"></script>
  18         <script src="../../js/darkfish.js" type="text/javascript"
  19                 charset="utf-8"></script>
  20
  21 </head>
  22 <body class="class">
  23
  24         <div id="metadata">
  25                 <div id="file-metadata">
  26                         <div id="file-list-section" class="section">
  27                                 <h3 class="section-header">In Files</h3>
  28                                 <div class="section-body">
  29                                         <ul>
  30
  31                                                 <li><a href="../../lib/mcollective/generators/base_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
  32                                                         class="thickbox" title="lib/mcollective/generators/base.rb">lib/mcollective/generators/base.rb</a></li>
  33
  34                                         </ul>
  35                                 </div>
  36                         </div>
  37
  38
  39                 </div>
  40
  41                 <div id="class-metadata">
  42
  43                         <!-- Parent Class -->
  44
  45                         <div id="parent-class-section" class="section">
  46                                 <h3 class="section-header">Parent</h3>
  47
  48                                 <p class="link"><a href="../../Object.html">Object</a></p>
  49
  50                         </div>
  51
  52
  53                         <!-- Namespace Contents -->
  54
  55
  56                         <!-- Method Quickref -->
  57
  58                         <div id="method-list-section" class="section">
  59                                 <h3 class="section-header">Methods</h3>
  60                                 <ul class="link-list">
  61
  62                                         <li><a href="#M000238">::new</a></li>
  63
  64                                         <li><a href="#M000239">#create_metadata_string</a></li>
  65
  66                                         <li><a href="#M000240">#create_plugin_string</a></li>
  67
  68                                         <li><a href="#M000241">#write_plugins</a></li>
  69
  70                                 </ul>
  71                         </div>
  72
  73
  74                         <!-- Included Modules -->
  75
  76                 </div>
  77
  78                 <div id="project-metadata">
  79
  80
  81                         <div id="fileindex-section" class="section project-section">
  82                                 <h3 class="section-header">Files</h3>
  83                                 <ul>
  84
  85                                         <li class="file"><a href="../../COPYING.html">COPYING</a></li>
  86
  87                                         <li class="file"><a href="../../Gemfile.html">Gemfile</a></li>
  88
  89                                         <li class="file"><a href="../../README.html">README</a></li>
  90
  91                                         <li class="file"><a href="../../Rakefile.html">Rakefile</a></li>
  92
  93                                         <li class="file"><a href="../../etc/client_cfg_dist.html">client.cfg.dist</a></li>
  94
  95                                         <li class="file"><a href="../../etc/data-help_erb.html">data-help.erb</a></li>
  96
  97                                         <li class="file"><a href="../../etc/discovery-help_erb.html">discovery-help.erb</a></li>
  98
  99                                         <li class="file"><a href="../../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
 100
 101                                         <li class="file"><a href="../../etc/metadata-help_erb.html">metadata-help.erb</a></li>
 102
 103                                         <li class="file"><a href="../../etc/msg-help_erb.html">msg-help.erb</a></li>
 104
 105                                         <li class="file"><a href="../../etc/rpc-help_erb.html">rpc-help.erb</a></li>
 106
 107                                         <li class="file"><a href="../../etc/server_cfg_dist.html">server.cfg.dist</a></li>
 108
 109                                         <li class="file"><a href="../../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
 110
 111                                         <li class="file"><a href="../../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
 112
 113                                         <li class="file"><a href="../../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
 114
 115                                         <li class="file"><a href="../../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
 116
 117                                         <li class="file"><a href="../../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
 118
 119                                         <li class="file"><a href="../../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
 120
 121                                         <li class="file"><a href="../../lib/mcollective/locales/en_yml.html">en.yml</a></li>
 122
 123                                         <li class="file"><a href="../../mcollective_init.html">mcollective.init</a></li>
 124
 125                                 </ul>
 126                         </div>
 127
 128
 129                         <div id="classindex-section" class="section project-section">
 130                                 <h3 class="section-header">Class Index
 131                                         <span class="search-toggle"><img src="../../images/find.png"
 132                                                 height="16" width="16" alt="[+]"
 133                                                 title="show/hide quicksearch" /></span></h3>
 134                                 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
 135                                 <fieldset>
 136                                         <legend>Quicksearch</legend>
 137                                         <input type="text" name="quicksearch" value=""
 138                                                 class="quicksearch-field" />
 139                                 </fieldset>
 140                                 </form>
 141
 142                                 <ul class="link-list">
 143
 144                                         <li><a href="../../MCollective.html">MCollective</a></li>
 145
 146                                         <li><a href="../../MCollective/Agent.html">MCollective::Agent</a></li>
 147
 148                                         <li><a href="../../MCollective/Agents.html">MCollective::Agents</a></li>
 149
 150                                         <li><a href="../../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
 151
 152                                         <li><a href="../../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
 153
 154                                         <li><a href="../../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
 155
 156                                         <li><a href="../../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
 157
 158                                         <li><a href="../../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
 159
 160                                         <li><a href="../../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
 161
 162                                         <li><a href="../../MCollective/Application.html">MCollective::Application</a></li>
 163
 164                                         <li><a href="../../MCollective/Applications.html">MCollective::Applications</a></li>
 165
 166                                         <li><a href="../../MCollective/Cache.html">MCollective::Cache</a></li>
 167
 168                                         <li><a href="../../MCollective/Client.html">MCollective::Client</a></li>
 169
 170                                         <li><a href="../../MCollective/CodedError.html">MCollective::CodedError</a></li>
 171
 172                                         <li><a href="../../MCollective/Config.html">MCollective::Config</a></li>
 173
 174                                         <li><a href="../../MCollective/Connector.html">MCollective::Connector</a></li>
 175
 176                                         <li><a href="../../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
 177
 178                                         <li><a href="../../MCollective/DDL.html">MCollective::DDL</a></li>
 179
 180                                         <li><a href="../../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
 181
 182                                         <li><a href="../../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
 183
 184                                         <li><a href="../../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
 185
 186                                         <li><a href="../../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
 187
 188                                         <li><a href="../../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
 189
 190                                         <li><a href="../../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
 191
 192                                         <li><a href="../../MCollective/Data.html">MCollective::Data</a></li>
 193
 194                                         <li><a href="../../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
 195
 196                                         <li><a href="../../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
 197
 198                                         <li><a href="../../MCollective/Discovery.html">MCollective::Discovery</a></li>
 199
 200                                         <li><a href="../../MCollective/Facts.html">MCollective::Facts</a></li>
 201
 202                                         <li><a href="../../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
 203
 204                                         <li><a href="../../MCollective/Generators.html">MCollective::Generators</a></li>
 205
 206                                         <li><a href="../../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
 207
 208                                         <li><a href="../../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
 209
 210                                         <li><a href="../../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
 211
 212                                         <li><a href="../../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
 213
 214                                         <li><a href="../../MCollective/Log.html">MCollective::Log</a></li>
 215
 216                                         <li><a href="../../MCollective/Logger.html">MCollective::Logger</a></li>
 217
 218                                         <li><a href="../../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
 219
 220                                         <li><a href="../../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
 221
 222                                         <li><a href="../../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
 223
 224                                         <li><a href="../../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
 225
 226                                         <li><a href="../../MCollective/Matcher.html">MCollective::Matcher</a></li>
 227
 228                                         <li><a href="../../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
 229
 230                                         <li><a href="../../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
 231
 232                                         <li><a href="../../MCollective/Message.html">MCollective::Message</a></li>
 233
 234                                         <li><a href="../../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
 235
 236                                         <li><a href="../../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
 237
 238                                         <li><a href="../../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
 239
 240                                         <li><a href="../../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
 241
 242                                         <li><a href="../../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
 243
 244                                         <li><a href="../../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
 245
 246                                         <li><a href="../../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
 247
 248                                         <li><a href="../../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
 249
 250                                         <li><a href="../../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
 251
 252                                         <li><a href="../../MCollective/RPC.html">MCollective::RPC</a></li>
 253
 254                                         <li><a href="../../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
 255
 256                                         <li><a href="../../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
 257
 258                                         <li><a href="../../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
 259
 260                                         <li><a href="../../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
 261
 262                                         <li><a href="../../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
 263
 264                                         <li><a href="../../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
 265
 266                                         <li><a href="../../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
 267
 268                                         <li><a href="../../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
 269
 270                                         <li><a href="../../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
 271
 272                                         <li><a href="../../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
 273
 274                                         <li><a href="../../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
 275
 276                                         <li><a href="../../MCollective/RPCError.html">MCollective::RPCError</a></li>
 277
 278                                         <li><a href="../../MCollective/Registration.html">MCollective::Registration</a></li>
 279
 280                                         <li><a href="../../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
 281
 282                                         <li><a href="../../MCollective/Runner.html">MCollective::Runner</a></li>
 283
 284                                         <li><a href="../../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
 285
 286                                         <li><a href="../../MCollective/SSL.html">MCollective::SSL</a></li>
 287
 288                                         <li><a href="../../MCollective/Security.html">MCollective::Security</a></li>
 289
 290                                         <li><a href="../../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
 291
 292                                         <li><a href="../../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
 293
 294                                         <li><a href="../../MCollective/Shell.html">MCollective::Shell</a></li>
 295
 296                                         <li><a href="../../MCollective/Translatable.html">MCollective::Translatable</a></li>
 297
 298                                         <li><a href="../../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
 299
 300                                         <li><a href="../../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
 301
 302                                         <li><a href="../../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
 303
 304                                         <li><a href="../../MCollective/Util.html">MCollective::Util</a></li>
 305
 306                                         <li><a href="../../MCollective/Validator.html">MCollective::Validator</a></li>
 307
 308                                         <li><a href="../../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
 309
 310                                         <li><a href="../../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
 311
 312                                         <li><a href="../../Array.html">Array</a></li>
 313
 314                                         <li><a href="../../Dir.html">Dir</a></li>
 315
 316                                         <li><a href="../../Object.html">Object</a></li>
 317
 318                                         <li><a href="../../String.html">String</a></li>
 319
 320                                         <li><a href="../../Symbol.html">Symbol</a></li>
 321
 322                                 </ul>
 323                                 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
 324                         </div>
 325
 326
 327                 </div>
 328         </div>
 329
 330         <div id="documentation">
 331                 <h1 class="class">MCollective::Generators::Base</h1>
 332
 333                 <div id="description">
 334
 335                 </div>
 336
 337                 <!-- Constants -->
 338
 339
 340                 <!-- Attributes -->
 341
 342                 <div id="attribute-method-details" class="method-section section">
 343                         <h3 class="section-header">Attributes</h3>
 344
 345
 346                         <div id="meta-attribute-method" class="method-detail">
 347                                 <a name="meta"></a>
 348
 349                                 <a name="meta="></a>
 350
 351                                 <div class="method-heading attribute-method-heading">
 352                                         <span class="method-name">meta</span><span
 353                                                 class="attribute-access-type">[RW]</span>
 354                                 </div>
 355
 356                                 <div class="method-description">
 357
 358                                 <p class="missing-docs">(Not documented)</p>
 359
 360                                 </div>
 361                         </div>
 362
 363                         <div id="plugin-name-attribute-method" class="method-detail">
 364                                 <a name="plugin_name"></a>
 365
 366                                 <a name="plugin_name="></a>
 367
 368                                 <div class="method-heading attribute-method-heading">
 369                                         <span class="method-name">plugin_name</span><span
 370                                                 class="attribute-access-type">[RW]</span>
 371                                 </div>
 372
 373                                 <div class="method-description">
 374
 375                                 <p class="missing-docs">(Not documented)</p>
 376
 377                                 </div>
 378                         </div>
 379
 380                         <div id="mod-name-attribute-method" class="method-detail">
 381                                 <a name="mod_name"></a>
 382
 383                                 <a name="mod_name="></a>
 384
 385                                 <div class="method-heading attribute-method-heading">
 386                                         <span class="method-name">mod_name</span><span
 387                                                 class="attribute-access-type">[RW]</span>
 388                                 </div>
 389
 390                                 <div class="method-description">
 391
 392                                 <p class="missing-docs">(Not documented)</p>
 393
 394                                 </div>
 395                         </div>
 396
 397                 </div>
 398
 399
 400                 <!-- Methods -->
 401
 402                 <div id="public-class-method-details" class="method-section section">
 403                         <h3 class="section-header">Public Class Methods</h3>
 404
 405
 406                         <div id="new-method" class="method-detail ">
 407                                 <a name="M000238"></a>
 408
 409                                 <div class="method-heading">
 410
 411                                         <span class="method-name">new</span><span
 412                                                 class="method-args">(name, description, author, license, version, url, timeout)</span>
 413                                         <span class="method-click-advice">click to toggle source</span>
 414
 415                                 </div>
 416
 417                                 <div class="method-description">
 418
 419                                         <p class="missing-docs">(Not documented)</p>
 420
 421
 422
 423                                         <div class="method-source-code"
 424                                                 id="new-source">
 425 <pre>
 426     <span class="ruby-comment cmt"># File lib/mcollective/generators/base.rb, line 5</span>
 427  5:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">description</span>, <span class="ruby-identifier">author</span>, <span class="ruby-identifier">license</span>, <span class="ruby-identifier">version</span>, <span class="ruby-identifier">url</span>, <span class="ruby-identifier">timeout</span>)
 428  6:         <span class="ruby-ivar">@meta</span> = {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">name</span>,
 429  7:                  <span class="ruby-identifier">:description</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">description</span>,
 430  8:                  <span class="ruby-identifier">:author</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">author</span>,
 431  9:                  <span class="ruby-identifier">:license</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">license</span>,
 432 10:                  <span class="ruby-identifier">:version</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">version</span>,
 433 11:                  <span class="ruby-identifier">:url</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">url</span>,
 434 12:                  <span class="ruby-identifier">:timeout</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">timeout</span>}
 435 13:       <span class="ruby-keyword kw">end</span></pre>
 436                                         </div>
 437
 438                                 </div>
 439
 440
 441                         </div>
 442
 443
 444                 </div>
 445
 446                 <div id="public-instance-method-details" class="method-section section">
 447                         <h3 class="section-header">Public Instance Methods</h3>
 448
 449
 450                         <div id="create-metadata-string-method" class="method-detail ">
 451                                 <a name="M000239"></a>
 452
 453                                 <div class="method-heading">
 454
 455                                         <span class="method-name">create_metadata_string</span><span
 456                                                 class="method-args">()</span>
 457                                         <span class="method-click-advice">click to toggle source</span>
 458
 459                                 </div>
 460
 461                                 <div class="method-description">
 462
 463                                         <p class="missing-docs">(Not documented)</p>
 464
 465
 466
 467                                         <div class="method-source-code"
 468                                                 id="create-metadata-string-source">
 469 <pre>
 470     <span class="ruby-comment cmt"># File lib/mcollective/generators/base.rb, line 15</span>
 471 15:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_metadata_string</span>
 472 16:         <span class="ruby-identifier">ddl_template</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword kw">__FILE__</span>), <span class="ruby-value str">&quot;templates&quot;</span>, <span class="ruby-value str">&quot;ddl.erb&quot;</span>))
 473 17:         <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">ddl_template</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-value str">&quot;-&quot;</span>).<span class="ruby-identifier">result</span>(<span class="ruby-identifier">binding</span>)
 474 18:       <span class="ruby-keyword kw">end</span></pre>
 475                                         </div>
 476
 477                                 </div>
 478
 479
 480                         </div>
 481
 482
 483                         <div id="create-plugin-string-method" class="method-detail ">
 484                                 <a name="M000240"></a>
 485
 486                                 <div class="method-heading">
 487
 488                                         <span class="method-name">create_plugin_string</span><span
 489                                                 class="method-args">()</span>
 490                                         <span class="method-click-advice">click to toggle source</span>
 491
 492                                 </div>
 493
 494                                 <div class="method-description">
 495
 496                                         <p class="missing-docs">(Not documented)</p>
 497
 498
 499
 500                                         <div class="method-source-code"
 501                                                 id="create-plugin-string-source">
 502 <pre>
 503     <span class="ruby-comment cmt"># File lib/mcollective/generators/base.rb, line 20</span>
 504 20:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_plugin_string</span>
 505 21:         <span class="ruby-identifier">plugin_template</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">dirname</span>(<span class="ruby-keyword kw">__FILE__</span>), <span class="ruby-value str">&quot;templates&quot;</span>, <span class="ruby-value str">&quot;plugin.erb&quot;</span>))
 506 22:         <span class="ruby-constant">ERB</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">plugin_template</span>, <span class="ruby-keyword kw">nil</span>, <span class="ruby-value str">&quot;-&quot;</span>).<span class="ruby-identifier">result</span>(<span class="ruby-identifier">binding</span>)
 507 23:       <span class="ruby-keyword kw">end</span></pre>
 508                                         </div>
 509
 510                                 </div>
 511
 512
 513                         </div>
 514
 515
 516                         <div id="write-plugins-method" class="method-detail ">
 517                                 <a name="M000241"></a>
 518
 519                                 <div class="method-heading">
 520
 521                                         <span class="method-name">write_plugins</span><span
 522                                                 class="method-args">()</span>
 523                                         <span class="method-click-advice">click to toggle source</span>
 524
 525                                 </div>
 526
 527                                 <div class="method-description">
 528
 529                                         <p class="missing-docs">(Not documented)</p>
 530
 531
 532
 533                                         <div class="method-source-code"
 534                                                 id="write-plugins-source">
 535 <pre>
 536     <span class="ruby-comment cmt"># File lib/mcollective/generators/base.rb, line 25</span>
 537 25:       <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">write_plugins</span>
 538 26:         <span class="ruby-keyword kw">begin</span>
 539 27:           <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">mkdir</span> <span class="ruby-ivar">@plugin_name</span>
 540 28:           <span class="ruby-identifier">dirname</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-ivar">@plugin_name</span>, <span class="ruby-ivar">@mod_name</span>.<span class="ruby-identifier">downcase</span>)
 541 29:           <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">mkdir</span> <span class="ruby-identifier">dirname</span>
 542 30:           <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Created plugin directory : #{@plugin_name}&quot;</span>
 543 31:
 544 32:           <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">dirname</span>, <span class="ruby-node">&quot;#{@plugin_name}.ddl&quot;</span>), <span class="ruby-value str">&quot;w&quot;</span>){<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-ivar">@ddl</span>}
 545 33:           <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Created DDL file : #{File.join(dirname, &quot;#{@plugin_name}.ddl&quot;)}&quot;</span>
 546 34:
 547 35:           <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">dirname</span>, <span class="ruby-node">&quot;#{@plugin_name}.rb&quot;</span>), <span class="ruby-value str">&quot;w&quot;</span>){<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-ivar">@plugin</span>}
 548 36:           <span class="ruby-identifier">puts</span> <span class="ruby-node">&quot;Created #{@mod_name} file : #{File.join(dirname, &quot;#{@plugin_name}.rb&quot;)}&quot;</span>
 549 37:         <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Errno</span><span class="ruby-operator">::</span><span class="ruby-constant">EEXIST</span>
 550 38:           <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;cannot generate '#{@plugin_name}' : plugin directory already exists.&quot;</span>
 551 39:         <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
 552 40:           <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">rm_rf</span>(<span class="ruby-ivar">@plugin_name</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-ivar">@plugin_name</span>)
 553 41:           <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;cannot generate plugin - #{e}&quot;</span>
 554 42:         <span class="ruby-keyword kw">end</span>
 555 43:       <span class="ruby-keyword kw">end</span></pre>
 556                                         </div>
 557
 558                                 </div>
 559
 560
 561                         </div>
 562
 563
 564                 </div>
 565
 566
 567         </div>
 568
 569
 570         <div id="rdoc-debugging-section-dump" class="debugging-section">
 571
 572                 <p>Disabled; run with --debug to generate this.</p>
 573
 574         </div>
 575
 576         <div id="validator-badges">
 577                 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 578                 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
 579                         Rdoc Generator</a> 1.1.6</small>.</p>
 580         </div>
 581
 582 </body>
 583 </html>
 584