extruding-hash 0.9.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/LICENSE

@@ -0,0 +1,14 @@
+This work is licensed under the Creative Commons Attribution 3.0 Unported License. 
+
+To view a copy of this license, visit :
+
+http://creativecommons.org/licenses/by/3.0/ 
+
+Or send a letter to :
+
+Creative Commons, 
+444 Castro Street, 
+Suite 900, 
+Mountain View, 
+California, 94041, 
+USA.

data/README.md

@@ -0,0 +1,83 @@
+extruding-hash
+==============
+
+`extruding-hash` provdes a data structure, based on a Hash of Arrays,
+that provides a method or two to gather data together in what can be
+considered _bins_.  The Hash functionality provides these _bins_, while
+the data values themselves are contained in Arrays, providing the
+concept of _columns_.
+
+The `extruding-hash` object has methods where if an added _column_ (in
+the form of a Hash) has any _bins_ that the object does not already
+contain, the _bin_ will be added, populated with **nil** values for any
+_columns_ that had not had a value for that _bin_ - see figure 1:
+
+    Init. State (extruding-hash object)
+    Bin       Columns
+    ---       -------
+    a1|b1     [ 1, 2, 3, 5 ]
+    a3|b3     [ 2, 3, 5, 8 ]
+    a4|b4     [ 3, 5, 8, 13 ]
+
+    New column (Hash) to be added, note second bin not in extruding-hash object already.
+    Bins      Values
+    ---       -------
+    a1|b1     21
+    a2|b2     34
+    a4|b4     55
+
+    End. State (extruding-hash object), after column introduced.
+    Bin       Columns
+    ---       -------
+    a1|b1     [ 1,   2,   3,   5,   21 ]
+    a2|b2     [ nil, nil, nil, nil, 34 ]
+    a3|b3     [ 2,   3,   5,   8,   nil ]
+    a4|b4     [ 3,   5,   8,   13   55 ]
+
+              Figure 1
+
+License
+-------
+
+`extruding-hash` is licensed under the Creative Commons 3.0 License.
+Details can be found in the file LICENSE.
+
+License-file referencing and other doc. formatting taken from
+[damiendallimore](https://github.com/damiendallimore "damiendallimore on GitHub").
+
+Install
+-------
+
+    gem install extruding-hash
+
+Usage
+-----
+```ruby
+require 'extruding-hash'
+data = ExtrudingHash.new
+data = { "a1|b1" => [ 1, 2, 3, 5 ], "a3|b3" => [ 2, 3, 5, 8 ],
+         "a4|b4" => [ 3, 5, 8, 13 ] }
+data << { "a1|b1" => 21, "a2|b2" => 34, "a4|b4" => 55 }
+data
+=> {"a1|b1"=>[1, 2, 3, 5, 21], "a2|b2"=>[nil, nil, nil, 34],
+    "a3|b3"=>[2, 3, 5, 8, nil], "a4|b4"=>[ 3, 5, 8, 13, 55]}
+```
+
+Contribute
+----------
+
+Please fork the GitHub project (https://github.com/aburnheimer/extruding-hash),
+make any changes, commit and push to GitHub, and submit a pull request.
+Including tests for your changes would be greatly appreciated!
+
+Contact
+-------
+
+This project was initiated by Andrew Burnheimer.
+
+* Email:
+  * aburnheimer@gmail.com
+* Twitter:
+  * @aburnheimer
+* Github:
+  * https://github.com/aburnheimer/

data/extruding-hash.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'extruding-hash'
+  s.version     = '0.9.0'
+  s.summary     = %q{Hash structure for histograms}
+
+  s.description = %q{Data structure, based on a Hash of Arrays, that
+provides a method or two to gather data together in what can be
+considered "bins".}
+
+  s.license     = 'CC-BY-3.0'
+
+  s.author      = 'Andrew Burnheimer'
+  s.email       = 'Andrew_Burnheimer@cable.comcast.com'
+  s.homepage    = 'https://github.com/aburnheimer/extruding-hash'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  # no dependencies
+end

data/lib/extruding-hash/array.rb

@@ -0,0 +1,6 @@
+class Array
+  def last=(arg)
+    self.pop
+    self << arg
+  end
+end

data/lib/extruding-hash/extruding_hash.rb

@@ -0,0 +1,71 @@
+# `extruding-hash` provdes a data structure, based on a Hash of Arrays,
+# that provides a method or two to gather data together in what can be
+# considered _bins_.  The Hash functionality provides these _bins_,
+# while the data values themselves are contained in Arrays, providing
+# the concept of _columns_.
+#
+# The `extruding-hash` object has methods where if an added _column_ (in
+# the form of a Hash) has any _bins_ that the object does not already
+# contain, the _bin_ will be added, populated with *nil* values for any
+# _columns_ that had not had a value for that _bin_ - see README.md for
+# more info.
+#
+# Author::    Andrew Burnheimer (mailto:aburnheimer@gmail.com)
+# Copyright:: Copyright (c) 2012
+# License::   Creative Commons 3.0 License.  Details can be found in the
+#             file LICENSE.
+require File.expand_path File.join(File.dirname(__FILE__), 'array')
+
+class ExtrudingHash < Hash
+
+  # Set this sub-class of hash to the passed hash.
+  def set_from_hash( right )
+    right.each { |k,v| self[k] = v }
+    return self
+  end
+
+  # Add a column into the structure.  Respect any _bins_ already in the
+  # structure, and add nil values to any existing columns that haven't
+  # included the _bins_ of the newly passed-in column.
+  def <<( right )
+    right.each_key do |key|
+      self[key] = Array.new if self[key].nil?
+    end
+    self.normalize!
+
+    right.each do |key, value|
+      self[key] << value
+    end
+    self.normalize!
+
+    return self
+  end
+
+  # The (largest) number of columns among all _bins_ of the Hash.
+  def columns
+    ret = -1
+    self.each do |key, value|
+      ret = value.count if value.count > ret
+    end
+
+    if ret < 0
+      nil
+    else
+      ret
+    end
+  end
+
+  # Grow any extent short rows to the same width as the longest
+  def normalize!
+    max = self.columns
+
+    self.each do |key, value|
+      value << nil while value.count < max
+    end
+
+    max
+  end
+
+end
+
+# vim:set et ts=2 sts=2 sw=2 tw=72 wm=72 ai:

data/lib/extruding-hash.rb

@@ -0,0 +1 @@
+require 'extruding-hash/extruding_hash'

data/spec/array_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path File.join(File.dirname(__FILE__), '../lib/extruding-hash/array')
+
+describe Array, "#last=" do
+  it "sets the last element to a new value" do
+    array = Array.new
+    array = [ 1, 3, 5 ]
+    array.last = 4
+    array.last.should eq(4)
+  end
+end
+
+# vim:set et ts=2 sts=2 sw=2 tw=72 wm=72 ai:
+

data/spec/extruding_hash_spec.rb

@@ -0,0 +1,47 @@
+require File.expand_path File.join(File.dirname(__FILE__), '../lib/extruding-hash/extruding_hash')
+
+describe ExtrudingHash, "#<<" do
+
+  it "returns the number of columns contained" do
+    test_value = ExtrudingHash.new.set_from_hash( { "a1|b1" => [ 1, 2, 3, 5 ],
+        "a3|b3" => [ 2, 3, 5, 8 ], "a4|b4" => [ 3, 5, 8, 13 ] } )
+
+    test_value.columns.should eq(4)
+  end
+
+  it "can normalize itself such that all bins' value-arrays are as wide as the widest" do
+    test_value = ExtrudingHash.new.set_from_hash( { "a1|b1" => [ 1, 2, 3 ],
+        "a3|b3" => [ 2, 3, 5, 8 ] } )
+    test_value.normalize!
+
+    expected_value = { "a1|b1" => [ 1, 2, 3, nil], "a3|b3" => [ 2, 3, 5, 8 ] }
+
+    test_value.should eq(expected_value)
+  end
+
+  it "adds a column where all bins correspond" do
+    test_value = ExtrudingHash.new.set_from_hash( { "a1|b1" => [ 1, 2, 3, 5 ],
+        "a3|b3" => [ 2, 3, 5, 8 ], "a4|b4" => [ 3, 5, 8, 13 ] } )
+
+    test_value << { "a1|b1" => 21, "a3|b3" => 34, "a4|b4" => 55 }
+
+    expected_value = {"a1|b1"=>[1, 2, 3, 5, 21],
+        "a3|b3"=>[2, 3, 5, 8, 34], "a4|b4"=>[ 3, 5, 8, 13, 55]}
+
+    test_value.should eq(expected_value)
+  end
+
+  it "adds a column where all bins do not correspond" do
+    test_value = ExtrudingHash.new.set_from_hash( { "a1|b1" => [ 1, 2, 3, 5 ],
+        "a3|b3" => [ 2, 3, 5, 8 ], "a4|b4" => [ 3, 5, 8, 13 ] } )
+
+    test_value << { "a1|b1" => 21, "a2|b2" => 34, "a4|b4" => 55 }
+
+    expected_value = {"a1|b1"=>[1, 2, 3, 5, 21],
+        "a2|b2"=>[nil, nil, nil, nil, 34], "a3|b3"=>[2, 3, 5, 8, nil],
+        "a4|b4"=>[ 3, 5, 8, 13, 55]}
+
+    test_value.should eq(expected_value)
+  end
+
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: extruding-hash
+version: !ruby/object:Gem::Version 
+  hash: 59
+  prerelease: 
+  segments: 
+  - 0
+  - 9
+  - 0
+  version: 0.9.0
+platform: ruby
+authors: 
+- Andrew Burnheimer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-17 00:00:00 Z
+dependencies: []
+
+description: |-
+  Data structure, based on a Hash of Arrays, that
+  provides a method or two to gather data together in what can be
+  considered "bins".
+email: Andrew_Burnheimer@cable.comcast.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- LICENSE
+- README.md
+- extruding-hash.gemspec
+- lib/extruding-hash.rb
+- lib/extruding-hash/array.rb
+- lib/extruding-hash/extruding_hash.rb
+- spec/array_spec.rb
+- spec/extruding_hash_spec.rb
+homepage: https://github.com/aburnheimer/extruding-hash
+licenses: 
+- CC-BY-3.0
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Hash structure for histograms
+test_files: 
+- spec/array_spec.rb
+- spec/extruding_hash_spec.rb