bindata 0.8.0 → 0.8.1

data/ChangeLog

@@ -1,5 +1,12 @@
 = BinData Changelog
 
+-== Version 0.8.1 (2008-01-14)
+
+* Reduced memory consumption.
+* Increased execution speed.
+* Deprecated BinData::Base.parameters
+* Fixed spec syntax (thanks to David Goodlad)
+
 -== Version 0.8.0 (2007-10-14)
 
 * Add reserved field names to Struct.

data/lib/bindata.rb

@@ -1,5 +1,5 @@
 # BinData -- Binary data manipulator.
-# Copyright (c) 2007 Dion Mendel.
+# Copyright (c) 2007,2008 Dion Mendel.
 
 require 'bindata/array'
 require 'bindata/choice'
@@ -10,5 +10,5 @@ require 'bindata/stringz'
 require 'bindata/struct'
 
 module BinData
-  VERSION = "0.8.0"
+  VERSION = "0.8.1"
 end

data/lib/bindata/array.rb

@@ -40,6 +40,9 @@ module BinData
     mandatory_parameter :type
     optional_parameters :initial_length, :read_until
 
+    # An empty hash shared by all instances
+    @@empty_hash = Hash.new.freeze
+
     # Creates a new Array
     def initialize(params = {}, env = nil)
       super(cleaned_params(params), env)
@@ -51,7 +54,7 @@ module BinData
 
       @element_list    = nil
       @element_klass   = klass
-      @element_params  = el_params || {}
+      @element_params  = el_params || @@empty_hash
     end
 
     # Clears the element at position +index+.  If +index+ is not given, then
@@ -133,7 +136,7 @@ module BinData
     # Returns the appended object, or value in the case of single_values.
     def append(value = nil)
       append_new_element
-      self[self.length - 1] = value unless value.nil?
+      self[-1] = value unless value.nil?
       self.last
     end
 
@@ -142,9 +145,9 @@ module BinData
     def [](*index)
       data = elements[*index]
       if data.respond_to?(:each)
-        data.collect { |el| el.single_value? ? el.value : el }
+        data.collect { |el| (el && el.single_value?) ? el.value : el }
       else
-        data.single_value? ? data.value : data
+        (data && data.single_value?) ? data.value : data
       end
     end
     alias_method :slice, :[]
@@ -172,13 +175,9 @@ module BinData
     # form returns an empty array.
     def first(n = nil)
       if n.nil?
-        self.length.zero? ? nil : self[0]
+        self[0]
       else
-        array = []
-        [n, self.length].min.times do |i|
-          array.push(self[i])
-        end
-        array
+        self[0, n]
       end
     end
 
@@ -187,14 +186,10 @@ module BinData
     # form returns an empty array.
     def last(n = nil)
       if n.nil?
-        self.length.zero? ? nil : self[self.length - 1]
+        self[-1]
       else
-        array = []
-        start = self.length - [n, self.length].min
-        start.upto(self.length - 1) do |i|
-          array.push(self[i])
-        end
-        array
+        n = length if n > length
+        self[-n, n]
       end
     end
 

data/lib/bindata/base.rb

@@ -65,6 +65,8 @@ module BinData
 
       # Returns both the mandatory and optional parameters used by this class.
       def parameters
+        # warn about deprecated method - remove before releasing 1.0
+        warn "warning: #parameters is deprecated."
         (mandatory_parameters + optional_parameters).uniq
       end
 
@@ -112,6 +114,10 @@ module BinData
     # reference callable objects (methods or procs).  +env+ is the
     # environment that these callable objects are evaluated in.
     def initialize(params = {}, env = nil)
+      # all known parameters
+      mandatory = self.class.mandatory_parameters
+      optional = self.class.optional_parameters
+
       # default :readwrite param to true if unspecified
       if not params.has_key?(:readwrite)
         params = params.dup
@@ -119,22 +125,20 @@ module BinData
       end
 
       # ensure mandatory parameters exist
-      self.class.mandatory_parameters.each do |prm|
+      mandatory.each do |prm|
         if not params.has_key?(prm)
           raise ArgumentError, "parameter ':#{prm}' must be specified " +
                                "in #{self}"
         end
       end
 
-      known_params = self.class.parameters
-
       # partition parameters into known and extra parameters
       @params = {}
       extra   = {}
       params.each do |k,v|
         k = k.to_sym
         raise ArgumentError, "parameter :#{k} is nil in #{self}" if v.nil?
-        if known_params.include?(k)
+        if mandatory.include?(k) or optional.include?(k)
           @params[k] = v.freeze
         else
           extra[k] = v.freeze
@@ -149,18 +153,22 @@ module BinData
 
     # Returns the class matching a previously registered +name+.
     def klass_lookup(name)
-      klass = self.class.lookup(name)
-      if klass.nil? and @env.parent_data_object != nil
-        # lookup failed so retry in the context of the parent data object
-        klass = @env.parent_data_object.klass_lookup(name)
+      @cache ||= {}
+      klass = @cache[name]
+      if klass.nil?
+        klass = self.class.lookup(name)
+        if klass.nil? and @env.parent_data_object != nil
+          # lookup failed so retry in the context of the parent data object
+          klass = @env.parent_data_object.klass_lookup(name)
+        end
+        @cache[name] = klass
       end
       klass
     end
 
-    # Returns a list of parameters that *weren't* provided to this object.
-    def unsupplied_parameters
-      supplied = @params.keys + @env.params.keys
-      self.class.parameters - supplied
+    # Returns a list of parameters that are accepted by this object
+    def accepted_parameters
+      (self.class.mandatory_parameters + self.class.optional_parameters).uniq
     end
 
     # Reads data into this bin object by calling #do_read then #done_read.
@@ -218,7 +226,7 @@ module BinData
     # parameter from the +params+ hash used when creating the data object.
     # +values+ contains data that may be accessed when evaluating +key+.
     # Returns nil if +key+ does not refer to any parameter.
-    def eval_param(key, values = {})
+    def eval_param(key, values = nil)
       @env.lazy_eval(@params[key], values)
     end
 

data/lib/bindata/choice.rb

@@ -97,9 +97,9 @@ module BinData
       super || the_choice.respond_to?(symbol, include_private)
     end
 
-    def method_missing(symbol, *args)
+    def method_missing(symbol, *args, &block)
       if the_choice.respond_to?(symbol)
-        the_choice.__send__(symbol, *args)
+        the_choice.__send__(symbol, *args, &block)
       else
         super
       end

data/lib/bindata/lazy.rb

@@ -13,23 +13,35 @@ module BinData
   # parent data object.  This makes the lambda easier to read as we just write
   # <tt>field</tt> instead of <tt>obj.field</tt>.
   class LazyEvalEnv
+    # An empty hash shared by all instances
+    @@empty_hash = Hash.new.freeze
+
     # Creates a new environment.  +parent+ is the environment of the
     # parent data object.
     def initialize(parent = nil)
       @parent = parent
-      @variables = {}
-      @overrides = {}
+      @variables = @@empty_hash
+      @overrides = @@empty_hash
+      @params    = @@empty_hash
     end
-    attr_reader :parent
-    attr_accessor :data_object, :params
+    attr_reader :parent, :params
+    attr_accessor :data_object
 
     # only accessible by another LazyEvalEnv
     protected :data_object
 
+    # Set the parameters for this environment.
+    def params=(p)
+      @params = (p.nil? or p.empty?) ? @@empty_hash : p
+    end
+
     # Add a variable with a pre-assigned value to this environment.  +sym+
     # will be accessible as a variable for any lambda evaluated
     # with #lazy_eval.
     def add_variable(sym, value)
+      if @variables.equal?(@@empty_hash)
+        @variables = {}
+      end
       @variables[sym.to_sym] = value
     end
 
@@ -47,15 +59,16 @@ module BinData
 
     # Evaluates +obj+ in the context of this environment.  Evaluation
     # recurses until it yields a value that is not a symbol or lambda.
-    def lazy_eval(obj, overrides = {})
-      @overrides = overrides
+    # +overrides+ is an optional +params+ like hash
+    def lazy_eval(obj, overrides = nil)
+      @overrides = overrides if overrides
       if obj.is_a? Symbol
         # treat :foo as lambda { foo }
         obj = __send__(obj)
       elsif obj.respond_to? :arity
         obj = instance_eval(&obj)
       end
-      @overrides = {}
+      @overrides = @@empty_hash
       obj
     end
 

