bit-struct 0.15.0 → 0.16

data/lib/bit-struct/text-field.rb

@@ -13,13 +13,13 @@ class BitStruct
           "Bad offset, #{offset}, for #{self.class} #{name}." +
           " Must be multiple of 8."
       end
-      
+
       unless length % 8 == 0
         raise ArgumentError,
           "Bad length, #{length}, for #{self.class} #{name}." +
           " Must be multiple of 8."
       end
-      
+
       offset_byte = offset / 8
       length_byte = length / 8
       last_byte = offset_byte + length_byte - 1

data/lib/bit-struct/unsigned-field.rb

@@ -6,21 +6,18 @@ class BitStruct
     def self.class_name
       @class_name ||= "unsigned"
     end
-    
+
     def add_accessors_to(cl, attr = name) # :nodoc:
       offset_byte = offset / 8
       offset_bit = offset % 8
-      
+
       length_bit = offset_bit + length
       length_byte = (length_bit/8.0).ceil
       last_byte = offset_byte + length_byte - 1
-      
+
       divisor = options[:fixed] || options["fixed"]
       divisor_f = divisor && divisor.to_f
-#      if divisor and not divisor.is_a? Fixnum
-#        raise ArgumentError, "fixed-point divisor must be a fixnum"
-#      end
-      
+
       endian = (options[:endian] || options["endian"]).to_s
       case endian
       when "native"
@@ -33,15 +30,15 @@ class BitStruct
         raise ArgumentError,
           "Unrecognized endian option: #{endian.inspect}"
       end
-      
+
       data_is_big_endian =
         ([1234].pack(ctl) == [1234].pack(length_byte <= 2 ? "n" : "N"))
-      
+
       if length_byte == 1
         rest = 8 - length_bit
         mask  = ["0"*offset_bit + "1"*length + "0"*rest].pack("B8")[0].ord
         mask2 = ["1"*offset_bit + "0"*length + "1"*rest].pack("B8")[0].ord
-        
+
         cl.class_eval do
           if divisor
             define_method attr do ||
@@ -65,11 +62,11 @@ class BitStruct
             end
           end
         end
-      
+
       elsif offset_bit == 0 and length % 8 == 0
         field_length = length
         byte_range = offset_byte..last_byte
-        
+
         cl.class_eval do
           case field_length
           when 8
@@ -82,7 +79,7 @@ class BitStruct
                 val = (val * divisor).round
                 self[offset_byte] = val
               end
-          
+
             else
               define_method attr do ||
                 self[offset_byte]
@@ -92,7 +89,7 @@ class BitStruct
                 self[offset_byte] = val
               end
             end
-        
+
           when 16, 32
             if divisor
               define_method attr do ||
@@ -103,7 +100,7 @@ class BitStruct
                 val = (val * divisor).round
                 self[byte_range] = [val].pack(ctl)
               end
-            
+
             else
               define_method attr do ||
                 self[byte_range].unpack(ctl).first
@@ -113,7 +110,7 @@ class BitStruct
                 self[byte_range] = [val].pack(ctl)
               end
             end
-          
+
           else
             reader_helper = proc do |substr|
               bytes = substr.unpack("C*")
@@ -122,7 +119,7 @@ class BitStruct
                 (sum << 8) + byte
               end
             end
-            
+
             writer_helper = proc do |val|
               bytes = []
               while val > 0
@@ -136,21 +133,21 @@ class BitStruct
               bytes.reverse! if data_is_big_endian
               bytes.pack("C*")
             end
-            
+
             if divisor
               define_method attr do ||
                 reader_helper[self[byte_range]] / divisor_f
               end
-              
+
               define_method "#{attr}=" do |val|
                 self[byte_range] = writer_helper[(val * divisor).round]
               end
-            
+
             else
               define_method attr do ||
                 reader_helper[self[byte_range]]
               end
-              
+
               define_method "#{attr}=" do |val|
                 self[byte_range] = writer_helper[val]
               end
@@ -161,10 +158,10 @@ class BitStruct
       elsif length_byte == 2 # unaligned field that fits within two whole bytes
         byte_range = offset_byte..last_byte
         rest = 16 - length_bit
-        
+
         mask  = ["0"*offset_bit + "1"*length + "0"*rest]
         mask = mask.pack("B16").unpack(ctl).first
