bindata 1.2.1 → 1.2.2

data/spec/base_primitive_spec.rb

@@ -5,13 +5,6 @@ require File.expand_path(File.join(File.dirname(__FILE__), "example"))
 require 'bindata/base_primitive'
 require 'bindata/io'
 
-class ExampleSingle
-  # reopen example to make @in_read public for testing
-  def in_read?
-    @in_read
-  end
-end
-
 describe BinData::BasePrimitive, "when subclassing" do
   class SubClassOfBasePrimitive < BinData::BasePrimitive
     expose_methods_for_testing
@@ -31,16 +24,15 @@ end
 describe BinData::BasePrimitive do
   it "should conform to rule 1 for returning a value" do
     data = ExampleSingle.new(:value => 5)
-    data.should_not be_in_read
     data.value.should == 5
   end
 
   it "should conform to rule 2 for returning a value" do
     io = ExampleSingle.io_with_value(42)
     data = ExampleSingle.new(:value => 5)
-    data.expose_methods_for_testing
-    data.do_read(io)
-    data.should be_in_read
+    data.read(io)
+
+    def data.reading?; true; end
     data.value.should == 42
   end
 
@@ -210,7 +202,6 @@ end
 describe BinData::BasePrimitive, "with :value" do
   before(:each) do
     @data = ExampleSingle.new(:value => 5)
-    @data.expose_methods_for_testing
   end
 
   it "should return that :value" do
@@ -219,9 +210,10 @@ describe BinData::BasePrimitive, "with :value" do
 
   it "should change during reading" do
     io = ExampleSingle.io_with_value(56)
-    @data.do_read(io)
+    @data.read(io)
+
+    def @data.reading?; true; end
     @data.value.should == 56
-    @data.done_read
   end
 
   it "should not change after reading" do

data/spec/base_spec.rb

@@ -7,26 +7,22 @@ class BaseStub < BinData::Base
   # Override to avoid NotImplemented errors
   def clear; end
   def clear?; end
-  def _do_read(io) end
-  def _done_read; end
-  def _do_write(io) end
-  def _do_num_bytes; end
-  def _assign(x); end
-  def _snapshot; end
-
-  expose_methods_for_testing
+  def assign(x); end
+  def snapshot; end
+  def do_read(io) end
+  def do_write(io) end
+  def do_num_bytes; end
 end
 
 class MockBaseStub < BaseStub
   attr_accessor :mock
   def clear;           mock.clear; end
   def clear?;          mock.clear?; end
-  def _do_read(io)     mock._do_read(io); end
-  def _done_read;      mock._done_read; end
-  def _do_write(io)    mock._do_write(io); end
-  def _do_num_bytes;   mock._do_num_bytes; end
-  def _assign(x);      mock._assign(x); end
-  def _snapshot;       mock._snapshot; end
+  def assign(x);       mock.assign(x); end
+  def snapshot;        mock.snapshot; end
+  def do_read(io)      mock.do_read(io); end
+  def do_write(io)     mock.do_write(io); end
+  def do_num_bytes;    mock.do_num_bytes; end
 end
 
 describe BinData::Base, "when subclassing" do
@@ -42,11 +38,10 @@ describe BinData::Base, "when subclassing" do
     lambda { @obj.clear }.should raise_error(NotImplementedError)
     lambda { @obj.clear? }.should raise_error(NotImplementedError)
     lambda { @obj.assign(nil) }.should raise_error(NotImplementedError)
-    lambda { @obj._do_read(nil) }.should raise_error(NotImplementedError)
-    lambda { @obj._done_read }.should raise_error(NotImplementedError)
-    lambda { @obj._do_write(nil) }.should raise_error(NotImplementedError)
-    lambda { @obj._do_num_bytes }.should raise_error(NotImplementedError)
-    lambda { @obj._snapshot }.should raise_error(NotImplementedError)
+    lambda { @obj.snapshot }.should raise_error(NotImplementedError)
+    lambda { @obj.do_read(nil) }.should raise_error(NotImplementedError)
+    lambda { @obj.do_write(nil) }.should raise_error(NotImplementedError)
+    lambda { @obj.do_num_bytes }.should raise_error(NotImplementedError)
   end
 end
 
@@ -176,10 +171,14 @@ end
 
 describe BinData::Base, "with :check_offset" do
   class TenByteOffsetBase < BaseStub
+    def initialize(params = {})
+      super({})
+      @child = BaseStub.new(params, self)
+    end
+
     def do_read(io)
-      # advance the io position before checking offset
       io.seekbytes(10)
-      super(io)
+      @child.do_read(io)
     end
   end
 
@@ -214,10 +213,14 @@ end
 
 describe BinData::Base, "with :adjust_offset" do
   class TenByteAdjustingOffsetBase < BaseStub
+    def initialize(params = {})
+      super({})
+      @child = BaseStub.new(params, self)
+    end
+
     def do_read(io)
-      # advance the io position before checking offset
       io.seekbytes(10)
-      super(io)
+      @child.do_read(io)
     end
   end
 
@@ -252,6 +255,10 @@ describe BinData::Base, "with :adjust_offset" do
 end
 
 describe BinData::Base, "as black box" do
+  it "should return bindata_name" do
+    BaseStub.bindata_name.should == "base_stub"
+  end
+
   it "should access parent" do
     parent = BaseStub.new
     child = BaseStub.new(nil, parent)
@@ -305,7 +312,7 @@ describe BinData::Base, "as black box" do
 
   it "should write the same as to_binary_s" do
     class WriteToSBase < BaseStub
-      def _do_write(io) io.writebytes("abc"); end
+      def do_write(io) io.writebytes("abc"); end
     end
 
     obj = WriteToSBase.new
@@ -321,30 +328,24 @@ describe BinData::Base, "as white box" do
     @obj.mock = mock('mock')
   end
 
-  it "should forward read to _do_read" do
+  it "should forward read to do_read" do
     @obj.mock.should_receive(:clear).ordered
-    @obj.mock.should_receive(:_do_read).ordered
-    @obj.mock.should_receive(:_done_read).ordered
+    @obj.mock.should_receive(:do_read).ordered
     @obj.read(nil)
   end
 
-  it "should forward write to _do_write" do
-    @obj.mock.should_receive(:_do_write)
+  it "should forward write to do_write" do
+    @obj.mock.should_receive(:do_write)
     @obj.write(nil)
   end
 
-  it "should forward num_bytes to _do_num_bytes" do
-    @obj.mock.should_receive(:_do_num_bytes).and_return(42)
+  it "should forward num_bytes to do_num_bytes" do
+    @obj.mock.should_receive(:do_num_bytes).and_return(42)
     @obj.num_bytes.should == 42
   end
 
   it "should round up fractional num_bytes" do
-    @obj.mock.should_receive(:_do_num_bytes).and_return(42.1)
+    @obj.mock.should_receive(:do_num_bytes).and_return(42.1)
     @obj.num_bytes.should == 43
   end
-
-  it "should forward snapshot to _snapshot" do
-    @obj.mock.should_receive(:_snapshot).and_return("abc")
-    @obj.snapshot.should == "abc"
-  end
 end

data/spec/deprecated_spec.rb

@@ -52,3 +52,39 @@ describe BinData::Base, "when defining" do
     }.should_not raise_error
   end
 end
+
+describe BinData::Base do
+  class DeprecatedBase < BinData::Base
+  end
+
+  before(:each) do
+    @obj = DeprecatedBase.new
+    @io = "abcde"
+  end
+
+  it "should forward _do_read to do_read" do
+    @obj.should_receive(:do_read).with(@io)
+    @obj._do_read(@io)
+  end
+
+  it "should forward _do_write to do_write" do
+    @obj.should_receive(:do_write).with(@io)
+    @obj._do_write(@io)
+  end
+
+  it "should forward _do_num_bytes to do_num_bytes" do
+    @obj.should_receive(:do_num_bytes)
+    @obj._do_num_bytes
+  end
+
+  it "should forward _assign to assign" do
+    val = 3
+    @obj.should_receive(:assign).with(val)
+    @obj._assign(val)
+  end
+
+  it "should forward _snapshot to snapshot" do
+    @obj.should_receive(:snapshot)
+    @obj._snapshot
+  end
+end

data/spec/primitive_spec.rb

@@ -103,6 +103,15 @@ describe BinData::Primitive do
       @obj.does_not_exist
     }.should raise_error(NoMethodError)
   end
+
+  it "should use read value whilst reading" do
+    obj = PrimitiveWithEndian.new(:value => 2)
+    obj.read "\x05\x00"
+    obj.value.should == 2
+
+    def obj.reading?; true; end
+    obj.value.should == 5
+  end
 end
 
 describe BinData::Primitive, "requiring custom parameters" do

