iostruct 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 535a978c6d95f5213d7a7e63523b46788adc2d6ca83c714758e9f30f927f546f
-  data.tar.gz: 5f52aea99a2615221a62e9b7d3228f129f1320e2a21c8b65eae3fec644e4007a
+  metadata.gz: 4a17b782202e0503788fd3b16dffdebddecd62becb30c52ba28161ebde1e300d
+  data.tar.gz: d42484281a468a378902d4589b67201ad4f134660559766690e48849b9f2a46c
 SHA512:
-  metadata.gz: 5a7489c0f185fb36a4e54c51273c2b87bd344754522e6584b329f529ed0ae00c8c287a1abf224b4cd3bfc1ed44fa5694c8036c89b3ef881231f8cfb4f773b6b0
-  data.tar.gz: 4fa626885e4446c846594c1be13b67649928e45e919aabc660cc2c414c7cb225efb29841e5bd856737d905d988f5dd2219dd3c1622c976cb2e656799beb2a0fe
+  metadata.gz: db34080f66b2815628e20a6e7b9331089d55a011dd35ae90b9e8f7758cb97332fad7b9caadfcc977a93e104cb0d9b9e3c932e82a2070e54205ba3bb7a52337d4
+  data.tar.gz: d25f3804da77a52630bb4492548c3ab71124c06610558dde277ea2c769a826ce8a720a5df99b2ab3691791b090f6ec4774b65e8072117383ab389e4095451a0f

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# 0.3.0
+
+ - added `__offset` field:
+    
+    ```ruby
+    X = IOStruct.new('LL')
+    io = StringIO.new('x'*1000)
+
+    X.read(io).__offset     # 0
+    X.read(io).__offset     # 8
+    X.read(io).__offset     # 16
+
+    X.read('abcd').__offset # nil
+    ```

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    iostruct (0.1.0)
+    iostruct (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/lib/iostruct/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IOStruct
-  VERSION = "0.1.3"
+  VERSION = "0.3.0"
 end

data/lib/iostruct.rb

@@ -23,6 +23,9 @@ module IOStruct
 
     'A' => [1, String  ], # arbitrary binary string (remove trailing nulls and ASCII spaces)
     'a' => [1, String  ], # arbitrary binary string
+    'Z' => [1, String  ], # arbitrary binary string (remove trailing nulls)
+    'H' => [1, String  ], # hex string (high nibble first)
+    'h' => [1, String  ], # hex string (low nibble first)
 
     'D' => [8, Float   ], # double-precision, native format
     'd' => [8, Float   ],
@@ -38,9 +41,10 @@ module IOStruct
 
   FieldInfo = Struct.new :type, :size, :offset
 
-  def self.new fmt, *names, inspect: :hex
+  def self.new fmt, *names, inspect: :hex, **renames
     fields, size = parse_format(fmt, names)
-    names  = auto_names(fields, size) if names.empty?
+    names = auto_names(fields, size) if names.empty?
+    names.map!{ |n| renames[n] || n } if renames.any?
 
     Struct.new( *names ).tap do |x|
       x.const_set 'FIELDS', names.zip(fields).to_h
@@ -59,9 +63,13 @@ module IOStruct
       size, klass = FMTSPEC[type] || raise("Unknown field type #{type.inspect}")
       len = len.empty? ? 1 : len.to_i
       case type
-      when 'A', 'a', 'x'
+      when 'A', 'a', 'x', 'Z'
         fields << FieldInfo.new(klass, size*len, offset) if klass
         offset += len
+      when 'H', 'h'
+        # XXX ruby's String#unpack length for hex strings is in characters, not bytes, i.e. "x".unpack("H2") => ["78"]
+        fields << FieldInfo.new(klass, size*len/2, offset) if klass
+        offset += len/2
       else
         len.times do |i|
           fields << FieldInfo.new(klass, size, offset)
@@ -86,23 +94,27 @@ module IOStruct
   module ClassMethods
     # src can be IO or String, or anything that responds to :read or :unpack
     def read src, size = nil
+      pos = nil
       size ||= const_get 'SIZE'
       data =
         if src.respond_to?(:read)
+          pos = src.tell
           src.read(size).to_s
         elsif src.respond_to?(:unpack)
           src
         else
           raise "[?] don't know how to read from #{src.inspect}"
         end
-      if data.size < size
-        $stderr.puts "[!] #{self.to_s} want #{size} bytes, got #{data.size}"
-      end
-      new(*data.unpack(const_get('FORMAT')))
+#      if data.size < size
+#        $stderr.puts "[!] #{self.to_s} want #{size} bytes, got #{data.size}"
+#      end
+      new(*data.unpack(const_get('FORMAT'))).tap{ |x| x.__offset = pos }
     end
   end # ClassMethods
 
   module InstanceMethods
+    attr_accessor :__offset
+
     def pack
       to_a.pack self.class.const_get('FORMAT')
     end
@@ -130,7 +142,7 @@ module IOStruct
 
   module HexInspect
     def to_s
-      s = "<#{self.class.to_s} " + to_h.map do |k, v|
+      "<#{self.class.to_s} " + to_h.map do |k, v|
         if v.is_a?(Integer) && v > 9
           "#{k}=0x%x" % v
         else
@@ -152,7 +164,7 @@ module IOStruct
           end
         "#{name}=#{fmt}"
       end.join(' ') + ">"
-      sprintf @fmtstr_tbl, *to_a.map{ |v| v.is_a?(String) ? v.inspect : v }
+      sprintf @fmtstr_tbl, *to_a.map{ |v| v.is_a?(String) ? v.inspect : (v||0) } # "||0" to avoid "`sprintf': can't convert nil into Integer" error
     end
 
     def inspect

data/spec/iostruct_spec.rb

@@ -59,6 +59,20 @@ describe IOStruct do
     expect(x.y).to eq a[1]
   end
 
+  it "unpacks hex-string (H)" do
+    data = "1234"
+    struct = IOStruct.new('H8', :x).read(data)
+    expect(struct.x).to eq "31323334"
+    expect(struct.pack).to eq data
+  end
+
+  it "unpacks reverse-nibbled hex-string (h)" do
+    data = "1234"
+    struct = IOStruct.new('h8', :x).read(data)
+    expect(struct.x).to eq "13233343"
+    expect(struct.pack).to eq data
+  end
+
   ['n', 'N', 'S>', 'L>', 'I>'].each do |fmt|
     it "unpacks unsigned big-endian '#{fmt}'" do
       a = [12345]
@@ -82,4 +96,27 @@ describe IOStruct do
   it "throws exception on unknown format" do
     expect { IOStruct.new('K', :x) }.to raise_error('Unknown field type "K"')
   end
+
+  context '__offset field' do
+    let(:data) { 0x100.times.to_a.pack('L*') }
+    let(:io) { StringIO.new(data) }
+    let(:struct) { IOStruct.new('LLLL', :a, :b, :c, :d) }
+
+    context 'when src is an IO' do
+      it 'is set to the current IO position' do
+        a = []
+        while !io.eof?
+          a << struct.read(io)
+        end
+        expect(a.map(&:__offset)).to eq (0...0x400).step(0x10).to_a
+      end
+    end
+
+    context 'when src is a string' do
+      it 'is nil' do
+        x = struct.read(data)
+        expect(x.__offset).to be_nil
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iostruct
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrey "Zed" Zaikin
@@ -60,6 +60,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -89,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A Struct that can read/write itself from/to IO-like objects