bindata 2.1.0 → 2.2.0

data/test/struct_test.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.join(File.dirname(__FILE__), "common"))
+require File.expand_path(File.join(File.dirname(__FILE__), "test_helper"))
 
 describe BinData::Struct, "when initializing" do
   it "fails on non registered types" do
@@ -62,7 +62,7 @@ describe BinData::Struct, "with anonymous fields" do
   it "writes anonymous fields" do
     obj.read("\001\002\003")
     obj.a.clear
-    obj.to_binary_s.must_equal "\005\002\005"
+    obj.to_binary_s.must_equal_binary "\005\002\005"
   end
 end
 
@@ -104,7 +104,7 @@ describe BinData::Struct, "with multiple fields" do
   let(:obj) { BinData::Struct.new({:a => 1, :b => 2}, params) }
 
   specify { obj.field_names.must_equal [:a, :b] }
-  specify { obj.to_binary_s.must_equal "\x01\x02" }
+  specify { obj.to_binary_s.must_equal_binary "\x01\x02" }
 
   it "returns num_bytes" do
     obj.a.num_bytes.must_equal 1
@@ -290,7 +290,7 @@ describe BinData::Struct, "with an endian defined" do
 
     expected = [1, 2.0, 3, 4, 5, 6, 7, 8].pack('veCCVvNv')
 
-    obj.to_binary_s.must_equal expected
+    obj.to_binary_s.must_equal_binary expected
   end
 end
 
@@ -301,7 +301,7 @@ describe BinData::Struct, "with bit fields" do
   }
 
   specify { obj.num_bytes.must_equal 3 }
-  specify { obj.to_binary_s.must_equal [0b0000_0101, 3, 1].pack("C*") }
+  specify { obj.to_binary_s.must_equal_binary [0b0000_0101, 3, 1].pack("C*") }
 
   it "reads" do
     str = [0b0000_0110, 5, 0].pack("C*")
@@ -338,6 +338,56 @@ describe BinData::Struct, "with nested endian" do
   end
 end
 
