bit-struct 0.13.6 → 0.14

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 608b421ed008ebeb58562339819ffcd658042440
+  data.tar.gz: 261e61fdd294f8ac987e52b7fbce9611d0ee9460
+SHA512:
+  metadata.gz: 7df8011e8550844695ef884a39a1f16afaf7e602633c6e518fe3ed869d9873f79b653881a8600b3fcc97dcd5e4e98d45d79d9f53f0b24de496d62d7992fd09a0
+  data.tar.gz: c906b109cc5a76d39fe06cbfcd36e84b870d8dd431bae19914d85ab8f545df9aed59579731533df552dc57707f96799126b6ea73de13c39c0a7e7278808c1027

data/History.txt

@@ -1,3 +1,7 @@
+bit-struct 0.14
+
+- updated for ruby 2.0
+
 bit-struct 0.13.6
 
 - Fixed bug in #to_a. Thanks Michael Edgar.

data/{README.txt → README.md}

@@ -1,4 +1,4 @@
-= BitStruct
+# BitStruct #
 
 Class for packed binary data stored in ruby Strings. BitStruct accessors, generated from user declared fields, use pack/unpack to treat substrings as fields with a specified portable format.
 
@@ -37,25 +37,25 @@ Field options (specifiable as :foo => val or "foo" => val) include:
 * *fixed*: float stored as fixed-point integer, with specified scale factor
 
 
-== Installation
+## Installation ##
 
 For .gem:
 
-  gem install bit-struct
+    gem install bit-struct
 
 For .tgz, unpack and then:
 
-  ruby install.rb config
-  ruby install.rb setup
-  ruby install.rb install
+    ruby install.rb config
+    ruby install.rb setup
+    ruby install.rb install
 
-== Uses
+## Uses ##
 
 BitStruct is useful for defining packets used in network protocols. This is especially useful for raw IP--see examples/ping-recv.rb. All multibyte numeric fields are stored by default in network order.
 
 BitStruct is most efficient when your data is primarily treated as a binary string, and only secondarily treated as a data structure. (For instance, you are routing packets from one socket to another, possibly looking at one or two fields as it passes through or munging some headers.) If accessor operations are a bottleneck, a better approach is to define a class that wraps an array and uses pack/unpack when the object needs to behave like a binary string.
 
-== Features
+## Features ##
 
 * Extensible with user-defined field classes.
 
@@ -77,13 +77,13 @@ BitStruct is most efficient when your data is primarily treated as a binary stri
 
 * Includes tests, examples, and rdoc API documentation.
 
-== Limitations
+## Limitations ##
 
 * 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
+## 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.
 
@@ -91,97 +91,99 @@ BitStruct is most efficient when your data is primarily treated as a binary stri
 
 * Remove field size and alignment limitations.
 
-== Example
+## Example ##
 
 An IP packet can be defined and used like this:
 
-  require 'bit-struct'
-
-  class IP < BitStruct
-    unsigned    :ip_v,     4,     "Version"
-    unsigned    :ip_hl,    4,     "Header length"
-    unsigned    :ip_tos,   8,     "TOS"
-    unsigned    :ip_len,  16,     "Length"
-    unsigned    :ip_id,   16,     "ID"
-    unsigned    :ip_off,  16,     "Frag offset"
-    unsigned    :ip_ttl,   8,     "TTL"
-    unsigned    :ip_p,     8,     "Protocol"
-    unsigned    :ip_sum,  16,     "Checksum"
-    octets      :ip_src,  32,     "Source addr"
-    octets      :ip_dst,  32,     "Dest addr"
-    rest        :body,            "Body of message"
-
-    note "     rest is application defined message body"
-
-    initial_value.ip_v    = 4
-    initial_value.ip_hl   = 5
-  end
-
-  ip = IP.new
-  ip.ip_tos = 0
-  ip.ip_len = 0
-  ip.ip_id  = 0
-  ip.ip_off = 0
-  ip.ip_ttl = 255
-  ip.ip_p   = 255
-  ip.ip_sum = 0
-  ip.ip_src = "192.168.1.4"
-  ip.ip_dst = "192.168.1.255"
-  ip.body   = "This is the payload text."
-  ip.ip_len = ip.length
-
-  puts ip.inspect
-  puts "-"*50
-  puts ip.inspect_detailed
-  puts "-"*50
-  puts IP.describe
+```ruby
+    require 'bit-struct'
+
+    class IP < BitStruct
+      unsigned    :ip_v,     4,     "Version"
+      unsigned    :ip_hl,    4,     "Header length"
+      unsigned    :ip_tos,   8,     "TOS"
+      unsigned    :ip_len,  16,     "Length"
+      unsigned    :ip_id,   16,     "ID"
+      unsigned    :ip_off,  16,     "Frag offset"
+      unsigned    :ip_ttl,   8,     "TTL"
+      unsigned    :ip_p,     8,     "Protocol"
+      unsigned    :ip_sum,  16,     "Checksum"
+      octets      :ip_src,  32,     "Source addr"
+      octets      :ip_dst,  32,     "Dest addr"
+      rest        :body,            "Body of message"
+
+      note "     rest is application defined message body"
+
+      initial_value.ip_v    = 4
+      initial_value.ip_hl   = 5
+    end
+
+    ip = IP.new
+    ip.ip_tos = 0
+    ip.ip_len = 0
+    ip.ip_id  = 0
+    ip.ip_off = 0
+    ip.ip_ttl = 255
+    ip.ip_p   = 255
+    ip.ip_sum = 0
+    ip.ip_src = "192.168.1.4"
+    ip.ip_dst = "192.168.1.255"
+    ip.body   = "This is the payload text."
+    ip.ip_len = ip.length
+
+    puts ip.inspect
+    puts "-"*50
+    puts ip.inspect_detailed
+    puts "-"*50
+    puts IP.describe
+```
 
 (Note that you can also construct an IP packet by passing a string to new, or by passing a hash of <tt>field,value</tt> pairs, or by providing a block that is yielded the new BitStruct.)
 
 The output of this fragment is:
 
-  #<IP ip_v=4, ip_hl=5, ip_tos=0, ip_len=45, ip_id=0, ip_off=0, ip_ttl=255, ip_p=255, ip_sum=0, ip_src="192.168.1.4", ip_dst="192.168.1.255", body="This is the payload text.">
-  --------------------------------------------------
-  IP:
-                         Version = 4
-                   Header length = 5
-                             TOS = 0
-                          Length = 45
-                              ID = 0
-                     Frag offset = 0
-                             TTL = 255
-                        Protocol = 255
-                        Checksum = 0
-                     Source addr = "192.168.1.4"
-                       Dest addr = "192.168.1.255"
-                 Body of message = "This is the payload text."
-  --------------------------------------------------
-
-  Description of IP Packet:
-      byte: type         name          [size] description
-  ----------------------------------------------------------------------
-        @0: unsigned     ip_v          [  4b] Version
-        @0: unsigned     ip_hl         [  4b] Header length
-        @1: unsigned     ip_tos        [  8b] TOS
-        @2: unsigned     ip_len        [ 16b] Length
-        @4: unsigned     ip_id         [ 16b] ID
-        @6: unsigned     ip_off        [ 16b] Frag offset
-        @8: unsigned     ip_ttl        [  8b] TTL
-        @9: unsigned     ip_p          [  8b] Protocol
-       @10: unsigned     ip_sum        [ 16b] Checksum
-       @12: octets       ip_src        [ 32b] Source addr
-       @16: octets       ip_dst        [ 32b] Dest addr
-       rest is application defined message body
-
-== Web site
-
-The current version of this software can be found at http://redshift.sourceforge.net/bit-struct.
-
-== License
+    #<IP ip_v=4, ip_hl=5, ip_tos=0, ip_len=45, ip_id=0, ip_off=0, ip_ttl=255, ip_p=255, ip_sum=0, ip_src="192.168.1.4", ip_dst="192.168.1.255", body="This is the payload text.">
+    --------------------------------------------------
+    IP:
+                           Version = 4
+                     Header length = 5
+                               TOS = 0
+                            Length = 45
+                                ID = 0
+                       Frag offset = 0
+                               TTL = 255
+                          Protocol = 255
+                          Checksum = 0
+                       Source addr = "192.168.1.4"
+                         Dest addr = "192.168.1.255"
+                   Body of message = "This is the payload text."
+    --------------------------------------------------
+
+    Description of IP Packet:
+        byte: type         name          [size] description
+    ----------------------------------------------------------------------
+          @0: unsigned     ip_v          [  4b] Version
+          @0: unsigned     ip_hl         [  4b] Header length
+          @1: unsigned     ip_tos        [  8b] TOS
+          @2: unsigned     ip_len        [ 16b] Length
+          @4: unsigned     ip_id         [ 16b] ID
+          @6: unsigned     ip_off        [ 16b] Frag offset
+          @8: unsigned     ip_ttl        [  8b] TTL
+          @9: unsigned     ip_p          [  8b] Protocol
+         @10: unsigned     ip_sum        [ 16b] Checksum
+         @12: octets       ip_src        [ 32b] Source addr
+         @16: octets       ip_dst        [ 32b] Dest addr
+         rest is application defined message body
+
+## Web site ##
+
+The current version of this software can be found at https://github.com/vjoel/bit-struct.
+
+## License ##
 
 This software is distributed under the Ruby license. See http://www.ruby-lang.org.
 
