bindata 1.4.4 → 1.4.5

data/ChangeLog

@@ -1,5 +1,10 @@
 = BinData Changelog
 
+== Version 1.4.5 (2012-07-24)
+
+* Added the :pad_front option for padding to occur at the front of a String.
+  (suggested by Eduardo Mourão).
+
 == Version 1.4.4 (2012-06-21)
 
 * Fixed bug where user defined boolean primitive wouldn't set its

data/lib/bindata.rb

@@ -32,5 +32,5 @@ require 'bindata/deprecated'
 #
 # Copyright (c) 2007 - 2012 Dion Mendel.
 module BinData
-  VERSION = "1.4.4"
+  VERSION = "1.4.5"
 end

data/lib/bindata/string.rb

@@ -41,13 +41,16 @@ module BinData
   # <tt>:pad_byte</tt>::       The byte to use when padding a string to a
   #                            set length.  Valid values are Integers and
   #                            Strings of length 1.  "\0" is the default.
+  # <tt>:pad_front</tt>::      Signifies that the padding occurs at the front
+  #                            of the string rather than the end.  Default
+  #                            is false.
   # <tt>:trim_padding</tt>::   Boolean, default false.  If set, #value will
   #                            return the value with all pad_bytes trimmed
   #                            from the end of the string.  The value will
   #                            not be trimmed when writing.
   class String < BinData::BasePrimitive
 
-    optional_parameters :read_length, :length, :trim_padding
+    optional_parameters :read_length, :length, :trim_padding, :pad_front, :pad_left
     default_parameters  :pad_byte => "\0"
     mutually_exclusive_parameters :read_length, :length
     mutually_exclusive_parameters :length, :value
@@ -59,6 +62,10 @@ module BinData
 
         params.warn_renamed_parameter(:pad_char, :pad_byte) # Remove this line in the future
 
+        if params.has_parameter?(:pad_left)
+          params[:pad_front] = params.delete(:pad_left)
+        end
+
         if params.has_parameter?(:pad_byte)
           byte = params[:pad_byte]
           params[:pad_byte] = sanitized_pad_byte(byte)
@@ -120,12 +127,21 @@ module BinData
       elsif str.length > len
         str.slice(0, len)
       else
-        str + (eval_parameter(:pad_byte) * (len - str.length))
+        padding = (eval_parameter(:pad_byte) * (len - str.length))
+        if get_parameter(:pad_front)
+          padding + str
+        else
+          str + padding
+        end
       end
     end
 
     def trim_padding(str)
-      str.sub(/#{eval_parameter(:pad_byte)}*$/, "")
+      if get_parameter(:pad_front)
+        str.sub(/\A#{eval_parameter(:pad_byte)}*/, "")
+      else
+        str.sub(/#{eval_parameter(:pad_byte)}*\z/, "")
+      end
     end
 
     def value_to_binary_string(val)

data/manual.md

@@ -40,7 +40,7 @@ manipulating.
 It supports all the common datatypes that are found in structured binary
 data. Support for dependent and variable length fields is built in. 
 
-Last updated: 2012-06-21
+Last updated: 2012-07-24
 
 ## License
 
@@ -578,6 +578,16 @@ There are several parameters that are specific to fixed sized strings.
         obj #=> "abcdef"
     {:ruby}
 
+`:pad_front` or `:pad_left`
+
+:   Boolean, default `false`.  Signifies that the padding occurs at the front
+    of the string rather than the end.
+
+        obj = BinData::String.new(:length => 6, :pad_front => true)
+        obj.assign("abcd")
+        obj.snapshot #=> "\000\000abcd"
+    {:ruby}
+
 `:pad_byte`
 
 :   Defaults to `"\0"`.  The character to use when padding a string to a

data/spec/string_spec.rb

@@ -218,6 +218,48 @@ describe BinData::String, "with :trim_padding" do
   end
 end
 
+describe BinData::String, "with :pad_front" do
+  it "set false is the default" do
+    str1 = BinData::String.new(:length => 5)
+    str2 = BinData::String.new(:length => 5, :pad_front => false)
+    str1.assign("abc")
+    str2.assign("abc")
+    str1.should == "abc\0\0"
+    str2.should == "abc\0\0"
+  end
+
+  it "pads to the front" do
+    str = BinData::String.new(:length => 5, :pad_byte => 'R', :pad_front => true)
+    str.assign("abc")
+    str.should == "RRabc"
+  end
+
+  it "can alternatively be accesses by :pad_left" do
+    str = BinData::String.new(:length => 5, :pad_byte => 'R', :pad_left => true)
+    str.assign("abc")
+    str.should == "RRabc"
+  end
+
+  context "and :trim_padding" do
+    subject { BinData::String.new(:length => 5, :pad_byte => 'R', :pad_front => true, :trim_padding => true) }
+
+    it "assigns" do
+      subject.assign("abc")
+      subject.should == "abc"
+    end
+
+    it "has to_binary_s" do
+      subject.assign("abc")
+      subject.to_binary_s.should == "RRabc"
+    end
+
+    it "reads" do
+      subject.read "RRabc"
+      subject.should == "abc"
+    end
+  end
+end
+
 describe BinData::String, "with Ruby 1.9 encodings" do
   if RUBY_VERSION >= "1.9"
     class UTF8String < BinData::String

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bindata
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 1
   - 4
-  - 4
-  version: 1.4.4
+  - 5
+  version: 1.4.5
 platform: ruby
 authors: 
 - Dion Mendel
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-06-21 00:00:00 Z
+date: 2012-07-24 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec