bit-struct 0.15.0 → 0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3fe95e9207bbe0468e22df2f4d2962fc13a97567
-  data.tar.gz: ff639098210a16fea1ec24b09dbd8185cf39aec6
+  metadata.gz: 8b4260733d87afeaad67a83a5e81bce6f5445885
+  data.tar.gz: 6d271698553f2cff7d062f9c095c9e395fbd7233
 SHA512:
-  metadata.gz: 4ad8d43e7500738629df54d3246c8e3506fde4e9162c7157b85a7a8664f3fb0cb6aad8d20445eba59be3de626717615d12ee62bac65f04c23d383e2827a5b8e1
-  data.tar.gz: e1874e18418b5f048c2dda2355e7023398fed5c6b0b76aaeb8f0bfc68b21b3fef88bcaf290b881f234bf4e3bbfd5180bbccfb8c7a62b8d53b325b1a09aa7e8cf
+  metadata.gz: 76fd8928a0eeb632b70e8b81c3a2ded19649659e9ede7473dd7ebbc3257ea1eb14ed8cbcc2150606f997394be8774eeee37870ae772388f5795af59bdc94d57f
+  data.tar.gz: 670298e1efc0da14c23efc1fedb00c27c6bf2f3488a85f6a70234b45ca7c3858961449def4840aca9fdb71aeeb70d99d00dcc6cdd9217e68229ccc48e9e23ae6

data/History.txt

@@ -1,3 +1,7 @@
+bit-struct 0.16
+
+- updated for ruby 2.4
+
 bit-struct 0.15
 
 - modernize rakefile and gemspec
@@ -35,7 +39,7 @@ bit-struct 0.10
 - Fixed a bug when calling #to_yaml on a BitStruct with a pad field. Thanks
   to Jay Reitz for reporting it and providing the solution.
 
-- Added BitStruct.default_options. Particularly useful for default endian 
+- Added BitStruct.default_options. Particularly useful for default endian
   settings--see examples/native.rb.
 
 - Fixed a bug that prevented warning about field name conflicts with

data/LICENSE

@@ -0,0 +1,56 @@
+bit-struct is copyrighted free software by Joel VanderWerf <vjoel@users.sourceforge.net>
+You can redistribute it and/or modify it under either the terms of the
+2-clause BSDL (see the file BSDL), or the conditions below:
+
+  1. You may make and give away verbatim copies of the source form of the
+     software without restriction, provided that you duplicate all of the
+     original copyright notices and associated disclaimers.
+
+  2. You may modify your copy of the software in any way, provided that
+     you do at least ONE of the following:
+
+       a) place your modifications in the Public Domain or otherwise
+          make them Freely Available, such as by posting said
+          modifications to Usenet or an equivalent medium, or by allowing
+          the author to include your modifications in the software.
+
+       b) use the modified software only within your corporation or
+          organization.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  3. You may distribute the software in object code or binary form,
+     provided that you do at least ONE of the following:
+
+       a) distribute the binaries and library files of the software,
+          together with instructions (in the manual page or equivalent)
+          on where to get the original distribution.
+
+       b) accompany the distribution with the machine-readable source of
+          the software.
+
+       c) give non-standard binaries non-standard names, with
+          instructions on where to get the original software distribution.
+
+       d) make other distribution arrangements with the author.
+
+  4. You may modify and include the part of the software into any other
+     software (possibly commercial).  But some files in the distribution
+     are not written by the author, so that they are not under these terms.
+
+     For the list of those files and their copying conditions, see the
+     file LEGAL.
+
+  5. The scripts and library files supplied as input to or produced as
+     output from the software do not automatically fall under the
+     copyright of the software, but belong to whomever generated them,
+     and may be sold commercially, and may be aggregated with this
+     software.
+
+  6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+     IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+     PURPOSE.

data/README.md

@@ -82,7 +82,7 @@ BitStruct is most efficient when your data is primarily treated as a binary stri
 * Fields that are not aligned on byte boundaries may cross no more than two bytes boundaries. (See examples/byte-bdy.rb.)
 
 * No variable length fields (except the #rest field).
- 
+
 ## Future plans ##
 
 * Currently, the library is written in pure ruby. The implementation uses Array#pack and String#unpack calls, as well as shifting and masking in pure ruby. Future versions will optionally generate a customized C extension for better efficiency.
@@ -186,4 +186,4 @@ This software is distributed under the Ruby license. See http://www.ruby-lang.or
 ## Author ##
 
 Joel VanderWerf, mailto:vjoel@users.sourceforge.net
-Copyright (c) 2005-2013, Joel VanderWerf.
+Copyright (c) 2005-2014, Joel VanderWerf.

data/Rakefile

@@ -25,7 +25,7 @@ end
 desc "Commit, tag, and push repo; build and push gem"
 task :release => "release:is_new_version" do
   require 'tempfile'
-  
+
   sh "gem build #{PRJ}.gemspec"
 
   file = Tempfile.new "template"
@@ -41,7 +41,7 @@ task :release => "release:is_new_version" do
   sh "git tag #{tag}"
   sh "git push"
   sh "git push --tags"
-  
+
   sh "gem push #{tag}.gem"
 end
 

data/examples/field-ripper.rb

@@ -13,7 +13,7 @@ end
 
 class BS2 < BitStruct
   fields_to_add = BS1.fields.select {|f| f.name.to_s =~ /[234]/}
-  
+
   fields_to_add.each do |field|
     add_field(field.name, field.length, field.options)
   end

data/examples/ip.rb

@@ -15,7 +15,7 @@ class IP < BitStruct
   rest        :body,            "Body of message"
 
   note "     rest is application defined message body"
-  
+
   initial_value.ip_v    = 4
   initial_value.ip_hl   = 5
 end
@@ -33,7 +33,7 @@ if __FILE__ == $0
   ip1.ip_dst = "192.168.1.255"
   ip1.body   = "This is the payload text."
   ip1.ip_len = ip1.length
-  
+
   ip2 = IP.new do |ip|
     ip.ip_tos = 0
     ip.ip_len = 0
@@ -47,7 +47,7 @@ if __FILE__ == $0
     ip.body   = "This is the payload text."
     ip.ip_len = ip.length
   end
-  
+
   ip3 = IP.new(
     :ip_tos => 0,
     :ip_len => 0,
@@ -62,15 +62,15 @@ if __FILE__ == $0
   ) do |ip|
     ip.ip_len = ip.length
   end
-  
+
   ip4 = IP.new(ip1) # Construct from a BitStruct (or String)
-  
+
   raise unless ip1 == ip2
   raise unless ip1 == ip3
   raise unless ip1 == ip4
 
   ip = ip1
-  
+
   puts ip.inspect
   puts "-"*50
   puts ip.inspect_detailed

data/examples/longlong.rb

@@ -10,8 +10,8 @@ pkt = MyPacket.new
 pkt.x = 59843759843759843
 pkt.y = 59843759843759843
 
-p pkt.x  # 59843759843759843           
-p pkt.y  # 59843759843759843           
+p pkt.x  # 59843759843759843
+p pkt.y  # 59843759843759843
 
 p pkt
 # #<MyPacket x=59843759843759843, y=59843759843759843>

data/examples/md.rb

@@ -18,6 +18,6 @@ md = MD.new
       row.col = cols
     rows[2] = row
   md.row = rows
-  
+
 p md
 p md.row[2].col[7].x

data/examples/modular-def.rb

@@ -6,7 +6,7 @@ module ModuleMethodSaver
     @saved ||= []
     @saved << [meth, args, block]
   end
-  
+
   def included(m)
     if @saved
       @saved.each do |meth, args, block|
@@ -21,7 +21,7 @@ require 'bit-struct'
 
 module M
   extend ModuleMethodSaver
-  
+
   unsigned  :x, 13
   signed    :y, 7
 end

data/examples/native.rb

@@ -6,15 +6,15 @@ class NativeNumbers < BitStruct
   unsigned   :x1,    13,  :endian => :native
   unsigned   :x2,    2,   :endian => :native
   unsigned   :x3,    32,  :endian => :native
-  
+
   float      :f1,    32,  :endian => :native
   float      :f2,    64,  :endian => :native
   float      :f3,    32
   float      :f4,    64
-  
+
   default_options :endian => :native
     # affects fields defined after this and in subclasses
-  
+
   unsigned    :y1,   32
 
 end

data/examples/ping.rb

@@ -61,7 +61,7 @@ addr = Socket.pack_sockaddr_in(1024, "localhost")
     b.ip_len  = b.length
     b.ip_sum  = 0 ## ?
   end
-  
+
   out = "-"*80,
         "packet sent:",
         icmp.inspect_detailed,

data/examples/raw.rb

@@ -50,7 +50,7 @@ addr = Socket.pack_sockaddr_in(1024, "localhost")
     b.ip_len  = b.length
     b.ip_sum  = 0 # linux will calculate this for us (QNX won't?)
   end
-  
+
   out = "-"*80,
         "packet sent:",
         ip.inspect_detailed,

data/examples/switch-endian.rb

@@ -3,7 +3,7 @@ module ModuleMethodSaver
     @saved ||= []
     @saved << [meth, args, block]
   end
-  
+
   def included(m)
     if @saved
       @saved.each do |meth, args, block|
@@ -18,7 +18,7 @@ require 'bit-struct'
 
 module MyFields
   extend ModuleMethodSaver
-  
+
   unsigned  :x, 16
 end
 

data/examples/vector.rb

@@ -5,7 +5,7 @@ class Vec < BitStruct::Vector
   # these declarations apply to *each* entry in the vector:
   unsigned :x,  16
   signed   :y,  32
-  
+
   Entry = struct_class # Give it a name, just for inspect to look nice
 end
 
@@ -72,7 +72,7 @@ puts
 # Example 4: vector field in a bitstruct
 class Packet < BitStruct
   unsigned :stuff, 32, "whatever"
-  
+
   # Using the Vec class defined above
   vector  :v, Vec, "a vector", 5
 

data/lib/bit-struct.rb

@@ -1,14 +1,3 @@
-# A Convenience to load all field classes and yaml handling.
-
-if "a"[0].kind_of? Fixnum
-  unless Fixnum.methods.include? :ord
-    class Fixnum
-      def ord; self; end
-    end
-  end
-end
-
 require 'bit-struct/bit-struct'
 require 'bit-struct/fields'
 require 'bit-struct/yaml'
-

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

@@ -9,100 +9,11 @@
 # The String#replace method is useful.
 #
 class BitStruct < String
-  VERSION = "0.15.0"
-
-  class Field
-    # Offset of field in bits.
-    attr_reader :offset
-    
-    # Length of field in bits.
-    attr_reader :length
-    alias size length
-    
-    # Name of field (used for its accessors).
-    attr_reader :name
-    
-    # Options, such as :default (varies for each field subclass).
-    # In general, options can be provided as strings or as symbols.
-    attr_reader :options
-    
-    # Display name of field (used for printing).
-    attr_reader :display_name
-    
-    # Default value.
-    attr_reader :default
-    
-    # Format for printed value of field.
-    attr_reader :format
-    
-    # Subclasses can override this to define a default for all fields of this
-    # class, not just the one currently being added to a BitStruct class, a
-    # "default default" if you will. The global default, if #default returns
-    # nil, is to fill the field with zero. Most field classes just let this
-    # default stand. The default can be overridden per-field when a BitStruct
-    # class is defined.
-    def self.default; nil; end
-
-    # Used in describe.
-    def self.class_name
-      @class_name ||= name[/\w+$/]
-    end
-    
-    # Used in describe. Can be overridden per-subclass, as in NestedField.
-    def class_name
-      self.class.class_name
-    end
-
-    # Yield the description of this field, as an array of 5 strings: byte
-    # offset, type, name, size, and description. The opts hash may have:
-    #
-    # :expand ::  if the value is true, expand complex fields
-    #
-    # (Subclass implementations may yield more than once for complex fields.)
-    #
-    def describe opts
-      bits = size
-      if bits > 32 and bits % 8 == 0
-        len_str = "%dB" % (bits/8)
-      else
-        len_str = "%db" % bits
-      end
-      
-      byte_offset = offset / 8 + (opts[:byte_offset] || 0)
+  VERSION = "0.16"
 
-      yield ["@%d" % byte_offset, class_name, name, len_str, display_name]
-    end
-
-    # Options are _display_name_, _default_, and _format_ (subclasses of Field
-    # may add other options).
-    def initialize(offset, length, name, opts = {})
-      @offset, @length, @name, @options =
-        offset, length, name, opts
-      
-      @display_name = opts[:display_name] || opts["display_name"]
-      @default      = opts[:default] || opts["default"] || self.class.default
-      @format       = opts[:format] || opts["format"]
-    end
-    
-    # Inspect the value of this field in the specified _obj_.
-    def inspect_in_object(obj, opts)
-      val = obj.send(name)
-      str =
-        begin
-          val.inspect_with_options(opts)
-        rescue NoMethodError
-          val.inspect
-        end
-      (f=@format) ? (f % str) : str
-    end
-    
-    # Normally, all fields show up in inspect, but some, such as padding,
-    # should not.
-    def inspectable?; true; end
-  end
-  
+  require 'bit-struct/field'
   NULL_FIELD = Field.new(0, 0, :null, :display_name => "null field")
-  
+
   # Raised when a field is added after an instance has been created. Fields
   # cannot be added after this point.
   class ClosedClassError < StandardError; end
@@ -110,9 +21,9 @@ class BitStruct < String
   # Raised if the chosen field name is not allowed, either because another
   # field by that name exists, or because a method by that name exists.
   class FieldNameError < StandardError; end
-  
+
   @default_options = {}
-  
+
   @initial_value = nil
   @closed = nil
   @rest_field = nil
@@ -127,7 +38,7 @@ class BitStruct < String
         @note = nil
       end
     end
-    
+
     # ------------------------
     # :section: field access methods
     #
@@ -139,7 +50,7 @@ class BitStruct < String
     def fields
       @fields ||= self == BitStruct ? [] : superclass.fields.dup
     end
-    
+
     # Return the list of fields defined by this class, not inherited
     # from the superclass.
     def own_fields
@@ -150,9 +61,9 @@ class BitStruct < String
     def add_field(name, length, opts = {})
       round_byte_length ## just to make sure this has been calculated
       ## before adding anything
-      
+
       name = name.to_sym
-      
+
       if @closed
         raise ClosedClassError, "Cannot add field #{name}: " +
           "The definition of the #{self.inspect} BitStruct class is closed."
@@ -169,9 +80,9 @@ class BitStruct < String
           raise FieldNameError,"Field #{name} is already defined as a method."
         end
       end
-      
+
       field_class = opts[:field_class]
-      
+
       prev = fields[-1] || NULL_FIELD
       offset = prev.offset + prev.length
       field = field_class.new(offset, length, name, opts)
@@ -194,13 +105,13 @@ class BitStruct < String
     def parse_options(ary, default_name, default_field_class) # :nodoc:
       opts = ary.grep(Hash).first || {}
       opts = default_options.merge(opts)
-      
+
       opts[:display_name]  = ary.grep(String).first || default_name
       opts[:field_class]   = ary.grep(Class).first || default_field_class
-      
+
       opts
     end
-    
+
     # Get or set the hash of default options for the class, which apply to all
     # fields. Changes take effect immediately, so can be used alternatingly with
     # blocks of field declarations. If +h+ is provided, update the default
@@ -214,17 +125,17 @@ class BitStruct < String
       end
       @default_options
     end
-    
+
     # Length, in bits, of this object.
     def bit_length
       @bit_length ||= fields.inject(0) {|a, f| a + f.length}
     end
-    
+
     # Length, in bytes (rounded up), of this object.
     def round_byte_length
       @round_byte_length ||= (bit_length/8.0).ceil
     end
-    
+
     def closed! # :nodoc:
       @closed = true
     end
@@ -239,17 +150,17 @@ class BitStruct < String
       field
     end
   end
-  
+
   # Return the list of fields for this class.
   def fields
     self.class.fields
   end
-  
+
   # Return the rest field for this class.
   def rest_field
     self.class.rest_field
   end
-  
+
   # Return the field with the given name.
   def field_by_name name
     self.class.field_by_name name
@@ -266,7 +177,7 @@ class BitStruct < String
     # Default format for describe. Fields are byte, type, name, size,
     # and description.
     DESCRIBE_FORMAT = "%8s: %-12s %-14s[%4s] %s"
-    
+
     # Can be overridden to use a different format.
     def describe_format
       DESCRIBE_FORMAT
@@ -279,7 +190,7 @@ class BitStruct < String
       if fmt.kind_of? Hash
         opts = fmt; fmt = nil
       end
-      
+
       if block_given?
         fields.each do |field|
           field.describe(opts) do |desc|
@@ -287,7 +198,7 @@ class BitStruct < String
           end
         end
         nil
-        
+
       else
         fmt ||= describe_format
 
@@ -311,7 +222,7 @@ class BitStruct < String
         result
       end
     end
-    
+
     # Subclasses can use this to append a string (or several) to the #describe
     # output. Notes are not cumulative with inheritance. When used with no
     # arguments simply returns the note string
@@ -320,7 +231,7 @@ class BitStruct < String
       @note
     end
   end
-  
+
   # ------------------------
   # :section: initialization and conversion methods
   #
@@ -339,9 +250,9 @@ class BitStruct < String
       value.each do |k, v|
         send "#{k}=", v
       end
-    
+
     when nil
-      
+
     else
       if value.respond_to?(:read)
         value = value.read(self.class.round_byte_length)
@@ -349,16 +260,16 @@ class BitStruct < String
 
       self[0, value.length] = value
     end
-    
+
     self.class.closed!
     yield self if block_given?
   end
-  
+
   DEFAULT_TO_H_OPTS = {
     :convert_keys   => :to_sym,
     :include_rest   => true
   }
-  
+
   # Returns a hash of {name=>value,...} for each field. By default, include
   # the rest field.
   # Keys are symbols derived from field names using +to_sym+, unless
@@ -370,13 +281,13 @@ class BitStruct < String
     if opts[:include_rest] and (rest_field = self.class.rest_field)
       fields_for_to_h += [rest_field]
     end
-    
+
     fields_for_to_h.inject({}) do |h,f|
       h[f.name.send(converter)] = send(f.name)
       h
     end
   end
-  
+
   # Returns an array of values of the fields of the BitStruct. By default,
   # include the rest field.
   def to_a(include_rest = true)
@@ -384,17 +295,16 @@ class BitStruct < String
       fields.map do |f|
         send(f.name)
       end
-    
+
     if include_rest and (rest_field = self.class.rest_field)
       ary << send(rest_field.name)
     end
     ary
   end
-  
-  ## temporary hack for 1.9
+
   if "a"[0].kind_of? String
     def [](*args)
-      if args.size == 1 and args[0].kind_of?(Fixnum)
+      if args.size == 1 and args[0].kind_of?(Integer)
         super.ord
       else
         super
@@ -402,14 +312,14 @@ class BitStruct < String
     end
 
     def []=(*args)
-      if args.size == 2 and (i=args[0]).kind_of?(Fixnum)
+      if args.size == 2 and (i=args[0]).kind_of?(Integer)
         super(i, args[1].chr)
       else
         super
       end
     end
   end
-  
+
   class << self
     # The unique "prototype" object from which new instances are copied.
     # The fields of this instance can be modified in the class definition
@@ -423,7 +333,7 @@ class BitStruct < String
     #
     def initial_value   # :yields: the initial value
       unless @initial_value
-        iv = defined?(superclass.initial_value) ? 
+        iv = defined?(superclass.initial_value) ?
           superclass.initial_value.dup : ""
         if iv.length < round_byte_length
           iv << "\0" * (round_byte_length - iv.length)
@@ -432,7 +342,7 @@ class BitStruct < String
         @initial_value = "" # Serves as initval while the real initval is inited
         @initial_value = new(iv)
         @closed = false # only creating the first _real_ instance closes.
-        
+
         fields.each do |field|
           @initial_value.send("#{field.name}=", field.default) if field.default
         end
@@ -440,7 +350,7 @@ class BitStruct < String
       yield @initial_value if block_given?
       @initial_value
     end
-    
+
     # Take +data+ (a string or BitStruct) and parse it into instances of
     # the +classes+, returning them in an array. The classes can be given
     # as an array or a separate arguments. (For parsing a string into a _single_
@@ -450,7 +360,7 @@ class BitStruct < String
         c.new(data.slice!(0...c.round_byte_length))
       end
     end
-    
+
     # Join the given structs (array or multiple args) as a string.
     # Actually, the inherited String#+ instance method is the same, as is using
     # Array#join.
@@ -474,7 +384,7 @@ class BitStruct < String
     :include_class    => true,
     :simple_format    => "<%s>"
   }
-  
+
   DETAILED_INSPECT_OPTS = {
     :format           => "%s:\n%s",
     :field_format     => "%30s = %s",
@@ -485,34 +395,34 @@ class BitStruct < String
     :include_class    => true,
     :simple_format    => "\n%s"
   }
-  
+
   # A standard inspect method which does not add newlines.
   def inspect_with_options(opts = DEFAULT_INSPECT_OPTS)
     field_format = opts[:field_format]
     field_name_meth = opts[:field_name_meth]
-    
+
     fields_for_inspect = fields.select {|field| field.inspectable?}
     if opts[:include_rest] and (rest_field = self.class.rest_field)
       fields_for_inspect << rest_field
     end
-    
+
     ary = fields_for_inspect.map do |field|
       field_format %
        [field.send(field_name_meth),
         field.inspect_in_object(self, opts)]
     end
-        
+
     body = ary.join(opts[:separator])
-    
+
     if opts[:include_class]
       opts[:format] % [self.class, body]
     else
       opts[:simple_format] % body
     end
   end
-  
+
   alias inspect inspect_with_options
-  
+
   # A more visually appealing inspect method that puts each field/value on
   # a separate line. Very useful when output is scrolling by on a screen.
   #
@@ -526,7 +436,7 @@ class BitStruct < String
   # :section: field declaration methods
   #
   # ------------------------
-  
+
   # Define accessors for a variable length substring from the end of
   # the defined fields to the end of the BitStruct. The _rest_ may behave as
   # a String or as some other String or BitStruct subclass.
@@ -544,13 +454,13 @@ class BitStruct < String
   # If a hash is provided, use it for options.
   #
   # *Warning*: the rest reader method returns a copy of the field, so
-  # accessors on that returned value do not affect the original rest field. 
+  # accessors on that returned value do not affect the original rest field.
   #
   def self.rest(name, *ary)
     if @rest_field
       raise ArgumentError, "Duplicate rest field: #{name.inspect}."
     end
-    
+
     opts = parse_options(ary, name, String)
     offset = round_byte_length
     byte_range = offset..-1
@@ -563,14 +473,14 @@ class BitStruct < String
       define_method "#{name}=" do |val|
         self[byte_range] = val
       end
-      
+
       @rest_field = Field.new(offset, -1, name, {
         :display_name => opts[:display_name],
         :rest_class => field_class
       })
     end
   end
-  
+
   # Not included with the other fields, but accessible separately.
   def self.rest_field; @rest_field; end
 end