struct_packing 0.0.1 → 0.0.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/C-like_structure_declaration.rdoc

@@ -0,0 +1,117 @@
+= C-language like structure declaration
+
+== Overview:
+
+StructPacking uses "C like structure declaration" to define 
+object packing byte array format.
+It is mostly compatible with struct definition in C language, and
+some extended notation to support byte packing function in Ruby language.
+
+This is mainly use to genarate Ruby pack template string from C language's struct
+declaration.
+
+== Syntax:
+Syntax is same as C-language variable declaration.
+  [sign-modifier] <type> <variable-name> [ [array-length] ];
+
+
+== Type:
+* Traditional C language's types.
+  * char
+  * short
+  * int
+  * long
+  * long long
+  * float
+  * double
+
+
+* C99 types.
+  * int8_t
+  * int16_t
+  * int32_t
+  * int64_t
+  * uint8_t
+  * uint16_t
+  * uint32_t
+  * uint64_t
+
+* Extend keyword for Ruby pack string support.
+  * ascii
+  * utf8
+  * big
+  * big16
+  * big32
+  * little
+  * little16
+  * little32
+  * big float
+  * little float
+  * big double
+  * little double
+
+== Variable-name:
+Variable-name is identifier of this variable.
+This is must unique in this struct.
+
+In StructPacking package, variable-name is used to make relation object
+with struct definition.
+Packing function is get value from object's attr-getter which is same name as
+variable-name, and pack the value toC-like_structure_declaration.rdoc 
+
+== Array-length
+If "[]" is placed after variable-name, this variable define as array.
+
+== Sign-modifier:
+* signed 
+* unsigned
+are sign-modifier.
+
+== Bit-field
+* TODO
+
+
+== Ruby pack template mapping:
+
+* Signed (or not assinged)
+
+*char*::      "c"
+*int8_t*::      "c"
+*short*::     "s"
+*int16_t*::     "s"
+*int*::       "i"
+*int32_t*::     "l"
+*long*::        "l"
+*long* *long*:: "q"
+*int64_t*::       "q"
+*float*::       "f"
+*double*::       "d"
+
+* Unsigned
+
+*unsigned* *char*::        "C"
+*uint8_t*::                  "C"
+*unsigned* *short*::       "S"
+*uint16_t*::                 "S"
+*unsigned* *int*::         "I"
+*unsigned* *long*::        "L"
+*uint32_t*::                 "L"
+*unsigned* *long* *long*:: "Q"
+*uint64_t*::                 "Q"
+
+* Extend types
+
+*ascii*:: "a"
+*utf8*:: "U"
+*big*:: "N"
+*big16*:: "n"
+*big32*:: "N"
+*little*:: "V"
+*little16*:: "v"
+*little32*:: "V"
+*big* *float*:: "g"
+*little* *float*:: "e"
+*big* *double*:: "G"
+*little* *double*:: "E"
+
+

data/Gemfile

@@ -0,0 +1,13 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.2.0"
+  gem "jeweler", "~> 1.8.4"
+end

data/History.txt

@@ -1,4 +1,4 @@
-=== 0.0.1 2013-02-11
-
-* 1 major enhancement:
-  * Initial release
+=== 0.0.1 2013-02-11
+
+* 1 major enhancement:
+  * Initial release

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 TOKITA Hiroshi
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -1,14 +1,13 @@
-History.txt
-Manifest.txt
-PostInstall.txt
-README.rdoc
-Rakefile
-lib/struct_packing.rb
-script/console
-script/console.cmd
-script/destroy
-script/destroy.cmd
-script/generate
-script/generate.cmd
-test/test_helper.rb
-test/test_struct_packing.rb
+History.txt
+C-like_structure_declaration.rdoc
+README.rdoc
+Rakefile
+lib/struct_packing.rb
+script/console
+script/console.cmd
+script/destroy
+script/destroy.cmd
+script/generate
+script/generate.cmd
+test/test_helper.rb
+test/test_struct_packing.rb

data/PostInstall.txt

@@ -1,7 +1,7 @@
-
-For more information on struct_packing, see http://struct_packing.rubyforge.org
-
-NOTE: Change this information in PostInstall.txt 
-You can also delete it if you don't want it.
-
-
+
+For more information on struct_packing, see http://struct_packing.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -1,59 +1,63 @@
-= struct_packing
-
-* http://github.com/TOKITAHiroshi/struct_packing
-
-== DESCRIPTION:
-
-* Read/Write ruby object to byte array with C-like struct declarations.
-
-== FEATURES/PROBLEMS:
-
-* Simple read/write ruby-object to formatted byte array.
-
-== SYNOPSIS:
-
-# Packing object to byte array.
-
-class MyStruct < OpenStruct
-  include StructPacking::Packable
-  self.byte_format = "uint32 hoge; int fuga; byte[1] piyo;"
-end
-
-obj = MyStruct.new
-sd.hoge = 1
-sd.fuga = 2
-sd.piyo = [8]
-packed_struct = obj.pack # => "\x01\x00\x00\x00\x02\x00\x00\x00\b"
-
-== REQUIREMENTS:
-
-* none
-
-== INSTALL:
-
-* sudo gem install struct_packing
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2013 TOKITA Hiroshi
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+= struct_packing
+
+* http://github.com/TOKITAHiroshi/struct_packing
+
+== DESCRIPTION:
+
+* Read/Write ruby object to byte array with C-like struct declarations.
+
+== INSTALL:
+
+* sudo gem install struct_packing
+
+
+== SYNOPSIS:
+=== Packing object to byte array.
+  class PackableOStruct < OpenStruct
+    include StructPacking::Packable
+    self.byte_format = "int foo; char bar; byte[1] baz;"
+  end
+
+  obj = PackableOStruct.new
+  obj.foo = 1
+  obj.bar = 2
+  obj.baz = [8]
+  packed_bytes = obj.pack # => "\x01\x00\x00\x00\x02\b"
+
+
+=== Read object attributes from byte array.
+  class UnpackableOStruct < OpenStruct
+    include StructPacking::Unpackable
+    self.byte_format = "char foo; byte[1] bar; int baz;"
+  end
+
+  obj = UnpackableOStruct.from_data [1, 2, 3, 0, 0, 0].pack("C*")
+  obj.foo # => 1
+  obj.bar # => [2]
+  obj.baz # => 3
+
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2013 TOKITA Hiroshi
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,26 +1,53 @@
-require 'rubygems'
-gem 'hoe', '>= 2.1.0'
-require 'hoe'
-require 'fileutils'
-require './lib/struct_packing'
+# encoding: utf-8
 
