+++ /dev/null
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
- <title>Class: MCollective::Generators::Base</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Class</strong></td>
- <td class="class-name-in-header">MCollective::Generators::Base</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../../files/lib/mcollective/generators/base_rb.html">
- lib/mcollective/generators/base.rb
- </a>
- <br />
- </td>
- </tr>
-
- <tr class="top-aligned-row">
- <td><strong>Parent:</strong></td>
- <td>
- Object
- </td>
- </tr>
- </table>
- </div>
- <!-- banner header -->
-
- <div id="bodyContent">
-
-
-
- <div id="contextContent">
-
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
-
- <div class="name-list">
- <a href="#M000257">create_metadata_string</a>
- <a href="#M000258">create_plugin_string</a>
- <a href="#M000256">new</a>
- <a href="#M000259">write_plugins</a>
- </div>
- </div>
-
- </div>
-
-
- <!-- if includes -->
-
- <div id="section">
-
-
-
-
-
- <div id="attribute-list">
- <h3 class="section-bar">Attributes</h3>
-
- <div class="name-list">
- <table>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">meta</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">mod_name</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- <tr class="top-aligned-row context-row">
- <td class="context-item-name">plugin_name</td>
- <td class="context-item-value"> [RW] </td>
- <td class="context-item-desc"></td>
- </tr>
- </table>
- </div>
- </div>
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000256" class="method-detail">
- <a name="M000256"></a>
-
- <div class="method-heading">
- <a href="#M000256" class="method-signature">
- <span class="method-name">new</span><span class="method-args">(name, description, author, license, version, url, timeout)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000256-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000256-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/generators/base.rb, line 5</span>
- 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>)
- 6: <span class="ruby-ivar">@meta</span> = {<span class="ruby-identifier">:name</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">name</span>,
- 7: <span class="ruby-identifier">:description</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">description</span>,
- 8: <span class="ruby-identifier">:author</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">author</span>,
- 9: <span class="ruby-identifier">:license</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">license</span>,
-10: <span class="ruby-identifier">:version</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">version</span>,
-11: <span class="ruby-identifier">:url</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">url</span>,
-12: <span class="ruby-identifier">:timeout</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">timeout</span>}
-13: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <h3 class="section-bar">Public Instance methods</h3>
-
- <div id="method-M000257" class="method-detail">
- <a name="M000257"></a>
-
- <div class="method-heading">
- <a href="#M000257" class="method-signature">
- <span class="method-name">create_metadata_string</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000257-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000257-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/generators/base.rb, line 15</span>
-15: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_metadata_string</span>
-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">"templates"</span>, <span class="ruby-value str">"ddl.erb"</span>))
-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">"-"</span>).<span class="ruby-identifier">result</span>(<span class="ruby-identifier">binding</span>)
-18: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000258" class="method-detail">
- <a name="M000258"></a>
-
- <div class="method-heading">
- <a href="#M000258" class="method-signature">
- <span class="method-name">create_plugin_string</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000258-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000258-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/generators/base.rb, line 20</span>
-20: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">create_plugin_string</span>
-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">"templates"</span>, <span class="ruby-value str">"plugin.erb"</span>))
-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">"-"</span>).<span class="ruby-identifier">result</span>(<span class="ruby-identifier">binding</span>)
-23: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000259" class="method-detail">
- <a name="M000259"></a>
-
- <div class="method-heading">
- <a href="#M000259" class="method-signature">
- <span class="method-name">write_plugins</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000259-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000259-source">
-<pre>
- <span class="ruby-comment cmt"># File lib/mcollective/generators/base.rb, line 25</span>
-25: <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">write_plugins</span>
-26: <span class="ruby-keyword kw">begin</span>
-27: <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">mkdir</span> <span class="ruby-ivar">@plugin_name</span>
-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>)
-29: <span class="ruby-constant">Dir</span>.<span class="ruby-identifier">mkdir</span> <span class="ruby-identifier">dirname</span>
-30: <span class="ruby-identifier">puts</span> <span class="ruby-node">"Created plugin directory : #{@plugin_name}"</span>
-31:
-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">"#{@plugin_name}.ddl"</span>), <span class="ruby-value str">"w"</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>}
-33: <span class="ruby-identifier">puts</span> <span class="ruby-node">"Created DDL file : #{File.join(dirname, "#{@plugin_name}.ddl")}"</span>
-34:
-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">"#{@plugin_name}.rb"</span>), <span class="ruby-value str">"w"</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>}
-36: <span class="ruby-identifier">puts</span> <span class="ruby-node">"Created #{@mod_name} file : #{File.join(dirname, "#{@plugin_name}.rb")}"</span>
-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>
-38: <span class="ruby-identifier">raise</span> <span class="ruby-node">"cannot generate '#{@plugin_name}' : plugin directory already exists."</span>
-39: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
-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>)
-41: <span class="ruby-identifier">raise</span> <span class="ruby-node">"cannot generate plugin - #{e}"</span>
-42: <span class="ruby-keyword kw">end</span>
-43: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
-
- </div>
-
-
- </div>
-
-
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>
\ No newline at end of file