bin_struct 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aeb290e624ce4004c20cfaf40fc60ae43938c80eab8fd1df1e8aa908a75e26cf
-  data.tar.gz: 8cb5dd0abdce7421b8269a4d35c14886f57cc6440a50c924b0937e5b30fe20ce
+  metadata.gz: b6e644878c67b11f8006b130b0964a2349f0aa66645f2706cb97a20bf1ec6b77
+  data.tar.gz: 0bbf06e91de1bc410888f9c0e79f8caa0b7bb7f7082b5c775186c41c4a3d04db
 SHA512:
-  metadata.gz: ecf6acc2f5c406556598212d22ad6257d22ed646c1128a145cff1730dc537bb7acfd40903f211aad28b11fa30c11324a98b98ecebb70ad7b84ea991bcf181f25
-  data.tar.gz: 1dcfbb20a54f7c08d2794e0e8391b70c633d65f6ccbc41c372e46c77da6fb036fbfa9d1548462030b86603e3e41b132019da70b3c2d603f7f21116bdc842ec14
+  metadata.gz: c1bd8b95ce395af08b53ea41385929e9d06490d4ab21588dd46e02d8ba1d66207879174ec2f3a98400667446956042b581a032d93e8b9b97cc2d8448b20ced44
+  data.tar.gz: b81c04e4ddcf9a4bbe3af1b36735a5221014f69f43ef5d11c166d33e595aa989f0feb436ed2ba5547f42372c636383a5196c302f54548d0525d49057576f2467

data/CHANGELOG.md

@@ -3,6 +3,21 @@
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.5.0 - 2025-02-17
+
+### Added
+
+- Add `String#b` to mimic Ruby's `String`
+- Add a lot of examples in YARD documentation. These examples are checked using yard-doctest.
+
+### Deprecated
+
+- Deprecate `BinStruct.force_binary` and `Struct.force_binary` in favor of Ruby's `String#b`
+
+### Fixed
+
+- Fix `String#to_s` when static_length is set. `#to_s` was not aware of static length option.
+
 ## 0.4.0 - 2025-02-13
 
 ### Added

data/lib/bin_struct/abstract_tlv.rb

@@ -6,13 +6,10 @@
 # Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
 # This program is published under MIT license.
 
-# BinStruct module
-# @author LemonTree55
 module BinStruct
   # @abstract Base class to define type-length-value data.
   #
-  # ===Usage
-  # To simply define a new TLV class, do:
+  # You have to define a concrete class from AbstractTLV
   #   MyTLV = BinStruct::AbstractTLV.create
   #   MyTLV.define_type_enum 'one' => 1, 'two' => 2
   # This will define a new +MyTLV+ class, subclass of {AbstractTLV}. This class will
@@ -23,26 +20,33 @@ module BinStruct
   # +.define_type_enum+ is, here, necessary to define enum hash to be used
   # for +#type+ accessor, as this one is defined as an {Enum}.
   #
-  # This new defined class may now be easily used:
+  # @example Basic usage
+  #   MyTLV = BinStruct::AbstractTLV.create
+  #   MyTLV.define_type_enum 'one' => 1, 'two' => 2
+  #
   #   tlv = MyTLV.new(type: 1, value: 'abcd')  # automagically set #length from value
   #   tlv.type        #=> 1
   #   tlv.human_type  #=> 'one'
   #   tlv.length      #=> 4
   #   tlv.value       #=> "abcd"
   #
-  # ===Advanced usage
-  # Each attribute's type may be changed at generating TLV class:
+  # @example Change attribute types
+  #   # Change type for each attribute
+  #   # Type and length are 16-bit big endian integers
+  #   # Value is a OUI
   #   MyTLV = BinStruct::AbstractTLV.create(type_class: BinStruct::Int16,
   #                                         length_class: BinStruct::Int16,
-  #                                         value_class: PacketGen::Header::IP::Addr)
-  #   tlv = MyTLV.new(type: 1, value: '1.2.3.4')
+  #                                         value_class: BinStruct::OUI)
+  #   tlv = MyTLV.new(type: 1, value: '01:02:03')
   #   tlv.type        #=> 1
-  #   tlv.length      #=> 4
-  #   tlv.value       #=> '1.2.3.4'
-  #   tlv.to_s        #=> "\x00\x01\x00\x04\x01\x02\x03\x04"
+  #   tlv.length      #=> 3
+  #   tlv.value       #=> '01:02:03'
+  #   tlv.to_s        #=> "\x00\x01\x00\x03\x01\x02\x03"
   #
