bit-struct 0.13.5 → 0.17

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,8 +152,8 @@ class BitStruct::Vector < String
       yield self[i]
     end
   end
-  
-  def inspect(opts = BitStruct::DEFAULT_INSPECT_OPTS)
+
+  def inspect_with_options(opts = BitStruct::DEFAULT_INSPECT_OPTS)
     if opts[:include_class]
       opts = opts.dup
       opts[:include_class] = false
@@ -161,12 +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
 
@@ -27,8 +27,27 @@ class BitStruct
       end
     end
 
+  elsif RUBY_VERSION =~ /^2\./
+    def encode_with coder
+      yaml_fields = fields.select {|field| field.inspectable?}
+      props = yaml_fields.map {|f| f.name.to_s}
+      if (rest_field = self.class.rest_field)
+        props << rest_field.name.to_s
+      end
+      props.each do |prop|
+        coder[prop] = send(prop)
+      end
+    end
+
+    def init_with coder
+      self << self.class.initial_value
+      coder.map.each do |k, v|
+        send("#{k}=", v)
+      end
+    end
+
   else
-    yaml_as "tag:path.berkeley.edu,2006:bitstruct"
+    yaml_tag "tag:github.com:vjoel/bit-struct"
 
     def to_yaml_properties # :nodoc:
       yaml_fields = fields.select {|field| field.inspectable?}
@@ -55,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

@@ -1,28 +1,28 @@
-require 'test/unit'
+require 'minitest/autorun'
 require 'bit-struct'
 
-class Test_Endian < Test::Unit::TestCase
+class Test_Endian < Minitest::Test
   class Endian < BitStruct
     unsigned  :f_big,       32,   :endian => :big
     unsigned  :f_little,    32,   :endian => :little
     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