bencode 0.7.0 → 0.8.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NzJhZTUzNzVhM2ZmMzNjOTJhYTkwNGJhOWU4NTFjZTNhOTdjY2Y1Ng==
+  data.tar.gz: !binary |-
+    YWQzMDg5NmM2ODYwY2M1Y2JhZTU4NzA0ZmE5MWRmN2QwODEwNTIxNA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MjM1ODBjMmNmMjU1YmY3ZGViNDZiMmE5OTlkZTg4NWZjZGFkZGQ0NzEyNmQ3
+    NjEzOTI2NmVjMDEwNGYwNTI0NTAyNGU5YmE3ZWU5ODg4MWExMGJjZGY1MTll
+    YmE2MzljNTg1YzYzYTdhYjljMGQzOWQxYWYwOWQ2NTllM2M1NGQ=
+  data.tar.gz: !binary |-
+    ZmQ4ODY3NDM3NDZiYThjZDc5MTYzOTNiOTdlOGRhMDJmNjhhNDAxY2Q2OTM2
+    NWUwZmFhMWVkNGI0ZGI5ZWZlM2UzMTJmYWIxNDVmOWMzNzliY2RmMWUwMGVj
+    YjdlMDVhN2YxYzQwZWFiNjA1ZDY2OTI1MmU2YTU3OTYwZWZjZjM=

data/Gemfile

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

data/README.md

@@ -1,4 +1,3 @@
-
 Ruby bencode binding
 ====================
 
