shenanigans 1.0.8 → 1.0.9

data/doc/created.rid

@@ -1,22 +1,25 @@
-Mon, 20 Aug 2012 18:53:22 +0200
-README.rdoc	Thu, 17 May 2012 11:45:08 +0200
-lib/shenanigans/array/caret.rb	Thu, 28 Jun 2012 09:15:50 +0200
-lib/shenanigans/array/random_subarray.rb	Thu, 17 May 2012 00:03:23 +0200
-lib/shenanigans/array/zip_with.rb	Tue, 19 Jun 2012 21:23:27 +0200
-lib/shenanigans/array.rb	Thu, 28 Jun 2012 09:00:29 +0200
-lib/shenanigans/fixnum/string_length.rb	Sun, 15 Jul 2012 00:00:21 +0200
-lib/shenanigans/fixnum.rb	Sat, 14 Jul 2012 23:49:59 +0200
-lib/shenanigans/hash/extract.rb	Thu, 09 Aug 2012 18:47:48 +0200
-lib/shenanigans/hash/has_shape_pred.rb	Tue, 19 Jun 2012 21:25:03 +0200
-lib/shenanigans/hash/to_ostruct.rb	Mon, 13 Aug 2012 17:56:35 +0200
-lib/shenanigans/hash.rb	Thu, 09 Aug 2012 18:32:30 +0200
-lib/shenanigans/kernel/fn.rb	Wed, 16 May 2012 23:57:36 +0200
-lib/shenanigans/kernel/prompt.rb	Thu, 17 May 2012 00:10:42 +0200
-lib/shenanigans/kernel/with.rb	Thu, 17 May 2012 00:00:08 +0200
-lib/shenanigans/kernel.rb	Wed, 16 May 2012 20:49:22 +0200
-lib/shenanigans/object/display.rb	Fri, 25 May 2012 17:29:45 +0200
-lib/shenanigans/object/it.rb	Thu, 28 Jun 2012 09:07:56 +0200
-lib/shenanigans/object.rb	Thu, 28 Jun 2012 09:10:12 +0200
-lib/shenanigans/string/in_groups_of.rb	Mon, 20 Aug 2012 18:53:19 +0200
-lib/shenanigans/string.rb	Mon, 20 Aug 2012 18:29:46 +0200
-lib/shenanigans.rb	Sat, 14 Jul 2012 23:53:13 +0200
+Wed, 06 Nov 2013 11:32:26 +0630
+README.rdoc	Thu, 17 May 2012 16:15:08 +0630
+lib/shenanigans.rb	Sun, 15 Jul 2012 04:23:13 +0630
+lib/shenanigans/array.rb	Thu, 28 Jun 2012 13:30:29 +0630
+lib/shenanigans/array/caret.rb	Thu, 28 Jun 2012 13:45:50 +0630
+lib/shenanigans/array/random_subarray.rb	Thu, 17 May 2012 04:33:23 +0630
+lib/shenanigans/array/zip_with.rb	Wed, 20 Jun 2012 01:53:27 +0630
+lib/shenanigans/fixnum.rb	Sun, 15 Jul 2012 04:19:59 +0630
+lib/shenanigans/fixnum/string_length.rb	Sun, 15 Jul 2012 04:30:21 +0630
+lib/shenanigans/hash.rb	Thu, 09 Aug 2012 23:02:30 +0630
+lib/shenanigans/hash/extract.rb	Thu, 09 Aug 2012 23:17:48 +0630
+lib/shenanigans/hash/has_shape_pred.rb	Wed, 20 Jun 2012 01:55:03 +0630
+lib/shenanigans/hash/to_ostruct.rb	Thu, 10 Oct 2013 23:47:27 +0630
+lib/shenanigans/kernel.rb	Wed, 06 Nov 2013 10:47:33 +0630
+lib/shenanigans/kernel/fn.rb	Wed, 06 Nov 2013 10:54:54 +0630
+lib/shenanigans/kernel/prompt.rb	Wed, 06 Nov 2013 10:55:11 +0630
+lib/shenanigans/kernel/require_optional.rb	Wed, 06 Nov 2013 10:54:41 +0630
+lib/shenanigans/kernel/with.rb	Wed, 06 Nov 2013 10:56:14 +0630
+lib/shenanigans/module.rb	Thu, 10 Oct 2013 21:59:25 +0630
+lib/shenanigans/module/private_accessor.rb	Wed, 06 Nov 2013 11:23:15 +0630
+lib/shenanigans/object.rb	Thu, 28 Jun 2012 13:40:12 +0630
+lib/shenanigans/object/display.rb	Fri, 25 May 2012 21:59:45 +0630
+lib/shenanigans/object/it.rb	Thu, 28 Jun 2012 13:37:56 +0630
+lib/shenanigans/string.rb	Mon, 20 Aug 2012 22:59:46 +0630
+lib/shenanigans/string/in_groups_of.rb	Mon, 20 Aug 2012 23:23:19 +0630