-        
+
         mask2 = ["1"*offset_bit + "0"*length + "1"*rest]
         mask2 = mask2.pack("B16").unpack(ctl).first
 
@@ -194,14 +191,14 @@ class BitStruct
             end
           end
         end
-      
+
       elsif length_byte == 3 # unaligned field that fits within 3 whole bytes
         byte_range = offset_byte..last_byte
         rest = 32 - length_bit
-        
+
         mask  = ["0"*offset_bit + "1"*length + "0"*rest]
         mask = mask.pack("B32").unpack(ctl).first
-        
+
         mask2 = ["1"*offset_bit + "0"*length + "1"*rest]
         mask2 = mask2.pack("B32").unpack(ctl).first
 
@@ -239,7 +236,7 @@ class BitStruct
             end
           end
         end
-      
+
       else
         raise "unsupported: #{inspect}"
       end

data/lib/bit-struct/vector-field.rb

@@ -8,12 +8,12 @@ class BitStruct
     def self.class_name
       @class_name ||= "vector"
     end
-    
+
     # Used in describe.
     def class_name
       @class_name ||= vector_class.name[/\w+$/]
     end
-    
+
     # Returns the subclass of Vector that is used to manage the value of this
     # field. If the class was specified in the BitStruct.vector declaration,
     # #vector_class will return it, otherwise it will be an anonymous class
@@ -39,20 +39,20 @@ class BitStruct
           "Bad offset, #{offset}, for vector field #{name}." +
           " Must be multiple of 8."
       end
-      
+
       unless length % 8 == 0
         raise ArgumentError,
           "Bad length, #{length}, for vector field #{name}." +
           " Must be multiple of 8."
       end
-      
+
       offset_byte = offset / 8
       length_byte = length / 8
       last_byte = offset_byte + length_byte - 1
       byte_range = offset_byte..last_byte
 
       vc = vector_class
-      
+
       cl.class_eval do
         define_method attr do ||
           vc.new(self[byte_range])
@@ -63,12 +63,12 @@ class BitStruct
             raise ArgumentError, "Size mismatch in vector field assignment " +
               "to #{attr} with value #{val.inspect}"
           end
-          
+
           if val.class != vc
             warn "Type mismatch in vector field assignment " +
               "to #{attr} with value #{val.inspect}"
           end
-          
+
           self[byte_range] = val
         end
       end

data/lib/bit-struct/vector.rb

@@ -22,7 +22,7 @@ class BitStruct::Vector < String
         @struct_class = nil
       end
     end
-    
+
     # Called as a class method with a single argument in a user-defined
     # subclass to specify a particular BitStruct class to use for each entry,
     # instead of generating an anonymous class. Called without arguments to
@@ -38,7 +38,7 @@ class BitStruct::Vector < String
         @struct_class.default_options default_options
       else
         unless @struct_class
-          @struct_class = self == BitStruct::Vector ? BitStruct : 
+          @struct_class = self == BitStruct::Vector ? BitStruct :
             Class.new(superclass.struct_class)
           @struct_class.default_options default_options
         end
@@ -54,7 +54,7 @@ class BitStruct::Vector < String
     def respond_to?(*m)  # :nodoc:
       orig_respond_to?(*m) || struct_class.respond_to?(*m)
     end
-    
+
     # Get or set the hash of default options for the class, which apply to all
     # fields in the entries. If +h+ is provided, update the default options
     # with that hash. Default options are inherited.
@@ -70,7 +70,7 @@ class BitStruct::Vector < String
       end
       @default_options
     end
-    
+
     def describe(*args)
       fmt = args[0] || BitStruct.describe_format
       if block_given?
@@ -81,37 +81,37 @@ class BitStruct::Vector < String
       end
     end
   end
-    
+
   # Convenience method for instances. Returns the BitStruct class that
   # describes each entry.
   def struct_class
     self.class.struct_class
   end
-  
-  # Convenience method for instances. Returns the string length in bytes of 
+
+  # Convenience method for instances. Returns the string length in bytes of
   # each entry in the vector.
   def struct_class_length
     self.class.struct_class.round_byte_length
   end
-  
+
   # +arg+ can be an integer (number of entries) or a string
   # (binary data, such as another Vector of the same size).
   def initialize arg   # :yields: instance
     case arg
     when Integer
       super(struct_class.initial_value * arg)
