hash_magic 0.0.1 → 0.1.0

data/LICENSE

@@ -0,0 +1,16 @@
+Copyright (c) 2006 BehindLogic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software 
+and associated documentation files (the "Software"), to deal in the Software without restriction, 
+including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, 
+and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, 
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial 
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT 
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN 
+NO EVENT SHALL THE 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.

data/README

@@ -0,0 +1,44 @@
+HashMagic simply contains a couple of spin-off data structures based on the basic Ruby Hash:
+1. SlashedHash
+2. OrderedHash
+
+You can use either of those separately or in combination. Note that ruby-1.9 Hashes are made to keep their order, but I'm not sure about setting an order explicitly for them, and definitely not setting an order ahead of time.
+
+==SlashedHash
+The concept of a SlashedHash is to flatten down a multi-level Hash structure into a single-level Hash whose keys represent the pathway to the data in the original multi-level structure. For example,
+  >> sh = {'a' => 'b', 'c' => {'d' => :e, 'f' => ['a', 'b']}, 'd' => ['e', 'f']}.slashed
+  => {slashed: "a"=>"b", "c/d"=>:e, "d"=>["e", "f"], "c/f"=>["a", "b"]}
+
+Once you transform a Hash into a SlashedHash, the only negative differences are:
+1. All but the end-point (or 'leaf node') data are turned into strings. Restated: Any data at the "end" of a Hash multi-level structure is left alone, but all keys in between, whether string, symbol, or anything else, is turned into a string in order to pack them together into a "slashed" key.
+2. Speed. A Ruby Hash is built into the core and written mostly in C so it is very fast; but a SlashedHash clones the same C functionality on all the Hash's methods so that it can act as a normal Hash but with more sugar.
+
+Like I said, the above mentioned things are the only negative differences. You can still access items by their original keys -- to continue the example above,
+  >> sh['c']['d']
+  => :e
+BUT you can also access the same values by their "slashed" keys:
+  >> sh['c/d']
+  => :e
+  >> sh['c/f']
+  => ["a", "b"]
+And you can access the keys either normally or flattened:
+  >> sh.keys
+  => ["a", "c", "d"]
+  >> sh.flat.keys
+  => ["a", "c/d", "d", "c/f"]
+Accessing one level into the SlashedHash gives you another SlashedHash, if applicable:
+  >> sh['c']
+  => {slashed: "d"=>:e, "f"=>["a", "b"]}
+
+==What good is SlashedHash? What can it do for me?
+
+1) It comes in VERY handy when doing special transformations or multi-level key mappings. Think of reading an XML structure into specific property names (example uses the formattedstring gem syntax):
+  >> joe = "<person><name>Joe Schmoe</name><age>25</age><parent><name>Joseph Schmoe</name><age>56</age></parent>".formatted(:xml).to_hash.slashed
+  => {slashed: "person"=>{"name"=>"Joe Schmoe", "age"=>"25", "parent"=>{"name"=>"Joseph Schmoe", "age"=>"56"}}}
+  >> mapping = {'name' => 'person/name', 'age' => 'person/age', 'parent_name' => 'person/parent/name', 'parent_age' => 'person/parent/age'}
+  >> joe.transform_keys_with_mapping(mapping)
+  => {"name"=>"Joe Schmoe", "parent_name"=>"Joseph Schmoe", "age"=>"25", "parent_age"=>"56"}
+
+2) It is useful for sorting multi-level hashes by integration with OrderedHash.
+
+ / / / Still writing, will come back to this sometime... :) / / /

data/Rakefile

@@ -6,7 +6,7 @@ require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 
 PKG_NAME = 'hash_magic'
