bitstream 0.1.2 → 0.1.3

data/lib/bitstream/field-info.rb

@@ -0,0 +1,13 @@
+class FieldInfo < Hash
+
+	def initialize(value, length)
+		@table = {}
+		@table[:value] = value
+		@table[:length] = length
+	end
+
+	def [](key)
+		@table[key]
+	end
+
+end

data/lib/bitstream/utils.rb

@@ -0,0 +1,24 @@
+# Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
+# Copyright:: Copyright (c) 2012 Natsuki Kawai
+# License:: 2-clause BSDL or Ruby's
+
+module BitStream
+
+  module Utils
+
+    def self.class2symbol(type)
+      name = type.name.split("::").last
+      name = self.camel2snake(name).intern
+    end
+
+    def self.camel2snake(camel)
+      snake = camel.dup
+      snake[0] = snake[0].downcase
+      snake.gsub(/[A-Z]/) do |s|
+        "_" + s.downcase
+      end
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitstream
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-14 00:00:00.000000000 Z
+date: 2014-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: random-accessible
@@ -46,24 +46,10 @@ files:
 - lib/types/integer.rb
 - lib/types/cstring.rb
 - lib/types/string.rb
-- test/test-dynarray.rb
-- test/test-overload.rb
-- test/test-array.rb
-- test/test-suite.rb
-- test/test-nesting.rb
-- test/test-lazy-string.rb
-- test/test-primitives.rb
-- test/test-simple-properties.rb
-- test/test-condition.rb
-- test/types/test-character.rb
-- test/types/test-cstring.rb
-- test/types/test-string.rb
-- test/types/test-integer.rb
-- sample/flac.rb
-- sample/flac-front.rb
-- sample/gzip.rb
-- sample/gzip-viewer.rb
+- lib/bitstream/field-info.rb
+- lib/bitstream/utils.rb
 - README.en
+- test/test-suite.rb
 homepage: https://github.com/natsuki14/bitstream
 licenses:
 - Ruby's

data/sample/flac-front.rb

@@ -1,8 +0,0 @@
-require './flac'
-
-if ARGV.size != 1
-  STDERR.puts "Usage: #{__FILE__} flac_file"
-  exit 1
-end
-
-flac = FLAC.create(ARGV[0])

data/sample/flac.rb

@@ -1,37 +0,0 @@
-require 'bitstream'
-
-class FLAC
-
-  include BitStream
-
-  class MetadataBlock
-
-    include BitStream
-
-    #add_type MetadataBlockData
-
-    fields do
-      unsigned_int :last_metadata_block, 1
-      unsigned_int :block_type, 7
-      unsigned_int :body_length, 24
-      string :data, body_length
-    end
-
-    def length
-      32 + body_length
-    end
-    
-  end
-
-  add_type MetadataBlock
-
-  fields do
-    string :magic, 4#, "The FLAC stream marker"
-    dyn_array :metadata_blocks, :metadata_block
-    unless metadata_blocks.last.last_metadata_block
-      dyn_array :metadata_blocks, :metadata_block
-        #, "The basic property of the stream."
-    end
-  end
-
-end

data/sample/gzip-viewer.rb

@@ -1,12 +0,0 @@
-require_relative 'gzip'
-
-gzip = nil
-File.open(ARGV[0], "rb") do |file|
-  gzip = Gzip.create(file.read)
-end
-
-if gzip.respond_to? :original_file_name
-  puts "original_file_name:#{gzip.original_file_name}"
-else
-  puts "The gzip does not contain its original file name."
-end

data/sample/gzip.rb

@@ -1,38 +0,0 @@
-require 'bitstream'
-
-class Gzip
-  
-  include BitStream
-  byte_order :little_endian
-
-  FHCRC    = 1 << 1
-  FEXTRA   = 1 << 2
-  FNAME    = 1 << 3
-  FCOMMENT = 1 << 4
-
-  fields do
-    unsigned :id1,   8
-    unsigned :id2,   8
-    unsigned :cm,    8
-    unsigned :flg,   8
-    unsigned :mtime, 32
-    unsigned :xfl,   8
-    unsigned :os,    8
-    if (flg & FEXTRA) != 0
-      unsigned :xlen, 16
-      string   :extra_field, xlen
-    end
-    if (flg & FNAME) != 0
-      # cstring means a NULL-terminated string.
-      cstring :original_file_name
-    end
-    if (flg & FCOMMENT) != 0
-      # cstring means a NULL-terminated string.
-      cstring :file_comment
-    end
-    if (flg & FHCRC) != 0
-      unsigned :crc16, 16
-    end
-  end
-
-end

data/test/test-array.rb

@@ -1,75 +0,0 @@
-# Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
-# Copyright:: Copyright (c) 2011, 2012 Natsuki Kawai
-# License:: 2-clause BSDL or Ruby's
-
-
-require 'test/unit'
-require 'bitstream'
-
-class ArraySample
-
-  include BitStream
-
-  fields do
-    array :a1, 5, :unsigned_int, 16
-  end
-
-end
-
-class InfiniteArraySample
-
-  include BitStream
-
-  fields do
-    array :a1, nil, :uint16
-  end
-
-end
-
-class VarlenArraySample
-
-  include BitStream
-
-  fields do
-    array :a1, nil, :cstring
-  end
-
-end
-
-class TestArray < Test::Unit::TestCase
-
-  def setup
-    @spec = ArraySample.create "\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a"
-    @spec_inf = InfiniteArraySample.create "\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a"
-    @spec_var = VarlenArraySample.create "foo\0quux\0baz\0"
-  end
-
-  def test_a1
-    assert_equal(5, @spec.a1.size)
-    assert_equal(0x0102, @spec.a1[0])
-    assert_equal(0x0304, @spec.a1[1])
-    assert_equal(0x0506, @spec.a1[2])
-    assert_equal(0x0708, @spec.a1[3])
-    assert_equal(0x090a, @spec.a1[4])
-    assert_equal(nil, @spec.a1[5])
-  end
-
-  def test_infinite
-    assert_equal(5, @spec_inf.a1.size)
-    assert_equal(0x0102, @spec_inf.a1[0])
-    assert_equal(0x0304, @spec_inf.a1[1])
-    assert_equal(0x0506, @spec_inf.a1[2])
-    assert_equal(0x0708, @spec_inf.a1[3])
-    assert_equal(0x090a, @spec_inf.a1[4])
-    assert_equal(nil, @spec_inf.a1[5])
-  end
-
-  def test_varlen
-    assert_equal(3, @spec_var.a1.size)
-    assert_equal("foo", @spec_var.a1[0])
-    assert_equal("quux", @spec_var.a1[1])
-    assert_equal("baz", @spec_var.a1[2])
-    assert_equal(nil, @spec_var.a1[3])
-  end
-
-end

data/test/test-condition.rb

@@ -1,50 +0,0 @@
-# Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
-# Copyright:: Copyright 2011 Natsuki Kawai
-# License:: 2-clause BSDL or Ruby's
-
-
-require 'test/unit'
-require 'bitstream'
-
-class ConditionSample
-
-  include BitStream
-
-  fields {
-    unsigned_int :u1, 32
-    if u1 == 0
-      unsigned_int :u2, 32
-    end
-  }
-
-end
-
-class TestCondition < Test::Unit::TestCase
-
-  def setup
-  end
-
-  def test_condition_true
-    spec = ConditionSample.create "\x00\x00\x00\x00\x00\x00\x00\x01"
-    assert_equal(0, spec.u1)
-    assert_equal(1, spec.u2)
-  end
-
-  def test_condition_false
-    spec = ConditionSample.create "\x00\x00\x00\x01\x00\x00\x00\x01"
-    assert_equal(1, spec.u1)
-    assert_raise(NoMethodError) do
-      spec.u2
-    end
-  end
-
-  def test_condition_false_with_dummy
-    ConditionSample.create "\x00\x00\x00\x00\x00\x00\x00\x01" # dummy
-    spec = ConditionSample.create "\x00\x00\x00\x01\x00\x00\x00\x01"
-    assert_equal(1, spec.u1)
-    assert_raise(NoMethodError) do
-      spec.u2
-    end
-  end
-
-end

data/test/test-dynarray.rb

@@ -1,34 +0,0 @@
-# Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
-# Copyright:: Copyright 2011 Natsuki Kawai
-# License:: 2-clause BSDL or Ruby's
-
-
-require 'test/unit'
-require 'bitstream'
-
-class DynArraySample
-
-  include BitStream
-
-  fields {
-    dyn_array :a1, :char
-    while a1.last != "\0"
-      dyn_array :a1, :char
-    end
-  }
-
-end
-
-
-class TestDynArray < Test::Unit::TestCase
-
-  def setup
-    @spec = DynArraySample.create "foobar\0"
-  end
-
-  def test_a1
-    assert_equal("foobar\0", @spec.a1.join)
-  end
-
-end
-

data/test/test-lazy-string.rb

@@ -1,36 +0,0 @@
-# Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
-# Copyright:: Copyright (c) 2012 Natsuki Kawai
-# License:: 2-clause BSDL or Ruby's
-
-require 'test/unit'
-require 'lazy-string'
-
-class TestLazyString < Test::Unit::TestCase
-
-  def setup
-    @sample = LazyString.new
-    @sample << "foo"
-    @sample << "bar"
-    @sample << "quux"
-    @sample << "baz"
-  end
-
-  def test_head
-    assert_equal("fo", @sample[0, 2].to_str)
-    assert_equal("foo", @sample[0, 3].to_str)
-    assert_equal("foob", @sample[0, 4].to_str)
-  end
-
-  def test_im
-    assert_equal("a", @sample[4, 1].to_str)
-    assert_equal("bar", @sample[3, 3].to_str)
-    assert_equal("obarq", @sample[2, 5].to_str)
-  end
-
-  def test_last
-    assert_equal("az", @sample[11, 2].to_str)
-    assert_equal("baz", @sample[10, 3].to_str)
-    assert_equal("xbaz", @sample[9, 4].to_str)
-  end
-
-end

data/test/test-nesting.rb

@@ -1,64 +0,0 @@
-# Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
-# Copyright:: Copyright 2011 Natsuki Kawai
-# License:: 2-clause BSDL or Ruby's
-
-
-require 'test/unit'
-require 'bitstream'
-
-class Nested
-
-  include BitStream
-
-  fields do
-    unsigned_int "u1", 8
-    unsigned_int :u2, 8
-  end
-
-end
-
-class Nesting
-
-  include BitStream
-
-  add_type Nested, :nested
-
-  fields do
-    unsigned_int "u1", 8
-    nested       "n"
-    unsigned_int :u2, 8
-  end
-
-end
-
-class TestNesting < Test::Unit::TestCase
-
-  def setup
-    @spec = Nesting.create "\x01\x02\x03\x04"
-  end
-
-  def test_nesting_u1
-    assert_equal(0x01, @spec.u1)
-  end
-
-  def test_nesting_u2
-    assert_equal(0x04, @spec.u2)
-  end
-
-  def test_nesting
-    assert_equal(32, @spec.length)
-  end
-
-  def test_nested_u1
-    assert_equal(0x02, @spec.n.u1)
-  end
-
-  def test_nested_u2
-    assert_equal(0x03, @spec.n.u2)
-  end
-
-  def test_nested
-    assert_equal(16, @spec.n.length)
-  end
-
-end

data/test/test-overload.rb

@@ -1,69 +0,0 @@
-# Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
-# Copyright:: Copyright (c) 2012 Natsuki Kawai
-# License:: 2-clause BSDL or Ruby's
-
-require 'test/unit'
-require 'bitstream'
-
-class OverloadSample1
-
-  include BitStream
-
-  fields do
-    unsigned :a, 32
-    unsigned :a, 32
-  end
-
-end
-
-class OverloadSample2
-
-  include BitStream
-
-  fields do
-    unsigned :a, 8
-    if a == 1
-      cstring :a
-    else
-      string :a, 1
-    end
-  end
-
-end
-
-class OverloadSampleArray
-
-  include BitStream
-
-  fields do
-    array :a, 3, :unsigned, 8
-    unsigned :a, 16
-    unsigned :b, 16
-    array :b, 2, :unsigned, 8
-  end
-
-end
-
-class TestOverload < Test::Unit::TestCase
-
-  def setup
-    @spec1 = OverloadSample1.create "\x00\x00\x00\x01\x00\x00\x00\x02"
-    @spec2 = OverloadSample2.create "\x01foo\0"
-    @spec_array = OverloadSampleArray.create "abc\x01\x01\x02\x02\x03\x03"
-  end
-
-  def test_a1
-    assert_equal(2, @spec1.a)
-  end
-
-  def test_a2
-    assert_equal("foo", @spec2.a)
-  end
-
-  def test_array
-    assert_equal(0x0101, @spec_array.a)
-    assert_equal([3, 3], @spec_array.b)
-  end
-
-end
-

data/test/test-primitives.rb

@@ -1,92 +0,0 @@
-# Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
-# Copyright:: Copyright 2011 Natsuki Kawai
-# License:: 2-clause BSDL or Ruby's
-
-
-require 'test/unit'
-require 'bitstream'
-
-class SimpleIntBe
-
-  include BitStream
-
-  byte_order :big_endian
-
-  fields {
-    unsigned "u1", 32
-    uint32   :u2
-    cstring  "cs1"
-    unsigned "u3", 1
-    uint7    "u4"
-    string   :s1, 3
-  }
-
-end
-
-class SimpleIntLe
-
-  include BitStream
-
-  byte_order :little_endian
-
-  fields {
-    unsigned_int "u1", 32
-    unsigned_int :u2, 32
-    cstring      "cs1"
-    unsigned_int "u3", 1
-    unsigned_int "u4", 7
-    string       :s1, 3
-  }
-
-end
-
-class TestSimpleInt < Test::Unit::TestCase
-
-  def setup
-    @spec = SimpleIntBe.create "\x10\x20\x30\x40\x50\x60\x70\x80foobar\00\xfebazdummy"
-
-    # dummy
-    dummy = SimpleIntBe.create "\x10\x20\x30\x40\x50\x60\x70\x80foobar\00\xfebazdummy"
-
-    @spec_le = SimpleIntLe.create "\x10\x20\x30\x40\x50\x60\x70\x80foobar\00\xfebazdummy"
-  end
-
-  def test_u1
-    assert_equal(0x10203040.to_s(16), @spec.u1.to_s(16))
-  end
-  def test_u1le
-    assert_equal(0x40302010.to_s(16), @spec_le.u1.to_s(16))
-  end
-
-  def test_u2
-    assert_equal(0x50607080.to_s(16), @spec.u2.to_s(16))
-  end
-  def test_u2le
-    assert_equal(0x80706050.to_s(16), @spec_le.u2.to_s(16))
-  end
-
-  def test_u3
-    assert_equal(1, @spec.u3)
-  end
-  def test_u3le
-    assert_equal(1, @spec_le.u3)
-  end
-
-  def test_u4
-    assert_equal(0x7e, @spec.u4)
-  end
-  def test_u4le
-    assert_equal(0x7e, @spec_le.u4)
-  end
-
-  def test_cs1
-    assert_equal("foobar", @spec.cs1)
-    assert_equal("foobar", @spec_le.cs1)
-  end
-
-  def test_s1
-    assert_equal("baz", @spec.s1)
-    assert_equal("baz", @spec_le.s1)
-  end
-
-end

data/test/test-simple-properties.rb

@@ -1,34 +0,0 @@
-# Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
-# Copyright:: Copyright 2011 Natsuki Kawai
-# License:: 2-clause BSDL or Ruby's
-
-
-require 'test/unit'
-require 'bitstream'
-
-class HavingProps
-
-  include BitStream
-
-  fields do
-    unsigned_int :u1, props[:lengths][0]
-    unsigned_int :u2, props[:lengths][1]
-  end
-
-end
-
-class TestSimpleProperties < Test::Unit::TestCase
-
-  def setup
-    @spec = HavingProps.create "\x01\x02\x03\x04", lengths: [24, 8]
-  end
-
-  def test_u1
-    assert_equal(0x010203, @spec.u1)
-  end
-
-  def test_u2
-    assert_equal(0x04, @spec.u2)
-  end
-
-end

data/test/types/test-character.rb

@@ -1,19 +0,0 @@
-# Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
-# Copyright:: Copyright 2011, 2012 Natsuki Kawai
-# License:: 2-clause BSDL or Ruby's
-
-
-require 'test/unit'
-require 'types/character'
-
-class TestUint < Test::Unit::TestCase
-
-  def test_char_nooffset_read
-    type = BitStream::Char.instance({})
-    info = type.read("abcd", 8)
-    assert_equal("b", info[:value])
-    assert_equal(8, info[:length])
-  end
-  
-end
-

data/test/types/test-cstring.rb

@@ -1,18 +0,0 @@
-# Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
-# Copyright:: Copyright 2011, 2012 Natsuki Kawai
-# License:: 2-clause BSDL or Ruby's
-
-
-require 'test/unit'
-require 'types/cstring'
-
-class TestCstring < Test::Unit::TestCase
-
-  def test_aligned_read
-    type = BitStream::Cstring.instance({})
-    info = type.read("foobar\0baz", 16)
-    assert_equal("obar", info[:value])
-    assert_equal(8 * "obar\0".size, info[:length])
-  end
-
-end

data/test/types/test-integer.rb

@@ -1,98 +0,0 @@
-# Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
-# Copyright:: Copyright 2011, 2012 Natsuki Kawai
-# License:: 2-clause BSDL or Ruby's
-
-
-require 'test/unit'
-require 'types/integer'
-
-class TestUint < Test::Unit::TestCase
-
-  BE_PROP = { :byte_order => :big_endian }
-  LE_PROP = { :byte_order => :little_endian }
-
-  def test_uint32be_nooffset_read
-    type = BitStream::Unsigned.instance(BE_PROP,32)
-    info = type.read("\x01\x02\x03\x04", 0)
-    assert_equal(0x01020304, info[:value])
-    assert_equal(32, info[:length])
-  end
-
-  def test_uint32le_nooffset_read
-    type = BitStream::Unsigned.instance(LE_PROP,32)
-    info = type.read("\x01\x02\x03\x04", 0)
-    assert_equal(0x04030201, info[:value])
-    assert_equal(32, info[:length])
-  end
-
-  def test_sint32be_nooffset_read
-    type = BitStream::Signed.instance(BE_PROP,32)
-    info = type.read("\xfe\xfd\xfc\xfb", 0)
-    assert_equal(-0x01020304 - 1, info[:value])
-    assert_equal(32, info[:length])
-  end
-
-  def test_sint32le_nooffset_read
-    type = BitStream::Signed.instance(LE_PROP,32)
-    info = type.read("\xfe\xfd\xfc\xfb", 0)
-    assert_equal(-0x04030201 - 1, info[:value])
-    assert_equal(32, info[:length])
-  end
-
-  def test_uint32_nooffset_write
-    type = BitStream::Unsigned.instance(BE_PROP, 32)
-    val = "\xff\x00"
-    type.write(val, 8, 0x01020304)
-    assert_equal("\xff\x01\x02\x03\x04", val)
-  end
-
-  def test_uint32be_offset4_read
-    type = BitStream::Unsigned.instance(BE_PROP, 32)
-    info = type.read("\xf1\x02\x03\x04\x05", 4)
-    assert_equal(0x10203040.to_s(16), info[:value].to_s(16))
-    assert_equal(32, info[:length])
-  end
-
-  def test_uint32be_offset1_read
-    type = BitStream::Unsigned.instance(BE_PROP, 32)
-    info = type.read("\x12\x23\x34\x45\x56", 1)
-    assert_equal(0x2446688a.to_s(16), info[:value].to_s(16))
-    assert_equal(32, info[:length])
-  end
-
-  def test_uint32le_offset4_read
-    type = BitStream::Unsigned.instance(LE_PROP, 32)
-    info = type.read("\xf1\x02\x03\x04\x05", 4)
-    assert_equal(0x5040302f.to_s(16), info[:value].to_s(16))
-    assert_equal(32, info[:length])
-  end
-
-  def test_uint32le_offset1_read
-    type = BitStream::Unsigned.instance(LE_PROP, 32)
-    info = type.read("\x80\x23\x34\x45\x56", 1)
-    assert_equal(0xac8a6847.to_s(16), info[:value].to_s(16))
-    assert_equal(32, info[:length])
-  end
-
-  def test_uint1be_read
-    type = BitStream::Unsigned.instance(BE_PROP, 1)
-    info = type.read("\x40", 1)
-    assert_equal(1, info[:value])
-    assert_equal(1, info[:length])
-
-    info = type.read("\xfd", 6)
-    assert_equal(0, info[:value])
-    assert_equal(1, info[:length])
-  end
-
-  def test_uint1le_read
-    type = BitStream::Unsigned.instance(LE_PROP, 1)
-    info = type.read("\x40", 1)
-    assert_equal(1, info[:value])
-    assert_equal(1, info[:length])
-
-    info = type.read("\xfd", 6)
-    assert_equal(0, info[:value])
-    assert_equal(1, info[:length])
-  end
-end

data/test/types/test-string.rb

@@ -1,41 +0,0 @@
-# Author:: Natsuki Kawai (natsuki.kawai@gmail.com)
-# Copyright:: Copyright 2011, 2012 Natsuki Kawai
-# License:: 2-clause BSDL or Ruby's
-
-
-require 'test/unit'
-require 'types/string'
-
-class TestString < Test::Unit::TestCase
-
-  def test_aligned_read
-    type = BitStream::String.instance({}, 3)
-    info = type.read("foobarbaz", 16)
-    assert_equal("oba", info[:value])
-    assert_equal(3 * 8, info[:length])
-  end
-
-  def test_aligned_write
-    type = BitStream::String.instance({}, 3)
-    val = "foobarbaz"
-    ret = type.write(val, 24, "qux")
-    assert_equal("fooquxbaz", val)
-  end
-
-  def test_unaligned_read
-    type = BitStream::String.instance({}, 2)
-    info = type.read([0x12345678].pack('N'), 1)
-    assert_equal("\x24\x68", info[:value])
-    assert_equal(2 * 8, info[:length])
-  end
-
-  def test_unaligned_write
-    type = BitStream::String.instance({}, 2)
-    val = "\x12\x34"
-    ret = type.write(val, 7, "\xcd\xef")
-
-    assert_equal("\x13\x9b", val[0..1])
-    assert(val[2].ord & 0xfe == 0xde)
-  end
-
-end