bindata 2.1.0 → 2.2.0

data/test/record_test.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.join(File.dirname(__FILE__), "common"))
+require File.expand_path(File.join(File.dirname(__FILE__), "test_helper"))
 
 describe BinData::Record do
   it "is not registered" do
@@ -117,7 +117,7 @@ describe BinData::Record, "with anonymous fields" do
     str = "\001\002\003\004\005"
     obj.read(str)
     obj.a.clear
-    obj.to_binary_s.must_equal "\012\002\003\004\012"
+    obj.to_binary_s.must_equal_binary "\012\002\003\004\012"
   end
 end
 
@@ -184,7 +184,7 @@ describe BinData::Record, "with multiple fields" do
   end
 
   it "writes ordered" do
-    obj.to_binary_s.must_equal "\x01\x02"
+    obj.to_binary_s.must_equal_binary "\x01\x02"
   end
 
   it "reads ordered" do
@@ -374,7 +374,60 @@ describe BinData::Record, "with an endian defined" do
 
     lambdaed = [1, 2.0, 3, 4, 5, 6, 7, 8].pack('veCCVvNn')
 
-    obj.to_binary_s.must_equal lambdaed
+    obj.to_binary_s.must_equal_binary lambdaed
+  end
+end
+
+describe BinData::Record, "with search_prefix" do
+  class ASprefix < BinData::Int8; end
+  class BSprefix < BinData::Int8; end
+
+  class RecordWithSearchPrefix < BinData::Record
+    search_prefix :a
+    sprefix :f
+  end
+
+  class RecordWithParentSearchPrefix < BinData::Record
+    search_prefix :a
+    struct :s do
+      sprefix :f
+    end
+  end
+
+  class RecordWithNestedSearchPrefix < BinData::Record
+    search_prefix :a
+    struct :s do
+      search_prefix :x
+      sprefix :f
+    end
+  end
+
+  class RecordWithPrioritisedNestedSearchPrefix < BinData::Record
+    search_prefix :b
+    struct :s do
+      search_prefix :a
+      sprefix :f
+    end
+  end
+
+  it "uses search_prefix" do
+    obj = RecordWithSearchPrefix.new
+    obj.f.class.name.must_equal "ASprefix"
+  end
+
+  it "uses parent search_prefix" do
+    obj = RecordWithParentSearchPrefix.new
+    obj.s.f.class.name.must_equal "ASprefix"
+  end
+
+  it "uses nested search_prefix" do
+    obj = RecordWithNestedSearchPrefix.new
+    obj.s.f.class.name.must_equal "ASprefix"
+  end
+
+  it "uses prioritised nested search_prefix" do
+    obj = RecordWithPrioritisedNestedSearchPrefix.new
+    obj.s.f.class.name.must_equal "ASprefix"
   end
 end
 
@@ -392,12 +445,12 @@ describe BinData::Record, "with endian :big_and_little" do
 
   it "creates big endian version" do
     obj = RecordWithBnLEndianBe.new
-    obj.to_binary_s.must_equal binary("\x00\x01")
+    obj.to_binary_s.must_equal_binary "\x00\x01"
   end
 
   it "creates little endian version" do
     obj = RecordWithBnLEndianLe.new
-    obj.to_binary_s.must_equal binary("\x01\x00")
+    obj.to_binary_s.must_equal_binary "\x01\x00"
   end
 
   it "requires :endian as argument" do
@@ -408,7 +461,28 @@ describe BinData::Record, "with endian :big_and_little" do
 
   it "accepts :endian as argument" do
     obj = RecordWithBnLEndian.new(:endian => :little)
-    obj.to_binary_s.must_equal binary("\x01\x00")
+    obj.to_binary_s.must_equal_binary "\x01\x00"
+  end
+end
+
+describe BinData::Record, "with endian :big_and_little and search_prefix" do
+  class NsBNLIntBe < BinData::Int16be; end
+  class NsBNLIntLe < BinData::Int16le; end
+
+  class RecordWithBnLEndianAndSearchPrefix < BinData::Record
+    endian :big_and_little
+    search_prefix :ns
+     bnl_int :a, :value => 1
+  end
+
+  it "creates big endian version" do
+    obj = RecordWithBnLEndianAndSearchPrefixBe.new
+    obj.to_binary_s.must_equal_binary "\x00\x01"
+  end
+
+  it "creates little endian version" do
+    obj = RecordWithBnLEndianAndSearchPrefixLe.new
+    obj.to_binary_s.must_equal_binary "\x01\x00"
   end
 end
 
@@ -429,12 +503,12 @@ describe BinData::Record, "with endian :big_and_little when subclassed" do
 
   it "creates big endian version" do
     obj = BRecordWithBnLEndianBe.new
-    obj.to_binary_s.must_equal binary("\x00\x01\x00\x02")
+    obj.to_binary_s.must_equal_binary "\x00\x01\x00\x02"
   end
 
   it "creates little endian version" do
     obj = BRecordWithBnLEndianLe.new
-    obj.to_binary_s.must_equal binary("\x01\x00\x02\x00")
+    obj.to_binary_s.must_equal_binary "\x01\x00\x02\x00"
   end
 
   it "requires :endian as argument" do
@@ -445,7 +519,7 @@ describe BinData::Record, "with endian :big_and_little when subclassed" do
 
   it "accepts :endian as argument" do
     obj = BRecordWithBnLEndian.new(:endian => :little)
-    obj.to_binary_s.must_equal binary("\x01\x00\x02\x00")
+    obj.to_binary_s.must_equal_binary "\x01\x00\x02\x00"
   end
 end
 
@@ -481,7 +555,7 @@ describe BinData::Record, "defined recursively" do
     obj.val = 5
     obj.nxt.val = 6
     obj.nxt.nxt.val = 7
-    obj.to_binary_s.must_equal "\x00\x05\x01\x00\x06\x01\x00\x07\x00"
+    obj.to_binary_s.must_equal_binary "\x00\x05\x01\x00\x06\x01\x00\x07\x00"
   end
 end
 
@@ -544,7 +618,7 @@ describe BinData::Record, "with :onlyif" do
   it "initial state" do
     obj.num_bytes.must_equal 2
     obj.snapshot.must_equal({:a => 3, :b => 5})
-    obj.to_binary_s.must_equal "\x03\x05"
+    obj.to_binary_s.must_equal_binary "\x03\x05"
   end
 
   it "identifies if fields are included" do

data/test/registry_test.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.join(File.dirname(__FILE__), "common"))
+require File.expand_path(File.join(File.dirname(__FILE__), "test_helper"))
 
 describe BinData::Registry do
   A = Class.new
@@ -59,10 +59,10 @@ describe BinData::Registry, "with numerics" do
   let(:r) { BinData::RegisteredClasses }
 
   it "lookup integers with endian" do
-    r.lookup("int24", :big).to_s.must_equal "BinData::Int24be"
-    r.lookup("int24", :little).to_s.must_equal "BinData::Int24le"
-    r.lookup("uint24", :big).to_s.must_equal "BinData::Uint24be"
-    r.lookup("uint24", :little).to_s.must_equal "BinData::Uint24le"
+    r.lookup("int24", {:endian => :big}).to_s.must_equal "BinData::Int24be"
+    r.lookup("int24", {:endian => :little}).to_s.must_equal "BinData::Int24le"
+    r.lookup("uint24", {:endian => :big}).to_s.must_equal "BinData::Uint24be"
+    r.lookup("uint24", {:endian => :little}).to_s.must_equal "BinData::Uint24le"
   end
 
   it "does not lookup integers without endian" do
@@ -76,18 +76,18 @@ describe BinData::Registry, "with numerics" do
       r.lookup("int3")
     }.must_raise BinData::UnRegisteredTypeError
     lambda {
-      r.lookup("int3", :big)
+      r.lookup("int3", {:endian => :big})
     }.must_raise BinData::UnRegisteredTypeError
     lambda {
-      r.lookup("int3", :little)
+      r.lookup("int3", {:endian => :little})
     }.must_raise BinData::UnRegisteredTypeError
   end
 
   it "lookup floats with endian" do
-    r.lookup("float", :big).to_s.must_equal "BinData::FloatBe"
-    r.lookup("float", :little).to_s.must_equal "BinData::FloatLe"
-    r.lookup("double", :big).to_s.must_equal "BinData::DoubleBe"
-    r.lookup("double", :little).to_s.must_equal "BinData::DoubleLe"
+    r.lookup("float", {:endian => :big}).to_s.must_equal "BinData::FloatBe"
+    r.lookup("float", {:endian => :little}).to_s.must_equal "BinData::FloatLe"
+    r.lookup("double", {:endian => :big}).to_s.must_equal "BinData::DoubleBe"
+    r.lookup("double", {:endian => :little}).to_s.must_equal "BinData::DoubleLe"
   end
 
   it "lookup bits" do
@@ -97,17 +97,17 @@ describe BinData::Registry, "with numerics" do
   end
 
   it "lookup bits by ignoring endian" do
-    r.lookup("bit2", :big).to_s.must_equal "BinData::Bit2"
-    r.lookup("bit3le", :big).to_s.must_equal "BinData::Bit3le"
-    r.lookup("bit2", :little).to_s.must_equal "BinData::Bit2"
-    r.lookup("bit3le", :little).to_s.must_equal "BinData::Bit3le"
+    r.lookup("bit2", {:endian => :big}).to_s.must_equal "BinData::Bit2"
+    r.lookup("bit3le", {:endian => :big}).to_s.must_equal "BinData::Bit3le"
+    r.lookup("bit2", {:endian => :little}).to_s.must_equal "BinData::Bit2"
+    r.lookup("bit3le", {:endian => :little}).to_s.must_equal "BinData::Bit3le"
   end
 
   it "lookup signed bits by ignoring endian" do
-    r.lookup("sbit2", :big).to_s.must_equal "BinData::Sbit2"
-    r.lookup("sbit3le", :big).to_s.must_equal "BinData::Sbit3le"
-    r.lookup("sbit2", :little).to_s.must_equal "BinData::Sbit2"
-    r.lookup("sbit3le", :little).to_s.must_equal "BinData::Sbit3le"
+    r.lookup("sbit2", {:endian => :big}).to_s.must_equal "BinData::Sbit2"
+    r.lookup("sbit3le", {:endian => :big}).to_s.must_equal "BinData::Sbit3le"
+    r.lookup("sbit2", {:endian => :little}).to_s.must_equal "BinData::Sbit2"
+    r.lookup("sbit3le", {:endian => :little}).to_s.must_equal "BinData::Sbit3le"
   end
 end
 
@@ -120,16 +120,37 @@ describe BinData::Registry, "with endian specific types" do
   end
   
   it "lookup little endian types" do
-    r.lookup('a', :little).must_equal A
+    r.lookup('a', {:endian => :little}).must_equal A
   end
 
   it "lookup big endian types" do
-    r.lookup('b', :big).must_equal B
+    r.lookup('b', {:endian => :big}).must_equal B
   end
 
   it "does not lookup types with non existent endian" do
     lambda {
-      r.lookup('a', :big)
+      r.lookup('a', {:endian => :big})
     }.must_raise BinData::UnRegisteredTypeError
   end
 end
+
+describe BinData::Registry, "with search_prefix" do
+  let(:r) { BinData::Registry.new }
+
+  before do
+    r.register('a_f', A)
+    r.register('b_f', B)
+  end
+
+  it "lookup single search_prefix" do
+    r.lookup('f', {:search_prefix => :a}).must_equal A
+  end
+
+  it "lookup multiple search_prefix" do
+    r.lookup('f', {:search_prefix => [:x, :a]}).must_equal A
+  end
+
+  it "lookup first match in search_prefix" do
+    r.lookup('f', {:search_prefix => [:a, :b]}).must_equal A
+  end
+end

data/test/rest_test.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.join(File.dirname(__FILE__), "common"))
+require File.expand_path(File.join(File.dirname(__FILE__), "test_helper"))
 
 describe BinData::Rest do
   let(:obj) { BinData::Rest.new }
@@ -17,7 +17,7 @@ describe BinData::Rest do
   it "allows setting value for completeness" do
     obj.assign("123")
     obj.must_equal "123"
-    obj.to_binary_s.must_equal "123"
+    obj.to_binary_s.must_equal_binary "123"
   end
 
   it "accepts BinData::BasePrimitive parameters" do

data/test/skip_test.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.join(File.dirname(__FILE__), "common"))
+require File.expand_path(File.join(File.dirname(__FILE__), "test_helper"))
 
 describe BinData::Skip do
   let(:obj) { BinData::Skip.new(:length => 5) }
@@ -8,7 +8,7 @@ describe BinData::Skip do
 
   it "initial state" do
     obj.must_equal ""
-    obj.to_binary_s.must_equal "\000" * 5
+    obj.to_binary_s.must_equal_binary "\000" * 5
   end
 
   it "skips bytes" do
@@ -18,11 +18,11 @@ describe BinData::Skip do
 
   it "has expected binary representation after setting value" do
     obj.assign("123")
-    obj.to_binary_s.must_equal "\000" * 5
+    obj.to_binary_s.must_equal_binary "\000" * 5
   end
 
   it "has expected binary representation after reading" do
     obj.read(io)
-    obj.to_binary_s.must_equal "\000" * 5
+    obj.to_binary_s.must_equal_binary "\000" * 5
   end
 end

data/test/string_test.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.join(File.dirname(__FILE__), "common"))
+require File.expand_path(File.join(File.dirname(__FILE__), "test_helper"))
 
 describe BinData::String, "with mutually exclusive parameters" do
   it ":value and :initial_value" do
@@ -249,7 +249,7 @@ describe BinData::String, "with :pad_front" do
 
     it "has to_binary_s" do
       obj.assign("abc")
-      obj.to_binary_s.must_equal "RRabc"
+      obj.to_binary_s.must_equal_binary "RRabc"
     end
 
     it "reads" do
@@ -267,19 +267,19 @@ describe BinData::String, "with Ruby 1.9 encodings" do
   end
 
   let(:obj) { UTF8String.new }
-  let(:binary_str) { binary("\xC3\x85\xC3\x84\xC3\x96") }
+  let(:binary_str) { "\xC3\x85\xC3\x84\xC3\x96" }
   let(:utf8_str) { binary_str.dup.force_encoding('UTF-8') }
 
   it "stores assigned values as binary" do
     obj.assign(utf8_str)
-    obj.to_binary_s.must_equal binary_str
+    obj.to_binary_s.must_equal_binary binary_str
   end
 
   it "stores read values as binary" do
-    obj = UTF8String.new(:read_length => binary_str.length)
+    obj = UTF8String.new(:read_length => binary_str.bytesize)
     obj.read(binary_str)
 
-    obj.to_binary_s.must_equal binary_str
+    obj.to_binary_s.must_equal_binary binary_str
   end
 
   it "returns values in correct encoding" do
@@ -291,7 +291,35 @@ describe BinData::String, "with Ruby 1.9 encodings" do
   it "has correct num_bytes" do
     obj.assign(utf8_str)
 
-    obj.num_bytes.must_equal binary_str.length
+    obj.num_bytes.must_equal binary_str.bytesize
   end
 end
 
+class Object
+  def must_warn(msg, &block)
+    result = ""
+    callable = proc { |str|
+      result = str
+    }
+    self.stub(:warn, callable) do
+      block.call
+    end
+    result.must_equal msg
+  end
+end
+
+describe BinData::String, "warnings" do
+  it "warns if has :asserted_value but no :length" do
+    obj = BinData::String.new(:asserted_value => "ABC")
+    obj.must_warn "obj does not have a :read_length parameter - returning empty string" do
+      lambda { obj.read("abcde") }.must_raise BinData::ValidityError
+    end
+  end
+
+  it "warns if has :value but no :read_length" do
+    obj = BinData::String.new(:value => "ABC")
+    obj.must_warn "obj does not have a :read_length parameter - returning empty string" do
+      obj.read("abcde")
+    end
+  end
+end

data/test/stringz_test.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.join(File.dirname(__FILE__), "common"))
+require File.expand_path(File.join(File.dirname(__FILE__), "test_helper"))
 
 describe BinData::Stringz, "when empty" do
   let(:obj) { BinData::Stringz.new }
@@ -8,7 +8,7 @@ describe BinData::Stringz, "when empty" do
   it "initial state" do
     obj.value.must_equal ""
     obj.num_bytes.must_equal 1
-    obj.to_binary_s.must_equal "\0"
+    obj.to_binary_s.must_equal_binary "\0"
   end
 end
 
@@ -18,7 +18,7 @@ describe BinData::Stringz, "with value set" do
   it "initial state" do
     obj.value.must_equal "abcd"
     obj.num_bytes.must_equal 5
-    obj.to_binary_s.must_equal "abcd\0"
+    obj.to_binary_s.must_equal_binary "abcd\0"
   end
 end
 
@@ -112,16 +112,16 @@ describe BinData::Stringz, "with max_length" do
 
   it "writes values greater than max_length" do
     obj.assign("abcde")
-    obj.to_binary_s.must_equal "abcd\0"
+    obj.to_binary_s.must_equal_binary "abcd\0"
   end
 
   it "writes values less than max_length" do
     obj.assign("abc")
-    obj.to_binary_s.must_equal "abc\0"
+    obj.to_binary_s.must_equal_binary "abc\0"
   end
 
   it "writes values exactly max_length" do
     obj.assign("abcd")
-    obj.to_binary_s.must_equal "abcd\0"
+    obj.to_binary_s.must_equal_binary "abcd\0"
   end
 end