bindata 2.4.4 → 2.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc513e5824615b4b143e4a733bd6e8290bdfa831ab111267475a167f31125bb1
-  data.tar.gz: 93b4a5203a1d641dd1af806b769f92f8daf50644e9815d01fa2dbfec9f30bc8e
+  metadata.gz: 651bb61168cb520dbec6550dc4ee3d566e950a0a4e3c373752a37d9ced6dc17e
+  data.tar.gz: 543f3849f0502255c976520e3d11f2e988f0733314b905d098b8617025ef2d99
 SHA512:
-  metadata.gz: 88c701264083edfa92d193c33d394f7cb4bdc2f12722089ff27bb296bad28665f8e28a63158c98a8a45a189c68ce4792c027615ac0c9f1c61cacee1e02e817cc
-  data.tar.gz: dd1f06f1b17cbc005ca5399d86b62cfe420787d8a2f820d24f589f30dd58af99ed539eb5d5873f90b3877f986093a3bc5f176dcb7aaaeea176381809272b20ff
+  metadata.gz: 5ab4ddc205727d64b5b4f1354c6c738965745ff6736030f440c3982799351e68af06c9f1e0faff28d6e52830a0abf55d678a0ea7ffefa160f9f7bf3c309b6e7b
+  data.tar.gz: 834bdfa27436e578043e8b92ded99a02e6fc5ca2d0e11f0503bf3d8d68c1c7c9e491e66fe59f264156fb9675437cc9f014193f42132a8e6aec3a11b6f84f5312

data/.travis.yml

@@ -1,9 +1,11 @@
 language: ruby
 rvm:
-  - 2.0
-  - 2.1.10
   - 2.2
   - 2.3
+  - 2.4
+  - 2.5
+  - 2.6
+  - 2.7
   - jruby
   - ruby-head
 

data/ChangeLog.rdoc

@@ -1,5 +1,33 @@
 = BinData Changelog
 
+== Version 2.4.10 (2021-05-18)
+
+* Improve speed of dynamic object creation.  Reported by Charlie Ablett.
+
+== Version 2.4.9 (2021-04-22)
+
+* Change example from Fixnum to Integer.  Thanks to Tim Chambers.
+* Now works with frozen string literals.  Requested by Jeremy Evans.
+
+== Version 2.4.8 (2020-07-21)
+
+* Bug fix array self assignment.  Thanks to Spencer McIntyre.
+* Bug fix Stringz max_length.  Thanks to cdelafuente-r7.
+
+== Version 2.4.7 (2020-03-31)
+
+* Fix choice assignment inside arrays.  Reported by Spencer McIntyre.
+
+== Version 2.4.6 (2020-02-27)
+
+* More encoding fixes.  Thanks to Aaron Patterson.
+
+== Version 2.4.5 (2020-02-21)
+
+* Small typo fixes to examples.
+* Fix encoding issue for ruby 2.7.  Thanks to Aaron Patterson.
+* Quieter test output.
+
 == Version 2.4.4 (2018-10-03)
 
 * Display a hint when endian is omitted.  Requested by Tails.

data/bindata.gemspec

@@ -8,17 +8,15 @@ Gem::Specification.new do |s|
   s.summary = 'A declarative way to read and write binary file formats'
   s.author = 'Dion Mendel'
   s.email = 'bindata@dm9.info'
-  s.homepage = 'http://github.com/dmendel/bindata'
-  s.rubyforge_project = 'bindata'
+  s.homepage = 'https://github.com/dmendel/bindata'
   s.require_path = 'lib'
-  s.has_rdoc = true
   s.extra_rdoc_files = ['NEWS.rdoc']
   s.rdoc_options << '--main' << 'NEWS.rdoc'
   s.files = `git ls-files`.split("\n")
   s.license = 'Ruby'
 
   s.add_development_dependency('rake')
-  s.add_development_dependency('minitest', "> 5.0.0")
+  s.add_development_dependency('minitest', "> 5.0.0", "< 5.12.0")
   s.add_development_dependency('coveralls')
   s.description = <<-END.gsub(/^ +/, "")
     BinData is a declarative way to read and write binary file formats.

data/examples/list.rb

@@ -105,7 +105,7 @@ class Term < BinData::Record
   end
 
   def self.encode(val)
-    if Fixnum === val
+    if Integer === val
       Term.new(tag: 'a', term: Atom.encode(val))
     else
       Term.new(tag: 'l', term: List.encode(val))

data/examples/tcp_ip.rb

@@ -14,7 +14,7 @@ class MacAddr < BinData::Primitive
   array :octets, type: :uint8, initial_length: 6
 
   def set(val)
