bindata 2.4.2 → 2.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 660228b3b8cdee82618401590015a45820a422fae8e0789d8bf4eceb89df3ee7
-  data.tar.gz: db1dfef8d5942a56d5a31a25fba27b28a4169433669cb3e910a3fb7236ba8a0f
+  metadata.gz: dd9ce2f3336fc2e9f8e3250a278732351d6a1af220603fb62763b3ef83caaf5e
+  data.tar.gz: f8f15a3836564c6a51891231a276ed0848cc92bdb4663c5aca6d4eecd0f53ec4
 SHA512:
-  metadata.gz: f4ba761be1d6e109d30961cffa4c92774fafd05fad047aa710f335d1cbd25a02c81a252e06e187ccf3864fd0453e49f2c58de4abac3504762fd60db5e32e962f
-  data.tar.gz: b442381a7d7a04e930edcbad4e42269d88477e8223d26dbd81a57f0620fbe325299445d06ff1ea80e9ebf11a049e99f5e38e75d1a452a68d34ca8708e1b59441
+  metadata.gz: 5abcc6829c6b6ea410bc3c542d4b60d40a83e6ac883bb3a4b09dfefdc1e5a4ae1d37307d75e53cbbc1593a17dd327269974835a6f0936f2ab21f66fe69f120ba
+  data.tar.gz: ba8d7abcaac0ceb95acb6ffa8b24b7253495241fbd483ef887103a63d5c65c9649954a1998a70289e64823d0fb85bef1ba22a5bfb126b1cae9708a7412658220

data/ChangeLog.rdoc

@@ -1,5 +1,9 @@
 = BinData Changelog
 
+== Version 2.4.3 (2018-03-10)
+
+* Add Uint8Arrays.  Requested by masarakki.
+
 == Version 2.4.2 (2018-01-31)
 
 * Allow boolean values as parameters.  Requested by Patrik Wenger.

data/lib/bindata.rb

@@ -26,6 +26,7 @@ require 'bindata/string'
 require 'bindata/stringz'
 require 'bindata/struct'
 require 'bindata/trace'
+require 'bindata/uint8_array'
 require 'bindata/virtual'
 require 'bindata/alignment'
 require 'bindata/warnings'

data/lib/bindata/uint8_array.rb

@@ -0,0 +1,62 @@
+require "bindata/base_primitive"
+
+module BinData
+  # Uint8Array is a specialised type of array that only contains
+  # bytes (Uint8).  It is a faster and more memory efficient version
+  # of `BinData::Array.new(:type => :uint8)`.
+  #
+  #   require 'bindata'
+  #
+  #   obj = BinData::Uint8Array.new(initial_length: 5)
+  #   obj.read("abcdefg") #=> [97, 98, 99, 100, 101]
+  #   obj[2] #=> 99
+  #   obj.collect { |x| x.chr }.join #=> "abcde"
+  #
+  # == Parameters
+  #
+  # Parameters may be provided at initialisation to control the behaviour of
+  # an object.  These params are:
+  #
+  # <tt>:initial_length</tt>:: The initial length of the array.
+  # <tt>:read_until</tt>::     May only have a value of `:eof`.  This parameter
+  #                            instructs the array to read as much data from
+  #                            the stream as possible.
+  class Uint8Array < BinData::BasePrimitive
+    optional_parameters :initial_length, :read_until
+    mutually_exclusive_parameters :initial_length, :read_until
+    arg_processor :uint8_array
+
+    #---------------
+    private
+
+    def value_to_binary_string(val)
+      val.pack("C*")
+    end
+
+    def read_and_return_value(io)
+      if has_parameter?(:initial_length)
+        data = io.readbytes(eval_parameter(:initial_length))
+      else
+        data = io.read_all_bytes
+      end
+
+      data.unpack("C*")
+    end
+
+    def sensible_default
+      []
+    end
+  end
+
+  class Uint8ArrayArgProcessor < BaseArgProcessor
+    def sanitize_parameters!(obj_class, params) #:nodoc:
+      # ensure one of :initial_length and :read_until exists
+      unless params.has_at_least_one_of?(:initial_length, :read_until)
+        params[:initial_length] = 0
+      end
+
+      msg = "Parameter :read_until must have a value of :eof"
+      params.sanitize(:read_until) { |val| raise ArgumentError, msg unless val == :eof }
+    end
+  end
+end

data/lib/bindata/version.rb

@@ -1,3 +1,3 @@
 module BinData
-  VERSION = "2.4.2"
+  VERSION = "2.4.3"
 end

data/test/uint8_array_test.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__), "test_helper"))
+
+describe BinData::Uint8Array, "when initialising" do
+  it "with mutually exclusive parameters :initial_length and :read_until" do
+    params = {initial_length: 5, read_until: :eof}
+    lambda { BinData::Uint8Array.new(params) }.must_raise ArgumentError
+  end
+
+  it "with :read_until" do
+    params = {read_until: :not_eof}
+    lambda { BinData::Uint8Array.new(params) }.must_raise ArgumentError
+  end
+
+  it "with no parameters" do
+    arr = BinData::Uint8Array.new
+    arr.num_bytes.must_equal 0
+  end
+end
+
+describe BinData::Uint8Array, "with :read_until" do
+  it "reads until :eof" do
+    arr = BinData::Uint8Array.new(read_until: :eof)
+    arr.read("\xff\xfe\xfd\xfc")
+    arr.must_equal([255, 254, 253, 252])
+  end
+end
+
+describe BinData::Uint8Array, "with :initial_length" do
+  it "reads" do
+    arr = BinData::Uint8Array.new(initial_length: 3)
+    arr.read("\xff\xfe\xfd\xfc")
+    arr.must_equal([255, 254, 253])
+  end
+end
+
+describe BinData::Uint8Array, "when assigning" do
+  it "copies data" do
+    arr = BinData::Uint8Array.new
+    arr.assign([1, 2, 3])
+    arr.must_equal([1, 2, 3])
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bindata
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.4.3
 platform: ruby
 authors:
 - Dion Mendel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-31 00:00:00.000000000 Z
+date: 2018-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -111,6 +111,7 @@ files:
 - lib/bindata/stringz.rb
 - lib/bindata/struct.rb
 - lib/bindata/trace.rb
+- lib/bindata/uint8_array.rb
 - lib/bindata/version.rb
 - lib/bindata/virtual.rb
 - lib/bindata/warnings.rb
@@ -139,6 +140,7 @@ files:
 - test/struct_test.rb
 - test/system_test.rb
 - test/test_helper.rb
+- test/uint8_array_test.rb
 - test/virtual_test.rb
 - test/warnings_test.rb
 homepage: http://github.com/dmendel/bindata