bindata 0.10.0 → 0.11.0

data/spec/rest_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/rest'
 
 describe BinData::Rest do

data/spec/spec_common.rb

@@ -1,4 +1,4 @@
-$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+$LOAD_PATH.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
 
 begin
   require 'rubygems'

data/spec/string_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'
 require 'bindata/string'
 
@@ -21,14 +21,6 @@ describe BinData::String, "with mutually exclusive parameters" do
   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::String, "when assigning" do
   before(:each) do
     @small = BinData::String.new(:length => 3, :pad_char => "A")

data/spec/stringz_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/stringz'
 
 describe BinData::Stringz, "when empty" do

data/spec/struct_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::Struct, "when initializing" do
@@ -79,15 +79,15 @@ describe BinData::Struct, "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::Struct.accepted_internal_parameters.should include(:fields)
-    BinData::Struct.accepted_internal_parameters.should include(:hide)
-    BinData::Struct.accepted_internal_parameters.should include(:endian)
+    BinData::Struct.accepted_parameters.all.should include(:fields)
+    BinData::Struct.accepted_parameters.all.should include(:hide)
+    BinData::Struct.accepted_parameters.all.should include(:endian)
   end
 
   it "should return field names" do
@@ -103,9 +103,9 @@ describe BinData::Struct, "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
@@ -138,6 +138,11 @@ describe BinData::Struct, "with multiple fields" do
     @obj.b.should == 4
   end
 
+  it "should assign from nil" do
+    @obj.assign(nil)
+    @obj.should be_clear
+  end
+
   it "should assign from Struct" do
     src = BinData::Struct.new(@params)
     src.a = 3
@@ -183,8 +188,8 @@ describe BinData::Struct, "with nested structs" do
   end
 
   it "should return num_bytes" do
-    @obj.num_bytes(:b).should == 2
-    @obj.num_bytes(:c).should == 2
+    @obj.b.num_bytes.should == 2
+    @obj.c.num_bytes.should == 2
     @obj.num_bytes.should == 5
   end
 

data/spec/system_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'
 
 describe "lambdas with index" do
@@ -64,7 +64,7 @@ describe "lambdas with parent" do
   end
 end
 
-describe "Records with choice field" do
+describe BinData::Record, "with choice field" do
   before(:all) do
     eval <<-END
       class TupleRecord < BinData::Record
@@ -289,3 +289,18 @@ describe "Evaluating custom parameters" do
     obj.c.eval_parameter(:custom).should == 5
   end
 end
+
+describe BinData::Record, "with custom sized integers" do
+  before(:all) do
+    eval <<-END
+      class CustomIntRecord < BinData::Record
+        int40be :a
+      end
+    END
+  end
+
+  it "should read as expected" do
+    str = "\x00\x00\x00\x00\x05"
+    CustomIntRecord.read(str).should == {"a" => 5}
+  end
+end

data/spec/wrapper_spec.rb

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__), "spec_common"))
+require 'bindata'
+require 'bindata/wrapper'
+
+describe BinData::Wrapper, "with errors" do
+  it "should not wrap more than one type" do
+    lambda {
+      eval <<-END
+        class WrappedMultipleTypes < BinData::Wrapper
+          uint8
+          uint8
+        end
+      END
+    }.should raise_error(SyntaxError)
+  end
+end
+
+describe BinData::Wrapper, "around a Primitive" do
+  before(:all) do
+    eval <<-END
+      class WrappedPrimitive < BinData::Wrapper
+        default_parameter :a => 3
+
+        uint8 :initial_value => :a
+      end
+    END
+  end
+
+  it "should access custom parameter" do
+    obj = WrappedPrimitive.new
+    obj.value.should == 3
+    obj.should == 3
+  end
+
+  it "should be able to override custom default parameter" do
+    obj = WrappedPrimitive.new(:a => 5)
+    obj.value.should == 5
+  end
+
+  it "should be able to override parameter" do
+    obj = WrappedPrimitive.new(:initial_value => 7)
+    obj.value.should == 7
+  end
+end
+
+describe BinData::Wrapper, "around an Array" do
+  before(:all) do
+    eval <<-END
+      class WrappedIntArray < BinData::Wrapper
+        endian :big
+        default_parameter :initial_element_value => 0
+        array :type => [:uint16, {:initial_value => :initial_element_value}]
+      end
+    END
+  end
+
+  it "should forward parameters" do
+    obj = WrappedIntArray.new(:initial_length => 7)
+    obj.length.should == 7
+  end
+
+  it "should be able to override default parameters" do
+    obj = WrappedIntArray.new(:initial_length => 3, :initial_element_value => 5)
+    obj.to_binary_s.should == "\x00\x05\x00\x05\x00\x05"
+  end
+end
+
+describe BinData::Wrapper, "around a Choice" do
+  before(:all) do
+    eval <<-END
+      class WrappedChoice < BinData::Wrapper
+        endian :big
+        choice :choices => { 'a' => :uint8, 'b' => :uint16 }
+      end
+    END
+  end
+
+  it "should forward parameters" do
+    obj = WrappedChoice.new(:selection => 'b')
+    obj.num_bytes.should == 2
+  end
+end

data/tasks/pkg.rake

@@ -0,0 +1,36 @@
+begin
+  require 'rubygems'
+  require 'rake/gempackagetask'
+
+  SPEC = Gem::Specification.new do |s|
+    s.name = 'bindata'
+    s.version = CURRENT_VERSION
+    s.platform = Gem::Platform::RUBY
+    s.summary = 'A declarative way to read and write binary file formats'
+    s.author = 'Dion Mendel'
+    s.email = 'dion@lostrealm.com'
+    s.homepage = 'http://bindata.rubyforge.org'
+    s.rubyforge_project = 'bindata'
+    s.require_path = 'lib'
+    s.has_rdoc = true
+    s.extra_rdoc_files = ['README']
+    s.rdoc_options << '--main' << 'README'
+    s.files = PKG_FILES
+  end
+
+  Rake::GemPackageTask.new(SPEC) do |pkg|
+    pkg.need_tar_gz = true
+  end
+
+  file "bindata.gemspec" => ["Rakefile", "lib/bindata.rb"] do |t|
+    require 'yaml'
+    open(t.name, "w") { |f| f.puts SPEC.to_yaml }
+  end
+
+  CLOBBER.include("bindata.gemspec")
+
+  desc "Create a stand-alone gemspec"
+  task :gemspec => "bindata.gemspec"
+rescue LoadError
+  puts "RubyGems must be installed to build the package"
+end

data/tasks/rdoc.rake

@@ -0,0 +1,8 @@
+require 'rake/rdoctask'
+
+Rake::RDocTask.new() do |rdoc|
+  rdoc.main = "README"
+  rdoc.rdoc_files.include("README", "NEWS")
+  rdoc.rdoc_files.include("lib/**/*.rb")
+end
+

data/tasks/rspec.rake

@@ -0,0 +1,17 @@
+begin
+  require 'spec'
+  require 'spec/rake/spectask'
+
+  Spec::Rake::SpecTask.new("spec") do |t|
+    t.warning = false
+    t.rcov = false
+    t.spec_files = FileList['spec/**/*_spec.rb'].exclude("spec/deprecated_spec.rb")
+  end
+
+  Spec::Rake::SpecTask.new("rcov") do |t|
+    t.warning = true
+    t.rcov = true
+  end
+rescue LoadError
+  puts "Rspec must be installed to run tests"
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: bindata
 version: !ruby/object:Gem::Version 
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors: 
 - Dion Mendel
-autorequire: bindata
+autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-04-17 00:00:00 +08:00
+date: 2009-06-28 00:00:00 +08:00
 default_executable: 
 dependencies: []
 
@@ -19,65 +19,70 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README
 files: 
-- ChangeLog
 - INSTALL
-- README
-- GPL
-- NEWS
 - TODO
+- GPL
+- Rakefile
 - COPYING
+- NEWS
+- README
+- ChangeLog
 - examples/gzip.rb
+- spec/primitive_spec.rb
+- spec/record_spec.rb
 - spec/float_spec.rb
-- spec/base_spec.rb
-- spec/sanitize_spec.rb
+- spec/int_spec.rb
+- spec/registry_spec.rb
 - spec/lazy_spec.rb
-- spec/io_spec.rb
-- spec/choice_spec.rb
-- spec/base_primitive_spec.rb
+- spec/deprecated_spec.rb
 - spec/array_spec.rb
+- spec/bits_spec.rb
+- spec/io_spec.rb
+- spec/struct_spec.rb
 - spec/stringz_spec.rb
-- spec/primitive_spec.rb
+- spec/rest_spec.rb
+- spec/base_spec.rb
+- spec/wrapper_spec.rb
+- spec/choice_spec.rb
 - spec/example.rb
 - spec/system_spec.rb
-- spec/int_spec.rb
 - spec/string_spec.rb
-- spec/struct_spec.rb
 - spec/spec_common.rb
-- spec/bits_spec.rb
-- spec/registry_spec.rb
-- spec/rest_spec.rb
-- spec/record_spec.rb
-- lib/bindata
-- lib/bindata/params.rb
-- lib/bindata/int.rb
-- lib/bindata/choice.rb
-- lib/bindata/trace.rb
-- lib/bindata/registry.rb
+- spec/base_primitive_spec.rb
+- lib/bindata/array.rb
 - lib/bindata/base_primitive.rb
-- lib/bindata/struct.rb
-- lib/bindata/stringz.rb
-- lib/bindata/bits.rb
-- lib/bindata/record.rb
-- lib/bindata/primitive.rb
+- lib/bindata/int.rb
 - lib/bindata/rest.rb
