iostruct 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a36ab3a3a2de5e2cb4f94175231aa664be8cee2c5361d83cc2f62def71f2b067
-  data.tar.gz: 2604c514757df2287d4652c0929ebfc09b1d54cd281599b6e7f52fd2d7f270d8
+  metadata.gz: f3b93bdd7f541a9cec7f68169c9927e989203b38cea668441523c499e3b62562
+  data.tar.gz: ee73bec71e144d684769c6238718e82cab1f2b526543721bfc2fcfe5e979bcc3
 SHA512:
-  metadata.gz: e99bb3cdd28c0f1283332470cf1e88aca1c425d79545a28d448bde831630e272dca6a5eda4d88ea869482e21c9d7e2adf80d61ee62661fa4d2a09420bad82f36
-  data.tar.gz: 4bf4896671e0a04675210468855b5efa5ec0df22378ac4bad1bef3a193080be8f908fc571bdcc3325c1dc4b7d5d50c10dd98ac213376a5f1d4ed396fdd85c247
+  metadata.gz: b910103dc94c253a01cf0f82a94d2359bed9489ceb829621fc6acdd04fdc140188dbb80c3cf58d9de06a289ec27479333b43b2e14f0c0028b31d6f94050c37eb
+  data.tar.gz: dbecaa47ac2e8077b8b2e23818add7ccf2142e0349cf482aa4e8108f03fa19a512c1acb30eceb94d18fc736ce5cf9516dd480ab49b1b1f59089d6714ddd1622f

data/.rubocop.yml

@@ -46,6 +46,9 @@ Style/CommentedKeyword:
 Style/Documentation:
   Enabled: false
 
+Style/EmptyElse:
+  Enabled: false
+
 Style/FormatString:
   Enabled: false
 

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+# 0.7.0
+
+- added big-endian and little-endian type support in hash format:
+
+   ```ruby
+   IOStruct.new(fields: {
+     be_val: 'uint16_be',  # or 'be16', 'uint16_t_be'
+     le_val: 'uint32_le',  # or 'le32', 'uint32_t_le'
+   })
+   ```
+
+- added nested struct arrays:
+
+   ```ruby
+   Point = IOStruct.new(fields: { x: 'int', y: 'int' })
+   Polygon = IOStruct.new(fields: {
+     num_points: 'int',
+     points: { type: Point, count: 3 },  # array of 3 nested structs
+   })
+   p = Polygon.read(data)
+   p.points[0].x  # access nested struct in array
+   p.pack         # packing works too!
+   ```
+
+- added endian-specific float types: `float_le`, `float_be`, `double_le`, `double_be`
+- improved class name handling in inspect for subclasses
+- `DecInspect` now defines `to_s` for consistent behavior with `HexInspect`
+
 # 0.6.0
 
 - added alternative hash-based struct definition with C type names:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    iostruct (0.6.0)
+    iostruct (0.7.0)
 
 GEM
   remote: https://rubygems.org/
@@ -18,7 +18,6 @@ GEM
     prism (1.8.0)
     racc (1.8.1)
     rainbow (3.1.1)
-    rake (13.3.1)
     regexp_parser (2.11.3)
     rspec (3.13.2)
       rspec-core (~> 3.13.0)
@@ -63,9 +62,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler
   iostruct!
-  rake
   rspec
   rubocop
   rubocop-rake

data/lib/iostruct/hash_fmt.rb

@@ -2,6 +2,7 @@
 
 module IOStruct
   module HashFmt
+    # rubocop:disable Style/WordArray
     KNOWN_FIELD_TYPES_REVERSED = {
       'C' => ['uint8_t',  'unsigned char', '_BYTE'],
       'S' => ['uint16_t', 'unsigned short'],
@@ -15,9 +16,23 @@ module IOStruct
       'l' => ['long',    'signed long'],
       'q' => ['int64_t', 'long long', 'signed long long'],
 
+      # Big-endian (network byte order)
+      'n' => ['uint16_be', 'uint16_t_be', 'be16'],
+      'N' => ['uint32_be', 'uint32_t_be', 'be32'],
+
+      # Little-endian (VAX byte order)
+      'v' => ['uint16_le', 'uint16_t_le', 'le16'],
+      'V' => ['uint32_le', 'uint32_t_le', 'le32'],
+
+      # Floats
       'd' => ['double'],
       'f' => ['float'],
+      'E' => ['double_le'],  # double-precision, little-endian
+      'e' => ['float_le'],   # single-precision, little-endian
+      'G' => ['double_be'],  # double-precision, big-endian
+      'g' => ['float_be'],   # single-precision, big-endian
     }.freeze
+    # rubocop:enable Style/WordArray
 
     KNOWN_FIELD_TYPES = KNOWN_FIELD_TYPES_REVERSED.map { |t, a| a.map { |v| [v, t] } }.flatten.each_slice(2).to_h
 
@@ -73,7 +88,12 @@ module IOStruct
         end
 
         if f_count != 1
-          f_fmt = "#{type_code}#{f_count}"
+          if f_fmt.is_a?(Class)
+            # Nested struct array: keep f_fmt as the Class, just update size and type_code
+          else
+            # Primitive array: set f_fmt to pack format string (e.g., "i3")
+            f_fmt = "#{type_code}#{f_count}"
+          end
           f_size *= f_count
           type_code = "a#{f_size}"
         end

data/lib/iostruct/version.rb

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

data/lib/iostruct.rb

@@ -35,10 +35,13 @@ module IOStruct
       extend ClassMethods
       include InstanceMethods
       include NestedInstanceMethods if finfos.any?(&:fmt)
-      if inspect == :hex
+      case inspect
+      when :hex
         include HexInspect
-      else
+      when :dec
         include DecInspect
+      else
+        # ruby default inspect
       end
       define_singleton_method(:to_s) { struct_name } if struct_name
       define_singleton_method(:name) { struct_name } if struct_name
@@ -55,6 +58,10 @@ module IOStruct
     names
   end
 
+  def self.get_name(klass)
+    (klass.respond_to?(:name) && klass.name) || 'struct'
+  end
+
   module ClassMethods
     # src can be IO or String, or anything that responds to :read or :unpack
     def read(src, size = nil)
@@ -72,10 +79,6 @@ module IOStruct
       new(*data.unpack(const_get('FORMAT'))).tap { |x| x.__offset = pos }
     end
 
-    def name
-      'struct'
-    end
-
     def size
       self::SIZE
     end
@@ -115,10 +118,20 @@ module IOStruct
       super
       self.class::FIELDS.each do |k, v|
         next unless v.fmt
-
-        if (value = self[k])
-          self[k] = v.fmt.is_a?(String) ? value.unpack(v.fmt) : v.fmt.read(value)
-        end
+        next unless (value = self[k])
+
+        self[k] =
+          if v.fmt.is_a?(String)
+            # Primitive array (e.g., "i3" for 3 ints)
+            value.unpack(v.fmt)
+          elsif v.count && v.count > 1
+            # Nested struct array: split data and read each chunk
+            item_size = v.fmt.size
+            v.count.times.map { |i| v.fmt.read(value[i * item_size, item_size]) }
+          else
+            # Single nested struct
+            v.fmt.read(value)
+          end
       end
     end
 
@@ -128,7 +141,16 @@ module IOStruct
         next value unless v&.fmt && value
 
         # Reverse the unpacking done in initialize
-        v.fmt.is_a?(String) ? value.pack(v.fmt) : value.pack
+        if v.fmt.is_a?(String)
+          # Primitive array
+          value.pack(v.fmt)
+        elsif v.count && v.count > 1
+          # Nested struct array: pack each and concatenate
+          value.map(&:pack).join
+        else
+          # Single nested struct
+          value.pack
+        end
       end
       values.pack self.class.const_get('FORMAT')
     end
@@ -140,7 +162,7 @@ module IOStruct
     # rubocop:disable Lint/DuplicateBranch
     def to_table
       values = to_a
-      "<#{self.class.name} " + self.class::FIELDS.map.with_index do |el, idx|
+      "<#{IOStruct.get_name(self.class)} " + self.class::FIELDS.map.with_index do |el, idx|
         v = values[idx]
         fname, f = el
 