-PKG_VERSION = "0.0.1"
+PKG_VERSION = "0.1.0"
 
 PKG_FILES = FileList[
     "lib/**/*", "rspec/**/*", "[A-Z]*", "Rakefile", "doc/**/*"
@@ -29,8 +29,8 @@ desc "Create documentation"
 Rake::RDocTask.new("doc") { |rdoc|
   rdoc.title = "Hash Magic"
   rdoc.rdoc_dir = 'doc'
-  # rdoc.rdoc_files.include('README')
-  # rdoc.rdoc_files.include('LICENSE')
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('LICENSE')
   rdoc.rdoc_files.include('lib/**/*.rb')
 }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hash_magic
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Daniel Parker
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-03-31 00:00:00 -04:00
+date: 2008-04-15 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -23,41 +23,9 @@ extra_rdoc_files: []
 
 files: 
 - lib/hash_magic.rb
+- LICENSE
 - Rakefile
-- doc/classes
-- doc/classes/Hash.html
-- doc/classes/Hash.src
-- doc/classes/Hash.src/M000012.html
-- doc/classes/Hash.src/M000013.html
-- doc/classes/OrderedHash.html
-- doc/classes/OrderedHash.src
-- doc/classes/OrderedHash.src/M000014.html
-- doc/classes/OrderedHash.src/M000015.html
-- doc/classes/OrderedHash.src/M000016.html
-- doc/classes/OrderedHash.src/M000017.html
-- doc/classes/OrderedHash.src/M000018.html
-- doc/classes/SlashedHash.html
-- doc/classes/SlashedHash.src
-- doc/classes/SlashedHash.src/M000001.html
-- doc/classes/SlashedHash.src/M000002.html
-- doc/classes/SlashedHash.src/M000003.html
-- doc/classes/SlashedHash.src/M000004.html
-- doc/classes/SlashedHash.src/M000005.html
-- doc/classes/SlashedHash.src/M000006.html
-- doc/classes/SlashedHash.src/M000007.html
-- doc/classes/SlashedHash.src/M000008.html
-- doc/classes/SlashedHash.src/M000009.html
-- doc/classes/SlashedHash.src/M000010.html
-- doc/classes/SlashedHash.src/M000011.html
-- doc/created.rid
-- doc/files
-- doc/files/lib
-- doc/files/lib/hash_magic_rb.html
-- doc/fr_class_index.html
-- doc/fr_file_index.html
-- doc/fr_method_index.html
-- doc/index.html
-- doc/rdoc-style.css
+- README
 has_rdoc: true
 homepage: http://hash_magic.rubyforge.org
 post_install_message: 

data/doc/classes/Hash.html

@@ -1,177 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!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>
-  <title>Class: Hash</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-
-    elemStyle = elem.style;
-    
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-
-    return true;
-  }
-  
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  
-  // ]]>
-  </script>
-
-</head>
-<body>
-
-
-
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Class</strong></td>
-          <td class="class-name-in-header">Hash</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../files/lib/hash_magic_rb.html">
-                lib/hash_magic.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-
-        <tr class="top-aligned-row">
-            <td><strong>Parent:</strong></td>
-            <td>
-                Object
-            </td>
-        </tr>
-        </table>
-    </div>
-  <!-- banner header -->
-
-  <div id="bodyContent">
-
-
-
-  <div id="contextContent">
-
-    <div id="description">
-      <p>
-The aim of this gem:
-</p>
-<ol>
-<li>Don&#8216;t extend <a href="Hash.html">Hash</a>
-
-</li>
-<li>Provide <a href="SlashedHash.html">SlashedHash</a>
-
-</li>
-<li>Provide <a href="OrderedHash.html">OrderedHash</a>
-
-</li>
-<li>Make a <a href="SlashedHash.html">SlashedHash</a> orderable
-
-</li>
-<li>Make an <a href="OrderedHash.html">OrderedHash</a> convert correctly to an
-<a href="Hash.html#M000013">ordered</a> <a
-href="SlashedHash.html">SlashedHash</a>
-
-</li>
-</ol>
-
-    </div>
-
-
-   </div>
-
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-
-      <div class="name-list">
-      <a href="#M000013">ordered</a>&nbsp;&nbsp;
-      <a href="#M000012">slashed</a>&nbsp;&nbsp;
-      </div>
-    </div>
-
-  </div>
-
-
-    <!-- if includes -->
-
-    <div id="section">
-
-
-
-
-
-      
-
-
-    <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Instance methods</h3>
-
-      <div id="method-M000013" class="method-detail">
-        <a name="M000013"></a>
-
-        <div class="method-heading">
-          <a href="Hash.src/M000013.html" target="Code" class="method-signature"
-            onclick="popupCode('Hash.src/M000013.html');return false;">
-          <span class="method-name">ordered</span><span class="method-args">(*keys_in_order)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-        </div>
-      </div>
-
-      <div id="method-M000012" class="method-detail">
-        <a name="M000012"></a>
-
-        <div class="method-heading">
-          <a href="Hash.src/M000012.html" target="Code" class="method-signature"
-            onclick="popupCode('Hash.src/M000012.html');return false;">
-          <span class="method-name">slashed</span><span class="method-args">()</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-        </div>
-      </div>
-
-
-    </div>
-
-
-  </div>
-
-
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>

data/doc/classes/Hash.src/M000012.html

@@ -1,18 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html 
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html>
-<head>
-  <title>slashed (Hash)</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
-</head>
-<body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/hash_magic.rb, line 9</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">slashed</span>
-    <span class="ruby-constant">SlashedHash</span>.<span class="ruby-identifier">new</span>(<span class="ruby-keyword kw">self</span>)
-  <span class="ruby-keyword kw">end</span></pre>
-</body>
-</html>

data/doc/classes/Hash.src/M000013.html

@@ -1,18 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html 
-     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
-<html>
-<head>
-  <title>ordered (Hash)</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
-</head>
-<body class="standalone-code">
-  <pre><span class="ruby-comment cmt"># File lib/hash_magic.rb, line 12</span>
-  <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">ordered</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">keys_in_order</span>)
-    <span class="ruby-constant">OrderedHash</span>.<span class="ruby-identifier">new</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">keys_in_order</span>).<span class="ruby-identifier">update!</span>(<span class="ruby-keyword kw">self</span>)
-  <span class="ruby-keyword kw">end</span></pre>
-</body>
-</html>

