bindata 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fba829df2a0f618021920683747584daef8f572a
-  data.tar.gz: efe2ac6d0ab61895a09f271fb9d7712e289f1897
+  metadata.gz: ef9bdd3883fe70283af7a90ef1d7a7aabdbc1043
+  data.tar.gz: a0e441bd2a6fc0fcebe932b21737364baa53a373
 SHA512:
-  metadata.gz: eef3a6fd17fcb5fe9afcffa35c566cd4e0752063f20bc4d9d135aa3300184454b8974d3161d90e37390dfa3b6606b5f1bfe1217705075e28bd2e5641b11f878d
-  data.tar.gz: 55bc265de56013c33f1e9abf7d38a796deff58cedf7faa1c20e77ee6dbad5e42a080c3ab46c8f06503e7268888cedd38b51667e1d091fa23cb89afc39b5b124e
+  metadata.gz: 45b2a84cd80c08590463773919d93cb8aececa94fc391d620e897a4b3b1d2a512dd2e8f91c9ec608008b6007a1828ff1dae80938de1d961eab7403a802d1a696
+  data.tar.gz: 179ea9774c018fa6d90f2e864d99ae829ee8f41d8289fc30da514481b2dddff94c6b1e6ca9c316f98657a9cfee6c307f001d6d1449db713569c17cb171e06645

data/.travis.yml

@@ -1,7 +1,12 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
-  - 2.1.1
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
   - jruby
   - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/COPYING

@@ -1,4 +1,4 @@
-BinData is copyrighted free software by Dion Mendel <dion@lostrealm.com>.
+BinData is copyrighted free software by Dion Mendel <bindata@dm9.info>.
 You can redistribute it and/or modify it under either the terms of the
 2-clause BSDL (see the file BSDL), or the conditions below:
 

data/ChangeLog.rdoc

@@ -1,5 +1,13 @@
 = BinData Changelog
 
+== Version 2.2.0 (2016-01-30)
+
+* Warn if String has :value but no :read_length.  Requested by Michael
+  Genereux.
+* Prevent running under Ruby 2.1.0p0 due to ruby bug 44525.
+* Added #to_hex convenience method.  Thanks to Gregory Romé.
+* Added namespacing via search_prefix. Requested by sumofparts.
+
 == Version 2.1.0 (2014-04-16)
 
 * Performance improvements.

data/README.md

@@ -59,4 +59,4 @@ or if running ruby 1.8
 # Contact
 
 If you have any queries / bug reports / suggestions, please contact me
-(Dion Mendel) via email at dion@lostrealm.com
+(Dion Mendel) via email at bindata@dm9.info

data/bindata.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   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.email = 'bindata@dm9.info'
   s.homepage = 'http://github.com/dmendel/bindata'
   s.rubyforge_project = 'bindata'
   s.require_path = 'lib'

data/lib/bindata.rb

@@ -1,10 +1,14 @@
 # BinData -- Binary data manipulator.
-# Copyright (c) 2007 - 2014 Dion Mendel.
+# Copyright (c) 2007 - 2016 Dion Mendel.
 
 if RUBY_VERSION <= "1.9"
   fail "BinData requires ruby >= 1.9.3. Use BinData version 1.8.x instead"
 end
 
+if RUBY_VERSION == "2.1.0" and RUBY_PATCHLEVEL == "0"
+  fail "Ruby 2.1.0p0 has a bug that causes BinData to fail. Upgrade your ruby version"
+end
+
 require 'bindata/version'
 require 'bindata/array'
 require 'bindata/bits'
@@ -36,4 +40,4 @@ require 'bindata/warnings'
 #
 # BinData is released under the same license as Ruby.
 #
-# Copyright (c) 2007 - 2014 Dion Mendel.
+# Copyright (c) 2007 - 2016 Dion Mendel.

data/lib/bindata/base.rb

@@ -182,6 +182,11 @@ module BinData
       io.read
     end
 
+    # Returns the hexadecimal string representation of this data object.
+    def to_hex
+      to_binary_s.unpack('H*')[0]
+    end
+
     # Return a human readable representation of this data object.
     def inspect
       snapshot.inspect

