shenanigans 1.0.5 → 1.0.6

data/doc/Fixnum.html

@@ -145,7 +145,7 @@
 
         <div class="method-description">
           
-          <p>Returns the lenth of the number’s string representation</p>
+          <p>Returns the length of the number’s string representation.</p>
 
 <pre class="ruby"><span class="ruby-value">0</span>.<span class="ruby-identifier">string_length</span>
 <span class="ruby-comment">#=&gt; 1</span>

data/doc/Hash.html

@@ -47,6 +47,7 @@
     <nav id="file-list-section" class="section">
   <h3 class="section-header">Defined In</h3>
   <ul>
+    <li>lib/shenanigans/hash/extract.rb
     <li>lib/shenanigans/hash/has_shape_pred.rb
     <li>lib/shenanigans/hash/to_ostruct.rb
   </ul>
@@ -71,6 +72,8 @@
 
   <ul class="link-list">
     
+    <li><a href="#method-i-extract">#extract</a>
+    
     <li><a href="#method-i-has_shape-3F">#has_shape?</a>
     
     <li><a href="#method-i-to_ostruct">#to_ostruct</a>
@@ -137,6 +140,44 @@
       <h3 class="section-header">Public Instance Methods</h3>
 
     
+      <div id="method-i-extract" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">extract</span><span
+            class="method-args">(*ks)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Returns a new hash only with the specified keys (if present).</p>
+
+<pre class="ruby"><span class="ruby-identifier">hash</span> = { <span class="ruby-identifier">a</span><span class="ruby-operator">:</span> <span class="ruby-value">1</span>, <span class="ruby-identifier">b</span><span class="ruby-operator">:</span> <span class="ruby-value">2</span>, <span class="ruby-identifier">c</span><span class="ruby-operator">:</span> <span class="ruby-value">3</span> }
+<span class="ruby-identifier">hash</span>.<span class="ruby-identifier">extract</span>(:<span class="ruby-identifier">b</span>, :<span class="ruby-identifier">a</span>)
+<span class="ruby-comment">#=&gt; { a: 1, b: 2 }</span>
+<span class="ruby-identifier">hash</span>.<span class="ruby-identifier">extract</span>(:<span class="ruby-identifier">a</span>, :<span class="ruby-identifier">d</span>)
+<span class="ruby-comment">#=&gt; { a: 1}</span>
+</pre>
+          
+
+          
+          <div class="method-source-code" id="extract-source">
+            <pre><span class="ruby-comment"># File lib/shenanigans/hash/extract.rb, line 8</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">extract</span>(*<span class="ruby-identifier">ks</span>)
+  <span class="ruby-identifier">existing</span> = <span class="ruby-identifier">keys</span> &amp; <span class="ruby-identifier">ks</span>
+  <span class="ruby-constant">Hash</span>[<span class="ruby-identifier">existing</span>.<span class="ruby-identifier">zip</span>(<span class="ruby-identifier">values_at</span>(*<span class="ruby-identifier">existing</span>))]
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- extract-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- extract-method -->
+
+    
       <div id="method-i-has_shape-3F" class="method-detail ">
         
         <div class="method-heading">

data/doc/created.rid

@@ -1,14 +1,15 @@
-Sun, 15 Jul 2012 00:00:08 +0200
+Thu, 09 Aug 2012 18:48:00 +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:03 +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	Tue, 26 Jun 2012 21:24:42 +0200
-lib/shenanigans/hash.rb	Thu, 21 Jun 2012 19:13:44 +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

data/doc/js/search_index.js

@@ -1 +1 @@
-var search_data = {"index":{"searchIndex":["array","fixnum","hash","kernel","object","^()","d()","display()","fn()","has_shape?()","it()","prompt()","random_subarray()","string_length()","to_ostruct()","with()","zip_with()","readme"],"longSearchIndex":["array","fixnum","hash","kernel","object","array#^()","object#d()","object#display()","kernel#fn()","hash#has_shape?()","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","",""],["^","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"],["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"],["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 lenth 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; 3 ...</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","object","^()","d()","display()","extract()","fn()","has_shape?()","it()","prompt()","random_subarray()","string_length()","to_ostruct()","with()","zip_with()","readme"],"longSearchIndex":["array","fixnum","hash","kernel","object","array#^()","object#d()","object#display()","hash#extract()","kernel#fn()","hash#has_shape?()","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","",""],["^","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"],["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"]]}}

data/doc/table_of_contents.html

@@ -71,6 +71,8 @@
   
     <li class="method"><a href="Object.html#method-i-display">#display &mdash; Object</a>
   
+    <li class="method"><a href="Hash.html#method-i-extract">#extract &mdash; Hash</a>
+  
     <li class="method"><a href="Kernel.html#method-i-fn">#fn &mdash; Kernel</a>
   
     <li class="method"><a href="Hash.html#method-i-has_shape-3F">#has_shape? &mdash; Hash</a>

data/lib/shenanigans/hash.rb

@@ -1,2 +1,3 @@
+require_relative 'hash/extract'
 require_relative 'hash/has_shape_pred'
 require_relative 'hash/to_ostruct'

data/lib/shenanigans/hash/extract.rb

@@ -0,0 +1,12 @@
+class Hash
+  # Returns a new hash only with the specified keys (if present).
+  #   hash = { a: 1, b: 2, c: 3 }
+  #   hash.extract(:b, :a)
+  #   #=> { a: 1, b: 2 }
+  #   hash.extract(:a, :d)
+  #   #=> { a: 1}
+  def extract(*ks)
+    existing = keys & ks
+    Hash[existing.zip(values_at(*existing))]
+  end
+end

data/test/hash/test_extract.rb

@@ -0,0 +1,11 @@
+require 'minitest/autorun'
+require 'shenanigans/hash/extract'
+
+class Extract < MiniTest::Unit::TestCase
+  def test_extract
+    hash = { a: 1, b: 2, c: 3 }
+    assert_equal hash.extract(:b, :a), { a: 1, b: 2 }
+    assert_equal hash.extract(:a, :d), { a: 1}
+    assert_equal Hash.new.extract(:a, :c), Hash.new
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shenanigans
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-14 00:00:00.000000000 Z
+date: 2012-08-09 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: citizen428@gmail.com
@@ -66,6 +66,7 @@ files:
 - lib/shenanigans/array.rb
 - lib/shenanigans/fixnum/string_length.rb
 - lib/shenanigans/fixnum.rb
+- lib/shenanigans/hash/extract.rb
 - lib/shenanigans/hash/has_shape_pred.rb
 - lib/shenanigans/hash/to_ostruct.rb
 - lib/shenanigans/hash.rb
@@ -82,6 +83,7 @@ files:
 - test/array/test_random_subarray.rb
 - test/array/test_zip_with.rb
 - test/fixnum/test_string_length.rb
+- test/hash/test_extract.rb
 - test/hash/test_has_shape_pred.rb
 - test/hash/test_to_ostruct.rb
 - test/kernel/test_fn.rb