jbangert-bindata 1.5.0

data/spec/registry_spec.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_common"))
+require 'bindata/bits'
+require 'bindata/int'
+require 'bindata/float'
+require 'bindata/registry'
+
+describe BinData::Registry do
+  A = Class.new
+  B = Class.new
+  C = Class.new
+  D = Class.new
+
+  let(:r) { BinData::Registry.new }
+
+  it "lookups registered names" do
+    r.register('ASubClass', A)
+    r.register('AnotherSubClass', B)
+
+    r.lookup('ASubClass').should == A
+    r.lookup('a_sub_class').should == A
+    r.lookup('AnotherSubClass').should == B
+    r.lookup('another_sub_class').should == B
+  end
+
+  it "does not lookup unregistered names" do
+    expect {
+      r.lookup('a_non_existent_sub_class')
+    }.to raise_error(BinData::UnRegisteredTypeError)
+  end
+
+  it "unregisters names" do
+    r.register('ASubClass', A)
+    r.unregister('ASubClass')
+
+    expect {
+      r.lookup('ASubClass')
+    }.to raise_error(BinData::UnRegisteredTypeError)
+  end
+
+  it "allows overriding of registered classes" do
+    r.register('A', A)
+    r.register('A', B)
+
+    r.lookup('a').should == B
+  end
+
+  it "converts CamelCase to underscores" do
+    r.underscore_name('CamelCase').should == 'camel_case'
+  end
+
+  it "converts adjacent caps camelCase to underscores" do
+    r.underscore_name('XYZCamelCase').should == 'xyz_camel_case'
+  end
+
+  it "ignores the outer nestings of classes" do
+    r.underscore_name('A::B::C').should == 'c'
+  end
+end
+
+describe BinData::Registry, "with numerics" do
+  let(:r) { BinData::RegisteredClasses }
+
+  it "lookup integers with endian" do
+    r.lookup("int24", :big).to_s.should == "BinData::Int24be"
+    r.lookup("int24", :little).to_s.should == "BinData::Int24le"
+    r.lookup("uint24", :big).to_s.should == "BinData::Uint24be"
+    r.lookup("uint24", :little).to_s.should == "BinData::Uint24le"
+  end
+
+  it "does not lookup integers without endian" do
+    expect {
+      r.lookup("int24")
+    }.to raise_error(BinData::UnRegisteredTypeError)
+  end
+
+  it "does not lookup non byte based integers" do
+    expect {
+      r.lookup("int3")
+    }.to raise_error(BinData::UnRegisteredTypeError)
+    expect {
+      r.lookup("int3", :big)
+    }.to raise_error(BinData::UnRegisteredTypeError)
+    expect {
+      r.lookup("int3", :little)
+    }.to raise_error(BinData::UnRegisteredTypeError)
+  end
+
+  it "lookup floats with endian" do
+    r.lookup("float", :big).to_s.should == "BinData::FloatBe"
+    r.lookup("float", :little).to_s.should == "BinData::FloatLe"
+    r.lookup("double", :big).to_s.should == "BinData::DoubleBe"
+    r.lookup("double", :little).to_s.should == "BinData::DoubleLe"
+  end
+
+  it "lookup bits" do
+    r.lookup("bit5").to_s.should == "BinData::Bit5"
+    r.lookup("bit6le").to_s.should == "BinData::Bit6le"
+  end
+
+  it "lookup bits by ignoring endian" do
+    r.lookup("bit2", :big).to_s.should == "BinData::Bit2"
+    r.lookup("bit3le", :big).to_s.should == "BinData::Bit3le"
+    r.lookup("bit2", :little).to_s.should == "BinData::Bit2"
+    r.lookup("bit3le", :little).to_s.should == "BinData::Bit3le"
+  end
+end