-== Author
+## Author ##
 
 Joel VanderWerf, mailto:vjoel@users.sourceforge.net
-Copyright (c) 2005-2009, Joel VanderWerf.
+Copyright (c) 2005-2013, Joel VanderWerf.

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

@@ -89,8 +89,8 @@ class BitStruct < String
       val = obj.send(name)
       str =
         begin
-          val.inspect(opts)
-        rescue ArgumentError # assume: "wrong number of arguments (1 for 0)"
+          val.inspect_with_options(opts)
+        rescue NoMethodError
           val.inspect
         end
       (f=@format) ? (f % str) : str
@@ -487,7 +487,7 @@ class BitStruct < String
   }
   
   # A standard inspect method which does not add newlines.
-  def inspect(opts = DEFAULT_INSPECT_OPTS)
+  def inspect_with_options(opts = DEFAULT_INSPECT_OPTS)
     field_format = opts[:field_format]
     field_name_meth = opts[:field_name_meth]
     
@@ -511,6 +511,8 @@ class BitStruct < String
     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.
   #

data/lib/bit-struct/vector.rb

@@ -153,7 +153,7 @@ class BitStruct::Vector < String
     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
@@ -166,6 +166,8 @@ class BitStruct::Vector < String
     lb, rb = opts[:brackets]
     [lb, s, rb].join
   end
+
+  alias inspect inspect_with_options
   
   def inspect_detailed
     inspect(BitStruct::DETAILED_INSPECT_OPTS)

data/lib/bit-struct/yaml.rb

@@ -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_as "tag:github.com:vjoel/bit-struct"
 
     def to_yaml_properties # :nodoc:
       yaml_fields = fields.select {|field| field.inspectable?}

metadata

@@ -1,127 +1,93 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: bit-struct
-version: !ruby/object:Gem::Version 
-  version: 0.13.6
+version: !ruby/object:Gem::Version
+  version: '0.14'
 platform: ruby
-authors: 
+authors:
 - Joel VanderWerf
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2009-07-27 00:00:00 -07:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: bones
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 2.5.1
-    version: 
-description: |
-  Library for packed binary data stored in ruby Strings. Useful for accessing fields in network packets and binary files.
-
+date: 2013-04-15 00:00:00.000000000 Z
+dependencies: []
+description: Library for packed binary data stored in ruby Strings. Useful for accessing
+  fields in network packets and binary files.
 email: vjoel@users.sourceforge.net
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - History.txt
-- README.txt
-files: 
-- .gitignore
+- README.md
+files:
 - History.txt
-- README.txt
-- Rakefile
-- TODO
-- examples/ara-player-data.rb
-- examples/bignum.rb
+- README.md
+- lib/bit-struct/pad-field.rb
+- lib/bit-struct/octet-field.rb
+- lib/bit-struct/fields.rb
+- lib/bit-struct/hex-octet-field.rb
+- lib/bit-struct/yaml.rb
+- lib/bit-struct/nested-field.rb
+- lib/bit-struct/char-field.rb
+- lib/bit-struct/unsigned-field.rb
+- lib/bit-struct/vector.rb
+- lib/bit-struct/bit-struct.rb
+- lib/bit-struct/float-field.rb
+- lib/bit-struct/vector-field.rb
+- lib/bit-struct/text-field.rb
+- lib/bit-struct/signed-field.rb
+- lib/bit-struct.rb
 - examples/bits.rb
-- examples/byte-bdy.rb
+- examples/nested-block.rb
+- examples/raw.rb
+- examples/md.rb
 - examples/field-ripper.rb
+- examples/ping-recv.rb
+- examples/switch-endian.rb
+- examples/pad.rb
+- examples/ara-player-data.rb
+- examples/rest.rb
 - examples/fixed-point.rb
-- examples/ip.rb
 - examples/longlong.rb
