bindata 2.4.3 → 2.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dd9ce2f3336fc2e9f8e3250a278732351d6a1af220603fb62763b3ef83caaf5e
-  data.tar.gz: f8f15a3836564c6a51891231a276ed0848cc92bdb4663c5aca6d4eecd0f53ec4
+  metadata.gz: 930073ad9a50e67aa2d584a17c0138f3cb4008e4bd96851ceef305e16c7cadd2
+  data.tar.gz: ec59bb6fcff33192da1ee33952c69e1069c214c0f41f9b21786694ed7fa4c87c
 SHA512:
-  metadata.gz: 5abcc6829c6b6ea410bc3c542d4b60d40a83e6ac883bb3a4b09dfefdc1e5a4ae1d37307d75e53cbbc1593a17dd327269974835a6f0936f2ab21f66fe69f120ba
-  data.tar.gz: ba8d7abcaac0ceb95acb6ffa8b24b7253495241fbd483ef887103a63d5c65c9649954a1998a70289e64823d0fb85bef1ba22a5bfb126b1cae9708a7412658220
+  metadata.gz: c2ebc4a2e56294d7b503d73cfee08fa165c37b96a4216e6ac17206b2566d3b5ea77adb188b819a8e63bf1a059ab79d068d1def5059d7b2b6811609f099a3656f
+  data.tar.gz: 96c38802d6197001dfbfb76a4a338bcc7dbf2e8f7ec685b5007cdc6a8917b502ad8bc1ca106323a52f3555cada27f1b90ba204a5c72253447983026af020c27f

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,30 @@
 = BinData Changelog
 
+== 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.
+* Add thread safety to Integer/BitField creation.  Requested by jbpeirce.
+* Ensure windows sockets are unseekable.  Thanks to Brent Cook.
+
 == Version 2.4.3 (2018-03-10)
 
 * Add Uint8Arrays.  Requested by masarakki.

data/README.md

@@ -2,7 +2,6 @@
 
 [![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)
-[![Quality     ](http://img.shields.io/codeclimate/github/dmendel/bindata.svg)](https://codeclimate.com/github/dmendel/bindata)
 [![Coverage    ](http://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

@@ -9,16 +9,14 @@ Gem::Specification.new do |s|
   s.author = 'Dion Mendel'
   s.email = 'bindata@dm9.info'
   s.homepage = 'http://github.com/dmendel/bindata'
-  s.rubyforge_project = '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/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.rb

@@ -1,13 +1,5 @@
 # BinData -- Binary data manipulator.
-# Copyright (c) 2007 - 2016 Dion Mendel.
-
-if RUBY_VERSION <= "1.9"
-  fail "BinData requires ruby >= 1.9.3. Use BinData version 1.8.x instead"
-end
-
-if RUBY_VERSION == "2.1.0" and RUBY_PATCHLEVEL == "0"
-  fail "Ruby 2.1.0p0 has a bug that causes BinData to fail. Upgrade your ruby version"
-end
+# Copyright (c) 2007 - 2018 Dion Mendel.
 
 require 'bindata/version'
 require 'bindata/array'
@@ -36,10 +28,10 @@ require 'bindata/warnings'
 # A declarative way to read and write structured binary data.
 # 
 # A full reference manual is available online at
-# http://bindata.rubyforge.org/manual.html
+# https://github.com/dmendel/bindata/wiki
 #
 # == License
 #
 # BinData is released under the same license as Ruby.
 #
-# Copyright (c) 2007 - 2016 Dion Mendel.
+# Copyright (c) 2007 - 2018 Dion Mendel.

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

@@ -1,3 +1,4 @@
+require 'thread'
 require 'bindata/base_primitive'
 
 module BinData
@@ -5,15 +6,18 @@ module BinData
   # The integer is defined by endian and number of bits.
 
   module BitField #:nodoc: all
+    @@mutex = Mutex.new
+
     class << self
       def define_class(name, nbits, endian, signed = :unsigned)
-        unless BinData.const_defined?(name)
-          BinData.module_eval <<-END
-            class #{name} < BinData::BasePrimitive
-              # nbits is either an integer or the symbol `:nbits`
-              BitField.define_methods(self, #{nbits.inspect}, :#{endian}, :#{signed})
-            end
-          END
+        @@mutex.synchronize do
+          unless BinData.const_defined?(name)
+            new_class = Class.new(BinData::BasePrimitive)
+            BitField.define_methods(new_class, nbits, endian.to_sym, signed.to_sym)
+            RegisteredClasses.register(name, new_class)
+
+            BinData.const_set(name, new_class)
+          end
         end
 
         BinData.const_get(name)

data/lib/bindata/int.rb

@@ -1,3 +1,4 @@
+require 'thread'
 require 'bindata/base_primitive'
 
 module BinData
@@ -5,14 +6,18 @@ module BinData
   # is defined by endian, signedness and number of bytes.
 
   module Int #:nodoc: all
+    @@mutex = Mutex.new
+
     class << self
       def define_class(name, nbits, endian, signed)
-        unless BinData.const_defined?(name)
-          BinData.module_eval <<-END
-            class #{name} < BinData::BasePrimitive
-              Int.define_methods(self, #{nbits}, :#{endian}, :#{signed})
-            end
-          END
+        @@mutex.synchronize do
+          unless BinData.const_defined?(name)
+            new_class = Class.new(BinData::BasePrimitive)
+            Int.define_methods(new_class, nbits, endian.to_sym, signed.to_sym)
+            RegisteredClasses.register(name, new_class)
+
+            BinData.const_set(name, new_class)
+          end
         end
 
         BinData.const_get(name)

data/lib/bindata/io.rb

@@ -29,7 +29,7 @@ module BinData
 
       def seekable?
         @raw_io.pos
-      rescue NoMethodError, Errno::ESPIPE, Errno::EPIPE
+      rescue NoMethodError, Errno::ESPIPE, Errno::EPIPE, Errno::EINVAL
         nil
       end
 
@@ -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/registry.rb

@@ -24,7 +24,7 @@ module BinData
     end
 
     def register(name, class_to_register)
-      return if class_to_register.nil?
+      return if name.nil? || class_to_register.nil?
 
       formatted_name = underscore_name(name)
       warn_if_name_is_already_registered(formatted_name, class_to_register)
@@ -37,8 +37,14 @@ module BinData
     end
 
     def lookup(name, hints = {})
-      key = normalize_name(name, hints)
-      @registry[key] || raise(UnRegisteredTypeError, name.to_s)
+      the_class = @registry[normalize_name(name, hints)]
+      if the_class
+        the_class
+      elsif @registry[normalize_name(name, hints.merge(endian: :big))]
+        raise(UnRegisteredTypeError, "#{name}, do you need to specify endian?")
+      else
+        raise(UnRegisteredTypeError, name)
+      end
     end
 
     # Convert CamelCase +name+ to underscore style.

data/lib/bindata/stringz.rb

@@ -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.3"
+  VERSION = "2.4.8"
 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/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/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
@@ -71,6 +77,14 @@ describe BinData::Registry, "with numerics" do
     }.must_raise BinData::UnRegisteredTypeError
   end
 
+  it "provides a nice error message when endian is omitted" do
+    begin
+      r.lookup("int24")
+    rescue BinData::UnRegisteredTypeError => e
+      e.message.must_equal "int24, do you need to specify endian?"
+    end
+  end
+
   it "does not lookup non byte based integers" do
     lambda {
       r.lookup("int3")

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.3
+  version: 2.4.8
 platform: ruby
 authors:
 - Dion Mendel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-09 00:00:00.000000000 Z
+date: 2020-07-21 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
@@ -164,8 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: bindata
-rubygems_version: 2.6.14
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A declarative way to read and write binary file formats