@@ -24,14 +23,25 @@ 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"
+```ruby
+"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 complete data stream is as easy as calling `BEncode.load(data)`.
 
-Decoding a data stream is as easy as calling `BEncode.load(data)`.
+Decoding a data stream in chunks works as follows:
 
+```ruby
+irb(main):007:0> stream = BEncode::Parser.new(StringIO.new "d3:foo3:bared3:baz3:quxe")
+=> #<BEncode::Parser:0x007fbe6b008c88 @stream=#<StringIO:0x007fbe6b008cd8>>
+irb(main):008:0> stream.parse!
+=> {"foo"=>"bar"}
+irb(main):009:0> stream.parse!
+=> {"baz"=>"qux"}
+```
 
 License
 -------
@@ -48,3 +58,4 @@ Contributors
 - Eric Himmelreich
 - Allen Madsen ([blatyo](https://github.com/blatyo))
 - Ian Levesque ([ianlevesque](https://github.com/ianlevesque))
+- Dirk Geurs ([Dirklectisch](https://github.com/Dirklectisch))

data/Rakefile

@@ -1,22 +1,58 @@
-
+require 'rubygems'
+require 'rake'
+require 'date'
 require 'rake/testtask'
-require 'rake/rdoctask'
+require 'rdoc/task'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
 
 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
 
-
-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|
@@ -26,17 +62,82 @@ task :benchmark do
   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"]
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{name}-#{version}.gem"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
   end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end

data/bencode.gemspec

@@ -0,0 +1,63 @@
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.rubygems_version = '1.3.5'
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'bencode'
+  s.version           = '0.8.0'
+  s.date              = '2013-03-15'
+
+  s.summary = "Encode and decode bencoded data"
+  s.description = "A simple encoder and decoder for the BitTorrent serialization format."
+
+  s.authors = ["Daniel Schierbeck"]
+  s.email = "daniel.schierbeck@gmail.com"
+  s.homepage = "http://github.com/dasch/ruby-bencode"
+
+  s.require_paths = %w[lib]
+
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.extra_rdoc_files = %w[README.md LICENSE]
+
+  s.add_development_dependency('rdoc')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('minitest')
+  s.add_development_dependency('shoulda')
+
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    LICENSE
+    README.md
+    Rakefile
+    bencode.gemspec
+    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/core_ext/stringio.rb
+    lib/bencode/decode.rb
+    lib/bencode/parseio.rb
+    lib/bencode/parser.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
+  ]
+  # = MANIFEST =
+
+  s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+end

data/lib/bencode.rb

@@ -3,6 +3,8 @@
 #
 # See {BEncode.load} and {BEncode.dump}.
 module BEncode
+  VERSION = "0.8.0"
+
   class DecodeError < StandardError
   end
 

data/lib/bencode/core_ext/io.rb

@@ -1,5 +1,8 @@
+require 'bencode/parseio'
 
 class IO
+  include BEncode::ParseIO
+  
   def self.bdecode(filename)
     open(filename, 'rb') {|io| io.bdecode}
   end

data/lib/bencode/core_ext/stringio.rb

@@ -0,0 +1,6 @@
+require 'stringio'
+require 'bencode/parseio'
+
+class StringIO
+  include BEncode::ParseIO
+end

data/lib/bencode/decode.rb

@@ -19,8 +19,8 @@ module BEncode
   # @return [Object] a Ruby object
   # @raise [DecodeError] if +str+ is malformed
   def self.load(str, opts = {})
-    scanner = StringScanner.new(str)
-    obj = parse(scanner)
+    scanner = BEncode::Parser.new(str)
+    obj = scanner.parse!
     raise BEncode::DecodeError unless (opts[:ignore_trailing_junk] || scanner.eos?)
     return obj
   end
@@ -33,52 +33,6 @@ module BEncode
   def self.load_file(path, opts = {})
     load(File.open(path, 'rb').read, opts)
   end
-
-  private
-
-  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
-
-              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 = num.chop.to_i
-              str = scanner.peek(length)
-              scanner.pos += num.chop.to_i
-            rescue
-              raise BEncode::DecodeError, "invalid string length"
-            end
-
-            str
-          end
-
-    raise BEncode::DecodeError if val.nil?
-    val
-  end
-
 end
 
 class String

data/lib/bencode/parseio.rb

@@ -0,0 +1,9 @@
+module BEncode
+  module ParseIO
+    def peek
+      c = self.getc
+      self.ungetc(c)
+      c
+    end
+  end
+end

data/lib/bencode/parser.rb

@@ -0,0 +1,80 @@
+require 'stringio'
+require 'bencode/parseio'
+
+module BEncode
+  class Parser
+    attr_reader :stream
+
+    def initialize(stream)
+      if stream.kind_of? BEncode::ParseIO
+        @stream = stream
+      elsif stream.respond_to? :string
+        @stream = StringIO.new stream.string
+      elsif stream.respond_to? :to_s
+        @stream = StringIO.new stream.to_s
+      end
+    end
+
+    def parse!
+      case stream.peek
+        when ?i then parse_integer!
+        when ?l then parse_list!
+        when ?d then parse_dict!
+        when ?0 .. ?9 then parse_string!
+      end
+    end
+    
+    def eos?
+      stream.eof?
+    end
+
+    private
+
+    def parse_integer!
+      stream.getc
+      num = stream.gets("e") or raise BEncode::DecodeError
+      num.chop.to_i
+    end
+
+    def parse_list!
+      stream.getc
+      ary = []
+      ary.push(parse!) until stream.peek == ?e
+      stream.getc
+      ary
+    end
+
+    def parse_dict!
+      stream.getc
+      hsh = {}
+      until stream.peek == ?e
+        key = parse!
+
+        unless key.is_a? String or key.is_a? Fixnum
+          raise BEncode::DecodeError, "key must be a string or number"
+        end
+          
+        val = parse!
+
+        hsh.store(key.to_s, val)
+      end
+      stream.getc
+      hsh
+    end
+
+    def parse_string!
+      num = stream.gets(":") or
+        raise BEncode::DecodeError, "invalid string length (no colon)"
+
+      begin
+        length = num.chop.to_i
+        return "" if length == 0 # Workaround for Rubinius bug
+        str = stream.read(length)
+      rescue
+        raise BEncode::DecodeError, "invalid string length"
+      end
+
+      str
+    end
+  end
+end

data/test/bittorrent_test.rb

@@ -1,6 +1,4 @@
-
-require 'test/environment'
-
+require 'environment'
 
 class BitTorrentTest < MiniTest::Unit::TestCase
   should "load a bencoded torrent file" do

data/test/decoding_test.rb

@@ -1,5 +1,4 @@
-
-require 'test/environment'
+require 'environment'
 
 class DecodingTest < MiniTest::Unit::TestCase
   context "The BEncode decoder" do
@@ -12,6 +11,9 @@ class DecodingTest < MiniTest::Unit::TestCase
 
     should_decode [1, 2, 3], "li1ei2ei3ee"
     
+    hsh = {"foo" => "bar", "baz" => "qux"}
+    should_decode hsh, "d3:foo3:bar3:baz3:quxe"
+    
     should_decode 42, "i42eBOGUS", :ignore_trailing_junk => true
   end
 end

data/test/encoding_test.rb

@@ -1,5 +1,4 @@
-
-require 'test/environment'
+require 'environment'
 
 class EncodingTest < MiniTest::Unit::TestCase
   context "The BEncode encoder" do

data/test/environment.rb

@@ -1,8 +1,8 @@
-
 require 'rubygems'
 require 'bundler/setup'
 
-Bundler.require(:default, :test)
+require 'minitest/unit'
+require 'shoulda'
 
 MiniTest::Unit.autorun
 

data/test/utf8_decoding_test.rb

@@ -1,5 +1,4 @@
-
-require 'test/environment'
+require 'environment'
 
 class UTF8DecodingTest < MiniTest::Unit::TestCase
   context "The BEncode decoder" do

metadata

@@ -1,39 +1,84 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: bencode
-version: !ruby/object:Gem::Version 
-  hash: 3
-  prerelease: 
-  segments: 
-  - 0
-  - 7
-  - 0
-  version: 0.7.0
+version: !ruby/object:Gem::Version
+  version: 0.8.0
 platform: ruby
-authors: 
+authors:
 - Daniel Schierbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-06-15 00:00:00 Z
-dependencies: []
-
+date: 2013-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple encoder and decoder for the BitTorrent serialization format.
 email: daniel.schierbeck@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
+extra_rdoc_files:
 - README.md
-files: 
-- .yardopts
+- LICENSE
+files:
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- VERSION
+- bencode.gemspec
 - lib/bencode.rb
 - lib/bencode/core_ext/array.rb
 - lib/bencode/core_ext/hash.rb
@@ -41,7 +86,10 @@ files:
 - lib/bencode/core_ext/io.rb
 - lib/bencode/core_ext/object.rb
 - lib/bencode/core_ext/string.rb
+- lib/bencode/core_ext/stringio.rb
 - lib/bencode/decode.rb
+- lib/bencode/parseio.rb
+- lib/bencode/parser.rb
 - test/benchmark/decoding.rb
 - test/benchmark/encoding.rb
 - test/bittorrent_test.rb
@@ -55,36 +103,27 @@ files:
 - test/utf8_decoding_test.rb
 homepage: http://github.com/dasch/ruby-bencode
 licenses: []
-
+metadata: {}
 post_install_message: 
-rdoc_options: []
-
-require_paths: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.5
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 2
 summary: Encode and decode bencoded data
 test_files: []
-
+has_rdoc: 

data/.yardopts

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

data/VERSION

@@ -1 +0,0 @@
-0.7.0