bencodr 1.2.0 → 2.0.0

data/spec/bencodr/string_spec.rb

@@ -1,73 +1,6 @@
 # encoding: UTF-8
-
-require "spec"
 require "spec_helper"
 
-describe String do
-  describe "#bencodr" do
-    it "should encode a string" do
-      "string".bencode.should == "6:string"
-    end
-
-    it "should encode a zero length string" do
-      "".bencode.should == "0:"
-    end
-  end
-end
-
-describe Symbol do
-  describe "#bencodr" do
-    it "should encode a symbol" do
-      :symbol.bencode.should == "6:symbol"
-    end
-  end
-end
-
-describe URI::Generic do
-  describe "#bencodr" do
-    it "should encode a http uri" do
-      uri = URI.parse("http://github.com/blatyo/bencodr")
-      uri.bencode.should == "32:http://github.com/blatyo/bencodr"
-    end
-
-    it "should encode a https uri" do
-      uri = URI.parse("https://github.com/blatyo/bencodr")
-      uri.bencode.should == "33:https://github.com/blatyo/bencodr"
-    end
-
-    it "should encode a ftp uri" do
-      uri = URI.parse("ftp://github.com/blatyo/bencodr")
-      uri.bencode.should == "31:ftp://github.com/blatyo/bencodr"
-    end
-
-    it "should encode a ldap uri" do
-      uri = URI.parse("ldap://github.com/blatyo/bencodr")
-      uri.bencode.should == "32:ldap://github.com/blatyo/bencodr"
-    end
-
-    it "should encode a mailto uri" do
-      uri = URI.parse("mailto:sudo@sudoers.su")
-      uri.bencode.should == "22:mailto:sudo@sudoers.su"
-    end
-  end
-end
-
 describe BEncodr::String do
-  describe "#register" do
-    context "once an object has been registered as a BEncode string" do
-      before :all do
-        BEncodr::String.register Range
-      end
-
-      context "an instance of that object" do
-        it "should respond to bencodr" do
-          (1..2).should respond_to :bencode
-        end
-
-        it "should encode to a bencoded string" do
-          (1..2).bencode.should == "4:1..2"
-        end
-      end
-    end
-  end
+  it_behaves_like "BEncodr::String", BEncodr::String
 end

data/spec/custom_matchers.rb

@@ -0,0 +1,87 @@
+RSpec::Matchers.define :bencode_to do |expected|
+  match do |actual|
+    actual.bencode.should equal(expected)
+  end
+  
+  failure_message_for_should do |actual|
+    "expected that #{actual} would bencode to #{expected}"
+  end
+end
+
+RSpec::Matchers.define :bencode do |actual|
+  chain :to do |_expected|
+    @_expected = _expected
+  end
+  
+  match do |klass|
+    klass.bencode(actual).should == @_expected
+  end
+  
+  failure_message_for_should do |klass|
+    "expected #{klass.name} to bencode #{actual} to #{@_expected}"
+  end
+end
+
+RSpec::Matchers.define :parse do |actual|
+  chain :as do |type|
+    @type = type
+  end
+  
+  chain :to do |_expected|
+    @_expected = _expected
+  end
+  
+  match do |klass|
+    scanner = StringScanner.new(actual)
+    klass.send(:"parse_#{@type}", scanner).should == @_expected
+  end
+  
+  failure_message_for_should do |klass|
+    "expected #{klass.name} to bdencode #{actual} as #{@type} to #{@_expected}"
+  end
+end
+
+RSpec::Matchers.define :generate_parse_error do |expected|
+  chain :for do |type|
+    @type = type
+  end
+  
+  chain :with do |_actual|
+    @_actual = _actual
+  end
+  
+  match do |klass|
+    scanner = StringScanner.new(@_actual)
+    lambda do
+      klass.send(:"parse_#{@type}", scanner)
+    end.should raise_error(expected)
+  end
+  
+  failure_message_for_should do |klass|
+    "expected #{klass.name} to generate parse error #{expected.name} for #{@type} with #{actual}"
+  end
+end
+
+RSpec::Matchers.define :bdecode_to do |expected|
+  match do |actual|
+    actual.bdecode.should == expected
+  end
+  
+  failure_message_for_should do |actual|
+    "expected that #{actual} would bdecode to #{expected}"
+  end
+end
+
+RSpec::Matchers.define :bdecode do |actual|
+  chain :to do |_expected|
+    @_expected = _expected
+  end
+  
+  match do |klass|
+    klass.bdecode(actual).should == @_expected
+  end
+  
+  failure_message_for_should do |actual|
+    "expected that #{klass.name} would bdecode #{actual} to #{expected}"
+  end
+end