data/lib/bindata/struct.rb

@@ -26,8 +26,8 @@ module BinData
   #    class PascalString < BinData::Struct
   #      delegate :data
   #
-  #      int32le :len, :value => lambda { data.length }
-  #      string  :data, :read_length => :len
+  #      uint8  :len, :value => lambda { data.length }
+  #      string :data, :read_length => :len
   #    end
   #
   #    str = PascalString.new
@@ -176,35 +176,46 @@ module BinData
         all_reserved_methods = delegate.methods + delegate.field_names -
                                  all_methods
 
-        # move unsupplied params from this object to the delegate object
-        delegate.unsupplied_parameters.each do |p|
-          if (v = @env.params.delete(p))
+        # move accepted params from this object to the delegate object
+        env_params = @env.params.dup
+        delegate.accepted_parameters.each do |p|
+          if (v = env_params.delete(p))
             delegate_params[p] = v
           end
         end
+        @env.params = env_params
       else
         # no delegate so all instance methods of Hash are reserved
         all_reserved_methods = Hash.instance_methods - all_methods
       end
 
+      # check if field names conflict with any reserved names
+      field_names = param(:fields).collect { |f| f[1] }
+      field_names_okay = (all_methods & field_names).empty? &&
+                           (all_reserved_methods & field_names).empty?
+
       # create instances of the fields
       @fields = param(:fields).collect do |type, name, params|
         klass = klass_lookup(type)
         raise TypeError, "unknown type '#{type}' for #{self}" if klass.nil?
-        if all_methods.include?(name)
-          raise NameError.new("field '#{name}' shadows an existing method",name)
-        end
-        if all_reserved_methods.include?(name)
-          raise NameError.new("field '#{name}' is a reserved name",name)
+        if not field_names_okay
+          # at least one field names conflicts so test them all.
+          # rationale - #include? is expensive so we avoid it if possible.
+          if all_methods.include?(name)
+            raise NameError.new("field '#{name}' shadows an existing method",name)
+          end
+          if all_reserved_methods.include?(name)
+            raise NameError.new("field '#{name}' is a reserved name",name)
+          end
         end
         [name, klass.new(params, create_env)]
       end
     end
 
-    # Returns a list of parameters that *weren't* provided to this object.
-    def unsupplied_parameters
+    # Returns a list of parameters that are accepted by this object
+    def accepted_parameters
       if delegate_object != nil
-        delegate_object.unsupplied_parameters
+        delegate_object.accepted_parameters
       else
         super
       end
@@ -335,7 +346,7 @@ module BinData
       delegate_object ? delegate_object.single_value? : false
     end
 
-    def method_missing(symbol, *args)
+    def method_missing(symbol, *args, &block)
       name = symbol.id2name
 
       is_writer = (name[-1, 1] == "=")
@@ -352,7 +363,7 @@ module BinData
           obj
         end
       elsif delegate_object.respond_to?(symbol)
-        delegate_object.__send__(symbol, *args)
+        delegate_object.__send__(symbol, *args, &block)
       else
         super
       end

data/spec/base_spec.rb

@@ -94,12 +94,12 @@ describe "A data object with parameters" do
     obj.param(:p3).should respond_to(:arity)
   end
 
-  it "should identify unsupplied parameters" do
+  it "should identify accepted parameters" do
     obj = WithParam.new(:p1 => 1, :p3 => 3, :p4 => 4, :p5 => 5)
-    obj.unsupplied_parameters.should include(:p2)
-    obj.unsupplied_parameters.should_not include(:p1)
-    obj.unsupplied_parameters.should_not include(:p3)
-    obj.unsupplied_parameters.should_not include(:p4)
+    obj.accepted_parameters.should include(:p1)
+    obj.accepted_parameters.should include(:p2)
+    obj.accepted_parameters.should include(:p3)
+    obj.accepted_parameters.should_not include(:p4)
   end
 end
 

data/spec/struct_spec.rb

@@ -26,7 +26,7 @@ describe "A Struct with hidden fields" do
     @obj.c = 15
     @obj.c.should eql(15)
 
-    @obj.should respond_to?(:b=)
+    @obj.should respond_to(:b=)
   end
 
   it "should not include hidden fields in snapshot" do
