bindata 0.10.0 → 0.11.0

data/spec/array_spec.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.dirname(__FILE__)) + '/spec_common'
-require File.expand_path(File.dirname(__FILE__)) + '/example'
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_common"))
+require File.expand_path(File.join(File.dirname(__FILE__), "example"))
 require 'bindata/array'
 require 'bindata/int'
 
@@ -135,7 +135,7 @@ describe BinData::Array, "with several elements" do
   end
 
   it "should have correct num_bytes for individual elements" do
-    @data.num_bytes(0).should == ExampleSingle.new.num_bytes
+    @data[0].num_bytes.should == ExampleSingle.new.num_bytes
   end
 
   it "should be able to directly access elements" do
@@ -163,7 +163,7 @@ describe BinData::Array, "with several elements" do
 
   it "should clear a single element" do
     @data[1] = 8
-    @data.clear(1)
+    @data[1].clear
     @data[1].should == 2
   end
 
@@ -173,14 +173,14 @@ describe BinData::Array, "with several elements" do
 
   it "should be clear if all elements are clear" do
     @data[1] = 8
-    @data.clear(1)
+    @data[1].clear
     @data.should be_clear
   end
 
   it "should test clear status of individual elements" do
     @data[1] = 8
-    @data.clear?(0).should be_true
-    @data.clear?(1).should be_false
+    @data[0].should be_clear
+    @data[1].should_not be_clear
   end
 
   it "should symmetrically read and write" do
@@ -269,21 +269,6 @@ describe BinData::Array, "when accessing elements" do
     @data.length.should == 5
   end
 
-  it "should not extend on clear" do
-    @data.clear(9)
-    @data.length.should == 5
-  end
-
-  it "should not extend on clear?" do
-    @data.clear?(9).should be_true
-    @data.length.should == 5
-  end
-
-  it "should not extend on num_bytes" do
-    @data.num_bytes(9).should == 0
-    @data.length.should == 5
-  end
-
   it "should raise error on bad input to []" do
     lambda { @data["a"] }.should raise_error(TypeError)
     lambda { @data[1, "a"] }.should raise_error(TypeError)

data/spec/base_primitive_spec.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.dirname(__FILE__)) + '/spec_common'
-require File.expand_path(File.dirname(__FILE__)) + '/example'
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_common"))
+require File.expand_path(File.join(File.dirname(__FILE__), "example"))
 require 'bindata/base_primitive'
 require 'bindata/io'
 
@@ -124,6 +124,15 @@ describe ExampleSingle do
     @data.should == 5
     5.should == @data
   end
+
+  it "should work as hash keys" do
+    hash = {5 => 17}
+
+    obj = ExampleSingle.new
+    obj.value = 5
+
+    hash[obj].should == 17
+  end
 end
 
 describe BinData::BasePrimitive, "after initialisation" do

data/spec/base_spec.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.dirname(__FILE__)) + '/spec_common'
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_common"))
 require 'bindata/base'
 
 class BaseStub < BinData::Base
@@ -56,6 +56,28 @@ describe BinData::Base, "when subclassing" do
   end
 end
 
+describe BinData::Base, "with parameters" do
+  it "should raise error if parameter has nil value" do
+    lambda { BaseStub.new(:a => nil) }.should raise_error(ArgumentError)
+  end
+
+  it "should raise error if parameter name is invalid" do
+    lambda {
+      eval <<-END
+        class InvalidParameterNameBase < BinData::Base
+          optional_parameter :eval # i.e. Kernel#eval
+        end
+      END
+    }.should raise_error(NameError)
+  end
+
+  it "should convert keys to symbols" do
+    obj = BaseStub.new('a' => 3)
+    obj.should have_parameter(:a)
+    obj.get_parameter(:a).should == 3
+  end
+end
+
 describe BinData::Base, "with mandatory parameters" do
   before(:all) do
     eval <<-END
@@ -139,7 +161,7 @@ describe BinData::Base, "with multiple parameters" do
   end
 
   it "should identify internally accepted parameters" do
-    accepted = WithParamBase.accepted_internal_parameters
+    accepted = WithParamBase.accepted_parameters.all
     accepted.should include(:p1)
     accepted.should include(:p2)
     accepted.should include(:p3)

data/spec/bits_spec.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.dirname(__FILE__)) + '/spec_common'
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_common"))
 require 'bindata/bits'
 
 describe "Bits of size 1" do

data/spec/choice_spec.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.dirname(__FILE__)) + '/spec_common'
-require File.expand_path(File.dirname(__FILE__)) + '/example'
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_common"))
+require File.expand_path(File.join(File.dirname(__FILE__), "example"))
 require 'bindata/choice'
 
 class Chooser

data/spec/deprecated_spec.rb

@@ -0,0 +1,96 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_common"))
+require File.expand_path(File.join(File.dirname(__FILE__), "example"))
+require 'bindata'
+
+describe BinData::SingleValue, "when defining" do
+  it "should allow inheriting from deprecated SingleValue" do
+    lambda {
+      eval <<-END
+        class SubclassSingleValue < BinData::SingleValue
+        end
+      END
+    }.should_not raise_error
+  end
+end
+
+describe BinData::MultiValue, "when defining" do
+  it "should allow inheriting from deprecated MultiValue" do
+    lambda {
+      eval <<-END
+        class SubclassMultiValue < BinData::MultiValue
+        end
+      END
+    }.should_not raise_error
+  end
+end
+
+describe BinData::Array, "with several elements" do
+  before(:each) do
+    type = [:example_single, {:initial_value => lambda { index + 1 }}]
+    @data = BinData::Array.new(:type => type, :initial_length => 5)
+  end
+
+  it "should clear a single element" do
+    @data[1] = 8
+    @data.clear(1)
+    @data[1].should == 2
+  end
+
+  it "should test clear status of individual elements" do
+    @data[1] = 8
+    @data.clear?(0).should be_true
+    @data.clear?(1).should be_false
+  end
+
+  it "should have correct num_bytes for individual elements" do
+    @data.num_bytes(0).should == ExampleSingle.new.num_bytes
+  end
+
+  it "should not extend on clear" do
+    @data.clear(9)
+    @data.length.should == 5
+  end
+
+  it "should not extend on clear?" do
+    @data.clear?(9).should be_true
+    @data.length.should == 5
+  end
+
+  it "should not extend on num_bytes" do
+    @data.num_bytes(9).should == 0
+    @data.length.should == 5
+  end
+end
+
+describe BinData::String, "with deprecated parameters" do
+  it "should substitude :trim_padding for :trim_value" do
+    obj = BinData::String.new(:trim_value => true)
+    obj.value = "abc\0"
+    obj.value.should == "abc"
+  end
+end
+
+describe BinData::Struct, "with multiple fields" do
+  before(:each) do
+    @params = { :fields => [ [:int8, :a], [:int8, :b] ] }
+    @obj = BinData::Struct.new(@params)
+    @obj.a = 1
+    @obj.b = 2
+  end
+
+  it "should return num_bytes" do
+    @obj.num_bytes(:a).should == 1
+    @obj.num_bytes(:b).should == 1
+    @obj.num_bytes.should     == 2
+  end
+
+  it "should clear individual elements" do
+    @obj.a = 6
+    @obj.b = 7
+    @obj.clear(:a)
+    @obj.should be_clear(:a)
+    @obj.should_not be_clear(:b)
+  end
+end

data/spec/float_spec.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.dirname(__FILE__)) + '/spec_common'
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_common"))
 require 'bindata/float'
 
 describe "A FloatLe" do

data/spec/int_spec.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.dirname(__FILE__)) + '/spec_common'
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_common"))
 require 'bindata'
 
 share_examples_for "All Integers" do

data/spec/io_spec.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.dirname(__FILE__)) + '/spec_common'
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_common"))
 require 'bindata/io'
 
 describe BinData::IO do

data/spec/lazy_spec.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.dirname(__FILE__)) + '/spec_common'
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_common"))
 require 'bindata/lazy'
 
 # A mock data object with customizable fields.

data/spec/primitive_spec.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.dirname(__FILE__)) + '/spec_common'
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_common"))
 require 'bindata'
 
 describe BinData::Primitive, "when subclassing" do
@@ -23,15 +23,6 @@ describe BinData::Primitive, "when subclassing" do
 end
 
 describe BinData::Primitive, "when defining" do
-  it "should allow inheriting from deprecated SingleValue" do
-    lambda {
-      eval <<-END
-        class SubclassSingleValue < BinData::SingleValue
-        end
-      END
-    }.should_not raise_error
-  end
-
   it "should fail on non registered types" do
     lambda {
       eval <<-END

data/spec/record_spec.rb

@@ -1,18 +1,9 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.dirname(__FILE__)) + '/spec_common'
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_common"))
 require 'bindata'
 
 describe BinData::Record, "when defining" do