data/doc/classes/OrderedHash.html

@@ -1,208 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!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>
-  <title>Class: OrderedHash</title>
-  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
-  <meta http-equiv="Content-Script-Type" content="text/javascript" />
-  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
-  <script type="text/javascript">
-  // <![CDATA[
-
-  function popupCode( url ) {
-    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
-  }
-
-  function toggleCode( id ) {
-    if ( document.getElementById )
-      elem = document.getElementById( id );
-    else if ( document.all )
-      elem = eval( "document.all." + id );
-    else
-      return false;
-
-    elemStyle = elem.style;
-    
-    if ( elemStyle.display != "block" ) {
-      elemStyle.display = "block"
-    } else {
-      elemStyle.display = "none"
-    }
-
-    return true;
-  }
-  
-  // Make codeblocks hidden by default
-  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-  
-  // ]]>
-  </script>
-
-</head>
-<body>
-
-
-
-    <div id="classHeader">
-        <table class="header-table">
-        <tr class="top-aligned-row">
-          <td><strong>Class</strong></td>
-          <td class="class-name-in-header">OrderedHash</td>
-        </tr>
-        <tr class="top-aligned-row">
-            <td><strong>In:</strong></td>
-            <td>
-                <a href="../files/lib/hash_magic_rb.html">
-                lib/hash_magic.rb
-                </a>
-        <br />
-            </td>
-        </tr>
-
-        <tr class="top-aligned-row">
-            <td><strong>Parent:</strong></td>
-            <td>
-                <a href="Hash.html">
-                Hash
-               </a>
-            </td>
-        </tr>
-        </table>
-    </div>
-  <!-- banner header -->
-
-  <div id="bodyContent">
-
-
-
-  <div id="contextContent">
-
-
-
-   </div>
-
-    <div id="method-list">
-      <h3 class="section-bar">Methods</h3>
-
-      <div class="name-list">
-      <a href="#M000015">[]=</a>&nbsp;&nbsp;
-      <a href="#M000016">inspect</a>&nbsp;&nbsp;
-      <a href="#M000017">keys</a>&nbsp;&nbsp;
-      <a href="#M000014">new</a>&nbsp;&nbsp;
-      <a href="#M000018">slashed</a>&nbsp;&nbsp;
-      </div>
-    </div>
-
-  </div>
-
-
-    <!-- if includes -->
-    <div id="includes">
-      <h3 class="section-bar">Included Modules</h3>
-
-      <div id="includes-list">
-        <span class="include-name">StandardHashMethodsInRuby</span>
-      </div>
-    </div>
-
-    <div id="section">
-
-
-
-
-
-      
-
-
-    <!-- if method_list -->
-    <div id="methods">
-      <h3 class="section-bar">Public Class methods</h3>
-
-      <div id="method-M000014" class="method-detail">
-        <a name="M000014"></a>
-
-        <div class="method-heading">
-          <a href="OrderedHash.src/M000014.html" target="Code" class="method-signature"
-            onclick="popupCode('OrderedHash.src/M000014.html');return false;">
-          <span class="method-name">new</span><span class="method-args">(*args)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-        </div>
-      </div>
-
-      <h3 class="section-bar">Public Instance methods</h3>
-
-      <div id="method-M000015" class="method-detail">
-        <a name="M000015"></a>
-
-        <div class="method-heading">
-          <a href="OrderedHash.src/M000015.html" target="Code" class="method-signature"
-            onclick="popupCode('OrderedHash.src/M000015.html');return false;">
-          <span class="method-name">[]=</span><span class="method-args">(key,value)</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-        </div>
-      </div>
-
-      <div id="method-M000016" class="method-detail">
-        <a name="M000016"></a>
-
-        <div class="method-heading">
-          <a href="OrderedHash.src/M000016.html" target="Code" class="method-signature"
-            onclick="popupCode('OrderedHash.src/M000016.html');return false;">
-          <span class="method-name">inspect</span><span class="method-args">()</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-        </div>
-      </div>
-
-      <div id="method-M000017" class="method-detail">
-        <a name="M000017"></a>
-
-        <div class="method-heading">
-          <a href="OrderedHash.src/M000017.html" target="Code" class="method-signature"
-            onclick="popupCode('OrderedHash.src/M000017.html');return false;">
-          <span class="method-name">keys</span><span class="method-args">()</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-        </div>
-      </div>
-
-      <div id="method-M000018" class="method-detail">
-        <a name="M000018"></a>
-
-        <div class="method-heading">
-          <a href="OrderedHash.src/M000018.html" target="Code" class="method-signature"
-            onclick="popupCode('OrderedHash.src/M000018.html');return false;">
-          <span class="method-name">slashed</span><span class="method-args">()</span>
-          </a>
-        </div>
-      
-        <div class="method-description">
-        </div>
-      </div>
-
-
-    </div>
-
-
-  </div>
-
-
-<div id="validator-badges">
-  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
-
-</body>
-</html>