bencode 0.6.0 → 0.7.0

data/.yardopts

@@ -0,0 +1,5 @@
+--no-private
+--title "BEncode Documentation"
+--readme README.md
+lib/**/*.rb -
+LICENSE

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+group :test do
+  gem "minitest", :require => "minitest/unit"
+  gem "shoulda", :git => "git://github.com/dasch/shoulda.git", :branch => "minitest"
+end

data/README.md

@@ -42,8 +42,9 @@ Released under the MIT license.
 Contributors
 ------------
 
-- Daniel Schierbeck
-- Mike Hodgson
+- Daniel Schierbeck ([dasch](https://github.com/dasch))
+- Mike Hodgson ([mikehodgson](https://github.com/mikehodgson))
 - Andrew Danforth
 - Eric Himmelreich
-- Allen Madsen
+- Allen Madsen ([blatyo](https://github.com/blatyo))
+- Ian Levesque ([ianlevesque](https://github.com/ianlevesque))

data/VERSION

@@ -1 +1 @@
-0.6.0
+0.7.0

data/lib/bencode.rb

@@ -1,9 +1,15 @@
 
-# TODO: Write some documentation here.
+# Support for loading and dumping bencoded data.
+#
+# See {BEncode.load} and {BEncode.dump}.
 module BEncode
-  VERSION = '0.5.0'
+  class DecodeError < StandardError
+  end
+
+  class EncodeError < StandardError
+  end
 end
 
 glob = File.join(File.dirname(__FILE__), 'bencode/**/*.rb')
 
-Dir[glob].sort.each{|file| require file }
+Dir[glob].sort.each {|file| require file }

data/lib/bencode/{encode → core_ext}/array.rb

@@ -8,7 +8,7 @@ class Array
   #
   def bencode
     begin
-      "l#{map{|obj| obj.bencode }.join('')}e"
+      "l#{map{|obj| obj.bencode }.join}e"
     rescue BEncode::EncodeError
       raise BEncode::EncodeError, "array items must be encodable"
     end

data/lib/bencode/{encode → core_ext}/hash.rb

@@ -7,8 +7,8 @@ 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] }
-    "d#{pairs.join('')}e"
+    pairs = sort.map{|key, val| [key.to_s.bencode, val.bencode] }
+    "d#{pairs.join}e"
   rescue NoMethodError => error
     raise BEncode::EncodeError, "dictionary keys must be strings"
   end

data/lib/bencode/decode.rb

@@ -2,69 +2,83 @@
 require 'strscan'
 
 module BEncode
-  class << self
-    # BEncodes +obj+
-    def dump(obj)
-      obj.bencode
-    end
+  # Encodes the Ruby object +obj+ into a bencoded string.
+  #
+  # @param [Hash, Array, Integer, String] obj the object to encode
+  # @return [String] a bencoded string
+  # @raise [EncodeError] if +obj+ is not a supported object type
+  def self.dump(obj)
+    obj.bencode
+  end
+
+  # Decodes +str+ into a Ruby structure.
+  #
+  # @param [String] str a bencoded string
+  # @option opts [Boolean] :ignore_trailing_junk (false) whether
+  #  to ignore invalid bencode at the end of +str+
+  # @return [Object] a Ruby object
+  # @raise [DecodeError] if +str+ is malformed
+  def self.load(str, opts = {})
+    scanner = StringScanner.new(str)
+    obj = parse(scanner)
+    raise BEncode::DecodeError unless (opts[:ignore_trailing_junk] || scanner.eos?)
+    return obj
+  end
 
-    # Bdecodes +str+
-    def load(str)
-      scanner = StringScanner.new(str)
-      obj = parse(scanner)
-      raise BEncode::DecodeError unless scanner.eos?
-      return obj
-    end
+  # Decodes the file located at +path+.
+  #
+  # @param [String] path path to the bencoded file
+  # @option (see .load)
+  # @return (see .load)
+  def self.load_file(path, opts = {})
+    load(File.open(path, 'rb').read, opts)
+  end
 
-    # Bdecodes the file located at +path+
-    def load_file(path)
-      load(File.open(path, 'rb') {|f| f.read})
-    end
+  private
 
-    def parse(scanner) # :nodoc:
-      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
-        scanner.pos += 1
-        hsh = {}
-        until scanner.scan(/e/)
-          key = parse(scanner)
+  def self.parse(scanner) # :nodoc:
+    val = case scanner.peek(1)[0]
+          when ?i
+            scanner.pos += 1
+            num = scanner.scan_until(/e/) or raise BEncode::DecodeError
+            num.chop.to_i
+          when ?l
+            scanner.pos += 1
+            ary = []
+            ary.push(parse(scanner)) until scanner.scan(/e/)
+            ary
+          when ?d
+            scanner.pos += 1
+            hsh = {}
+            until scanner.scan(/e/)
+              key = parse(scanner)
 
-          unless key.is_a? String or key.is_a? Fixnum
-            raise BEncode::DecodeError, "key must be a string or number"
-          end
+              unless key.is_a? String or key.is_a? Fixnum
+                raise BEncode::DecodeError, "key must be a string or number"
+              end
 
-          hsh.store(key.to_s, parse(scanner))
-        end
-        return hsh
-      when ?0 .. ?9
-        num = scanner.scan_until(/:/) or
-           raise BEncode::DecodeError, "invalid string length (no colon)"
+              hsh.store(key.to_s, parse(scanner))
+            end
+            hsh
+          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
-          raise BEncode::DecodeError, "invalid string length"
-        end
+            begin
+              length = num.chop.to_i
+              str = scanner.peek(length)
+              scanner.pos += num.chop.to_i
+            rescue
+              raise BEncode::DecodeError, "invalid string length"
+            end
 
-        return str
-      else
-        raise BEncode::DecodeError, "Invalid specifier #{scanner.peek(1).inspect} at position #{scanner.pos+1}"
-      end
-    end
+            str
+          end
 
-    private :parse
+    raise BEncode::DecodeError if val.nil?
+    val
   end
+
 end
 
 class String

data/test/bittorrent_test.rb

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

data/test/decoding_test.rb

@@ -1,7 +1,7 @@
 
 require 'test/environment'
 
-class DecodingTest < Test::Unit::TestCase
+class DecodingTest < MiniTest::Unit::TestCase
   context "The BEncode decoder" do
     should_decode 42, "i42e"
     should_decode 0, "i0e"
@@ -11,5 +11,7 @@ class DecodingTest < Test::Unit::TestCase
     should_decode "", "0:"
 
     should_decode [1, 2, 3], "li1ei2ei3ee"
+    
+    should_decode 42, "i42eBOGUS", :ignore_trailing_junk => true
   end
 end

data/test/encoding_test.rb

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

data/test/environment.rb

@@ -1,7 +1,11 @@
 
 require 'rubygems'
-require 'test/unit'
-require 'shoulda'
+require 'bundler/setup'
+
+Bundler.require(:default, :test)
+
+MiniTest::Unit.autorun
+
 require File.dirname(__FILE__) + '/../lib/bencode'
 Dir.glob(File.dirname(__FILE__) + '/shoulda_macros/*.rb').each do |macro|
   require macro

data/test/shoulda_macros/decoding.rb

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

data/test/shoulda_macros/encoding.rb

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

data/test/utf8_decoding_test.rb

@@ -1,12 +1,11 @@
 
 require 'test/environment'
 
-class UTF8DecodingTest < Test::Unit::TestCase
+class UTF8DecodingTest < MiniTest::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
+      BEncode.load_file('test/fixtures/test.torrent')
+      pass
     end
   end
 end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bencode
 version: !ruby/object:Gem::Version 
-  version: 0.6.0
+  hash: 3
+  prerelease: 
+  segments: 
+  - 0
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Daniel Schierbeck
@@ -9,8 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-06 00:00:00 +01:00
-default_executable: 
+date: 2011-06-15 00:00:00 Z
 dependencies: []
 
 description: A simple encoder and decoder for the BitTorrent serialization format.
@@ -23,21 +28,20 @@ extra_rdoc_files:
 - LICENSE
 - README.md
 files: 
-- .gitignore
+- .yardopts
+- Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - VERSION
 - lib/bencode.rb
+- lib/bencode/core_ext/array.rb
+- lib/bencode/core_ext/hash.rb
+- lib/bencode/core_ext/integer.rb
+- lib/bencode/core_ext/io.rb
+- lib/bencode/core_ext/object.rb
+- lib/bencode/core_ext/string.rb
 - lib/bencode/decode.rb
-- lib/bencode/decode_error.rb
-- lib/bencode/encode/array.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
@@ -49,41 +53,38 @@ files:
 - 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
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Encode and decode bencoded data
-test_files: 
-- 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/encoding_test.rb
-- test/benchmark/decoding.rb
-- test/benchmark/encoding.rb
+test_files: []
+

data/.gitignore

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

data/lib/bencode/decode_error.rb

@@ -1,4 +0,0 @@
-
-unless BEncode.const_defined? :DecodeError
-  BEncode::DecodeError = Class.new(StandardError)
-end

data/lib/bencode/encode_error.rb

@@ -1,4 +0,0 @@
-
-unless BEncode.const_defined? :EncodeError
-  BEncode::EncodeError = Class.new(StandardError)
-end