shenanigans 1.0.3 → 1.0.4

data/doc/Array.html

@@ -47,6 +47,7 @@
     <nav id="file-list-section" class="section">
   <h3 class="section-header">Defined In</h3>
   <ul>
+    <li>lib/shenanigans/array/caret.rb
     <li>lib/shenanigans/array/random_subarray.rb
     <li>lib/shenanigans/array/zip_with.rb
   </ul>
@@ -71,6 +72,8 @@
 
   <ul class="link-list">
     
+    <li><a href="#method-i-5E">#^</a>
+    
     <li><a href="#method-i-random_subarray">#random_subarray</a>
     
     <li><a href="#method-i-zip_with">#zip_with</a>
@@ -135,6 +138,40 @@
       <h3 class="section-header">Public Instance Methods</h3>
 
     
+      <div id="method-i-5E" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">^</span><span
+            class="method-args">(other)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Returns an array containing elements exclusive between two arrays.</p>
+
+<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>]
+<span class="ruby-comment">#=&gt; [3, 4]</span>
+</pre>
+          
+
+          
+          <div class="method-source-code" id="5E-source">
+            <pre><span class="ruby-comment"># File lib/shenanigans/array/caret.rb, line 5</span>
+<span class="ruby-keyword">def</span> <span class="ruby-operator">^</span>(<span class="ruby-identifier">other</span>)
+  (<span class="ruby-keyword">self</span> <span class="ruby-operator">|</span> <span class="ruby-identifier">other</span>) <span class="ruby-operator">-</span> (<span class="ruby-keyword">self</span> &amp; <span class="ruby-identifier">other</span>)
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- 5E-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- 5E-method -->
+
+    
       <div id="method-i-random_subarray" class="method-detail ">
         
         <div class="method-heading">

data/doc/Hash.html

@@ -115,27 +115,6 @@
 
   <div id="description" class="description">
     
-<p>Recursively converts a <code>Hash</code> and all nested <code>Hash</code>es
-to <code>OpenStruct</code>s. Especially useful for parsing YAML.</p>
-
-<pre class="ruby"><span class="ruby-identifier">yaml</span>=<span class="ruby-string">&quot;subject: Programming Languages
-languages:
-  - name        : Ruby
-    creator     : Matz
-  - name        : Python
-    creator     : Guido van Rossum
-  - name        : Perl
-    creator     : Larry Wall
-&quot;</span>
-<span class="ruby-identifier">struct</span> = <span class="ruby-constant">YAML</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">yaml</span>).<span class="ruby-identifier">to_ostruct</span>
-<span class="ruby-identifier">struct</span>.<span class="ruby-identifier">subject</span>
-<span class="ruby-comment">#=&gt; &quot;Programming Languages&quot;</span>
-<span class="ruby-identifier">struct</span>.<span class="ruby-identifier">languages</span>.<span class="ruby-identifier">first</span>
-<span class="ruby-comment">#=&gt; #&lt;OpenStruct name=&quot;Ruby&quot;, creator=&quot;Matz&quot;&gt;</span>
-<span class="ruby-identifier">struct</span>.<span class="ruby-identifier">languages</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">creator</span>
-<span class="ruby-comment">#=&gt; &quot;Matz&quot;</span>
-</pre>
-
   </div><!-- description -->
 
   
@@ -214,17 +193,36 @@ languages:
 
         <div class="method-description">
           
-          
+          <p>Recursively converts a <code>Hash</code> and all nested <code>Hash</code>es
+to <code>OpenStruct</code>s. Especially useful for parsing YAML.</p>
+
+<pre class="ruby"><span class="ruby-identifier">yaml</span>=<span class="ruby-string">&quot;subject: Programming Languages
+languages:
+  - name        : Ruby
+    creator     : Matz
+  - name        : Python
+    creator     : Guido van Rossum
+  - name        : Perl
+    creator     : Larry Wall
+&quot;</span>
+<span class="ruby-identifier">struct</span> = <span class="ruby-constant">YAML</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">yaml</span>).<span class="ruby-identifier">to_ostruct</span>
+<span class="ruby-identifier">struct</span>.<span class="ruby-identifier">subject</span>
+<span class="ruby-comment">#=&gt; &quot;Programming Languages&quot;</span>
+<span class="ruby-identifier">struct</span>.<span class="ruby-identifier">languages</span>.<span class="ruby-identifier">first</span>
+<span class="ruby-comment">#=&gt; #&lt;OpenStruct name=&quot;Ruby&quot;, creator=&quot;Matz&quot;&gt;</span>
+<span class="ruby-identifier">struct</span>.<span class="ruby-identifier">languages</span>.<span class="ruby-identifier">first</span>.<span class="ruby-identifier">creator</span>
+<span class="ruby-comment">#=&gt; &quot;Matz&quot;</span>
+</pre>
           
 
           
           <div class="method-source-code" id="to_ostruct-source">
