bit-struct 0.13.5 → 0.17

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1cf35ff5b015befc041abc2494b386401d3c01e8a9c5712e3f61a428d182328
+  data.tar.gz: afbaee46ef4571da92e49ab6b428d60a6babfb846cf7309f274e4c05a2597d0c
+SHA512:
+  metadata.gz: d484839de3555a0389591c8a33727bed2f032b64161e4056d61263da319e6b3ca7e3e98bd5c1c8da3cd5e5773fb2a83475834530c756569cdbce5ac44584a068
+  data.tar.gz: dd2ba2763c4ceda28774b75d0fd52b7022700e64707adf6e3788c13164b5c77e85bb123d1085a64d2c4a4465cc0274807d92385dbee14cc988461fc23bfb4531

data/History.txt

@@ -1,3 +1,24 @@
+bit-struct 0.17
+
+- updated for ruby 3.0
+
+bit-struct 0.16
+
+- updated for ruby 2.4
+
+bit-struct 0.15
+
+- modernize rakefile and gemspec
+- switch to minitest
+
+bit-struct 0.14
+
+- updated for ruby 2.0
+
+bit-struct 0.13.6
+
+- Fixed bug in #to_a. Thanks Michael Edgar.
+
 bit-struct 0.13
 
 - Packaged as a gem using bones.
@@ -22,7 +43,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.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-2014, Joel VanderWerf.

data/Rakefile

@@ -1,38 +1,64 @@
-# 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 ###'
+require 'rake'
+require 'rake/testtask'
+
+PRJ = "bit-struct"
+
+def version
+  @version ||= begin
+    require 'bit-struct'
+    warn "BitStruct::VERSION not a string" unless
+      BitStruct::VERSION.kind_of? String
+    BitStruct::VERSION
   end
 end
 
-ensure_in_path 'lib'
-require 'bit-struct/bit-struct'
+def tag
+  @tag ||= "#{PRJ}-#{version}"
+end
+
+desc "Run unit tests"
+Rake::TestTask.new :test do |t|
+  t.libs << "lib"
+  t.test_files = FileList["test/*.rb"]
+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"
 
-#task :default => 'spec:run'
+  file = Tempfile.new "template"
+  begin
+    file.puts "release #{version}"
+    file.close
+    sh "git commit --allow-empty -a -v -t #{file.path}"
+  ensure
+    file.close unless file.closed?
+    file.unlink
+  end
 
-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]
+  sh "git tag #{tag}"
+  sh "git push"
+  sh "git push --tags"
+
+  sh "gem push #{tag}.gem"
+end
 
-PROJ.spec.opts << '--color'
-PROJ.test.files = Dir["test/*.rb"]
+namespace :release do
+  desc "Diff to latest release"
+  task :diff do
+    latest = `git describe --abbrev=0 --tags --match '#{PRJ}-*'`.chomp
+    sh "git diff #{latest}"
+  end
 
-task :release => ["gem:release", "doc:release"]
+  desc "Log to latest release"
+  task :log do
+    latest = `git describe --abbrev=0 --tags --match '#{PRJ}-*'`.chomp
+    sh "git log #{latest}.."
+  end
 
-# EOF
+  task :is_new_version do
+    abort "#{tag} exists; update version!" unless `git tag -l #{tag}`.empty?
+  end
+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