bin_struct 0.1.0 → 0.2.0

data/lib/bin_struct/length_from.rb

@@ -10,16 +10,16 @@ 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.
-  # @author Sylvain Daubert
-  # @since 3.0.0
+  # @author Sylvain Daubert (2016-2024)
+  # @author LemonTree55
   module LengthFrom
     # Max value returned by {#sz_to_read}.
     MAX_SZ_TO_READ = 65_535
 
-    # Initialize +length from+ capacity.
-    # Should be call by extensed object's initialize.
+    # Initialize +length_from+ capacity.
+    # Should be called by extended object's initialize method.
     # @param [Hash] options
-    # @option options [Types::Int,Proc] :length_from object or proc from which
+    # @option options [Int,Proc] :length_from object or proc from which
     #   takes length when reading
     # @return [void]
     def initialize_length_from(options)
@@ -28,7 +28,7 @@ module BinStruct
 
     # Return a substring from +str+ of length given in another object.
     # @param [#to_s] str
-    # @return [String]
+    # @return [::String]
     def read_with_length_from(str)
       s = BinStruct.force_binary(str.to_s)
       s[0, sz_to_read]

data/lib/bin_struct/oui.rb

@@ -11,23 +11,26 @@ module BinStruct
   #  oui = OUI.new
   #  oui.from_human('00:01:02')
   #  oui.to_human   # => "00:01:02"
-  # @author Sylvain Daubert
-  class OUI < Fields
-    include Fieldable
+  #  oui.to_s       # => "\x00\x01\x03"
+  # @author Sylvain Daubert (2016-2024)
+  # @author LemonTree55
+  class OUI < Struct
+    include Structable
 
     # @attribute b2
     #  @return [Integer] left-most byte
-    define_field :b2, Int8
+    define_attr :b2, Int8
     # @attribute b1
     #  @return [Integer] center byte
-    define_field :b1, Int8
+    define_attr :b1, Int8
     # @attribute b0
     #  @return [Integer] right-most byte
-    define_field :b0, Int8
+    define_attr :b0, Int8
 
     # Read a human-readable string to populate object
-    # @param [String] str
-    # @return [OUI] self
+    # @param [::String] str
+    # @return [self]
+    # @raise [ArgumentError] OUI cannot be recognized from +str+
     def from_human(str)
       return self if str.nil?
 
@@ -41,9 +44,9 @@ module BinStruct
     end
 
     # Get OUI in human readable form (colon-separated bytes)
-    # @return [String]
+    # @return [::String]
     def to_human
-      fields.map { |m| '%02x' % self[m] }.join(':')
+      attributes.map { |m| '%02x' % self[m] }.join(':')
     end
   end
 end

data/lib/bin_struct/string.rb

@@ -9,25 +9,27 @@
 require 'forwardable'
 
 module BinStruct
-  # This class mimics regular String, but it is {Fieldable}.
-  # @author Sylvain Daubert
-  # @since 3.1.6 no more a subclass or regular String
+  # This class mimics regular String, but it is {Structable}.
+  # @author Sylvain Daubert (2016-2024)
+  # @author LemonTree55
   class String
     extend Forwardable
-    include Fieldable
+    include Structable
     include LengthFrom
 
-    def_delegators :@string, :[], :to_s, :length, :size, :inspect, :==,
+    def_delegators :@string, :[], :length, :size, :inspect, :==,
                    :unpack, :force_encoding, :encoding, :index, :empty?,
                    :encode, :slice, :slice!, :[]=
 
+    # Underlying Ruby String
     # @return [::String]
     attr_reader :string
+    # String static length, if set
     # @return [Integer]
     attr_reader :static_length
 
     # @param [Hash] options
-    # @option options [Types::Int,Proc] :length_from object or proc from which
+    # @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
     def initialize(options = {})
@@ -36,15 +38,19 @@ module BinStruct
       @static_length = options[:static_length]
     end
 
+    # Initialize object on copying:
+    # * duplicate underlying Ruby String
+    # @return [void]
     def initialize_copy(_orig)
       @string = @string.dup
     end
 
+    # Populate String from a binary String. Limit length using {LengthFrom} or {#static_length}, if one is set.
     # @param [::String] str
-    # @return [String] self
+    # @return [self]
     def read(str)
       s = read_with_length_from(str)
-      register_internal_string s
+      register_internal_string(s)
       self
     end
 
@@ -52,9 +58,8 @@ module BinStruct
     private :old_sz_to_read
 
     # Size to read.
-    # Computed from static_length or length_from, if defined.
+    # Computed from {#static_length} or +length_from+, if one defined.
     # @return [Integer]
-    # @since 3.1.6
     def sz_to_read
       return static_length if static_length?
 
@@ -63,11 +68,12 @@ module BinStruct
 
     # Say if a static length is defined
     # @return [Boolean]
-    # @since 3.1.6
     def static_length?
       !static_length.nil?
     end
 
+    # Format String when inspecting from a {Struct}
+    # @return [::String]
     def format_inspect
       inspect
     end
@@ -76,10 +82,16 @@ module BinStruct
     # @param [#to_s] str
     # @return [self]
     def <<(str)
-      @string << str.to_s
+      @string << BinStruct.force_binary(str.to_s)
       self
     end
 
+    # Generate binary string
+    # @return [::String]
+    def to_s
+      @string
+    end
+
     alias sz length
     alias to_human to_s
     alias from_human read