data/spec/shared_examples.rb

@@ -0,0 +1,91 @@
+shared_examples_for "BEncodr::String" do |obj|
+  subject{ obj }
+  
+  describe "#bencode" do
+    it{ should bencode("string").to("6:string") }
+    it{ should bencode("").to("0:") }
+    it{ should bencode(:symbol).to("6:symbol") }
+    it{ should bencode(URI.parse("http://github.com/blatyo/bencodr")).to("32:http://github.com/blatyo/bencodr") }
+    it{ should bencode(URI.parse("https://github.com/blatyo/bencodr")).to("33:https://github.com/blatyo/bencodr") }
+    it{ should bencode(URI.parse("ftp://github.com/blatyo/bencodr")).to("31:ftp://github.com/blatyo/bencodr") }
+    it{ should bencode(URI.parse("ldap://github.com/blatyo/bencodr")).to("32:ldap://github.com/blatyo/bencodr") }
+    it{ should bencode(URI.parse("mailto:sudo@sudoers.su")).to("22:mailto:sudo@sudoers.su") }
+  end
+end
+
+shared_examples_for "BEncodr::Integer" do |obj|
+  subject{ obj }
+  
+  describe "#bencodr" do
+    it{ should bencode(1).to("i1e") }
+    it{ should bencode(-1).to("i-1e") }
+    it{ should bencode(10_000_000_000).to("i10000000000e") }
+    it{ should bencode(-10_000_000_000).to("i-10000000000e") }
+    it{ should bencode(1.1).to("i1e") }
+    it{ should bencode(-1.1).to("i-1e") }
+    it{ should bencode(1e10).to("i10000000000e") }
+    it{ should bencode(-1e10).to("i-10000000000e") }
+    it{ should bencode(Time.at(4)).to("i4e") }
+  end
+end
+
+shared_examples_for "BEncodr::List" do |obj|
+  subject{ obj }
+  
+  describe "#bencode" do
+    it{ should bencode([]).to("le") }
+    it{ should bencode([:e, "a", 1, Time.at(11)]).to("l1:e1:ai1ei11ee") }
+  end
+end
+
+shared_examples_for "BEncodr::Dictionary" do |obj|
+  subject{ obj }
+  
+  describe "#bencode" do
+    it{ should bencode({}).to("de") }
+    it{ should bencode({:a => 1, "A" => 1, 1=> 1}).to("d1:1i1e1:Ai1e1:ai1ee")}
+
+    context "a key should always be encoded as a string" do
+      it{ should bencode({"string" => "string"}).to("d6:string6:stringe") }
+      it{ should bencode({:symbol => :symbol}).to("d6:symbol6:symbole") }
+      it{ should bencode({1 => 1}).to("d1:1i1ee")}
+      it{ should bencode({1.1 => 1.1}).to("d3:1.1i1ee") }
+      it{ should bencode({{} => {}}).to("d2:{}dee") }
+      
+      it{
+        uri = URI.parse("http://github.com/blatyo/bencode")
+        should bencode({uri => uri}).to("d32:http://github.com/blatyo/bencode32:http://github.com/blatyo/bencodee")
+      }
+
+      it{
+        time = Time.utc(0)
+        should bencode({time => time}).to("d23:0000-01-01 00:00:00 UTCi-62167219200ee")
+      }
+
+      it{
+        array = (1..4).to_a
+        should bencode({array => array}).to("d12:[1, 2, 3, 4]li1ei2ei3ei4eee")
+      }
+    end
+  end
+end
+
+shared_examples_for "BEncode decoder" do |klass|
+  subject{ klass }
+  
+  it{ should bdecode("6:string").to("string") }
+  it{ should bdecode("0:").to("") }
+  it{ should bdecode("6:symbol").to("symbol") }
+  it{ should bdecode("32:http://github.com/blatyo/bencodr").to("http://github.com/blatyo/bencodr") }
+  it{ should bdecode("33:https://github.com/blatyo/bencodr").to("https://github.com/blatyo/bencodr") }
+  it{ should bdecode("31:ftp://github.com/blatyo/bencodr").to("ftp://github.com/blatyo/bencodr") }
+  it{ should bdecode("32:ldap://github.com/blatyo/bencodr").to("ldap://github.com/blatyo/bencodr") }
+  it{ should bdecode("22:mailto:sudo@sudoers.su").to("mailto:sudo@sudoers.su") }
+end
+
+shared_examples_for "a BEncodr extension" do |obj, klass|
+  subject{ obj }
+  
+  it{ should respond_to(:bencode) }
+  it{ should be_a(klass) }
+end