-  # Some aliases may also be defined. For example, to create a TLV type
-  # whose +type+ attribute should be named +code+:
+  # @example Using aliases
+  #   # Type and length are 16-bit big endian integers
+  #   # Value is a string
+  #   # code is an alias for type
   #   MyTLV = BinStruct::AbstractTLV.create(type_class: BinStruct::Int16,
   #                                         length_class: BinStruct::Int16,
   #                                         aliases: { code: :type })

data/lib/bin_struct/array.rb

@@ -87,6 +87,23 @@ module BinStruct
 
     # @param [Hash] options
     # @option options [Int] counter Int object used as a counter for this set
+    # @example counter example
+    #   # Define a counter
+    #   counter = BinStruct::Int8.new
+    #   counter.to_i # => 0
+    #
+    #   # Define an array with associated counter
+    #   ary = BinStruct::ArrayOfInt8.new(counter: counter)
+    #   # Add 2 elements to arry, increment counter twice
+    #   ary.read([1, 2])
+    #   counter.to_i #=> 2
+    #   # Add a third element
+    #   ary << BinStruct::Int8.new(value: 42)
+    #   counter.to_i #=> 3
+    #
+    #   # push does not increment the counter
+    #   ary.push(BinStruct::Int8.new(value: 100))
+    #   counter.to_i #=> 3
     def initialize(options = {})
       @counter = options[:counter]
       @array = []
@@ -271,30 +288,65 @@ module BinStruct
   end
 
   # Specialized {Array} to handle serie of {Int8}.
+  # @example
+  #   ary = BinStruct::ArrayOfInt8.new
+  #   ary.read([0, 1, 2])
+  #   ary.to_s #=> "\x00\x01\x02".b
+  #
+  #   ary.read("\x05\x06")
+  #   ary.map(&:to_i) #=> [5, 6]
   class ArrayOfInt8 < Array
     include ArrayOfIntMixin
     set_of Int8
   end
 
   # Specialized {Array} to handle serie of {Int16}.
+  # @example
+  #   ary = BinStruct::ArrayOfInt16.new
+  #   ary.read([0, 1, 2])
+  #   ary.to_s #=> "\x00\x00\x00\x01\x00\x02".b
+  #
+  #   ary.read("\x05\x06")
+  #   ary.map(&:to_i) #=> [0x0506]
   class ArrayOfInt16 < Array
     include ArrayOfIntMixin
     set_of Int16
   end
 
   # Specialized {Array} to handle serie of {Int16le}.
+  # @example
+  #   ary = BinStruct::ArrayOfInt16le.new
+  #   ary.read([0, 1, 2])
+  #   ary.to_s #=> "\x00\x00\x01\x00\x02\x00".b
+  #
+  #   ary.read("\x05\x06")
+  #   ary.map(&:to_i) #=> [0x0605]
   class ArrayOfInt16le < Array
     include ArrayOfIntMixin
     set_of Int16le
   end
 
   # Specialized {Array} to handle serie of {Int32}.
+  # @example
+  #   ary = BinStruct::ArrayOfInt32.new
+  #   ary.read([0, 1, 2])
+  #   ary.to_s #=> "\x00\x00\x00\x00\x00\x00\x00\x01\x00\x00\x00\x02".b
+  #
+  #   ary.read("\x00\x00\x05\x06")
+  #   ary.map(&:to_i) #=> [0x00000506]
   class ArrayOfInt32 < BinStruct::Array
     include ArrayOfIntMixin
     set_of Int32
   end
 
   # Specialized {Array} to handle serie of {Int32le}.
+  # @example
+  #   ary = BinStruct::ArrayOfInt32le.new
+  #   ary.read([0, 1, 2])
+  #   ary.to_s #=> "\x00\x00\x00\x00\x01\x00\x00\x00\x02\x00\x00\x00".b
+  #
+  #   ary.read("\x00\x00\x05\x06")
+  #   ary.map(&:to_i) #=> [0x06050000]
   class ArrayOfInt32le < BinStruct::Array
     include ArrayOfIntMixin
     set_of Int32le

data/lib/bin_struct/bit_attr.rb

@@ -7,13 +7,23 @@
 require 'digest'
 
 module BinStruct
-  # Define a bitfield attribute to embed in a {Struct}.
+  # Define a bitfield attribute to embed in a {Struct}. Use it through {Struct.define_bit_attr}
   #
+  # @example
   #  class MyStruct < BinStruct::Struct
   #    # Create a 32-bit bitfield attribute, with fields a (16 bits), b and c (4 bits each) and d (8 bits).
   #    # a is the leftmost field in bitfield, and d the rightmost one.
-  #    define_attr :int32, BinStruct::BitAttr.create(width: 32, a: 16, b: 4, c: 4, d:8)
+  #    define_bit_attr :int32, width: 32, a: 16, b: 4, c: 4, d:8
   #  end
+  #
+  #  s1 = MyStruct.new(int32: 0x12345678)
+  #  s1.a #=> 0x1234
+  #  s1.b #=> 5
+  #  s1.c #=> 6
+  #  s1.d #=> 0x78
+  #
+  #  s2 = MyStruct.new(a: 0x1234, d: 0x42)
+  #  s2.to_s #=> "\x12\x34\x00\x42".b
   # @since 0.3.0
   # @abstract Subclasses must de derived using {.create}.
   # @author LemonTree55

data/lib/bin_struct/cstring.rb

@@ -10,6 +10,9 @@ require 'forwardable'
 
 module BinStruct
   # This class handles null-terminated strings (aka C strings).
+  # # @example
+  #   cstr = BinStruct::CString.new(value: 'abcd')
+  #   cstr.to_s #=> "abcd\x00".b
   # @author Sylvain Daubert (2016-2024)
   # @author LemonTree55
   class CString
@@ -102,7 +105,7 @@ module BinStruct
       else
         s = "#{string}\x00"
       end
-      BinStruct.force_binary(s)
+      s.b
     end
 
     # Append the given string to CString
@@ -134,7 +137,7 @@ module BinStruct
     # @param [::String] str
     # @return [self]
     def from_human(str)
-      read str
+      read(str)
     end
 
     # Get human-readable string
@@ -146,8 +149,7 @@ module BinStruct
     private
 
     def register_internal_string(str)
-      @string = str
-      BinStruct.force_binary(@string)
+      @string = str.b
     end
 
     def remove_null_character

data/lib/bin_struct/enum.rb

@@ -12,21 +12,23 @@ module BinStruct
   # An {Enum} type is used to handle an {Int} attribute with limited
   # and named values.
   #
-  # == Simple example
-  #   enum = Int8Enum.new('low' => 0, 'medium' => 1, 'high' => 2})
-  # In this example, +enum+ is a 8-bit attribute which may take one
-  # among three values: +low+, +medium+ or +high+:
-  #   enum.value = 'high'
-  #   enum.value              # => 2
-  #   enum.value = 1
-  #   enum.value              # => 1
-  #   enum.to_human           # => "medium"
   # Setting an unknown name will raise an exception:
   #   enum.value = 'unknown'  # => raise!
   # But {#read} and {#value=} will not raise when reading/setting an out-of-bound integer. This
   # to enable decoding (or forging) of bad packets.
   #   enum.read("\x05".b).value # => 5
   #   enum.value = 4            # => 4
+  #
+  # @example Simple example
+  #   # Define an enum on 8-bit integer. It may take one among
+  #   # three values: low, medium or high
+  #   enum = BinStruct::Int8Enum.new(enum: {'low' => 0, 'medium' => 1, 'high' => 2})
+  #   enum.value = 'high'
+  #   enum.value              # => 2
+  #   enum.value = 1
+  #   enum.value              # => 1
+  #   enum.to_human           # => "medium"
+  #
   # @author Sylvain Daubert (2016-2024)
   # @author LemonTree55
   class Enum < Int

data/lib/bin_struct/length_from.rb

@@ -9,7 +9,7 @@
 module BinStruct
   # This module is a mixin adding +length_from+ capacity to a type.
   # +length_from+ capacity is the capacity, for a type, to gets its
-  # length from another object.
+  # length from another object. For an example, see {String}.
   # @author Sylvain Daubert (2016-2024)
   # @author LemonTree55
   module LengthFrom
@@ -30,7 +30,7 @@ module BinStruct
     # @param [#to_s] str
     # @return [::String]
     def read_with_length_from(str)
