ronin-support 1.0.0.beta3 → 1.0.1

data/lib/ronin/support/binary/ctypes/arch/arm64.rb

@@ -23,6 +23,9 @@ module Ronin
     module Binary
       module CTypes
         module Arch
+          #
+          # Represents the C types for the ARM64 architecture.
+          #
           module ARM64
             include LittleEndian
 

data/lib/ronin/support/binary/ctypes/arch/mips/little_endian.rb

@@ -24,6 +24,10 @@ module Ronin
       module CTypes
         module Arch
           module MIPS
+            #
+            # Represents the C types for the MIPS architecture, in little-endian
+            # mode.
+            #
             module LittleEndian
               include CTypes::LittleEndian
 

data/lib/ronin/support/binary/ctypes/arch/mips.rb

@@ -23,6 +23,9 @@ module Ronin
     module Binary
       module CTypes
         module Arch
+          #
+          # Represents the C types for the MIPS architecture.
+          #
           module MIPS
             include BigEndian
 

data/lib/ronin/support/binary/ctypes/arch/mips64/little_endian.rb

@@ -24,6 +24,10 @@ module Ronin
       module CTypes
         module Arch
           module MIPS64
+            #
+            # Represents the C types for the MIPS64 architecture,
+            # in little-endian mode.
+            #
             module LittleEndian
               include CTypes::LittleEndian
 

data/lib/ronin/support/binary/ctypes/arch/mips64.rb

@@ -23,6 +23,9 @@ module Ronin
     module Binary
       module CTypes
         module Arch
+          #
+          # Represents the C types for the MIPS64 architecture.
+          #
           module MIPS64
             include BigEndian
 

data/lib/ronin/support/binary/ctypes/arch/ppc.rb

@@ -23,6 +23,9 @@ module Ronin
     module Binary
       module CTypes
         module Arch
+          #
+          # Represents the C types for the PPC architecture.
+          #
           module PPC
             include BigEndian
 

data/lib/ronin/support/binary/ctypes/arch/ppc64.rb

@@ -23,6 +23,9 @@ module Ronin
     module Binary
       module CTypes
         module Arch
+          #
+          # Represents the C types for the PPC64 architecture.
+          #
           module PPC64
             include BigEndian
 

data/lib/ronin/support/binary/ctypes/arch/x86.rb

@@ -23,6 +23,9 @@ module Ronin
     module Binary
       module CTypes
         module Arch
+          #
+          # Represents the C types for the x86 architecture.
+          #
           module X86
             include LittleEndian
 

data/lib/ronin/support/binary/ctypes/arch/x86_64.rb

@@ -23,6 +23,9 @@ module Ronin
     module Binary
       module CTypes
         module Arch
+          #
+          # Represents the C types for the x86-64 architecture.
+          #
           module X86_64
             include LittleEndian
 

data/lib/ronin/support/binary/ctypes/array_type.rb

@@ -60,7 +60,7 @@ module Ronin
           #   Custom type alignment to override the type's alignment.
           #
           def initialize(type,length, alignment: nil)
-            if type.class == UnboundedArrayType
+            if type.kind_of?(UnboundedArrayType)
               raise(ArgumentError,"cannot initialize an #{self.class} of #{UnboundedArrayType}")
             end
 

data/lib/ronin/support/binary/ctypes/big_endian.rb

@@ -33,6 +33,9 @@ module Ronin
   module Support
     module Binary
       module CTypes
+        #
+        # Represents the C types, but in big-endian byte-order.
+        #
         module BigEndian
           include CharTypes
 

data/lib/ronin/support/binary/ctypes/enum_type.rb

@@ -54,8 +54,8 @@ module Ronin
           def initialize(int_type,mapping)
             super(pack_string: nil)
 
-            @int_type = int_type
-            @mapping  = mapping
+            @int_type        = int_type
+            @mapping         = mapping
             @reverse_mapping = @mapping.invert
           end
 

data/lib/ronin/support/binary/ctypes/little_endian.rb

@@ -33,6 +33,9 @@ module Ronin
   module Support
     module Binary
       module CTypes
+        #
+        # Represents the C types, but in little-endian byte-order.
+        #
         module LittleEndian
           include CharTypes
 

data/lib/ronin/support/binary/ctypes/native.rb

@@ -32,6 +32,9 @@ module Ronin
   module Support
     module Binary
       module CTypes
+        #
+        # Represents the system's native C types.
+        #
         module Native
           include CharTypes
 

data/lib/ronin/support/binary/ctypes/scalar_type.rb

@@ -82,7 +82,7 @@ module Ronin
             @signed    = signed
           end
 
-          # 
+          #
           # Whether the scalar type is signed.
           #
           # @return [Boolean]
@@ -91,7 +91,7 @@ module Ronin
             @signed
           end
 
-          # 
+          #
           # Whether the scalar type is unsigned.
           #
           # @return [Boolean]

data/lib/ronin/support/binary/ctypes/struct_type.rb

@@ -214,9 +214,9 @@ module Ronin
           #   The uninitialized values for the new struct's members.
           #
           def uninitialized_value
-            Hash[@members.map { |name,member|
-              [name, member.type.uninitialized_value]
-            }]
+            @members.transform_values do |member|
+              member.type.uninitialized_value
+            end
           end
 
           #

data/lib/ronin/support/binary/ctypes/type_resolver.rb

