bit-struct 0.13.2 → 0.13.3

data/History.txt

@@ -4,6 +4,8 @@ bit-struct 0.13
 
 - Added nest fields defined with blocks.
 
+- Vector length may be specified as argument or :length option.
+
 bit-struct 0.12
 
 - Added vectors.

data/Rakefile

@@ -31,4 +31,6 @@ END
 
 PROJ.spec.opts << '--color'
 
+task :release => ["gem:release", "doc:release"]
+
 # EOF

data/TODO

@@ -1,3 +1,5 @@
+rest :name, :terminator => ...
+
 easy way to define wrappers
 
 generate C code from bit-struct spec?

data/examples/vector.rb

@@ -74,10 +74,10 @@ class Packet < BitStruct
   unsigned :stuff, 32, "whatever"
   
   # Using the Vec class defined above
-  vector  :v, Vec, "a vector", :length => 5
+  vector  :v, Vec, "a vector", 5
 
   # equivalently, using an anonymous subclass of BitStruct::Vector
-  vector :v2, "a vector 2", :length => 5 do
+  vector :v2, "a vector 2", 5 do
     unsigned :x,  16
     signed   :y,  32
   end

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

@@ -9,7 +9,7 @@
 # The String#replace method is useful.
 #
 class BitStruct < String
-  VERSION = "0.13.2"
+  VERSION = "0.13.3"
 
   class Field
     # Offset of field in bits.

data/lib/bit-struct/fields.rb

@@ -233,6 +233,8 @@ class BitStruct
     #
     # If a string is provided, use it for the display_name.
     # If a hash is provided, use it for options.
+    # If a number is provided, use it for length (equivalent to using the
+    # :length option).
     #
     # WARNING: the accessors have COPY semantics, not reference. When you call a
     # reader method to get the vector structure, you get a *copy* of that data.
@@ -274,9 +276,11 @@ class BitStruct
       
       vector_class.default_options default_options
       
-      length = opts[:length] ## what about :length => :lenfield
+      length = opts[:length] || rest.grep(Integer).first
+        ## what about :length => :lenfield
       unless length
-        raise ArgumentError, "Must provide length as :length => N"
+        raise ArgumentError,
+          "Must provide length as argument N or as option :length => N"
       end
 
       opts[:default] ||= vector_class.new(length) ## nil if variable length

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bit-struct
 version: !ruby/object:Gem::Version 
-  version: 0.13.2
+  version: 0.13.3
 platform: ruby
 authors: 
 - Joel VanderWerf
@@ -41,7 +41,6 @@ files:
 - README.txt
 - Rakefile
 - TODO
-- TODO-ALSO
 - examples/ara-player-data.rb
 - examples/bignum.rb
 - examples/bits.rb

data/TODO-ALSO

@@ -1,54 +0,0 @@
-rest :name, :terminator => ...
-
-> * Is explicit :length for vector necessary?
-> 
->   class Tag < BitStruct
->     signed  :flags, 32
->     vector  :axis, Vec, :length => 3
->   end
-> 
-> compared to
-> 
->   class Tag < BitStruct
->     signed  :flags, 32
->     vector  :axis, Vec, 3
->   end
-> 
-> Or am I missing any ambiguities because of the simple cases?
-
-Nothing ambiguous, I just get giddy when there are too many positional args. But since length is required, it does make sense to pass it as a positional arg. I'll change that...
-
-> * Allow length not only in bits, but also bytes?
-> 
-> In my cases I've never encountered a situation where I needed a member
-> of a structure to represent anything which is not on a byte boundary.
-
-Sigh, if only life we always like that. There's a reason I call the library _bit_-struct :)
-
-> All my signed and unsigned int have to read "32" (32bit, 4bytes) all
-> over the place. For strings I'm writing "64*8" for string with 64
-> characters.
-> 
-> How about a new default_option :granularity which is "1" by default.
-> When set to "8", every specified length (except for vector ...) is
-> multiplied by that factor before used?
-
-Hm, will think about that. I wish I could define Fixnum#bytes, but only in the context of field declarations in a BitStruct subclass.
-
-I don't like granularity because it's really only meaningful if the value is 1 or 8. Perhaps :granularity => :bit, or :granularity => :byte. But I still don't like an option that you have to keep in mind to understand whether
-
-  char :x, 80
-  
-is 8 or 80 chars. It's too much context sensitivity.
-
-What about
-
-  signed :x, bytes(4)
-
-Is that too clunky? It would be trivial to implement...
-
-> * Why "vector" and not just "array"?
-
-For consistency with things like NArray, which has Vector, Matrix, and Array classes, where vectors are essentially one-dim arrays.
-
-Also, "array" might lead to confusion with ruby arrays.