-  it "should allow inheriting from deprecated MultiValue" do
-    lambda {
-      eval <<-END
-        class SubclassMultiValue < BinData::MultiValue
-        end
-      END
-    }.should_not raise_error
-  end
-
   it "should fail on non registered types" do
     lambda {
       eval <<-END
@@ -119,14 +110,14 @@ describe BinData::Record, "with multiple fields" do
   end
 
   it "should return num_bytes" do
-    @obj.num_bytes(:a).should == 1
-    @obj.num_bytes(:b).should == 1
+    @obj.a.num_bytes.should == 1
+    @obj.b.num_bytes.should == 1
     @obj.num_bytes.should     == 2
   end
 
   it "should identify accepted parameters" do
-    BinData::Record.accepted_internal_parameters.should include(:hide)
-    BinData::Record.accepted_internal_parameters.should include(:endian)
+    BinData::Record.accepted_parameters.all.should include(:hide)
+    BinData::Record.accepted_parameters.all.should include(:endian)
   end
 
   it "should clear" do
@@ -138,9 +129,9 @@ describe BinData::Record, "with multiple fields" do
   it "should clear individual elements" do
     @obj.a = 6
     @obj.b = 7
-    @obj.clear(:a)
-    @obj.should be_clear(:a)
-    @obj.should_not be_clear(:b)
+    @obj.a.clear
+    @obj.a.should be_clear
+    @obj.b.should_not be_clear
   end
 
   it "should write ordered" do

data/spec/registry_spec.rb

@@ -1,6 +1,8 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.dirname(__FILE__)) + '/spec_common'
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_common"))
+require 'bindata/bits'
+require 'bindata/int'
 require 'bindata/registry'
 
 describe BinData::Registry do
@@ -57,32 +59,50 @@ describe BinData::Registry do
   end
 
   it "should lookup integers with endian" do
-#    @r.register("Int24be", A)
-#    @r.register("Int24le", B)
-#    @r.register("Uint24be", C)
-#    @r.register("Uint24le", D)
-#
-#    @r.lookup("int24", :big).should == A
-#    @r.lookup("int24", :little).should == B
-#    @r.lookup("uint24", :big).should == C
-#    @r.lookup("uint24", :little).should == D
+    @r.register("Int24be", A)
+    @r.register("Int24le", B)
+    @r.register("Uint24be", C)
+    @r.register("Uint24le", D)
+
+    @r.lookup("int24", :big).should == A
+    @r.lookup("int24", :little).should == B
+    @r.lookup("uint24", :big).should == C
+    @r.lookup("uint24", :little).should == D
   end
 
   it "should not lookup integers without endian" do
-#    @r.register("Int24be", A)
+    @r.register("Int24be", A)
 
-#    @r.lookup("int24").should be_nil
+    @r.lookup("int24").should be_nil
   end
 
   it "should lookup floats with endian" do
-#    @r.register("FloatBe", A)
-#    @r.register("FloatLe", B)
-#    @r.register("DoubleBe", C)
-#    @r.register("DoubleLe", D)
-#
-#    @r.lookup("float", :big).should == A
-#    @r.lookup("float", :little).should == B
-#    @r.lookup("double", :big).should == C
-#    @r.lookup("double", :little).should == D
+    @r.register("FloatBe", A)
+    @r.register("FloatLe", B)
+    @r.register("DoubleBe", C)
+    @r.register("DoubleLe", D)
+
+    @r.lookup("float", :big).should == A
+    @r.lookup("float", :little).should == B
+    @r.lookup("double", :big).should == C
+    @r.lookup("double", :little).should == D
+  end
+
+  it "should automatically create classes for integers" do
+    BinData.const_defined?(:Uint40be).should be_false
+    @r.lookup("uint40be")
+    BinData.const_defined?(:Uint40be).should be_true
+  end
+
+  it "should automatically create classes for big endian bits" do
+    BinData.const_defined?(:Bit801).should be_false
+    @r.lookup("bit801")
+    BinData.const_defined?(:Bit801).should be_true
+  end
+
+  it "should automatically create classes for little endian bits" do
+    BinData.const_defined?(:Bit802le).should be_false
+    @r.lookup("bit802le")
+    BinData.const_defined?(:Bit802le).should be_true
   end
 end