bencode 0.3.1 → 0.3.2

data/lib/bencode.rb

@@ -5,12 +5,12 @@
 #
 # == Synopsis
 #
-# Bencoding (pronounced _bee-encode_) is a simple protocol, consiting of
+# Bencoding (pronounced <i>bee-encode</i>) is a simple protocol, consisting of
 # only 4 value types.
 #
 # === Integers
 #
-# An integer is encoded an _i_ followed by the numeral itself, followed 
+# An integer is encoded as an _i_ followed by the numeral itself, followed 
 # by an _e_. Leading zeros are not allowed. Negative values are prefixed
 # with a minus sign.
 #
@@ -20,8 +20,8 @@
 #
 # === Strings
 #   
-# Strings are a sequence of zero or more bytes. It is encoded as 
-# _<length>:<contents>_, where _length_ is the lenth of _contents_. _length_
+# Strings are sequences of zero or more bytes. They are encoded as 
+# <i><length>:<contents></i>, where _length_ is the length of _contents_. _length_
 # must be non-negative.
 #
 #   "".bencode     #=> "0:"
@@ -36,9 +36,9 @@
 #
 # === Dictionaries
 #
-# Dictionaries are encoded as _d<contents>e_, where _contents_ is a sequence
-# of keys and values. Each value is immediately preceded by a key. Keys must
-# be strings, and will appear in lexicographical order.
+# Dictionaries are encoded as _d_ followed by a sequence of key-value pairs, followed by _e_. 
+# Each value must be immediately preceded by a key. Keys must be strings, and must appear in 
+# lexicographical order.
 #
 #   {"foo" => 3, "bar" => 1, "baz" => 2}.bencode  
 #     #=> "d3:bari1e3:bazi2e3:fooi3ee"
@@ -67,6 +67,7 @@
 #
 
 class Object
+  #
   # Raises an exception. Subclasses of Object must themselves
   # define meaningful #bencode methods.
   def bencode
@@ -75,6 +76,7 @@ class Object
 end
 
 class Integer
+  #
   # Bencodes the Integer object. Bencoded integers are represented
   # as +ixe+, where +x+ is the integer with an optional
   # hyphen prepended, indicating negativity.
@@ -87,8 +89,9 @@ class Integer
 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 +x+:+y+, where +y+ is the string and +x+ is the length of the
   # string.
   #   
   #   "foo".bencode   #=> "3:foo"
@@ -98,6 +101,7 @@ class String
     "#{length}:#{self}"
   end
 
+  #
   # Bdecodes the String object and returns the data serialized
   # through bencoding.
   #
@@ -107,6 +111,7 @@ class String
     Bencode.load(self)
   end
 
+  #
   # Tests whether the String object is a valid bencoded string.
   def bencoded?
     bdecode
@@ -118,8 +123,9 @@ class String
 end
 
 class Array
+  #
   # Bencodes the Array object. Bencoded arrays are represented as
-  # +lxe+, where x is zero or more bencoded objects.
+  # +lxe+, where +x+ is zero or more bencoded objects.
   #
   #   [1, "foo"].bencode   #=> "li1e3:fooe"
   #
@@ -129,8 +135,9 @@ class Array
 end
 
 class Hash
+  #
   # Bencodes the Hash object. Bencoded hashes are represented as
-  # +dxe+, where x is zero or a power of two bencoded objects. 
+  # +dxe+, where +x+ is zero or a power of two bencoded objects. 
   # each key is immediately followed by its associated value.
   # All keys must be strings. The keys of the bencoded hash will
   # be in lexicographical order.
@@ -141,12 +148,12 @@ class Hash
 end
 
 class IO
-  def self.bdecode(*args)
-    new(*args).bdecode
+  def self.bdecode(filename)
+    open(filename, 'r').bdecode
   end
 
-  def self.bencode(*args)
-    new(*args).bencode
+  def self.bencode(filename)
+    open(filename, 'r').bencode
   end
 
   def bdecode
@@ -154,7 +161,7 @@ class IO
   end
 
   def bencode
-    read.chomp.bdecode
+    read.chomp.bencode
   end
 end
 

data/test/tc_bdecode.rb

@@ -1,7 +1,6 @@
 
 require 'test/unit'
-require 'rubygems'
-require 'bencode'
+require "#{File.dirname(__FILE__)}/../lib/bencode"
 
 class BdecodeTest < Test::Unit::TestCase
   def test_string

data/test/tc_bencode.rb

@@ -1,7 +1,6 @@
 
 require 'test/unit'
-require 'rubygems'
-require 'bencode'
+require "#{File.dirname(__FILE__)}/../lib/bencode"
 
 class BencodeTest < Test::Unit::TestCase
   def test_string
@@ -9,6 +8,11 @@ class BencodeTest < Test::Unit::TestCase
     assert_equal "0:", "".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 "i42e", 42.bencode
     assert_equal "i-3e", -3.bencode
@@ -28,4 +32,9 @@ class BencodeTest < Test::Unit::TestCase
     assert_equal "d1:a3:foo1:g3:bar1:z3:baze", 
       {"a" => "foo", "g" => "bar", "z" => "baz"}.bencode
   end
+
+  def test_hash_julien
+    assert_equal "d1:ai1e2:bbi1e1:ci1ee",
+      {'a' => 1, 'c' => 1, 'bb' => 1}.bencode
+  end
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: bencode
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
-date: 2006-10-24 00:00:00 +02:00
+  version: 0.3.2
+date: 2006-12-26 00:00:00 +01:00
 summary: A Ruby implementation of the Bencode encoding used by BitTorrent
 require_paths: 
 - lib