iostruct 0.0.2 → 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 78f534f107abf828f64d62134f93a553cb5af56af1860c338e0844b49cb482ba
+  data.tar.gz: cdd0dfc48cf8a171bfcfc25fbe630182424008376e245b6a4816b12ed183940e
+SHA512:
+  metadata.gz: 534ccfd92eadd911de930d08cc787dab929d0a2af5210da3700b5f6ea98f444896d9cdc674b657216f03da753d902acf80a55ae21cb4943b34fd7e065ab8a0af
+  data.tar.gz: 660427b2d4652c94791a8552dd2542614fd6b7e04a895b0ab7d1ffeeabfc508b77c02d61788bd1a9a46f9c2880257cddf274297885e4b0c11d8e6f141632a518

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile.lock

@@ -1,17 +1,20 @@
 PATH
   remote: .
   specs:
-    iostruct (0.0.2)
+    iostruct (0.0.5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    rake (10.0.3)
+    rake (13.0.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.3)
+  bundler
   iostruct!
   rake
+
+BUNDLED WITH
+   2.1.4

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "run specs"
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/iostruct.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.summary  = "A Struct that can read/write itself from/to IO-like objects"
 
-  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "bundler"
   s.add_development_dependency "rake"
 end
 

data/lib/iostruct/version.rb

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

data/lib/iostruct.rb

@@ -1,14 +1,45 @@
+# frozen_string_literal: true
+
 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
+  }.freeze
+
   def self.new fmt, *args
     size = fmt.scan(/([a-z])(\d*)/i).map do |f,len|
-      [len.to_i, 1].max *
-        case f
-        when /[AC]/i then 1
-        when 'v' then 2
-        when 'V','l','L' then 4
-        when 'Q' then 8
-        else raise "unknown fmt #{f.inspect}"
-        end
+      if (field_size = FIELD_SIZES[f])
+        [len.to_i, 1].max * field_size
+      else
+        raise "Unknown fmt #{f.inspect}"
+      end
     end.inject(&:+)
 
     Struct.new( *args ).tap do |x|
@@ -48,5 +79,21 @@ module IOStruct
     def empty?
       to_a.all?{ |t| t == 0 || t.nil? || t.to_s.tr("\x00","").empty? }
     end
+
+    # allow initializing individual struct members by name, like:
+    #   PEdump::IMAGE_SECTION_HEADER.new(
+    #     :VirtualSize    => 0x100,
+    #     :VirtualAddress => 0x100000
+    #   )
+    def initialize *args
+      if args.size == 1 && args.first.is_a?(Hash)
+        super()
+        args.first.each do |k,v|
+          send "#{k}=", v
+        end
+      else
+        super
+      end
+    end
   end # InstanceMethods
 end # IOStruct

data/spec/iostruct_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'stringio'
+
+describe IOStruct do
+  describe "#read" do
+    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
+  end
+
+  it "skips on 'x'" do
+    a = [12345, 56789]
+    data = a.pack('L2')
+    x = IOStruct.new('x4L', :y).read(data)
+    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]
+  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]
+  end
+
+  it "throws exception on unknown format" do
+    expect { IOStruct.new('K', :x) }.to raise_error('Unknown fmt "K"')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require File.join(File.dirname(__FILE__), '../lib/iostruct.rb')
+
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+end

metadata

@@ -1,12 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: iostruct
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.5
 platform: ruby
 authors:
 - Andrey "Zed" Zaikin
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2013-01-08 00:00:00.000000000 Z
@@ -14,42 +13,39 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email: zed.0xff@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -58,29 +54,29 @@ files:
 - iostruct.gemspec
 - lib/iostruct.rb
 - lib/iostruct/version.rb
+- spec/iostruct_spec.rb
+- spec/spec_helper.rb
 homepage: http://github.com/zed-0xff/iostruct
 licenses:
 - MIT
-post_install_message: 
+metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 1.8.24
-signing_key: 
-specification_version: 3
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
 summary: A Struct that can read/write itself from/to IO-like objects
 test_files: []