bencode_blatyo 1.0.0 → 1.0.1

data/README.rdoc

@@ -1,9 +1,10 @@
-= BEncode 1.0
+= BEncode
 * *Author* Allen Madsen (blatyo)
 * *My* *Site* http://www.allenmadsen.com
 * *Gem* http://gemcutter.org/gems/bencode_blatyo
 * *Source* http://github.com/blatyo/bencode
 * *Documentation* http://blatyo.github.com/bencode
+* *Issue* *Tracker* http://github.com/blatyo/bencode/issues 
 
 == Synopsis
 This gem provides a way to encode and parse bencodings used by the Bit Torrent protocol.
@@ -12,11 +13,11 @@ This gem provides a way to encode and parse bencodings used by the Bit Torrent p
 
     # install the gem
     > gem install bencode_blatyo
-    Successfully installed bencode_blatyo-1.0.0
+    Successfully installed bencode_blatyo
     1 gem installed
-    Installing ri documentation for bencode_blatyo-1.0.0...
-    Building YARD (yri) index for bencode_blatyo-1.0.0...
-    Installing RDoc documentation for bencode_blatyo-1.0.0.
+    Installing ri documentation for bencode_blatyo...
+    Building YARD (yri) index for bencode_blatyo...
+    Installing RDoc documentation for bencode_blatyo
 
     # somefile.rb
     require 'bencode'
@@ -124,6 +125,13 @@ of the last type registered for.
     BEncode::Dictionary.register MyClass
     MyClass.new.bencode #=> "d1:a1:a1:b1:be"
 
+== Note on Reporting Issues
+
+* Try to make a failing test case
+* Tell me which version of ruby you're using
+* Tell me which OS you are using
+* Provide me with any extra files if necessary
+
 == Note on Patches/Pull Requests
 
 * Fork the project.

data/Rakefile

@@ -5,8 +5,8 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "bencode_blatyo"
-    gem.summary = "This gem provides a way to encode and parse bencodings used by the Bit Torrent protocol."
-    gem.description = "This gem provides a way to encode and parse bencodings used by the Bit Torrent protocol."
+    gem.summary = "This gem has been renamed to bencodr. Use that one instead."
+    gem.description = "This gem has been renamed to bencodr. Use that one instead."
     gem.email = "blatyo@gmail.com"
     gem.homepage = "http://github.com/blatyo/bencode"
     gem.authors = ["Allen Madsen"]

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/bencode_blatyo.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bencode_blatyo}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Allen Madsen"]
-  s.date = %q{2010-01-30}
-  s.description = %q{This gem provides a way to encode and parse bencodings used by the Bit Torrent protocol.}
+  s.date = %q{2010-02-02}
+  s.description = %q{This gem has been renamed to bencodr. Use that one instead.}
   s.email = %q{blatyo@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -40,6 +40,7 @@ Gem::Specification.new do |s|
      "spec/bencode_spec.rb",
      "spec/samples/bencode.rb.torrent",
      "spec/samples/mini.bencode",
+     "spec/samples/python.torrent",
      "spec/spec.opts",
      "spec/spec_helper.rb"
   ]