data/doc/index.html

@@ -67,6 +67,8 @@
   
     <li><a href="./Kernel.html">Kernel</a>
   
+    <li><a href="./Module.html">Module</a>
+  
     <li><a href="./Object.html">Object</a>
   
     <li><a href="./String.html">String</a>
@@ -78,8 +80,8 @@
 </nav>
 
 <div id="documentation" class="description">
-  
-<h1 id="label-Shenanigans">Shenanigans</h1>
+
+<h1 id="label-Shenanigans">Shenanigans<span><a href="#label-Shenanigans">&para;</a> <a href="#documentation">&uarr;</a></span></h1>
 
 <p><strong>shenanigan</strong> (plural shenanigans):</p>
 <ol><li>
@@ -99,7 +101,7 @@ but in reality, it is simply a complaint.</p>
 <p>Source: <a
 href="http://en.wiktionary.org/wiki/shenanigan#English">Wiktionary</a></p>
 
-<h2 id="label-Introduction">Introduction</h2>
+<h2 id="label-Introduction">Introduction<span><a href="#label-Introduction">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
 
 <p>Ruby Facets is the premiere collection of general purpose method extensions
 and standard additions for the Ruby programming language. This is not Ruby
@@ -108,7 +110,7 @@ because I found them interesting and/or useful. Some of them I actually
 also contributed to Facets, although sometimes they have different names or
 slightly different implementations.</p>
 
-<h2 id="label-Installation">Installation</h2>
+<h2 id="label-Installation">Installation<span><a href="#label-Installation">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
 
 <p>Shenanigans can be installed via <a
 href="http://rubygems.org/">RubyGems</a>.</p>
@@ -118,35 +120,35 @@ href="http://rubygems.org/">RubyGems</a>.</p>
 <p>I only works on 1.9.3 and I generally only test it with the most current
 Ruby release.</p>
 
-<h2 id="label-Usage">Usage</h2>
+<h2 id="label-Usage">Usage<span><a href="#label-Usage">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
 
 <p>If you really want the whole shebang, you can get it this way:</p>
 
-<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'shenanigans'</span>
+<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;shenanigans&#39;</span>
 </pre>
 
 <p>Requiring a single method works as follows:</p>
 
-<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'shenanigans/&lt;class|module&gt;/&lt;method&gt;'</span>
+<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;shenanigans/&lt;class|module&gt;/&lt;method&gt;&#39;</span>
 </pre>
 
 <p>Requiring all the extensions of a class or module also works:</p>
 
-<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'shenanigans/kernel'</span>
+<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">&#39;shenanigans/kernel&#39;</span>
 </pre>
 
-<h2 id="label-Contribute">Contribute</h2>
+<h2 id="label-Contribute">Contribute<span><a href="#label-Contribute">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
 
 <p>If you have something you want to contribute to Shenanigans, you shoud
 reconsider and add it to Facets instead. This is a library for my own wonky
-ideas and I don’t think it will ever see any real usage.</p>
+ideas and I don&#39;t think it will ever see any real usage.</p>
 
-<h2 id="label-Authors">Authors</h2>
+<h2 id="label-Authors">Authors<span><a href="#label-Authors">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
 
 <p>This project was created by Michael Kohl. He can be reached via email at
 citizen428 at gmail.com.</p>
 
-<h2 id="label-License">License</h2>
+<h2 id="label-License">License<span><a href="#label-License">&para;</a> <a href="#documentation">&uarr;</a></span></h2>
 
 <p>Copyright © 2012 Michael Kohl</p>
 
