bin_struct 0.5.2 → 0.5.3

data/lib/bin_struct/enum.rb

@@ -36,7 +36,7 @@ module BinStruct
     # @return [Hash{::String => Integer}]
     attr_reader :enum
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @see Int#initialize
     # @option options [Hash{::String => Integer}] :enum enumerated values. Default value is taken from
     #   first element unless given. This option is mandatory.
@@ -52,7 +52,7 @@ module BinStruct
     end
 
     # Setter for value attribute
-    # @param [#to_i, String,nil] value value as an Integer or as a String
+    # @param value [#to_i, String,nil] value as an Integer or as a String
     #   from enumration
     # @return [Integer]
     # @raise [ArgumentError] String value is unknown
@@ -89,7 +89,7 @@ module BinStruct
   # Enumeration on one byte. See {Enum}.
   # @author LemonTree55
   class Int8Enum < Enum
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Hash{::String => Integer}] :enum enumerated values. Default value is taken from
     #   first element unless given. This option is mandatory.
     # @option options [Integer,::String] :value
@@ -106,7 +106,7 @@ module BinStruct
   # Enumeration on 2-byte integer. See {Enum}.
   # @author LemonTree55
   class Int16Enum < Enum
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Hash{::String => Integer}] :enum enumerated values. Default value is taken from
     #   first element unless given. This option is mandatory.
     # @option options [:big,:little] :endian
@@ -127,7 +127,7 @@ module BinStruct
   class Int16beEnum < Int16Enum
     undef endian=
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Hash{::String => Integer}] :enum enumerated values. Default value is taken from
     #   first element unless given. This option is mandatory.
     # @option options [Integer,::String] :value
@@ -145,7 +145,7 @@ module BinStruct
   class Int16leEnum < Int16Enum
     undef endian=
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Hash{::String => Integer}] :enum enumerated values. Default value is taken from
     #   first element unless given. This option is mandatory.
     # @option options [Integer,::String] :value
@@ -160,7 +160,7 @@ module BinStruct
   # Enumeration on 4-byte integer. See {Enum}.
   # @author LemonTree55
   class Int32Enum < Enum
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Hash{::String => Integer}] :enum enumerated values. Default value is taken from
     #   first element unless given. This option is mandatory.
     # @option options [:big,:little] :endian
@@ -181,7 +181,7 @@ module BinStruct
   class Int32beEnum < Int32Enum
     undef endian=
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Hash{::String => Integer}] :enum enumerated values. Default value is taken from
     #   first element unless given. This option is mandatory.
     # @option options [Integer,::String] :value
@@ -199,7 +199,7 @@ module BinStruct
   class Int32leEnum < Int32Enum
     undef endian=
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Hash{::String => Integer}] :enum enumerated values. Default value is taken from
     #   first element unless given. This option is mandatory.
     # @option options [Integer,::String] :value

data/lib/bin_struct/int.rb

@@ -18,7 +18,7 @@ module BinStruct
     # @return [Integer,nil]
     attr_accessor :value
     # Integer endianness
-    # @return [:little,:big,:native,nil]
+    # @return [Symbol,nil] +:big:, +:little+, +:native+ or +nil+
     attr_accessor :endian
     # Integer size, in bytes
     # @return [Integer]
@@ -27,9 +27,9 @@ module BinStruct
     # @return [Integer]
     attr_accessor :default
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer, nil] :value Value to set Int to
-    # @option options [:little,:big,:native,nil] :endian Int's endianess
+    # @option options [Symbol,nil] :endian Int's endianess
     # @option options [Integer,nil] :width Int's width in bytes
     # @option options [Integer] :default Default value to use when {#value} is not set (Default to +0+).
     # @author LemonTree55
@@ -42,7 +42,7 @@ module BinStruct
 
     # @abstract
     # Read an Int from a binary string or an integer
-    # @param [#to_s] str
+    # @param str [#to_s]
     # @return [self]
     # @raise [Error] when reading +#to_s+ objects with abstract Int class.
     # @author LemonTree55
@@ -70,7 +70,7 @@ module BinStruct
     alias to_human to_i
 
     # Initialize value from an Integer.
-    # @param [Integer] value
+    # @param value [Integer]
     # @return [self]
     def from_human(value)
       @value = value
@@ -103,6 +103,8 @@ module BinStruct
 
     private
 
+    # Format string, tailord to integer {#width}
+    # @return [String]
     def format_str
       "%-16s (0x%0#{width * 2}x)"
     end