-- examples/md.rb
-- examples/modular-def.rb
-- examples/native.rb
-- examples/nested-block.rb
+- examples/vector.rb
+- examples/byte-bdy.rb
 - examples/nested.rb
-- examples/pad.rb
-- examples/ping-recv.rb
 - examples/ping.rb
+- examples/ip.rb
+- examples/modular-def.rb
+- examples/native.rb
 - examples/player-data.rb
-- examples/raw.rb
-- examples/rest.rb
-- examples/switch-endian.rb
-- examples/vector.rb
-- install.rb
-- lib/bit-struct.rb
-- lib/bit-struct/bit-struct.rb
-- lib/bit-struct/char-field.rb
-- lib/bit-struct/fields.rb
-- lib/bit-struct/float-field.rb
-- lib/bit-struct/hex-octet-field.rb
-- lib/bit-struct/nested-field.rb
-- lib/bit-struct/octet-field.rb
-- lib/bit-struct/pad-field.rb
-- lib/bit-struct/signed-field.rb
-- lib/bit-struct/text-field.rb
-- lib/bit-struct/unsigned-field.rb
-- lib/bit-struct/vector-field.rb
-- lib/bit-struct/vector.rb
-- lib/bit-struct/yaml.rb
-- tasks/ann.rake
-- tasks/bones.rake
-- tasks/gem.rake
-- tasks/git.rake
-- tasks/notes.rake
-- tasks/post_load.rake
-- tasks/rdoc.rake
-- tasks/rubyforge.rake
-- tasks/setup.rb
-- tasks/spec.rake
-- tasks/svn.rake
-- tasks/test.rake
-- tasks/zentest.rake
+- examples/bignum.rb
+- test/test.rb
 - test/test-endian.rb
 - test/test-vector.rb
-- test/test.rb
-has_rdoc: true
-homepage: http://rubyforge.org/projects/bit-struct/
+homepage: https://github.com/vjoel/bit-struct
 licenses: []
-
+metadata: {}
 post_install_message: 
-rdoc_options: 
+rdoc_options:
+- --quiet
+- --line-numbers
+- --inline-source
+- --title
+- BitStruct
 - --main
-- README.txt
-require_paths: 
+- README.md
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-  version: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: bit-struct
-rubygems_version: 1.3.5
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Library for packed binary data stored in ruby Strings
-test_files: 
-- test/test-endian.rb
-- test/test.rb
-- test/test-vector.rb
+test_files: []

data/.gitignore

@@ -1,3 +0,0 @@
-*.bck
-pkg/*
-doc/*

data/Rakefile

@@ -1,38 +0,0 @@
-# Look in the tasks/setup.rb file for the various options that can be
-# configured in this Rakefile. The .rake files in the tasks directory
-# are where the options are used.
-
-begin
-  require 'bones'
-  Bones.setup
-rescue LoadError
-  begin
-    load 'tasks/setup.rb'
-  rescue LoadError
-    raise RuntimeError, '### please install the "bones" gem ###'
-  end
-end
-
-ensure_in_path 'lib'
-require 'bit-struct/bit-struct'
-
-#task :default => 'spec:run'
-
-PROJ.name = 'bit-struct'
-PROJ.authors = 'Joel VanderWerf'
-PROJ.email = 'vjoel@users.sourceforge.net'
-PROJ.url = 'http://rubyforge.org/projects/bit-struct/'
-PROJ.version = BitStruct::VERSION
-PROJ.rubyforge.name = 'bit-struct'
-PROJ.summary = "Library for packed binary data stored in ruby Strings"
-PROJ.description = <<END
-Library for packed binary data stored in ruby Strings. Useful for accessing fields in network packets and binary files.
-END
-PROJ.changes = File.read(PROJ.history_file)[/^\w.*?(?=^\w)/m]
-
-PROJ.spec.opts << '--color'
-PROJ.test.files = Dir["test/*.rb"]
-
-task :release => ["gem:release", "doc:release"]
-
-# EOF

data/TODO

@@ -1,20 +0,0 @@
-rest :name, :terminator => ...
-
-easy way to define wrappers
-
-generate C code from bit-struct spec?
-
-write extension to extract and insert bit-fields, and use that instead
-  of pack/unpack
-
-variable-length embedded fields, with referenced length field
-
-terminated arrays?
-
-use with mmap; in general: bit struct that references a position in another string or string-like object (e.g. a Mmap).
-
-use require 'ipaddr'?
-
-See ideas in
-
-  http://www.notwork.org/~gotoken/ruby/p/as-is/pack.rb