-Hoe.plugin :newgem
-# Hoe.plugin :website
-# Hoe.plugin :cucumberfeatures
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
 
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.spec 'struct_packing' do
-  self.developer 'TOKITA Hiroshi', 'tokita.hiroshi@gmail.com'
-  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
-  self.rubyforge_name       = self.name # TODO this is default value
-  # self.extra_deps         = [['activesupport','>= 2.0.2']]
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "struct_packing"
+  gem.homepage = "http://github.com/TOKITAHiroshi/struct_packing"
+  gem.license = "MIT"
+  gem.summary = %Q{* Read/Write ruby object to byte array with C-like struct declarations.}
+  gem.description = %Q{* Read/Write ruby object to byte array with C-like struct declarations.}
+  gem.email = ["tokita.hiroshi@gmail.com"]
+  gem.authors = ["TOKITA Hiroshi"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
 
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+=begin
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
 end
+=end
+task :default => :test
 
-require 'newgem/tasks'
-Dir['tasks/**/*.rake'].each { |t| load t }
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
-# TODO - want other tests/tasks run by default? Add them to the list
-# remove_task :default
-# task :default => [:spec, :features]
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "struct_packing #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/struct_packing/base.rb

@@ -0,0 +1,91 @@
+
+module StructPacking
+  
+  private
+  
+  # Common defines for Packable and Unpackable 
+  module Base
+    
+    private
+    
+    def self.included(base)
+      base.extend ClassMethods
+    end
+  
+    public
+    
+    # Get structure format string used in packing this object.
+    #
+    # This method work as just wrapper to same name class-method. 
+    def internal_format
+      self.class.internal_format
+    end
+
+    # Get field name list of this class.
+    def field_names
+      self.class.field_names
+    end
+
+    # Get field type list of this class.
+    def field_types
+      self.class.field_types
+    end
+
+    # Get Ruby's pack tenplate string for this class.
+    def pack_template
+      self.class.pack_template
+    end
+    
+    # Common extending methods for Packable and Unpackable.
+    #
+    # Automatically extend on including StructPacking::Base module.
+    module ClassMethods
+      
+      private
+
+      # TODO temporary initializer for @@struct_internal_format
+      def check_vardef
+        if not self.class_variable_defined?(:@@struct_internal_format)
+          class_eval("@@struct_internal_format = ''")
+        end
+      end
+      
+      public
+
+      # Get internal structure format used to pack a object of this class.
+      def internal_format
+        check_vardef # TODO Find more good way!
+        
+        Util.internal_format_from( self.class_variable_get(:@@struct_internal_format) )
+      end
+      
+      # Set structure format for this class by string.
+      def byte_format=(text)
+        check_vardef # TODO Find more good way!
+        
+        self.class_variable_set(:@@struct_internal_format, text)
+
+        true
+      end
+
+      # Get field name list of this class.
+      def field_names
+        internal_format.keys
+      end
+
+      # Get field type list of this class.
+      def field_types
+        internal_format.values
+      end
+
+      # Get Ruby's pack tenplate string for this class.
+      def pack_template
+        check_vardef # TODO Find more good way!
+
+        Util.pack_template_from( self.class_variable_get(:@@struct_internal_format) )
+      end
+
+    end
+  end
+  
+end

data/lib/struct_packing/packable.rb

@@ -0,0 +1,49 @@
+
+module StructPacking
+  
+  # Packable module provides object-packing function.
+  # 
+  # A class include this module, and call struct defining method,
+  # pack method returns defined byte-array-form of that class's instance.
+  #
+  # == SYNOPSIS:
+  #  class PackableOStruct < OpenStruct
+  #    include StructPacking::Packable
+  #    self.byte_format = "int foo; char bar; byte[1] baz;"
+  #  end
+  #
+  #  obj = PackableOStruct.new
+  #  obj.foo = 1
+  #  obj.bar = 2
+  #  obj.baz = [8]
+  #  packed_bytes = obj.pack # => "\x01\x00\x00\x00\x02\b"
+  module Packable
+    private
+    
+    include Base
+    
+    def self.included(base)
+      base.send("include", Base)
+    end
+    
+    public
+
+    # Pack this object to byte array.
+    #
+    # If attribute defined in byte_format, 
+    # but object has no attr_getter, treat as the attribute is zero.
+    def pack()
+      values = field_names.collect do |n|
+        begin
+          instance_eval { send(n) }
+        rescue NoMethodError
+          0
+        end
+      end
+      values.flatten!
+
+      values.pack( pack_template )
+    end
+      
+  end
+end

data/lib/struct_packing/unpackable.rb

@@ -0,0 +1,79 @@
+module StructPacking
+
+  # Unpackable module provides value assign function from packed byte array.
+  # 
+  # A class include this module, and call struct defininesg method,
+  # A instance's unpack method assign variables from packed object.
+  # This module also provide read_struct_data class method
+  # which construct object and assign values from packed object.
+  module Unpackable
+    include StructPacking::Base  
+  
+    private
+
+    def self.included(base)
+      base.send("include", Base)
+      base.extend ClassMethods
+    end
+  
+    # Extending methods for Unpackable class.
+    #
+    # Automatically extend on including StructPacking::Unpackable module.
+    module ClassMethods
+      
+      # Construct object byte array.
+      # 
+      # This method is simply do object construct and values assignment.
+      # If attribute defined in byte_format, 
+      # but object has no attr_setter, do nothing.
+      # 
+      # TODO: Including class must have default constructor.
+      # 
+      # * _bytes_ packed structure. (see Packable.pack)
+      def unpack(bytes)  
+        obj = self.new
+        set_values_from_byte_to_object(bytes, obj)
+      end
+      
+      alias :from_data :unpack
+
+      private
+
+      def set_values_from_byte_to_object(bytes, obj)
+        
+        values = bytes.unpack( pack_template )
+
+        field_names.zip(gather_array_field(values) ).each do |name,value|
+          begin
+            obj.instance_eval {
+              send("#{name}=", value)
+            }
+          rescue NoMethodError
+          end
+        end
+        obj
+      end
+      
+      def gather_array_field(values)
+        field_types.collect do |name|
+          if name =~ /.*\[\w*(\d+)\w*\]\w*/
+            [0..$1.to_i].to_a.collect { values.shift }
+          else
+            values.shift
+          end
+        end
+      end
+    end
+    
+    public
+   
+    # Set attributes from packed struct byte array.
+    #
+    # If attribute defined in byte_format, 
+    # but object has no attr_setter, do nothing.
+    def read_struct_data(bytes)
+      self.class.set_values_from_byte_to_object(bytes, self)
+    end
+
+  end
+end