@@ -150,7 +172,7 @@ module IOStruct
             v.inspect
           when f.type == Integer
             v ||= 0 # avoid "`sprintf': can't convert nil into Integer" error
-            format_integer(v, f.size, fname)
+            format_int(v, f.size, fname)
           when f.type == Float
             v ||= 0 # avoid "`sprintf': can't convert nil into Float" error
             "%8.3f" % v
@@ -160,6 +182,17 @@ module IOStruct
       end.join(' ') + ">"
     end
     # rubocop:enable Lint/DuplicateBranch
+
+    # don't make inspect an alias to to_s or vice versa, because:
+    #  - ruby's default struct inspect() and to_s() returns same result, but they are different methods
+    #  - inspect/to_s may already be used by some code (zsteg), where aliasing would break things
+    def inspect
+      _inspect
+    end
+
+    def to_s
+      _inspect
+    end
   end
 
   module DecInspect
@@ -167,10 +200,16 @@ module IOStruct
 
     DEC_FMTS = { 1 => "%4d", 2 => "%6d", 4 => "%11d", 8 => "%20d" }.freeze
 
-    def format_integer(value, size, fname)
+    def format_int(value, size, fname)
       fmt = DEC_FMTS[size] || raise("Unsupported Integer size #{size} for field #{fname}")
       fmt % value
     end
+
+    private
+
+    def _inspect
+      "<#{IOStruct.get_name(self.class)} " + to_h.map { |k, v| "#{k}=#{v.inspect}" }.join(' ') + ">"
+    end
   end
 
   module HexInspect
@@ -178,8 +217,17 @@ module IOStruct
 
     HEX_FMTS = { 1 => "%2x", 2 => "%4x", 4 => "%8x", 8 => "%16x" }.freeze
 
-    def to_s
-      "<#{self.class.name} " + to_h.map do |k, v|
+    # display as unsigned, because signed %x looks ugly: "..f" for -1
+    def format_int(value, size, fname)
+      fmt  = HEX_FMTS[size]  || raise("Unsupported Integer size #{size} for field #{fname}")
+      mask = INT_MASKS[size] || raise("Unsupported Integer size #{size} for field #{fname}")
+      fmt % (value & mask)
+    end
+
+    private
+
+    def _inspect
+      "<#{IOStruct.get_name(self.class)} " + to_h.map do |k, v|
         if v.is_a?(Integer) && v > 9
           "#{k}=0x%x" % v
         else
@@ -187,16 +235,5 @@ module IOStruct
         end
       end.join(' ') + ">"
     end
-
-    def inspect
-      to_s
-    end
-
-    # display as unsigned, because signed %x looks ugly: "..f" for -1
-    def format_integer(value, size, fname)
-      fmt  = HEX_FMTS[size]  || raise("Unsupported Integer size #{size} for field #{fname}")
-      mask = INT_MASKS[size] || raise("Unsupported Integer size #{size} for field #{fname}")
-      fmt % (value & mask)
-    end
   end
 end # IOStruct

data/spec/.rubocop.yml

@@ -23,5 +23,8 @@ RSpec/ExampleLength:
 RSpec/ExampleWording:
   Enabled: false
 
+RSpec/NestedGroups:
+  Enabled: false
+
 RSpec/SpecFilePathFormat:
   Enabled: false

data/spec/hash_fmt_spec.rb

@@ -143,6 +143,34 @@ describe IOStruct do
       expect(reparsed.bottomRight.y).to eq 200
     end
 
+    it "supports nested struct arrays" do
+      point = described_class.new(fields: { x: "int", y: :int })
+      polygon = described_class.new(
+        fields: {
+          num_points: 'int',
+          points: { type: point, count: 3 },
+        }
+      )
+      expect(polygon.size).to eq(4 + (8 * 3))
+
+      data = [3, 10, 20, 30, 40, 50, 60].pack('i*')
+      p = polygon.read(data)
+
+      expect(p.num_points).to eq 3
+      expect(p.points.size).to eq 3
+      expect(p.points[0]).to be_instance_of(point)
+      expect(p.points[0].x).to eq 10
+      expect(p.points[0].y).to eq 20
+      expect(p.points[1].x).to eq 30
+      expect(p.points[1].y).to eq 40
+      expect(p.points[2].x).to eq 50
+      expect(p.points[2].y).to eq 60
+
+      # Test round-trip
+      reparsed = polygon.read(p.pack)
+      expect(reparsed.points[2].y).to eq 60
+    end
+
     it "packs arrays" do
       klass = described_class.new(
         fields: {
@@ -211,5 +239,49 @@ describe IOStruct do
         expect(klass.read("\xff").a).to eq 255 # unsigned
       end
     end
+
+    context "endian types" do
+      it "supports big-endian uint16" do
+        klass = described_class.new(fields: { a: 'uint16_be' })
+        expect(klass.size).to eq 2
+        expect(klass.read("\x01\x02").a).to eq 0x0102 # big-endian
+      end
+
+      it "supports big-endian uint32" do
+        klass = described_class.new(fields: { a: 'uint32_be' })
+        expect(klass.size).to eq 4
+        expect(klass.read("\x01\x02\x03\x04").a).to eq 0x01020304
+      end
+
+      it "supports little-endian uint16" do
+        klass = described_class.new(fields: { a: 'uint16_le' })
+        expect(klass.size).to eq 2
+        expect(klass.read("\x01\x02").a).to eq 0x0201 # little-endian
+      end
+
+      it "supports little-endian uint32" do
+        klass = described_class.new(fields: { a: 'uint32_le' })
+        expect(klass.size).to eq 4
+        expect(klass.read("\x01\x02\x03\x04").a).to eq 0x04030201
+      end
+
+      it "supports alternate names (be16, le32, etc.)" do
+        klass = described_class.new(fields: {
+                                      a: 'be16',
+                                      b: 'be32',
+                                      c: 'le16',
+                                      d: 'le32'
+                                    })
+        expect(klass.size).to eq(2 + 4 + 2 + 4)
+      end
+
+      it "round-trips big-endian values" do
+        klass = described_class.new(fields: { a: 'uint16_be', b: 'uint32_be' })
+        obj = klass.read([0x1234, 0xDEADBEEF].pack('nN'))
+        expect(obj.a).to eq 0x1234
+        expect(obj.b).to eq 0xDEADBEEF
+        expect(obj.pack).to eq [0x1234, 0xDEADBEEF].pack('nN')
+      end
+    end
   end
 end

data/spec/iostruct_spec.rb

@@ -43,6 +43,40 @@ describe IOStruct do
     end
   end
 
+  describe "#inspect" do
+    [nil, "MyClass"].each do |struct_name|
+      context "when struct_name is #{struct_name.inspect}" do
+        [:hex, :dec].each do |inspect_mode|
+          context "when inspect is :#{inspect_mode}" do
+            context "for IOStruct" do
+              it "shows default struct name" do
+                struct = described_class.new('L S C', :a, :b, :c, inspect: inspect_mode, struct_name: struct_name)
+                cname = struct_name || "struct"
+                expect(struct.new.inspect).to match(/<#{cname} a=/)
+              end
+            end
+
+            context "for IOStruct anonymous subclass" do
+              it "shows default struct name" do
+                struct = Class.new( described_class.new('L S C', :a, :b, :c, inspect: inspect_mode, struct_name: struct_name) )
+                cname = struct_name || "struct"
+                expect(struct.new.inspect).to match(/<#{cname} a=/)
+              end
+            end
+
+            context "for named IOStruct subclass" do
+              it "shows custom struct name" do
+                stub_const("C1", described_class.new('L S C', :a, :b, :c, inspect: inspect_mode, struct_name: struct_name) )
+                cname = struct_name || "C1"
+                expect(C1.new.inspect).to match(/<#{cname} a=/)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+
   describe "hash-style initialization" do
     let(:struct) { described_class.new('L S C', :a, :b, :c) }
 
@@ -184,7 +218,7 @@ describe IOStruct do
     end
   end
 
-  describe "#read" do
+  describe "read" do
     let(:a) { [12345, 56789] }
     let(:data) { a.pack('L2') }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iostruct
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Andrey "Zed" Zaikin