bindata 1.2.2 → 1.3.1

data/spec/system_spec.rb

@@ -23,8 +23,8 @@ describe "lambdas with index" do
   end
 
   it "should fail if there is no containing array" do
-    obj = NestedLambdaWithIndex.new
-    lambda { obj.a.value }.should raise_error(NoMethodError)
+    subject = NestedLambdaWithIndex.new
+    lambda { subject.a.to_s }.should raise_error(NoMethodError)
   end
 end
 
@@ -40,8 +40,8 @@ describe "lambdas with parent" do
       nested_lambda_without_parent :x
     end
 
-    obj = TestLambdaWithoutParent.new
-    obj.x.b.should == 5
+    subject = TestLambdaWithoutParent.new
+    subject.x.b.should == 5
   end
 
   it "should access parent's parent when parent is specified" do
@@ -55,8 +55,8 @@ describe "lambdas with parent" do
       nested_lambda_with_parent :x
     end
 
-    obj = TestLambdaWithParent.new
-    obj.x.b.should == 3
+    subject = TestLambdaWithParent.new
+    subject.x.b.should == 3
   end
 end
 
@@ -81,60 +81,117 @@ describe BinData::Record, "with choice field" do
   end
 
   it "should treat choice object transparently " do
-    obj = RecordWithChoiceField.new
+    subject = RecordWithChoiceField.new
 
-    obj.x.a.should == 3
+    subject.x.a.should == 3
   end
 
   it "should treat nested choice object transparently " do
-    obj = RecordWithNestedChoiceField.new
+    subject = RecordWithNestedChoiceField.new
 
-    obj.x.a.should == 3
+    subject.x.a.should == 3
   end
 
   it "should have correct offset" do
-    obj = RecordWithNestedChoiceField.new
-    obj.x.b.offset.should == 1
+    subject = RecordWithNestedChoiceField.new
+    subject.x.b.offset.should == 1
   end
 end
 
 describe BinData::Array, "of bits" do
-  before(:each) do
-    @data = BinData::Array.new(:type => :bit1, :initial_length => 15)
-  end
+  let(:data) { BinData::Array.new(:type => :bit1, :initial_length => 15) }
 
   it "should read" do
     str = [0b0001_0100, 0b1000_1000].pack("CC")
-    @data.read(str)
-    @data[0].should  == 0
-    @data[1].should  == 0
-    @data[2].should  == 0
-    @data[3].should  == 1
-    @data[4].should  == 0
-    @data[5].should  == 1
-    @data[6].should  == 0
-    @data[7].should  == 0
-    @data[8].should  == 1
-    @data[9].should  == 0
-    @data[10].should == 0
-    @data[11].should == 0
-    @data[12].should == 1
-    @data[13].should == 0
-    @data[14].should == 0
+    data.read(str)
+    data[0].should  == 0
+    data[1].should  == 0
+    data[2].should  == 0
+    data[3].should  == 1
+    data[4].should  == 0
+    data[5].should  == 1
+    data[6].should  == 0
+    data[7].should  == 0
+    data[8].should  == 1
+    data[9].should  == 0
+    data[10].should == 0
+    data[11].should == 0
+    data[12].should == 1
+    data[13].should == 0
+    data[14].should == 0
   end
 
   it "should write" do
-    @data[3] = 1
-    @data.to_binary_s.should == [0b0001_0000, 0b0000_0000].pack("CC")
+    data[3] = 1
+    data.to_binary_s.should == [0b0001_0000, 0b0000_0000].pack("CC")
   end
 
   it "should return num_bytes" do
-    @data.num_bytes.should == 2
+    data.num_bytes.should == 2
   end
 
   it "should have correct offset" do
