bindata 2.3.3 → 2.3.4

data/lib/bindata/base.rb

@@ -29,7 +29,7 @@ module BinData
         if name
           @arg_processor = "#{name}_arg_processor".gsub(/(?:^|_)(.)/) { $1.upcase }.to_sym
         elsif @arg_processor.is_a? Symbol
-          @arg_processor = BinData::const_get(@arg_processor).new
+          @arg_processor = BinData.const_get(@arg_processor).new
         elsif @arg_processor.nil?
           @arg_processor = superclass.arg_processor
         else
@@ -39,7 +39,7 @@ module BinData
 
       # The name of this class as used by Records, Arrays etc.
       def bindata_name
-        RegisteredClasses.underscore_name(self.name)
+        RegisteredClasses.underscore_name(name)
       end
 
       # Call this method if this class is abstract and not to be used.
@@ -109,7 +109,7 @@ module BinData
     # Returns nil if +key+ does not refer to any parameter.
     def eval_parameter(key, overrides = nil)
       value = get_parameter(key)
-      if value.is_a?(Symbol) or value.respond_to?(:arity)
+      if value.is_a?(Symbol) || value.respond_to?(:arity)
         lazy_evaluator.lazy_eval(value, overrides)
       else
         value
@@ -239,7 +239,8 @@ module BinData
     def safe_respond_to?(symbol, include_private = false) #:nodoc:
       base_respond_to?(symbol, include_private)
     end
-    alias_method :base_respond_to?, :respond_to? #:nodoc:
+
+    alias base_respond_to? respond_to?
 
     #---------------
     private
@@ -248,9 +249,9 @@ module BinData
       self.class.arg_processor.extract_args(self.class, args)
     end
 
-    def start_read(&block)
+    def start_read
       top_level_set(:in_read, true)
-      block.call
+      yield
     ensure
       top_level_set(:in_read, false)
     end
@@ -266,7 +267,7 @@ module BinData
 
     def top_level_get(sym)
       tl = top_level
-      tl.instance_variable_defined?("@tl_#{sym}") and
+      tl.instance_variable_defined?("@tl_#{sym}") &&
         tl.instance_variable_get("@tl_#{sym}")
     end
 
@@ -305,15 +306,15 @@ module BinData
 
     # Separates the arguments passed to BinData::Base.new into
     # [value, parameters, parent].  Called by #extract_args.
-    def separate_args(obj_class, obj_args)
+    def separate_args(_obj_class, obj_args)
       args = obj_args.dup
       value = parameters = parent = nil
 
-      if args.length > 1 and args.last.is_a? BinData::Base
+      if args.length > 1 && args.last.is_a?(BinData::Base)
         parent = args.pop
       end
 
-      if args.length > 0 and args.last.is_a? Hash
+      if args.length > 0 && args.last.is_a?(Hash)
         parameters = args.pop
       end
 
@@ -323,13 +324,13 @@ module BinData
 
       parameters ||= @@empty_hash
 
-      return [value, parameters, parent]
+      [value, parameters, parent]
     end
 
     # Performs sanity checks on the given parameters.
     # This method converts the parameters to the form expected
     # by the data object.
-    def sanitize_parameters!(obj_class, obj_params) 
+    def sanitize_parameters!(obj_class, obj_params)
     end
   end
 end

data/lib/bindata/base_primitive.rb

@@ -8,22 +8,22 @@ module BinData
   #
   #   require 'bindata'
   #
-  #   obj = BinData::Uint8.new(:initial_value => 42)
+  #   obj = BinData::Uint8.new(initial_value: 42)
   #   obj #=> 42
   #   obj.assign(5)
   #   obj #=> 5
   #   obj.clear
   #   obj #=> 42
   #
-  #   obj = BinData::Uint8.new(:value => 42)
+  #   obj = BinData::Uint8.new(value: 42)
   #   obj #=> 42
   #   obj.assign(5)
   #   obj #=> 42
   #
-  #   obj = BinData::Uint8.new(:assert => 3)
+  #   obj = BinData::Uint8.new(assert: 3)
   #   obj.read("\005") #=> BinData::ValidityError: value is '5' but expected '3'
   #