-            <pre><span class="ruby-comment"># File lib/shenanigans/hash/to_ostruct.rb, line 24</span>
+            <pre><span class="ruby-comment"># File lib/shenanigans/hash/to_ostruct.rb, line 23</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">to_ostruct</span>
   <span class="ruby-identifier">arr</span> = <span class="ruby-identifier">map</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
     <span class="ruby-keyword">case</span> <span class="ruby-identifier">v</span>
     <span class="ruby-keyword">when</span> <span class="ruby-constant">Hash</span>
-      [<span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span>.<span class="ruby-identifier">to_open_struct</span>]
+      [<span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span>.<span class="ruby-identifier">to_ostruct</span>]
     <span class="ruby-keyword">when</span> <span class="ruby-constant">Array</span>
       [<span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span>.<span class="ruby-identifier">map</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">el</span><span class="ruby-operator">|</span> <span class="ruby-constant">Hash</span> <span class="ruby-operator">===</span> <span class="ruby-identifier">el</span> <span class="ruby-operator">?</span> <span class="ruby-identifier">el</span>.<span class="ruby-identifier">to_ostruct</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">el</span> }]
     <span class="ruby-keyword">else</span>

data/doc/created.rid

@@ -1,10 +1,11 @@
-Thu, 21 Jun 2012 19:19:16 +0200
+Thu, 28 Jun 2012 09:01:37 +0200
 README.rdoc	Thu, 17 May 2012 11:45:08 +0200
+lib/shenanigans/array/caret.rb	Thu, 28 Jun 2012 09:01:33 +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	Wed, 16 May 2012 20:09:21 +0200
+lib/shenanigans/array.rb	Thu, 28 Jun 2012 09:00:29 +0200
 lib/shenanigans/hash/has_shape_pred.rb	Tue, 19 Jun 2012 21:25:03 +0200
-lib/shenanigans/hash/to_ostruct.rb	Thu, 21 Jun 2012 19:19:11 +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/kernel/fn.rb	Wed, 16 May 2012 23:57:36 +0200
 lib/shenanigans/kernel/prompt.rb	Thu, 17 May 2012 00:10:42 +0200

data/doc/js/search_index.js