+describe BinData::Struct, "with a search_prefix" do
+  class AShort < BinData::Uint8; end
+  class BShort < BinData::Uint8; end
+
+  it "searches symbol prefixes" do
+    obj = BinData::Struct.new(:search_prefix => :a,
+                              :fields => [ [:short, :f] ])
+    obj.f.class.name.must_equal "AShort"
+  end
+
+  it "searches string prefixes" do
+    obj = BinData::Struct.new(:search_prefix => "a",
+                              :fields => [ [:short, :f] ])
+    obj.f.class.name.must_equal "AShort"
+  end
+
+  it "searches string prefixes with optional underscore" do
+    obj = BinData::Struct.new(:search_prefix => "a_",
+                              :fields => [ [:short, :f] ])
+    obj.f.class.name.must_equal "AShort"
+  end
+
+  it "searches multiple prefixes" do
+    obj = BinData::Struct.new(:search_prefix => [:x, :a],
+                              :fields => [ [:short, :f] ])
+    obj.f.class.name.must_equal "AShort"
+  end
+
+  it "uses parent search_prefix" do
+    nested_params = { :fields => [[:short, :f]] }
+    obj = BinData::Struct.new(:search_prefix => :a,
+                              :fields => [[:struct, :s, nested_params]])
+    obj.s.f.class.name.must_equal "AShort"
+  end
+
+  it "searches parent search_prefix" do
+    nested_params = { :search_prefix => :x, :fields => [[:short, :f]] }
+    obj = BinData::Struct.new(:search_prefix => :a,
+                              :fields => [[:struct, :s, nested_params]])
+    obj.s.f.class.name.must_equal "AShort"
+  end
+
+  it "prioritises nested search_prefix" do
+    nested_params = { :search_prefix => :a, :fields => [[:short, :f]] }
+    obj = BinData::Struct.new(:search_prefix => :b,
+                              :fields => [[:struct, :s, nested_params]])
+    obj.s.f.class.name.must_equal "AShort"
+  end
+end
+
 describe BinData::Struct, "with byte_align" do
   let(:obj) {
     params = { :fields => [[:int8, :a],
@@ -358,7 +408,7 @@ describe BinData::Struct, "with byte_align" do
 
   it "writes" do
     obj.assign(:a => 1, :b => 2, :c => 3, :d => 4)
-    obj.to_binary_s.must_equal binary("\x01\x00\x00\x00\x00\x02\xc0\x00\x00\x04")
+    obj.to_binary_s.must_equal_binary "\x01\x00\x00\x00\x00\x02\xc0\x00\x00\x04"
   end
 
   it "has correct offsets" do

data/test/system_test.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.join(File.dirname(__FILE__), "common"))
+require File.expand_path(File.join(File.dirname(__FILE__), "test_helper"))
 
 describe "lambdas with index" do
   class NestedLambdaWithIndex < BinData::Record
@@ -152,34 +152,34 @@ describe BinData::Record, "containing bitfields" do
     obj.c.x = 1
     obj.d = 850
     obj.e = 35
-    obj.to_binary_s.must_equal [0b0011_0010, 0b0100_0011, 0b0000_1010, 0b0001_0001, 0b1000_0000].pack("CCCCC")
+    obj.to_binary_s.must_equal_binary [0b0011_0010, 0b0100_0011, 0b0000_1010, 0b0001_0001, 0b1000_0000].pack("CCCCC")
   end
 end
 
 describe "Objects with debug_name" do
   it "haves default name of obj" do
-    el = ExampleSingle.new
+    el = BinData::Uint8.new
     el.debug_name.must_equal "obj"
   end
 
   it "includes array index" do
-    arr = BinData::Array.new(:type => :example_single, :initial_length => 2)
+    arr = BinData::Array.new(:type => :uint8, :initial_length => 2)
     arr[2].debug_name.must_equal "obj[2]"
   end
 
   it "includes field name" do
-    s = BinData::Struct.new(:fields => [[:example_single, :a]])
+    s = BinData::Struct.new(:fields => [[:uint8, :a]])
     s.a.debug_name.must_equal "obj.a"
   end
 
   it "delegates to choice" do
-    choice_params = {:choices => [:example_single], :selection => 0}
+    choice_params = {:choices => [:uint8], :selection => 0}
     s = BinData::Struct.new(:fields => [[:choice, :a, choice_params]])
     s.a.debug_name.must_equal "obj.a"
   end
 
   it "nests" do
-    nested_struct_params = {:fields => [[:example_single, :c]]}
+    nested_struct_params = {:fields => [[:uint8, :c]]}
     struct_params = {:fields => [[:struct, :b, nested_struct_params]]}
     s = BinData::Struct.new(:fields => [[:struct, :a, struct_params]])
     s.a.b.c.debug_name.must_equal "obj.a.b.c"

data/test/{common.rb → test_helper.rb}

@@ -9,21 +9,6 @@ require 'stringio'
 $LOAD_PATH.unshift File.expand_path("../lib", File.dirname(__FILE__))
 require 'bindata'
 
-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
@@ -32,31 +17,24 @@ class StringIO
   end
 end
 
-class ExampleSingle < BinData::BasePrimitive
-  def self.io_with_value(val)
-    StringIO.new([val].pack("V"))
-  end
-
-  private
+module Kernel
+  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)
 
-  def value_to_binary_string(val)
-    [val].pack("V")
+    protected_method_names = cls.protected_instance_methods - Object.protected_instance_methods
+    cls.send(:public, *protected_method_names)
   end
 
-  def read_and_return_value(io)
-    io.readbytes(4).unpack("V").at(0)
+  def value_read_from_written
+    self.class.read(self.to_binary_s)
   end
 
-  def sensible_default
-    0
+  def must_equal_binary(expected)
+    must_equal expected.dup.force_encoding(Encoding::BINARY)
   end
-end
 
-def binary(str)
-  str.dup.force_encoding(Encoding::BINARY)
-end
-
-module Kernel
   def must_raise_on_line(exp, line, msg = nil)
     ex = self.must_raise exp
     ex.message.must_equal msg if msg
@@ -70,4 +48,3 @@ module Kernel
     (err_line - ref_line).must_equal line
   end
 end
-

data/test/virtual_test.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.join(File.dirname(__FILE__), "common"))
+require File.expand_path(File.join(File.dirname(__FILE__), "test_helper"))
 
 describe BinData::Virtual do
   let(:stream) { StringIO.new "abcdefghij" }
@@ -12,7 +12,7 @@ describe BinData::Virtual do
 
   it "must not write to a stream" do
     obj = BinData::Virtual.new
-    obj.to_binary_s.must_equal ""
+    obj.to_binary_s.must_equal_binary ""
   end
 
   it "occupies no space" do

data/test/warnings_test.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-require File.expand_path(File.join(File.dirname(__FILE__), "common"))
+require File.expand_path(File.join(File.dirname(__FILE__), "test_helper"))
 
 describe BinData::Base, "when defining" do
   it "fails if #initialize is overridden" do

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: bindata
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Dion Mendel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-16 00:00:00.000000000 Z
+date: 2016-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: 5.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - ">"
       - !ruby/object:Gem::Version
         version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: |
@@ -59,14 +59,14 @@ description: |
   data is, and BinData works out *how* to read and write data in this
   format.  It is an easier ( and more readable ) alternative to
   ruby's #pack and #unpack methods.
-email: dion@lostrealm.com
+email: bindata@dm9.info
 executables: []
 extensions: []
 extra_rdoc_files:
 - NEWS.rdoc
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - BSDL
 - COPYING
 - ChangeLog.rdoc
@@ -120,7 +120,6 @@ files:
 - test/bits_test.rb
 - test/buffer_test.rb
 - test/choice_test.rb
-- test/common.rb
 - test/count_bytes_remaining_test.rb
 - test/float_test.rb
 - test/int_test.rb
@@ -137,6 +136,7 @@ files:
 - test/stringz_test.rb
 - test/struct_test.rb
 - test/system_test.rb
+- test/test_helper.rb
 - test/virtual_test.rb
 - test/warnings_test.rb
 homepage: http://github.com/dmendel/bindata
@@ -145,23 +145,23 @@ licenses:
 metadata: {}
 post_install_message: 
 rdoc_options:
-- --main
+- "--main"
 - NEWS.rdoc
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: bindata
-rubygems_version: 2.0.14
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A declarative way to read and write binary file formats