-    @data[7].offset.should == 0
-    @data[8].offset.should == 1
+    data[7].offset.should == 0
+    data[8].offset.should == 1
+  end
+end
+
+describe BinData::Record, "containing bitfields" do
+  class BCD < BinData::Primitive
+    bit4 :d1
+    bit4 :d2
+    bit4 :d3
+
+    def set(v)
+      self.d1 = (v / 100) % 10
+      self.d2 = (v /  10) % 10
+      self.d3 =  v        % 10
+    end
+
+    def get()
+      d1 * 100 + d2 * 10 + d3
+    end
+  end
+
+  class BitfieldRecord < BinData::Record
+    struct :a do
+      bit4 :w
+    end
+
+    array  :b, :type => :bit1, :initial_length => 9
+
+    struct :c do
+      bit2 :x
+    end
+
+    bcd    :d
+    bit6   :e
+  end
+
+  subject { BitfieldRecord.new }
+
+  it "should have correct num_bytes" do
+    subject.num_bytes.should == 5
+  end
+
+  it "should read across bitfield boundaries" do
+    subject.read [0b0111_0010, 0b0110_0101, 0b0010_1010, 0b1000_0101, 0b1000_0000].pack("CCCCC")
+
+    subject.a.w.should == 7
+    subject.b.should == [0, 0, 1, 0, 0, 1, 1, 0, 0]
+    subject.c.x.should == 2
+    subject.d.should == 954
+    subject.e.should == 11
+  end
+
+  it "should write across bitfield boundaries" do
+    subject.a.w = 3
+    subject.b[2] = 1
+    subject.b[5] = 1
+    subject.c.x = 1
+    subject.d = 850
+    subject.e = 35
+    subject.to_binary_s.should == [0b0011_0010, 0b0100_0011, 0b0000_1010, 0b0001_0001, 0b1000_0000].pack("CCCCC")
   end
 end
 
@@ -186,28 +243,28 @@ describe "Tracing"  do
       def set(val) self.ex = val; end
     end
 
-    obj = DebugNamePrimitive.new
+    subject = DebugNamePrimitive.new
 
     io = StringIO.new
-    BinData::trace_reading(io) { obj.read("\x01") }
+    BinData::trace_reading(io) { subject.read("\x01") }
 
     io.value.should == ["obj-internal-.ex => 1\n", "obj => 1\n"].join("")
   end
 
   it "should trace choice selection" do
-    obj = BinData::Choice.new(:choices => [:int8, :int16be], :selection => 0)
+    subject = BinData::Choice.new(:choices => [:int8, :int16be], :selection => 0)
 
     io = StringIO.new
-    BinData::trace_reading(io) { obj.read("\x01") }
+    BinData::trace_reading(io) { subject.read("\x01") }
 
     io.value.should == ["obj-selection- => 0\n", "obj => 1\n"].join("")
   end
 
   it "should trim long trace values" do
-    obj = BinData::String.new(:read_length => 40)
+    subject = BinData::String.new(:read_length => 40)
 
     io = StringIO.new
-    BinData::trace_reading(io) { obj.read("0000000000111111111122222222223333333333") }
+    BinData::trace_reading(io) { subject.read("0000000000111111111122222222223333333333") }
 
     io.value.should == "obj => \"000000000011111111112222222222...\n"
   end
@@ -219,21 +276,20 @@ describe "Forward referencing with Primitive" do
     string :data, :read_length => :len
   end
 
+  subject { FRPrimitive.new }
+
   it "should initialise" do
-    @obj = FRPrimitive.new
-    @obj.snapshot.should == {"len" => 0, "data" => ""}
+    subject.snapshot.should == {"len" => 0, "data" => ""}
   end
 
   it "should read" do
-    @obj = FRPrimitive.new
-    @obj.read("\x04test")
-    @obj.snapshot.should == {"len" => 4, "data" => "test"}
+    subject.read("\x04test")
+    subject.snapshot.should == {"len" => 4, "data" => "test"}
   end
 
   it "should set value" do
-    @obj = FRPrimitive.new
-    @obj.data = "hello"
-    @obj.snapshot.should == {"len" => 5, "data" => "hello"}
+    subject.data = "hello"
+    subject.snapshot.should == {"len" => 5, "data" => "hello"}
   end
 end
 
@@ -243,21 +299,20 @@ describe "Forward referencing with Array" do
     array :data, :type => :uint8, :initial_length => :len
   end
 
+  subject { FRArray.new }
+
   it "should initialise" do
