--- /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>Module: MCollective::PluginPackager</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>Module</strong></td>
+ <td class="class-name-in-header">MCollective::PluginPackager</td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>In:</strong></td>
+ <td>
+ <a href="../../files/lib/mcollective/pluginpackager_rb.html">
+ lib/mcollective/pluginpackager.rb
+ </a>
+ <br />
+ <a href="../../files/lib/mcollective/pluginpackager/standard_definition_rb.html">
+ lib/mcollective/pluginpackager/standard_definition.rb
+ </a>
+ <br />
+ <a href="../../files/lib/mcollective/pluginpackager/agent_definition_rb.html">
+ lib/mcollective/pluginpackager/agent_definition.rb
+ </a>
+ <br />
+ </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="#M000312">[]</a>
+ <a href="#M000314">check_dir_present</a>
+ <a href="#M000316">command_available?</a>
+ <a href="#M000315">execute_verbosely</a>
+ <a href="#M000318">filter_dependencies</a>
+ <a href="#M000313">get_metadata</a>
+ <a href="#M000311">load_packagers</a>
+ <a href="#M000317">safe_system</a>
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- if includes -->
+
+ <div id="section">
+
+ <div id="class-list">
+ <h3 class="section-bar">Classes and Modules</h3>
+
+ Class <a href="PluginPackager/AgentDefinition.html" class="link">MCollective::PluginPackager::AgentDefinition</a><br />
+Class <a href="PluginPackager/StandardDefinition.html" class="link">MCollective::PluginPackager::StandardDefinition</a><br />
+
+ </div>
+
+
+
+
+
+
+
+ <!-- if method_list -->
+ <div id="methods">
+ <h3 class="section-bar">Public Class methods</h3>
+
+ <div id="method-M000312" class="method-detail">
+ <a name="M000312"></a>
+
+ <div class="method-heading">
+ <a href="#M000312" class="method-signature">
+ <span class="method-name">[]</span><span class="method-args">(klass)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000312-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000312-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 12</span>
+12: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-operator">[]</span>(<span class="ruby-identifier">klass</span>)
+13: <span class="ruby-identifier">const_get</span>(<span class="ruby-node">"#{klass}"</span>)
+14: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000314" class="method-detail">
+ <a name="M000314"></a>
+
+ <div class="method-heading">
+ <a href="#M000314" class="method-signature">
+ <span class="method-name">check_dir_present</span><span class="method-args">(path)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Checks if a directory is present and not empty
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000314-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000314-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 31</span>
+31: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">check_dir_present</span>(<span class="ruby-identifier">path</span>)
+32: (<span class="ruby-constant">File</span>.<span class="ruby-identifier">directory?</span>(<span class="ruby-identifier">path</span>) <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-constant">Dir</span>.<span class="ruby-identifier">glob</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">path</span>, <span class="ruby-value str">"*"</span>)).<span class="ruby-identifier">empty?</span>)
+33: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000316" class="method-detail">
+ <a name="M000316"></a>
+
+ <div class="method-heading">
+ <a href="#M000316" class="method-signature">
+ <span class="method-name">command_available?</span><span class="method-args">(build_tool)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Checks if a build tool is present on the system
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000316-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000316-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 54</span>
+54: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">command_available?</span>(<span class="ruby-identifier">build_tool</span>)
+55: <span class="ruby-constant">ENV</span>[<span class="ruby-value str">"PATH"</span>].<span class="ruby-identifier">split</span>(<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">PATH_SEPARATOR</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">path</span><span class="ruby-operator">|</span>
+56: <span class="ruby-identifier">builder</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">build_tool</span>)
+57: <span class="ruby-keyword kw">if</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">exists?</span>(<span class="ruby-identifier">builder</span>)
+58: <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span>
+59: <span class="ruby-keyword kw">end</span>
+60: <span class="ruby-keyword kw">end</span>
+61: <span class="ruby-keyword kw">false</span>
+62: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000315" class="method-detail">
+ <a name="M000315"></a>
+
+ <div class="method-heading">
+ <a href="#M000315" class="method-signature">
+ <span class="method-name">execute_verbosely</span><span class="method-args">(verbose, &block)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Quietly calls a block if verbose parameter is false
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000315-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000315-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 36</span>
+36: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">execute_verbosely</span>(<span class="ruby-identifier">verbose</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
+37: <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">verbose</span>
+38: <span class="ruby-identifier">old_stdout</span> = <span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">clone</span>
+39: <span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">reopen</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">"/dev/null"</span>, <span class="ruby-value str">"w"</span>))
+40: <span class="ruby-keyword kw">begin</span>
+41: <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>
+42: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">e</span>
+43: <span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">reopen</span> <span class="ruby-identifier">old_stdout</span>
+44: <span class="ruby-identifier">raise</span> <span class="ruby-identifier">e</span>
+45: <span class="ruby-keyword kw">ensure</span>
+46: <span class="ruby-identifier">$stdout</span>.<span class="ruby-identifier">reopen</span> <span class="ruby-identifier">old_stdout</span>
+47: <span class="ruby-keyword kw">end</span>
+48: <span class="ruby-keyword kw">else</span>
+49: <span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>
+50: <span class="ruby-keyword kw">end</span>
+51: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000318" class="method-detail">
+ <a name="M000318"></a>
+
+ <div class="method-heading">
+ <a href="#M000318" class="method-signature">
+ <span class="method-name">filter_dependencies</span><span class="method-args">(prefix, dependencies)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Filter out platform specific dependencies Given a list of dependencies
+named - debian::foo redhat::bar <a
+href="PluginPackager.html#M000318">PluginPackager.filter_dependencies</a>(‘debian’,
+dependencies) will return foo.
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000318-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000318-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 74</span>
+74: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">filter_dependencies</span>(<span class="ruby-identifier">prefix</span>, <span class="ruby-identifier">dependencies</span>)
+75: <span class="ruby-identifier">dependencies</span>.<span class="ruby-identifier">map</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">dependency</span><span class="ruby-operator">|</span>
+76: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">dependency</span>[<span class="ruby-identifier">:name</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/^(\w+)::(\w+)/</span>
+77: <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">prefix</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">$1</span>
+78: <span class="ruby-identifier">dependency</span>[<span class="ruby-identifier">:name</span>] = <span class="ruby-identifier">$2</span>
+79: <span class="ruby-identifier">dependency</span>
+80: <span class="ruby-keyword kw">else</span>
+81: <span class="ruby-keyword kw">nil</span>
+82: <span class="ruby-keyword kw">end</span>
+83: <span class="ruby-keyword kw">else</span>
+84: <span class="ruby-identifier">dependency</span>
+85: <span class="ruby-keyword kw">end</span>
+86: <span class="ruby-keyword kw">end</span>.<span class="ruby-identifier">reject</span>{ <span class="ruby-operator">|</span><span class="ruby-identifier">dependency</span><span class="ruby-operator">|</span> <span class="ruby-identifier">dependency</span> <span class="ruby-operator">==</span> <span class="ruby-keyword kw">nil</span> }
+87: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000313" class="method-detail">
+ <a name="M000313"></a>
+
+ <div class="method-heading">
+ <a href="#M000313" class="method-signature">
+ <span class="method-name">get_metadata</span><span class="method-args">(path, type)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Fetch and return metadata from plugin <a href="DDL.html">DDL</a>
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000313-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000313-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 17</span>
+17: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">get_metadata</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">type</span>)
+18: <span class="ruby-identifier">ddl</span> = <span class="ruby-constant">DDL</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">"package"</span>, <span class="ruby-identifier">type</span>.<span class="ruby-identifier">to_sym</span>, <span class="ruby-keyword kw">false</span>)
+19:
+20: <span class="ruby-keyword kw">begin</span>
+21: <span class="ruby-identifier">ddl_file</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">read</span>(<span class="ruby-constant">Dir</span>.<span class="ruby-identifier">glob</span>(<span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">type</span>, <span class="ruby-value str">"*.ddl"</span>)).<span class="ruby-identifier">first</span>)
+22: <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">Exception</span>
+23: <span class="ruby-identifier">raise</span> <span class="ruby-node">"failed to load ddl file in plugin directory : #{File.join(path, type)}"</span>
+24: <span class="ruby-keyword kw">end</span>
+25: <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">instance_eval</span> <span class="ruby-identifier">ddl_file</span>
+26:
+27: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">meta</span>, <span class="ruby-identifier">ddl</span>.<span class="ruby-identifier">requirements</span>[<span class="ruby-identifier">:mcollective</span>]
+28: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000311" class="method-detail">
+ <a name="M000311"></a>
+
+ <div class="method-heading">
+ <a href="#M000311" class="method-signature">
+ <span class="method-name">load_packagers</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p>
+Package implementation plugins
+</p>
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000311-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000311-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 8</span>
+ 8: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">load_packagers</span>
+ 9: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">find_and_load</span>(<span class="ruby-value str">"pluginpackager"</span>)
+10: <span class="ruby-keyword kw">end</span>
+</pre>
+ </div>
+ </div>
+ </div>
+
+ <div id="method-M000317" class="method-detail">
+ <a name="M000317"></a>
+
+ <div class="method-heading">
+ <a href="#M000317" class="method-signature">
+ <span class="method-name">safe_system</span><span class="method-args">(*args)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ <p><a class="source-toggle" href="#"
+ onclick="toggleCode('M000317-source');return false;">[Source]</a></p>
+ <div class="method-source-code" id="M000317-source">
+<pre>
+ <span class="ruby-comment cmt"># File lib/mcollective/pluginpackager.rb, line 64</span>
+64: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">safe_system</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
+65: <span class="ruby-identifier">raise</span>(<span class="ruby-constant">RuntimeError</span>, <span class="ruby-node">"Failed: #{args.join(' ')}"</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">system</span> <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>
+66: <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
Code Review / packages / precise / mcollective.git / blobdiff