julik-depix 1.0.2

data/test/test_dict.rb

@@ -0,0 +1,686 @@
+require File.dirname(__FILE__) + '/../lib/depix/dict'
+require 'test/unit'
+
+include Depix
+
+module FieldConformity
+  def conform_field!(f)
+    assert_respond_to f, :name
+    assert_respond_to f, :length
+    assert_respond_to f, :pattern
+    assert_respond_to f, :req
+    assert_respond_to f, :req?
+    assert_respond_to f, :rtype
+    assert_respond_to f, :explain
+  end
+  
+  def assert_method_removed(f, method)
+    fail("#{f.inspect} should not respond to #{method}") if f.respond_to?(method)
+  end
+end
+
+class FieldExplainsItself < Test::Unit::TestCase
+  def test_explain
+    f = Field.new :rtype => self.class, :desc => "Eats people"
+    assert_equal "(FieldExplainsItself) Eats people", f.explain
+  end 
+  
+  def test_explain_with_verbatim
+    f = Field.new :desc => "Eats people"
+    assert_equal "Eats people", f.explain
+  end
+
+  def test_explain_with_verbatim_and_required
+    f = Field.new :desc => "Eats people", :req => true
+    assert_equal "Eats people - required", f.explain
+  end
+
+  def test_explain_with_no_data
+    f = Field.new
+    assert_equal "", f.explain
+  end
+  
+  def test_explaion_for_empty_array
+    f = ArrayField.new
+    assert_equal "Empty array", f.explain
+  end
+  
+  def test_explain_for_array_with_members
+    f = ArrayField.new :members => [U8Field.new, U8Field.new], :desc => "Eats babies"
+    assert_equal "(Array of 2 Integer fields) Eats babies", f.explain
+  end
+
+  def test_explain_for_nested_struct
+    f = InnerField.new :cast => self.class, :desc => "Link to test case"
+    assert_equal "(FieldExplainsItself) Link to test case", f.explain
+  end
+
+end
+
+class TestField < Test::Unit::TestCase
+  include FieldConformity
+  
+  def test_field_responds_to_all_meths
+    f = Field.new
+    conform_field!(f)
+    
+    assert_respond_to f, :name=
+    assert_respond_to f, :length=
+    assert_respond_to f, :pattern=
+    assert_respond_to f, :req=
+  end
+  
+  def test_field_supports_hash_initialization
+    f = Field.new :name => "foo", :length => 3, :pattern => "C3"
+    assert_equal ["foo", 3, "C3"], [f.name, f.length, f.pattern]
+  end
+  
+  def test_req?
+    f = Field.new :name => "foo"
+    assert !f.req?
+
+    f = Field.new :name => "foo", :req => false
+    assert !f.req?
+
+    f = Field.new :name => "foo", :req => true
+    assert f.req?
+  end
+  
+  def test_consume_for_field
+    f = Field.new :name => "foo"
+    
+    assert_respond_to f, :consume!
+    assert_nil f.consume!([])
+    assert_equal 1, f.consume!([1])
+    assert_equal 2, f.consume!([2,"foo"])
+
+    ar = [1,2,3]
+    f.consume!(ar)
+    assert_equal [2,3], ar
+  end 
+  
+  def test_consume_for_inner_field
+    catcher = Class.new do
+      def self.consume!(arg)
+        raise RuntimeError if arg == ["julik"]
+      end
+    end
+    
+    f = InnerField.new :cast => catcher
+    assert_respond_to f, :consume!
+    
+    assert_raise(RuntimeError) { f.consume!(["julik"]) }
+  end
+  
+  def test_consume_for_array
+    f = ArrayField.new :members => [Field.new, Field.new]
+    assert_respond_to f, :consume!
+    
+    assert_equal [1,2], f.consume!([1,2])
+  end
+end
+
+class TestArrayField < Test::Unit::TestCase
+  include FieldConformity
+  
+  def test_array_field_conform_field!s_to_field_and_has_extra_methods
+    f = ArrayField.new
+    conform_field!(f)
+    
+    assert_respond_to f, :name=
+    
+    assert_method_removed f, :length=
+    assert_method_removed f, :pattern=
+  end
+  
+  def test_array_does_not_allow_setting_length
+    f = ArrayField.new
+    assert_method_removed(f, :length=)
+    assert_method_removed(f, :pattern=)
+  end
+  
+  def test_array_field_has_members
+    f = ArrayField.new
+    assert_respond_to f, :members
+    assert_respond_to f, :members=
+  end
+  
+  def test_rtype_for_array_field_is_array
+    casted = ArrayField.new(:members => [])
+    assert_equal Array, casted.rtype
+  end
+  
+  def test_array_field_accumulates_lengths_and_patterns_from_members
+    f = ArrayField.new(:members => [
+      Field.new(:name => :foo, :length => 1, :pattern => "C"),
+      Field.new(:name => :bar, :length => 2, :pattern => "C2"),
+    ])
+    
+    assert_equal 3, f.length
+    assert_equal "CC2", f.pattern
+  end
+end
+
+class TestInnerField < Test::Unit::TestCase
+
+  include FieldConformity
+  
+  def test_inner_field_conforms_to_field_and_has_extra_methods
+    f = InnerField.new
+    conform_field!(f)
+        
+    assert_respond_to f, :cast
+    assert_respond_to f, :cast=
+    
+    assert_method_removed(f, :length=)
+    assert_method_removed(f, :pattern=)
+  end
+  
+  def test_inner_field_asks_cast_for_pattern_and_length
+    sample = Struct.new(:length, :pattern).new
+    sample.length, sample.pattern = 123, "C123"
+    
+    casted = InnerField.new(:cast => sample)
+    assert_equal 123, casted.length
+    assert_equal 'C123', casted.pattern
+    
+    assert_method_removed(casted, :length=)
+    assert_method_removed(casted, :pattern=)
+    
+  end
+  
+  def test_rtype_for_inner_field_is_cast
+    c = Class.new
+    casted = InnerField.new(:cast => c)
+    assert_equal c, casted.rtype
+  end
+end
+
+class TestWideIntField < Test::Unit::TestCase
+  include FieldConformity
+  
+  def test_u32_field_contorms_to_basics
+    f = U32Field.new :name  => :foo
+    conform_field!(f)
+    
+    assert_equal "N", f.pattern
+    assert_equal 4, f.length
+    assert_equal :foo, f.name
+    assert_equal 66, f.clean(66)
+    assert_equal nil, f.clean(0xFFFFFFFF)
+  end
+end
+
+class TestCharField < Test::Unit::TestCase
+  include FieldConformity
+  
+  def test_char_field_conforms_to_basics
+    f = CharField.new :name  => :foo
+    conform_field!(f)
+    assert_method_removed(f, :pattern=)
+  end
+  
+  def test_char_field_pads
+    f = CharField.new :name => :foo, :length => 15
+    
+    assert_equal "A15", f.pattern
+    assert_equal 15, f.length
+    assert_equal String, f.rtype
+  end
+  
+  def test_char_field_does_not_clean_inner_nulls
+    f = CharField.new :name => :foo, :length => 15
+    assert_equal "foo\0foo", f.clean("\0\0foo\0foo\0")
+    assert_equal "swoop\377\0bla", f.clean("\0\0\0\377\377swoop\377\0bla\0\0\0\377\377\377\377\0\0\0")
+  end
+  
+  def test_char_field_clean_blank
+    f = CharField.new :name => :foo, :length => 15
+    assert_equal nil, f.clean("\0")
+    assert_equal nil, f.clean("\0\0\0\0\0\0")
+    assert_equal nil, f.clean("\0\0\0\377\377\0\0\0")
+    assert_equal "foo\0foo", f.clean("\0\0foo\0foo\0")
+
+  end
+end
+
+class TestFloatField < Test::Unit::TestCase
+  include FieldConformity
+  
+  def test_r32_field_contorms_to_basics
+    f = R32Field.new :name  => :foo
+    conform_field!(f)
+    
+    the_nan = Class.new do
+      def nan?; true; end
+    end.new
+    
+    assert_equal "g", f.pattern
+    assert_equal 4, f.length
+    assert_equal :foo, f.name
+    assert_equal Float, f.rtype
+    assert_equal nil, f.clean(the_nan)
+  end
+end
+
+class TestSmallintField < Test::Unit::TestCase
+  include FieldConformity
+  
+  def test_smallint_conformity
+    f = U8Field.new :name => :foo
+    conform_field!(f)
+    
+    assert_method_removed(f, :pattern=)
+    assert_method_removed(f, :length=)
+    
+  end
+  
+  def test_smallint_operation
+    f = U8Field.new
+    
+    assert_equal 'c', f.pattern
+    assert_equal 1, f.length
+    assert_equal Integer, f.rtype
+  end
+  
+  def test_smallint_clean
+    f = U8Field.new
+    
+    assert_equal nil, f.clean(0xFF)
+    assert_equal 10, f.clean(10)
+  end
+  
+end
+
+class TestDoubleField < Test::Unit::TestCase
+  include FieldConformity
+  
+  def test_double_conformity
+    f = U16Field.new :name => :foo
+    conform_field!(f)
+
+    assert_method_removed(f, :pattern=)
+    assert_method_removed(f, :length=)
+  end
+  
+  def test_double_operation
+    f = U16Field.new
+    
+    assert_equal 'n', f.pattern
+    assert_equal 2, f.length
+    assert_equal Integer, f.rtype
+  end
+  
+  def test_double_clean
+    f = U16Field.new
+    
+    assert_equal nil, f.clean(0xFFFF)
+    assert_equal 10, f.clean(10)
+  end
+end
+
+class TestFillerField < Test::Unit::TestCase
+  include FieldConformity
+  
+  def test_field_conformity
+    f = Filler.new
+    conform_field!(f)
+    assert_equal "x1", f.pattern
+  end
+  
+  def test_filler_does_not_allow_setting_pattern
+    assert_method_removed(Filler.new, :pattern=)
+  end
+  
+  def test_pattern_discards_value
+    data = [1,2,3].pack("ccc")
+    filler = Filler.new(:length => 3)
+    unpacked = data.unpack(filler.pattern)
+    assert_equal [], unpacked
+  end
+
+  def test_consume_does_not_touch_stack
+    data = [1,2,3]
+    data.freeze
+    assert_nothing_raised { Filler.new(:length => 1).consume(data) }
+  end
+
+end
+
+class TestFieldEmit < Test::Unit::TestCase
+  include FieldConformity
+  
+  def test_emit_short
+    f = Field.emit_u8
+    conform_field!(f)
+    
+    f = Field.emit_u8(:desc => "Dick length")
+    conform_field!(f)
+    assert_equal "c", f.pattern
+    assert_equal 1, f.length
+  end
+
+  def test_emit_double
+    f = Field.emit_u16
+    conform_field!(f)
+    
+    f = Field.emit_u16(:desc => "Dick length")
+    conform_field!(f)
+    assert_equal "n", f.pattern
+    assert_equal 2, f.length
+  end
+
+  def test_emit_char
+    f = Field.emit_char
+    conform_field!(f)
+    
+    assert_equal "A1", f.pattern
+    assert_equal 1, f.length
+
+    f = Field.emit_char :length => 3
+    conform_field!(f)
+    
+    assert_equal "A3", f.pattern
+    assert_equal 3, f.length
+  end
+  
+  def test_emit_float
+    f = Field.emit_r32
+    conform_field!(f)
+    
+    assert_equal "g", f.pattern
+    assert_equal 4, f.length
+  end
+end
+
+class TestDict < Test::Unit::TestCase
+  
+  def test_dict_has_a_fields_array
+    dict_class = Class.new(Dict)
+    assert_respond_to dict_class, :fields
+    assert_equal [], dict_class.fields
+  end
+  
+  def test_dict_fields_array_not_class_shared
+    d1, d2 = (0..1).map{|_| Class.new(Dict) }
+    
+    d1.fields << 1
+    d2.fields << 2
+    assert_not_equal d1.fields, d2.fields
+  end
+  
+  def test_dict_responds_to_emit_methods_from_fields
+    c = Class.new(Dict)
+
+    emitter_methods = Field.methods.grep(/^emit_/)
+    emitter_methods.each do | m |
+      assert_respond_to c, m.gsub(/^emit_/, '')
+    end
+  end
+  
+  def test_empty_dict_has_empty_template
+    c = Class.new(Dict)
+    assert_respond_to c, :pattern
+    assert_equal '', c.pattern
+    assert_equal 0, c.length
+  end
+
+  def test_dict_assembles_template
+    c = Class.new(Dict)
+    c.fields << Field.emit_char
+    c.fields << Field.emit_char
+    
+    assert_respond_to c, :pattern
+    assert_equal 'A1A1', c.pattern
+    assert_equal 2, c.length
+  end
+  
+end
+
+class TestDictConsume < Test::Unit::TestCase
+  def test_dict_consume
+    c = Class.new(Dict)
+    c.char :foo
+    c.char :bar
+    
+    result = c.consume!(["a", "b"])
+    assert_kind_of c, result
+    
+    assert_equal "a", result.foo
+    assert_equal "b", result.bar
+  end
+end
+
+class TestDictEmitDSL < Test::Unit::TestCase
+
+  def test_dict_emit_char
+    c = Class.new(Dict)
+    c.char :tag, :desc => "Some name"
+    
+    assert c.instance_methods.include?("tag")
+    
+    assert_equal 1, c.fields.length
+    field = c.fields[0]
+
+    assert_equal 1, field.length
+    assert_equal "A1", field.pattern
+    assert_equal :tag, field.name
+  end
+  
+  def test_dict_emit_char_with_length
+    c = Class.new(Dict)
+    c.char :joe, 3, :desc => "Some name"
+
+    assert c.instance_methods.include?("joe")
+    
+    assert_equal 1, c.fields.length
+    field = c.fields[0]
+    assert_equal 3, field.length
+    assert_equal "A3", field.pattern
+    assert_equal :joe, field.name
+  end
+  
+  def test_dict_emit_u32
+    c = Class.new(Dict)
+    c.u32 :num, :desc => "Huge number"
+
+    assert c.instance_methods.include?("num")
+    
+    assert_equal 1, c.fields.length
+    field = c.fields[0]
+    assert_equal 4, field.length
+    assert_equal "N", field.pattern
+    assert_equal :num, field.name
+  end
+  
+  def test_dict_emit_r32
+    c = Class.new(Dict)
+    c.r32 :joe, :req => true
+
+    assert c.instance_methods.include?("joe")
+    
+    assert_equal 1, c.fields.length
+    field = c.fields[0]
+    assert_equal 4, field.length
+    assert_equal "g", field.pattern
+    assert_equal true, field.req?
+  end
+  
+  def test_dict_emit_u8
+    c = Class.new(Dict)
+    c.u8 :joe, :req => true
+
+    assert c.instance_methods.include?("joe")
+    
+    assert_equal 1, c.fields.length
+
+    field = c.fields[0]
+    assert_equal 1, field.length
+    assert_equal "c", field.pattern
+    assert_equal true, field.req?
+  end
+  
+  def test_dict_emit_u16
+    c = Class.new(Dict)
+    c.u16 :joe, :req => true, :desc => "A little bit of numbers"
+    
+    assert c.instance_methods.include?("joe")
+    
+    assert_equal 1, c.fields.length
+
+    field = c.fields[0]
+    
+    assert_equal 2, field.length
+    assert_equal "n", field.pattern
+    assert_equal "A little bit of numbers", field.desc
+  end
+  
+  def test_dict_emit_array
+    c = Class.new(Dict)
+    c.array :point, :u32, :desc => "Two coordinates"
+    
+    assert c.instance_methods.include?("point")
+
+    assert_equal 1, c.fields.length
+    field = c.fields[0]
+    
+    assert_kind_of ArrayField, field
+    assert_equal "Two coordinates", field.desc
+    assert_equal 1, field.members.length
+    assert_equal U32Field, field.members[0].class
+  end
+  
+  def test_dict_emit_inner
+    c = Class.new(Dict)
+    c2 = Class.new(Dict)
+    
+    c.inner :nest, c2, :desc => "Nested struct"
+    
+    assert c.instance_methods.include?("nest")
+    
+    assert_equal 1, c.fields.length
+    f = c.fields[0]
+    
+    assert_kind_of InnerField, f
+    assert_equal "Nested struct", f.desc
+    assert_equal c2, f.cast
+  end
+  
+  def test_dict_emit_array_of_substructs
+    c = Class.new(Dict)
+    c2 = Class.new(Dict)
+    
+    c2.u32 :some_num
+    c.array :inners, c2, 8, :desc => "Inner items"
+    
+    assert c.instance_methods.include?("inners")
+    
+    assert_equal 1, c.fields.length
+    f = c.fields[0]
+    
+    assert_kind_of ArrayField, f
+    assert_equal "Inner items", f.desc
+    
+    assert_equal 8, f.members.length, "8 inner members should be there"
+    
+    mem = f.members[0]
+    assert_equal c2, mem.cast
+  end
+end
+
+class TestDictCompact < Test::Unit::TestCase
+  def test_only_with_interspersed_fields
+    c = Class.new(Dict) do
+      u8 :some
+      u8 :another
+      u8 :third
+    end
+    
+    distill = c.only(:another)
+
+    assert_equal distill.length, c.length, "The distilled struct should occupy the same space"
+
+    assert distill.ancestors.include?(c)
+    assert_equal 3, distill.fields.length
+    
+    assert_kind_of Filler, distill.fields[0]
+    assert_equal 1, distill.fields[0].length
+    
+    assert_kind_of U8Field, distill.fields[1]
+    assert_equal 1, distill.fields[0].length
+
+    assert_kind_of Filler, distill.fields[2]
+    assert_equal 1, distill.fields[2].length
+    
+  end
+  
+  def test_only_with_fields_in_a_row
+    c = Class.new(Dict) do
+      u8   :some
+      u32  :another
+      u8   :third
+      u32  :fourth
+      char :fifth, 10
+    end
+    
+    distill = c.only(:third)
+    assert_equal distill.length, c.length, "The distilled struct should occupy the same space"
+    assert_equal 3, distill.fields.length
+    
+    result = distill.apply!("abcdefhjhjkujkdkklsalierioeiore")
+    
+    assert_kind_of Filler, distill.fields[0]
+    assert_equal 5, distill.fields[0].length
+
+    assert_kind_of Filler, distill.fields[2]
+    assert_equal 14, distill.fields[2].length
+    
+    assert_nil result.some
+    assert_nil result.fourth
+  end
+  
+  def test_get_filler
+    c = Class.new(Dict) do
+      u32 :some
+    end
+    
+    filler = c.filler
+    assert_equal filler.length, c.length
+    assert_equal 1, c.fields.length
+  end
+  
+  def test_filler_parses_the_same
+    c = Class.new(Dict) do
+      u8 :first
+      u8 :second
+      u8 :third
+    end
+    
+    distill = c.only(:second)
+    
+    data = [1,2,3].pack("ccc")
+    
+    base_r = c.apply!(data)
+    assert_not_nil  base_r.first
+    assert_not_nil  base_r.third
+    assert_equal 2, base_r.second
+    
+    r = distill.apply!(data)
+    assert_nil r.first
+    assert_nil r.third
+    assert_equal 2, r.second
+  end
+end
+
+class TestDictApply < Test::Unit::TestCase
+  def test_apply
+    struct = Class.new(Dict) do
+      char :name, "julik".length
+      char :module, "depix".length
+    end
+    
+    result = struct.apply!("julikdepix")
+    assert_equal "julik", result.name
+    assert_equal "depix", result.module
+  end
+end