@@ -155,9 +155,9 @@ module Ronin
           #
           def resolve_struct(type_signature)
             struct_class   = type_signature
-            struct_members = Hash[struct_class.members.map { |name,member|
-              [name, resolve(member.type_signature)]
-            }]
+            struct_members = struct_class.members.transform_values { |member|
+              resolve(member.type_signature)
+            }
 
             struct_type = StructType.build(
               struct_members, alignment: struct_class.alignment,
@@ -176,9 +176,9 @@ module Ronin
           #
           def resolve_union(type_signature)
             union_class   = type_signature
-            union_members = Hash[union_class.members.map { |name,member|
-              [name, resolve(member.type_signature)]
-            }]
+            union_members = union_class.members.transform_values { |member|
+              resolve(member.type_signature)
+            }
 
             union_type = UnionType.build(
               union_members, alignment: union_class.alignment
@@ -191,7 +191,7 @@ module Ronin
           # Resolves a type name.
           #
           # @param [Symbol] name
-          # 
+          #
           # @return [Type]
           #
           def resolve_symbol(name)
@@ -203,4 +203,3 @@ module Ronin
     end
   end
 end
-

data/lib/ronin/support/binary/ctypes/unbounded_array_type.rb

@@ -47,7 +47,7 @@ module Ronin
           #   Cannot initialize a nested {UnboundedArrayType}.
           #
           def initialize(type, alignment: nil)
-            if type.class == UnboundedArrayType
+            if type.kind_of?(UnboundedArrayType)
               raise(ArgumentError,"cannot initialize a nested #{UnboundedArrayType}")
             end
 

data/lib/ronin/support/binary/ctypes/union_type.rb

@@ -162,9 +162,9 @@ module Ronin
           #   The uninitialized values for the new union's members.
           #
           def uninitialized_value
-            Hash[@members.map { |name,member|
-              [name, member.type.uninitialized_value]
-            }]
+            @members.transform_values do |member|
+              member.type.uninitialized_value
+            end
           end
 
           #

data/lib/ronin/support/binary/ctypes.rb

@@ -61,7 +61,7 @@ module Ronin
       #   * Floating Point Types:
       #     * {CTypes::Float32Type float} (`-3.40282347E+38F` -
       #       `3.40282347E+38F`)
-      #     * {CTypes::Float64Type double} (`-1.79769313486231570E+308` - 
+      #     * {CTypes::Float64Type double} (`-1.79769313486231570E+308` -
       #       `1.79769313486231570E+308`)
       # * Aggregate Types:
       #   * {CTypes::ArrayType Array} (ex: `{1,2,3}`)
@@ -182,7 +182,7 @@ module Ronin
         UINT32_NET = Network::UINT32
         UINT64_NET = Network::UINT64
 
-        WORD_NET = Network::WORD
+        WORD_NET  = Network::WORD
         DWORD_NET = Network::DWORD
         QWORD_NET = Network::QWORD
 
@@ -390,7 +390,7 @@ module Ronin
           openbsd: OS::OpenBSD,
           netbsd:  OS::NetBSD,
 
-          linux:   OS:: Linux,
+          linux:   OS::Linux,
           macos:   OS::MacOS,
           windows: OS::Windows
         }

data/lib/ronin/support/binary/memory.rb

@@ -145,7 +145,7 @@ module Ronin
 
             case length
             when Integer then @string[index,length] = value
-            when nil     then @string[index] = value
+            when nil     then @string[index]        = value
             when Float::INFINITY
               @string[index,@string.length - index] = value
             else
@@ -157,7 +157,7 @@ module Ronin
         end
 
         #
-        # Returns a byte slice of the memory at the given offset and for the 
+        # Returns a byte slice of the memory at the given offset and for the
         # remainder of the memory.
         #
         # @param [Integer] offset

data/lib/ronin/support/binary/packet.rb

@@ -21,6 +21,9 @@ require 'ronin/support/binary/struct'
 module Ronin
   module Support
     module Binary
+      #
+      # Represents a network packet in network byte-order.
+      #
       class Packet < Binary::Struct
 
         platform endian: :net

data/lib/ronin/support/binary/stack.rb

@@ -152,7 +152,7 @@ module Ronin
                    else              index
                    end
 
-          if offset+@machine_word.size > @size
+          if (offset + @machine_word.size) > @size
             raise(IndexError,"index #{index} is out of bounds: 0...#{@size}")
           end
 
@@ -184,12 +184,11 @@ module Ronin
                    else              index
                    end
 
-          if offset+@machine_word.size > @size
+          if (offset + @machine_word.size) > @size
             raise(IndexError,"index #{index} is out of bounds: 0...#{@size}")
           end
 
-          data = @machine_word.pack(value)
-          @string[offset,@machine_word.size] = data
+          @string[offset,@machine_word.size] = @machine_word.pack(value)
           return value
         end
 

data/lib/ronin/support/binary/struct/member.rb

@@ -22,6 +22,9 @@ module Ronin
   module Support
     module Binary
       class Struct < Memory
+        #
+        # Represents a member defined within a {Struct}.
+        #
         class Member
 
           # The name of the structure member.
@@ -51,10 +54,9 @@ module Ronin
           #   The optional default value for the structure's field.
           #
           def initialize(name,type_signature, default: nil)
-            @name = name
+            @name           = name
             @type_signature = type_signature
-
-            @default = default
+            @default        = default
           end
 
           #