-    
+
     else
       begin
         super arg
       rescue NameError
         raise ArgumentError, "must be string or integer: #{arg.inspect}"
       end
-    end 
+    end
 
     yield self if block_given?
   end
-  
+
   # Get the +i+-th entry. Returns a *copy* of the entry. If you want to
   # use this copy to modify the entry, you must modify the copy and then
   # use #[]= to replace the entry with the copy.
@@ -122,29 +122,29 @@ class BitStruct::Vector < String
     unless (0...(length / entry_length)).include? i
       raise ArgumentError, "index out of range: #{i}"
     end
-    
+
     sc.new slice(entry_length * i, entry_length)
   end
-  
+
   alias _old_replace_substr []=
 
   # Set the +i+-th entry to +val+.
   def []=(i,val)
     entry_length = struct_class_length
-    
+
     unless (0...(length / entry_length)).include? i
       raise ArgumentError, "index out of range: #{i}"
     end
-    
+
     unless val.length == entry_length
       raise ArgumentError, "wrong entry length: #{val.length} != #{entry_length}"
     end
-    
+
     _old_replace_substr(entry_length * i, entry_length, val)
   end
-  
+
   ## TODO: [i..j] etc.
-  
+
   # Iterate over entries.
   def each
     entry_length = struct_class_length
@@ -152,7 +152,7 @@ class BitStruct::Vector < String
       yield self[i]
     end
   end
-  
+
   def inspect_with_options(opts = BitStruct::DEFAULT_INSPECT_OPTS)
     if opts[:include_class]
       opts = opts.dup
@@ -161,14 +161,14 @@ class BitStruct::Vector < String
     else
       s = ""
     end
-    
+
     s << entries.map{|entry| entry.inspect(opts)}.join(opts[:separator])
     lb, rb = opts[:brackets]
     [lb, s, rb].join
   end
 
   alias inspect inspect_with_options
-  
+
   def inspect_detailed
     inspect(BitStruct::DETAILED_INSPECT_OPTS)
   end

data/lib/bit-struct/yaml.rb

@@ -7,7 +7,7 @@ class BitStruct
     end
 
     YAML.add_ruby_type(/^bitstruct/) do |type, val|
-      subtype, subclass = YAML.read_type_class(type, Object)
+      _subtype, subclass = YAML.read_type_class(type, Object)
       subclass.new(val)
     end
 
@@ -74,7 +74,7 @@ class BitStruct
         raise YAML::TypeError, "Invalid BitStruct: " + val.inspect
       end
 
-      bitstruct_name, bitstruct_type = YAML.read_type_class( tag, BitStruct )
+      _bitstruct_name, bitstruct_type = YAML.read_type_class( tag, BitStruct )
 
       st = bitstruct_type.new
 

data/test/test-endian.rb

@@ -8,21 +8,21 @@ class Test_Endian < Minitest::Test
     unsigned  :f_native,    32,   :endian => :native
     unsigned  :f_network,   32,   :endian => :network
   end
-  
+
   attr_reader :bs
 
   def setup
     @bs = Endian.new
     bs.f_big = bs.f_little = bs.f_native = bs.f_network = 0x01020304
   end
-  
+
   def test_readers
     assert_equal(0x01020304, bs.f_big)
     assert_equal(0x01020304, bs.f_little)
     assert_equal(0x01020304, bs.f_native)
     assert_equal(0x01020304, bs.f_network)
   end
-  
+
   def test_writers
     bs.fields.each do |field|
       byte_offset = field.offset / 8

data/test/test-vector.rb

@@ -9,20 +9,20 @@ class Test_Vector < Minitest::Test
       unsigned :x,  16
       signed   :y,  32
     end
-    
+
     unsigned :other, 16, "other stuff"
   end
-  
+
   attr_reader :pkt
 
   def setup
     @pkt = Packet.new
   end
-  
+
   def test_length
     assert_equal(Packet.round_byte_length, pkt.length)
   end
-  
+
   def test_writers
     assert_equal(pkt.v[2].x, 0)
     v = pkt.v

data/test/test.rb

@@ -10,18 +10,18 @@ class Test_BitStruct < Minitest::Test
   class T2 < BitStruct
     unsigned    :bar, 8
   end
-  
+
   class Rest < BitStruct
     unsigned    :zap, 8
     rest        :body, T2
   end