data/spec/spec_helper.rb

@@ -1,11 +1,10 @@
-# encoding: UTF-8
+require File.join(File.dirname(__FILE__), '..', 'lib', 'bencodr')
+require 'rspec'
+require 'fuubar'
+require 'custom_matchers'
+require 'shared_examples'
 
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'bencodr'
-require 'spec'
-require 'spec/autorun'
-
-Spec::Runner.configure do |config|
-  
+Rspec.configure do |c|
+  c.formatter = Fuubar
+  c.color_enabled = true
 end

metadata

@@ -1,7 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: bencodr
 version: !ruby/object:Gem::Version 
-  version: 1.2.0
+  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors: 
 - Allen Madsen
@@ -9,101 +10,127 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-04 00:00:00 -05:00
+date: 2011-06-11 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.9
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: yard
+        version: 1.0.0
   type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: fuubar
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-description: This gem provides a way to encode and parse bencodings used by the Bit Torrent protocol.
-email: blatyo@gmail.com
+        version: 0.0.1
+  type: :development
+  version_requirements: *id003
+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.
+email: 
+- blatyo@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
 - .autotest
 - .document
 - .gitignore
+- .rvmrc
+- Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
-- VERSION
-- autotest/discover.rb
 - bencodr.gemspec
 - lib/bencodr.rb
 - lib/bencodr/dictionary.rb
+- lib/bencodr/ext.rb
 - lib/bencodr/integer.rb
 - lib/bencodr/io.rb
 - lib/bencodr/list.rb
+- lib/bencodr/object.rb
 - lib/bencodr/parser.rb
 - lib/bencodr/string.rb
+- lib/bencodr/version.rb
 - spec/bencode_spec.rb
 - spec/bencodr/dictionary_spec.rb
+- spec/bencodr/ext_spec.rb
 - spec/bencodr/integer_spec.rb
 - spec/bencodr/io_spec.rb
 - spec/bencodr/list_spec.rb
+- spec/bencodr/object_spec.rb
 - spec/bencodr/parser_spec.rb
 - spec/bencodr/string_spec.rb
+- spec/custom_matchers.rb
 - spec/samples/bencode.rb.torrent
 - spec/samples/mini.bencode
 - spec/samples/python.torrent
-- spec/spec.opts
+- spec/shared_examples.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/blatyo/bencodr
 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 
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+      version: 1.3.6
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.6.2
 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 provides a way to encode and decode bencode used by the Bit Torrent protocol.
 test_files: 
 - spec/bencode_spec.rb
 - spec/bencodr/dictionary_spec.rb
+- spec/bencodr/ext_spec.rb
 - spec/bencodr/integer_spec.rb
 - spec/bencodr/io_spec.rb
 - spec/bencodr/list_spec.rb
+- spec/bencodr/object_spec.rb
 - spec/bencodr/parser_spec.rb
 - spec/bencodr/string_spec.rb
+- spec/custom_matchers.rb
+- spec/samples/bencode.rb.torrent
+- spec/samples/mini.bencode
+- spec/samples/python.torrent
+- spec/shared_examples.rb
 - spec/spec_helper.rb

data/VERSION

@@ -1 +0,0 @@
-1.2.0