bencodr 1.1.0 → 1.2.0

data/README.rdoc

@@ -88,16 +88,37 @@ You can decode a bencoding by calling bdecode on the string.
     "le".bdecode        #=> []
     "de".bdecode        #=> {}
 
-=== Encoding and Decoding with BEncodr
+=== IO and Files
+You can also write and read bencodings.
+
+    # write to standard out
+    IO.bencode(1, "string")             #=> "6:string" to stdout
+    $stdout.bencode("string")           #=> "6:string" to stdout
+
+    # write to file
+    File.bencode("a.bencode", "string") #=> "6:string" to a.bencode
+    
+    file = File.open("a.bencode", "wb")
+    file.bencode("string")              #=> "6:string" to a.bencode
+
+    # read from standard in
+    IO.bdecode(0)                       #=> "string"
+    $stdin.bdecode                      #=> "string"
+
+    # read from file
+    File.bdecode("a.bencode")           #=> "string"
+
+    file = File.open("a.bencode", "wb")
+    file.bdecode                        #=> "string"
+
+=== BEncodr
+Most of the functionality of this library can also be accessed directly on the BEncodr class.
 
     # encoding is just like calling bencode on the object
     BEncodr.encode("string")    #=> "6:string"
 
     # decoding is just like calling bdecode on a bencoding
     BEncodr.decode("6:string")  #=> "string"
-    BEncodr.decode("i1e")       #=> 1
-    BEncodr.decode("le")        #=> []
-    BEncodr.decode("de")        #=> {}
 
     # you can work directly with files too
     BEncodr.encode_file("my_awesome.torrent", {:announce => "http://www.sometracker.com/announce:80"})
@@ -152,4 +173,4 @@ of the last type registered for.
 
 == Copyright
 
-Copyright (c) 2010 blatyo. See LICENSE for details.
+Copyright (c) 2010 Allen Madsen. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/bencodr.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bencodr}
-  s.version = "1.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Allen Madsen"]
@@ -29,12 +29,14 @@ Gem::Specification.new do |s|
      "lib/bencodr.rb",
      "lib/bencodr/dictionary.rb",
      "lib/bencodr/integer.rb",
+     "lib/bencodr/io.rb",
      "lib/bencodr/list.rb",
      "lib/bencodr/parser.rb",
      "lib/bencodr/string.rb",
      "spec/bencode_spec.rb",
      "spec/bencodr/dictionary_spec.rb",
      "spec/bencodr/integer_spec.rb",
+     "spec/bencodr/io_spec.rb",
      "spec/bencodr/list_spec.rb",
      "spec/bencodr/parser_spec.rb",
      "spec/bencodr/string_spec.rb",
@@ -53,6 +55,7 @@ Gem::Specification.new do |s|
     "spec/bencode_spec.rb",
      "spec/bencodr/dictionary_spec.rb",
      "spec/bencodr/integer_spec.rb",
+     "spec/bencodr/io_spec.rb",
      "spec/bencodr/list_spec.rb",
      "spec/bencodr/parser_spec.rb",
      "spec/bencodr/string_spec.rb",

data/lib/bencodr/io.rb