-  
+
   class NestedPart < BitStruct
     unsigned :x,    5
     unsigned :y,    3, :default => 2
     char     :s,  5*8
   end
-  
+
   class Container < BitStruct
     nest    :n1,  NestedPart, :default => NestedPart.new(:x=>1, :s=>"deflt")
     nest    :n2,  NestedPart
@@ -66,7 +66,7 @@ class Test_BitStruct < Minitest::Test
     float       next_name, 64,  :format => "%10.5f"
 
     octets      next_name, 32,  :default => "192.168.1.123"
-    
+
     hex_octets  next_name, 48,  :default => "ab:cd:ef:01:23:45"
 
     unsigned    next_name, 1
@@ -76,14 +76,14 @@ class Test_BitStruct < Minitest::Test
     signed      next_name, 7,   :fixed => 1000 # unaligned!
 
     char        next_name, 24
-    
+
     rest        :bs_body
-    
+
     INITIAL_VALUES = {
       f1 => 1234,
       f2 => 5678
     }
-    
+
     INITIAL_VALUES.each do |f, v|
       initial_value.send "#{f}=", v
     end
@@ -106,11 +106,11 @@ class Test_BitStruct < Minitest::Test
     unsigned    next_name, 8
 
     unsigned    next_name, 1
-    
+
     rest        :bs1_body
 
   end
-  
+
   def setup
     srand(767343)
     @bs = BS.new
@@ -127,7 +127,7 @@ class Test_BitStruct < Minitest::Test
       bs.fields.each do |field|
         iv = initial_values && initial_values[field.name]
         iv ||= field.default
-        
+
         if iv
           case field
           when BitStruct::FloatField
@@ -141,21 +141,21 @@ class Test_BitStruct < Minitest::Test
       end
     end
   end
-  
+
   def test_init_with_value
     randomize(@bs_1)
 
     b = BS_1.new(@bs_1)
     assert_equal(@bs_1, b, "Initialize with argument failed.")
-    
+
     c = BS_1.new(b)
     assert_equal(@bs_1, c, "Initialize with argument failed.")
-    
+
     b1 = BS_1.new("")
     b2 = BS_1.new(nil)
     assert_equal(b1, b2, "Initialize with short argument failed.")
   end
-  
+
   def test_init_with_hash
     randomize(@bs_1)
 
@@ -167,25 +167,25 @@ class Test_BitStruct < Minitest::Test
     b = BS_1.new(h)
     assert_equal(@bs_1, b, "Initialize with argument failed.")
   end
-  
+
   def test_join
     assert_equal(@bs+@bs_1, BitStruct.join(@bs,@bs_1))
     assert_equal(@bs+@bs_1, [@bs,@bs_1].join(""))
   end
-  
+
   def test_parse
     orig = @testers
     orig.each do |bs|
       randomize(bs)
     end
-    
+
     data = BitStruct.join(orig)
     round_trip = BitStruct.parse(data, orig.map{|bs|bs.class})
     orig.zip(round_trip) do |bs1, bs2|
       assert_equal(bs1, bs2)
     end
   end
-  
+
   def test_closed
     assert_raises(BitStruct::ClosedClassError) do
       BS.class_eval do
@@ -193,7 +193,7 @@ class Test_BitStruct < Minitest::Test
       end
     end
   end
-  
+
   def test_rest
     len0 = @bs_1.length
 
@@ -204,16 +204,16 @@ class Test_BitStruct < Minitest::Test
     @bs_1.bs1_body = "b"*60
     assert_equal("b"*60, @bs_1.bs1_body)
     assert_equal(len0+60, @bs_1.length)
-    
+
     @bs_1.bs1_body = "c"*40
     assert_equal("c"*40, @bs_1.bs1_body)
     assert_equal(len0+40, @bs_1.length)
-    
+
     @bs_1.bs1_body = ""
     assert_equal("", @bs_1.bs1_body)
     assert_equal(len0, @bs_1.length)
   end
-  
+
   def test_rest_with_class
     r = Rest.new
     t2 = T2.new
@@ -221,38 +221,44 @@ class Test_BitStruct < Minitest::Test
     r.body = t2
     assert_equal(123, r.body.bar)
   end
-  
+
+  def test_rest_with_class_constructed
+    r = Rest.new(['0011'].pack('H*'))
+    assert_equal(0x00, r.zap)
+    assert_equal(0x11, r.body.bar)
+  end
+
   def test_nest
     cont = Container.new
     n1 = cont.n1
