iostruct 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a17b782202e0503788fd3b16dffdebddecd62becb30c52ba28161ebde1e300d
-  data.tar.gz: d42484281a468a378902d4589b67201ad4f134660559766690e48849b9f2a46c
+  metadata.gz: 1f676ed52c2ea4738cc80dc0c6634ee50d9b4ef844107caad6f15937f70bca6f
+  data.tar.gz: b66779b78bc9abb15007089fb4cb4320324b6efa07e92d4df39b82fb16717bbb
 SHA512:
-  metadata.gz: db34080f66b2815628e20a6e7b9331089d55a011dd35ae90b9e8f7758cb97332fad7b9caadfcc977a93e104cb0d9b9e3c932e82a2070e54205ba3bb7a52337d4
-  data.tar.gz: d25f3804da77a52630bb4492548c3ab71124c06610558dde277ea2c769a826ce8a720a5df99b2ab3691791b090f6ec4774b65e8072117383ab389e4095451a0f
+  metadata.gz: ee0f456796c677b2d9bd9638b993d88ff828e84453ad8b89dc2b4f7d365cb8c6ab3b34156de415c47294ee88541f2b87157f04526c04930171ed211d51371709
+  data.tar.gz: 914f2243b76864fa1dbc476528512b1827a690fdff29b4981157860c2311e8f0caa31b4cfe5f102dff656fd2ccbd7f0ffa04b22617270726646cbd4a6eb4585a

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+# 0.5.0
+
+ - added `inspect_name_override` constructor param, useful for dynamic declarations:
+
+    ```ruby
+    IOStruct.new("NN").new.inspect                                 # "<#<Class:0x000000011c45fa20> f0=nil f4=nil>"
+    IOStruct.new("NN", inspect_name_override: "Point").new.inspect # "<Point f0=nil f4=nil>"
+    ```
+
+# 0.4.0
+
+ - added `size` class method that returns SIZE constant
+    
+    ```ruby
+    X = IOStruct.new('LL')
+    X::SIZE # 8
+    X.size  # 8
+    ```
+
 # 0.3.0
 
  - added `__offset` field:

data/lib/iostruct/version.rb

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

data/lib/iostruct.rb

@@ -41,7 +41,7 @@ module IOStruct
 
   FieldInfo = Struct.new :type, :size, :offset
 
-  def self.new fmt, *names, inspect: :hex, **renames
+  def self.new fmt, *names, inspect: :hex, inspect_name_override: nil, **renames
     fields, size = parse_format(fmt, names)
     names = auto_names(fields, size) if names.empty?
     names.map!{ |n| renames[n] || n } if renames.any?
@@ -53,6 +53,7 @@ module IOStruct
       x.extend ClassMethods
       x.include InstanceMethods
       x.include HexInspect if inspect == :hex
+      x.define_singleton_method(:name) { inspect_name_override } if inspect_name_override
     end
   end # self.new
 
@@ -110,6 +111,14 @@ module IOStruct
 #      end
       new(*data.unpack(const_get('FORMAT'))).tap{ |x| x.__offset = pos }
     end
+
+    def size
+      self::SIZE
+    end
+
+    def name
+      self.to_s
+    end
   end # ClassMethods
 
   module InstanceMethods
@@ -142,7 +151,7 @@ module IOStruct
 
   module HexInspect
     def to_s
-      "<#{self.class.to_s} " + to_h.map do |k, v|
+      "<#{self.class.name} " + to_h.map do |k, v|
         if v.is_a?(Integer) && v > 9
           "#{k}=0x%x" % v
         else
@@ -152,7 +161,7 @@ module IOStruct
     end
 
     def to_table
-      @fmtstr_tbl = "<#{self.class.to_s} " + self.class.const_get('FIELDS').map do |name, f|
+      @fmtstr_tbl = "<#{self.class.name} " + self.class.const_get('FIELDS').map do |name, f|
         fmt =
           case 
           when f.type == Integer

data/spec/iostruct_spec.rb

@@ -2,6 +2,22 @@ require 'spec_helper'
 require 'stringio'
 
 describe IOStruct do
+  describe ":inspect_name_override" do
+    context "when set" do
+      it "uses the custom name" do
+        x = IOStruct.new('LL', :x, :y, inspect_name_override: 'Point')
+        expect(x.new.inspect).to match /<Point x=nil y=nil>/
+      end
+    end
+
+    context "when not set" do
+      it "has default name" do
+        x = IOStruct.new('LL', :x, :y)
+        expect(x.new.inspect).to match /<#<Class:0x\h+> x=nil y=nil>/
+      end
+    end
+  end
+
   describe "#read" do
     let(:a) { [12345, 56789] }
     let(:data) { a.pack('L2') }
@@ -36,10 +52,14 @@ describe IOStruct do
       expect(x.c).to eq 2
     end
 
-    it "has correct size" do
+    it "has correct SIZE" do
       expect(struct::SIZE).to eq 2
     end
 
+    it "has correct size" do
+      expect(struct.size).to eq 2
+    end
+
     it "reads correct number of bytes from IO" do
       io = StringIO.new(data*2)
       x = struct.read(io)

metadata

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