data/lib/bindata/base_primitive.rb

@@ -20,10 +20,10 @@ module BinData
   #   obj.assign(5)
   #   obj #=> 42
   #
-  #   obj = BinData::Uint8.new(:assert_value => 3)
+  #   obj = BinData::Uint8.new(:assert => 3)
   #   obj.read("\005") #=> BinData::ValidityError: value is '5' but expected '3'
   #
-  #   obj = BinData::Uint8.new(:assert_value => lambda { value < 5 })
+  #   obj = BinData::Uint8.new(:assert => lambda { value < 5 })
   #   obj.read("\007") #=> BinData::ValidityError: value not as expected
   #
   # == Parameters

data/lib/bindata/dsl.rb

@@ -67,7 +67,6 @@ module BinData
         @the_class      = the_class
         @parser_type    = parser_type
         @validator      = DSLFieldValidator.new(the_class, self)
-        @endian_handler = DSLBigAndLittleEndianHandler.new(the_class)
         @endian         = nil
       end
 
@@ -77,12 +76,28 @@ module BinData
         if endian
           set_endian(endian)
         elsif @endian.nil?
-          pendian = parent_attribute(:endian, nil)
-          set_endian(pendian) if pendian
+          set_endian(parent_attribute(:endian))
         end
         @endian
       end
 
+      def search_prefix(*args)
+        unless defined? @search_prefix
+          @search_prefix = parent_attribute(:search_prefix, []).dup
+        end
+
+        prefix = args.collect { |name| name.to_sym }.compact
+        if prefix.size > 0
+          if has_fields?
+            dsl_raise SyntaxError, "search_prefix must be called before defining fields"
+          end
+
+          @search_prefix = prefix.concat(@search_prefix)
+        end
+
+        @search_prefix
+      end
+
       def hide(*args)
         if option?(:hidden_fields)
           hidden = args.collect { |name| name.to_sym }
@@ -98,8 +113,8 @@ module BinData
 
       def fields
         unless defined? @fields
-          fields = @endian_handler.ancestor_fields || parent_attribute(:fields)
-          @fields = SanitizedFields.new(endian)
+          fields = parent_fields
+          @fields = SanitizedFields.new(hints)
           @fields.copy_fields(fields) if fields
         end
 
@@ -111,11 +126,8 @@ module BinData
       end
 
       def method_missing(*args, &block)
-        if endian == :big_and_little
-          @endian_handler.forward_field_definition(*args, &block)
-        else
-          parse_and_append_field(*args, &block)
-        end
+        ensure_hints
+        parse_and_append_field(*args, &block)
       end
 
       #-------------
@@ -125,7 +137,7 @@ module BinData
         @abilities ||= {
           :struct    => [:to_struct_params, [:multiple_fields, :optional_fieldnames, :hidden_fields]],
           :array     => [:to_array_params,  [:multiple_fields, :optional_fieldnames]],
-          :buffer    => [:to_array_params,  [:multiple_fields, :optional_fieldnames]],
+          :buffer    => [:to_array_params,  [:multiple_fields, :optional_fieldnames, :hidden_fields]],
           :choice    => [:to_choice_params, [:multiple_fields, :all_or_none_fieldnames, :fieldnames_are_values]],
           :primitive => [:to_struct_params, [:multiple_fields, :optional_fieldnames]]
         }
@@ -135,41 +147,49 @@ module BinData
         parser_abilities[@parser_type].at(1).include?(opt)
       end
 
-      def set_endian(endian)
-        if has_fields?
-          dsl_raise SyntaxError, "endian must not be called after defining fields"
-        end
-        if not valid_endian?(endian)
-          dsl_raise ArgumentError, "unknown value for endian '#{endian}'"
-        end
-
-        if endian == :big_and_little
-          @endian_handler.prepare_subclasses
-        end
+      def ensure_hints
+        endian
+        search_prefix
+      end
 
-        @endian = endian
+      def hints
+        {
+          :endian => endian,
+          :search_prefix => search_prefix,
+        }
       end
 
