bencode 0.5.1 → 0.6.0

data/.gitignore

@@ -0,0 +1,3 @@
+doc
+*.gem
+.idea

data/README.md

@@ -22,12 +22,17 @@ It contains only four data types, namely:
 Examples
 --------
 
+Encoding objects is as simple as calling `#bencode` on them:
+
     "foo bar".bencode                   # => "7:foo bar"
     42.bencode                          # => "i42e"
     [1, 2, 3].bencode                   # => "li1ei2ei3ee"
     {"foo" => 1, "bar" => -10}.bencode  # => "d3:bari-10e3:fooi1ee"
 
 
+Decoding a data stream is as easy as calling `BEncode.load(data)`.
+
+
 License
 -------
 
@@ -37,4 +42,8 @@ Released under the MIT license.
 Contributors
 ------------
 
+- Daniel Schierbeck
 - Mike Hodgson
+- Andrew Danforth
+- Eric Himmelreich
+- Allen Madsen

data/Rakefile

@@ -2,13 +2,41 @@
 require 'rake/testtask'
 require 'rake/rdoctask'
 
-##
-# Run all unit tests.
-Rake::TestTask.new
+task :default => :test
+
+desc "Run all unit tests"
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end
 
 
-##
-# Generate RDoc documentation.
+desc "Generate RDoc documentation"
 Rake::RDocTask.new :doc do |rdoc|
   rdoc.rdoc_dir = 'doc'
 end
+
+desc "Run all the benchmarks"
+task :benchmark do
+  Dir["test/benchmark/*.rb"].each do |file|
+    puts ">> Running #{file}"
+    puts %x[ruby #{file}]
+    puts
+  end
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "bencode"
+    gem.summary = "Encode and decode bencoded data"
+    gem.description = "A simple encoder and decoder for the BitTorrent serialization format."
+    gem.email = "daniel.schierbeck@gmail.com"
+    gem.homepage = "http://github.com/dasch/ruby-bencode"
+    gem.authors = ["Daniel Schierbeck"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.6.0

data/lib/bencode/decode.rb

@@ -1,4 +1,6 @@
 
+require 'strscan'
+
 module BEncode
   class << self
     # BEncodes +obj+
@@ -8,8 +10,6 @@ module BEncode
 
     # Bdecodes +str+
     def load(str)
-      require 'strscan'
-
       scanner = StringScanner.new(str)
       obj = parse(scanner)
       raise BEncode::DecodeError unless scanner.eos?
@@ -18,51 +18,48 @@ module BEncode
 
     # Bdecodes the file located at +path+
     def load_file(path)
-      if RUBY_PLATFORM =~ /(win|w)32$/
-        load(File.open(path, 'rb').read)
-      else
-        load(File.open(path).read)
-      end
+      load(File.open(path, 'rb') {|f| f.read})
     end
 
     def parse(scanner) # :nodoc:
-      case scanner.scan(/[ild]|\d+:/)
-      when "i"
-        number = scanner.scan(/0|(?:-?[1-9][0-9]*)/)
-        raise BEncode::DecodeError unless number and scanner.scan(/e/)
-        return number.to_i
-      when "l"
-        ary = []
-        # TODO: There must be a smarter way of doing this...
-        ary.push(parse(scanner)) until scanner.peek(1) == "e"
+      case scanner.peek(1)[0]
+      when ?i
         scanner.pos += 1
+        num = scanner.scan_until(/e/) or raise BEncode::DecodeError
+        return Integer(num.chop)
+      when ?l
+        scanner.pos += 1
+        ary = []
+        ary.push(parse(scanner)) until scanner.scan(/e/)
         return ary
-      when "d"
+      when ?d
+        scanner.pos += 1
         hsh = {}
-        until scanner.peek(1) == "e"
-          key, value = parse(scanner), parse(scanner)
+        until scanner.scan(/e/)
+          key = parse(scanner)
 
-          unless key.is_a? String
-            raise BEncode::DecodeError, "key must be a string"
+          unless key.is_a? String or key.is_a? Fixnum
+            raise BEncode::DecodeError, "key must be a string or number"
           end
 
-          hsh.store(key, value)
+          hsh.store(key.to_s, parse(scanner))
         end
-        scanner.pos += 1
         return hsh
-      when /\d+:/
-        length = Integer($~.string.chop)
-        str = scanner.peek(length)
+      when ?0 .. ?9
+        num = scanner.scan_until(/:/) or
+           raise BEncode::DecodeError, "invalid string length (no colon)"
 
         begin
+          length = Integer(num.chop)
+          str = scanner.peek(length)
           scanner.pos += length
-        rescue RangeError
+        rescue
           raise BEncode::DecodeError, "invalid string length"
         end
 
         return str
       else
-        raise BEncode::DecodeError
+        raise BEncode::DecodeError, "Invalid specifier #{scanner.peek(1).inspect} at position #{scanner.pos+1}"
       end
     end
 

data/lib/bencode/io.rb

@@ -1,11 +1,11 @@
 
 class IO
   def self.bdecode(filename)
-    open(filename, 'r').bdecode
+    open(filename, 'rb') {|io| io.bdecode}
   end
 
   def self.bencode(filename)
-    open(filename, 'r').bencode
+    open(filename, 'rb') {|io| io.bencode}
   end
 
   def bdecode

data/test/benchmark/decoding.rb

@@ -0,0 +1,22 @@
+$:.unshift(File.dirname(__FILE__)+"/../../lib")
+require 'benchmark'
+require 'bencode'
+
+Benchmark.bmbm do |x|
+  x.report("Decoding an integer") do
+    100_000.times do
+      BEncode.load("i42e")
+    end
+  end
+
+  x.report("Decoding an string") do
+    100_000.times do
+      BEncode.load("6:foobar")
+    end
+  end
+  x.report("Decoding a long integer array") do
+    100.times do
+      BEncode.load("l" + ("i42e" * 1000) + "e")
+    end
+  end
+end

data/test/benchmark/encoding.rb

@@ -0,0 +1,11 @@
+$:.unshift(File.dirname(__FILE__)+"/../../lib")
+require 'benchmark'
+require 'bencode'
+
+Benchmark.bmbm do |x|
+  x.report("Encoding an array of integers") do
+    100.times do
+      ((1..50).to_a * 100).bencode
+    end
+  end
+end

data/test/bittorrent_test.rb

@@ -0,0 +1,11 @@
+
+require 'test/environment'
+
+
+class BitTorrentTest < Test::Unit::TestCase
+  should "load a bencoded torrent file" do
+    assert_nothing_raised do
+      BEncode.load_file("test/fixtures/python.torrent")
+    end
+  end
+end

data/test/decoding_test.rb

@@ -0,0 +1,15 @@
+
+require 'test/environment'
+
+class DecodingTest < Test::Unit::TestCase
+  context "The BEncode decoder" do
+    should_decode 42, "i42e"
+    should_decode 0, "i0e"
+    should_decode -42, "i-42e"
+
+    should_decode "foo", "3:foo"
+    should_decode "", "0:"
+
+    should_decode [1, 2, 3], "li1ei2ei3ee"
+  end
+end

data/test/encoding_test.rb

@@ -0,0 +1,9 @@
+
+require 'test/environment'
+
+class EncodingTest < Test::Unit::TestCase
+  context "The BEncode encoder" do
+    should_encode "i42e", 42
+    should_encode "3:foo", "foo"
+  end
+end

data/test/environment.rb

@@ -1,2 +1,8 @@
 
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
 require File.dirname(__FILE__) + '/../lib/bencode'
+Dir.glob(File.dirname(__FILE__) + '/shoulda_macros/*.rb').each do |macro|
+  require macro
+end

data/test/shoulda_macros/decoding.rb

@@ -0,0 +1,8 @@
+
+class Test::Unit::TestCase
+  def self.should_decode(expected, encoded)
+    should "decode #{encoded.inspect} into #{expected.inspect}" do
+      assert_equal expected, BEncode.load(encoded)
+    end
+  end
+end

data/test/shoulda_macros/encoding.rb

@@ -0,0 +1,8 @@
+
+class Test::Unit::TestCase
+  def self.should_encode(expected, value)
+    should "encode #{value.inspect} into #{expected.inspect}" do
+      assert_equal expected, value.bencode
+    end
+  end
+end

data/test/utf8_decoding_test.rb

@@ -0,0 +1,12 @@
+
+require 'test/environment'
+
+class UTF8DecodingTest < Test::Unit::TestCase
+  context "The BEncode decoder" do
+    should "be able to handle UTF8-encoded data" do
+      assert_nothing_raised do
+        BEncode.load_file('test/fixtures/test.torrent')
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bencode
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors: 
 - Daniel Schierbeck
@@ -9,39 +9,53 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-06 00:00:00 +02:00
+date: 2010-02-06 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
-description: Ruby bindings for the bencode data serialization format.
+description: A simple encoder and decoder for the BitTorrent serialization format.
 email: daniel.schierbeck@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- LICENSE
+- README.md
 files: 
-- Rakefile
+- .gitignore
 - LICENSE
 - README.md
+- Rakefile
+- VERSION
 - lib/bencode.rb
 - lib/bencode/decode.rb
 - lib/bencode/decode_error.rb
-- lib/bencode/encode_error.rb
-- lib/bencode/io.rb
 - lib/bencode/encode/array.rb
-- lib/bencode/encode/integer.rb
-- lib/bencode/encode/string.rb
 - lib/bencode/encode/hash.rb
+- lib/bencode/encode/integer.rb
 - lib/bencode/encode/object.rb
+- lib/bencode/encode/string.rb
+- lib/bencode/encode_error.rb
+- lib/bencode/io.rb
+- test/benchmark/decoding.rb
+- test/benchmark/encoding.rb
+- test/bittorrent_test.rb
+- test/decoding_test.rb
+- test/encoding_test.rb
+- test/environment.rb
+- test/fixtures/python.torrent
+- test/fixtures/test.torrent
+- test/shoulda_macros/decoding.rb
+- test/shoulda_macros/encoding.rb
+- test/utf8_decoding_test.rb
 has_rdoc: true
-homepage: http://github.com/dasch/ruby-bencode-bindings
+homepage: http://github.com/dasch/ruby-bencode
 licenses: []
 
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -62,8 +76,14 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: Ruby bencode bindings
+summary: Encode and decode bencoded data
 test_files: 
-- test/test_decode_utf8.rb
+- test/bittorrent_test.rb
+- test/decoding_test.rb
+- test/utf8_decoding_test.rb
+- test/shoulda_macros/decoding.rb
+- test/shoulda_macros/encoding.rb
 - test/environment.rb
-- test/fixtures/test.torrent
+- test/encoding_test.rb
+- test/benchmark/decoding.rb
+- test/benchmark/encoding.rb

data/test/test_decode_utf8.rb

@@ -1,13 +0,0 @@
-
-require 'test/unit'
-require 'test/environment'
-
-class TestDecodeUTF8 < Test::Unit::TestCase
-
-  def test_can_handle_utf8_encoded_data
-    assert_nothing_raised do
-      BEncode.load_file('test/fixtures/test.torrent')
-    end
-  end
-
-end