RubyGems - mattock - Versions diffs - 0.2.2 → 0.2.3 - Mend

mattock 0.2.2 → 0.2.3

Files changed (59) hide show

data/doc/FileSandbox.html +537 -0
data/doc/FileSandbox/HaveContents.html +279 -0
data/doc/FileSandbox/Sandbox.html +525 -0
data/doc/FileSandbox/SandboxFile.html +622 -0
data/doc/Mattock.html +137 -0
data/doc/Mattock/CascadingDefinition.html +459 -0
data/doc/Mattock/CommandChain.html +456 -0
data/doc/Mattock/CommandLine.html +1312 -0
data/doc/Mattock/CommandLineExampleGroup.html +282 -0
data/doc/Mattock/CommandLineExampleGroup/Matchers.html +109 -0
data/doc/Mattock/CommandRunResult.html +643 -0
data/doc/Mattock/CommandTask.html +464 -0
data/doc/Mattock/Configurable.html +609 -0
data/doc/Mattock/Configurable/ClassMethods.html +754 -0
data/doc/Mattock/Configurable/Struct.html +148 -0
data/doc/Mattock/FileCreationTask.html +177 -0
data/doc/Mattock/FileTask.html +177 -0
data/doc/Mattock/MockCommandResult.html +445 -0
data/doc/Mattock/MultiTask.html +177 -0
data/doc/Mattock/PipelineChain.html +221 -0
data/doc/Mattock/PrereqChain.html +221 -0
data/doc/Mattock/RakeExampleGroup.html +292 -0
data/doc/Mattock/RakeExampleGroup/Matchers.html +109 -0
data/doc/Mattock/RakeExampleGroup/TaskManager.html +131 -0
data/doc/Mattock/RemoteCommandTask.html +423 -0
data/doc/Mattock/ShellEscaped.html +315 -0
data/doc/Mattock/Task.html +181 -0
data/doc/Mattock/TaskLib.html +755 -0
data/doc/Mattock/TaskMixin.html +668 -0
data/doc/Mattock/TaskMixin/ClassMethods.html +166 -0
data/doc/Mattock/TemplateHost.html +320 -0
data/doc/Mattock/ValiseManager.html +257 -0
data/doc/Mattock/WrappingChain.html +221 -0
data/doc/Mattock/YARDExtensions.html +110 -0
data/doc/Mattock/YARDExtensions/DefineHandler.html +253 -0
data/doc/Mattock/YARDExtensions/NilFieldsHandler.html +258 -0
data/doc/Mattock/YARDExtensions/RequiredFieldsHandler.html +205 -0
data/doc/Mattock/YARDExtensions/SettingHandler.html +529 -0
data/doc/Mattock/YARDExtensions/SettingsHandler.html +207 -0
data/doc/RSpecTest.html +233 -0
data/doc/Ungemmer.html +282 -0
data/doc/_index.html +435 -0
data/doc/class_list.html +47 -0
data/doc/css/common.css +1 -0
data/doc/css/full_list.css +55 -0
data/doc/css/style.css +322 -0
data/doc/file.README.html +107 -0
data/doc/file_list.html +49 -0
data/doc/frames.html +13 -0
data/doc/index.html +107 -0
data/doc/js/app.js +205 -0
data/doc/js/full_list.js +173 -0
data/doc/js/jquery.js +16 -0
data/doc/method_list.html +950 -0
data/doc/top-level-namespace.html +107 -0
data/lib/mattock/task.rb +12 -0
data/lib/mattock/yard_extensions.rb +36 -0
data/yard_templates/default/module/setup.rb +1 -0
metadata +114 -4

