bindata 2.4.10 → 2.4.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 651bb61168cb520dbec6550dc4ee3d566e950a0a4e3c373752a37d9ced6dc17e
-  data.tar.gz: 543f3849f0502255c976520e3d11f2e988f0733314b905d098b8617025ef2d99
+  metadata.gz: 3688cea66b3a68f7f45ecd4b89b632e9e4438ee40ff4f59c57bbe0a68130e7d6
+  data.tar.gz: 647a570fd024d8938297d2fb4d2ac0123d03befaf0e5d3441627601d86694d8f
 SHA512:
-  metadata.gz: 5ab4ddc205727d64b5b4f1354c6c738965745ff6736030f440c3982799351e68af06c9f1e0faff28d6e52830a0abf55d678a0ea7ffefa160f9f7bf3c309b6e7b
-  data.tar.gz: 834bdfa27436e578043e8b92ded99a02e6fc5ca2d0e11f0503bf3d8d68c1c7c9e491e66fe59f264156fb9675437cc9f014193f42132a8e6aec3a11b6f84f5312
+  metadata.gz: ddb2cd1156f3200fcc1bcce2d1a0bf5554f52babd692652debb71a8b56a9dced9c0f76db22884599f475b91d549f915344fcc1ec71a7f28be8dcb87192c968a5
+  data.tar.gz: ea223714bb2753b3b5dd626711dbffdc328ed326d2218a5ef2d8817ad797de66299d438dbf2ad8a9904ea774e758efd8c6bef47bafe51e391247d32acc92f5ee

data/ChangeLog.rdoc

@@ -1,5 +1,13 @@
 = BinData Changelog
 
+== Version 2.4.12 (2022-10-03)
+
+* Do not include DelayedIO objects when :onlyif is false.
+
+== Version 2.4.11 (2022-09-27)
+
+* Make DelayedIO work with :onlyif.  Reported by Spencer McIntyre.
+
 == Version 2.4.10 (2021-05-18)
 
 * Improve speed of dynamic object creation.  Reported by Charlie Ablett.

data/lib/bindata/delayed_io.rb

@@ -116,9 +116,14 @@ module BinData
       0
     end
 
+    def include_obj?
+      ! has_parameter?(:onlyif) || eval_parameter(:onlyif)
+    end
+
     # DelayedIO objects aren't read when #read is called.
     # The reading is delayed until this method is called.
     def read_now!
+      return unless include_obj?
       raise IOError, "read from where?" unless @read_io
 
       @read_io.seekbytes(abs_offset - @read_io.offset)
@@ -130,7 +135,9 @@ module BinData
     # DelayedIO objects aren't written when #write is called.
     # The writing is delayed until this method is called.
     def write_now!
+      return unless include_obj?
       raise IOError, "write to where?" unless @write_io
+
       @write_io.seekbytes(abs_offset - @write_io.offset)
       @type.do_write(@write_io)
     end

data/lib/bindata/struct.rb

@@ -1,4 +1,5 @@
 require 'bindata/base'
+require 'bindata/delayed_io'
 
 module BinData
 
@@ -136,12 +137,12 @@ module BinData
 
     def do_read(io) #:nodoc:
       instantiate_all_objs
-      @field_objs.each { |f| f.do_read(io) if include_obj?(f) }
+      @field_objs.each { |f| f.do_read(io) if include_obj_for_io?(f) }
     end
 
     def do_write(io) #:nodoc
       instantiate_all_objs
-      @field_objs.each { |f| f.do_write(io) if include_obj?(f) }
+      @field_objs.each { |f| f.do_write(io) if include_obj_for_io?(f) }
     end
 
     def do_num_bytes #:nodoc:
@@ -263,6 +264,12 @@ module BinData
       end
     end
 
+    def include_obj_for_io?(obj)
+      # Used by #do_read and #do_write, to ensure the stream is passed to
+      # DelayedIO objects for delayed processing.
+      include_obj?(obj) || DelayedIO === obj
+    end
+
     def include_obj?(obj)
       !obj.has_parameter?(:onlyif) || obj.eval_parameter(:onlyif)
     end

data/lib/bindata/version.rb

@@ -1,3 +1,3 @@
 module BinData
-  VERSION = "2.4.10"
+  VERSION = "2.4.12"
 end

data/test/delayed_io_test.rb

@@ -184,6 +184,51 @@ describe BinData::DelayedIO, "inside a Record" do
   end
 end
 
+describe BinData::DelayedIO, "inside a Record with onlyif" do
+  class DelayedIOOnlyIfRecord < BinData::Record
+    endian :little
+
+    uint8 :flag
+    delayed_io :my_int1, read_abs_offset: 4, onlyif: -> { flag != 0 } do
+      uint16 initial_value: 6
+    end
+    delayed_io :my_int2, read_abs_offset: 2, onlyif: -> { flag == 0 } do
+      uint16 initial_value: 7
+    end
+  end
+
+  it "reads" do
+    obj = DelayedIOOnlyIfRecord.read "\x01\x00\x03\x0012345"
+    obj.num_bytes.must_equal 1
+    obj.snapshot.must_equal({flag: 1, my_int1: 6})
+  end
+
+  it "reads explicitly when flag is set" do
+    obj = DelayedIOOnlyIfRecord.read "\x01\xff\x01\x00\x02\x00"
+    obj.my_int1.read_now!
+    obj.my_int2.read_now!
+    obj.num_bytes.must_equal 1
+    obj.snapshot.must_equal({flag: 1, my_int1: 2})
+  end
+
+  it "reads explicitly when flag is not set" do
+    obj = DelayedIOOnlyIfRecord.read "\x00\xff\x01\x00\x02\x00"
+    obj.my_int1.read_now!
+    obj.my_int2.read_now!
+    obj.num_bytes.must_equal 1
+    obj.snapshot.must_equal({flag: 0, my_int2: 1})
+  end
+
+  it "writes" do
+    obj = DelayedIOOnlyIfRecord.new(flag:1, my_int1: 3, my_int2: 4)
+    io = StringIO.new
+    obj.write(io)
+    obj.my_int1.write_now!
+    obj.my_int2.write_now!
+    io.value.must_equal "\x01\x00\x00\x00\x03\x00"
+  end
+end
+
 describe BinData::DelayedIO, "with auto_call" do
   class AutoCallDelayedIORecord < BinData::Record
     auto_call_delayed_io

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bindata
 version: !ruby/object:Gem::Version
-  version: 2.4.10
+  version: 2.4.12
 platform: ruby
 authors:
 - Dion Mendel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-05-18 00:00:00.000000000 Z
+date: 2022-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake