iostruct 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78f534f107abf828f64d62134f93a553cb5af56af1860c338e0844b49cb482ba
-  data.tar.gz: cdd0dfc48cf8a171bfcfc25fbe630182424008376e245b6a4816b12ed183940e
+  metadata.gz: 9933717b7fe8a0b269d297587f3c15c53896c71c15ace8151bea990a3e65b45f
+  data.tar.gz: c4953e161f96a2a02e1fef1544e80d049ea2c1b759f2d782eb4c482edb758796
 SHA512:
-  metadata.gz: 534ccfd92eadd911de930d08cc787dab929d0a2af5210da3700b5f6ea98f444896d9cdc674b657216f03da753d902acf80a55ae21cb4943b34fd7e065ab8a0af
-  data.tar.gz: 660427b2d4652c94791a8552dd2542614fd6b7e04a895b0ab7d1ffeeabfc508b77c02d61788bd1a9a46f9c2880257cddf274297885e4b0c11d8e6f141632a518
+  metadata.gz: cae61a11f83095187649f1204e07a020315ea5ce5f1276e1b082f8dae5f75c77d82a69de2cb25b775cfd39bae8fee497ea1dc65562e60618450b78069d2cd132
+  data.tar.gz: 20f25a1f518db2ed314f52d4603617a98ff4c93081be83f02f6e053ffb09917dbb29306d0e56ce695aa54ea0b6b3720f0a60bf52614db0117710c7be480d268f

data/Gemfile.lock

@@ -1,12 +1,26 @@
 PATH
   remote: .
   specs:
-    iostruct (0.0.5)
+    iostruct (0.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    rake (13.0.6)
+    diff-lcs (1.5.1)
+    rake (13.2.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
 
 PLATFORMS
   ruby
@@ -15,6 +29,7 @@ DEPENDENCIES
   bundler
   iostruct!
   rake
+  rspec
 
 BUNDLED WITH
-   2.1.4
+   2.5.6

data/iostruct.gemspec

@@ -19,5 +19,6 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency "bundler"
   s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
 end
 

data/lib/iostruct/version.rb

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

data/lib/iostruct.rb

@@ -3,55 +3,86 @@
 module IOStruct
 
   # https://apidock.com/ruby/String/unpack
-  FIELD_SIZES = {
-    'C' => 1,      # Integer | 8-bit unsigned (unsigned char)
-    'S' => 2,      # Integer | 16-bit unsigned, native endian (uint16_t)
-    'L' => 4,      # Integer | 32-bit unsigned, native endian (uint32_t)
-    'Q' => 8,      # Integer | 64-bit unsigned, native endian (uint64_t)
-    'c' => 1,      # Integer | 8-bit signed (signed char)
-    's' => 2,      # Integer | 16-bit signed, native endian (int16_t)
-    'l' => 4,      # Integer | 32-bit signed, native endian (int32_t)
-    'q' => 8,      # Integer | 64-bit signed, native endian (int64_t)
-
-    'n' => 2,      # Integer | 16-bit unsigned, network (big-endian) byte order
-    'N' => 4,      # Integer | 32-bit unsigned, network (big-endian) byte order
-    'v' => 2,      # Integer | 16-bit unsigned, VAX (little-endian) byte order
-    'V' => 4,      # Integer | 32-bit unsigned, VAX (little-endian) byte order
-
-    'A' => 1,      # String  | arbitrary binary string (remove trailing nulls and ASCII spaces)
-    'a' => 1,      # String  | arbitrary binary string
-
-    'D' => 8,      # Float   | double-precision, native format
-    'd' => 8,
-    'F' => 4,      # Float   | single-precision, native format
-    'f' => 4,
-    'E' => 8,      # Float   | double-precision, little-endian byte order
-    'e' => 4,      # Float   | single-precision, little-endian byte order
-    'G' => 8,      # Float   | double-precision, network (big-endian) byte order
-    'g' => 4,      # Float   | single-precision, network (big-endian) byte order
-
-    'x' => 1,      # ---     | skip forward one byte
+  FMTSPEC = {
+    'C' => [1, Integer ], # 8-bit unsigned (unsigned char)
+    'S' => [2, Integer ], # 16-bit unsigned, native endian (uint16_t)
+    'I' => [4, Integer ], # 32-bit unsigned, native endian (uint32_t)
+    'L' => [4, Integer ], # 32-bit unsigned, native endian (uint32_t)
+    'Q' => [8, Integer ], # 64-bit unsigned, native endian (uint64_t)
+
+    'c' => [1, Integer ], # 8-bit signed (signed char)
+    's' => [2, Integer ], # 16-bit signed, native endian (int16_t)
+    'i' => [4, Integer ], # 32-bit signed, native endian (int32_t)
+    'l' => [4, Integer ], # 32-bit signed, native endian (int32_t)
+    'q' => [8, Integer ], # 64-bit signed, native endian (int64_t)
+
+    'n' => [2, Integer ], # 16-bit unsigned, network (big-endian) byte order
+    'N' => [4, Integer ], # 32-bit unsigned, network (big-endian) byte order
+    'v' => [2, Integer ], # 16-bit unsigned, VAX (little-endian) byte order
+    'V' => [4, Integer ], # 32-bit unsigned, VAX (little-endian) byte order
+
+    'A' => [1, String  ], # arbitrary binary string (remove trailing nulls and ASCII spaces)
+    'a' => [1, String  ], # arbitrary binary string
+
+    'D' => [8, Float   ], # double-precision, native format
+    'd' => [8, Float   ],
+    'F' => [4, Float   ], # single-precision, native format
+    'f' => [4, Float   ],
+    'E' => [8, Float   ], # double-precision, little-endian byte order
+    'e' => [4, Float   ], # single-precision, little-endian byte order
+    'G' => [8, Float   ], # double-precision, network (big-endian) byte order
+    'g' => [4, Float   ], # single-precision, network (big-endian) byte order
+
+    'x' => [1, nil     ], # skip forward one byte
   }.freeze
 
-  def self.new fmt, *args
-    size = fmt.scan(/([a-z])(\d*)/i).map do |f,len|
-      if (field_size = FIELD_SIZES[f])
-        [len.to_i, 1].max * field_size
-      else
-        raise "Unknown fmt #{f.inspect}"
-      end
-    end.inject(&:+)
+  FieldInfo = Struct.new :type, :size, :offset
 
-    Struct.new( *args ).tap do |x|
+  def self.new fmt, *names, inspect: :hex
+    fields, size = parse_format(fmt, names)
+    names  = auto_names(fields, size) if names.empty?
+
+    Struct.new( *names ).tap do |x|
+      x.const_set 'FIELDS', names.zip(fields).to_h
       x.const_set 'FORMAT', fmt
       x.const_set 'SIZE',  size
-      x.class_eval do
-        include InstanceMethods
-      end
       x.extend ClassMethods
+      x.include InstanceMethods
+      x.include HexInspect if inspect == :hex
     end
   end # self.new
 
+  def self.parse_format(fmt, names)
+    offset = 0
+    fields = []
+    fmt.scan(/([a-z])(\d*)/i).map do |type,len|
+      size, klass = FMTSPEC[type] || raise("Unknown field type #{type.inspect}")
+      len = [len.to_i, 1].max
+      case type
+      when 'A', 'a', 'x'
+        fields << FieldInfo.new(klass, size*len, offset) if klass
+        offset += len
+      else
+        len.times do |i|
+          fields << FieldInfo.new(klass, size, offset)
+          offset += size
+        end
+      end
+    end
+    [fields, offset]
+  end
+
+  def self.auto_names fields, size
+    names = []
+    offset = 0
+    fields.each do |f|
+      names << sprintf("f%x", offset).to_sym
+      offset += f.size
+    end
+    #raise "size mismatch: #{size} != #{offset}" if size != offset
+    names
+  end
+
   module ClassMethods
     # src can be IO or String, or anything that responds to :read or :unpack
     def read src, size = nil
@@ -96,4 +127,22 @@ module IOStruct
       end
     end
   end # InstanceMethods
+
+  module HexInspect
+    def inspect
+      @fmtstr ||= "<#{self.class.to_s} " + self.class.const_get('FIELDS').map do |name, f|
+        fmt =
+          case 
+          when f.type == Integer
+            "%#{f.size*2}x"
+          when f.type == Float
+            "%8.3f"
+          else
+            "%s"
+          end
+        "#{name}=#{fmt}"
+      end.join(' ') + ">"
+      sprintf @fmtstr, *to_a.map{ |v| v.is_a?(String) ? v.inspect : v }
+    end
+  end
 end # IOStruct

data/spec/iostruct_spec.rb

@@ -3,21 +3,26 @@ require 'stringio'
 
 describe IOStruct do
   describe "#read" do
+    let(:a) { [12345, 56789] }
+    let(:data) { a.pack('L2') }
+
     it "reads from IO" do
-      a = [12345, 56789]
-      data = a.pack('L2')
       x = IOStruct.new('LL', :x, :y).read(StringIO.new(data))
       expect(x.x).to eq a[0]
       expect(x.y).to eq a[1]
     end
 
     it "reads from String" do
-      a = [12345, 56789]
-      data = a.pack('L2')
       x = IOStruct.new('LL', :x, :y).read(data)
       expect(x.x).to eq a[0]
       expect(x.y).to eq a[1]
     end
+
+    it "creates a new instance of a subclass" do
+      klass = Class.new( IOStruct.new('LL', :x, :y) )
+      x = klass.read(data)
+      expect(x).to be_a klass
+    end
   end
 
   it "skips on 'x'" do
@@ -27,23 +32,27 @@ describe IOStruct do
     expect(x.y).to eq a[1]
   end
 
-  it "unpacks big-endian" do
-    a = [12345, 56789]
-    data = a.pack('nN')
-    x = IOStruct.new('nN', :x, :y).read(data)
-    expect(x.x).to eq a[0]
-    expect(x.y).to eq a[1]
+  ['n', 'N', 'S>', 'L>', 'I>'].each do |fmt|
+    it "unpacks unsigned big-endian '#{fmt}'" do
+      a = [12345]
+      data = a.pack(fmt)
+      x = IOStruct.new(fmt, :x).read(data)
+      expect(x.x).to eq a[0]
+      expect(x.pack).to eq data
+    end
   end
 
-  it "unpacks little-endian" do
-    a = [12345, 56789]
-    data = a.pack('vV')
-    x = IOStruct.new('vV', :x, :y).read(data)
-    expect(x.x).to eq a[0]
-    expect(x.y).to eq a[1]
+  ['v', 'V', 'S<', 'L<', 'I<'].each do |fmt|
+    it "unpacks unsigned little-endian '#{fmt}'" do
+      a = [12345]
+      data = a.pack(fmt)
+      x = IOStruct.new(fmt, :x).read(data)
+      expect(x.x).to eq a[0]
+      expect(x.pack).to eq data
+    end
   end
 
   it "throws exception on unknown format" do
-    expect { IOStruct.new('K', :x) }.to raise_error('Unknown fmt "K"')
+    expect { IOStruct.new('K', :x) }.to raise_error('Unknown field type "K"')
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iostruct
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Andrey "Zed" Zaikin
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email: zed.0xff@gmail.com
 executables: []
@@ -75,7 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.6
 signing_key:
 specification_version: 4
 summary: A Struct that can read/write itself from/to IO-like objects