data/spec/record_spec.rb

@@ -49,6 +49,17 @@ describe BinData::Record, "when defining with errors" do
     }
   end
 
+  it "should fail on malformed names" do
+    lambda {
+      class MalformedNameRecord < BinData::Record
+        int8 :a
+        int8 45
+      end
+    }.should raise_error_on_line(NameError, 3) { |err|
+      err.message.should == "field '45' is an illegal fieldname in #{MalformedNameRecord}"
+    }
+  end
+
   it "should fail on duplicate names" do
     lambda {
       class DuplicateNameRecord < BinData::Record

data/spec/string_spec.rb

@@ -128,7 +128,6 @@ end
 describe BinData::String, "with :read_length and :value" do
   before(:each) do
     @str = BinData::String.new(:read_length => 5, :value => "abcdefghij")
-    @str.expose_methods_for_testing
   end
 
   it "should not be affected by :read_length before value is read" do
@@ -148,12 +147,12 @@ describe BinData::String, "with :read_length and :value" do
     @str.value.should == "abcdefghij"
   end
 
-  it "should return read value before calling done_read" do
-    @str.do_read(BinData::IO.new("ABCDEFGHIJKLMNOPQRST"))
-    @str.value.should == "ABCDE"
+  it "should return read value while reading" do
+    @str.read("ABCDEFGHIJKLMNOPQRST")
 
-    @str.done_read
-    @str.value.should == "abcdefghij"
+    def @str.reading?; true; end
+
+    @str.value.should == "ABCDE"
   end
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bindata
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 1
   - 2
-  - 1
-  version: 1.2.1
+  - 2
+  version: 1.2.2
 platform: ruby
 authors: 
 - Dion Mendel
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-20 00:00:00 +08:00
+date: 2010-12-14 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -122,7 +122,6 @@ files:
 - spec/spec_common.rb
 - spec/deprecated_spec.rb
 - lib/bindata.rb
-- lib/bench.rb
 - lib/bindata/skip.rb
 - lib/bindata/choice.rb
 - lib/bindata/dsl.rb
@@ -152,6 +151,7 @@ files:
 - tasks/rdoc.rake
 - setup.rb
 - manual.haml
+- manual.md
 has_rdoc: true
 homepage: http://bindata.rubyforge.org
 licenses: []

data/lib/bench.rb

@@ -1,102 +0,0 @@
-#require 'rubygems'; gem 'bindata'
-
-require 'bindata'
-
-COUNT = 50000
-
-Test1 = Struct.new(:a, :b, :c)
-
-class Test2
-  attr_accessor :a, :b, :c
-end
-
-class Test3
-  def initialize
-    @a = @b = @c = 1
-  end
-
-  def a=(v)
-    @a = v
-  end
-  def b=(v)
-    @b = v
-  end
-  def c=(v)
-    @c = v
-  end
-end
-
-class Test4 < BinData::Record
-  endian :little
-
-  int8 :a
-  int8 :b
-  int8 :c
-end
-
-def test1(klass)
-  a  = Time.now
-    z = []
-    COUNT.times do
-      obj = klass.new
-#      obj.a = 1
-#      obj.b = 1
-#      obj.c = 1
-      z << obj
-    end
-  b = Time.now
-  puts "#{klass}: #{b - a}"
-end
-
-def test2
-  a  = Time.now
-    z = []
-    COUNT.times do |i|
-      eval <<-END
-      class A#{i} < BinData::Record
-        int8 :a
-        int8 :b
-        int8 :c
-        int8 :d
-        int8 :e
-        int8 :f
-        int8 :g
-        int8 :h
-        int8 :i
-        int8 :j
-        int8 :k
-        int8 :l
-        int8 :m
-        int8 :n
-        int8 :o
-        int8 :p
-        int8 :q
-        int8 :r
-        int8 :s
-        int8 :t
-      end
-      END
-    end
-  b = Time.now
-  puts "test2: #{b - a}"
-end
-
-
-def prof(&block)
-  require 'rubygems'
-  require 'ruby-prof'
-  result = RubyProf.profile do
-    block.call
-  end
-
-  printer = RubyProf::GraphPrinter.new(result)
-  printer.print(STDOUT, 0)
-end
-
-
-#test1(Test1)
-#test1(Test2)
-#test1(Test3)
-test1(Test4)
-
-#test2