-      s = BinStruct.force_binary(str.to_s)
+      s = str.to_s.b
       s[0, sz_to_read]
     end
 

data/lib/bin_struct/oui.rb

@@ -8,10 +8,11 @@
 
 module BinStruct
   # OUI type, defined as a set of 3 bytes
-  #  oui = OUI.new
+  # @example
+  #  oui = BinStruct::OUI.new
   #  oui.from_human('00:01:02')
   #  oui.to_human   # => "00:01:02"
-  #  oui.to_s       # => "\x00\x01\x03"
+  #  oui.to_s       # => "\x00\x01\x02".b
   # @author Sylvain Daubert (2016-2024)
   # @author LemonTree55
   class OUI < Struct

data/lib/bin_struct/string.rb

@@ -10,6 +10,33 @@ require 'forwardable'
 
 module BinStruct
   # This class mimics regular String, but it is {Structable}.
+  #
+  # It may take its length from another field ({LengthFrom} capacity). It may also has a static length
+  # (i.e. string has always the same length, whatever its content is).
+  #
+  # @example Basic example
+  #   str = BinStruct::String.new
+  #   str.read("abc")
+  #   str.to_s #=> "abc".b
+  #
+  # @example LengthFrom example
+  #   class StrLen < BinStruct::Struct
+  #     define_attr :length, BinStruct::Int8
+  #     define_attr :str, BinStruct::String, builder: ->(h, t) { t.new(length_from: h[:length]) }
+  #   end
+  #
+  #   # Length is 3, but rest of data is 4 byte long. Only 3 bytes will be read.
+  #   s = StrLen.new.read("\x03abcd")
+  #   s.length #=> 3
+  #   s.str.to_s #=> "abc".b
+  #   s.to_s # => "\x03abc".b
+  #
+  # @example static length example
+  #   s = BinStruct::String.new(static_length: 10)
+  #   s.sz #=> 10
+  #   s.to_s #=> "\0\0\0\0\0\0\0\0\0\0".b
+  #   s.read("01234567890123456789")
+  #   s.to_s #=> "0123456789".b
   # @author Sylvain Daubert (2016-2024)
   # @author LemonTree55
   class String
@@ -19,7 +46,7 @@ module BinStruct
 
     def_delegators :@string, :[], :length, :size, :inspect, :==,
                    :unpack, :force_encoding, :encoding, :index, :empty?,
-                   :encode, :slice, :slice!, :[]=
+                   :encode, :slice, :slice!, :[]=, :b
 
     # Underlying Ruby String
     # @return [::String]
@@ -83,25 +110,29 @@ module BinStruct
     # @param [#to_s] str
     # @return [self]
     def <<(str)
-      @string << BinStruct.force_binary(str.to_s)
+      @string << str.to_s.b
       self
     end
 
     # Generate "binary" string
     # @return [::String]
     def to_s
-      @string
+      if static_length?
+        s = @string[0, static_length]
+        s << ("\x00" * (static_length - s.length))
+        s.b
+      else
+        @string.b
+      end
     end
 
-    alias sz length
     alias to_human to_s
     alias from_human read
 
     private
 
     def register_internal_string(str)
-      @string = str
-      BinStruct.force_binary(@string)
+      @string = str.b
     end
   end
 end

data/lib/bin_struct/struct.rb

@@ -32,8 +32,8 @@ module BinStruct
   # Attributes may also be accessed through {#[]} ans {#[]=}. These methods give access
   # to type object:
   #   mybs = MyBinaryStructure.new
-  #   mybs.attr1     # => Integer
-  #   mybs[:attr1]   # => BinStruct::Int8
+  #   mybs.attr1.class     # => Integer
+  #   mybs[:attr1].class   # => BinStruct::Int8
   #
   # {#initialize} accepts an option hash to populate attributes. Keys are attribute
   # name symbols, and values are those expected by writer accessor.
@@ -57,7 +57,7 @@ module BinStruct
   # +#body+, +#body=+, +#mac_addr+ and +#mac_addr=+.
   #
   # {.define_attr} has many options (third optional Hash argument):
-  # * +:default+ gives default attribute value. It may be a simple value (an Integer
+  # * +:default+ to define default attribute value. It may be a simple value (an Integer
   #   for an Int attribute, for example) or a lambda,
   # * +:builder+ to give a builder/constructor lambda to create attribute. The lambda
   #   takes 2 arguments: {Struct} subclass object owning attribute, and type class as passes