-    self.octets = val.split(/\./).collect(&:to_i)
+    self.octets = val.split(/:/).collect(&:to_i)
   end
 
   def get
@@ -23,7 +23,7 @@ class MacAddr < BinData::Primitive
 end
 
 # Present IP addresses in a human readable way
-class IPAddr < BinData::Primitive
+class IP_Addr < BinData::Primitive
   array :octets, type: :uint8, initial_length: 4
 
   def set(val)

data/lib/bindata/alignment.rb

@@ -47,7 +47,7 @@ module BinData
       end
       def readbytes(n)
         n.times.inject("") do |bytes, _|
-          bytes << @io.readbits(8, :big).chr
+          bytes += @io.readbits(8, :big).chr
         end
       end
     end

data/lib/bindata/array.rb

@@ -80,9 +80,11 @@ module BinData
     end
 
     def assign(array)
+      return if self.equal?(array)  # prevent self assignment
       raise ArgumentError, "can't set a nil value for #{debug_name}" if array.nil?
 
-      @element_list = to_storage_formats(array.to_ary)
+      @element_list = []
+      concat(array)
     end
 
     def snapshot
@@ -119,7 +121,17 @@ module BinData
 
     def insert(index, *objs)
       extend_array(index - 1)
-      elements.insert(index, *to_storage_formats(objs))
+      abs_index = (index >= 0) ? index : index + 1 + length
+
+      # insert elements before...
+      new_elements = objs.map { new_element }
+      elements.insert(index, *new_elements)
+
+      # ...assigning values
+      objs.each_with_index do |obj, i|
+        self[abs_index + i] = obj
+      end
+
       self
     end
 
@@ -238,10 +250,6 @@ module BinData
       end
     end
 
-    def to_storage_formats(els)
-      els.collect { |el| new_element(el) }
-    end
-
     def elements
       @element_list ||= []
     end
@@ -252,8 +260,8 @@ module BinData
       element
     end
 
-    def new_element(value = nil)
-      @element_prototype.instantiate(value, self)
+    def new_element
+      @element_prototype.instantiate(nil, self)
     end
 
     def sum_num_bytes_for_all_elements

data/lib/bindata/base.rb

@@ -172,8 +172,7 @@ module BinData
     def to_binary_s(&block)
       io = BinData::IO.create_string_io
       write(io, &block)
-      io.rewind
-      io.read
+      io.string
     end
 
     # Returns the hexadecimal string representation of this data object.

data/lib/bindata/bits.rb

@@ -115,14 +115,14 @@ module BinData
         end
 
         if signed == :signed
-          max = (1 << (nbits - 1)) - 1
-          min = -(max + 1)
+          max = "max = (1 << (#{nbits} - 1)) - 1"
+          min = "min = -(max + 1)"
         else
-          min = 0
-          max = (1 << nbits) - 1
+          min = "min = 0"
+          max = "max = (1 << #{nbits}) - 1"
         end
 
-        clamp = "(val < #{min}) ? #{min} : (val > #{max}) ? #{max} : val"
+        clamp = "(#{max}; #{min}; val = (val < min) ? min : (val > max) ? max : val)"
 
         if nbits == 1
           # allow single bits to be used as booleans

data/lib/bindata/int.rb

@@ -59,14 +59,16 @@ module BinData
 
       def create_clamp_code(nbits, signed)
         if signed == :signed
-          max = (1 << (nbits - 1)) - 1
-          min = -(max + 1)
+          max = "max = (1 << (#{nbits} - 1)) - 1"
+          min = "min = -(max + 1)"
         else
-          max = (1 << nbits) - 1
-          min = 0
+          max = "max = (1 << #{nbits}) - 1"
+          min = "min = 0"
         end
 
-        "val = (val < #{min}) ? #{min} : (val > #{max}) ? #{max} : val"
+        clamp = "(#{max}; #{min}; val = (val < min) ? min : (val > max) ? max : val)"
+
+        "val = #{clamp}"
       end
 
       def create_read_code(nbits, endian, signed)
@@ -107,7 +109,7 @@ module BinData
         parts = (0...nwords).collect do |i|
                   "(ints.at(#{idx[i]}) << #{bits_per_word(nbits) * i})"
                 end
-        parts[0].sub!(/ << 0\b/, "")  # Remove " << 0" for optimisation
+        parts[0] = parts[0].sub(/ << 0\b/, "")  # Remove " << 0" for optimisation
 
         parts.join(" + ")
       end
@@ -132,7 +134,7 @@ module BinData
         mask   = (1 << bits_per_word(nbits)) - 1
 
         vals = (0...nwords).collect { |i| "val >> #{bits_per_word(nbits) * i}" }
