iostruct 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b5299fc722f0b62051802a5ec32ac37de25c48b92a5899a77da7494aa6dfa73
-  data.tar.gz: dd50d4aa68a79fded59a6720867bea0b4961ca7513d79cf124bda6ad9d5e40fc
+  metadata.gz: 0376aab4653f3f1fb656d82f679346bd1d04c6d8f80e17540a4a7fbb3bc470d7
+  data.tar.gz: 211894d68015bc52658e8e818296a42c115bdeda8cfa2cb6525cadb1e9554e9b
 SHA512:
-  metadata.gz: b3434b61ba2cac8b9465a91da45d7dd5ee5aadd5eeaba77c3d115a564b7dbb31ecdb37e579bd3b41132af5eff42ad687c12ebf4d69da5a4015e23fa317e5b133
-  data.tar.gz: 852776b5bbaacf3ac4107a9755879ca986841e7d415bc16310e7ee6f565b6335b58c2d0730fd5de20ecde7843abe64c30c898855bb48e918e8bd7f83b527b5a0
+  metadata.gz: 79edc6088c3258506085cf22aee37e75386bab8309c478786ec3022f3895f34a4b05490640bca22db56b78242b500d7030d3fc6b141a24aa0f9cfc1681baef7d
+  data.tar.gz: 36ddc86813c0c0fc92874025fbe37f755a8f1cef22533949b101428b50ca2a0369aae9beddfe99a4b00d71c0db5985ec4f89b5beddefcc262ea6c91dfd2787b7

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# 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:
+    
+    ```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.2.0"
+  VERSION = "0.4.0"
 end

data/lib/iostruct.rb

@@ -94,9 +94,11 @@ 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
@@ -106,11 +108,17 @@ module IOStruct
 #      if data.size < size
 #        $stderr.puts "[!] #{self.to_s} want #{size} bytes, got #{data.size}"
 #      end
-      new(*data.unpack(const_get('FORMAT')))
+      new(*data.unpack(const_get('FORMAT'))).tap{ |x| x.__offset = pos }
+    end
+
+    def size
+      self::SIZE
     end
   end # ClassMethods
 
   module InstanceMethods
+    attr_accessor :__offset
+
     def pack
       to_a.pack self.class.const_get('FORMAT')
     end

data/spec/iostruct_spec.rb

@@ -36,10 +36,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)
@@ -96,4 +100,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.2.0
+  version: 0.4.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.11
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: A Struct that can read/write itself from/to IO-like objects