@@ -0,0 +1,49 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+      <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
+      <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+      <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+      <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
+    <base id="base_target" target="_parent" />
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) {
+        document.getElementById('base_target').target = 'main';
+        document.body.className = 'frames';
+      }
+    </script>
+    <div id="content">
+      <h1 id="full_list_header">File List</h1>
+      <div id="nav">
+          <a target="_self" href="class_list.html">Classes</a>
+          <a target="_self" href="method_list.html">Methods</a>
+          <a target="_self" href="file_list.html">Files</a>
+      </div>
+      <div id="search">Search: <input type="text" /></div>
+      <ul id="full_list" class="files">
+  <li class="r1"><a href="index.html" title="README">README</a></li>
+      </ul>
+    </div>
+  </body>
+</html>

data/doc/frames.html ADDED

@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
+	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+	<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+	<title>Documentation by YARD 0.7.5</title>
+</head>
+<frameset cols="20%,*">
+  <frame name="list" src="class_list.html" />
+  <frame name="main" src="index.html" />
+</frameset>
+</html>

data/doc/index.html ADDED

@@ -0,0 +1,107 @@
+<!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>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+<title>
+  File: README
+    &mdash; Documentation by YARD 0.7.5
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  relpath = '';
+  if (relpath != '') relpath += '/';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+    <div id="header">
+      <div id="menu">
+    <a href="_index.html" title="Index">Index</a> &raquo;
+    <span class="title">File: README</span>
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+      <div id="search">
+    <a id="class_list_link" href="#">Class List</a>
+    <a id="method_list_link" href="#">Method List</a>
+    <a id="file_list_link" href="#">File List</a>
+</div>
+      <div class="clear"></div>
+    </div>
+    <iframe id="search_frame"></iframe>
+    <div id="content"><div id='filecontents'><h2>Mattock</h2>
+<p>Another tool to use with Rake.  Mattock is a collection of handy Rake
+extensions I&#39;ve been using elsewhere and generalized.</p>
+<h3>Configurable Tasklibs</h3>
+<p>Rake suggests an idiom for Tasklibs that works very well:</p>
+<pre class="code ruby"><code><span class='const'>Tasklib</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_t'>t</span><span class='op'>|</span>
+  <span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_config'>config</span> <span class='op'>=</span> <span class='symbol'>:x</span>
+<span class='kw'>end</span>
+</code></pre>
+<p>And that defines some tasks.  Rake&#39;s default Tasklib class doesn&#39;t do much to
+support that idiom though, so Mattock&#39;s first purpose is to add support for
+default settings, a yield into a configuration block, and the a setting
+resolution step.</p>
+<h3>A Command line scripting API</h3>
+<p>There&#39;s two reasons to do something more complicate that good old</p>
+<pre class="code ruby"><code> <span class='id identifier rubyid_sh'>sh</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>rm -rf *</span><span class='tstring_end'>'</span></span>
+</code></pre>
+<p>First is composibility.  With a Mattock::CommandLine, you can pass the
+resulting command around and modify it&#39;s arguments or encorporate it into a
+larger pipeline easily.</p>
+<p>Second is testability.  You can mock out all command line execution and provide
+fake responses.  Additionally, command results can be recorded to make that
+process easier.</p>
+<h3>Easy templating</h3>
+<p>One thing that Thor has on Rake is the ease with which templates can be
+rendered to files.  Mattock::TemplateHost makes it easy to render overridable
+templates based on the object it&#39;s included into.</p>
+<p>For more information, check out <a href="http://nyarly.github.com/mattock/">http://nyarly.github.com/mattock/</a></p>
+</div></div>
+    <div id="footer">
+  Generated on Tue Mar  6 02:47:28 2012 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.7.5 (ruby-1.9.2).
+</div>
+  </body>
+</html>

data/doc/js/app.js ADDED