@@ -0,0 +1,60 @@
+class IO
+  class << self
+    # This method encodes the object and writes it to the specified output.
+    #
+    #   # write to standard out
+    #   IO.bencode(1, "string")             #=> "6:string" to stdout
+    #
+    #   # write to file
+    #   File.bencode("a.bencode", "string") #=> "6:string" to a.bencode
+    #
+    # @param [Object] fd the file descriptor to use for output
+    # @param [Object] object the object to write
+    def bencode(fd, object)
+      open(fd, "wb") {|file| file.bencode object }
+    end
+
+    # This method reads from the specified input and decodes the object.
+    #
+    #   # read from standard in
+    #   IO.bdecode(0)             #=> "string"
+    #
+    #   # read from file
+    #   File.bdecode("a.bencode") #=> "string"
+    #
+    # @param [Object] fd the file descriptor to use for input
+    # @param [Object] object the object to write
+    def bdecode(fd)
+      open(fd, "rb") {|file| file.bdecode}
+    end
+  end
+
+  # This method encodes the object and writes.
+  #
+  #   # write to standard out
+  #   $stdout.bencode("string") #=> "6:string" to stdout
+  #
+  #   # write to file
+  #   file = File.open("a.bencode", "wb")
+  #   file.bencode("string")    #=> "6:string" to a.bencode
+  #
+  # @param [Object] object the object to write
+  def bencode(object)
+    write object.bencode
+  end
+
+  # This method reads from the specified input and decodes the object.
+  #
+  #   # read from standard in
+  #   $stdin.bdecode  #=> "string"
+  #
+  #   # read from file
+  #   file = File.open("a.bencode", "wb")
+  #   file.bdecode    #=> "string"
+  #
+  # @param [Object] fd the file descriptor to use for input
+  # @param [Object] object the object to write
+  def bdecode
+    read.bdecode
+  end
+end

data/lib/bencodr.rb

@@ -7,6 +7,7 @@ require path + "/integer"
 require path + "/list"
 require path + "/dictionary"
 require path + "/parser"
+require path + "/io"
 
 module BEncodr
   class BEncodeError < StandardError; end
@@ -29,7 +30,7 @@ module BEncodr
     # @param [::String] file the file to decode
     # @return [::String, ::Integer, ::Hash, ::Array] the decoded object
     def decode_file(name)
-      decode(File.open(name, 'rb') {|file| file.read})
+      File.bdecode name
     end
 
     # This method encodes a bencoded object.
@@ -49,7 +50,7 @@ module BEncodr
     # @param [::String] file the file to write the bencoded object to
     # @param [#bencodr] object the object to encode
     def encode_file(name, object)
-      File.open(name, 'wb') {|file| file.write encode(object)}
+      File.bencode name, object
     end
   end
 end

data/spec/bencodr/io_spec.rb

@@ -0,0 +1,36 @@
+require "spec"
+
+describe File do
+  describe "#bencode" do
+    context "when an object gets bencoded and written to a file" do
+      before :all do
+        @path = "tmp"
+        Dir.mkdir(@path) unless File.exists? @path
+      end
+
+      before :each do
+        @file = File.join(@path, 'test.bencodr')
+        @object = "string"
+        File.bencode(@file, @object)
+      end
+
+      it "should actually write a file" do
+        File.exists?(@file).should be_true
+      end
+
+      describe "#bdecode" do
+        it "should properly encode the file" do
+          File.bdecode(@file).should == @object
+        end
+      end
+
+      after :each do
+        File.delete(@file)
+      end
+
+      after :all do
+        Dir.delete(@path) if File.exists? @path
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bencodr
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Allen Madsen
@@ -54,12 +54,14 @@ files:
 - lib/bencodr.rb
 - lib/bencodr/dictionary.rb
 - lib/bencodr/integer.rb
+- lib/bencodr/io.rb
 - lib/bencodr/list.rb
 - lib/bencodr/parser.rb
 - lib/bencodr/string.rb
 - spec/bencode_spec.rb
 - spec/bencodr/dictionary_spec.rb
 - spec/bencodr/integer_spec.rb
+- spec/bencodr/io_spec.rb
 - spec/bencodr/list_spec.rb
 - spec/bencodr/parser_spec.rb
 - spec/bencodr/string_spec.rb
@@ -100,6 +102,7 @@ test_files:
 - spec/bencode_spec.rb
 - spec/bencodr/dictionary_spec.rb
 - spec/bencodr/integer_spec.rb
+- spec/bencodr/io_spec.rb
 - spec/bencodr/list_spec.rb
 - spec/bencodr/parser_spec.rb
 - spec/bencodr/string_spec.rb