bencodr 1.2.0 → 2.0.0

data/.gitignore

@@ -22,4 +22,6 @@ pkg
 .idea
 doc
 .yardoc
-tmp/*
+tmp/*
+.bundle
+Gemfile.lock

data/.rvmrc

@@ -0,0 +1 @@
+rvm --create use 1.9.2@bencodr

data/Gemfile

@@ -0,0 +1,3 @@
+source :gemcutter
+
+gemspec

data/{README.rdoc → README.md}

@@ -1,31 +1,70 @@
-= BEncodr
-* *Author* Allen Madsen (blatyo)
-* *My* *Site* http://www.allenmadsen.com
-* *Gem* http://gemcutter.org/gems/bencodr
-* *Source* http://github.com/blatyo/bencodr
-* *Documentation* http://blatyo.github.com/bencodr
-* *Issue* *Tracker* http://github.com/blatyo/bencodr/issues 
-
-== Synopsis
+# BEncodr
+* **Author** Allen Madsen (blatyo)
+* **My Site** http://www.allenmadsen.com
+* **Gem** http://gemcutter.org/gems/bencodr
+* **Source** http://github.com/blatyo/bencodr
+* **Issue Tracker** http://github.com/blatyo/bencodr/issues 
+
+## Synopsis
 This gem provides a way to encode and parse bencodings used by the Bit Torrent protocol.
 
-== Installation
+## Installation
 
-    # install the gem
-    > [sudo] gem install bencodr
-    Successfully installed bencodr
-    1 gem installed
-    Installing ri documentation for bencodr...
-    Building YARD (yri) index for bencodr...
-    Installing RDoc documentation for bencodr
+Install the gem:
 
-    # somefile.rb
+``` bash
+    gem install bencodr
+```
+
+Require it in your ruby files:
+
+``` ruby
     require 'bencodr'
+```
+
+## Usage
+### BEncodr
+Most of the functionality of this library can be accessed directly on the BEncodr class.
+
+``` ruby
+    # encoding is just like calling bencode on the object
+    BEncodr.bencode("string")    #=> "6:string"
 
-== Examples
-=== String
+    # decoding is just like calling bdecode on a bencoding
+    BEncodr.bdecode("6:string")  #=> "string"
+
+    # you can work directly with files too
+    BEncodr.bencode_file("my_awesome.torrent", {:announce => "http://www.sometracker.com/announce:80"})
+    BEncodr.bdecode_file("my_awesome.torrent") #=> {:announce => "http://www.sometracker.com/announce:80"}
+```
+    
+### Monkey Patching
+In order to get this functionality on the objects described below, you can call:
+
+``` ruby
+    BEncodr.include!
+```
+
+This will extend:
+
+* BEncodr::String
+    * String
+    * Symbol
+    * URI::Generic
+* BEncodr::Integer
+    * Numeric
+    * Time
+* BEncodr::List
+    * Array
+* BEncodr::Dictionary
+    * Hash
+* BEncodr::IO
+    * IO
+
+### String
 BEncoded strings are length-prefixed base ten followed by a colon and the string.
 
+``` ruby
     # strings
     "".bencode              #=> "0:"
     "string".bencode        #=> "6:string"
@@ -36,10 +75,12 @@ BEncoded strings are length-prefixed base ten followed by a colon and the string
     # URIs
     uri = URI.parse("http://github.com/blatyo/bencode")
     uri.bencode             #=> "32:http://github.com/blatyo/bencode"
+```
 
-=== Integer
+### Integer
 Bencoded integers are represented by an 'i' followed by the number in base 10 followed by an 'e'.
 
+``` ruby
     # integers
     1.bencode               #=> "i1e"
     -1.bencode              #=> "i-1e"
@@ -51,18 +92,22 @@ Bencoded integers are represented by an 'i' followed by the number in base 10 fo
 
     # times
     Time.at(4).bencode      #=> "i4e"
+```
 
-=== List
+### List
 Bencoded lists are encoded as an 'l' followed by their elements (also bencoded) followed by an 'e'.
 
+``` ruby
     # arrays
     [].bencode                        #=> "le"
     [:e, "a", 1, Time.at(11)].bencode #=> "l1:e1:ai1ei11ee"
+```
 
-=== Dictionary
+### Dictionary
 Bencoded dictionaries are encoded as a 'd' followed by a list of alternating keys and their corresponding values
 followed by an 'e'. Keys appear in sorted order (sorted as raw strings, not alphanumerics) and are always strings.
 
+``` ruby
     # hashes
     {}.bencode                          #=> "de"
     {"string" => "string"}.bencode      #=> "d6:string6:stringe"
@@ -79,18 +124,22 @@ followed by an 'e'. Keys appear in sorted order (sorted as raw strings, not alph
 
     # Note: keys are sorted as raw strings.
     {:a => 1, "A" => 1, 1=> 1}.bencode  #=> "d1:1i1e1:Ai1e1:ai1ee"
+```
 
-=== Decoding
+### Decoding
 You can decode a bencoding by calling bdecode on the string.
 
+``` ruby
     "6:string".bdecode  #=> "string"
     "i1e".bdecode       #=> 1
     "le".bdecode        #=> []
     "de".bdecode        #=> {}
+```
 
-=== IO and Files
+### IO and Files
 You can also write and read bencodings.
 
+``` ruby
     # write to standard out
     IO.bencode(1, "string")             #=> "6:string" to stdout
     $stdout.bencode("string")           #=> "6:string" to stdout
@@ -110,58 +159,44 @@ You can also write and read bencodings.
 
     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"
-
-    # you can work directly with files too
-    BEncodr.encode_file("my_awesome.torrent", {:announce => "http://www.sometracker.com/announce:80"})
-    BEncodr.decode_file("my_awesome.torrent") #=> {:announce => "http://www.sometracker.com/announce:80"}
-
-=== Registering Types
-When using bencodings it may be useful to translate your own objects into bencoded strings. You can do that with the
-register methods on each BEncode type. All register does is define a bencode instance method for the class that
-internally uses type conversion. That means if you want to specify a String type then your class must have a to_s or
-to_str instance method. The same goes for all the other types.
-
-Keep in mind when registering that if you register a class for two separate types it will only retain the bencode method
-of the last type registered for.
+### Make Your Own Objects Compatible
+When using bencodings it may be useful to translate your own objects into bencoded strings.
 
+``` ruby
     # register string type
-    BEncodr::String.register Range
+    Range.send :include, BEncodr::String
     (1..2).bencode      #=> "4:1..2"
 
     # register integer type
-    BEncodr::Integer.register NilClass
+    NilClass.send :include, BEncodr::Integer
     nil.bencode         #=> "i0e"
 
     # register list type
-    BEncodr::List.register Range
+    Range.send :include, BEncodr::List
     (1..2).bencode      #=> "li1ei2ee"
 
     #register dictionary type
     MyClass = Class.new do
+      include BEncodr::Dictionary
+      
       def to_h
         {:a => "a", :b => "b"}
       end
     end
-    BEncodr::Dictionary.register MyClass
+
     MyClass.new.bencode #=> "d1:a1:a1:b1:be"
+```
 
-== Note on Reporting Issues
+## 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
+## Note on Patches/Pull Requests
 
 * Fork the project.
 * Make your feature addition or bug fix.
@@ -171,6 +206,6 @@ of the last type registered for.
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-== Copyright
+## Copyright
 
 Copyright (c) 2010 Allen Madsen. See LICENSE for details.

data/Rakefile

@@ -1,45 +1,5 @@
-require 'rubygems'
-require 'rake'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "bencodr"
-    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.email = "blatyo@gmail.com"
-    gem.homepage = "http://github.com/blatyo/bencodr"
-    gem.authors = ["Allen Madsen"]
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.add_development_dependency "yard", ">= 0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
-end
-
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
-
-task :spec => :check_dependencies
-
-task :default => :spec
-
-begin
-  require 'yard'
-  YARD::Rake::YardocTask.new
-rescue LoadError
-  task :yardoc do
-    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
-  end
-end
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)

data/bencodr.gemspec

@@ -1,81 +1,24 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "bencodr/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{bencodr}
-  s.version = "1.2.0"
+  s.name        = "bencodr"
+  s.version     = BEncodr::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Allen Madsen"]
+  s.email       = ["blatyo@gmail.com"]
+  s.homepage    = "http://github.com/blatyo/bencodr"
+  s.summary     = "This gem provides a way to encode and decode bencode used by the Bit Torrent protocol."
+  s.description = "This gem provides a way to encode and decode bencode used by the Bit Torrent protocol. Normal ruby objects can be marshalled as bencode and demarshalled back to ruby."
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Allen Madsen"]
-  s.date = %q{2010-02-04}
-  s.description = %q{This gem provides a way to encode and parse bencodings used by the Bit Torrent protocol.}
-  s.email = %q{blatyo@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".autotest",
-     ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "autotest/discover.rb",
-     "bencodr.gemspec",
-     "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",
-     "spec/samples/bencode.rb.torrent",
-     "spec/samples/mini.bencode",
-     "spec/samples/python.torrent",
-     "spec/spec.opts",
-     "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/blatyo/bencodr}
-  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.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",
-     "spec/spec_helper.rb"
-  ]
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
+  s.required_rubygems_version = ">= 1.3.6"
+  s.add_development_dependency "rspec",   "~> 2.1.0"
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "fuubar",  ">= 0.0.1"
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
-      s.add_development_dependency(%q<yard>, [">= 0"])
-    else
-      s.add_dependency(%q<rspec>, [">= 1.2.9"])
-      s.add_dependency(%q<yard>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<rspec>, [">= 1.2.9"])
-    s.add_dependency(%q<yard>, [">= 0"])
-  end
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
 end
-

data/lib/bencodr.rb

@@ -1,56 +1,39 @@
 # encoding: UTF-8
 
-path = File.expand_path(File.dirname(__FILE__)) + "/bencodr"
+path = File.expand_path(File.dirname(__FILE__)) + "/bencodr/"
 
-require path + "/string"
-require path + "/integer"
-require path + "/list"
-require path + "/dictionary"
-require path + "/parser"
-require path + "/io"
+require path + "string"
+require path + "integer"
+require path + "list"
+require path + "dictionary"
+require path + "object"
+require path + "parser"
+require path + "io"
+require path + "ext"
+require path + "version"
 
 module BEncodr
   class BEncodeError < StandardError; end
 
   class << self
-    # This method decodes a bencoded string.
-    #
-    #   BEncode.decode("6:string") #=> "string"
-    #
-    # @param [::String] string the bencoded string to decode
-    # @return [::String, ::Integer, ::Hash, ::Array] the decoded object
-    def decode(string)
-      string.bdecode
+    def bdecode(object)
+      BEncodr::Object.bdecode(object)
     end
 
-    # This method decodes a bencoded file.
-    #
-    #   BEncode.decode_file("simple.torrent") #=> "d8:announce32:http://www..."
-    #
-    # @param [::String] file the file to decode
-    # @return [::String, ::Integer, ::Hash, ::Array] the decoded object
-    def decode_file(name)
-      File.bdecode name
+    def bdecode_file(fd)
+      ::File.open(fd, "rb") {|file| bdecode(file.read)}
     end
 
-    # This method encodes a bencoded object.
-    #
-    #   BEncode.encode("string") #=> "6:string"
-    #
-    # @param [#bencodr] object the object to encode
-    # @return [::String] the bencoded object
-    def encode(object)
-      object.bencode
+    def bencode(object)
+      BEncodr::Object.bencode(object)
     end
 
-    # This method encodes a bencoded object.
-    #
-    #   BEncode.encode("string") #=> "6:string"
-    #
-    # @param [::String] file the file to write the bencoded object to
-    # @param [#bencodr] object the object to encode
-    def encode_file(name, object)
-      File.bencode name, object
+    def bencode_file(fd, object)
+      ::File.open(fd, "wb") {|file| file.write(bencode(object))}
+    end
+
+    def include!
+      Ext.include!
     end
   end
-end
+end