@@ -0,0 +1,205 @@
+function createSourceLinks() {
+    $('.method_details_list .source_code').
+        before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
+    $('.toggleSource').toggle(function() {
+       $(this).parent().nextAll('.source_code').slideDown(100);
+       $(this).text("Hide source");
+    },
+    function() {
+        $(this).parent().nextAll('.source_code').slideUp(100);
+        $(this).text("View source");
+    });
+}
+function createDefineLinks() {
+    var tHeight = 0;
+    $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
+    $('.toggleDefines').toggle(function() {
+        tHeight = $(this).parent().prev().height();
+        $(this).prev().show();
+        $(this).parent().prev().height($(this).parent().height());
+        $(this).text("(less)");
+    },
+    function() {
+        $(this).prev().hide();
+        $(this).parent().prev().height(tHeight);
+        $(this).text("more...");
+    });
+}
+function createFullTreeLinks() {
+    var tHeight = 0;
+    $('.inheritanceTree').toggle(function() {
+        tHeight = $(this).parent().prev().height();
+        $(this).parent().toggleClass('showAll');
+        $(this).text("(hide)");
+        $(this).parent().prev().height($(this).parent().height());
+    },
+    function() {
+        $(this).parent().toggleClass('showAll');
+        $(this).parent().prev().height(tHeight);
+        $(this).text("show all");
+    });
+}
+function fixBoxInfoHeights() {
+    $('dl.box dd.r1, dl.box dd.r2').each(function() {
+       $(this).prev().height($(this).height());
+    });
+}
+function searchFrameLinks() {
+  $('#method_list_link').click(function() {
+    toggleSearchFrame(this, relpath + 'method_list.html');
+  });
+  $('#class_list_link').click(function() {
+    toggleSearchFrame(this, relpath + 'class_list.html');
+  });
+  $('#file_list_link').click(function() {
+    toggleSearchFrame(this, relpath + 'file_list.html');
+  });
+}
+function toggleSearchFrame(id, link) {
+  var frame = $('#search_frame');
+  $('#search a').removeClass('active').addClass('inactive');
+  if (frame.attr('src') == link && frame.css('display') != "none") {
+    frame.slideUp(100);
+    $('#search a').removeClass('active inactive');
+  }
+  else {
+    $(id).addClass('active').removeClass('inactive');
+    frame.attr('src', link).slideDown(100);
+  }
+}
+function linkSummaries() {
+  $('.summary_signature').click(function() {
+    document.location = $(this).find('a').attr('href');
+  });
+}
+function framesInit() {
+  if (window.top.frames.main) {
+    document.body.className = 'frames';
+    $('#menu .noframes a').attr('href', document.location);
+    $('html head title', window.parent.document).text($('html head title').text());
+  }
+}
+function keyboardShortcuts() {
+  if (window.top.frames.main) return;
+  $(document).keypress(function(evt) {
+    if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
+    if (typeof evt.target !== "undefined" &&
+        (evt.target.nodeName == "INPUT" ||
+        evt.target.nodeName == "TEXTAREA")) return;
+    switch (evt.charCode) {
+      case 67: case 99:  $('#class_list_link').click(); break;  // 'c'
+      case 77: case 109: $('#method_list_link').click(); break; // 'm'
+      case 70: case 102: $('#file_list_link').click(); break;   // 'f'
+      default: break;
+    }
+  });
+}
+function summaryToggle() {
+  $('.summary_toggle').click(function() {
+    localStorage.summaryCollapsed = $(this).text();
+    $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
+    var next = $(this).parent().parent().nextAll('ul.summary').first();
+    if (next.hasClass('compact')) {
+      next.toggle();
+      next.nextAll('ul.summary').first().toggle();
+    }
+    else if (next.hasClass('summary')) {
+      var list = $('<ul class="summary compact" />');
+      list.html(next.html());
+      list.find('.summary_desc, .note').remove();
+      list.find('a').each(function() {
+        $(this).html($(this).find('strong').html());
+        $(this).parent().html($(this)[0].outerHTML);
+      });
+      next.before(list);
+      next.toggle();
+    }
+    return false;
+  });
+  if (localStorage) {
+    if (localStorage.summaryCollapsed == "collapse") $('.summary_toggle').click();
+    else localStorage.summaryCollapsed = "expand";
+  }
+}
+function fixOutsideWorldLinks() {
+  $('a').each(function() {
+    if (window.location.host != this.host) this.target = '_parent';
+  });
+}
+function generateTOC() {
+  if ($('#filecontents').length === 0) return;
+  var _toc = $('<ol class="top"></ol>');
+  var show = false;
+  var toc = _toc;
+  var counter = 0;
+  var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
+  var i;
+  if ($('#filecontents h1').length > 1) tags.unshift('h1');
+  for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
+  var lastTag = parseInt(tags[0][1], 10);
+  $(tags.join(', ')).each(function() {
+    if (this.id == "filecontents") return;
+    show = true;
+    var thisTag = parseInt(this.tagName[1], 10);
+    if (this.id.length === 0) {
+      var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
+      if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
+      this.id = proposedId;
+    }
+    if (thisTag > lastTag) {
+      for (i = 0; i < thisTag - lastTag; i++) {
+        var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
+      }
+    }
+    if (thisTag < lastTag) {
+      for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
+    }
+    toc.append('<li><a href="#' + this.id + '">' + $(this).text() + '</a></li>');
+    lastTag = thisTag;
+  });
+  if (!show) return;
+  html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
+  $('#content').prepend(html);
+  $('#toc').append(_toc);
+  $('#toc .hide_toc').toggle(function() {
+    $('#toc .top').slideUp('fast');
+    $('#toc').toggleClass('hidden');
+    $('#toc .title small').toggle();
+  }, function() {
+    $('#toc .top').slideDown('fast');
+    $('#toc').toggleClass('hidden');
+    $('#toc .title small').toggle();
+  });
+  $('#toc .float_toc').toggle(function() {
+    $(this).text('float');
+    $('#toc').toggleClass('nofloat');
+  }, function() {
+    $(this).text('left');
+    $('#toc').toggleClass('nofloat');
+  });
+}
+$(framesInit);
+$(createSourceLinks);
+$(createDefineLinks);
+$(createFullTreeLinks);
+$(fixBoxInfoHeights);
+$(searchFrameLinks);
+$(linkSummaries);
+$(keyboardShortcuts);
+$(summaryToggle);
+$(fixOutsideWorldLinks);
+$(generateTOC);

