bin_struct 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a90f75409d497521af8957e89577a4e8b7c14211e5343aa9126a71ef413d759
-  data.tar.gz: b07e2bf73d2cb1f4b7be4340944cd52df4382fc94f171607357adf10ddc7a914
+  metadata.gz: 44d43c8007a5ad33899e5c7ee6a09c306a64a95012bd489ee2d14d69c7e40dcf
+  data.tar.gz: db0b44a68cb8a23b1a5110cb12bb587c4cf4a737b42443f72c0ae9241fffa6c9
 SHA512:
-  metadata.gz: 6acd7aeb0516bf6692ae5971aecb10c8ae685936f24302d909ff16f055118a68588876409819d0ba966e4f3a7b524b194e58713bfb0ccaef95eb542fca221bb3
-  data.tar.gz: 790bf0b81cef084c030e0412731e3b0b852815fa1f66f5d28564278579e12b7e3fd3ef3674c6f36dd32bc792e1c248f7f20b3f65f505d3193f370b2d8c6f1d88
+  metadata.gz: 287f8dbf64a09b27b5fe376f9b6a982055713cdb2453ab7dd2b5ec0489678727441a3545427bb9f1f31d0ccc733bcc10e6af703fdc3b85b7cf539614b306bc21
+  data.tar.gz: cc3ba318afa6ac9706d57676256bbebeeec3b4dc52402728777b8c7a7fb89c9de8d893903b3e753d84a25aa6339b9aa919cfd4a223ff1f1a446a2d169047dee2

data/CHANGELOG.md

@@ -3,6 +3,27 @@
 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.3.0 - 2024-12-02
+
+### Added
+
+- `BitAddr` class is added. This class is used as a `Structable` type to handle bitfield attributes.
+- Add `Struct.define_bit_attr`, `.define_bit_attr_before` and `.define_bit_attr_before` to define bitfield attributes.
+
+### Changed
+
+- `Struct.define_bit_attr_on` is removed in favor of `Struct.define_bit_attr`. Bitfield attributes are now first class attributes, and no more an onverlay on `Int`.
+
+## 0.2.1 - 2024-11-25
+
+### Added
+
+- `CString` and `String` initializers now accepts `:value` option to set string initial value.
+
+### Changed
+
+- `IntString` initializer option `:string` is renamed into `:value`.
+
 ## 0.2.0 - 2024-07-21
 
 ### Changed

data/README.md