-    @obj = FRArray.new
-    @obj.snapshot.should == {"len" => 0, "data" => []}
+    subject.snapshot.should == {"len" => 0, "data" => []}
   end
 
   it "should read" do
-    @obj = FRArray.new
-    @obj.read("\x04\x01\x02\x03\x04")
-    @obj.snapshot.should == {"len" => 4, "data" => [1, 2, 3, 4]}
+    subject.read("\x04\x01\x02\x03\x04")
+    subject.snapshot.should == {"len" => 4, "data" => [1, 2, 3, 4]}
   end
 
   it "should set value" do
-    @obj = FRArray.new
-    @obj.data = [1, 2, 3]
-    @obj.snapshot.should == {"len" => 3, "data" => [1, 2, 3]}
+    subject.data = [1, 2, 3]
+    subject.snapshot.should == {"len" => 3, "data" => [1, 2, 3]}
   end
 end
 
@@ -271,8 +326,8 @@ describe "Evaluating custom parameters" do
   end
 
   it "should recursively evaluate parameter" do
-    obj = CustomParameterRecord.new(:zz => 5)
-    obj.c.eval_parameter(:custom).should == 5
+    subject = CustomParameterRecord.new(:zz => 5)
+    subject.c.eval_parameter(:custom).should == 5
   end
 end
 

data/spec/wrapper_spec.rb

@@ -45,44 +45,44 @@ describe BinData::Wrapper, "around a Primitive" do
   end
 
   it "should access custom parameter" do
-    obj = WrappedPrimitive.new
-    obj.assign(3)
-    obj.should == 3
+    subject = WrappedPrimitive.new
+    subject.assign(3)
+    subject.should == 3
   end
 
   it "should be able to override custom default parameter" do
-    obj = WrappedPrimitive.new(:a => 5)
-    obj.should == 5
+    subject = WrappedPrimitive.new(:a => 5)
+    subject.should == 5
   end
 
   it "should be able to override parameter" do
-    obj = WrappedPrimitive.new(:initial_value => 7)
-    obj.should == 7
+    subject = WrappedPrimitive.new(:initial_value => 7)
+    subject.should == 7
   end
 
   it "should clear" do
-    obj = WrappedPrimitive.new
-    obj.assign(3)
-    obj.should_not be_clear
+    subject = WrappedPrimitive.new
+    subject.assign(3)
+    subject.should_not be_clear
 
-    obj.clear
-    obj.should be_clear
+    subject.clear
+    subject.should be_clear
   end
 
   it "should read" do
-    obj = WrappedPrimitive.new
-    obj.assign(3)
-    str = obj.to_binary_s
+    subject = WrappedPrimitive.new
+    subject.assign(3)
+    str = subject.to_binary_s
 
     WrappedPrimitive.read(str).should == 3
   end
 
   it "should respond_to and forward messages to the wrapped object" do
-    obj = WrappedPrimitive.new
-    obj.assign(5)
+    subject = WrappedPrimitive.new
+    subject.assign(5)
 
-    obj.should respond_to(:value)
-    obj.value.should == 5
+    subject.should respond_to(:to_int)
+    subject.to_int.should == 5
   end
 end
 
@@ -90,17 +90,19 @@ describe BinData::Wrapper, "around an Array" do
   class WrappedIntArray < BinData::Wrapper
     endian :big
     default_parameter :initial_element_value => 0
-    array :type => [:uint16, {:initial_value => :initial_element_value}]
+    array do
+      uint16 :initial_value => :initial_element_value
+    end
   end
 
   it "should forward parameters" do
-    obj = WrappedIntArray.new(:initial_length => 7)
-    obj.length.should == 7
+    subject = WrappedIntArray.new(:initial_length => 7)
+    subject.length.should == 7
   end
 
   it "should be able to override default parameters" do
-    obj = WrappedIntArray.new(:initial_length => 3, :initial_element_value => 5)
-    obj.to_binary_s.should == "\x00\x05\x00\x05\x00\x05"
+    subject = WrappedIntArray.new(:initial_length => 3, :initial_element_value => 5)
+    subject.to_binary_s.should == "\x00\x05\x00\x05\x00\x05"
   end
 end
 