@@ -47,7 +48,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.5}
-  s.summary = %q{This gem provides a way to encode and parse bencodings used by the Bit Torrent protocol.}
+  s.summary = %q{This gem has been renamed to bencodr. Use that one instead.}
   s.test_files = [
     "spec/bencode/dictionary_spec.rb",
      "spec/bencode/integer_spec.rb",

data/lib/bencode.rb

@@ -16,8 +16,8 @@ module BEncode
     #
     #   BEncode.decode("6:string") #=> "string"
     #
-    # @param [String] string the bencoded string to decode
-    # @return [String, Integer, Hash, Array] the decoded object
+    # @param [::String] string the bencoded string to decode
+    # @return [::String, ::Integer, ::Hash, ::Array] the decoded object
     def decode(string)
       scanner = StringScanner.new(string)
       Parser.parse_object(scanner) or raise BEncodeError, "Invalid bencoding"
@@ -27,8 +27,8 @@ module BEncode
     #
     #   BEncode.decode_file("simple.torrent") #=> "d8:announce32:http://www..."
     #
-    # @param [String] file the file to decode
-    # @return [String, Integer, Hash, Array] the decoded object
+    # @param [::String] file the file to decode
+    # @return [::String, ::Integer, ::Hash, ::Array] the decoded object
     def decode_file(file)
       decode(File.open(file, 'rb') {|f| f.read})
     end
@@ -38,7 +38,7 @@ module BEncode
     #   BEncode.encode("string") #=> "6:string"
     #
     # @param [#bencode] object the object to encode
-    # @return [String] the bencoded object
+    # @return [::String] the bencoded object
     def encode(object)
       object.bencode
     end
@@ -47,7 +47,7 @@ module BEncode
     #
     #   BEncode.encode("string") #=> "6:string"
     #
-    # @param [String] file the file to write the bencoded object to
+    # @param [::String] file the file to write the bencoded object to
     # @param [#bencode] object the object to encode
     def encode_file(file, object)
       File.open(file, 'wb') {|f| f.write encode(object)}

data/lib/bencode/dictionary.rb

@@ -10,7 +10,7 @@ module BEncode
         #
         #   {:cow => "moo", :seven => 7}.bencode #=> "d3:cow3:moo5:seveni7ee"
         #
-        # @return [String] the bencoded dictionary
+        # @return [::String] the bencoded dictionary
         def bencode
           (respond_to?(:to_h) ? to_h : to_hash).bencode
         end
@@ -43,7 +43,7 @@ module BEncode
         #
         #   {:cow => "moo", :seven => 7}.bencode #=> "d3:cow3:moo5:seveni7ee"
         #
-        # @return [String] the bencoded dictionary 
+        # @return [::String] the bencoded dictionary 
         def bencode
           keys.sort{|a, b| a.to_s <=> b.to_s}.collect do |key|
             key.to_s.bencode + self[key].bencode

data/lib/bencode/integer.rb

@@ -9,7 +9,7 @@ module BEncode
         #
         #   1.bencode #=> "i1e"
         #
-        # @return [String] the bencoded integer
+        # @return [::String] the bencoded integer
         def bencode
           (respond_to?(:to_i) ? to_i : to_int).bencode
         end
@@ -45,7 +45,7 @@ module BEncode
         #   3.bencode #=> "i3e"
         #   -3.bencode #=> "i-3e"
         #
-        # @return [String] the bencoded integer
+        # @return [::String] the bencoded integer
         def bencode
           [:i, self, :e].join
         end

data/lib/bencode/list.rb

@@ -9,7 +9,7 @@ module BEncode
         #
         #   [].bencode #=> "le"
         #
-        # @return [String] the bencoded list
+        # @return [::String] the bencoded list
         def bencode
           (respond_to?(:to_ary) ? to_ary : to_a).bencode
         end
@@ -41,7 +41,7 @@ module BEncode
         #
         #   [:eggs, "ham", 3, 4.1].bencode #=> "l4:eggs3:hami3ei4ee"
         #
-        # @return [String] the bencoded list
+        # @return [::String] the bencoded list
         def bencode
           collect do |element|
             element.bencode

data/lib/bencode/parser.rb

@@ -11,7 +11,7 @@ module BEncode
       #   BEncode::Parser.parse_object(scanner) #=> "string"
       #
       # @param [StringScanner] scanner the scanner of a bencoded object
-      # @return [String, Integer, Hash, Array, nil] an object if type is recognized or nil
+      # @return [::String, ::Integer, ::Hash, ::Array, nil] an object if type is recognized or nil
       def parse_object(scanner)
         case scanner.peek(1)[0]
           when ?0..?9
@@ -33,11 +33,11 @@ module BEncode
       #   BEncode::Parser.parse_string(scanner) #=> "string"
       #
       # @param [StringScanner] scanner the scanner of a bencoded string
-      # @return [String] the parsed string
+      # @return [::String] the parsed string
       def parse_string(scanner)
         length = scanner.scan(/[1-9][0-9]*|0/)    or raise BEncodeError, "Invalid string: length invalid. #{scanner.pos}"
         scanner.scan(/:/)                         or raise BEncodeError, "Invalid string: missing colon(:). #{scanner.pos}"
-        scanner.scan(/.{#{length.to_i}}/)         or raise BEncodeError, "Invalid string: length too long(#{length}) #{scanner.pos}."
+        scanner.scan(/.{#{length}}/m)             or raise BEncodeError, "Invalid string: length too long(#{length}) #{scanner.pos}."
       end
 
       # This method parases a bencoded integer.
@@ -46,7 +46,7 @@ module BEncode
       #   BEncode::Parser.parse_integer(scanner) #=> 1
       #
       # @param [StringScanner] scanner the scanner of a bencoded integer
-      # @return [Integer] the parsed integer
+      # @return [::Integer] the parsed integer
       def parse_integer(scanner)
         scanner.scan(/i/)                         or raise BEncodeError, "Invalid integer: missing opening i. #{scanner.pos}"
         integer = scanner.scan(/-?[1-9][0-9]*|0/) or raise BEncodeError, "Invalid integer: valid integer not found. #{scanner.pos}"
@@ -60,7 +60,7 @@ module BEncode
       #   BEncode::Parser.parse_list(scanner) #=> []
       #
       # @param [StringScanner] scanner the scanner of a bencoded list
-      # @return [Array] the parsed array
+      # @return [::Array] the parsed array
       def parse_list(scanner)
         list = []
 
@@ -81,7 +81,7 @@ module BEncode
       #   BEncode::Parser.parse_dictionary(scanner) #=> {}
       #
       # @param [StringScanner] scanner the scanner of a bencoded dictionary
-      # @return [Hash] the parsed hash
+      # @return [::Hash] the parsed hash
       def parse_dictionary(scanner)
         dictionary = {}
 

data/lib/bencode/string.rb

@@ -11,7 +11,7 @@ module BEncode
         #
         #   :symbol.bencode #=> "6:symbol"
         #
-        # @return [String] the bencoded string
+        # @return [::String] the bencoded string
         def bencode
           (respond_to?(:to_s) ? to_s : to_str).bencode
         end
@@ -46,7 +46,7 @@ module BEncode
         #
         #   "string".bencode #=> "6:string"
         #
-        # @return [String] the bencoded string
+        # @return [::String] the bencoded string
         def bencode
           [length, ':', self].join
         end

data/spec/bencode_spec.rb

@@ -43,8 +43,13 @@ describe BEncode do
 
   describe "#encode_file" do
     context "when an object gets bencoded and written to a file" do
+      before :all do
+        @path = File.join(File.dirname(__FILE__), '..', 'tmp')
+        Dir.mkdir(@path) unless File.exists? @path
+      end
+
       before :each do
-        @file = File.join(File.dirname(__FILE__), '..', 'tmp', 'test.bencode')
+        @file = File.join(@path, 'test.bencode')
         @object = "string"
         BEncode.encode_file(@file, @object)
       end
@@ -60,6 +65,15 @@ describe BEncode do
       after :each do
         File.delete(@file)
       end
+
+      after :all do
+        Dir.delete(@path) if File.exists? @path
+      end
+    end
+
+    it "should read a torrent with newlines as part of a string without raising an error" do
+      file = File.join(File.dirname(__FILE__), 'samples', 'python.torrent')
+      lambda{BEncode.decode_file file}.should_not raise_error
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bencode_blatyo
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Allen Madsen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-30 00:00:00 -05:00
+date: 2010-02-02 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
-description: This gem provides a way to encode and parse bencodings used by the Bit Torrent protocol.
+description: This gem has been renamed to bencodr. Use that one instead.
 email: blatyo@gmail.com
 executables: []
 
@@ -65,6 +65,7 @@ files:
 - spec/bencode_spec.rb
 - spec/samples/bencode.rb.torrent
 - spec/samples/mini.bencode
+- spec/samples/python.torrent
 - spec/spec.opts
 - spec/spec_helper.rb
 has_rdoc: true
@@ -94,7 +95,7 @@ rubyforge_project:
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: This gem provides a way to encode and parse bencodings used by the Bit Torrent protocol.
+summary: This gem has been renamed to bencodr. Use that one instead.
 test_files: 
 - spec/bencode/dictionary_spec.rb
 - spec/bencode/integer_spec.rb