-  #   obj = BinData::Uint8.new(:assert => lambda { value < 5 })
+  #   obj = BinData::Uint8.new(assert: -> { value < 5 })
   #   obj.read("\007") #=> BinData::ValidityError: value not as expected
   #
   # == Parameters
@@ -44,7 +44,7 @@ module BinData
   #                            parameter.  A boolean return indicates success
   #                            or failure.  Any other return is compared to
   #                            the value just read in.
-  # [<tt>:asserted_value</tt>] Equavalent to <tt>:assert</tt> and <tt>:value</tt>.
+  # [<tt>:asserted_value</tt>] Equivalent to <tt>:assert</tt> and <tt>:value</tt>.
   #
   class BasePrimitive < BinData::Base
     unregister_self
@@ -101,6 +101,9 @@ module BinData
     def method_missing(symbol, *args, &block) #:nodoc:
       child = snapshot
       if child.respond_to?(symbol)
+        self.class.class_eval "def #{symbol}(*args, &block);" \
+                              "  snapshot.#{symbol}(*args, &block);" \
+                              "end"
         child.__send__(symbol, *args, &block)
       else
         super
@@ -139,7 +142,7 @@ module BinData
     # method.  This indirection is so that #snapshot can be overridden in
     # subclasses to modify the presentation value.
     def _value
-      @value != nil ? @value : sensible_default()
+      @value != nil ? @value : sensible_default
     end
 
     # Logic for the :value parameter
@@ -174,15 +177,15 @@ module BinData
 
       def assert!
         current_value = snapshot
-        expected = eval_parameter(:assert, :value => current_value)
-
-        msg = if not expected
-          "value '#{current_value}' not as expected"
-        elsif expected != true and current_value != expected
-          "value is '#{current_value}' but expected '#{expected}'"
-        else
-          nil
-        end
+        expected = eval_parameter(:assert, value: current_value)
+
+        msg = if !expected
+                "value '#{current_value}' not as expected"
+              elsif expected != true && current_value != expected
+                "value is '#{current_value}' but expected '#{expected}'"
+              else
+                nil
+              end
 
         raise ValidityError, "#{msg} for #{debug_name}" if msg
       end
@@ -209,10 +212,10 @@ module BinData
       end
 
       def assert_value(current_value)
-        expected = eval_parameter(:asserted_value, :value => current_value)
+        expected = eval_parameter(:asserted_value, value: current_value)
         if current_value != expected
           raise ValidityError,
-                "value is '#{current_value}' but " +
+                "value is '#{current_value}' but " \
                 "expected '#{expected}' for #{debug_name}"
         end
       end

data/lib/bindata/bits.rb

@@ -86,13 +86,13 @@ module BinData
 
       def create_clamp_code(nbits, signed)
         if nbits == :nbits
-          create_dynamic_clamp_code(nbits, signed)
+          create_dynamic_clamp_code(signed)
         else
           create_fixed_clamp_code(nbits, signed)
         end
       end
 
-      def create_dynamic_clamp_code(nbits, signed)
+      def create_dynamic_clamp_code(signed)
         if signed == :signed
           max = "max = (1 << (nbits - 1)) - 1"
           min = "min = -(max + 1)"
@@ -105,8 +105,8 @@ module BinData
       end
 
       def create_fixed_clamp_code(nbits, signed)
-        if nbits == 1 and signed == :signed
-          raise "signed bitfield must have more than one bit" 
+        if nbits == 1 && signed == :signed
+          raise "signed bitfield must have more than one bit"
         end
 
         if signed == :signed

data/lib/bindata/buffer.rb

@@ -9,12 +9,12 @@ module BinData
   #
   #   require 'bindata'
   #
-  #   obj = BinData::Buffer.new(:length => 5, :type => [:string, {:value => "abc"}])
+  #   obj = BinData::Buffer.new(length: 5, type: [:string, {value: "abc"}])
   #   obj.to_binary_s #=> "abc\000\000"
   #
   #
   #   class MyBuffer < BinData::Buffer
-  #     default_parameter :length => 8
+  #     default_parameter length: 8
   #
   #     endian :little
   #
@@ -34,10 +34,10 @@ module BinData
   #     endian :little
   #
   #     uint16 :table_size_in_bytes
-  #     buffer :strings, :length => :table_size_in_bytes do
-  #       array :read_until => :eof do
+  #     buffer :strings, length: :table_size_in_bytes do
+  #       array read_until: :eof do
   #         uint8 :len
-  #         string :str, :length => :len
+  #         string :str, length: :len
   #       end
   #     end
   #   end

data/lib/bindata/choice.rb

@@ -8,19 +8,19 @@ module BinData
   #
   #   require 'bindata'
   #
-  #   type1 = [:string, {:value => "Type1"}]
-  #   type2 = [:string, {:value => "Type2"}]
+  #   type1 = [:string, {value: "Type1"}]
+  #   type2 = [:string, {value: "Type2"}]
   #
   #   choices = {5 => type1, 17 => type2}
-  #   a = BinData::Choice.new(:choices => choices, :selection => 5)
+  #   a = BinData::Choice.new(choices: choices, selection: 5)
   #   a # => "Type1"
   #
   #   choices = [ type1, type2 ]
-  #   a = BinData::Choice.new(:choices => choices, :selection => 1)
+  #   a = BinData::Choice.new(choices: choices, selection: 1)
   #   a # => "Type2"
   #
   #   choices = [ nil, nil, nil, type1, nil, type2 ]
-  #   a = BinData::Choice.new(:choices => choices, :selection => 3)
+  #   a = BinData::Choice.new(choices: choices, selection: 3)
   #   a # => "Type1"
   #
   #
@@ -29,8 +29,8 @@ module BinData
   #   mychoice.choice = 'big'
   #
   #   choices = {'big' => :uint16be, 'little' => :uint16le}
-  #   a = BinData::Choice.new(:choices => choices, :copy_on_change => true,
-  #                           :selection => lambda { mychoice.choice })
+  #   a = BinData::Choice.new(choices: choices, copy_on_change: true,
+  #                           selection: -> { mychoice.choice })
   #   a.assign(256)
   #   a.to_binary_s #=> "\001\000"
   #
@@ -94,7 +94,7 @@ module BinData
     end
 
     %w(clear? assign snapshot do_read do_write do_num_bytes).each do |m|
-      self.module_eval <<-END
+      module_eval <<-END
         def #{m}(*args)
           current_choice.#{m}(*args)
         end
@@ -149,10 +149,10 @@ module BinData
     end
 
     def ensure_valid_keys(choices)
-      if choices.has_key?(nil)
+      if choices.key?(nil)
         raise ArgumentError, ":choices hash may not have nil key"
       end
-      if choices.keys.detect { |key| key.is_a?(Symbol) and key != :default }
+      if choices.keys.detect { |key| key.is_a?(Symbol) && key != :default }
         raise ArgumentError, ":choices hash may not have symbols for keys"
       end
     end
@@ -174,10 +174,8 @@ module BinData
     end
 
     def get_previous_choice(selection)
-      if selection != @last_selection and @last_selection != nil
+      if @last_selection && selection != @last_selection
         @choices[@last_selection]
-      else
-        nil
       end
     end
 

data/lib/bindata/count_bytes_remaining.rb

@@ -9,14 +9,13 @@ module BinData
   #
   #   class A < BinData::Record
   #     count_bytes_remaining :bytes_remaining
-  #     string :all_data, :read_length => :bytes_remaining
+  #     string :all_data, read_length: :bytes_remaining
   #   end
   #
   #   obj = A.read("abcdefghij")
   #   obj.all_data #=> "abcdefghij"
   #
   class CountBytesRemaining < BinData::BasePrimitive
-
     #---------------
     private
 

data/lib/bindata/delayed_io.rb

@@ -13,7 +13,7 @@ module BinData
   #
   #   require 'bindata'
   #
-  #   obj = BinData::DelayedIO.new(:read_abs_offset => 3, :type => :uint16be)
+  #   obj = BinData::DelayedIO.new(read_abs_offset: 3, type: :uint16be)
   #   obj.read("\x00\x00\x00\x11\x12")
   #   obj #=> 0
   #
@@ -32,12 +32,12 @@ module BinData
   #   class ReversePascalString < BinData::Record
   #     auto_call_delayed_io
   #
