tnetstring 0.3.1 → 0.3.2

data/lib/tnetstring.rb

@@ -82,10 +82,9 @@ module TNetstring
 
   def self.parse_pair(data) # :nodoc:
     key, extra = parse(data)
-    assert key.kind_of?(String), "Dictionary keys must be Strings"
+    assert key.kind_of?(String) || key.kind_of?(Symbol), "Dictionary keys must be Strings or Symbols"
     assert extra, "Unbalanced dictionary store"
     value, extra = parse(extra)
-    assert value, "Got an invalid value, null not allowed"
 
     [key, value, extra]
   end
@@ -101,6 +100,8 @@ module TNetstring
     end
   end
 
+  # <b>DEPRECATED:</b> Please use <tt>dump</tt> instead.
+  #
   # Constructs a tnetstring out of the given object. Valid Ruby object types
   # include strings, integers, boolean values, nil, arrays, and hashes. Arrays
   # and hashes may contain any of the previous valid Ruby object types, but
@@ -109,44 +110,67 @@ module TNetstring
   # === Example
   #
   #  int = 12345
-  #  TNetstring.encode(int)
+  #  TNetstring.dump(int)
   #
   #  #=> '5:12345#'
   #
   #  hash = {'hello' => 'world'}
-  #  TNetstring.encode(hash)
+  #  TNetstring.dump(hash)
   #
   #  #=> '16:5:hello,5:world,}'
   #
   def self.encode(obj)
+    warn "[DEPRECATION] `encode` is deprecated.  Please use `dump` instead."
+    dump obj
+  end
+
+  # Constructs a tnetstring out of the given object. Valid Ruby object types
+  # include strings, integers, boolean values, nil, arrays, and hashes. Arrays
+  # and hashes may contain any of the previous valid Ruby object types, but
+  # hash keys must be strings.
+  #
+  # === Example
+  #
+  #  int = 12345
+  #  TNetstring.dump(int)
+  #
+  #  #=> '5:12345#'
+  #
+  #  hash = {'hello' => 'world'}
+  #  TNetstring.dump(hash)
+  #
+  #  #=> '16:5:hello,5:world,}'
+  #
+  def self.dump(obj)
     if obj.kind_of?(Integer)
       int_str = obj.to_s
       "#{int_str.length}:#{int_str}#"
-    elsif obj.kind_of?(String)
+    elsif obj.kind_of?(String) || obj.kind_of?(Symbol)
       "#{obj.length}:#{obj},"
-    elsif obj.is_a?(TrueClass) || obj.is_a?(FalseClass)
-      bool_str = obj.to_s
-      "#{bool_str.length}:#{bool_str}!"
+    elsif obj.is_a?(TrueClass)
+      "4:true!"
+    elsif obj.is_a?(FalseClass)
+      "5:false!"
     elsif obj == nil
       "0:~"
     elsif obj.kind_of?(Array)
-      encode_list(obj)
+      dump_list(obj)
     elsif obj.kind_of?(Hash)
-      encode_dictionary(obj)
+      dump_dictionary(obj)
     else
       assert false, "Object must be of a primitive type: #{obj.inspect}"
     end
   end
 
-  def self.encode_list(list) # :nodoc:
-    contents = list.map {|item| encode(item)}.join
+  def self.dump_list(list) # :nodoc:
+    contents = list.map {|item| dump(item)}.join
     "#{contents.length}:#{contents}]"
   end
 
-  def self.encode_dictionary(dict) # :nodoc:
+  def self.dump_dictionary(dict) # :nodoc:
     contents = dict.map do |key, value|
-      assert key.kind_of?(String), "Dictionary keys must be Strings"
-      "#{encode(key)}#{encode(value)}"
+      assert key.kind_of?(String) || key.kind_of?(Symbol), "Dictionary keys must be Strings or Symbols"
+      "#{dump(key)}#{dump(value)}"
     end.join
     "#{contents.length}:#{contents}}"
   end

data/lib/tnetstring/version.rb

@@ -1,5 +1,5 @@
 module TNetstring # :nodoc:
   module Version # :nodoc:
-    STRING = '0.3.1'
+    STRING = '0.3.2'
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Matt Yoho
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-17 00:00:00 -04:00
+date: 2011-06-21 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency