bindata 2.2.0 → 2.3.0

data/lib/bindata/lazy.rb

@@ -48,7 +48,7 @@ module BinData
     # Returns the index of this data object inside it's nearest container
     # array.
     def index
-      return @overrides[:index] if @overrides and @overrides.has_key?(:index)
+      return @overrides[:index] if defined? @overrides and @overrides.has_key?(:index)
 
       child = @obj
       parent = @obj.parent

data/lib/bindata/offset.rb

@@ -1,4 +1,13 @@
 module BinData
+  # WARNING: THIS IS UNSUPPORTED!!
+  #
+  # This was a (failed) experimental feature that allowed seeking within the
+  # input stream.  It remains here for backwards compatability for the few
+  # people that used it.
+  #
+  # The official way to skip around the stream is to use BinData::Skip with
+  # the `:to_abs_offset` parameter.
+  #
   # == Parameters
   #
   # Parameters may be provided at initialisation to control the behaviour of
@@ -77,4 +86,9 @@ module BinData
       end
     end
   end
+
+  # Add these offset options to Base
+  class Base
+    include CheckOrAdjustOffsetPlugin
+  end
 end

data/lib/bindata/primitive.rb

@@ -69,6 +69,7 @@ module BinData
     mandatory_parameter :struct_params
 
     def initialize_instance
+      super
       @struct = BinData::Struct.new(get_parameter(:struct_params), self)
     end
 

data/lib/bindata/sanitize.rb

@@ -28,7 +28,7 @@ module BinData
     end
 
     def has_parameter?(param)
-      if @factory
+      if defined? @factory
         @factory.has_parameter?(param)
       else
         @obj_params.has_parameter?(param)
@@ -200,7 +200,7 @@ module BinData
         self[:endian] ||= hints[:endian]
       end
 
-      if hints[:search_prefix]
+      if hints[:search_prefix] and not hints[:search_prefix].empty?
         self[:search_prefix] = Array(self[:search_prefix]).concat(Array(hints[:search_prefix]))
       end
 
@@ -217,19 +217,19 @@ module BinData
 
     def warn_replacement_parameter(bad_key, suggested_key)
       if has_parameter?(bad_key)
-        warn ":#{bad_key} is not used with #{@the_class}.  " +
+        Kernel.warn ":#{bad_key} is not used with #{@the_class}.  " +
         "You probably want to change this to :#{suggested_key}"
       end
     end
 
-    def warn_renamed_parameter(old_key, new_key)
-      val = delete(old_key)
-      if val
-        self[new_key] = val
-        warn ":#{old_key} has been renamed to :#{new_key} in #{@the_class}.  " +
-        "Using :#{old_key} is now deprecated and will be removed in the future"
-      end
-    end
+#    def warn_renamed_parameter(old_key, new_key)
+#      val = delete(old_key)
+#      if val
+#        self[new_key] = val
+#        Kernel.warn ":#{old_key} has been renamed to :#{new_key} in #{@the_class}.  " +
+#        "Using :#{old_key} is now deprecated and will be removed in the future"
+#      end
+#    end
 
     def must_be_integer(*keys)
       keys.each do |key|

data/lib/bindata/skip.rb

@@ -4,7 +4,7 @@ module BinData
   # Skip will skip over bytes from the input stream.  If the stream is not
   # seekable, then the bytes are consumed and discarded.
   #
-  # When writing, skip will write <tt>:length</tt> number of zero bytes.
+  # When writing, skip will write the appropriate number of zero bytes.
   #
   #   require 'bindata'
   #
@@ -21,22 +21,40 @@ module BinData
   # Skip objects accept all the params that BinData::BasePrimitive
   # does, as well as the following:
   #
-  # <tt>:length</tt>:: The number of bytes to skip.
+  # <tt>:length</tt>::        The number of bytes to skip.
+  # <tt>:to_abs_offset</tt>:: Skips to the given absolute offset.
   #
   class Skip < BinData::BasePrimitive
 
-    mandatory_parameter :length
+    arg_processor :skip
+
+    optional_parameters :length, :to_abs_offset
+    mutually_exclusive_parameters :length, :to_abs_offset
+
+    def initialize_shared_instance
+      extend SkipLengthPlugin      if has_parameter?(:length)
+      extend SkipToAbsOffsetPlugin if has_parameter?(:to_abs_offset)
+      super
+    end
 
     #---------------
     private
 
     def value_to_binary_string(val)
-      len = eval_parameter(:length)
-      "\000" * len
+      len = skip_length
+      if len < 0
+        raise ValidityError, "#{debug_name} attempted to seek backwards by #{len.abs} bytes"
+      end
+
+      "\000" * skip_length
     end
 
     def read_and_return_value(io)
-      len = eval_parameter(:length)
+      len = skip_length
+      if len < 0
+        raise ValidityError, "#{debug_name} attempted to seek backwards by #{len.abs} bytes"
+      end
+
       io.seekbytes(len)
       ""
     end
@@ -45,4 +63,27 @@ module BinData
       ""
     end
   end
+
+  class SkipArgProcessor < BaseArgProcessor
+    def sanitize_parameters!(obj_class, params)
+      unless (params.has_parameter?(:length) or params.has_parameter?(:to_abs_offset))
+        raise ArgumentError, "#{obj_class} requires either :length or :to_abs_offset"
+      end
+      params.must_be_integer(:to_abs_offset, :length)
+    end
+  end
+
+  # Logic for the :length parameter
+  module SkipLengthPlugin
+    def skip_length
+      eval_parameter(:length)
+    end
+  end
+
+  # Logic for the :to_abs_offset parameter
+  module SkipToAbsOffsetPlugin
+    def skip_length
+      eval_parameter(:to_abs_offset) - abs_offset
+    end
+  end
 end

data/lib/bindata/struct.rb

@@ -126,7 +126,7 @@ module BinData
     def offset_of(child) #:nodoc:
       instantiate_all_objs
       sum = sum_num_bytes_below_index(find_index_of(child))
-      child.do_num_bytes.is_a?(Integer) ? sum.ceil : sum.floor
+      child.bit_aligned? ? sum.floor : sum.ceil
     end
 
     def do_read(io) #:nodoc:

data/lib/bindata/version.rb

@@ -1,3 +1,3 @@
 module BinData
-  VERSION = "2.2.0"
+  VERSION = "2.3.0"
 end

data/lib/bindata/warnings.rb

@@ -28,12 +28,5 @@ module BinData
         fail "#{caller[0]} remove the call to super in #initialize_instance"
       end
     end
-
-    # #offset has been renamed to #abs_offset.
-    # Eventually #rel_offset will be renamed to #offset.
-    def offset
-      warn "#offset is deprecated in #{debug_name}. Use #abs_offset instead"
-      abs_offset
-    end
   end
 end

data/test/alignment_test.rb

@@ -50,6 +50,10 @@ describe BinData::BitAligned do
     obj.num_bytes.must_equal 3
   end
 
+  it "has expected abs_offset" do
+    obj.str.abs_offset.must_equal 0
+  end
+
   it "reads as expected" do
     obj.read("\x56\x36\x42")
     obj.snapshot.must_equal({:preamble => 5, :str => "cd", :afterward => 2})

data/test/array_test.rb

@@ -17,11 +17,30 @@ describe BinData::Array, "when instantiating" do
     end
   end
 
+  it "warns about :length" do
+    Kernel.must_warn ":length is not used with BinData::Array.  You probably want to change this to :initial_length" do
+    obj = BinData::Array.new(:type => :uint8, :length => 3)
+      obj.read "123"
+    end
+  end
+
+  it "warns about :read_length" do
+    Kernel.must_warn ":read_length is not used with BinData::Array.  You probably want to change this to :initial_length" do
+    obj = BinData::Array.new(:type => :uint8, :read_length => 3)
+      obj.read "123"
+    end
+  end
+
   it "fails if a given type is unknown" do
     args = {:type => :does_not_exist, :initial_length => 3}
     lambda { BinData::Array.new(args) }.must_raise BinData::UnRegisteredTypeError
   end
 
+  it "fails if :initial_length is not an integer" do
+    args = {:type => :uint8, :initial_length => "3"}
+    lambda { BinData::Array.new(args) }.must_raise ArgumentError
+  end
+
   it "does not allow both :initial_length and :read_until" do
     args = {:initial_length => 3, :read_until => lambda { false } }
     lambda { BinData::Array.new(args) }.must_raise ArgumentError

data/test/base_primitive_test.rb

@@ -194,6 +194,12 @@ describe BinData::BasePrimitive, "asserting value" do
   let(:io) { ExampleSingle.io_with_value(12) }
 
   describe ":assert is non boolean" do
+    it "asserts sensible value" do
+      data = ExampleSingle.new(:assert => 0)
+      data.assert!
+      data.value.must_equal 0
+    end
+
     it "succeeds when assert is correct" do
       data = ExampleSingle.new(:assert => 12)
       data.read(io)

data/test/base_test.rb

@@ -83,8 +83,8 @@ describe BinData::Base do
   class BaseStub < BinData::Base
     # Override to avoid NotImplemented errors
     def clear?; end
-    def assign(x); @data = x; end
-    def snapshot; @data; end
+    def assign(x); end
+    def snapshot; end
     def do_read(io) end
     def do_write(io) end
     def do_num_bytes; end

data/test/bits_test.rb

@@ -218,4 +218,14 @@ describe "Bits of size 1" do
       obj.must_equal 0
     end
   end
+
+  it "must not be signed" do
+    lambda {
+      BinData::Sbit1
+    }.must_raise RuntimeError
+
+    lambda {
+      BinData::Sbit1le
+    }.must_raise RuntimeError
+  end
 end

data/test/buffer_test.rb

@@ -54,6 +54,7 @@ describe BinData::Buffer, "subclassed with a single type" do
 
   it "has total num_bytes" do
     obj = IntBuffer.new
+    assert obj.clear?
     obj.num_bytes.must_equal 5
   end
 end

data/test/delayed_io_test.rb

@@ -0,0 +1,223 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__), "test_helper"))
+
+describe BinData::DelayedIO, "when instantiating" do
+  describe "with no mandatory parameters supplied" do
+    it "raises an error" do
+      args = {}
+      lambda { BinData::DelayedIO.new(args) }.must_raise ArgumentError
+    end
+  end
+
+  describe "with some but not all mandatory parameters supplied" do
+    it "raises an error" do
+      args = {:read_abs_offset => 3}
+      lambda { BinData::DelayedIO.new(args) }.must_raise ArgumentError
+    end
+  end
+
+  it "fails if a given type is unknown" do
+    args = {:type => :does_not_exist, :length => 3}
+    lambda { BinData::DelayedIO.new(args) }.must_raise BinData::UnRegisteredTypeError
+  end
+
+  it "accepts BinData::Base as :type" do
+    obj = BinData::Int8.new(:initial_value => 5)
+    array = BinData::DelayedIO.new(:type => obj, :read_abs_offset => 3)
+    array.must_equal 5
+  end
+end
+
+describe BinData::DelayedIO, "subclassed with a single type" do
+  class IntDelayedIO < BinData::DelayedIO
+    endian :big
+    default_parameter :read_abs_offset => 5
+
+    uint16
+  end
+
+  it "behaves as type" do
+    obj = IntDelayedIO.new(3)
+    obj.must_equal 3
+  end
+
+  it "does not read" do
+    obj = IntDelayedIO.read "\001\002\003\004\005\006\007"
+    assert obj.clear?
+  end
+
+  it "does not do_num_bytes" do
+    obj = IntDelayedIO.new(3)
+    obj.do_num_bytes.must_equal 0
+  end
+
+  it "does num_bytes" do
+    obj = IntDelayedIO.new(3)
+    obj.num_bytes.must_equal 2
+  end
+
+  it "does not write" do
+    io = StringIO.new
+    obj = IntDelayedIO.new(3)
+    obj.write(io)
+    io.value.must_equal ""
+  end
+
+  it "uses read_abs_offset" do
+    obj = IntDelayedIO.new(3)
+    obj.abs_offset.must_equal 5
+    obj.rel_offset.must_equal 5
+  end
+
+  it "uses abs_offset if set" do
+    obj = IntDelayedIO.new(3)
+    obj.abs_offset = 10
+    obj.abs_offset.must_equal 10
+    obj.rel_offset.must_equal 10
+  end
+
+  it "must call #read before #read_now!" do
+    obj = IntDelayedIO.new(3)
+    lambda {
+      obj.read_now!
+    }.must_raise IOError
+  end
+
+  it "reads explicitly" do
+    obj = IntDelayedIO.read "\001\002\003\004\005\006\007"
+    obj.read_now!
+
+    obj.must_equal 0x0607
+  end
+
+  it "must call #write before #write_now!" do
+    obj = IntDelayedIO.new(3)
+    lambda {
+      obj.write_now!
+    }.must_raise IOError
+  end
+
+  it "writes explicitly" do
+    io = StringIO.new "\001\002\003\004\005\006\007\010\011"
+    obj = IntDelayedIO.new(3)
+    obj.write(io)
+    obj.write_now!
+    io.value.must_equal "\001\002\003\004\005\000\003\010\011"
+  end
+
+  it "writes explicitly after setting abs_offset" do
+    io = StringIO.new "\001\002\003\004\005\006\007\010\011"
+    obj = IntDelayedIO.new(7)
+    obj.write(io)
+
+    obj.abs_offset = 1
+    obj.write_now!
+    io.value.must_equal "\001\000\007\004\005\006\007\010\011"
+  end
+end
+
+describe BinData::DelayedIO, "subclassed with multiple types" do
+  class StringDelayedIO < BinData::DelayedIO
+    endian :big
+    default_parameter :read_abs_offset => 5
+
+    uint16 :len, :value => lambda { str.length }
+    string :str, :read_length => :len
+  end
+
+  it "behaves as type" do
+    obj = StringDelayedIO.new(:str => "hello")
+    obj.snapshot.must_equal({:len => 5, :str => "hello"})
+  end
+
+  it "reads explicitly" do
+    obj = StringDelayedIO.read "\001\002\003\004\005\000\003abc\013"
+    obj.read_now!
+
+    obj.snapshot.must_equal({:len => 3, :str => "abc"})
+  end
+
+  it "writes explicitly" do
+    io = StringIO.new "\001\002\003\004\005\006\007\010\011\012\013\014\015"
+    obj = StringDelayedIO.new(:str => "hello")
+    obj.write(io)
+    obj.write_now!
+    io.value.must_equal "\001\002\003\004\005\000\005hello\015"
+  end
+end
+
+describe BinData::DelayedIO, "inside a Record" do
+  class DelayedIORecord < BinData::Record
+    endian :little
+
+    uint16 :str_length, :value => lambda { str.length }
+    delayed_io :str, :read_abs_offset => 4 do
+      string :read_length => :str_length
+    end
+    delayed_io :my_int, :read_abs_offset => 2 do
+      uint16 :initial_value => 7
+    end
+  end
+
+  it "reads" do
+    obj = DelayedIORecord.read "\x05\x00\x03\x0012345"
+    obj.num_bytes.must_equal 2
+    obj.snapshot.must_equal({:str_length => 0, :str => "", :my_int => 7})
+  end
+
+  it "reads explicitly" do
+    obj = DelayedIORecord.read "\x05\x00\x03\x0012345"
+    obj.str.read_now!
+    obj.my_int.read_now!
+    obj.num_bytes.must_equal 2
+    obj.snapshot.must_equal({:str_length => 5, :str => "12345", :my_int => 3})
+  end
+
+  it "writes" do
+    obj = DelayedIORecord.new(:str => "abc", :my_int => 2)
+    io = StringIO.new
+    obj.write(io)
+    obj.str.write_now!
+    obj.my_int.write_now!
+    io.value.must_equal "\x03\x00\x02\x00abc"
+  end
+end
+
+describe BinData::DelayedIO, "with auto_call" do
+  class AutoCallDelayedIORecord < BinData::Record
+    auto_call_delayed_io
+    uint8 :a
+    delayed_io :b, :read_abs_offset => 1 do
+      uint8
+    end
+  end
+
+  it "class reads" do
+    obj = AutoCallDelayedIORecord.read "\x01\x02"
+    obj.snapshot.must_equal({:a => 1, :b => 2})
+  end
+
+  it "reads" do
+    obj = AutoCallDelayedIORecord.new
+    obj.read "\x01\x02"
+    obj.snapshot.must_equal({:a => 1, :b => 2})
+  end
+
+  it "writes" do
+    obj = AutoCallDelayedIORecord.new(:a => 1, :b => 2)
+    io = StringIO.new
+    obj.write(io)
+    io.value.must_equal "\x01\x02"
+  end
+
+  it "to_binary_s" do
+    obj = AutoCallDelayedIORecord.new(:a => 1, :b => 2)
+    obj.to_binary_s.must_equal_binary "\x01\x02"
+  end
+
+  it "num_bytes" do
+    obj = AutoCallDelayedIORecord.new(:a => 1, :b => 2)
+    obj.num_bytes.must_equal 2
+  end
+end