-  #     delayed_io :str, :read_abs_offset => 0 do
-  #       string :read_length => :len
+  #     delayed_io :str, read_abs_offset: 0 do
+  #       string read_length: :len
   #     end
   #     count_bytes_remaining :total_size
-  #     skip :to_abs_offset => lambda { total_size - 1 }
-  #     uint8  :len, :value => lambda { str.length }
+  #     skip to_abs_offset: -> { total_size - 1 }
+  #     uint8  :len, value: -> { str.length }
   #   end
   #
   #   s = ReversePascalString.read("hello\x05")
@@ -119,7 +119,7 @@ module BinData
     # DelayedIO objects aren't read when #read is called.
     # The reading is delayed until this method is called.
     def read_now!
-      raise IOError.new "read from where?" unless @read_io
+      raise IOError, "read from where?" unless @read_io
 
       @read_io.seekbytes(abs_offset - @read_io.offset)
       start_read do
@@ -130,7 +130,7 @@ module BinData
     # DelayedIO objects aren't written when #write is called.
     # The writing is delayed until this method is called.
     def write_now!
-      raise IOError.new "write to where?" unless @write_io
+      raise IOError, "write to where?" unless @write_io
       @write_io.seekbytes(abs_offset - @write_io.offset)
       @type.do_write(@write_io)
     end
@@ -161,7 +161,7 @@ module BinData
 
         DelayedIO.send(:alias_method, :initialize_instance_without_record_io, :initialize_instance)
         DelayedIO.send(:define_method, :initialize_instance) do
-          if @parent and ! defined? @delayed_io_recorded
+          if @parent && !defined? @delayed_io_recorded
             @delayed_io_recorded = true
             list = top_level_get(:delayed_ios)
             list << self if list
@@ -179,11 +179,11 @@ module BinData
       end
 
       def read(io)
-        super(io) { top_level_get(:delayed_ios).each { |obj| obj.read_now! } }
+        super(io) { top_level_get(:delayed_ios).each(&:read_now!) }
       end
 
-      def write(io, *args)
-        super(io) { top_level_get(:delayed_ios).each { |obj| obj.write_now! } }
+      def write(io, *_)
+        super(io) { top_level_get(:delayed_ios).each(&:write_now!) }
       end
 
       def num_bytes

data/lib/bindata/dsl.rb

@@ -1,7 +1,7 @@
 module BinData
   # Extracts args for Records and Buffers.
   #
-  # Foo.new(:bar => "baz) is ambiguous as to whether :bar is a value or parameter.
+  # Foo.new(bar: "baz) is ambiguous as to whether :bar is a value or parameter.
   #
   # BaseArgExtractor always assumes :bar is parameter.  This extractor correctly
   # identifies it as value or parameter.
@@ -18,7 +18,7 @@ module BinData
     end
 
     def parameters_is_value?(obj_class, value, parameters)
-      if value.nil? and parameters.length > 0
+      if value.nil? && !parameters.empty?
         field_names_in_parameters?(obj_class, parameters)
       else
         false
@@ -29,18 +29,17 @@ module BinData
       field_names = obj_class.fields.field_names
       param_keys = parameters.keys
 
-      (field_names & param_keys).length > 0
+      !(field_names & param_keys).empty?
     end
   end
 
   # BinData classes that are part of the DSL must be extended by this.
   module DSLMixin
     def dsl_parser(parser_type = nil)
-      unless defined? @dsl_parser
-        parser_type = superclass.dsl_parser.parser_type if parser_type.nil?
-        @dsl_parser = DSLParser.new(self, parser_type)
+      @dsl_parser ||= begin
+        parser_type ||= superclass.dsl_parser.parser_type
+        DSLParser.new(self, parser_type)
       end
-      @dsl_parser
     end
 
     def method_missing(symbol, *args, &block) #:nodoc:
@@ -82,13 +81,11 @@ module BinData
       end
 
       def search_prefix(*args)
-        unless defined? @search_prefix
-          @search_prefix = parent_attribute(:search_prefix, []).dup
-        end
+        @search_prefix ||= parent_attribute(:search_prefix, []).dup
 
-        prefix = args.collect { |name| name.to_sym }.compact
-        if prefix.size > 0
-          if has_fields?
+        prefix = args.collect(&:to_sym).compact
+        unless prefix.empty?
+          if fields?
             dsl_raise SyntaxError, "search_prefix must be called before defining fields"
           end
 
