symboltable 1.0.1 → 1.0.2

data/README.md

@@ -0,0 +1,84 @@
+**SymbolTable** is a handy little Ruby class that was conceived from the union
+of `Hash` and `Symbol`. SymbolTable directly extends `Hash`, but it stores all
+keys internally as symbols. Any key that cannot be converted to a `Symbol` is
+not valid.
+
+While this may seem restrictive, it does have the nice side effect of making
+all keys slightly more memorable and usable. For example, values may be set
+and retrieved using any key that resolves to the same symbol.
+
+```ruby
+h = Hash.new
+h[:a] = 1
+h[:a]       # => 1
+h['a']      # => nil
+h.a         # => NoMethodError: undefined method `a' for {}:Hash
+
+require 'symboltable'
+
+t = SymbolTable.new
+t[:a] = 1
+t[:a]       # => 1
+t['a']      # => 1
+t.a         # => 1
+t.b = 2     # => 2
+```
+
+Also, because `SymbolTable` subclasses `Hash`, you get all the nice methods of
+`Hash` for free.
+
+```ruby
+t.keys      # => [:a, :b]
+t.values    # => [1, 2]
+
+t.merge!('c' => 3, :d => 4)
+t.keys      # => [:a, :b, :c, :d]
+t.values    # => [1, 2, 3, 4]
+
+t.each do |k, v|
+  puts "#{k} = #{v}"
+end
+```
+
+You get the idea. This kind of data structure is mainly useful for large
+configuration objects and the like, where you want to store a bunch of data and
+you don't want to have to remember later how you stored it.
+
+## Why?
+
+Mainly just for fun, and because I sometimes miss the automatic and ubiquitous
+type conversion you get in PHP.
+
+## Installation
+
+Using [RubyGems](http://rubygems.org):
+
+    $ sudo gem install symboltable
+
+From a local copy:
+
+    $ git clone git://github.com/mjijackson/symboltable.git
+    $ cd symboltable
+    $ rake package && sudo rake install
+
+## License
+
+Copyright 2012 Michael Jackson
+
+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 non-infringement. 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/lib/symboltable.rb

@@ -1,6 +1,3 @@
-# A Symbols-only Hash for Ruby.
-#
-# http://mjijackson.com/symboltable
 class SymbolTable < Hash
   def initialize(hash=nil)
     super()
@@ -25,7 +22,7 @@ class SymbolTable < Hash
   # Sets the value of the given +key+ to +val+.
   def store(key, val)
     if valid_key?(key)
-      val = self.class.new(val) if Hash === val && !(self.class === val)
+      val = self.class.new(val) if Hash === val && !(SymbolTable === val)
       super(key.to_sym, val)
     end
   end
@@ -56,4 +53,9 @@ class SymbolTable < Hash
       super(sym, *args)
     end
   end
+
+  # Returns a Hash
+  def to_hash
+    Hash[self]
+  end
 end

data/symboltable.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name = 'symboltable'
-  s.version = '1.0.1'
-  s.date = '2010-05-12'
+  s.version = '1.0.2'
+  s.date = Time.now.strftime('%Y-%m-%d')
 
   s.summary = 'A Symbols-only Hash for Ruby'
   s.description = 'A Symbols-only Hash for Ruby'
@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
 
   s.files = Dir['lib/**/*.rb'] +
     Dir['test/*.rb'] +
-    %w< symboltable.gemspec Rakefile README >
+    %w< symboltable.gemspec Rakefile README.md >
 
   s.test_files = s.files.select {|path| path =~ /^test\/.*.rb/ }
 
@@ -21,7 +21,7 @@ Gem::Specification.new do |s|
 
   s.has_rdoc = true
   s.rdoc_options = %w< --line-numbers --inline-source --title SymbolTable --main SymbolTable >
-  s.extra_rdoc_files = %w< README >
+  s.extra_rdoc_files = %w< README.md >
 
-  s.homepage = 'http://mjijackson.com/symboltable'
+  s.homepage = 'http://mjijackson.github.com/symboltable'
 end

data/test/symboltable.rb

@@ -6,6 +6,12 @@ require 'symboltable'
 
 class SymbolTableTest < Test::Unit::TestCase
 
+  class A < SymbolTable
+  end
+
+  class B < SymbolTable
+  end
+
   def test_empty
     t = SymbolTable.new
 
@@ -37,6 +43,15 @@ class SymbolTableTest < Test::Unit::TestCase
     assert_equal(1, t['b'])
   end
 
+  def test_store_symboltable
+    a = A.new
+    b = B.new
+
+    a.a = b
+
+    assert_equal(B, a.a.class)
+  end
+
   def test_update
     t = SymbolTable.new
 
@@ -108,4 +123,9 @@ class SymbolTableTest < Test::Unit::TestCase
     assert_equal([2],  b.values)
   end
 
+  def test_to_hash
+    t = SymbolTable[:a, 1]
+    assert_equal(t.to_hash.class, Hash)
+    assert_equal(t.to_hash[:a], 1)
+  end
 end

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: symboltable
 version: !ruby/object:Gem::Version 
-  version: 1.0.1
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Michael Jackson
@@ -9,19 +14,21 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-12 00:00:00 -07:00
+date: 2012-06-21 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rake
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 0
         version: "0"
-    version: 
+  type: :development
+  version_requirements: *id001
 description: A Symbols-only Hash for Ruby
 email: mjijackson@gmail.com
 executables: []
@@ -29,15 +36,15 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.md
 files: 
 - lib/symboltable.rb
 - test/symboltable.rb
 - symboltable.gemspec
 - Rakefile
-- README
+- README.md
 has_rdoc: true
-homepage: http://mjijackson.com/symboltable
+homepage: http://mjijackson.github.com/symboltable
 licenses: []
 
 post_install_message: 
@@ -54,18 +61,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: A Symbols-only Hash for Ruby

data/README

@@ -1,82 +0,0 @@
-+++ SymbolTable +++
-
-SymbolTable is a handy little Ruby class that was conceived from the union of
-Hash and Symbol. SymbolTable directly extends Hash, but it stores all keys
-internally as symbols. Any key that cannot be converted to a Symbol is not
-valid.
-
-While this may seem restrictive, it does have the nice side effect of making
-all keys slightly more memorable and usable. For example, values may be set
-and retrieved using any key that resolves to the same symbol.
-
-    h = Hash.new
-    h[:a] = 1
-    h[:a]       # => 1
-    h['a']      # => nil
-    h.a         # => NoMethodError: undefined method `a' for {}:Hash
-
-    require 'symboltable'
-
-    t = SymbolTable.new
-    t[:a] = 1
-    t[:a]       # => 1
-    t['a']      # => 1
-    t.a         # => 1
-    t.b = 2     # => 2
-
-Also, because SymbolTable subclasses Hash, you get all the nice methods of Hash
-for free.
-
-    t.keys      # => [:a, :b]
-    t.values    # => [1, 2]
-
-    t.merge!('c' => 3, :d => 4)
-    t.keys      # => [:a, :b, :c, :d]
-    t.values    # => [1, 2, 3, 4]
-
-    t.each do |k, v|
-      puts "#{k} = #{v}"
-    end
-
-You get the idea. This kind of data structure is mainly useful for large
-configuration objects and the like, where you want to store a bunch of data and
-you don't want to have to remember later how you stored it.
-
-== Why?
-
-Mainly just for fun, and because I sometimes miss the automatic and ubiquitous
-type conversion you get in PHP.
-
-== Installation
-
-Using RubyGems:
-
-    $ sudo gem install symboltable
-
-From a local copy:
-
-    $ git clone git://github.com/mjijackson/symboltable.git
-    $ cd symboltable
-    $ rake package && sudo rake install
-
-== License
-
-Copyright 2010 Michael Jackson
-
-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.