bencode 0.3.2 → 0.4.0

data/lib/bencode.rb

@@ -21,7 +21,7 @@
 # === Strings
 #   
 # Strings are sequences of zero or more bytes. They are encoded as 
-# <i><length>:<contents></i>, where _length_ is the length of _contents_. _length_
+# <i>&lt;length&gt;:&lt;contents&gt;</i>, where _length_ is the length of _contents_. _length_
 # must be non-negative.
 #
 #   "".bencode     #=> "0:"
@@ -71,7 +71,7 @@ class Object
   # Raises an exception. Subclasses of Object must themselves
   # define meaningful #bencode methods.
   def bencode
-    raise BencodeError, self.class
+    raise BencodeError, "object cannot be bencoded"
   end
 end
 
@@ -91,7 +91,7 @@ end
 class String
   #
   # Bencodes the String object. Bencoded strings are represented
-  # as +x+:+y+, where +y+ is the string and +x+ is the length of the
+  # as <code>x</code>:<code>y</code>, where +y+ is the string and +x+ is the length of the
   # string.
   #   
   #   "foo".bencode   #=> "3:foo"
@@ -130,7 +130,9 @@ class Array
   #   [1, "foo"].bencode   #=> "li1e3:fooe"
   #
   def bencode
-    "l#{map{|obj| obj.bencode}.join('') }e"
+    "l#{map{|obj| obj.bencode }.join('')}e"
+  rescue BencodeError
+    raise BencodeError, "list items must be bencodable"
   end
 end
 
@@ -142,8 +144,14 @@ class Hash
   # All keys must be strings. The keys of the bencoded hash will
   # be in lexicographical order.
   def bencode
-    pairs = sort.map{|key, val| [key.to_str.bencode, val.bencode]}
+    pairs = sort.map{|key, val| [key.to_str.bencode, val.bencode] }
     "d#{pairs.join('')}e"
+  rescue NoMethodError => error
+    if error.name == :to_str
+      raise BencodeError, "dictionary keys must be strings"
+    else
+      raise
+    end
   end
 end
 
@@ -165,15 +173,7 @@ class IO
   end
 end
 
-class BencodeError < StandardError
-  def initialize(object_class = nil) # :nodoc:
-    @object_class = object_class
-  end
-
-  def to_s # :nodoc:
-    "could not bencode #{@object_class}"
-  end
-end
+class BencodeError < StandardError; end
 
 class BdecodeError < StandardError; end
 

data/test/tc_bdecode.rb

@@ -4,11 +4,18 @@ require "#{File.dirname(__FILE__)}/../lib/bencode"
 
 class BdecodeTest < Test::Unit::TestCase
   def test_string
+    assert_equal "", "0:".bdecode
     assert_equal "foo", "3:foo".bdecode
+    assert_equal "foo bar", "7:foo bar".bdecode
   end
 
   def test_integer
+    assert_equal 0, "i0e".bdecode
     assert_equal 42, "i42e".bdecode
+    assert_equal -7, "i-7e".bdecode
+  end
+
+  def test_invalid_integer
     assert_raise BdecodeError do
       "i01e".bdecode
     end
@@ -18,10 +25,14 @@ class BdecodeTest < Test::Unit::TestCase
   end
 
   def test_array
+    assert_equal [], "le".bdecode
+    assert_equal ["foo"], "l3:fooe".bdecode
     assert_equal [1, 2, 3], "li1ei2ei3ee".bdecode
   end
 
   def test_hash
+    assert_equal Hash.new, "de".bdecode
+
     hsh = {"a" => "monkey", "h" => "elephant", "z" => "zebra"}
     assert_equal hsh, "d1:a6:monkey1:h8:elephant1:z5:zebrae".bdecode
   end
@@ -30,6 +41,8 @@ class BdecodeTest < Test::Unit::TestCase
     assert_raises BdecodeError do
       "foobar".bdecode
       "i1ei2e".bdecode
+      "4:foo".bdecode
+      "2:bar".bdecode
     end
   end
 

data/test/tc_bencode.rb

@@ -8,12 +8,18 @@ class BencodeTest < Test::Unit::TestCase
     assert_equal "0:", "".bencode
   end
 
+  def test_tab_string
+    assert_equal "1:\t", "\t".bencode
+    assert_equal "2:\t\t", "\t\t".bencode
+  end
+
   def test_multiline_string
     assert_equal "1:\n", "\n".bencode
     assert_equal "2:\n\n", "\n\n".bencode
   end
 
   def test_integer
+    assert_equal "i0e", 0.bencode
     assert_equal "i42e", 42.bencode
     assert_equal "i-3e", -3.bencode
   end
@@ -25,14 +31,25 @@ class BencodeTest < Test::Unit::TestCase
   end
 
   def test_array
+    assert_equal "le", [].bencode
     assert_equal "li1ei2ei3ee", [1, 2, 3].bencode
   end
 
   def test_hash
+    assert_equal "de", {}.bencode
     assert_equal "d1:a3:foo1:g3:bar1:z3:baze", 
       {"a" => "foo", "g" => "bar", "z" => "baz"}.bencode
   end
 
+  def test_illegal_hash_keys
+    assert_raise BencodeError do
+      {1 => 'foo'}.bencode
+    end
+    assert_raise BencodeError do
+      {1 => 'foo', 2 => 'bar'}.bencode
+    end
+  end
+
   def test_hash_julien
     assert_equal "d1:ai1e2:bbi1e1:ci1ee",
       {'a' => 1, 'c' => 1, 'bb' => 1}.bencode

data/test/test_suite.rb

@@ -0,0 +1,3 @@
+
+require 'tc_bencode'
+require 'tc_bdecode'

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: bencode
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.4.0
 date: 2006-12-26 00:00:00 +01:00
 summary: A Ruby implementation of the Bencode encoding used by BitTorrent
 require_paths: 
@@ -31,6 +31,7 @@ authors:
 files: 
 - lib/bencode.rb
 test_files: 
+- test/test_suite.rb
 - test/tc_bencode.rb
 - test/tc_bdecode.rb
 rdoc_options: []