bindata 1.1.0 → 1.2.0

data/spec/string_spec.rb

@@ -123,7 +123,6 @@ describe BinData::String, "with :read_length and :initial_value" do
     @str.num_bytes.should == 5
     @str.value.should == "ABCDE"
   end
-
 end
 
 describe BinData::String, "with :read_length and :value" do

data/spec/stringz_spec.rb

@@ -49,14 +49,14 @@ describe BinData::Stringz, "when reading" do
     io = StringIO.new("abcd\0xyz\0")
     @str.read(io)
     @str.value.should == "abcd"
-    io.read(1).should == "x"
+    io.pos.should == 5
   end
 
   it "should handle a zero length string" do
     io = StringIO.new("\0abcd")
     @str.read(io)
     @str.value.should == ""
-    io.read(1).should == "a"
+    io.pos.should == 1
   end
 
   it "should fail if no zero byte is found" do
@@ -64,7 +64,7 @@ describe BinData::Stringz, "when reading" do
   end
 end
 
-describe BinData::Stringz, " when setting the value" do
+describe BinData::Stringz, "when setting the value" do
   before(:each) do
     @str = BinData::Stringz.new
   end
@@ -116,7 +116,7 @@ describe BinData::Stringz, "with max_length" do
     io = StringIO.new("abcdefg\0xyz")
     @str.read(io)
     @str.value.should == "abcd"
-    io.read(1).should == "f"
+    io.pos.should == 5
   end
 
   it "should accept values less than max_length" do

data/spec/struct_spec.rb

@@ -8,7 +8,7 @@ describe BinData::Struct, "when initializing" do
     params = {:fields => [[:non_registered_type, :a]]}
     lambda {
       BinData::Struct.new(params)
-    }.should raise_error(BinData::UnknownTypeError)
+    }.should raise_error(BinData::UnRegisteredTypeError)
   end
 
   it "should fail on duplicate names" do
@@ -107,7 +107,7 @@ describe BinData::Struct, "with multiple fields" do
   it "should return num_bytes" do
     @obj.a.num_bytes.should == 1
     @obj.b.num_bytes.should == 1
-    @obj.num_bytes.should     == 2
+    @obj.num_bytes.should   == 2
   end
 
   it "should identify accepted parameters" do

data/spec/system_spec.rb

@@ -67,17 +67,17 @@ describe BinData::Record, "with choice field" do
   end
 
   class RecordWithChoiceField < BinData::Record
-    choice :x, :choices => [[:tuple_record]], :selection => 0
+    choice :x, :selection => 0 do
+      tuple_record
+    end
   end
 
   class RecordWithNestedChoiceField < BinData::Record
-    choice :x, :choices => [
-                  [:choice, {
-                      :choices => [[:tuple_record]],
-                      :selection => 0}
-                  ]
-               ],
-               :selection => 0
+    choice :x, :selection => 0 do
+      choice :selection => 0 do
+        tuple_record
+      end
+    end
   end
 
   it "should treat choice object transparently " do
@@ -174,10 +174,9 @@ describe "Tracing"  do
 
     io = StringIO.new
     BinData::trace_reading(io) { arr.read("\x01\x02\x03\x04\x05") }
-    io.rewind
 
     expected = (0..4).collect { |i| "obj[#{i}] => #{i + 1}\n" }.join("")
-    io.read.should == expected
+    io.value.should == expected
   end
 
   it "should trace custom single values" do
@@ -191,9 +190,8 @@ describe "Tracing"  do
 
     io = StringIO.new
     BinData::trace_reading(io) { obj.read("\x01") }
-    io.rewind
 
-    io.read.should == ["obj-internal-.ex => 1\n", "obj => 1\n"].join("")
+    io.value.should == ["obj-internal-.ex => 1\n", "obj => 1\n"].join("")
   end
 
   it "should trace choice selection" do
@@ -201,31 +199,39 @@ describe "Tracing"  do
 
     io = StringIO.new
     BinData::trace_reading(io) { obj.read("\x01") }
-    io.rewind
 
-    io.read.should == ["obj-selection- => 0\n", "obj => 1\n"].join("")
+    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)
+
+    io = StringIO.new
+    BinData::trace_reading(io) { obj.read("0000000000111111111122222222223333333333") }
+
+    io.value.should == "obj => \"000000000011111111112222222222...\n"
   end
 end
 
