bindata 1.8.1 → 1.8.2

data/ChangeLog.rdoc

@@ -1,5 +1,10 @@
 = BinData Changelog
 
+== Version 1.8.2 (2014-02-02)
+
+* Virtual fields can now have values.
+* Bug fixes.
+
 == Version 1.8.1 (2014-01-15)
 
 * Added signed bitfields.  Requested by redood.

data/lib/bindata/base.rb

@@ -282,7 +282,7 @@ module BinData
 
     def binary_string(str)
       if str.respond_to?(:force_encoding)
-        str.dup.force_encoding(Encoding::BINARY)
+        str.to_s.dup.force_encoding(Encoding::BINARY)
       else
         str.dup
       end

data/lib/bindata/base_primitive.rb

@@ -97,7 +97,10 @@ module BinData
     def value
       snapshot
     end
-    alias_method :value=, :assign
+
+    def value=(val)
+      assign(val)
+    end
 
     def respond_to?(symbol, include_private = false) #:nodoc:
       child = snapshot
@@ -201,14 +204,18 @@ module BinData
       def assert!
         current_value = snapshot
         expected = eval_parameter(:assert, :value => current_value)
-        if not expected
-          raise ValidityError,
-                "value '#{current_value}' not as expected for #{debug_name}"
-        elsif current_value != expected and expected != true
-          raise ValidityError,
-                "value is '#{current_value}' but " +
-                "expected '#{expected}' for #{debug_name}"
+
+        msg = if not expected and current_value.nil?
+          "assertion failed"
+        elsif 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
+
+        raise ValidityError, "#{msg} for #{debug_name}" if msg
       end
     end
 

data/lib/bindata/version.rb

@@ -1,3 +1,3 @@
 module BinData
-  VERSION = "1.8.1"
+  VERSION = "1.8.2"
 end

data/lib/bindata/virtual.rb

@@ -1,9 +1,9 @@
 require "bindata/base"
 
 module BinData
-  # A virtual field is one that is neither read, written nor occupies space.
-  # It is used to make assertions or as a convenient label for determining
-  # offsets.
+  # A virtual field is one that is neither read, written nor occupies space in
+  # the data stream.  It is used to make assertions or as a convenient label
+  # for determining offsets or storing values.
   #
   #   require 'bindata'
   #
@@ -26,28 +26,20 @@ module BinData
   #
   # [<tt>:assert</tt>]    Raise an error when reading or assigning if the value
   #                       of this evaluated parameter is false.
+  # [<tt>:value</tt>]     The virtual object will always have this value.
   #
-  class Virtual < BinData::Base
+  class Virtual < BinData::BasePrimitive
 
-    optional_parameter :assert
-
-    def clear?; true; end
-    def snapshot; nil; end
-    def do_num_bytes; 0; end
-    def do_write(io); end
-
-    def assign(val)
-      assert!
+    def value_to_binary_string(val)
+      ""
     end
 
-    def do_read(io)
-      assert!
+    def read_and_return_value(io)
+      nil
     end
 
-    def assert!
-      if has_parameter?(:assert) and not eval_parameter(:assert)
-        raise ValidityError, "assertion failed for #{debug_name}"
-      end
+    def sensible_default
+      nil
     end
   end
 end

data/test/virtual_test.rb

@@ -22,7 +22,7 @@ describe BinData::Virtual do
 
   it "asserts on #read" do
     data = []
-    obj = BinData::Virtual.new(:assert => lambda { data << 1 })
+    obj = BinData::Virtual.new(:assert => lambda { data << 1; true })
 
     obj.read ""
     data.must_equal [1]
@@ -30,9 +30,19 @@ describe BinData::Virtual do
 
   it "asserts on #assign" do
     data = []
-    obj = BinData::Virtual.new(:assert => lambda { data << 1 })
+    obj = BinData::Virtual.new(:assert => lambda { data << 1; true })
 
     obj.assign("foo")
     data.must_equal [1]
   end
+
+  it "assigns a value" do
+    obj = BinData::Virtual.new(3)
+    obj.must_equal 3
+  end
+
+  it "accepts the :value parameter" do
+    obj = BinData::Virtual.new(:value => 3)
+    obj.must_equal 3
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bindata
 version: !ruby/object:Gem::Version 
-  hash: 53
+  hash: 51
   prerelease: 
   segments: 
   - 1
   - 8
-  - 1
-  version: 1.8.1
+  - 2
+  version: 1.8.2
 platform: ruby
 authors: 
 - Dion Mendel
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-01-15 00:00:00 +08:00
+date: 2014-02-02 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency