bindata 2.4.10 → 2.4.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 651bb61168cb520dbec6550dc4ee3d566e950a0a4e3c373752a37d9ced6dc17e
-  data.tar.gz: 543f3849f0502255c976520e3d11f2e988f0733314b905d098b8617025ef2d99
+  metadata.gz: 80617b407b7a7c2213a57dd816a4c34b144dc7bf84cfbedb021b4121f733d375
+  data.tar.gz: 4a71111bd4ee444bd71bde4d2e1cf4242501618d4884b93f72eabdc7f0cd6ed6
 SHA512:
-  metadata.gz: 5ab4ddc205727d64b5b4f1354c6c738965745ff6736030f440c3982799351e68af06c9f1e0faff28d6e52830a0abf55d678a0ea7ffefa160f9f7bf3c309b6e7b
-  data.tar.gz: 834bdfa27436e578043e8b92ded99a02e6fc5ca2d0e11f0503bf3d8d68c1c7c9e491e66fe59f264156fb9675437cc9f014193f42132a8e6aec3a11b6f84f5312
+  metadata.gz: 4de56ea71fa7e19e79d668eca56fd767a6dc781ce2184ef6d0373835ca73650d423cecd65c9066a1cd3e2055d66f87223688b78737da5630401cda06ec6ab5ee
+  data.tar.gz: 33865f2dca175323ed73af86b52ec4c507b3b1ef1af6b4eeef103fbfe422607cb40476e558dda85e13ffad603ab6f8150a5798bdd1051a164dc54604ec7c5cf1

data/ChangeLog.rdoc

@@ -1,5 +1,33 @@
 = BinData Changelog
 
+== Version 2.4.15 (2023-02-07)
+
+* Added ruby 2.4.0 requirement to gemspec.  Thanks to theldoria.
+* Added github CI action.  Thanks to Peter Goldstein.
+* Convert file from latin1 to UTF-8.  Thanks to Cédric Boutillier.
+* Move license from dual license to solely BSD-2-Clause.
+* Remove unnecessary files from gem.  Requested by Orien Madgwick.
+* Allow multiple calls to auto_call_delayed_io.  Thanks to dwelch-r7.
+
+== Version 2.4.14 (2022-10-31)
+
+* Use Comparable#clamp instead of manual calculations.
+* Update tests to new minitest requirements.
+* Adjust tests due to changes in ruby 3.1
+
+== Version 2.4.13 (2022-10-16)
+
+* Relax over-strict parameter naming requirements.  Requested by
+  vinayak3qilabs.
+
+== 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/LICENSE

@@ -0,0 +1,25 @@
+BSD 2-Clause License
+
+Copyright (c) 2007-2022, Dion Mendel
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/NEWS.rdoc

@@ -1,3 +1,8 @@
+= 2.4.15
+
+This software was originally dual licensed under the Ruby license and the
+BSD-2-Clause license.  It is now licensed solely as BSD-2-Clause.
+
 = 2.4.0
 
 This release changes the internal API for sanitizing parameters.  This only

data/README.md

@@ -1,8 +1,8 @@
 # What is BinData?
 
-[![Version     ](http://img.shields.io/gem/v/bindata.svg)                       ](https://rubygems.org/gems/bindata)
-[![Travis CI   ](http://img.shields.io/travis/dmendel/bindata/master.svg)     ](https://travis-ci.org/dmendel/bindata)
-[![Coverage    ](http://img.shields.io/coveralls/dmendel/bindata.svg)         ](https://coveralls.io/r/dmendel/bindata)
+[![Version     ](https://img.shields.io/gem/v/bindata.svg)                       ](https://rubygems.org/gems/bindata)
+[![Github CI   ](https://github.com/dmendel/bindata/actions/workflows/ci.yml/badge.svg)     ](https://github.com/dmendel/bindata/actions/workflows/ci.yml)
+[![Coverage    ](https://img.shields.io/coveralls/dmendel/bindata.svg)         ](https://coveralls.io/r/dmendel/bindata)
 
 Do you ever find yourself writing code like this?
 

data/bindata.gemspec

@@ -12,8 +12,13 @@ Gem::Specification.new do |s|
   s.require_path = 'lib'
   s.extra_rdoc_files = ['NEWS.rdoc']
   s.rdoc_options << '--main' << 'NEWS.rdoc'
-  s.files = `git ls-files`.split("\n")
-  s.license = 'Ruby'
+  s.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |file|
+      file.start_with?(*%w[.git INSTALL])
+    end
+  end
+  s.license = 'BSD-2-Clause'
+  s.required_ruby_version = ">= 2.4.0"
 
   s.add_development_dependency('rake')
   s.add_development_dependency('minitest', "> 5.0.0", "< 5.12.0")

data/examples/NBT.txt

@@ -107,7 +107,7 @@ You should end up with this:
 	   TAG_Short("shortTest"): 32767
 	   TAG_Long("longTest"): 9223372036854775807
 	   TAG_Float("floatTest"): 0.49823147
-	   TAG_String("stringTest"): HELLO WORLD THIS IS A TEST STRING ���!
+	   TAG_String("stringTest"): HELLO WORLD THIS IS A TEST STRING ÅÄÖ!
 	   TAG_Int("intTest"): 2147483647
 	   TAG_Compound("nested compound test"): 2 entries
 	   {

data/lib/bindata/bits.rb

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

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
@@ -152,9 +159,10 @@ module BinData
       # The +auto_call_delayed_io+ keyword sets a data object tree to perform
       # multi pass I/O automatically.
       def auto_call_delayed_io
+        include AutoCallDelayedIO
+
         return if DelayedIO.method_defined? :initialize_instance_without_record_io
 
-        include AutoCallDelayedIO
         DelayedIO.send(:alias_method, :initialize_instance_without_record_io, :initialize_instance)
         DelayedIO.send(:define_method, :initialize_instance) do
           if @parent && !defined? @delayed_io_recorded

data/lib/bindata/dsl.rb

@@ -420,7 +420,7 @@ module BinData
       def ensure_valid_name(name)
         if name && !option?(:fieldnames_are_values)
           if malformed_name?(name)
-            raise NameError.new("", name), "field '#{name}' is an illegal fieldname"
+            raise SyntaxError, "field '#{name}' is an illegal fieldname"
           end
 
           if duplicate_name?(name)
@@ -428,11 +428,11 @@ module BinData
           end
 
           if name_shadows_method?(name)
-            raise NameError.new("", name), "field '#{name}' shadows an existing method"
+            raise SyntaxError, "field '#{name}' shadows an existing method"
           end
 
           if name_is_reserved?(name)
-            raise NameError.new("", name), "field '#{name}' is a reserved name"
+            raise SyntaxError, "field '#{name}' is a reserved name"
           end
         end
       end

data/lib/bindata/int.rb

@@ -59,16 +59,14 @@ module BinData
 
       def create_clamp_code(nbits, signed)
         if signed == :signed
-          max = "max = (1 << (#{nbits} - 1)) - 1"
-          min = "min = -(max + 1)"
+          max = "(1 << (#{nbits} - 1)) - 1"
+          min = "-((#{max}) + 1)"
         else
-          max = "max = (1 << #{nbits}) - 1"
-          min = "min = 0"
+          max = "(1 << #{nbits}) - 1"
+          min = "0"
         end
 
-        clamp = "(#{max}; #{min}; val = (val < min) ? min : (val > max) ? max : val)"
-
-        "val = #{clamp}"
+        "val = val.clamp(#{min}, #{max})"
       end
 
       def create_read_code(nbits, endian, signed)

data/lib/bindata/params.rb

@@ -116,7 +116,7 @@ module BinData
 
       def self.invalid_parameter_names
         @invalid_names ||= begin
-          all_names = LazyEvaluator.instance_methods(true) + Kernel.methods
+          all_names = LazyEvaluator.instance_methods(true)
           allowed_names = [:name, :type]
           invalid_names = (all_names - allowed_names).uniq
 

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.15"
 end

data/test/alignment_test.rb

@@ -14,20 +14,20 @@ describe BinData::ResumeByteAlignment do
   it "resets read alignment" do
     obj.read "\x12\x34"
 
-    obj.a.must_equal 1
-    obj.b.must_equal 3
+    _(obj.a).must_equal 1
+    _(obj.b).must_equal 3
   end
 
   it "resets write alignment" do
     obj.assign(a: 2, b: 7)
 
-    obj.to_binary_s.must_equal_binary "\x20\x70"
+    _(obj.to_binary_s).must_equal_binary "\x20\x70"
   end
 end
 
 describe BinData::BitAligned do
   it "does not apply to BinData::Primitives" do
-    lambda {
+    _ {
       class BitAlignedPrimitive < BinData::Primitive
         bit_aligned
       end
@@ -47,20 +47,20 @@ describe BinData::BitAligned do
   let(:obj) { BitAlignedRecord.new }
 
   it "#num_bytes as expected" do
-    obj.num_bytes.must_equal 3
+    _(obj.num_bytes).must_equal 3
   end
 
   it "has expected abs_offset" do
-    obj.str.abs_offset.must_equal 0
+    _(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})
+    _(obj.snapshot).must_equal({preamble: 5, str: "cd", afterward: 2})
   end
 
   it "writes as expected" do
     obj.assign(preamble: 5, str: "ab", afterward: 1)
-    obj.to_binary_s.must_equal_binary "\x56\x16\x21"
+    _(obj.to_binary_s).must_equal_binary "\x56\x16\x21"
   end
 end