-        vals[0].sub!(/ >> 0\b/, "")  # Remove " >> 0" for optimisation
+        vals[0] = vals[0].sub(/ >> 0\b/, "")  # Remove " >> 0" for optimisation
         vals.reverse! if (endian == :big)
 
         vals = vals.collect { |val| "#{val} & #{mask}" }  # TODO: "& mask" is needed to work around jruby bug. Remove this line when fixed.
@@ -160,7 +162,7 @@ module BinData
         directives = { 8 => "C", 16 => "S", 32 => "L", 64 => "Q" }
 
         d = directives[bits_per_word(nbits)]
-        d << ((endian == :big) ? ">" : "<") unless d == "C"
+        d += ((endian == :big) ? ">" : "<") unless d == "C"
 
         if signed == :signed && directives.key?(nbits)
           (d * nwords).downcase

data/lib/bindata/io.rb

@@ -169,7 +169,7 @@ module BinData
 
           unless @read_data.empty? || @in_readahead
             bytes_to_consume = [n, @read_data.length].min
-            data << @read_data.slice!(0, bytes_to_consume)
+            data += @read_data.slice!(0, bytes_to_consume)
             n -= bytes_to_consume
 
             if @read_data.empty?
@@ -180,10 +180,10 @@ module BinData
           end
 
           raw_data = @raw_io.read(n)
-          data << raw_data if raw_data
+          data += raw_data if raw_data
 
           if @in_readahead
-            @read_data << data
+            @read_data += data
           end
 
           @offset += data.size
@@ -213,7 +213,9 @@ module BinData
 
     # Creates a StringIO around +str+.
     def self.create_string_io(str = "")
-      StringIO.new(str.dup.force_encoding(Encoding::BINARY))
+      s = StringIO.new(str.dup.force_encoding(Encoding::BINARY))
+      s.binmode
+      s
     end
 
     # Create a new IO Read wrapper around +io+.  +io+ must provide #read,

data/lib/bindata/stringz.rb

@@ -54,7 +54,7 @@ module BinData
       # read until zero byte or we have read in the max number of bytes
       while ch != "\0" && i != max_length
         ch = io.readbytes(1)
-        str << ch
+        str += ch
         i += 1
       end
 
@@ -80,7 +80,7 @@ module BinData
     def trim_to!(str, max_length = nil)
       if max_length
         max_length = 1 if max_length < 1
-        str.slice!(max_length)
+        str.slice!(max_length..-1)
         if str.length == max_length && str[-1, 1] != "\0"
           str[-1, 1] = "\0"
         end

data/lib/bindata/version.rb

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

data/test/array_test.rb

@@ -266,6 +266,11 @@ describe BinData::Array, "when accessing elements" do
     lambda { obj["a"] }.must_raise TypeError
     lambda { obj[1, "a"] }.must_raise TypeError
   end
+
+  it "is unaffected by self assignment" do
+    obj.assign(obj)
+    obj.snapshot.must_equal [1, 2, 3, 4, 5]
+  end
 end
 
 describe BinData::Array, "with :read_until" do

data/test/bits_test.rb

@@ -101,14 +101,14 @@ def generate_bit_classes_to_test(endian, signed)
 
   (start .. 64).each do |nbits|
     name = "#{base}#{nbits}"
-    name << "le" if endian == :little
+    name += "le" if endian == :little
     obj = BinData.const_get(name).new
     bits << [obj, nbits]
   end
 
   (start .. 64).each do |nbits|
     name = "#{base}"
-    name << "Le" if endian == :little
+    name += "Le" if endian == :little
     obj = BinData.const_get(name).new(nbits: nbits)
     bits << [obj, nbits]
   end

data/test/buffer_test.rb

@@ -153,4 +153,3 @@ describe BinData::Buffer, "nested buffers" do
     obj.to_binary_s.must_equal_binary "abcdeABCDE12345"
   end
 end
-

data/test/delayed_io_test.rb

@@ -99,7 +99,7 @@ describe BinData::DelayedIO, "subclassed with a single type" do
   end
 
   it "writes explicitly" do
-    io = StringIO.new "\001\002\003\004\005\006\007\010\011"
+    io = StringIO.new "\001\002\003\004\005\006\007\010\011".dup
     obj = IntDelayedIO.new(3)
     obj.write(io)
     obj.write_now!
@@ -107,7 +107,7 @@ describe BinData::DelayedIO, "subclassed with a single type" do
   end
 
   it "writes explicitly after setting abs_offset" do