-describe "Forward referencing with Single" do
-  class FRSingle < BinData::Record
+describe "Forward referencing with Primitive" do
+  class FRPrimitive < BinData::Record
     uint8  :len, :value => lambda { data.length }
     string :data, :read_length => :len
   end
 
   it "should initialise" do
-    @obj = FRSingle.new
+    @obj = FRPrimitive.new
     @obj.snapshot.should == {"len" => 0, "data" => ""}
   end
 
   it "should read" do
-    @obj = FRSingle.new
+    @obj = FRPrimitive.new
     @obj.read("\x04test")
     @obj.snapshot.should == {"len" => 4, "data" => "test"}
   end
 
   it "should set value" do
-    @obj = FRSingle.new
+    @obj = FRPrimitive.new
     @obj.data = "hello"
     @obj.snapshot.should == {"len" => 5, "data" => "hello"}
   end
@@ -280,3 +286,4 @@ describe BinData::Record, "with custom sized integers" do
     CustomIntRecord.read(str).should == {"a" => 5}
   end
 end
+

data/spec/wrapper_spec.rb

@@ -10,7 +10,30 @@ describe BinData::Wrapper, "with errors" do
         uint8
         uint8
       end
-    }.should raise_error(SyntaxError)
+    }.should raise_error_on_line(SyntaxError, 3) { |err|
+      err.message.should == "attempting to wrap more than one type in #{WrappedMultipleTypes}"
+    }
+  end
+
+  it "should fail if wrapped type has a name" do
+    lambda {
+      class WrappedWithName < BinData::Wrapper
+        uint8 :a
+      end
+    }.should raise_error_on_line(SyntaxError, 2) { |err|
+      err.message.should == "field must not have a name in #{WrappedWithName}"
+    }
+  end
+
+  it "should fail if no types to wrap" do
+    class WrappedNoTypes < BinData::Wrapper
+    end
+
+    lambda {
+      WrappedNoTypes.new
+    }.should raise_error(RuntimeError) { |err|
+      err.message.should == "no wrapped type was specified in #{WrappedNoTypes}"
+    }
   end
 end
 
@@ -23,18 +46,43 @@ describe BinData::Wrapper, "around a Primitive" do
 
   it "should access custom parameter" do
     obj = WrappedPrimitive.new
-    obj.value.should == 3
+    obj.assign(3)
     obj.should == 3
   end
 
   it "should be able to override custom default parameter" do
     obj = WrappedPrimitive.new(:a => 5)
-    obj.value.should == 5
+    obj.should == 5
   end
 
   it "should be able to override parameter" do
     obj = WrappedPrimitive.new(:initial_value => 7)
-    obj.value.should == 7
+    obj.should == 7
+  end
+
+  it "should clear" do
+    obj = WrappedPrimitive.new
+    obj.assign(3)
+    obj.should_not be_clear
+
+    obj.clear
+    obj.should be_clear
+  end
+
+  it "should read" do
+    obj = WrappedPrimitive.new
+    obj.assign(3)
+    str = obj.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)
+
+    obj.should respond_to(:value)
+    obj.value.should == 5
   end
 end
 

data/tasks/manual.rake

@@ -22,7 +22,7 @@ rescue LoadError
 end
 
 unless load_failed
-  file "manual.html" => ["README", "manual.haml"] do |t|
+  file "manual.html" => ["manual.md", "manual.haml"] do |t|
     require 'haml/exec'
 
     opts = Haml::Exec::Haml.new(["manual.haml", "manual.html"])

data/tasks/pkg.rake

@@ -16,6 +16,19 @@ begin
     s.extra_rdoc_files = ['NEWS']
     s.rdoc_options << '--main' << 'NEWS'
     s.files = PKG_FILES
+    s.add_development_dependency('rspec')
+    s.add_development_dependency('haml')
+    s.add_development_dependency('maruku')
+    s.add_development_dependency('syntax')
+    s.description = <<-END.gsub(/^ +/, "")
+      BinData provides an easy (and more readable) alternative to ruby's
+      #pack and #unpack methods.
+
+      It does this by providing a declarative way of specifying structured
+      binary data.  This means the programmer specifies *what* the format
+      of the binary data is, and BinData works out *how* to read and write
+      data in this format.
+    END
   end
 
   Rake::GemPackageTask.new(SPEC) do |pkg|

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bindata
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  hash: 31
+  prerelease: false
+  segments: 
+  - 1
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Dion Mendel
@@ -9,11 +15,74 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-24 00:00:00 +08:00
+date: 2010-07-09 00:00:00 +08:00
 default_executable: 
-dependencies: []
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: haml
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: maruku
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: syntax
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: |
+  BinData provides an easy (and more readable) alternative to ruby's
+  #pack and #unpack methods.
+  
+  It does this by providing a declarative way of specifying structured
+  binary data.  This means the programmer specifies *what* the format
+  of the binary data is, and BinData works out *how* to read and write
+  data in this format.
 
-description: 
 email: dion@lostrealm.com
 executables: []
 
@@ -23,64 +92,64 @@ extra_rdoc_files:
 - NEWS
 files: 
 - COPYING
+- ChangeLog
+- GPL
+- Rakefile
 - INSTALL
 - README
 - NEWS
-- GPL
-- ChangeLog
-- Rakefile
-- TODO
-- examples/ip_address.rb
 - examples/gzip.rb
+- examples/ip_address.rb
+- spec/base_spec.rb
+- spec/string_spec.rb
+- spec/record_spec.rb
+- spec/example.rb
+- spec/primitive_spec.rb
+- spec/stringz_spec.rb
+- spec/float_spec.rb
 - spec/io_spec.rb
-- spec/rest_spec.rb
+- spec/system_spec.rb
+- spec/array_spec.rb
 - spec/lazy_spec.rb
-- spec/primitive_spec.rb
 - spec/wrapper_spec.rb
-- spec/spec_common.rb
-- spec/registry_spec.rb
-- spec/string_spec.rb
-- spec/stringz_spec.rb
-- spec/choice_spec.rb
-- spec/example.rb
+- spec/struct_spec.rb
+- spec/rest_spec.rb
 - spec/base_primitive_spec.rb
-- spec/bits_spec.rb
-- spec/deprecated_spec.rb
-- spec/base_spec.rb
+- spec/registry_spec.rb
 - spec/int_spec.rb
-- spec/system_spec.rb
-- spec/record_spec.rb
-- spec/float_spec.rb
+- spec/bits_spec.rb
 - spec/skip_spec.rb
-- spec/struct_spec.rb
-- spec/array_spec.rb
-- lib/bindata/deprecated.rb
-- lib/bindata/record.rb
-- lib/bindata/float.rb
-- lib/bindata/registry.rb
-- lib/bindata/lazy.rb
+- spec/choice_spec.rb
+- spec/spec_common.rb
+- spec/deprecated_spec.rb
+- lib/bindata.rb
+- lib/bindata/skip.rb
 - lib/bindata/choice.rb
-- lib/bindata/struct.rb
+- lib/bindata/dsl.rb
 - lib/bindata/params.rb
-- lib/bindata/base_primitive.rb
-- lib/bindata/bits.rb
+- lib/bindata/array.rb
 - lib/bindata/trace.rb
-- lib/bindata/wrapper.rb
-- lib/bindata/sanitize.rb
+- lib/bindata/struct.rb
+- lib/bindata/lazy.rb
 - lib/bindata/base.rb
-- lib/bindata/skip.rb
-- lib/bindata/rest.rb
-- lib/bindata/string.rb
-- lib/bindata/array.rb
 - lib/bindata/stringz.rb
-- lib/bindata/primitive.rb
+- lib/bindata/string.rb
 - lib/bindata/int.rb
 - lib/bindata/io.rb
-- lib/bindata.rb
-- tasks/rdoc.rake
-- tasks/manual.rake
+- lib/bindata/base_primitive.rb
+- lib/bindata/wrapper.rb
+- lib/bindata/bits.rb
+- lib/bindata/record.rb
+- lib/bindata/primitive.rb
+- lib/bindata/sanitize.rb
+- lib/bindata/rest.rb
+- lib/bindata/deprecated.rb
+- lib/bindata/registry.rb
+- lib/bindata/float.rb
 - tasks/rspec.rake
 - tasks/pkg.rake
+- tasks/manual.rake
+- tasks/rdoc.rake
 - setup.rb
 - manual.haml
 has_rdoc: true
@@ -94,21 +163,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: bindata
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A declarative way to read and write binary file formats