bindata 0.5.0

data/spec/stringz_spec.rb

@@ -0,0 +1,159 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.dirname(__FILE__)) + '/spec_common'
+require 'bindata/stringz'
+
+context "An empty Stringz data object" do
+  setup do
+    @str = BinData::Stringz.new
+  end
+
+  specify "should include the zero byte in num_bytes total" do
+    @str.num_bytes.should == 1
+  end
+
+  specify "should not append the zero byte terminator to the value" do
+    @str.value.should == ""
+  end
+
+  specify "should write the zero byte terminator" do
+    io = StringIO.new
+    @str.write(io)
+    io.rewind
+    io.read.should == "\0"
+  end
+end
+
+context "A Stringz data object with value set" do
+  setup do
+    @str = BinData::Stringz.new
+    @str.value = "abcd"
+  end
+
+  specify "should include the zero byte in num_bytes total" do
+    @str.num_bytes.should == 5
+  end
+
+  specify "should not append the zero byte terminator to the value" do
+    @str.value.should == "abcd"
+  end
+
+  specify "should write the zero byte terminator" do
+    io = StringIO.new
+    @str.write(io)
+    io.rewind
+    io.read.should == "abcd\0"
+  end
+end
+
+context "Reading with a Stringz data object" do
+  setup do
+    @str = BinData::Stringz.new
+  end
+
+  specify "should stop at the first zero byte" do
+    io = StringIO.new("abcd\0xyz\0")
+    @str.read(io)
+    @str.value.should == "abcd"
+    io.read(1).should == "x"
+  end
+
+  specify "should handle a zero length string" do
+    io = StringIO.new("\0abcd")
+    @str.read(io)
+    @str.value.should == ""
+    io.read(1).should == "a"
+  end
+
+  specify "should fail if no zero byte is found" do
+    io = StringIO.new("abcd")
+    lambda {@str.read(io) }.should raise_error(EOFError)
+  end
+end
+
+context "Setting the value of a Stringz data object" do
+  setup do
+    @str = BinData::Stringz.new
+  end
+
+  specify "should include the zero byte in num_bytes total" do
+    @str.value = "abcd"
+    @str.num_bytes.should == 5
+  end
+
+  specify "should accept empty strings" do
+    @str.value = ""
+    @str.value.should == ""
+  end
+
+  specify "should accept strings that aren't zero terminated" do
+    @str.value = "abcd"
+    @str.value.should == "abcd"
+  end
+
+  specify "should accept strings that are zero terminated" do
+    @str.value = "abcd\0"
+    @str.value.should == "abcd"
+  end
+
+  specify "should accept up to the first zero byte" do
+    @str.value = "abcd\0xyz\0"
+    @str.value.should == "abcd"
+  end
+end
+
+context "A Stringz data object with max_length" do
+  setup do
+    @str = BinData::Stringz.new(:max_length => 5)
+  end
+
+  specify "should read less than max_length" do
+    io = StringIO.new("abc\0xyz")
+    @str.read(io)
+    @str.value.should == "abc"
+  end
+
+  specify "should read exactly max_length" do
+    io = StringIO.new("abcd\0xyz")
+    @str.read(io)
+    @str.value.should == "abcd"
+  end
+
+  specify "should read no more than max_length" do
+    io = StringIO.new("abcdefg\0xyz")
+    @str.read(io)
+    @str.value.should == "abcd"
+    io.read(1).should == "f"
+  end
+
+  specify "should accept values less than max_length" do
+    @str.value = "abc"
+    @str.value.should == "abc"
+  end
+
+  specify "should accept values exactly max_length" do
+    @str.value = "abcd"
+    @str.value.should == "abcd"
+  end
+
+  specify "should trim values greater than max_length" do
+    @str.value = "abcde"
+    @str.value.should == "abcd"
+  end
+
+  specify "should write values less than max_length" do
+    io = StringIO.new
+    @str.value = "abc"
+    @str.write(io)
+    io.rewind
+    io.read.should == "abc\0"
+  end
+
+  specify "should write values exactly max_length" do
+    io = StringIO.new
+    @str.value = "abcd"
+    @str.write(io)
+    io.rewind
+    io.read.should == "abcd\0"
+  end
+end

data/spec/struct_spec.rb

@@ -0,0 +1,190 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.dirname(__FILE__)) + '/spec_common'
+require 'bindata/struct'
+require 'bindata/int'
+
+context "A Struct with hidden fields" do
+  context_setup do
+    eval <<-END
+      class TestStruct < BinData::Struct
+        hide :b, 'c'
+        int8 :a
+        int8 'b', :initial_value => 10
+        int8 :c
+        int8 :d, :value => :b
+      end
+    END
+    @obj = TestStruct.new
+  end
+
+  specify "should only show fields that aren't hidden" do
+    @obj.field_names.should == ["a", "d"]
+  end
+
+  specify "should be able to access hidden fields directly" do
+    @obj.b.should == 10
+    @obj.c = 15
+    @obj.c.should == 15
+
+    @obj.should respond_to?(:b=)
+  end
+
+  specify "should not include hidden fields in snapshot" do
+    @obj.b = 5
+    @obj.snapshot.should == {"a" => 0, "d" => 5}
+  end
+end
+
+context "Defining a Struct" do
+  specify "should fail on non registered types" do
+    lambda {
+      eval <<-END
+        class BadType < BinData::Struct
+          non_registerd_type :a
+        end
+      END
+    }.should raise_error(TypeError)
+  end
+
+  specify "should fail on duplicate names" do
+    lambda {
+      eval <<-END
+        class DuplicateName < BinData::Struct
+          int8 :a
+          int8 :b
+          int8 :a
+        end
+      END
+    }.should raise_error(SyntaxError)
+  end
+end
+
+context "A Struct with multiple fields" do
+  setup do
+    fields = [ [:int8, :a], [:int8, :b] ]
+    @obj = BinData::Struct.new(:fields => fields) 
+    @obj.a = 1
+    @obj.b = 2
+  end
+
+  specify "should return num_bytes" do
+    @obj.num_bytes(:a).should == 1
+    @obj.num_bytes(:b).should == 1
+    @obj.num_bytes.should == 2
+  end
+
+  specify "should clear" do
+    @obj.a = 6
+    @obj.clear
+    @obj.clear?.should be_true
+  end
+
+  specify "should clear individual elements" do
+    @obj.a = 6
+    @obj.b = 7
+    @obj.clear(:a)
+    @obj.clear?(:a).should be_true
+    @obj.clear?(:b).should be_false
+  end
+
+  specify "should write ordered" do
+    io = StringIO.new
+    @obj.write(io)
+
+    io.rewind
+    io.read.should == "\x01\x02"
+  end
+
+  specify "should read ordered" do
+    io = StringIO.new "\x03\x04"
+    @obj.read(io)
+
+    @obj.a.should == 3
+    @obj.b.should == 4
+  end
+
+  specify "should return a snapshot" do
+    snap = @obj.snapshot
+    snap.a.should == 1
+    snap.b.should == 2
+    snap.should == { "a" => 1, "b" => 2 }
+  end
+
+  specify "should return field_names" do
+    @obj.field_names.should == ["a", "b"]
+  end
+  
+  specify "should fail on unknown method call" do
+    lambda { @obj.does_not_exist }.should raise_error(NoMethodError)
+  end
+end
+
+context "A Struct with a value method" do
+  context_setup do
+    eval <<-END
+      class StructWithValue < BinData::Struct
+        int8 :a
+        int8 :b
+
+        def value
+          a
+        end
+      end
+    END
+    @obj = StructWithValue.new
+  end
+
+  specify "should be single value object" do
+    @obj.should be_a_single_value
+  end
+
+  specify "should have no field names" do
+    @obj.field_names.should be_empty
+  end
+
+  specify "should not respond to field accesses" do
+    @obj.should_not respond_to?(:a)
+  end
+end
+
+context "A Struct with nested structs" do
+  context_setup do
+    eval <<-END
+      class StructInner1 < BinData::Struct
+        int8 :w, :initial_value => 3
+        int8 :x, :value => :the_val
+      end
+
+      class StructInner2 < BinData::Struct
+        int8 :y, :value => lambda { parent.b.w }
+        int8 :z
+      end
+
+      class StructOuter < BinData::Struct
+        int8          :a, :initial_value => 6
+        struct_inner1 :b, :the_val => :a
+        struct_inner2 nil
+      end
+    END
+    @obj = StructOuter.new
+  end
+
+  specify "should included nested field names" do
+    @obj.field_names.should == ["a", "b", "y", "z"]
+  end
+
+  specify "should access nested fields" do
+    @obj.a.should == 6
+    @obj.b.w.should == 3
+    @obj.b.x.should == 6
+    @obj.y.should == 3
+  end
+
+  specify "should return correct offset of" do
+    @obj.offset_of("b").should == 1
+    @obj.offset_of("y").should == 3
+    @obj.offset_of("z").should == 4
+  end
+end
+

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.0
+specification_version: 1
+name: bindata
+version: !ruby/object:Gem::Version 
+  version: 0.5.0
+date: 2007-03-16 00:00:00 +09:00
+summary: A declarative way to read and write binary file formats
+require_paths: 
+- lib
+email: dion@lostrealm.com
+homepage: http://bindata.rubyforge.org
+rubyforge_project: bindata
+description: 
+autorequire: bindata
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Dion Mendel
+files: 
+- COPYING
+- GPL
+- INSTALL
+- README
+- TODO
+- ChangeLog
+- examples/gzip.rb
+- spec/lazy_spec.rb
+- spec/base_spec.rb
+- spec/int_spec.rb
+- spec/stringz_spec.rb
+- spec/choice_spec.rb
+- spec/registry_spec.rb
+- spec/single_spec.rb
+- spec/string_spec.rb
+- spec/spec_common.rb
+- spec/array_spec.rb
+- spec/struct_spec.rb
+- lib/bindata
+- lib/bindata.rb
+- lib/bindata/int.rb
+- lib/bindata/string.rb
+- lib/bindata/base.rb
+- lib/bindata/struct.rb
+- lib/bindata/array.rb
+- lib/bindata/stringz.rb
+- lib/bindata/registry.rb
+- lib/bindata/choice.rb
+- lib/bindata/lazy.rb
+- lib/bindata/single.rb
+test_files: []
+
+rdoc_options: 
+- README
+- lib/bindata
+- -m
+- README
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+