-      def has_fields?
-        @fields && @fields.length > 0
+      def set_endian(endian)
+        if endian
+          if has_fields?
+            dsl_raise SyntaxError, "endian must be called before defining fields"
+          end
+          if not valid_endian?(endian)
+            dsl_raise ArgumentError, "unknown value for endian '#{endian}'"
+          end
+
+          if endian == :big_and_little
+            DSLBigAndLittleEndianHandler.handle(@the_class)
+          end
+
+          @endian = endian
+        end
       end
 
       def valid_endian?(endian)
         [:big, :little, :big_and_little].include?(endian)
       end
 
-      def parent_attribute(attr, default = nil)
-        parent = @the_class.superclass
-        parser = parent.respond_to?(:dsl_parser) ? parent.dsl_parser : nil
-        if parser and parser.respond_to?(attr)
-          parser.send(attr)
-        else
-          default
-        end
+      def parent_fields
+        parent_attribute(:fields)
+      end
+
+      def has_fields?
+        @fields && @fields.length > 0
       end
 
       def parse_and_append_field(*args, &block)
-        parser = DSLFieldParser.new(endian, *args, &block)
+        parser = DSLFieldParser.new(hints, *args, &block)
         begin
           @validator.validate_field(parser.name)
           append_field(parser.type, parser.name, parser.params)
@@ -184,6 +204,16 @@ module BinData
         raise TypeError, "unknown type '#{err.message}'"
       end
 
+      def parent_attribute(attr, default = nil)
+        parent = @the_class.superclass
+        parser = parent.respond_to?(:dsl_parser) ? parent.dsl_parser : nil
+        if parser and parser.respond_to?(attr)
+          parser.send(attr)
+        else
+          default
+        end
+      end
+
       def dsl_raise(exception, message)
         backtrace = caller
         backtrace.shift while %r{bindata/dsl.rb} =~ backtrace.first
@@ -219,6 +249,9 @@ module BinData
         if not endian.nil?
           result[:endian] = endian
         end
+        if not search_prefix.empty?
+          result[:search_prefix] = search_prefix
+        end
         if option?(:hidden_fields) and not hide.empty?
           result[:hide] = hide
         end
@@ -231,87 +264,96 @@ module BinData
     # This option creates two subclasses, each handling
     # :big or :little endian.
     class DSLBigAndLittleEndianHandler
-      def initialize(the_class)
-        @the_class = the_class
-      end
-
-      def prepare_subclasses
-        create_subclasses_with_endian
-        make_class_abstract
-        override_new_in_class
-      end
-
-      def forward_field_definition(*args, &block)
-        class_with_endian(@the_class,    :big).send(*args, &block)
-        class_with_endian(@the_class, :little).send(*args, &block)
-      end
+      class << self
+        def handle(bnl_class)
+          make_class_abstract(bnl_class)
+          create_subclasses_with_endian(bnl_class)
+          override_new_in_class(bnl_class)
+          delegate_field_creation(bnl_class)
+          fixup_subclass_hierarchy(bnl_class)
+        end
 
-      def ancestor_fields
-        if subclass_of_big_and_little_endian?
-          pparent = @the_class.superclass.superclass
-          ancestor_with_endian = class_with_endian(pparent, @the_class.endian)
-          obj_attribute(ancestor_with_endian, :fields)
-        else
-          nil
+        def make_class_abstract(bnl_class)
+          bnl_class.send(:unregister_self)
         end
-      end
 
-      #-------------
-      private
+        def create_subclasses_with_endian(bnl_class)
+          instance_eval "class ::#{bnl_class}Be < ::#{bnl_class}; endian :big; end"
+          instance_eval "class ::#{bnl_class}Le < ::#{bnl_class}; endian :little; end"
+        end
 