data/doc/js/full_list.js ADDED

@@ -0,0 +1,173 @@
+var inSearch = null;
+var searchIndex = 0;
+var searchCache = [];
+var searchString = '';
+var regexSearchString = '';
+var caseSensitiveMatch = false;
+var ignoreKeyCodeMin = 8;
+var ignoreKeyCodeMax = 46;
+var commandKey = 91;
+RegExp.escape = function(text) {
+    return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
+}
+function fullListSearch() {
+  // generate cache
+  searchCache = [];
+  $('#full_list li').each(function() {
+    var link = $(this).find('.object_link a');
+    var fullName = link.attr('title').split(' ')[0];
+    searchCache.push({name:link.text(), fullName:fullName, node:$(this), link:link});
+  });
+  $('#search input').keyup(function() {
+    if ((event.keyCode > ignoreKeyCodeMin && event.keyCode < ignoreKeyCodeMax)
+         || event.keyCode == commandKey)
+      return;
+    searchString = this.value;
+    caseSensitiveMatch = searchString.match(/[A-Z]/) != null;
+    regexSearchString = RegExp.escape(searchString);
+    if (caseSensitiveMatch) {
+      regexSearchString += "|" +
+        $.map(searchString.split(''), function(e) { return RegExp.escape(e); }).
+        join('.+?');
+    }
+    if (searchString === "") {
+      clearTimeout(inSearch);
+      inSearch = null;
+      $('ul .search_uncollapsed').removeClass('search_uncollapsed');
+      $('#full_list, #content').removeClass('insearch');
+      $('#full_list li').removeClass('found').each(function() {
+        var link = $(this).find('.object_link a');
+        link.text(link.text());
+      });
+      if (clicked) {
+        clicked.parents('ul').each(function() {
+          $(this).removeClass('collapsed').prev().removeClass('collapsed');
+        });
+      }
+      highlight();
+    }
+    else {
+      if (inSearch) clearTimeout(inSearch);
+      searchIndex = 0;
+      lastRowClass = '';
+      $('#full_list, #content').addClass('insearch');
+      $('#noresults').text('');
+      searchItem();
+    }
+  });
+  $('#search input').focus();
+  $('#full_list').after("<div id='noresults'></div>");
+}
+var lastRowClass = '';
+function searchItem() {
+  for (var i = 0; i < searchCache.length / 50; i++) {
+    var item = searchCache[searchIndex];
+    var searchName = (searchString.indexOf('::') != -1 ? item.fullName : item.name);
+    var matchString = regexSearchString;
+    var matchRegexp = new RegExp(matchString, caseSensitiveMatch ? "" : "i");
+    if (searchName.match(matchRegexp) == null) {
+      item.node.removeClass('found');
+    }
+    else {
+      item.node.css('padding-left', '10px').addClass('found');
+      item.node.parents().addClass('search_uncollapsed');
+      item.node.removeClass(lastRowClass).addClass(lastRowClass == 'r1' ? 'r2' : 'r1');
+      lastRowClass = item.node.hasClass('r1') ? 'r1' : 'r2';
+      item.link.html(item.name.replace(matchRegexp, "<strong>$&</strong>"));
+    }
+    if (searchCache.length === searchIndex + 1) {
+      searchDone();
+      return;
+    }
+    else {
+      searchIndex++;
+    }
+  }
+  inSearch = setTimeout('searchItem()', 0);
+}
+function searchDone() {
+  highlight(true);
+  if ($('#full_list li:visible').size() === 0) {
+    $('#noresults').text('No results were found.').hide().fadeIn();
+  }
+  else {
+    $('#noresults').text('');
+  }
+  $('#content').removeClass('insearch');
+  clearTimeout(inSearch);
+  inSearch = null;
+}
+clicked = null;
+function linkList() {
+  $('#full_list li, #full_list li a:last').click(function(evt) {
+    if ($(this).hasClass('toggle')) return true;
+    if (this.tagName.toLowerCase() == "li") {
+      var toggle = $(this).children('a.toggle');
+      if (toggle.size() > 0 && evt.pageX < toggle.offset().left) {
+        toggle.click();
+        return false;
+      }
+    }
+    if (clicked) clicked.removeClass('clicked');
+    var win = window.top.frames.main ? window.top.frames.main : window.parent;
+    if (this.tagName.toLowerCase() == "a") {
+      clicked = $(this).parent('li').addClass('clicked');
+      win.location = this.href;
+    }
+    else {
+      clicked = $(this).addClass('clicked');
+      win.location = $(this).find('a:last').attr('href');
+    }
+    return false;
+  });
+}
+function collapse() {
+  if (!$('#full_list').hasClass('class')) return;
+  $('#full_list.class a.toggle').click(function() {
+    $(this).parent().toggleClass('collapsed').next().toggleClass('collapsed');
+    highlight();
+    return false;
+  });
+  $('#full_list.class ul').each(function() {
+    $(this).addClass('collapsed').prev().addClass('collapsed');
+  });
+  $('#full_list.class').children().removeClass('collapsed');
+  highlight();
+}
+function highlight(no_padding) {
+  var n = 1;
+  $('#full_list li:visible').each(function() {
+    var next = n == 1 ? 2 : 1;
+    $(this).removeClass("r" + next).addClass("r" + n);
+    if (!no_padding && $('#full_list').hasClass('class')) {
+      $(this).css('padding-left', (10 + $(this).parents('ul').size() * 15) + 'px');
+    }
+    n = next;
+  });
+}
+function escapeShortcut() {
+  $(document).keydown(function(evt) {
+    if (evt.which == 27) {
+      $('#search_frame', window.top.document).slideUp(100);
+      $('#search a', window.top.document).removeClass('active inactive');
+      $(window.top).focus();
+    }
+  });
+}
+$(escapeShortcut);
+$(fullListSearch);
+$(linkList);
+$(collapse);