ronin-support 0.5.2 → 1.0.0.beta2

data/lib/ronin/{extensions → support/core_ext}/string.rb

@@ -1,7 +1,6 @@
+# frozen_string_literal: true
 #
-# Copyright (c) 2006-2021 Hal Brodigan (postmodern.mod3 at gmail.com)
-#
-# This file is part of ronin-support.
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
 #
 # ronin-support is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Lesser General Public License as published
@@ -19,6 +18,51 @@
 
 class String
 
+  #
+  # Creates a new ASCII encoding string.
+  #
+  # @param [String] string
+  #   The string to convert to ASCII.
+  #
+  # @return [String]
+  #   The new ASCII encoded string.
+  #
+  # @api public
+  #
+  # @since 1.0.0
+  #
+  def self.ascii(string)
+    string.encode(Encoding::ASCII_8BIT)
+  end
+
+  #
+  # Converts the string into an ASCII encoded string.
+  #
+  # @return [String]
+  #   The new ASCII string.
+  #
+  # @api public
+  #
+  # @since 1.0.0
+  #
+  def to_ascii
+    encode(Encoding::ASCII_8BIT)
+  end
+
+  #
+  # Converts the string into an UTF-8 encoded string.
+  #
+  # @return [String]
+  #   The new UTF-8 string.
+  #
+  # @api public
+  #
+  # @since 1.0.0
+  #
+  def to_utf8
+    encode(Encoding::UTF_8)
+  end
+
   #
   # Enumerates over every sub-string within the string.
   #
@@ -162,18 +206,6 @@ class String
     return ''
   end
 
-  #
-  # @deprecated
-  #   Deprecates as of 0.2.0, and will be removed in 1.0.0.
-  #   Please use {#common_suffix} instead.
-  #
-  def common_postfix(other)
-    warn 'DEPRECATED: String#common_postfix was deprecated in 0.2.0.'
-    warn 'DEPRECATED: Please use String#common_suffix instead.'
-
-    common_suffix(other)
-  end
-
   #
   # Finds the uncommon sub-string within the specified other string,
   # which does not occur within the string.
@@ -193,48 +225,76 @@ class String
     return self[prefix.length...(length - postfix.length)]
   end
 
-  if RUBY_VERSION < '1.9.'
-    # Special ASCII bytes and their escaped character forms
-    ESCAPE_BYTES = Hash.new do |escape,byte|
-      escape[byte] = if (byte >= 0x20 && byte <= 0x7e)
-                       byte.chr
-                     else
-                       "\\x%.2X" % byte
-                     end
-    end
+  #
+  # Inserts data before the occurrence of a pattern.
+  #
+  # @param [String, Regexp] pattern
+  #   The pattern to search for.
+  #
+  # @param [String] data
+  #   The data to insert before the pattern.
+  #
+  # @return [String]
+  #   The new modified String.
+  #
+  # @api public
+  #
+  def insert_before(pattern,data)
+    string = dup
+    index  = string.index(pattern)
 
-    ESCAPE_BYTES[0x00] = '\0'
-    ESCAPE_BYTES[0x07] = '\a'
-    ESCAPE_BYTES[0x08] = '\b'
-    ESCAPE_BYTES[0x09] = '\t'
-    ESCAPE_BYTES[0x0a] = '\n'
-    ESCAPE_BYTES[0x0b] = '\v'
-    ESCAPE_BYTES[0x0c] = '\f'
-    ESCAPE_BYTES[0x0d] = '\r'
-
-    #
-    # Dumps the string as a C-style string.
-    #
-    # @return [String]
-    #   The C-style encoded version of the String.
-    #
-    # @example
-    #   "hello\x00\073\x90\r\n".dump
-    #   # => "hello\0;\x90\r\n"
-    #
-    # @note
-    #   This method is only defined on Ruby 1.8.x.
-    #
-    # @api public
-    #
-    def dump
-      dumped_string = ''
-
-      each_byte { |b| dumped_string << ESCAPE_BYTES[b] }
-      return "\"#{dumped_string}\""
+    string.insert(index,data) if index
+    return string
+  end
+
+  #
+  # Inserts data after the occurrence of a pattern.
+  #
+  # @param [String, Regexp] pattern
+  #   The pattern to search for.
+  #
+  # @param [String] data
+  #   The data to insert after the pattern.
+  #
+  # @return [String]
+  #   The new modified String.
+  #
+  # @api public
+  #
+  def insert_after(pattern,data)
+    string = dup
+    match  = string.match(pattern)
+
+    if match
+      index = match.end(match.length - 1)
+
+      string.insert(index,data)
     end
 
-    alias inspect dump
+    return string
+  end
+
+  #
+  # Creates a new String by padding the String with repeating text,
+  # out to a specified length.
+  #
+  # @param [String] padding
+  #   The text to pad the new String with.
+  #
+  # @param [String] length
+  #   The maximum length to pad the new String out to.
+  #
+  # @return [String]
+  #   The padded version of the String.
+  #
+  # @example
+  #   "hello".pad('A',50)
+  #   # => "helloAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA"
+  #
+  # @api public
+  #
+  def pad(padding,length)
+    ljust(length,padding)
   end
 
 end

data/lib/ronin/support/core_ext.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+#
+# Copyright (c) 2006-2022 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# ronin-support is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# ronin-support is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with ronin-support.  If not, see <https://www.gnu.org/licenses/>.
+#
+
+require 'ronin/support/core_ext/string'
+require 'ronin/support/core_ext/file'
+require 'ronin/support/core_ext/integer'
+require 'ronin/support/core_ext/ipaddr'
+require 'ronin/support/core_ext/resolv'
+require 'ronin/support/core_ext/kernel'
+require 'ronin/support/binary/core_ext'
+require 'ronin/support/compression/core_ext'
+require 'ronin/support/archive/core_ext'
+require 'ronin/support/crypto/core_ext'
+require 'ronin/support/encoding/core_ext'
+require 'ronin/support/text/core_ext'
+require 'ronin/support/network/core_ext'
+
+require 'hexdump/core_ext'
+require 'uri/query_params/core_ext'