@@ -97,7 +97,7 @@ module BinStruct
   # * {.define_attr_before} and {.define_bit_attr_before} to define a new attribute before an existing one,
   # * {.define_attr_after} and {.define_bit_attr_after} to define a new attribute after an existing onr,
   # * {.remove_attr} to remove an existing attribute,
-  # * {.uptade_attr} to change options of an attribute (but not its type),
+  # * {.update_attr} to change options of an attribute (but not its type),
   #
   # @author Sylvain Daubert (2016-2024)
   # @author LemonTree55
@@ -247,7 +247,7 @@ module BinStruct
       #   class MyHeader < BinStruct::Struct
       #     # define a 16-bit attribute named :flag
       #     # flag1, flag2 and flag3 are 1-bit attributes
-      #     # type and stype are 3-bit attributes. reserved is a 7-bit attribute
+      #     # type and stype are 3-bit attributes, reserved is a 7-bit attribute
       #     define_bit_attr :flags, flag1: 1, flag2: 1, flag3: 1, type: 3, stype: 3, reserved: 7
       #   end
       # A bit attribute of size 1 bit defines 3 methods:
@@ -443,12 +443,11 @@ module BinStruct
     def read(str)
       return self if str.nil?
 
-      force_binary(str)
       start = 0
       attributes.each do |attr|
         next unless present?(attr)
 
-        obj = self[attr].read(str[start..])
+        obj = self[attr].read(str.b[start..])
         start += self[attr].sz
         self[attr] = obj unless obj == self[attr]
       end
@@ -480,7 +479,7 @@ module BinStruct
     # @return [String]
     def to_s
       attributes.select { |attr| present?(attr) }
-                .map! { |attr| force_binary @attributes[attr].to_s }.join
+                .map! { |attr| @attributes[attr].to_s.b }.join
     end
 
     # Size of object as binary string
@@ -531,6 +530,7 @@ module BinStruct
     # Force str to binary encoding
     # @param [String] str
     # @return [String]
+    # @deprecated Prefer use of Ruby's {::String#b}
     def force_binary(str)
       BinStruct.force_binary(str)
     end

data/lib/bin_struct/version.rb

@@ -8,5 +8,5 @@
 
 module BinStruct
   # BinStruct version
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/lib/bin_struct.rb

@@ -8,7 +8,31 @@
 
 require_relative 'bin_struct/version'
 
-# BinStruct module
+# BinStruct module provides classes to easily serialize/deserialize data to/from binary strings.
+# @example Basic example
+#   class MyData < BinStruct::Struct
+#     # Define 2 attributes as a 8-bit integer
+#     define_attr :byte1, BinStruct::Int8
+#     define_attr :byte2, BinStruct::Int8
+#     # Define an attribute as a 16-bit big endian integer
+#     define_attr :word, BinStruct::Int16
+#     # Define a 32-bit little endian integer attribute
+#     define_attr :dword, BinStruct::Int32le
+#     # Define a string prepending with its length (8-bit integer)
+#     define_attr :str, BinStruct::IntString
+#   end
+#
+#   # Generate binary data
+#   mydata = MyData.new(byte1: 1, byte2: 2, word: 3, dword: 4, str: 'abc')
+#   mydata.to_s  #=> "\x01\x02\x00\x03\x04\x00\x00\x00\x03abc".b
+#
+#   # Parse binary data
+#   mydata.read("\x00\xff\x01\x23\x11\x22\x33\x44\x00")
+#   mydata.byte1 #=> 0
+#   mydata.byte2 #=> 255
+#   mydata.word  #=> 0x0123
+#   mydata.dword #=> 0x44332211
+#   mydata.str #=> ""
 # @author LemonTree55
 module BinStruct
   # BinStruct error class
@@ -17,8 +41,9 @@ module BinStruct
   # Force binary encoding for +str+
   # @param [String] str
   # @return [String] binary encoded string
+  # @deprecated Use {::String#b} instead of this method
   def self.force_binary(str)
-    str.dup.force_encoding(Encoding::BINARY)
+    str.b
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bin_struct
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - LemonTree55
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-13 00:00:00.000000000 Z
+date: 2025-02-17 00:00:00.000000000 Z
 dependencies: []
 description: 'BinStruct is a binary dissector and generator. It eases manipulating
   complex binary data.