@@ -100,25 +97,21 @@ module BinData
 
       def hide(*args)
         if option?(:hidden_fields)
-          hidden = args.collect { |name| name.to_sym }
+          @hide ||= parent_attribute(:hide, []).dup
 
-          unless defined? @hide
-            @hide = parent_attribute(:hide, []).dup
-          end
+          hidden = args.collect(&:to_sym).compact
+          @hide.concat(hidden)
 
-          @hide.concat(hidden.compact)
           @hide
         end
       end
 
       def fields
-        unless defined? @fields
-          fields = parent_fields
-          @fields = SanitizedFields.new(hints)
-          @fields.copy_fields(fields) if fields
+        @fields ||= begin
+          SanitizedFields.new(hints).tap do |san_fields|
+            san_fields.copy_fields(parent_fields) if parent_fields
+          end
         end
-
-        @fields
       end
 
       def dsl_params
@@ -136,13 +129,13 @@ module BinData
 
       def parser_abilities
         @abilities ||= {
-          :struct     => [:to_struct_params, :struct,      [:multiple_fields, :optional_fieldnames, :hidden_fields]],
-          :array      => [:to_object_params, :type,        [:multiple_fields, :optional_fieldnames]],
-          :buffer     => [:to_object_params, :type,        [:multiple_fields, :optional_fieldnames, :hidden_fields]],
-          :choice     => [:to_choice_params, :choices,     [:multiple_fields, :all_or_none_fieldnames, :fieldnames_are_values]],
-          :delayed_io => [:to_object_params, :type,        [:multiple_fields, :optional_fieldnames, :hidden_fields]],
-          :primitive  => [:to_struct_params, :struct,      [:multiple_fields, :optional_fieldnames]],
-          :skip       => [:to_object_params, :until_valid, [:multiple_fields, :optional_fieldnames]],
+          struct:     [:to_struct_params, :struct,      [:multiple_fields, :optional_fieldnames, :hidden_fields]],
+          array:      [:to_object_params, :type,        [:multiple_fields, :optional_fieldnames]],
+          buffer:     [:to_object_params, :type,        [:multiple_fields, :optional_fieldnames, :hidden_fields]],
+          choice:     [:to_choice_params, :choices,     [:multiple_fields, :all_or_none_fieldnames, :fieldnames_are_values]],
+          delayed_io: [:to_object_params, :type,        [:multiple_fields, :optional_fieldnames, :hidden_fields]],
+          primitive:  [:to_struct_params, :struct,      [:multiple_fields, :optional_fieldnames]],
+          skip:       [:to_object_params, :until_valid, [:multiple_fields, :optional_fieldnames]],
         }
       end
 
@@ -156,15 +149,15 @@ module BinData
       end
 
       def hints
-        { :endian => endian, :search_prefix => search_prefix }
+        { endian: endian, search_prefix: search_prefix }
       end
 
       def set_endian(endian)
         if endian
-          if has_fields?
+          if fields?
             dsl_raise SyntaxError, "endian must be called before defining fields"
           end
-          if not valid_endian?(endian)
+          if !valid_endian?(endian)
             dsl_raise ArgumentError, "unknown value for endian '#{endian}'"
           end
 
@@ -184,8 +177,8 @@ module BinData
         parent_attribute(:fields)
       end
 
-      def has_fields?
-        defined? @fields and @fields.length > 0
+      def fields?
+        defined?(@fields) && !@fields.empty?
       end
 
       def parse_and_append_field(*args, &block)
@@ -207,18 +200,18 @@ module BinData
       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)
+        if parser && parser.respond_to?(attr)
           parser.send(attr)
         else
           default
         end
       end
 
-      def dsl_raise(exception, message)
+      def dsl_raise(exception, msg)
         backtrace = caller
         backtrace.shift while %r{bindata/dsl.rb} =~ backtrace.first
 
-        raise exception, message + " in #{@the_class}", backtrace
+        raise exception, "#{msg} in #{@the_class}", backtrace
       end
 
       def to_object_params(key)
@@ -233,10 +226,10 @@ module BinData
       end
 
       def to_choice_params(key)
