shenanigans 1.0.2 → 1.0.3

data/doc/Hash.html

@@ -48,6 +48,7 @@
   <h3 class="section-header">Defined In</h3>
   <ul>
     <li>lib/shenanigans/hash/has_shape_pred.rb
+    <li>lib/shenanigans/hash/to_ostruct.rb
   </ul>
 </nav>
 
@@ -72,6 +73,8 @@
     
     <li><a href="#method-i-has_shape-3F">#has_shape?</a>
     
+    <li><a href="#method-i-to_ostruct">#to_ostruct</a>
+    
   </ul>
 </nav>
 
@@ -112,6 +115,27 @@
 
   <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 -->
 
   
@@ -179,6 +203,46 @@
       </div><!-- has_shape-3F-method -->
 
     
+      <div id="method-i-to_ostruct" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">to_ostruct</span><span
+            class="method-args">()</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        
+
+        <div class="method-description">
+          
+          
+          
+
+          
+          <div class="method-source-code" id="to_ostruct-source">
+            <pre><span class="ruby-comment"># File lib/shenanigans/hash/to_ostruct.rb, line 24</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-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>
+      [<span class="ruby-identifier">k</span>, <span class="ruby-identifier">v</span>]
+    <span class="ruby-keyword">end</span>
+  <span class="ruby-keyword">end</span>
+  <span class="ruby-constant">OpenStruct</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">arr</span>)
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- to_ostruct-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- to_ostruct-method -->
+
+    
     </section><!-- public-instance-method-details -->
   
   </section><!-- 5Buntitled-5D -->

data/doc/created.rid

@@ -1,10 +1,11 @@
-Tue, 19 Jun 2012 21:25:09 +0200
+Thu, 21 Jun 2012 19:19:16 +0200
 README.rdoc	Thu, 17 May 2012 11:45:08 +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/hash/has_shape_pred.rb	Tue, 19 Jun 2012 21:25:03 +0200
-lib/shenanigans/hash.rb	Tue, 19 Jun 2012 21:04:00 +0200
+lib/shenanigans/hash/to_ostruct.rb	Thu, 21 Jun 2012 19:19:11 +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
 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","hash","kernel","object","d()","display()","fn()","has_shape?()","identity()","prompt()","random_subarray()","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()","kernel#with()","array#zip_with()",""],"info":[["Array","","Array.html","",""],["Hash","","Hash.html","",""],["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"],["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","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"]]}}

data/doc/table_of_contents.html

@@ -76,6 +76,8 @@
   
     <li class="method"><a href="Array.html#method-i-random_subarray">#random_subarray &mdash; Array</a>
   
+    <li class="method"><a href="Hash.html#method-i-to_ostruct">#to_ostruct &mdash; Hash</a>
+  
     <li class="method"><a href="Kernel.html#method-i-with">#with &mdash; Kernel</a>
   
     <li class="method"><a href="Array.html#method-i-zip_with">#zip_with &mdash; Array</a>

data/lib/shenanigans/hash/to_ostruct.rb

@@ -0,0 +1,37 @@
+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
+  def to_ostruct
+    arr = map do |k, v|
+      case v
+      when Hash
+        [k, v.to_ostruct]
+      when Array
+        [k, v.map { |el| Hash === el ? el.to_ostruct : el }]
+      else
+        [k, v]
+      end
+    end
+    OpenStruct.new(arr)
+  end
+end

data/lib/shenanigans/hash.rb

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

data/test/hash/test_to_ostruct.rb

@@ -0,0 +1,19 @@
+require 'minitest/autorun'
+require 'shenanigans/hash/to_ostruct'
+
+class ToOstruct < MiniTest::Unit::TestCase
+  def test_simple_hash
+    struct = {a: 1, b: 2}.to_ostruct
+    assert struct.b == 2
+  end
+
+  def test_nested_hash
+    struct = {a: 1, b: {c: 3}}.to_ostruct
+    assert struct.b.c == 3
+  end
+
+  def test_nested_array
+    struct = {a: 1, b: [{c: 2}]}.to_ostruct
+    assert struct.b.first.c == 2
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shenanigans
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-19 00:00:00.000000000 Z
+date: 2012-06-21 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: citizen428@gmail.com
@@ -63,6 +63,7 @@ files:
 - lib/shenanigans/array/zip_with.rb
 - lib/shenanigans/array.rb
 - lib/shenanigans/hash/has_shape_pred.rb
+- lib/shenanigans/hash/to_ostruct.rb
 - lib/shenanigans/hash.rb
 - lib/shenanigans/kernel/fn.rb
 - lib/shenanigans/kernel/prompt.rb
@@ -77,6 +78,7 @@ files:
 - test/array/test_random_subarray.rb
 - test/array/test_zip_with.rb
 - test/hash/test_has_shape_pred.rb
+- test/hash/test_to_ostruct.rb
 - test/kernel/test_fn.rb
 - test/kernel/test_prompt.rb
 - test/kernel/test_with.rb