-    io = StringIO.new "\001\002\003\004\005\006\007\010\011"
+    io = StringIO.new "\001\002\003\004\005\006\007\010\011".dup
     obj = IntDelayedIO.new(7)
     obj.write(io)
 
@@ -139,7 +139,7 @@ describe BinData::DelayedIO, "subclassed with multiple types" do
   end
 
   it "writes explicitly" do
-    io = StringIO.new "\001\002\003\004\005\006\007\010\011\012\013\014\015"
+    io = StringIO.new "\001\002\003\004\005\006\007\010\011\012\013\014\015".dup
     obj = StringDelayedIO.new(str: "hello")
     obj.write(io)
     obj.write_now!

data/test/int_test.rb

@@ -128,7 +128,7 @@ module AllIntegers
   end
 
   def int_to_binary_str(val)
-    str = "".force_encoding(Encoding::BINARY)
+    str = "".dup.force_encoding(Encoding::BINARY)
     v = val & ((1 << (@nbytes * 8)) - 1)
     @nbytes.times do
       str.concat(v & 0xff)

data/test/offset_test.rb

@@ -74,9 +74,15 @@ describe BinData::Base, "offsets" do
     end
 
     it "adjust offset when incorrect" do
-      io.seek(2)
-      obj = TenByteOffsetBase.create(adjust_offset: 13)
-      obj.read(io).snapshot.must_equal data[2 + 13, 3]
+      w, $-w = $-w, false
+
+      begin
+        io.seek(2)
+        obj = TenByteOffsetBase.create(adjust_offset: 13)
+        obj.read(io).snapshot.must_equal data[2 + 13, 3]
+      ensure
+        $-w = w
+      end
     end
 
     it "succeeds when offset is correct" do

data/test/registry_test.rb

@@ -36,10 +36,16 @@ describe BinData::Registry do
   end
 
   it "allows overriding of registered classes" do
-    r.register('A', A)
-    r.register('A', B)
+    w, $-w = $-w, false
 
-    r.lookup('a').must_equal B
+    begin
+      r.register('A', A)
+      r.register('A', B)
+
+      r.lookup('a').must_equal B
+    ensure
+      $-w = w
+    end
   end
 
   it "converts CamelCase to underscores" do

data/test/stringz_test.rb

@@ -106,12 +106,12 @@ describe BinData::Stringz, "with max_length" do
   end
 
   it "trims values greater than max_length" do
-    obj.assign("abcde")
+    obj.assign("abcdefg")
     obj.must_equal "abcd"
   end
 
   it "writes values greater than max_length" do
-    obj.assign("abcde")
+    obj.assign("abcdefg")
     obj.to_binary_s.must_equal_binary "abcd\0"
   end
 

data/test/system_test.rb

@@ -360,3 +360,37 @@ describe BinData::Record, "with boolean parameters" do
     obj.a.must_equal 2
   end
 end
+
+describe BinData::Record, "encoding" do
+  class EncodingTestBufferRecord < BinData::Record
+    endian :big
+    default_parameter length: 5
+
+    uint16 :num
+    string :str, length: 10
+  end
+
+  it "returns binary encoded data" do
+    obj = EncodingTestBufferRecord.new(num: 3)
+    obj.to_binary_s.encoding.must_equal Encoding::ASCII_8BIT
+  end
+
+  it "returns binary encoded data with utf-8 string" do
+    obj = EncodingTestBufferRecord.new(num: 3, str: "日本語")
+    obj.to_binary_s.encoding.must_equal Encoding::ASCII_8BIT
+  end
+
+  it "returns binary encoded data despite Encoding.default_internal" do
+    w, $-w = $-w, false
+    before_enc = Encoding.default_internal
+
+    begin
+      Encoding.default_internal = Encoding::UTF_8
+      obj = EncodingTestBufferRecord.new(num: 3, str: "日本語")
+      obj.to_binary_s.encoding.must_equal Encoding::ASCII_8BIT
+    ensure
+      Encoding.default_internal = before_enc
+      $-w = w
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bindata
 version: !ruby/object:Gem::Version
-  version: 2.4.4
+  version: 2.4.10
 platform: ruby
 authors:
 - Dion Mendel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-03 00:00:00.000000000 Z
+date: 2021-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -31,6 +31,9 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.12.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +41,9 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.12.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -143,7 +149,7 @@ files:
 - test/uint8_array_test.rb
 - test/virtual_test.rb
 - test/warnings_test.rb
-homepage: http://github.com/dmendel/bindata
+homepage: https://github.com/dmendel/bindata
 licenses:
 - Ruby
 metadata: {}
@@ -164,8 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: bindata
-rubygems_version: 2.7.6
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: A declarative way to read and write binary file formats