-        if fields.length == 0
+        if fields.empty?
           {}
         elsif fields.all_field_names_blank?
-          {key => fields.collect { |f| f.prototype }}
+          {key => fields.collect(&:prototype)}
         else
           choices = {}
           fields.each { |f| choices[f.name] = f.prototype }
@@ -245,14 +238,14 @@ module BinData
       end
 
       def to_struct_params(*unused)
-        result = {:fields => fields}
-        if not endian.nil?
+        result = {fields: fields}
+        if !endian.nil?
           result[:endian] = endian
         end
-        if not search_prefix.empty?
+        if !search_prefix.empty?
           result[:search_prefix] = search_prefix
         end
-        if option?(:hidden_fields) and not hide.empty?
+        if option?(:hidden_fields) && !hide.empty?
           result[:hide] = hide
         end
 
@@ -284,8 +277,8 @@ module BinData
 
         def override_new_in_class(bnl_class)
           endian_classes = {
-            :big    => class_with_endian(bnl_class, :big),
-            :little => class_with_endian(bnl_class, :little),
+            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
@@ -300,8 +293,8 @@ module BinData
 
         def delegate_field_creation(bnl_class)
           endian_classes = {
-            :big    => class_with_endian(bnl_class, :big),
-            :little => class_with_endian(bnl_class, :little),
+            big:    class_with_endian(bnl_class, :big),
+            little: class_with_endian(bnl_class, :little),
           }
 
           parser = bnl_class.dsl_parser
@@ -333,8 +326,8 @@ module BinData
 
         def class_with_endian(class_name, endian)
           hints = {
-            :endian => endian,
-            :search_prefix => class_name.dsl_parser.search_prefix,
+            endian: endian,
+            search_prefix: class_name.dsl_parser.search_prefix,
           }
           RegisteredClasses.lookup(class_name, hints)
         end
@@ -358,7 +351,7 @@ module BinData
 
       def name_from_field_declaration(args)
         name, _ = args
-        if name == "" or name.is_a?(Hash)
+        if name == "" || name.is_a?(Hash)
           nil
         else
           name
@@ -384,12 +377,12 @@ module BinData
 
       def params_from_block(&block)
         bindata_classes = {
-          :array      => BinData::Array,
-          :buffer     => BinData::Buffer,
-          :choice     => BinData::Choice,
-          :delayed_io => BinData::DelayedIO,
-          :skip       => BinData::Skip,
-          :struct     => BinData::Struct,
+          array:      BinData::Array,
+          buffer:     BinData::Buffer,
+          choice:     BinData::Choice,
+          delayed_io: BinData::DelayedIO,
+          skip:       BinData::Skip,
+          struct:     BinData::Struct,
         }
 
         if bindata_classes.include?(@type)
@@ -429,7 +422,7 @@ module BinData
       end
 
       def ensure_valid_name(name)
-        if name and not option?(:fieldnames_are_values)
+        if name && !option?(:fieldnames_are_values)
           if malformed_name?(name)
             raise NameError.new("", name), "field '#{name}' is an illegal fieldname"
           end
@@ -449,19 +442,19 @@ module BinData
       end
 
       def must_not_have_a_name_failed?(name)
-        option?(:no_fieldnames) and name != nil
+        option?(:no_fieldnames) && !name.nil?
       end
 
       def must_have_a_name_failed?(name)
-        option?(:mandatory_fieldnames) and name.nil?
+        option?(:mandatory_fieldnames) && name.nil?
       end
 
       def all_or_none_names_failed?(name)
-        if option?(:all_or_none_fieldnames) and not fields.empty?
+        if option?(:all_or_none_fieldnames) && !fields.empty?
           all_names_blank = fields.all_field_names_blank?
           no_names_blank = fields.no_field_names_blank?
 
-          (name != nil and all_names_blank) or (name == nil and no_names_blank)
+          (!name.nil? && all_names_blank) || (name.nil? && no_names_blank)
         else
           false
         end
@@ -472,7 +465,7 @@ module BinData
       end
 
       def duplicate_name?(name)
-        fields.has_field_name?(name)
+        fields.field_name?(name)
       end
 
       def name_shadows_method?(name)