data/spec/rest_spec.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_common"))
+require 'bindata/rest'
+
+describe BinData::Rest do
+  it { should == "" }
+
+  it "reads till end of stream" do
+    data = "abcdefghij"
+    subject.read(data).should == data
+  end
+
+  it "allows setting value for completeness" do
+    subject.assign("123")
+    subject.should == "123"
+    subject.to_binary_s.should == "123"
+  end
+
+  it "accepts BinData::BasePrimitive parameters" do
+    rest = BinData::Rest.new(:check_value => "abc")
+    expect {
+      rest.read("xyz")
+    }.to raise_error(BinData::ValidityError)
+  end
+end

data/spec/skip_spec.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_common"))
+require 'bindata/skip'
+
+describe BinData::Skip do
+  subject { BinData::Skip.new(:length => 5) }
+  let(:io) { StringIO.new("abcdefghij") }
+
+  it { should == "" }
+  its(:to_binary_s) { should == "\000" * 5 }
+
+  it "skips bytes" do
+    subject.read(io)
+    io.pos.should == 5
+  end
+
+  it "has expected binary representation after setting value" do
+    subject.assign("123")
+    subject.to_binary_s.should == "\000" * 5
+  end
+
+  it "has expected binary representation after reading" do
+    subject.read(io)
+    subject.to_binary_s.should == "\000" * 5
+  end
+end

data/spec/spec_common.rb