-      def create_subclasses_with_endian
-        instance_eval "class ::#{@the_class}Be < ::#{@the_class}; endian :big; end"
-        instance_eval "class ::#{@the_class}Le < ::#{@the_class}; endian :little; end"
-      end
+        def override_new_in_class(bnl_class)
+          endian_classes = {
+            :big    => class_with_endian(bnl_class, :big),
+            :little => class_with_endian(bnl_class, :little),
+          }
+          bnl_class.define_singleton_method(:new) do |*args|
+            if self == bnl_class
+              value, options, parent = arg_processor.separate_args(self, args)
+              delegate = endian_classes[options[:endian]]
+              return delegate.new(*args) if delegate
+            end
+
+            super(*args)
+          end
+        end
 
-      def make_class_abstract
-        @the_class.send(:unregister_self)
-      end
+        def delegate_field_creation(bnl_class)
+          endian_classes = {
+            :big    => class_with_endian(bnl_class, :big),
+            :little => class_with_endian(bnl_class, :little),
+          }
 
-      def override_new_in_class
-        saved_class = @the_class
-        endian_classes = {
-          :big => class_with_endian(saved_class, :big),
-          :little => class_with_endian(saved_class, :little),
-        }
-        @the_class.define_singleton_method(:new) do |*args|
-          if self == saved_class
-            value, options, parent = arg_processor.separate_args(self, args)
-            delegate = endian_classes[options[:endian]]
-            return delegate.new(*args) if delegate
+          parser = bnl_class.dsl_parser
+          parser.define_singleton_method(:parse_and_append_field) do |*args, &block|
+            endian_classes[:big].send(*args, &block)
+            endian_classes[:little].send(*args, &block)
           end
-
-          super(*args)
         end
-      end
-
-      def subclass_of_big_and_little_endian?
-        parent  = @the_class.superclass
-        pparent = parent.superclass
 
-        obj_attribute(parent, :endian) == :big_and_little and
-        obj_attribute(pparent, :endian) == :big_and_little and
-        [:big, :little].include?(@the_class.endian)
-      end
+        def fixup_subclass_hierarchy(bnl_class)
+          parent = bnl_class.superclass
+          if obj_attribute(parent, :endian) == :big_and_little
+            be_subclass = class_with_endian(bnl_class, :big)
+            be_parent   = class_with_endian(parent, :big)
+            be_fields   = obj_attribute(be_parent, :fields)
+
+            le_subclass = class_with_endian(bnl_class, :little)
+            le_parent   = class_with_endian(parent, :little)
+            le_fields   = obj_attribute(le_parent, :fields)
+
+            be_subclass.dsl_parser.define_singleton_method(:parent_fields) do
+              be_fields
+            end
+            le_subclass.dsl_parser.define_singleton_method(:parent_fields) do
+              le_fields
+            end
+          end
+        end
 
-      def class_with_endian(class_name, endian)
-        RegisteredClasses.lookup(class_name, endian)
-      end
+        def class_with_endian(class_name, endian)
+          hints = {
+            :endian => endian,
+            :search_prefix => class_name.dsl_parser.search_prefix,
+          }
+          RegisteredClasses.lookup(class_name, hints)
+        end
 
-      def obj_attribute(obj, attr, default = nil)
-        parser = obj.respond_to?(:dsl_parser) ? obj.dsl_parser : nil
-        if parser and parser.respond_to?(attr)
-          parser.send(attr)
-        else
-          default
+        def obj_attribute(obj, attr, default = nil)
+          parser = obj.respond_to?(:dsl_parser) ? obj.dsl_parser : nil
+          if parser and parser.respond_to?(attr)
+            parser.send(attr)
+          else
+            default
+          end
         end
       end
     end
 
     # Extracts the details from a field declaration.
     class DSLFieldParser
-      def initialize(endian, symbol, *args, &block)
-        @endian = endian
+      def initialize(hints, symbol, *args, &block)
+        @hints  = hints
         @type   = symbol
         @name   = name_from_field_declaration(args)
         @params = params_from_field_declaration(args, &block)
@@ -355,7 +397,8 @@ module BinData
 
         if bindata_classes.include?(@type)
           parser = DSLParser.new(bindata_classes[@type], @type)
-          parser.endian(@endian)
+          parser.endian(@hints[:endian])
+          parser.search_prefix(*@hints[:search_prefix])
           parser.instance_eval(&block)
 
           parser.dsl_params