-- lib/bindata/base.rb
-- lib/bindata/array.rb
+- lib/bindata/struct.rb
 - lib/bindata/lazy.rb
+- lib/bindata/choice.rb
 - lib/bindata/string.rb
 - lib/bindata/float.rb
+- lib/bindata/base.rb
+- lib/bindata/primitive.rb
+- lib/bindata/registry.rb
+- lib/bindata/bits.rb
+- lib/bindata/deprecated.rb
+- lib/bindata/params.rb
 - lib/bindata/sanitize.rb
+- lib/bindata/trace.rb
+- lib/bindata/stringz.rb
 - lib/bindata/io.rb
+- lib/bindata/record.rb
+- lib/bindata/wrapper.rb
 - lib/bindata.rb
+- tasks/rdoc.rake
+- tasks/pkg.rake
+- tasks/rspec.rake
+- setup.rb
 has_rdoc: true
 homepage: http://bindata.rubyforge.org
 post_install_message: 
 rdoc_options: 
-- README
-- lib/bindata
-- -m
+- --main
 - README
 require_paths: 
 - lib
@@ -96,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: bindata
-rubygems_version: 1.2.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: A declarative way to read and write binary file formats

data/spec/sanitize_spec.rb

@@ -1,95 +0,0 @@
-#!/usr/bin/env ruby
-
-require File.expand_path(File.dirname(__FILE__)) + '/spec_common'
-require 'bindata/sanitize'
-require 'bindata/int'
-
-describe BinData::SanitizedParameters, "with bad input" do
-  before(:each) do
-    @mock = mock("dummy class")
-    @mock.stub!(:accepted_internal_parameters).and_return([:a, :b, :c])
-    @params = {:a => 1, :b => 2, :c => 3, :d => 4, :e => 5}
-  end
-
-  it "should convert keys to symbols" do
-    the_params = {'a' => 1, 'b' => 2, 'e' => 5}
-    sanitized = BinData::SanitizedParameters.new(@mock, the_params)
-    sanitized.parameters.should == {:a => 1, :b => 2, :e => 5}
-  end
-
-  it "should raise error if parameter has nil value" do
-    the_params = {'a' => 1, 'b' => nil, 'e' => 5}
-    lambda {
-      BinData::SanitizedParameters.new(@mock, the_params)
-    }.should raise_error(ArgumentError)
-  end
-end
-
-describe BinData::SanitizedParameters do
-  before(:each) do
-    @mock = mock("dummy class")
-    @mock.stub!(:accepted_internal_parameters).and_return([:a, :b, :c])
-    @params = {:a => 1, :b => 2, :c => 3, :d => 4, :e => 5}
-  end
-
-  it "should respond_to keys" do
-    sanitized = BinData::SanitizedParameters.new(@mock, @params)
-    sanitized.should respond_to(:keys)
-    keys = sanitized.keys.collect { |k| k.to_s }
-    keys.sort.should == ['a', 'b', 'c', 'd', 'e']
-  end
-
-  it "should respond_to has_key?" do
-    sanitized = BinData::SanitizedParameters.new(@mock, @params)
-    sanitized.should respond_to(:has_key?)
-    sanitized.should have_key(:a)
-    sanitized.should have_key(:e)
-    sanitized.should_not have_key(:z)
-  end
-
-  it "should respond_to []" do
-    sanitized = BinData::SanitizedParameters.new(@mock, @params)
-    sanitized.should respond_to(:[])
-    sanitized[:a].should == 1
-    sanitized[:d].should == 4
-  end
-end
-
-describe BinData::Sanitizer do
-  before(:each) do
-    @sanitizer = BinData::Sanitizer.new
-  end
-
-  it "should raise error on unknown types" do
-    lambda {
-      @sanitizer.lookup_class(:does_not_exist)
-    }.should raise_error(TypeError)
-  end
-
-  it "should lookup when endian is set" do
-    @sanitizer.with_endian(:little) do
-      the_class = @sanitizer.lookup_class(:int16)
-      the_class.should == BinData::Int16le
-    end
-  end
-
-  it "should nest with_endian calls" do
-    @sanitizer.with_endian(:little) do
-      the_class = @sanitizer.lookup_class(:int16)
-      the_class.should == BinData::Int16le
-
-      @sanitizer.with_endian(:big) do
-        the_class = @sanitizer.lookup_class(:int16)
-        the_class.should == BinData::Int16be
-      end
-
-      the_class = @sanitizer.lookup_class(:int16)
-      the_class.should == BinData::Int16le
-    end
-  end
-
-  it "should sanitize parameters" do
-    params = @sanitizer.sanitized_params(BinData::Int8, {:value => 3})
-    params.should have_key(:value)
-  end
-end