hashpipe 1.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Erik Hollensbe
+
+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.rdoc

@@ -0,0 +1,52 @@
+= HashPipe -- hash-alike openstructs for ruby.
+
+  Come on and kick me.
+  You’ve got your problems;
+  I’ve got my ass wide
+  You’ve got your big G's;
+  I’ve got my hash pipe.
+  
+  - Weezer, /Hash Pipe/
+
+HashPipe is a library to supplement users of OpenStruct and similar libs. It
+operates leak free at insertion cost and optimizes for the common case:
+reading, like a good hash table should. HashPipe includes Enumerable and a
+basic keys/values implementation.
+
+HashPipe also contains a locking mechanism whereby you can eliminate the
+ability to add more items, similar to Object#freeze in a sense.
+
+Examples:
+
+  h = HashPipe.new
+  h[:foo] = "bar"
+  h.foo             #=> "bar"
+  h["bar"] = "quux"
+  h[:bar]           #=> "quux"
+  h.bar             #=> "quux"
+
+  h.lock!   # no new attributes can be created
+
+  h.quux    # raises
+  h[:quux]  # raises
+  h['quux'] # raises
+  h.foo     #=> "bar"
+
+  h.keys    #=> [:foo, :bar]
+  h.values  #=> ["bar", "quux"]
+
+  h.map { |k,v| [k,v] } #=> [[:foo, "bar"], [:bar, "quux"]]
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Erik Hollensbe. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "hashpipe"
+    gem.summary = %Q{Create openstructs that are also symbol and string structs!}
+    gem.description = %Q{Create openstructs that are also symbol and string structs! Lock them! Index them! You've got your problems, I've got your hash pipe.}
+    gem.email = "erik@hollensbe.org"
+    gem.homepage = "http://github.com/erikh/hashpipe"
+    gem.authors = ["Erik Hollensbe"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.add_development_dependency 'test-unit'
+    gem.add_development_dependency 'rdoc'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.main     = "README.rdoc"
+  rdoc.title    = "HashPipe #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+task :to_blog => [:clobber_rdoc, :rdoc] do
+  sh "rm -fr $git/blog/content/docs/hashpipe && mv rdoc $git/blog/content/docs/hashpipe"
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/hashpipe.rb

@@ -0,0 +1,99 @@
+#
+# HashPipe is a library to supplement users of OpenStruct and similar libs. It
+# operates leak free at insertion cost and optimizes for the common case:
+# reading, like a good hash table should. HashPipe includes Enumerable and a
+# basic keys/values implementation.
+# 
+# HashPipe also contains a locking mechanism whereby you can eliminate the
+# ability to add more items, similar to Object#freeze in a sense.
+# 
+# Examples:
+# 
+#   h = HashPipe.new
+#   h[:foo] = "bar"
+#   h.foo             #=> "bar"
+#   h["bar"] = "quux"
+#   h[:bar]           #=> "quux"
+#   h.bar             #=> "quux"
+# 
+#   h.lock!   # no new attributes can be created
+# 
+#   h.quux    # raises
+#   h[:quux]  # raises
+#   h['quux'] # raises
+#   h.foo     #=> "bar"
+# 
+#   h.keys    #=> [:foo, :bar]
+#   h.values  #=> ["bar", "quux"]
+# 
+#   h.map { |k,v| [k,v] } #=> [[:foo, "bar"], [:bar, "quux"]]
+# 
+class HashPipe
+  def self.create_accessor(sym, obj)
+    unless obj.__respond_to?(sym)
+      class << obj; self; end.attr_accessor(sym)
+    end
+  end
+
+  if :foo.respond_to?(:[]) # ruby1.9 optimization
+    def self.callable_ivar(ivar)
+      ivar[/^@?(.*)$/, 1].to_sym
+    end
+  else
+    def self.callable_ivar(ivar)
+      ivar.to_s[/^@?(.*)$/, 1].to_sym
+    end
+  end
+
+  class << self
+    public :attr_accessor
+  end
+
+  alias __class__ class unless defined?(__class__) # rbx has it.
+  alias __instance_variables__ instance_variables
+  alias __respond_to? respond_to?
+  instance_methods.each { |m| undef_method m unless m =~ /^__|\?$/ }
+
+  include Enumerable
+
+  def [](sym_or_str)
+    self.__class__.create_accessor(sym_or_str, self)
+    self.__send__(sym_or_str)
+  end
+
+  def []=(sym_or_str, value)
+    self.__class__.create_accessor(sym_or_str, self)
+    self.__send__(:"#{sym_or_str}=", value)
+  end
+
+  def method_missing(sym, *args)
+    newsym = sym.to_s.gsub(/=$/, '').to_sym
+    if __respond_to?(newsym)
+      raise ArgumentError, "#{newsym} cannot be defined on #{self.inspect}"
+    else
+      self.__class__.create_accessor(newsym, self) 
+      self.__send__(sym, *args)
+    end
+  end
+
+  def keys
+    __instance_variables__.map { |ivar| self.__class__.callable_ivar(ivar) } 
+  end
+
+  def values
+    __instance_variables__.map { |ivar|
+      self.__send__(self.__class__.callable_ivar(ivar))
+    }
+  end
+
+  def each
+    __instance_variables__.each do |ivar|
+      callable = self.__class__.callable_ivar(ivar)
+      yield(callable, self.__send__(callable))
+    end
+  end
+
+  def lock!
+    class << self; undef_method :method_missing; end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,13 @@
+require 'rubygems'
+gem 'test-unit'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'hashpipe'
+
+class Test::Unit::TestCase
+  def create_sos
+    HashPipe.new
+  end
+end

data/test/test_hashpipe_superopenstruct.rb

@@ -0,0 +1,86 @@
+require 'helper'
+
+class TestHashpipeSuperOpenStruct < Test::Unit::TestCase
+  def test_01_construct
+    h = create_sos
+    assert(h)
+    assert_kind_of(HashPipe, h)
+    assert_respond_to(h, :lock!)
+  end
+
+  def test_02_accessors
+    h = create_sos
+
+    h.foo = "bar"
+    assert_equal(h.foo,    "bar")
+    assert_equal(h[:foo],  "bar")
+    assert_equal(h['foo'], "bar")
+    
+    h.bar = "baz"
+    assert_equal(h.bar,    "baz")
+    assert_equal(h[:bar],  "baz")
+    assert_equal(h['bar'], "baz")
+  end
+
+  def test_03_lock
+    h2 = create_sos
+    h = create_sos
+
+    h.foo = "bar"
+    h.lock!
+
+    assert_raises(NoMethodError) do
+      h.bar = "baz"
+    end
+
+    assert_equal(h.foo,    "bar")
+    assert_equal(h[:foo],  "bar")
+    assert_equal(h['foo'], "bar")
+
+    # should not raise
+    h2.bar = "baz"
+    h2.bar = "baz"
+
+    assert_equal(h2.bar,    "baz")
+    assert_equal(h2[:bar],  "baz")
+    assert_equal(h2['bar'], "baz")
+  end
+
+  def test_04_overwrite
+    h = create_sos
+    assert_respond_to(h, :map)
+
+    assert_raises(ArgumentError) { h.map = "foo" }
+    assert_raises(ArgumentError) { h[:map] = "foo" }
+    assert_raises(ArgumentError) { h['map'] = "foo" }
+  end
+  
+  def test_05_keys_values
+    h = create_sos
+    h.foo = "bar"
+    h.bar = "quux"
+
+    assert_equal(
+      h.keys.sort_by { |x| x.to_s }, 
+      [:bar, :foo]
+    )
+
+    assert_equal(
+      h.values.sort_by { |x| x.to_s }, 
+      ["bar", "quux"]
+    )
+  end
+
+  def test_06_enumerable
+    h = create_sos
+    assert_respond_to(h, :map)
+
+    h[:foo] = "bar"
+    h.bar   = :foo
+
+    assert_equal(
+      h.map { |k,v| [k,v] }.sort_by { |r| r[0].to_s }, 
+      [[:bar, :foo], [:foo, "bar"]]
+    )
+  end
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: hashpipe
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Erik Hollensbe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-07 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: test-unit
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Create openstructs that are also symbol and string structs! Lock them! Index them! You've got your problems, I've got your hash pipe.
+email: erik@hollensbe.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/hashpipe.rb
+- test/helper.rb
+- test/test_hashpipe_superopenstruct.rb
+has_rdoc: true
+homepage: http://github.com/erikh/hashpipe
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Create openstructs that are also symbol and string structs!
+test_files: 
+- test/helper.rb
+- test/test_hashpipe_superopenstruct.rb