@@ -111,7 +113,7 @@ module BinStruct
   # One byte unsigned integer
   # @author LemonTree55
   class Int8 < Int
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer,nil] :value
     def initialize(options = {})
       options[:endian] = nil
@@ -124,7 +126,7 @@ module BinStruct
   # One byte signed integer
   # @author LemonTree55
   class SInt8 < Int
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer,nil] :value
     def initialize(options = {})
       options[:endian] = nil
@@ -138,7 +140,7 @@ module BinStruct
   # @author Sylvain Daubert (2016-2024)
   # @author LemonTree55
   class Int16 < Int
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer,nil] :value
     # @option options [:big,:little,:native] :endian
     def initialize(options = {})
@@ -160,7 +162,7 @@ module BinStruct
   class Int16le < Int16
     undef endian=
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer,nil] :value
     def initialize(options = {})
       opts = { value: options[:value], endian: :little }
@@ -173,7 +175,7 @@ module BinStruct
   class Int16n < Int16
     undef endian=
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer,nil] :value
     def initialize(options = {})
       opts = { value: options[:value], endian: :native }
@@ -185,7 +187,7 @@ module BinStruct
   # @author Sylvain Daubert (2016-2024)
   # @author LemonTree55
   class SInt16 < Int16
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer,nil] :value
     # @option options [:big,:little,:native] :endian
     def initialize(options = {})
@@ -207,7 +209,7 @@ module BinStruct
   class SInt16le < SInt16
     undef endian=
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer,nil] :value
     # @author LemonTree55
     def initialize(options = {})
@@ -222,7 +224,7 @@ module BinStruct
   class SInt16n < SInt16
     undef endian=
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer,nil] :value
     def initialize(options = {})
       opts = { value: options[:value], endian: :native }
@@ -233,7 +235,7 @@ module BinStruct
   # 3-byte unsigned integer
   # @author LemonTree55
   class Int24 < Int
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer,nil] :value
     # @option options [:big, :little, :native] :endian
     def initialize(options = {})
@@ -252,7 +254,7 @@ module BinStruct
     end
 
     # Read a 3-byte Int from a binary string
-    # @param [::String] value
+    # @param value [::String]
     # @return [self]
     def read(value)
       return self if value.nil?
@@ -291,7 +293,7 @@ module BinStruct
   class Int24le < Int24
     undef endian=
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer] :value
     def initialize(options = {})
       opts = { value: options[:value], endian: :little }
@@ -304,7 +306,7 @@ module BinStruct
   class Int24n < Int24
     undef endian=
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer] :value
     def initialize(options = {})
       opts = { value: options[:value], endian: :little }
@@ -315,7 +317,7 @@ module BinStruct
   # 4-byte unsigned integer
   # @author LemonTree55
   class Int32 < Int
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer,nil] :value
     # @option options [:big,:little,:native] :endian
     def initialize(options = {})
@@ -336,7 +338,7 @@ module BinStruct
   class Int32le < Int32
     undef endian=
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer,nil] :value
     def initialize(options = {})
       opts = { value: options[:value], endian: :little }
@@ -349,7 +351,7 @@ module BinStruct
   class Int32n < Int32
     undef endian=
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer,nil] :value
     def initialize(options = {})
       opts = { value: options[:value], endian: :native }
@@ -360,7 +362,7 @@ module BinStruct
   # 4-byte signed integer
   # @author LemonTree55
   class SInt32 < Int32
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer] :value
     # @option options [:big,:little,:native] :endian
     def initialize(options = {})
@@ -381,7 +383,7 @@ module BinStruct
   class SInt32le < SInt32
     undef endian=
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer] :value
     def initialize(options = {})
       opts = { value: options[:value], endian: :little }
@@ -394,7 +396,7 @@ module BinStruct
   class SInt32n < SInt32
     undef endian=
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer] :value
     def initialize(options = {})
       opts = { value: options[:value], endian: :native }
@@ -405,7 +407,7 @@ module BinStruct
   # 8-byte unsigned integer
   # @author LemonTree55
   class Int64 < Int
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer] :value
     # @option options [:big,:little,:native] :endian
     def initialize(options = {})
@@ -428,7 +430,7 @@ module BinStruct
   class Int64le < Int64
     undef endian=
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer] :value
     def initialize(options = {})
       opts = { value: options[:value], endian: :little }
@@ -441,7 +443,7 @@ module BinStruct
   class Int64n < Int64
     undef endian=
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer] :value
     def initialize(options = {})
       opts = { value: options[:value], endian: :native }