-    
+
     assert_equal(1, n1.x)
     assert_equal(2, n1.y)
     assert_equal("deflt", n1.s)
-    
+
     n1.sub(/./, " ")
 
     assert_equal(1, n1.x)
     assert_equal(2, n1.y)
     assert_equal("deflt", n1.s)
-    
+
     n1 = cont.n1
     n2 = cont.n2
-    
+
     assert_equal(0, n2.x)
     assert_equal(2, n2.y)
     assert_equal("\0"*5, n2.s)
-    
+
     n = NestedPart.new(:x=>4, :y=>1, :s=>"qwert")
     cont.n1 = n
 
     assert_equal(4, cont.n1.x)
     assert_equal(1, cont.n1.y)
     assert_equal("qwert", cont.n1.s)
-    
+
     assert_raises(ArgumentError) {cont.n2 = Container.new}
   end
-  
+
   def test_overflow
     ov = Overflow.new
     empty = ov.dup
@@ -287,21 +293,21 @@ class Test_BitStruct < Minitest::Test
 
     repeat_access_test(@bs_1, 10)
   end
-  
+
   def test_initial_value
     bs = @bs
     bs.class::INITIAL_VALUES.each do |f,v|
       assert_equal(v, bs.send(f), "In #{f} of a #{bs.class}")
     end
   end
-  
+
   def test_inherited_initial_value
     bs = @bs_1
     bs.class::INITIAL_VALUES.each do |f,v|
       assert_equal(v, bs.send(f), "In #{f} of a #{bs.class}")
     end
   end
-  
+
   def test_to_h
     h = @bs_1.to_h(:convert_keys => :to_s)
     field_names = @bs_1.fields.map{|f|f.name.to_s}
@@ -310,7 +316,7 @@ class Test_BitStruct < Minitest::Test
       assert_equal(@bs_1.send(name), h[name])
     end
   end
-  
+
   def test_to_a_exclude_rest
     include_rest = false
     a = @bs_1.to_a(include_rest)
@@ -331,7 +337,7 @@ class Test_BitStruct < Minitest::Test
       assert_equal(@bs_1.send(name), a[i])
     end
   end
-  
+
   def test_format_option
     formatted_fields = @bs.fields.select {|f|f.format}
     formatted_fields.each do |f|
@@ -339,18 +345,18 @@ class Test_BitStruct < Minitest::Test
       assert_equal(f.format % val, f.inspect_in_object(@bs, {}))
     end
   end
-  
+
   def test_yaml
     assert_equal(@bs_1, YAML.load(@bs_1.to_yaml))
   end
-  
+
   def test_field_by_name
     name = :f007
     f = @bs.field_by_name(name)
     assert(f)
     assert_equal(f.name, name)
   end
-  
+
   #--------
   def repeat_access_test(bs, n)
     last_set_value = {}
@@ -371,7 +377,7 @@ class Test_BitStruct < Minitest::Test
               begin
                 assert_equal(lsv2, bs.send(f2.name))
               rescue Test::Unit::AssertionFailedError => ex
-                msg = 
+                msg =
                   "In #{f2.inspect} after setting #{field.inspect} to" +
                   " #{last_set_value[field].inspect}"
                 raise ex, msg + "\n" + ex.message, ex.backtrace
@@ -386,7 +392,7 @@ class Test_BitStruct < Minitest::Test
 
     assert_equal(start_length, finish_length, "Length differs after test!")
   end
-  
+
   def randomize(bs)
     bs.fields.each do |f|
       randomize_field(bs, f)
@@ -432,13 +438,13 @@ class Test_BitStruct < Minitest::Test
       value = s * (field.length/8)
       bs.send "#{field.name}=", value
       last_set_value = value
-    
+
     when BitStruct::TextField
       s = (rand(64)+32).chr
       value = s * rand(field.length*2/8)
       bs.send "#{field.name}=", value
       last_set_value = s * [field.length/8, value.length].min
-    
+
     when BitStruct::FloatField
       value = rand(2**30)
       bs.send "#{field.name}=", value
@@ -446,7 +452,7 @@ class Test_BitStruct < Minitest::Test
 
     else raise
     end
-    
+
     return last_set_value
   end
 end