@@ -111,22 +113,52 @@ describe BinData::Wrapper, "around a Choice" do
   end
 
   it "should forward parameters" do
-    obj = WrappedChoice.new(:selection => 'b')
-    obj.num_bytes.should == 2
+    subject = WrappedChoice.new(:selection => 'b')
+    subject.num_bytes.should == 2
   end
 end
 
-describe BinData::Wrapper, "inside a struct" do
+describe BinData::Wrapper, "inside a Record" do
   class WrappedUint32le < BinData::Wrapper
     uint32le
   end
 
+  class RecordWithWrapped < BinData::Record
+    wrapped_uint32le :a, :onlyif => false, :value => 1
+    wrapped_uint32le :b, :onlyif => true,  :value => 2
+  end
+
   it "should handle onlyif" do
-    field1 = [:wrapped_uint32le, :a, {:onlyif => false, :value => 1 }]
-    field2 = [:wrapped_uint32le, :b, {:onlyif => true, :value => 2 }]
+    subject = RecordWithWrapped.new
+    subject.should == {'b' => 2}
+  end
+end
+
+describe BinData::Wrapper, "around a Record" do
+  class RecordToBeWrapped < BinData::Record
+    default_parameter :arg => 3
+    uint8 :a, :initial_value => :arg
+    uint8 :b
+  end
+
+  class WrappedRecord < BinData::Wrapper
+    record_to_be_wrapped
+  end
+
+  it "should forward parameters" do
+    subject = WrappedRecord.new(:arg => 5)
+    subject.a.should == 5
+  end
+
+  it "should assign value" do
+    subject = WrappedRecord.new(:b => 5)
+    subject.b.should == 5
+  end
 
-    obj = BinData::Struct.new(:fields => [field1, field2])
-    obj.should == {'b' => 2}
+  it "should assign value and forward parameters" do
+    subject = WrappedRecord.new({:b => 5}, :arg => 7)
+    subject.a.should == 7
+    subject.b.should == 5
   end
 end
 

data/tasks/pkg.rake

@@ -16,7 +16,7 @@ begin
     s.extra_rdoc_files = ['NEWS']
     s.rdoc_options << '--main' << 'NEWS'
     s.files = PKG_FILES
-    s.add_development_dependency('rspec')
+    s.add_development_dependency('rspec', [">= 1.3.0"])
     s.add_development_dependency('haml')
     s.add_development_dependency('maruku')
     s.add_development_dependency('syntax')

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bindata
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 1
-  - 2
-  - 2
-  version: 1.2.2
+  - 3
+  - 1
+  version: 1.3.1
 platform: ruby
 authors: 
 - Dion Mendel
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-14 00:00:00 +08:00
+date: 2011-01-25 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -26,10 +26,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 27
         segments: 
+        - 1
+        - 3
         - 0
-        version: "0"
+        version: 1.3.0
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -99,6 +101,9 @@ files:
 - NEWS
 - examples/gzip.rb
 - examples/ip_address.rb
+- examples/nbt.rb
+- examples/NBT.txt
+- examples/list.rb
 - spec/base_spec.rb
 - spec/string_spec.rb
 - spec/record_spec.rb
@@ -113,6 +118,7 @@ files:
 - spec/wrapper_spec.rb
 - spec/struct_spec.rb
 - spec/rest_spec.rb
+- spec/alignment_spec.rb
 - spec/base_primitive_spec.rb
 - spec/registry_spec.rb
 - spec/int_spec.rb
@@ -133,6 +139,7 @@ files:
 - lib/bindata/base.rb
 - lib/bindata/stringz.rb
 - lib/bindata/string.rb
+- lib/bindata/alignment.rb
 - lib/bindata/int.rb
 - lib/bindata/io.rb
 - lib/bindata/base_primitive.rb
@@ -141,6 +148,7 @@ files:
 - lib/bindata/record.rb
 - lib/bindata/primitive.rb
 - lib/bindata/sanitize.rb
+- lib/bindata/offset.rb
 - lib/bindata/rest.rb
 - lib/bindata/deprecated.rb
 - lib/bindata/registry.rb