@@ -1 +1 @@
-var search_data = {"index":{"searchIndex":["array","hash","kernel","object","d()","display()","fn()","has_shape?()","identity()","prompt()","random_subarray()","to_ostruct()","with()","zip_with()","readme"],"longSearchIndex":["array","hash","kernel","object","object#d()","object#display()","kernel#fn()","hash#has_shape?()","object#identity()","kernel#prompt()","array#random_subarray()","hash#to_ostruct()","kernel#with()","array#zip_with()",""],"info":[["Array","","Array.html","",""],["Hash","","Hash.html","","<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"],["Kernel","","Kernel.html","",""],["Object","","Object.html","",""],["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"],["identity","Object","Object.html#method-i-identity","()","<p>An identity method that provides access to an object’s <code>self</code>.\n\n<pre>[1,2,3,4,5,1,2,2,3].group_by(&amp;:identity) ...</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"],["to_ostruct","Hash","Hash.html#method-i-to_ostruct","()",""],["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","hash","kernel","object","^()","d()","display()","fn()","has_shape?()","identity()","prompt()","random_subarray()","to_ostruct()","with()","zip_with()","readme"],"longSearchIndex":["array","hash","kernel","object","array#^()","object#d()","object#display()","kernel#fn()","hash#has_shape?()","object#identity()","kernel#prompt()","array#random_subarray()","hash#to_ostruct()","kernel#with()","array#zip_with()",""],"info":[["Array","","Array.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"],["identity","Object","Object.html#method-i-identity","()","<p>An identity method that provides access to an object’s <code>self</code>.\n\n<pre>[1,2,3,4,5,1,2,2,3].group_by(&amp;:identity) ...</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"],["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

@@ -62,6 +62,8 @@
 <h2 id="methods">Methods</h2>
 <ul>
   
+    <li class="method"><a href="Array.html#method-i-5E">#^ &mdash; Array</a>
+  
     <li class="method"><a href="Object.html#method-i-d">#d &mdash; Object</a>
   
     <li class="method"><a href="Object.html#method-i-display">#display &mdash; Object</a>

data/lib/shenanigans/array.rb

@@ -1,2 +1,3 @@
+require_relative "array/caret"
 require_relative "array/random_subarray"
 require_relative "array/zip_with"

data/lib/shenanigans/array/caret.rb

@@ -0,0 +1,8 @@
+class Array
+  # Returns an array containing elements exclusive between two arrays.
+  #   [1, 2, 3] ^ [1, 2, 4]
+  #   #=> [3, 4]
+  def ^(other)
+    (self | other) - (self & other)
+  end
+end

data/lib/shenanigans/hash/to_ostruct.rb

@@ -1,26 +1,25 @@
 require 'ostruct'
 
-# Recursively converts a <tt>Hash</tt> and all nested <tt>Hash</tt>es to
-# <tt>OpenStruct</tt>s. Especially useful for parsing YAML.
-#     yaml=<<EOY
-#     subject: Programming Languages
-#     languages:
-#       - name        : Ruby
-#         creator     : Matz
-#       - name        : Python
-#         creator     : Guido van Rossum
-#       - name        : Perl
-#         creator     : Larry Wall
-#     EOY
-#     struct = YAML.load(yaml).to_ostruct
-#     struct.subject
-#     #=> "Programming Languages"
-#     struct.languages.first
-#     #=> #<OpenStruct name="Ruby", creator="Matz">
-#     struct.languages.first.creator
-#     #=> "Matz"
-
 class Hash
+  # Recursively converts a <tt>Hash</tt> and all nested <tt>Hash</tt>es to
+  # <tt>OpenStruct</tt>s. Especially useful for parsing YAML.
+  #     yaml=<<EOY
+  #     subject: Programming Languages
+  #     languages:
+  #       - name        : Ruby
+  #         creator     : Matz
+  #       - name        : Python
+  #         creator     : Guido van Rossum
+  #       - name        : Perl
+  #         creator     : Larry Wall
+  #     EOY
+  #     struct = YAML.load(yaml).to_ostruct
+  #     struct.subject
+  #     #=> "Programming Languages"
+  #     struct.languages.first
+  #     #=> #<OpenStruct name="Ruby", creator="Matz">
+  #     struct.languages.first.creator
+  #     #=> "Matz"
   def to_ostruct
     arr = map do |k, v|
       case v

data/lib/shenanigans/object.rb

@@ -1,2 +1,2 @@
-require_relative "object/identity"
+require_relative "object/it"
 require_relative "object/display"

data/lib/shenanigans/object/{identity.rb → it.rb}

@@ -1,9 +1,9 @@
 class Object
   # An identity method that provides access to an object's
   # <tt>self</tt>.
-  #  [1,2,3,4,5,1,2,2,3].group_by(&:identity)
+  #  [1,2,3,4,5,1,2,2,3].group_by(&:it)
   #  #=> {1=>[1, 1], 2=>[2, 2, 2], 3=>[3, 3], 4=>[4], 5=>[5]}
-  def identity
+  def it
     self
   end
 end

data/test/array/test_caret.rb

@@ -0,0 +1,9 @@
+require 'minitest/autorun'
+require 'shenanigans/array/caret'
+
+class ArrayCaret < MiniTest::Unit::TestCase
+  def test_caret
+    result = [1, 2, 3] ^ [1, 2, 4]
+    assert result == [3, 4]
+  end
+end

data/test/object/test_it.rb

@@ -0,0 +1,10 @@
+require 'minitest/autorun'
+require 'shenanigans/object/it'
+
+class Identity < MiniTest::Unit::TestCase
+  def test_identity
+    arr = [1, "2", :tree]
+    assert arr.map(&:it) == arr
+    assert [1,1,2,3].group_by(&:it) == {1 => [1, 1], 2 => [2], 3 => [3]}
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shenanigans
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-21 00:00:00.000000000 Z
+date: 2012-06-28 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: citizen428@gmail.com
@@ -59,6 +59,7 @@ files:
 - doc/rdoc.css
 - doc/README_rdoc.html
 - doc/table_of_contents.html
+- lib/shenanigans/array/caret.rb
 - lib/shenanigans/array/random_subarray.rb
 - lib/shenanigans/array/zip_with.rb
 - lib/shenanigans/array.rb
@@ -70,11 +71,12 @@ files:
 - lib/shenanigans/kernel/with.rb
 - lib/shenanigans/kernel.rb
 - lib/shenanigans/object/display.rb
-- lib/shenanigans/object/identity.rb
+- lib/shenanigans/object/it.rb
 - lib/shenanigans/object.rb
 - lib/shenanigans/README.mdown
 - lib/shenanigans/shenanigans-0.0.1.gem
 - lib/shenanigans.rb
+- test/array/test_caret.rb
 - test/array/test_random_subarray.rb
 - test/array/test_zip_with.rb
 - test/hash/test_has_shape_pred.rb
@@ -83,7 +85,7 @@ files:
 - test/kernel/test_prompt.rb
 - test/kernel/test_with.rb
 - test/object/test_display.rb
-- test/object/test_identity.rb
+- test/object/test_it.rb
 homepage: https://github.com/citizen428/shenanigans
 licenses: []
 post_install_message: 

data/test/object/test_identity.rb

@@ -1,9 +0,0 @@
-require 'minitest/autorun'
-require 'shenanigans/object/identity'
-
-class Identity < MiniTest::Unit::TestCase
-  def test_identity
-    arr = [1, "2", :tree]
-    assert arr.map(&:identity) == arr
-  end
-end