@@ -41,7 +41,7 @@ describe "A Struct that delegates" do
       class DelegateStruct < BinData::Struct
         delegate :b
         int8 :a, :initial_value => :num
-        int8 'b'
+        int8 'b', :initial_value => 7
         int8 :c, :value => :b
       end
     END
@@ -50,6 +50,7 @@ describe "A Struct that delegates" do
 
   it "should access custom parameters" do
     @obj.a.should eql(5)
+    @obj.b.should eql(7)
   end
 
   it "should have correct num_bytes" do
@@ -66,16 +67,16 @@ describe "A Struct that delegates" do
   end
 
   it "should delegate methods" do
-    @obj.should respond_to?(:value)
-    @obj.value = 7
-    @obj.c.should eql(7)
+    @obj.should respond_to(:value)
+    @obj.value = 9
+    @obj.c.should eql(9)
   end
 
-  it "should identify unsupplied parameters" do
-    @obj.unsupplied_parameters.should include(:check_value)
-    @obj.unsupplied_parameters.should include(:initial_value)
-    @obj.unsupplied_parameters.should include(:value)
-    @obj.unsupplied_parameters.should_not include(:endian)
+  it "should identify accepted parameters" do
+    @obj.accepted_parameters.should include(:check_value)
+    @obj.accepted_parameters.should include(:initial_value)
+    @obj.accepted_parameters.should include(:value)
+    @obj.accepted_parameters.should_not include(:endian)
   end
 
   it "should pass params when creating" do
@@ -104,13 +105,14 @@ describe "A Struct with nested delegation" do
   end
 
   it "should forward parameters" do
-    @obj.should respond_to?(:value)
+    @obj.should respond_to(:value)
     @obj.value.should eql(7)
   end
 
-  it "should identify unsupplied parameters" do
-    @obj.unsupplied_parameters.should include(:check_value)
-    @obj.unsupplied_parameters.should include(:value)
+  it "should identify accepted parameters" do
+    @obj.accepted_parameters.should include(:check_value)
+    @obj.accepted_parameters.should include(:initial_value)
+    @obj.accepted_parameters.should include(:value)
   end
 end
 
@@ -211,9 +213,9 @@ describe "A Struct with multiple fields" do
     @obj.num_bytes.should     eql(2)
   end
 
-  it "should identify unsupplied parameters" do
-    @obj.unsupplied_parameters.should include(:delegate)
-    @obj.unsupplied_parameters.should include(:endian)
+  it "should identify accepted parameters" do
+    @obj.accepted_parameters.should include(:delegate)
+    @obj.accepted_parameters.should include(:endian)
   end
 
   it "should clear" do

metadata

@@ -1,33 +1,26 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
-specification_version: 1
 name: bindata
 version: !ruby/object:Gem::Version 
-  version: 0.8.0
-date: 2007-10-14 00:00:00 +08:00
-summary: A declarative way to read and write binary file formats
-require_paths: 
-- lib
-email: dion@lostrealm.com
-homepage: http://bindata.rubyforge.org
-rubyforge_project: bindata
-description: 
-autorequire: bindata
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.8.1
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
 - Dion Mendel
+autorequire: bindata
+bindir: bin
+cert_chain: []
+
+date: 2008-01-14 00:00:00 +09:00
+default_executable: 
+dependencies: []
+
+description: 
+email: dion@lostrealm.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
 files: 
 - COPYING
 - GPL
@@ -49,7 +42,6 @@ files:
 - spec/struct_spec.rb
 - spec/float_spec.rb
 - lib/bindata
-- lib/bindata.rb
 - lib/bindata/int.rb
 - lib/bindata/string.rb
 - lib/bindata/base.rb
@@ -61,20 +53,35 @@ files:
 - lib/bindata/lazy.rb
 - lib/bindata/single.rb
 - lib/bindata/float.rb
-test_files: []
-
+- lib/bindata.rb
+has_rdoc: true
+homepage: http://bindata.rubyforge.org
+post_install_message: 
 rdoc_options: 
 - README
 - lib/bindata
 - -m
 - README
-extra_rdoc_files: []
-
-executables: []
-
-extensions: []
-
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: []
+rubyforge_project: bindata
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: A declarative way to read and write binary file formats
+test_files: []