@@ -1,3 +1,6 @@
+[![Gem Version](https://badge.fury.io/rb/bin_struct.svg)](https://badge.fury.io/rb/bin_struct)
+[![Specs](https://github.com/lemontree55/bin_struct/actions/workflows/main.yml/badge.svg)](https://github.com/lemontree55/bin_struct/actions/workflows/main.yml)
+
 # BinStruct
 
 BinStruct provides a simple way to create and dissect binary data. It is an extraction from [PacketGen](https://github.com/lemontree55/packetgen) 3.x Fields.
@@ -6,9 +9,12 @@ BinStruct provides a simple way to create and dissect binary data. It is an extr
 
 Installation using RubyGems is easy:
 
-    $ gem install bin_struct
+```shell
+gem install bin_struct
+```
 
 Or add it to a Gemfile:
+
 ```ruby
 gem 'bin_struct'
 ```

data/lib/bin_struct/bit_attr.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+# This file is part of BinStruct
+# see https://github.com/lemontree55/bin_struct for more informations
+# Copyright (C) 2024 LemonTree55 <lenontree@proton.me>
+# This program is published under MIT license.
+require 'digest'
+
+module BinStruct
+  # Define a bitfield attribute to embed in a {Struct}.
+  #
+  #  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)
+  #  end
+  # @since 0.3.0
+  # @author LemonTree55
+  class BitAttr
+    include Structable
+
+    # @return [Integer] width in bits of bit attribute
+    attr_reader :width
+    # @return [Array[Symbol]]
+    attr_reader :bit_methods
+
+    # @private
+    Parameters = Struct.new(:width, :fields, :int)
+
+    class << self
+      @cache = {}
+
+      # @private
+      # @return [Parameters]
+      attr_reader :parameters
+
+      # Create a new {BitAttr} subclass with specified parameters
+      # @param [Integer] width size of bitfields in bits. Must be a size of an {Int} (8, 16, 24, 32 or 64 bits).
+      # @param [:big,:little,:native] endian endianess of bit attribute as an integer
+      # @param [Hash{Symbol=>Integer}] fields hash associating field names with their size. Total size MUST be equal
+      #    to +width+.
+      # @return [Class]
+      # @raise [ArgumentError] raise if:
+      #    * width is not a size of one of {Int} subclasses,
+      #    * sum of bitfield sizes is not equal to +width+
+      def create(width:, endian: :big, **fields)
+        raise ArgumentError, 'with must be 8, 16, 24, 32 or 64' unless [8, 16, 24, 32, 64].include?(width)
+
+        hsh = compute_hash(width, endian, fields)
+        cached = cache[hsh]
+        return cached if cached
+
+        total_size = fields.reduce(0) { |acc, ary| acc + ary.last }
+        raise ArgumentError, "sum of bitfield sizes is not equal to #{width}" unless total_size == width
+
+        cache[hsh] = Class.new(self) do
+          int_klass = BinStruct.const_get("Int#{width}")
+          @parameters = Parameters.new(width, fields, int_klass.new(endian: endian)).freeze
+        end
+      end
+
+      private
+
+      # @return [Hash{::String=>Class}]
+      def cache
+        return @cache if defined? @cache
+
+        @cache = {}
+      end
+
+      # @param [::Array] params
+      # @return [::String]
+      def compute_hash(*params)
+        Digest::MD5.digest(Marshal.dump(params))
+      end
+    end
+
+    # Initialize bit attribute
+    # @param [Hash{Symbol=>Integer}] opts initialization values for fields, where keys are field names and values are
+    #     initialization values
+    # @return [self]
+    def initialize(opts = {})
+      parameters = self.class.parameters
+      raise NotImplementedError, '#initialize may only be called on subclass of {self.class}' if parameters.nil?
+
+      @width = parameters.width
+      @fields = parameters.fields
+      @int = parameters.int.dup
+      @data = {}
+      @bit_methods = []
+
+      parameters.fields.each do |name, size|
+        @data[name] = opts[name] || 0
+        define_methods(name, size)
+      end
+      @bit_methods.freeze
+    end
+
+    # Get type name
+    # @return [::String]
+    def type_name
+      return @type_name if defined? @type_name
+
+      endian_suffix = case @int.endian
+                      when :big then ''
+                      when :little then 'le'
+                      when :native then 'n'
+                      end
+      @type_name = "BitAttr#{@width}#{endian_suffix}"
+    end
+
+    # Populate bit attribute from +str+
+    # @param [::String,nil] str
+    # @return [self]
+    def read(str)
+      return self if str.nil?
+
+      @int.read(str)
+      compute_data(@int.to_i)
+    end
+
+    # Give integer associated to this attribute
+    # @return [Integer]
+    def to_i
+      v = 0
+      @fields.each do |name, size|
+        v <<= size
+        v |= @data[name]
+      end
+
+      v
+    end
+    alias to_human to_i
+
+    # Return binary string
+    # @return [::String]
+    def to_s
+      @int.value = to_i
+      @int.to_s
+    end
+
+    # Set fields from associated integer
+    # @param [#to_i] value
+    # @return [self]
+    def from_human(value)
+      compute_data(value.to_i)
+    end
+
+    def format_inspect
+      str = @int.format_inspect << "\n"
+      str << @data.map { |name, value| "#{name}:#{value}" }.join(' ')
+    end
+
+    private
+
+    # @param [Integer] value
+    # @return [self]
+    def compute_data(value)
+      @fields.reverse_each do |name, size|
+        @data[name] = value & ((2**size) - 1)
+        value >>= size
+      end
+
+      self
+    end
+
+    # @param [Symbol] name
+    # @return [void]
+    def define_methods(name, size)
+      instance_eval "def #{name}; @data[#{name.inspect}]; end\n", __FILE__, __LINE__ # def name; data[:name]; end
+      bit_methods << name
+      bit_methods << :"#{name}="
+
+      # rubocop:disable Style/DocumentDynamicEvalDefinition
+      if size == 1
+        instance_eval "def #{name}?; @data[#{name.inspect}] != 0; end\n", __FILE__, __LINE__
+        instance_eval "def #{name}=(val); v = case val when TrueClass; 1 when FalseClass; 0 else val end; " \
+                      "@data[#{name.inspect}] = v; end", __FILE__, __LINE__ - 2
+        bit_methods << :"#{name}?"
+      else
+        instance_eval "def #{name}=(val); @data[#{name.inspect}] = val; end", __FILE__, __LINE__
+      end
+      # rubocop:enable Style/DocumentDynamicEvalDefinition
+    end
+  end
+end

data/lib/bin_struct/cstring.rb

@@ -76,8 +76,9 @@ module BinStruct
 
     # @param [Hash] options
     # @option options [Integer] :static_length set a static length for this string
+    # @option options [::String] :value string value (default to +''+)
     def initialize(options = {})
-      register_internal_string(+'')
+      register_internal_string(options[:value] || +'')
       @static_length = options[:static_length]
     end
 

data/lib/bin_struct/int_string.rb

@@ -20,9 +20,9 @@ module BinStruct
 
     # @param [Hash] options
     # @option options [Class] :length_type should be a {Int} subclass. Default to {Int8}.
-    # @option options [::String] :string String value. Default to +""+
+    # @option options [::String] :value String value. Default to +""+
     def initialize(options = {})
-      @string = BinStruct::String.new.read(options[:string] || '')
+      @string = BinStruct::String.new.read(options[:value] || +'')
       @length = (options[:length_type] || Int8).new
       calc_length
     end
@@ -61,7 +61,7 @@ module BinStruct
     # @return [::String]
     def string=(str)
       @length.value = str.to_s.size
-      @string = str.to_s
+      @string.read(str)
     end
 
     # Get binary string
@@ -82,7 +82,7 @@ module BinStruct
     # Get human readable string
     # @return [::String]
     def to_human
-      @string
+      @string.to_s
     end
 
     # Set length from internal string length

data/lib/bin_struct/string.rb

@@ -32,8 +32,9 @@ module BinStruct
     # @option options [Int,Proc] :length_from object or proc from which
     #   takes length when reading
     # @option options [Integer] :static_length set a static length for this string
+    # @option options [::String] :value string value (default to +''+)
     def initialize(options = {})
-      register_internal_string(+'')
+      register_internal_string(options[:value] || +'')
       initialize_length_from(options)
       @static_length = options[:static_length]
     end

data/lib/bin_struct/struct.rb

@@ -81,25 +81,23 @@ module BinStruct
   #   define_attr :opt1, BinStruct::Int16, optional: ->(h) { h.type == 42 }
   #
   # == Generating bit attributes
-  # {.define_bit_attr_on} creates bit attributes on a previously declared integer
-  # attribute. For example, +frag+ attribute in IP header:
-  #   define_attr :frag, BinStruct::Int16, default: 0
-  #   define_bit_attr_on :frag, :flag_rsv, :flag_df, :flag_mf, :fragment_offset, 13
+  # {.define_bit_attr} creates a bit attribute. For example, +frag+ attribute in IP header:
+  #   define_bit_attr :frag, flag_rsv: 1, flag_df: 1, flag_mf: 1, fragment_offset: 13
   #
   # This example generates methods:
   # * +#frag+ and +#frag=+ to access +frag+ attribute as a 16-bit integer,
   # * +#flag_rsv?+, +#flag_rsv=+, +#flag_df?+, +#flag_df=+, +#flag_mf?+ and +#flag_mf=+
   #   to access Boolean RSV, MF and DF flags from +frag+ attribute,
+  # * +#flag_rsv+, +#flag_df+ and +#flag_mf# to read RSV, MF and DF flags as Integer,
   # * +#fragment_offset+ and +#fragment_offset=+ to access 13-bit integer fragment
   #   offset subattribute from +frag+ attribute.
   #
   # == Creating a new Struct class from another one
   # Some methods may help in this case:
-  # * {.define_attr_before} to define a new attribute before an existing one,
-  # * {.define_attr_after} to define a new attribute after an existing onr,
-  # * {.remove_attribute} to remove an existing attribute,
-  # * {.uptade_fied} to change options of an attribute (but not its type),
-  # * {.remove_bit_attrs_on} to remove bit attribute definition.
+  # * {.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),
   #
   # @author Sylvain Daubert (2016-2024)
   # @author LemonTree55
@@ -121,7 +119,7 @@ module BinStruct
       # @return [Hash]
       attr_reader :attr_defs
       # Get bit attribute defintions for this class
-      # @return [Hash]
+      # @return [Hash{Symbol=>Array[Symbol]}]
       attr_reader :bit_attrs
 
       # On inheritage, create +@attr_defs+ class variable
@@ -198,11 +196,7 @@ module BinStruct
         define_attr name, type, options
         return if other.nil?
 
-        attributes.delete name
-        idx = attributes.index(other)
-        raise ArgumentError, "unknown #{other} attribute" if idx.nil?
-
-        attributes[idx, 0] = name
+        move_attr(name, before: other)
       end
 
       # Define an attribute, after another one
@@ -217,11 +211,7 @@ module BinStruct
         define_attr name, type, options
         return if other.nil?
 
-        attributes.delete name
-        idx = attributes.index(other)
-        raise ArgumentError, "unknown #{other} attribute" if idx.nil?
-
-        attributes[idx + 1, 0] = name
+        move_attr(name, after: other)
       end
 
       # Remove a previously defined attribute
@@ -229,9 +219,12 @@ module BinStruct
       # @return [void]
       def remove_attr(name)
         attributes.delete(name)
-        @attr_defs.delete(name)
+        attr_def = attr_defs.delete(name)
         undef_method name if method_defined?(name)
         undef_method :"#{name}=" if method_defined?(:"#{name}=")
+        return unless bit_attrs[name]
+
+        attr_def.type.new.bit_methods.each { |meth| undef_method(meth) }
       end
 
       # Update a previously defined attribute
@@ -250,64 +243,95 @@ module BinStruct
         attr_defs[name].options.merge!(options)
       end
 
-      # Define a bit attribute on given attribute
+      # Define a bit attribute
       #   class MyHeader < BinStruct::Struct
-      #     define_attr :flags, BinStruct::Int16
-      #     # define a bit attribute on :flag attribute
+      #     # 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 6-bit attribute
-      #     define_bit_attributes_on :flags, :flag1, :flag2, :flag3, :type, 3, :stype, 3, :reserved, 7
+      #     # 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 2 methods:
-      # * +#attr+ which returns a Boolean,
-      # * +#attr=+ which takes and returns a Boolean.
-      # A bit attribute of more bits defines 2 methods:
+      # A bit attribute of size 1 bit defines 3 methods:
+      # * +#attr+ which returns an Integer,
+      # * +#attr?+ which returns a Boolean,
+      # * +#attr=+ which accepts an Integer or a Boolean.
+      # A bit attribute of more bits defines only 2 methods:
       # * +#attr+ which returns an Integer,
-      # * +#attr=+ which takes and returns an Integer.
-      # @param [Symbol] attr attribute name (attribute should be a {BinStruct::Int}
-      #   subclass)
-      # @param [Array] args list of bit attribute names. Name may be followed
-      #   by bit size. If no size is given, 1 bit is assumed.
-      # @raise [ArgumentError] unknown +attr+
+      # * +#attr=+ which takes an Integer.
+      # @param [Symbol] attr attribute name
+      # @param [:big,:little,:native] endian endianess of Integer
+      # @param [Integer] default default value for whole attribute
+      # @param [Hash{Symbol=>Integer}] fields Hash defining fields. Keys are field names, values are field sizes.
       # @return [void]
-      def define_bit_attrs_on(attr, *args)
-        check_existence_of(attr)
-
-        type = attr_defs[attr].type
-        raise TypeError, "#{attr} is not a BinStruct::Int" unless type < Int
-
-        total_size = type.new.nbits
-        idx = total_size - 1
+      # @since 0.3.0
+      def define_bit_attr(attr, endian: :big, default: 0, **fields)
+        width = fields.reduce(0) { |acc, ary| acc + ary.last }
+        bit_attr_klass = BitAttr.create(width: width, endian: endian, **fields)
+        define_attr(attr, bit_attr_klass, default: default)
+        fields.each_key { |field| register_bit_attr_field(attr, field) }
+        bit_attr_klass.new.bit_methods.each do |meth|
+          if meth.to_s.end_with?('=')
+            define_method(meth) { |value| self[attr].send(meth, value) }
+          else
+            define_method(meth) { self[attr].send(meth) }
+          end
+        end
+      end
 
-        until args.empty?
-          arg = args.shift
-          next unless arg.is_a? Symbol
+      # Define a bit attribute, before another attribute
+      # @param [Symbol,nil] other attribute name to create a new one before.
+      #    If +nil+, new attribute is appended.
+      # @param [Symbol] name attribute name to create
+      # @param [:big,:little,:native] endian endianess of Integer
+      # @param [Hash{Symbol=>Integer}] fields Hash defining fields. Keys are field names, values are field sizes.
+      # @return [void]
+      # @since 0.3.0
+      # @see .define_bit_attr
+      def define_bit_attr_before(other, name, endian: :big, **fields)
+        define_bit_attr(name, endian: endian, **fields)
+        return if other.nil?
 
-          size = size_from(args)
+        move_attr(name, before: other)
+      end
 
-          unless attr == :_
-            add_bit_methods(attr, arg, size, total_size, idx)
-            register_bit_attr_size(attr, arg, size)
-          end
+      # Define a bit attribute after another attribute
+      # @param [Symbol,nil] other attribute name to create a new one after.
+      #    If +nil+, new attribute is appended.
+      # @param [Symbol] name attribute name to create
+      # @param [:big,:little,:native] endian endianess of Integer
+      # @param [Hash{Symbol=>Integer}] fields Hash defining fields. Keys are field names, values are field sizes.
+      # @return [void]
+      # @since 0.3.0
+      # @see .define_bit_attr
+      def define_bit_attr_after(other, name, endian: :big, **fields)
+        define_bit_attr(name, endian: endian, **fields)
+        return if other.nil?
 
-          idx -= size
-        end
+        move_attr(name, after: other)
       end
 
-      # Remove all bit attributes defined on +attr+
-      # @param [Symbol] attr attribute defining bit attributes
+      private
+
+      # @param [Symbol] name
+      # @param [Symbol,nil] before
+      # @param [Symbol,nil] after
       # @return [void]
-      def remove_bit_attrs_on(attr)
-        bits = bit_attrs.delete(attr)
-        return if bits.nil?
+      # @raise [ArgumentError] Both +before+ and +after+ are nil, or both are set.
+      def move_attr(name, before: nil, after: nil)
+        move_check_destination(before, after)
 
-        bits.each do |bit, size|
-          undef_method :"#{bit}="
-          undef_method(size == 1 ? "#{bit}?" : bit)
-        end
+        other = before || after
+        attributes.delete(name)
+        idx = attributes.index(other)
+        raise ArgumentError, "unknown #{other} attribute" if idx.nil?
+
+        idx += 1 unless after.nil?
+        attributes[idx, 0] = name
       end
 
-      private
+      def move_check_destination(before, after)
+        raise ArgumentError 'one of before: and after: arguments MUST be set' if before.nil? && after.nil?
+        raise ArgumentError 'only one of before and after argument MUST be set' if !before.nil? && !after.nil?
+      end
 
       def add_methods(name, type)
         define = []
@@ -328,73 +352,15 @@ module BinStruct
         class_eval define.join("\n")
       end
 
-      def add_bit_methods(attr, name, size, total_size, idx)
-        shift = idx - (size - 1)
-
-        if size == 1
-          add_single_bit_methods(attr, name, size, total_size, shift)
-        else
-          add_multibit_methods(attr, name, size, total_size, shift)
-        end
-      end
-
-      def compute_mask(size, shift)
-        ((2**size) - 1) << shift
-      end
-
-      def compute_clear_mask(total_size, mask)
-        ((2**total_size) - 1) & (~mask & ((2**total_size) - 1))
-      end
-
-      def add_single_bit_methods(attr, name, size, total_size, shift)
-        mask = compute_mask(size, shift)
-        clear_mask = compute_clear_mask(total_size, mask)
-
-        class_eval <<-METHODS, __FILE__, __LINE__ + 1
-          def #{name}?                                                  # def bit?
-            val = (self[:#{attr}].to_i & #{mask}) >> #{shift}           #   val = (self[:attr}].to_i & 1}) >> 1
-            val != 0                                                    #   val != 0
-          end                                                           # end
-          def #{name}=(v)                                               # def bit=(v)
-            val = v ? 1 : 0                                             #   val = v ? 1 : 0
-            self[:#{attr}].value = self[:#{attr}].to_i & #{clear_mask}  #   self[:attr].value = self[:attr].to_i & 0xfffd
-            self[:#{attr}].value |= val << #{shift}                     #   self[:attr].value |= val << 1
-          end                                                           # end
-        METHODS
-      end
-
-      def add_multibit_methods(attr, name, size, total_size, shift)
-        mask = compute_mask(size, shift)
-        clear_mask = compute_clear_mask(total_size, mask)
-
-        class_eval <<-METHODS, __FILE__, __LINE__ + 1
-          def #{name}                                                   # def multibit
-            (self[:#{attr}].to_i & #{mask}) >> #{shift}                 #   (self[:attr].to_i & 6) >> 1
-          end                                                           # end
-          def #{name}=(v)                                               # def multibit=(v)
-            self[:#{attr}].value = self[:#{attr}].to_i & #{clear_mask}  #   self[:attr].value = self[:attr].to_i & 0xfff9
-            self[:#{attr}].value |= (v & #{(2**size) - 1}) << #{shift}    #   self[:attr].value |= (v & 3) << 1
-          end                                                           # end
-        METHODS
-      end
-
-      def register_bit_attr_size(attr, name, size)
-        bit_attrs[attr] = {} if bit_attrs[attr].nil?
-        bit_attrs[attr][name] = size
+      def register_bit_attr_field(attr, field)
+        bit_attrs[attr] ||= []
+        bit_attrs[attr] << field
       end
 
       def attr_defs_property_from(attr, property, options)
         attr_defs[attr].send(:"#{property}=", options.delete(property)) if options.key?(property)
       end
 
-      def size_from(args)
-        if args.first.is_a? Integer
-          args.shift
-        else
-          1
-        end
-      end
-
       def check_existence_of(attr)
         raise ArgumentError, "unknown #{attr} attribute for #{self}" unless attr_defs.key?(attr)
       end
@@ -402,7 +368,7 @@ module BinStruct
 
     # Create a new Struct object
     # @param [Hash] options Keys are symbols. They should have name of object
-    #   attributes, as defined by {.define_attr} and by {.define_bit_attrs_on}.
+    #   attributes, as defined by {.define_attr} and by {.define_bit_attr}.
     def initialize(options = {})
       @attributes = {}
       @optional_attributes = {}
@@ -413,8 +379,8 @@ module BinStruct
         initialize_optional(attr)
       end
 
-      self.class.bit_attrs.each_value do |hsh|
-        hsh.each_key do |bit|
+      self.class.bit_attrs.each_value do |bit_fields|
+        bit_fields.each do |bit|
           send(:"#{bit}=", options[bit]) if options[bit]
         end
       end
@@ -599,26 +565,39 @@ module BinStruct
       end
     end
 
+    # @param [Symbol] attr
+    # @return [void]
     def initialize_optional(attr)
       optional = attr_defs[attr].optional
       @optional_attributes[attr] = optional if optional
     end
 
+    # @return [String]
     def inspect_titleize
       title = self.class.to_s
       +"-- #{title} #{'-' * (66 - title.length)}\n"
     end
 
+    # @param [:Symbol] attr
+    # @param [Structable] value
+    # @param [Integer] level
+    # @return [::String]
     def inspect_attribute(attr, value, level = 1)
-      type = value.class.to_s.sub(/.*::/, '')
-      inspect_format(type, attr, value.format_inspect, level)
-    end
-
-    def inspect_format(type, attr, value, level = 1)
       str = inspect_shift_level(level)
-      str << (FMT_ATTR % [type, attr, value])
+      value_lines = value.format_inspect.split("\n")
+      str << (FMT_ATTR % [value.type_name, attr, value_lines.shift])
+      return str if value_lines.empty?
+
+      shift = (FMT_ATTR % ['', '', 'START']).index('START')
+      value_lines.each do |l|
+        str << inspect_shift_level(level)
+        str << (' ' * shift) << l << "\n"
+      end
+      str
     end
 
+    # @param [Integer] level
+    # @return [String]
     def inspect_shift_level(level = 1)
       '  ' * (level + 1)
     end

data/lib/bin_struct/structable.rb

@@ -58,7 +58,7 @@ module BinStruct
     # Format object when inspecting a {Struct} object
     # @return [::String]
     def format_inspect
-      to_human
+      to_human.to_s
     end
   end
 end

data/lib/bin_struct/version.rb

@@ -8,5 +8,5 @@
 
 module BinStruct
   # BinStruct version
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/bin_struct.rb

@@ -25,6 +25,7 @@ end
 require_relative 'bin_struct/structable'
 require_relative 'bin_struct/int'
 require_relative 'bin_struct/enum'
+require_relative 'bin_struct/bit_attr'
 require_relative 'bin_struct/struct'
 require_relative 'bin_struct/length_from'
 require_relative 'bin_struct/abstract_tlv'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bin_struct
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - LemonTree55
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-21 00:00:00.000000000 Z
+date: 2024-12-02 00:00:00.000000000 Z
 dependencies: []
 description: 'BinStruct is a binary dissector and generator. It eases manipulating
   complex binary data.
@@ -26,6 +26,7 @@ files:
 - lib/bin_struct.rb
 - lib/bin_struct/abstract_tlv.rb
 - lib/bin_struct/array.rb
+- lib/bin_struct/bit_attr.rb
 - lib/bin_struct/cstring.rb
 - lib/bin_struct/enum.rb
 - lib/bin_struct/int.rb