@@ -167,13 +169,12 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 DEALINGS IN THE SOFTWARE.</p>
-
 </div>
 
 
 <footer id="validator-badges">
   <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
-  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
   <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
 </footer>
 

data/doc/js/darkfish.js

@@ -109,13 +109,15 @@ function hookSearch() {
 function highlightTarget( anchor ) {
   console.debug( "Highlighting target '%s'.", anchor );
 
-  $("a[name=" + anchor + "]").each( function() {
-    if ( !$(this).parent().parent().hasClass('target-section') ) {
-      console.debug( "Wrapping the target-section" );
-      $('div.method-detail').unwrap( 'div.target-section' );
-      $(this).parent().wrap( '<div class="target-section"></div>' );
-    } else {
-      console.debug( "Already wrapped." );
+  $("a[name]").each( function() {
+    if ( $(this).attr("name") == anchor ) {
+      if ( !$(this).parent().parent().hasClass('target-section') ) {
+        console.debug( "Wrapping the target-section" );
+        $('div.method-detail').unwrap( 'div.target-section' );
+        $(this).parent().wrap( '<div class="target-section"></div>' );
+      } else {
+        console.debug( "Already wrapped." );
+      }
     }
   });
 };

data/doc/js/search_index.js

@@ -1 +1 @@
-var search_data = {"index":{"searchIndex":["array","fixnum","hash","kernel","object","string","^()","d()","display()","extract()","fn()","has_shape?()","in_groups_of()","it()","prompt()","random_subarray()","string_length()","to_ostruct()","with()","zip_with()","readme"],"longSearchIndex":["array","fixnum","hash","kernel","object","string","array#^()","object#d()","object#display()","hash#extract()","kernel#fn()","hash#has_shape?()","string#in_groups_of()","object#it()","kernel#prompt()","array#random_subarray()","fixnum#string_length()","hash#to_ostruct()","kernel#with()","array#zip_with()",""],"info":[["Array","","Array.html","",""],["Fixnum","","Fixnum.html","",""],["Hash","","Hash.html","",""],["Kernel","","Kernel.html","",""],["Object","","Object.html","",""],["String","","String.html","",""],["^","Array","Array.html#method-i-5E","(other)","<p>Returns an array containing elements exclusive between two arrays.\n\n<pre class=\"ruby\">[<span class=\"ruby-value\">1</span>, <span class=\"ruby-value\">2</span>, <span class=\"ruby-value\">3</span>] <span class=\"ruby-operator\">^</span> [<span class=\"ruby-value\">1</span>, <span class=\"ruby-value\">2</span>, <span class=\"ruby-value\">4</span>]\n<span class=\"ruby-comment\">#=&gt; [3, 4]</span>\n</pre>\n"],["d","Object","Object.html#method-i-d","(new_line = true)",""],["display","Object","Object.html#method-i-display","(new_line = true)","<p>Outputs the object and also returns it. Will use <code>puts</code> if\n<code>new_line</code> is <code>true</code> and <code>print</code>\notherwise.\n\n<pre>&quot;foo&quot;.display ...</pre>\n"],["extract","Hash","Hash.html#method-i-extract","(*ks)","<p>Returns a new hash only with the specified keys (if present).\n\n<pre>hash = { a: 1, b: 2, c: 3 }\nhash.extract(:b, ...</pre>\n"],["fn","Kernel","Kernel.html#method-i-fn","(*funs)","<p>Composes a list of functions. Functions can be specified as symbols or\nlambdas.\n\n<pre>[&quot;foo bar&quot;, &quot;baz qux&quot;].map ...</pre>\n"],["has_shape?","Hash","Hash.html#method-i-has_shape-3F","(shape)","<p>Checks if a hash has a certain structure.\n\n<pre>h = { k1: 1, k2: &quot;1&quot; }\nh.has_shape?(k1: Fixnum, k2: String) ...</pre>\n"],["in_groups_of","String","String.html#method-i-in_groups_of","(size)","<p>Returns an array of the string broken down into groups of <code>size</code>\ncharacters.\n\n<pre class=\"ruby\"><span class=\"ruby-string\">&quot;aabbcc&quot;</span>.<span class=\"ruby-identifier\">in_groups_of</span>(<span class=\"ruby-value\">2</span>)\n<span class=\"ruby-comment\">#=&gt; ...</span>\n</pre>\n"],["it","Object","Object.html#method-i-it","()","<p>An identity method that provides access to an object’s <code>self</code>.\n\n<pre class=\"ruby\">[<span class=\"ruby-value\">1</span>,<span class=\"ruby-value\">2</span>,<span class=\"ruby-value\">3</span>,<span class=\"ruby-value\">4</span>,<span class=\"ruby-value\">5</span>,<span class=\"ruby-value\">1</span>,<span class=\"ruby-value\">2</span>,<span class=\"ruby-value\">2</span>,<span class=\"ruby-value\">3</span>].<span class=\"ruby-identifier\">group_by</span>(&amp;:<span class=\"ruby-identifier\">it</span>)\n<span class=\"ruby-comment\">#=&gt; {1=&gt;[1, ...</span>\n</pre>\n"],["prompt","Kernel","Kernel.html#method-i-prompt","(text='', conversion=nil)","<p>Displays a prompt and returns chomped input. Modelled after the Python\nmethod <code>raw_input</code>, but also can …\n"],["random_subarray","Array","Array.html#method-i-random_subarray","(n=1)","<p>Generates random subarrays. Uses random numbers and bit-fiddling to assure\nperformant uniform distributions …\n"],["string_length","Fixnum","Fixnum.html#method-i-string_length","()","<p>Returns the length of the number’s string representation.\n\n<pre class=\"ruby\"><span class=\"ruby-value\">0</span>.<span class=\"ruby-identifier\">string_length</span>\n<span class=\"ruby-comment\">#=&gt; 1</span>\n<span class=\"ruby-value\">123</span>.<span class=\"ruby-identifier\">string_length</span>\n<span class=\"ruby-comment\">#=&gt; ...</span>\n</pre>\n"],["to_ostruct","Hash","Hash.html#method-i-to_ostruct","()","<p>Recursively converts a <code>Hash</code> and all nested <code>Hash</code>es\nto <code>OpenStruct</code>s. Especially useful for parsing YAML …\n"],["with","Kernel","Kernel.html#method-i-with","(o, &blk)","<p>A Pascal/ActionScript like <code>with</code> method. Yields its argument to\nthe provided block and then returns it. …\n"],["zip_with","Array","Array.html#method-i-zip_with","(other, op=nil)","<p>Zip <code>self</code> with <code>other</code>, combining the elements with\nthe provided block or symbol. The resulting array will …\n"],["README","","README_rdoc.html","","<p>Shenanigans\n<p><strong>shenanigan</strong> (plural shenanigans):\n<p>Trickery, games; skulduggery. To “call”, “claim” …\n"]]}}
+var search_data = {"index":{"searchIndex":["array","fixnum","hash","kernel","module","object","string","^()","d()","display()","extract()","fn()","has_shape?()","in_groups_of()","it()","private_accessor()","prompt()","random_subarray()","require_optional()","string_length()","to_ostruct()","with()","zip_with()","readme"],"longSearchIndex":["array","fixnum","hash","kernel","module","object","string","array#^()","object#d()","object#display()","hash#extract()","kernel#fn()","hash#has_shape?()","string#in_groups_of()","object#it()","module#private_accessor()","kernel#prompt()","array#random_subarray()","kernel#require_optional()","fixnum#string_length()","hash#to_ostruct()","kernel#with()","array#zip_with()",""],"info":[["Array","","Array.html","",""],["Fixnum","","Fixnum.html","",""],["Hash","","Hash.html","",""],["Kernel","","Kernel.html","",""],["Module","","Module.html","",""],["Object","","Object.html","",""],["String","","String.html","",""],["^","Array","Array.html#method-i-5E","(other)","<p>Returns an array containing elements exclusive between two arrays.\n\n<pre class=\"ruby\">[<span class=\"ruby-value\">1</span>, <span class=\"ruby-value\">2</span>, <span class=\"ruby-value\">3</span>] <span class=\"ruby-operator\">^</span> [<span class=\"ruby-value\">1</span>, <span class=\"ruby-value\">2</span>, <span class=\"ruby-value\">4</span>]\n<span class=\"ruby-comment\">#=&gt; [3, 4]</span>\n</pre>\n"],["d","Object","Object.html#method-i-d","(new_line = true)",""],["display","Object","Object.html#method-i-display","(new_line = true)","<p>Outputs the object and also returns it. Will use <code>puts</code> if\n<code>new_line</code> is <code>true</code> and <code>print</code>\notherwise.\n\n<pre>&quot;foo&quot;.display ...</pre>\n"],["extract","Hash","Hash.html#method-i-extract","(*ks)","<p>Returns a new hash only with the specified keys (if present).\n\n<pre>hash = { a: 1, b: 2, c: 3 }\nhash.extract(:b, ...</pre>\n"],["fn","Kernel","Kernel.html#method-i-fn","(*funs)","<p>Composes a list of functions. Functions can be specified as symbols or\nlambdas.\n\n<pre>[&quot;foo bar&quot;, &quot;baz qux&quot;].map ...</pre>\n"],["has_shape?","Hash","Hash.html#method-i-has_shape-3F","(shape)","<p>Checks if a hash has a certain structure.\n\n<pre>h = { k1: 1, k2: &quot;1&quot; }\nh.has_shape?(k1: Fixnum, k2: String) ...</pre>\n"],["in_groups_of","String","String.html#method-i-in_groups_of","(size)","<p>Returns an array of the string broken down into groups of <code>size</code>\ncharacters.\n\n<pre class=\"ruby\"><span class=\"ruby-string\">&quot;aabbcc&quot;</span>.<span class=\"ruby-identifier\">in_groups_of</span>(<span class=\"ruby-value\">2</span>)\n<span class=\"ruby-comment\">#=&gt; ...</span>\n</pre>\n"],["it","Object","Object.html#method-i-it","()","<p>An identity method that provides access to an object&#39;s\n<code>self</code>.\n\n<pre class=\"ruby\">[<span class=\"ruby-value\">1</span>,<span class=\"ruby-value\">2</span>,<span class=\"ruby-value\">3</span>,<span class=\"ruby-value\">4</span>,<span class=\"ruby-value\">5</span>,<span class=\"ruby-value\">1</span>,<span class=\"ruby-value\">2</span>,<span class=\"ruby-value\">2</span>,<span class=\"ruby-value\">3</span>].<span class=\"ruby-identifier\">group_by</span>(<span class=\"ruby-operator\">&amp;</span>:<span class=\"ruby-identifier\">it</span>)\n<span class=\"ruby-comment\">#=&gt; ...</span>\n</pre>\n"],["private_accessor","Module","Module.html#method-i-private_accessor","(*names)","<p>Works like <code>attr_accessor</code> but generates private getter/setter\nmethods for class internal use only. Useful …\n"],["prompt","Kernel","Kernel.html#method-i-prompt","(text='', conversion=nil)","<p>Displays a prompt and returns chomped input. Modelled after the Python\nmethod <code>raw_input</code>, but also can …\n"],["random_subarray","Array","Array.html#method-i-random_subarray","(n=1)","<p>Generates random subarrays. Uses random numbers and bit-fiddling to assure\nperformant uniform distributions …\n"],["require_optional","Kernel","Kernel.html#method-i-require_optional","(gem, &block)","<p>Optionally require a gem. If it is not available, <code>nil</code> will be\nreturned. Alternatively, a block can be …\n"],["string_length","Fixnum","Fixnum.html#method-i-string_length","()","<p>Returns the length of the number&#39;s string representation.\n\n<pre class=\"ruby\"><span class=\"ruby-value\">0</span>.<span class=\"ruby-identifier\">string_length</span>\n<span class=\"ruby-comment\">#=&gt; 1</span>\n<span class=\"ruby-value\">123</span>.<span class=\"ruby-identifier\">string_length</span> <span class=\"ruby-operator\">...</span>\n</pre>\n"],["to_ostruct","Hash","Hash.html#method-i-to_ostruct","()","<p>Recursively converts a <code>Hash</code> and all nested <code>Hash</code>es\nto <code>OpenStruct</code>s. Especially useful for parsing YAML …\n"],["with","Kernel","Kernel.html#method-i-with","(o, &blk)","<p>A Pascal/ActionScript like <code>with</code> method. Yields its argument to\nthe provided block and then returns it. …\n"],["zip_with","Array","Array.html#method-i-zip_with","(other, op=nil)","<p>Zip <code>self</code> with <code>other</code>, combining the elements with\nthe provided block or symbol. The resulting array will …\n"],["README","","README_rdoc.html","","<p>Shenanigans\n<p><strong>shenanigan</strong> (plural shenanigans):\n<p>Trickery, games; skulduggery. To “call”, “claim” …\n"]]}}

data/doc/rdoc.css

@@ -6,6 +6,7 @@
  *
  */
 
+/* vim: ft=css et sw=2 ts=2 sts=2 */
 /* Base Green is: #6C8C22 */
 
 * { padding: 0; margin: 0; }
@@ -27,6 +28,27 @@ h1 {
 }
 h2,h3,h4 { margin-top: 1.5em; }
 
+h1 span,
+h2 span,
+h3 span,
+h4 span,
+h5 span,
+h6 span {
+  display: none;
+  padding-left: 1em;
+  font-size: 50%;
+  vertical-align: super;
+}
+
+h1:hover span,
+h2:hover span,
+h3:hover span,
+h4:hover span,
+h5:hover span,
+h6:hover span {
+  display: inline;
+}
+
 :link,
 :visited {
   color: #6C8C22;
@@ -42,6 +64,16 @@ pre {
   padding: 0.5em 0;
 }
 
+blockquote {
+  background: #ddd;
+  margin: 1em;
+  padding: 0.25em;
+}
+
+blockquote > :first-child {
+  margin-top: 0 !important;
+}
+
 /* @group Generic Classes */
 
 .initially-hidden {
@@ -193,6 +225,15 @@ pre {
   list-style-image: url(images/page_green.png);
 }
 
+#table-of-contents {
+  margin-top: 2em;
+}
+
+#table-of-contents ul {
+  padding-left: 28px;
+  list-style-image: url(images/tag_blue.png);
+}
+
 dl.svninfo {
   color: #666;
   margin: 0;
@@ -203,7 +244,9 @@ dl.svninfo dt {
 
 ul.link-list li {
   white-space: nowrap;
+  line-height: 20px;
 }
+
 ul.link-list .type {
   font-size: 8px;
   text-transform: uppercase;
@@ -213,6 +256,10 @@ ul.link-list .type {
   -webkit-border-radius: 5px;
 }
 
+.calls-super {
+  background: url(images/arrow_up.png) no-repeat right center;
+}
+
 /* @end */
 
 /* @group Class Metadata Section */
@@ -385,6 +432,11 @@ ul.link-list .type {
   display: none;
 }
 
+#documentation .method-description .method-calls-super {
+  color: #333;
+  font-weight: bolder;
+}
+
 #documentation .method-detail {
   margin: 0.5em 0;
   padding: 0.5em 0;

data/doc/table_of_contents.html

@@ -55,6 +55,9 @@
   </li>
     <li class="module">
     <a href="Kernel.html">Kernel</a>
+  </li>
+    <li class="class">
+    <a href="Module.html">Module</a>
   </li>
     <li class="class">
     <a href="Object.html">Object</a>
@@ -84,10 +87,14 @@
   
     <li class="method"><a href="Object.html#method-i-it">#it &mdash; Object</a>
   
+    <li class="method"><a href="Module.html#method-i-private_accessor">#private_accessor &mdash; Module</a>
+  
     <li class="method"><a href="Kernel.html#method-i-prompt">#prompt &mdash; Kernel</a>
   
     <li class="method"><a href="Array.html#method-i-random_subarray">#random_subarray &mdash; Array</a>
   
+    <li class="method"><a href="Kernel.html#method-i-require_optional">#require_optional &mdash; Kernel</a>
+  
     <li class="method"><a href="Fixnum.html#method-i-string_length">#string_length &mdash; Fixnum</a>
   
     <li class="method"><a href="Hash.html#method-i-to_ostruct">#to_ostruct &mdash; Hash</a>
@@ -101,7 +108,7 @@
 
 <footer id="validator-badges">
   <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
-  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
+  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
   <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
 </footer>
 

data/lib/shenanigans/kernel.rb

@@ -1,3 +1,4 @@
 require_relative "kernel/fn"
 require_relative "kernel/prompt"
 require_relative "kernel/with"
+require_relative "kernel/require_optional"

data/lib/shenanigans/kernel/fn.rb

@@ -13,4 +13,6 @@ module Kernel
       end
     end
   end
+
+  private :fn
 end

data/lib/shenanigans/kernel/prompt.rb

@@ -20,4 +20,5 @@ module Kernel
     CONVERSIONS.include?(conversion) ? input.send(conversion) : input
   end
 
+  private :prompt
 end

data/lib/shenanigans/kernel/require_optional.rb

@@ -0,0 +1,19 @@
+module Kernel
+  # Optionally require a gem. If it is not available, <tt>nil</tt>
+  # will be returned. Alternatively, a block can be provided with code
+  # to run.
+  #   require 'non_existent'
+  #   #=> nil
+  #
+  #   require 'non_existent' do
+  #     puts 'Something went wrong'
+  #   end
+  #   #=> Outputs 'Something went wrong'
+  def require_optional(gem, &block)
+    require gem
+  rescue LoadError
+    block.call if block
+  end
+
+  private :require_optional
+end

data/lib/shenanigans/kernel/with.rb

@@ -9,4 +9,6 @@ module Kernel
   def with(o, &blk)
     o.tap(&blk)
   end
+
+  private :with
 end

data/lib/shenanigans/module/private_accessor.rb

@@ -1,9 +1,9 @@
 class Module
-  private
-
   # Works like <tt>attr_accessor</tt> but generates private
   # getter/setter methods for class internal use only. Useful
   # for enforcing Smalltalk-style internal encapsulation.
+  #
+  # For a more complete implementation of a similar feature see {ivar_encapsulation}[https://github.com/citizen428/ivar_encapsulation].
   def private_accessor(*names)
     names.each do |name|
       instance_var_name = "@#{name}"
@@ -21,4 +21,6 @@ class Module
     end
     nil # like attr_accessor
   end
+
+  private :private_accessor
 end

data/test/kernel/test_require_optional.rb

@@ -0,0 +1,17 @@
+require 'minitest/autorun'
+require 'shenanigans/kernel/require_optional'
+require 'stringio'
+
+class RequireOptional < MiniTest::Unit::TestCase
+  def test_require_optional
+    assert_equal require_optional('non_existent'), nil
+  end
+
+  def test_require_optional_with_block
+    res = require_optional 'non_existent' do
+      42
+    end
+
+    assert_equal res, 42
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shenanigans
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Michael Kohl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-11 00:00:00.000000000 Z
+date: 2013-11-06 00:00:00.000000000 Z
 dependencies: []
 description: A collection of extensions for various Ruby core classes.
 email: citizen428@gmail.com
@@ -45,7 +45,9 @@ files:
 - doc/images/bullet_toggle_plus.png
 - doc/images/loadingAnimation.gif
 - doc/images/add.png
+- doc/images/arrow_up.png
 - doc/images/macFFBgHack.png
+- doc/Module.html
 - doc/index.html
 - doc/table_of_contents.html
 - doc/rdoc.css
@@ -64,11 +66,11 @@ files:
 - lib/shenanigans/fixnum/string_length.rb
 - lib/shenanigans/object.rb
 - lib/shenanigans/kernel.rb
-- lib/shenanigans/README.mdown
 - lib/shenanigans/string.rb
 - lib/shenanigans/kernel/prompt.rb
 - lib/shenanigans/kernel/fn.rb
 - lib/shenanigans/kernel/with.rb
+- lib/shenanigans/kernel/require_optional.rb
 - lib/shenanigans/array.rb
 - lib/shenanigans/array/zip_with.rb
 - lib/shenanigans/array/caret.rb
@@ -87,6 +89,7 @@ files:
 - test/kernel/test_prompt.rb
 - test/kernel/test_with.rb
 - test/kernel/test_fn.rb
+- test/kernel/test_require_optional.rb
 - test/array/test_zip_with.rb
 - test/array/test_random_subarray.rb
 - test/array/test_caret.rb
@@ -123,3 +126,4 @@ signing_key:
 specification_version: 4
 summary: Think Facets, just less useful
 test_files: []
+has_rdoc: