bencode 0.0.1

data/lib/bencode.rb

@@ -0,0 +1,183 @@
+# Thanks to Daniel Martin and all the other lads at ruby-lang for
+# helping me out.
+
+
+class Object
+  # Raises an exception. Subclasses of Object must themselves
+  # define meaningful #bencode methods.
+  def bencode
+    raise BencodeError, self.class
+  end
+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.
+  #
+  #   42.bencode   #=> "i42e"
+  #   -7.bencode   #=> "i-7e"
+  def bencode
+    "i#{self}e"
+  end
+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
+  # string.
+  #   
+  #   "foo".bencode   #=> "3:foo"
+  #   "".bencode      #=> "0:"
+  def bencode
+    "#{length}:#{self}"
+  end
+
+  # Bdecodes the String object and returns the data serialized
+  # through bencoding.
+  #
+  #   "li1ei2ei3ee".bdecode   #=> [1, 2, 3]
+  def bdecode
+    Bencode.load(self)
+  end
+
+  # Tests whether the String object is a valid bencoded string.
+  def bencoded?
+    bdecode
+  rescue BdecodeError
+    false
+  else
+    true
+  end
+end
+
+class Array
+  # Bencodes the Array object. Bencoded arrays are represented as
+  # +lxe+, where x is zero or more bencoded objects.
+  #
+  #   [1, "foo"].bencode   #=> "li1e3:fooe"
+  def bencode
+    "l#{map{|obj| obj.bencode}.join('') }e"
+  end
+end
+
+class Hash
+  # Bencodes the Hash object. Bencoded hashes are represented as
+  # +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.
+  def bencode
+    pairs = map{|key, val| [key.to_str.bencode, val.bencode] }
+    pairs.sort!{|a, b| a.first <=> b.first }
+    "d#{pairs.join('')}e"
+  end
+end
+
+class IO
+  def self.bdecode(*args)
+    new(*args).bdecode
+  end
+
+  def self.bencode(*args)
+    new(*args).bencode
+  end
+
+  def bdecode
+    read.chomp.bdecode
+  end
+
+  def bencode
+    read.chomp.bdecode
+  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 BdecodeError < StandardError
+  attr_reader :pos
+
+  def initialize(pos = nil) # :nodoc:
+    @pos = pos
+  end
+
+  def to_s # :nodoc:
+    if pos.nil?
+      "syntax error"
+    else
+      "syntax error near position #{pos}"
+    end
+  end
+end
+
+module Bencode
+  class << self
+    def dump(obj)
+      obj.bencode
+    end
+
+    def load(str)
+      require 'strscan'
+
+      scanner = StringScanner.new(str)
+      obj = parse(scanner)
+      raise BdecodeError unless scanner.eos?
+      return obj
+    end
+
+    def load_file(path)
+      load(File.open(path).read)
+    end
+
+    def parse(scanner) # :nodoc:
+      case token = scanner.scan(/[ild]|\d+:|\s/)
+      when nil
+        raise BdecodeError, scanner.pos
+      when "i"
+        number = scanner.scan(/0|(?:-?[1-9][0-9]*)/)
+        unless number and scanner.scan(/e/)
+          raise BdecodeError, scanner.pos
+        end
+        return number.to_i
+      when "l"
+        ary = []
+        until scanner.peek(1) == "e"
+          ary.push(parse(scanner))
+        end
+        scanner.pos += 1
+        return ary
+      when "d"
+        hsh = {}
+        until scanner.peek(1) == "e"
+          key, value = parse(scanner), parse(scanner)
+          unless key.is_a? String
+            raise BdecodeError, "error at #{scanner.pos}: " + 
+                                "key must be a string"
+          end
+          hsh.store(key, value)
+        end
+        scanner.pos += 1
+        return hsh
+      when /\d+:/
+        length = token.chop.to_i
+        str = scanner.peek(length)
+        scanner.pos += length
+        return str
+      when /\s/
+        nil
+      else
+        raise BdecodeError, scanner.pos
+      end
+    end
+
+    private :parse
+  end
+end

data/test/tc_bdecode.rb

@@ -0,0 +1,42 @@
+
+require 'test/unit'
+require 'bencode'
+
+class BdecodeTest < Test::Unit::TestCase
+  def test_string
+    assert_equal "foo", "3:foo".bdecode
+  end
+
+  def test_integer
+    assert_equal 42, "i42e".bdecode
+    assert_raise BdecodeError do
+      "i01e".bdecode
+    end
+    assert_raise BdecodeError do
+      "i-01e".bdecode
+    end
+  end
+
+  def test_array
+    assert_equal [1, 2, 3], "li1ei2ei3ee".bdecode
+  end
+
+  def test_hash
+    hsh = {"a" => "monkey", "h" => "elephant", "z" => "zebra"}
+    assert_equal hsh, "d1:a6:monkey1:h8:elephant1:z5:zebrae".bdecode
+  end
+
+  def test_invalid
+    assert_raises BdecodeError do
+      "foobar".bdecode
+      "i1ei2e".bdecode
+    end
+  end
+
+  def test_valid
+    assert  "3:foo".bencoded?
+    assert !"3:foo3:bar".bencoded?
+    assert  "i42e".bencoded?
+    assert !"i42ei101e".bencoded?
+  end
+end

data/test/tc_bencode.rb

@@ -0,0 +1,30 @@
+
+require 'unit/test'
+require 'bencode'
+
+class BencodeTest < Test::Unit::TestCase
+  def test_string
+    assert_equal "3:foo", "foo".bencode
+    assert_equal "0:", "".bencode
+  end
+
+  def test_integer
+    assert_equal "i42e", 42.bencode
+    assert_equal "i-3e", -3.bencode
+  end
+
+  def test_float
+    assert_raise BencodeError do
+      42.4.bencode
+    end
+  end
+
+  def test_array
+    assert_equal "li1ei2ei3ee", [1, 2, 3].bencode
+  end
+
+  def test_hash
+    assert_equal "d1:a3:foo1:g3:bar1:z3:baze", 
+      {"a" => "foo", "g" => "bar", "z" => "baz"}.bencode
+  end
+end

metadata

@@ -0,0 +1,48 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: bencode
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+date: 2006-09-17 00:00:00 +02:00
+summary: Bencode and -decode data
+require_paths: 
+- lib
+email: 
+homepage: 
+rubyforge_project: bencode
+description: 
+autorequire: bencode
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Daniel Schierbeck
+files: 
+- lib/bencode.rb
+- test/tc_bdecode.rb
+- test/tc_bencode.rb
+test_files: 
+- test/tc_bdecode.rb
+- test/tc_bencode.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+