@@ -0,0 +1,58 @@
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+
+require 'rspec'
+require 'rspec/autorun'
+require 'stringio'
+
+class Object
+  def expose_methods_for_testing
+    cls = (Class === self) ? self : (class << self ; self; end)
+    private_method_names = cls.private_instance_methods - Object.private_instance_methods
+    cls.send(:public, *private_method_names)
+
+    protected_method_names = cls.protected_instance_methods - Object.protected_instance_methods
+    cls.send(:public, *protected_method_names)
+  end
+
+  def value_read_from_written
+    self.class.read(self.to_binary_s)
+  end
+end
+
+class StringIO
+  # Returns the value that was written to the io
+  def value
+    rewind
+    read
+  end
+end
+
+def exception_line(ex)
+  idx = ex.backtrace.find_index { |bt| /:in `should'$/ =~ bt }
+
+  if idx
+    line_num_regex = /.*:(\d+)(:.*|$)/
+
+    err_line = line_num_regex.match(ex.backtrace[0])[1].to_i
+    ref_line = line_num_regex.match(ex.backtrace[idx + 1])[1].to_i
+
+    err_line - ref_line
+  else
+    raise "Required calling pattern is lambda { xxx }.should raise_error_on_line(...)"
+  end
+end
+
+def raise_error_on_line(exception, line, &block)
+  raise_exception(exception) do |err|
+    exception_line(err).should == line
+    block.call(err) if block_given?
+  end
+end
+
+def binary(str)
+  if str.respond_to?(:force_encoding)
+    str.dup.force_encoding(Encoding::BINARY)
+  else
+    str
+  end
+end

data/spec/string_spec.rb

@@ -0,0 +1,300 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_common"))
+require 'bindata/io'
+require 'bindata/string'
+
+describe BinData::String, "with mutually exclusive parameters" do
+  it ":value and :initial_value" do
+    params = {:value => "", :initial_value => ""}
+    expect { BinData::String.new(params) }.to raise_error(ArgumentError)
+  end
+
+  it ":length and :read_length" do
+    params = {:length => 5, :read_length => 5}
+    expect { BinData::String.new(params) }.to raise_error(ArgumentError)
+  end
+
+  it ":value and :length" do
+    params = {:value => "", :length => 5}
+    expect { BinData::String.new(params) }.to raise_error(ArgumentError)
+  end
+end
+
+describe BinData::String, "when assigning" do
+  let(:small) { BinData::String.new(:length => 3, :pad_byte => "A") }
+  let(:large) { BinData::String.new(:length => 5, :pad_byte => "B") }
+
+  it "copies data from small to large" do
+    large.assign(small)
+    large.should == "AAABB"
+  end
+
+  it "copies data from large to small" do
+    small.assign(large)
+    small.should == "BBB"
+  end
+end
+
+describe BinData::String do
+  subject { BinData::String.new("testing") }
+
+  it "compares with regexp" do
+    (/es/ =~ subject).should == 1
+  end
+
+  it "compares with regexp" do
+    (subject =~ /es/).should == 1
+  end
+end
+
+describe BinData::String, "with :read_length" do
+  subject { BinData::String.new(:read_length => 5) }
+
+  its(:num_bytes) { should == 0 }
+  its(:value) { should == "" }
+
+  it "reads :read_length bytes" do
+    subject.read("abcdefghij")
+    subject.should == "abcde"
+  end
+
+  it "remembers :read_length after value is cleared" do
+    subject.assign("abc")
+    subject.num_bytes.should == 3
+    subject.clear
+
+    subject.read("abcdefghij")
+    subject.should == "abcde"
+  end
+end
+
+describe BinData::String, "with :length" do
+  subject { BinData::String.new(:length => 5) }
+
+  its(:num_bytes) { should == 5 }
+  its(:value) { should == "\0\0\0\0\0" }
+
+  it "retains :length after value is set" do
+    subject.assign("abcdefghij")
+    subject.num_bytes.should == 5
+  end
+
+  it "reads :length bytes" do
+    subject.read("abcdefghij")
+    subject.should == "abcde"
+  end
+
+  it "pads values less than :length" do
+    subject.assign("abc")
+    subject.should == "abc\0\0"
+  end
+
+  it "accepts values exactly :length" do
+    subject.assign("abcde")
+    subject.should == "abcde"
+  end
+
+  it "truncates values greater than :length" do
+    subject.assign("abcdefghij")
+    subject.should == "abcde"
+  end
+end
+
+describe BinData::String, "with :read_length and :initial_value" do
+  subject { BinData::String.new(:read_length => 5, :initial_value => "abcdefghij") }
+
+  its(:num_bytes) { should == 10 }
+  its(:value) { should == "abcdefghij" }
+
+  it "uses :read_length for reading" do
+    io = StringIO.new("ABCDEFGHIJKLMNOPQRST")
+    subject.read(io)
+    io.pos.should == 5
+   end
+
+  it "forgets :initial_value after reading" do
+    subject.read("ABCDEFGHIJKLMNOPQRST")
+    subject.num_bytes.should == 5
+    subject.should == "ABCDE"
+  end
+end
+
+describe BinData::String, "with :read_length and :value" do
+  subject { BinData::String.new(:read_length => 5, :value => "abcdefghij") }
+
+  its(:num_bytes) { should == 10 }
+  its(:value) { should == "abcdefghij" }
+
+  it "uses :read_length for reading" do
+    io = StringIO.new("ABCDEFGHIJKLMNOPQRST")
+    subject.read(io)
+    io.pos.should == 5
+  end
+
+  context "after reading" do
+    before(:each) do
+      subject.read("ABCDEFGHIJKLMNOPQRST")
+    end
+
+    it "is not affected by :read_length after reading" do
+      subject.num_bytes.should == 10
+      subject.should == "abcdefghij"
+    end
+
+    it "returns read value while reading" do
+      subject.stub(:reading?).and_return(true)
+      subject.should == "ABCDE"
+    end
+  end
+end
+
+describe BinData::String, "with :length and :initial_value" do
+  subject { BinData::String.new(:length => 5, :initial_value => "abcdefghij") }
+
+  its(:num_bytes) { should == 5 }
+  its(:value) { should == "abcde" }
+
+  it "forgets :initial_value after reading" do
+    io = StringIO.new("ABCDEFGHIJKLMNOPQRST")
+    subject.read(io)
+    io.pos.should == 5
+    subject.num_bytes.should == 5
+    subject.should == "ABCDE"
+  end
+end
+
+describe BinData::String, "with :pad_byte" do
+  it "accepts a numeric value for :pad_byte" do
+    str = BinData::String.new(:length => 5, :pad_byte => 6)
+    str.assign("abc")
+    str.should == "abc\x06\x06"
+  end
+
+  it "accepts a character for :pad_byte" do
+    str = BinData::String.new(:length => 5, :pad_byte => "R")
+    str.assign("abc")
+    str.should == "abcRR"
+  end
+
+  it "does not accept a string for :pad_byte" do
+    params = {:length => 5, :pad_byte => "RR"}
+    lambda { BinData::String.new(params) }.should raise_error(ArgumentError)
+  end
+end
+
+describe BinData::String, "with :trim_padding" do
+  it "set false is the default" do
+    str1 = BinData::String.new(:length => 5)
+    str2 = BinData::String.new(:length => 5, :trim_padding => false)
+    str1.assign("abc")
+    str2.assign("abc")
+    str1.should == "abc\0\0"
+    str2.should == "abc\0\0"
+  end
+
+  context "trim padding set" do
+    subject { BinData::String.new(:pad_byte => 'R', :trim_padding => true) }
+
+    it "trims the value" do
+      subject.assign("abcRR")
+      subject.should == "abc"
+    end
+
+    it "does not affect num_bytes" do
+      subject.assign("abcRR")
+      subject.num_bytes.should == 5
+    end
+
+    it "trims if last char is :pad_byte" do
+      subject.assign("abcRR")
+      subject.should == "abc"
+    end
+
+    it "does not trim if value contains :pad_byte not at the end" do
+      subject.assign("abcRRde")
+      subject.should == "abcRRde"
+    end
+  end
+end
+
+describe BinData::String, "with :pad_front" do
+  it "set false is the default" do
+    str1 = BinData::String.new(:length => 5)
+    str2 = BinData::String.new(:length => 5, :pad_front => false)
+    str1.assign("abc")
+    str2.assign("abc")
+    str1.should == "abc\0\0"
+    str2.should == "abc\0\0"
+  end
+
+  it "pads to the front" do
+    str = BinData::String.new(:length => 5, :pad_byte => 'R', :pad_front => true)
+    str.assign("abc")
+    str.should == "RRabc"
+  end
+
+  it "can alternatively be accesses by :pad_left" do
+    str = BinData::String.new(:length => 5, :pad_byte => 'R', :pad_left => true)
+    str.assign("abc")
+    str.should == "RRabc"
+  end
+
+  context "and :trim_padding" do
+    subject { BinData::String.new(:length => 5, :pad_byte => 'R', :pad_front => true, :trim_padding => true) }
+
+    it "assigns" do
+      subject.assign("abc")
+      subject.should == "abc"
+    end
+
+    it "has to_binary_s" do
+      subject.assign("abc")
+      subject.to_binary_s.should == "RRabc"
+    end
+
+    it "reads" do
+      subject.read "RRabc"
+      subject.should == "abc"
+    end
+  end
+end
+
+describe BinData::String, "with Ruby 1.9 encodings" do
+  if RUBY_VERSION >= "1.9"
+    class UTF8String < BinData::String
+      def snapshot
+        super.force_encoding('UTF-8')
+      end
+    end
+
+    subject { UTF8String.new }
+    let(:binary_str) { binary("\xC3\x85\xC3\x84\xC3\x96") }
+    let(:utf8_str) { binary_str.dup.force_encoding('UTF-8') }
+
+    it "stores assigned values as binary" do
+      subject.assign(utf8_str)
+      subject.to_binary_s.should == binary_str
+    end
+
+    it "stores read values as binary" do
+      subject = UTF8String.new(:read_length => binary_str.length)
+      subject.read(binary_str)
+
+      subject.to_binary_s.should == binary_str
+    end
+
+    it "returns values in correct encoding" do
+      subject.assign(utf8_str)
+
+      subject.snapshot.should == utf8_str
+    end
+
+    it "has correct num_bytes" do
+      subject.assign(utf8_str)
+
+      subject.num_bytes.should == binary_str.length
+    end
+  end
+end
+