@@ -452,7 +454,7 @@ module BinStruct
   # 8-byte signed integer
   # @author LemonTree55
   class SInt64 < Int64
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer] :value
     # @option options [:big,:little,:native] :endian
     def initialize(options = {})
@@ -473,7 +475,7 @@ module BinStruct
   class SInt64le < SInt64
     undef endian=
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer] :value
     def initialize(options = {})
       opts = { value: options[:value], endian: :little }
@@ -486,7 +488,7 @@ module BinStruct
   class SInt64n < SInt64
     undef endian=
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Integer] :value
     def initialize(options = {})
       opts = { value: options[:value], endian: :native }

data/lib/bin_struct/int_string.rb

@@ -25,7 +25,7 @@ module BinStruct
     # @return [::String]
     attr_reader :string
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Class] :length_type should be a {Int} subclass. Default to {Int8}.
     # @option options [::String] :value String value. Default to +""+
     def initialize(options = {})
@@ -35,26 +35,27 @@ module BinStruct
     end
 
     # Populate IntString from a binary String
-    # @param [::String] str
+    # @param str [::String]
     # @return [self]
     def read(str)
+      return self if str.nil?
+
+      str = str.b
       unless str[0, @length.width].size == @length.width
         raise Error,
-              "String too short for type #{@length.class.to_s.gsub(/.*::/, '')}"
+              "String too short for #{@length.width}-byte length"
       end
-      @length.read str[0, @length.width]
-      @string.read str[@length.width, @length.to_i]
+      @length.read(str[0, @length.width])
+      @string.read(str[@length.width, @length.to_i])
       self
     end
 
     # Set length
-    # @param [Integer] len
+    # @param len [Integer]
     # @return [Integer]
     def length=(len)
       @length.from_human(len)
-      # rubocop:disable Lint/Void
-      len
-      # rubocop:enable Lint/Void
+      len # rubocop:disable Lint/Void
     end
 
     # Get length as registered in +IntLength+
@@ -64,10 +65,10 @@ module BinStruct
     end
 
     # Set string without setting {#length}
-    # @param [#to_s] str
+    # @param str [#to_s]
     # @return [::String]
     def string=(str)
-      @length.value = str.to_s.size
+      @length.value = str.to_s.bytesize
       @string.read(str)
     end
 
@@ -78,7 +79,7 @@ module BinStruct
     end
 
     # Set from a human readable string
-    # @param [::String] str
+    # @param str [::String]
     # @return [self]
     def from_human(str)
       @string.read(str)

data/lib/bin_struct/length_from.rb

@@ -18,7 +18,7 @@ module BinStruct
 
     # Initialize +length_from+ capacity.
     # Should be called by extended object's initialize method.
-    # @param [Hash] options
+    # @param options [Hash]
     # @option options [Int,Proc] :length_from object or proc from which
     #   takes length when reading
     # @return [void]
@@ -27,7 +27,7 @@ module BinStruct
     end
 
     # Return a substring from +str+ of length given in another object.
-    # @param [#to_s] str
+    # @param str [#to_s]
     # @return [::String]
     def read_with_length_from(str)
       s = str.to_s.b

data/lib/bin_struct/oui.rb

@@ -29,7 +29,7 @@ module BinStruct
     define_attr :b0, Int8
 
     # Read a human-readable string to populate object
-    # @param [::String] str
+    # @param str [::String]
     # @return [self]
     # @raise [ArgumentError] OUI cannot be recognized from +str+
     def from_human(str)

data/lib/bin_struct/string.rb

@@ -55,7 +55,7 @@ module BinStruct
     # @return [Integer]
     attr_reader :static_length
 
-    # @param [Hash] options
+    # @param options [Hash]
     # @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
@@ -68,13 +68,12 @@ module BinStruct
 
     # Initialize object on copying:
     # * duplicate underlying Ruby String
-    # @return [void]
-    def initialize_copy(_orig)
+    def initialize_copy(*)
       @string = @string.dup
     end
 
     # Populate String from a binary String. Limit length using {LengthFrom} or {#static_length}, if one is set.
-    # @param [::String,nil] str
+    # @param str [::String,nil]
     # @return [self]
     def read(str)
       s = read_with_length_from(str)
@@ -107,7 +106,7 @@ module BinStruct
     end
 
     # Append the given string to String
-    # @param [#to_s] str
+    # @param str [#to_s]
     # @return [self]
     def <<(str)
       @string << str.to_s.b
@@ -131,6 +130,8 @@ module BinStruct
 
     private
 
+    # @param str [String]
+    # @return [void]
     def register_internal_string(str)
       @string = str.b
     end