symboltable 0.2 → 1.0.0

data/README

@@ -56,6 +56,7 @@ Using RubyGems:
 From a local copy:
 
     $ git clone git://github.com/mjijackson/symboltable.git
+    $ cd symboltable
     $ rake package && sudo rake install
 
 == License

data/Rakefile

@@ -3,9 +3,6 @@ require 'rake/testtask'
 
 task :default => :test
 
-CLEAN.include %w< doc >
-CLOBBER.include %w< dist >
-
 # TESTS #######################################################################
 
 Rake::TestTask.new(:test) do |t|
@@ -14,12 +11,13 @@ end
 
 # DOCS ########################################################################
 
-desc "Generate API documentation (in doc)"
-task :doc => FileList['lib/**/*.rb'] do |t|
-  rm_rf 'doc'
+desc "Generate API documentation"
+task :api => FileList['lib/**/*.rb'] do |t|
+  output_dir = ENV['OUTPUT_DIR'] || 'api'
+  rm_rf output_dir
   sh((<<-SH).gsub(/[\s\n]+/, ' ').strip)
   hanna
-    --op doc
+    --op #{output_dir}
     --promiscuous
     --charset utf8
     --fmt html
@@ -32,6 +30,8 @@ task :doc => FileList['lib/**/*.rb'] do |t|
   SH
 end
 
+CLEAN.include 'api'
+
 # PACKAGING & INSTALLATION ####################################################
 
 if defined?(Gem)
@@ -65,3 +65,5 @@ if defined?(Gem)
     sh "gem push #{package('.gem')}"
   end
 end
+
+CLOBBER.include 'dist'

data/lib/symboltable.rb

@@ -1,6 +1,7 @@
 # A Symbols-only Hash for Ruby.
+#
+# http://mjijackson.com/symboltable
 class SymbolTable < Hash
-
   def initialize(hash=nil)
     super()
     merge!(hash) unless hash.nil?
@@ -11,22 +12,27 @@ class SymbolTable < Hash
     key.respond_to?(:to_sym)
   end
 
+  # Returns +true+ if this table contains the given +key+.
   def key?(key)
     valid_key?(key) && super(key.to_sym)
   end
 
+  # Retrieves the value of the given +key+.
   def [](key)
     super(key.to_sym) if valid_key?(key)
   end
 
+  # Sets the value of the given +key+ to +val+.
   def store(key, val)
     if valid_key?(key)
       val = SymbolTable.new(val) if Hash === val && !(SymbolTable === val)
       super(key.to_sym, val)
     end
   end
-  alias :[]= :store
 
+  alias []= store
+
+  # Merges the values from +other_hash+ into this table.
   def merge!(other_hash)
     raise ArgumentError unless Hash === other_hash
     other_hash.each do |k, v|
@@ -37,8 +43,10 @@ class SymbolTable < Hash
       end
     end
   end
-  alias :update :merge!
 
+  alias update merge!
+
+  # Allows values to be retrieved and set using Ruby's dot method syntax.
   def method_missing(sym, *args)
     if sym.to_s =~ /(.+)=$/
       self[$1] = args[0]
@@ -48,5 +56,4 @@ class SymbolTable < Hash
       super(sym, *args)
     end
   end
-
 end

data/symboltable.gemspec

@@ -1,12 +1,12 @@
 Gem::Specification.new do |s|
   s.name = 'symboltable'
-  s.version = '0.2'
-  s.date = '2010-04-08'
+  s.version = '1.0.0'
+  s.date = '2010-05-12'
 
   s.summary = 'A Symbols-only Hash for Ruby'
   s.description = 'A Symbols-only Hash for Ruby'
 
-  s.author = 'Michael J. I. Jackson'
+  s.author = 'Michael Jackson'
   s.email = 'mjijackson@gmail.com'
 
   s.require_paths = %w< lib >
@@ -23,5 +23,5 @@ Gem::Specification.new do |s|
   s.rdoc_options = %w< --line-numbers --inline-source --title SymbolTable --main SymbolTable >
   s.extra_rdoc_files = %w< README >
 
-  s.homepage = 'http://github.com/mjijackson/symboltable'
+  s.homepage = 'http://mjijackson.com/symboltable'
 end

metadata

@@ -3,17 +3,18 @@ name: symboltable
 version: !ruby/object:Gem::Version 
   prerelease: false
   segments: 
+  - 1
   - 0
-  - 2
-  version: "0.2"
+  - 0
+  version: 1.0.0
 platform: ruby
 authors: 
-- Michael J. I. Jackson
+- Michael Jackson
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-04-08 00:00:00 -06:00
+date: 2010-05-12 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,7 +44,7 @@ files:
 - Rakefile
 - README
 has_rdoc: true
-homepage: http://github.com/mjijackson/symboltable
+homepage: http://mjijackson.com/symboltable
 licenses: []
 
 post_install_message: