struct_packing 0.0.1 → 0.0.2

data/lib/struct_packing/util.rb

@@ -0,0 +1,119 @@
+
+module StructPacking
+
+  public
+
+  # internal C-like_structure_declaration
+  class Util
+
+    private
+
+    def self.parse_ctype_decl(decl)
+      decl =~ /^\s*(unsigned|signed)?\s*(ascii|utf8|byte|char|short|(?:u?int)(?:(?:8|16|32|64)_t)?|(?:big|little)?(?:16|32)|(?:big|little)?\s*(?:float|double)?|long(?:\s*long))\s*(?:\[\s*(\d+)\s*\])?\s*$/
+
+      sign = !("unsigned" == $1)
+      template = template_of(sign, $2)
+      if $3 != nil and $3 == "1"
+        template += $3
+      end
+      template
+    end
+
+    def self.template_of(sign, type)
+      case type
+      when "ascii"
+        'a'
+      when "utf8"
+        'U'
+      when "byte"
+        'C'
+      when "char"
+        'c'
+      when "int8_t"
+        sign ? 'c' : 'C'
+      when "short"
+        's'
+      when "int16_t"
+        sign ? 's' : 'S'
+      when "int"
+        sign ? 'i' : 'I'
+      when "int32_t"
+        sign ? 'l' : 'L'
+      when "long"
+        sign ? 'l' : 'L'
+      when /long(\s*long)/
+        sign ? 'q' : 'Q'
+      when "int64_t"
+        sign ? 'q' : 'Q'
+      when "uint8_t"
+        'C'
+      when "uint16_t"
+        'S'
+      when "uint"
+        'I'
+      when "uint32_t"
+        'L'
+      when "uint64_t"
+        'Q'
+      when "big16"
+        'n'
+      when "big"
+        'N'
+      when "big32"
+        'N'
+      when "little16"
+        'v'
+      when "little"
+        'V'
+      when "little32"
+        'V'
+      when "float"
+        'f'
+      when /big\s*float/
+        'g'
+      when /little\s*float/
+        'e'
+      when "double"
+        'd'
+      when /big\s*double/
+        'G'
+      when /little\s*double/
+        'E'
+      end      
+    end
+
+    def self.types_to_template(types)
+      types.collect {|t| parse_ctype_decl(t)}.join
+    end
+
+    public
+    # Parse declaration string into pack template.
+    def self.pack_template_from(text)
+      internal = internal_format_from(text)
+      types_to_template(internal.values)
+    end
+
+    # Parse declaration string into internal format.
+    # Internal format is {:name=>"type", ...}
+    def self.internal_format_from(text)
+      params = {}
+      text.split(/[\n;]/).each do |line|
+        line.gsub!(/^\s*/,'')
+        line.gsub!(/\s*$/,'')
+
+        idx = line.rindex(' ')
+        type = line[0..idx-1]
+        name = line[idx+1..line.length]
+
+        if name =~ /(.*)\[\w*(\d+)\w*\]\w*/
+          type += "[#{$2}]"
+          name = $1
+        end
+ 
+        params[name.to_sym] = type
+      end
+      
+      params
+    end
+  end
+end

data/lib/struct_packing.rb

@@ -1,12 +1,20 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
-
-module StructPacking
-  VERSION = '0.0.1'
-end
-
-require 'struct_packing/base'
-require 'struct_packing/util'
-require 'struct_packing/packable'
-require 'struct_packing/unpackable'
-  
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+
+# StructPacking package make up with Packable and Unpackable module.
+#
+# Include these module to a class, struct defining method and 
+# packing/unpacing methods append to the class and instances.
+#
+# First, call struct defining method with "C-like sturucture declaration",
+# and the class and instances can packing or unpacking by these methods.
+module StructPacking
+  # Gem version.
+  VERSION = '0.0.1'
+end
+
+require 'struct_packing/base'
+require 'struct_packing/util'
+require 'struct_packing/packable'
+require 'struct_packing/unpackable'

data/script/console

@@ -1,10 +1,10 @@
-#!/usr/bin/env ruby
-# File: script/console
-irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
-
-libs =  " -r irb/completion"
-# Perhaps use a console_lib to store any extra methods I may want available in the cosole
-# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
-libs <<  " -r #{File.dirname(__FILE__) + '/../lib/struct_packing.rb'}"
-puts "Loading struct_packing gem"
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/struct_packing.rb'}"
+puts "Loading struct_packing gem"
 exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-
-begin
-  require 'rubigen'
-rescue LoadError
-  require 'rubygems'
-  require 'rubigen'
-end
-require 'rubigen/scripts/destroy'
-
-ARGV.shift if ['--help', '-h'].include?(ARGV[0])
-RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
-RubiGen::Scripts::Destroy.new.run(ARGV)
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -1,14 +1,14 @@
-#!/usr/bin/env ruby
-APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-
-begin
-  require 'rubigen'
-rescue LoadError
-  require 'rubygems'
-  require 'rubigen'
-end
-require 'rubigen/scripts/generate'
-
-ARGV.shift if ['--help', '-h'].include?(ARGV[0])
-RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
-RubiGen::Scripts::Generate.new.run(ARGV)
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/struct_packing.gemspec

@@ -0,0 +1,76 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "struct_packing"
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["TOKITA Hiroshi"]
+  s.date = "2013-02-16"
+  s.description = "* Read/Write ruby object to byte array with C-like struct declarations."
+  s.email = ["tokita.hiroshi@gmail.com"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "C-like_structure_declaration.rdoc",
+    "Gemfile",
+    "History.txt",
+    "LICENSE.txt",
+    "Manifest.txt",
+    "PostInstall.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/struct_packing.rb",
+    "lib/struct_packing/base.rb",
+    "lib/struct_packing/packable.rb",
+    "lib/struct_packing/unpackable.rb",
+    "lib/struct_packing/util.rb",
+    "script/console",
+    "script/console.cmd",
+    "script/destroy",
+    "script/destroy.cmd",
+    "script/generate",
+    "script/generate.cmd",
+    "struct_packing.gemspec",
+    "test/struct_packing/test_base.rb",
+    "test/struct_packing/test_packable.rb",
+    "test/struct_packing/test_unpackable.rb",
+    "test/struct_packing/test_util.rb",
+    "test/test_helper.rb",
+    "test/test_struct_packing.rb"
+  ]
+  s.homepage = "http://github.com/TOKITAHiroshi/struct_packing"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.25"
+  s.summary = "* Read/Write ruby object to byte array with C-like struct declarations."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.2.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
+    else
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.2.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+    end
+  else
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.2.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
+  end
+end
+

data/test/struct_packing/test_base.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+require 'ostruct'
+
+class TestBase < Test::Unit::TestCase
+
+  def setup
+  end
+
+  class ClassIncludeOnly
+    include StructPacking::Base
+  end
+  
+  def test_null_internal_format
+    obj = ClassIncludeOnly.new
+    assert_equal({}, obj.internal_format())
+  end
+  
+
+  class SingleIntStruct
+    include StructPacking::Base
+    self.byte_format = "int hoge;"
+  end
+  
+  def test_single_int_internal_format
+    assert_equal("int" , SingleIntStruct.internal_format[:hoge])
+  end
+
+  class MultiFieldStruct
+    include StructPacking::Base
+    self.byte_format = "int fuga; char piyo"
+  end
+
+  def test_multi_field_internal_format
+    assert_equal("int" , MultiFieldStruct.internal_format[:fuga])
+    assert_equal("char" , MultiFieldStruct.internal_format[:piyo])
+  end
+
+=begin
+  def test_internal_format_not_modifiable
+    assert_equal(4, (SingleIntStruct.internal_format[:hoge])[:size])
+    (SingleIntStruct.internal_format[:hoge])[:size] = 8
+    assert_equal(8, (SingleIntStruct.internal_format[:hoge])[:size])
+    assert_equal({:type=>"int", :start=>0, :size=>4} , SingleIntStruct.internal_format[:hoge])
+  end
+=end 
+  
+end

data/test/struct_packing/test_packable.rb

@@ -0,0 +1,89 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+require 'ostruct'
+
+class TestPackable < Test::Unit::TestCase
+
+  TEST_MOD = StructPacking::Packable
+
+  def setup
+  end
+
+  
+  
+  class ClsIntNoAttr
+    include TEST_MOD
+    self.byte_format = "uint32_t packtestint;"
+  end
+  
+  def test_pack_undefined_field_int
+    obj = ClsIntNoAttr.new
+    assert_equal( [0,0,0,0].pack("C4"), obj.pack() )
+  end
+
+  class ClsInt < ClsIntNoAttr
+    attr_accessor :packtestint
+  end
+
+  def test_pack_field_int
+    obj = ClsInt.new
+    obj.packtestint = 1
+    assert_equal( [1,0,0,0].pack("C4"), obj.pack() )
+  end
+
+  class ClsCharNoAttr
+    include TEST_MOD
+    self.byte_format = "char packtestchar;"
+  end
+  
+  def test_pack_undefined_field_char
+    obj = ClsCharNoAttr.new
+    assert_equal( [0].pack("C"), obj.pack() )
+  end
+
+  class ClsChar < ClsCharNoAttr
+    attr_accessor :packtestchar
+  end
+
+  def test_pack_field_char
+    obj = ClsChar.new
+    obj.packtestchar = 1
+    assert_equal( [1].pack("C"), obj.pack() )
+  end
+
+  class ClsMultiField
+    include TEST_MOD
+    attr_accessor :packtestchar, :packtestint
+
+    self.byte_format = "char packtestchar; int packtestint"
+    
+    def initialize
+      @packtestint = 9999
+      @packtestchar = 9999
+    end
+  end
+
+  def test_pack_multi_field
+    obj = ClsMultiField.new
+    obj.packtestint = 1
+    obj.packtestchar = 1
+    assert_equal( [1, 1, 0, 0, 0].pack("C*"), obj.pack() )
+  end
+
+  class OStructTestClass < OpenStruct
+    include TEST_MOD
+    self.byte_format = "uint32_t hoge; int fuga; byte piyo[1]"
+  end
+
+  def test_pack_with_ostruct
+    sd = OStructTestClass.new
+    sd.hoge = 1
+    sd.fuga = 2
+    sd.piyo = [8]
+    
+    ba = sd.pack()
+    
+    assert_equal([1, 0, 0, 0, 2, 0, 0, 0, 8].pack("C*"), ba)
+  end
+
+end

data/test/struct_packing/test_unpackable.rb

@@ -0,0 +1,87 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+require 'ostruct'
+
+class TestUnpackable < Test::Unit::TestCase
+
+  TEST_MOD = StructPacking::Unpackable
+
+  def setup
+  end
+
+  
+  
+  class ClsIntNoAttr
+    include TEST_MOD
+    self.byte_format = "uint32_t packtestint;"
+  end
+  
+  def test_unpack_undefined_field_int
+    obj = ClsIntNoAttr.from_data( [0,0,0,0].pack("C4") )
+    assert_raise(NoMethodError) do
+      obj.packtestint
+    end
+  end
+
+  class ClsInt < ClsIntNoAttr
+    attr_accessor :packtestint
+  end
+
+  def test_unpack_field_int
+    obj = ClsInt.from_data( [1,0,0,0].pack("C4") )
+    assert_equal(1 , obj.packtestint)
+  end
+
+  class ClsCharNoAttr
+    include TEST_MOD
+    self.byte_format = "char packtestchar;"
+  end
+  
+  def test_unpack_undefined_field_char
+    obj = ClsCharNoAttr.from_data( [1].pack("C") )
+    assert_raise(NoMethodError) do
+      obj.packtestchar
+    end
+  end
+
+  class ClsChar < ClsCharNoAttr
+    attr_accessor :packtestchar
+  end
+
+  def test_unpack_field_char
+    obj = ClsChar.from_data( [1].pack("C") )
+    assert_equal(1 , obj.packtestchar)
+  end
+
+  class ClsMultiField
+    include TEST_MOD
+    attr_accessor :packtestchar, :packtestint
+
+    self.byte_format = "char packtestchar; int packtestint"
+    
+    def initialize
+      @packtestint = 9999
+      @packtestchar = 9999
+    end
+  end
+
+  def test_unpack_multi_field
+    obj = ClsMultiField.from_data( [1, 1, 0, 0, 0].pack("C*") )
+    assert_equal(1,  obj.packtestint)
+    assert_equal(1,  obj.packtestchar)
+  end
+
+  class OStructTestClass < OpenStruct
+    include TEST_MOD
+    self.byte_format = "uint32_t hoge; int fuga; byte piyo[1]"
+  end
+
+  def test_from_data_with_ostruct
+    ud = OStructTestClass.from_data [1, 0, 0, 0, 2, 0, 0, 0, 8, 9].pack("C*")
+    
+    assert_equal(1, ud.hoge)
+    assert_equal(2, ud.fuga)
+    assert_equal([8], ud.piyo)
+  end
+
+end

data/test/struct_packing/test_util.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/../test_helper.rb'
+
+require 'ostruct'
+
+class TestUtil < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def test_types_to_template
+    tpl = StructPacking::Util.types_to_template(["int", "char"])
+
+    assert_equal("ic", tpl)
+
+  end
+  
+end

data/test/test_helper.rb

@@ -1,3 +1,3 @@
-require 'stringio'
-require 'test/unit'
-require File.dirname(__FILE__) + '/../lib/struct_packing'
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/struct_packing'

data/test/test_struct_packing.rb

@@ -6,41 +6,5 @@ class TestStructPacking < Test::Unit::TestCase
 
   def setup
   end
-  
-  def test_truth
-    assert true
-  end
-
-  class UserData < OpenStruct
-    include StructPacking::Unpackable
-    self.byte_format = {:hoge=>"uint32", :fuga=>"int", :piyo=> "byte[1]"}
-  end
-  
-  class SysData < OpenStruct
-    include StructPacking::Packable
-    self.byte_format = "uint32 hoge; int fuga; byte[1] piyo;"#{:hoge=>"uint32", :fuga=>"int", :piyo=> "byte[1]"}
-  end
-  
-  def test_from_data_with_ostruct
-    ud = UserData.from_data [1, 0, 0, 0, 2, 0, 0, 0, 8, 9].pack("C*")
-
-    assert_equal(1, ud.hoge)
-    assert_equal(2, ud.fuga)
-    assert_equal([8], ud.piyo)
-  end
-  
-
-
-  def test_pack_with
-    sd = SysData.new
-    sd.hoge = 1
-    sd.fuga = 2
-    sd.piyo = [8]
-    
-    
-    ba = sd.pack()
-    
-    assert_equal([1, 0, 0, 0, 2, 0, 0, 0, 8].pack("C*"), ba)
-  end
-  
+ 
 end