ronin-support 0.1.0 → 0.2.0.rc1

data/lib/ronin/formatting/extensions/digest/string.rb

@@ -31,6 +31,8 @@ class String
   #   "hello".md5
   #   # => "5d41402abc4b2a76b9719d911017c592"
   #
+  # @api public
+  #
   def md5
     Digest::MD5.hexdigest(self)
   end
@@ -43,6 +45,8 @@ class String
   #   "hello".sha1
   #   # => "aaf4c61ddcc5e8a2dabede0f3b482cd9aea9434d"
   #
+  # @api public
+  #
   def sha1
     Digest::SHA1.hexdigest(self)
   end
@@ -57,6 +61,8 @@ class String
   #   "hello".sha2
   #   # => "2cf24dba5fb0a30e26e83b2ac5b9e29e1b161e5c1fa7425e73043362938b9824"
   #
+  # @api public
+  #
   def sha256
     Digest::SHA256.hexdigest(self)
   end
@@ -71,6 +77,8 @@ class String
   #   "hello".sha512
   #   # => "9b71d224bd62f3785d96d46ad3ea3d73319bfbc2890caadae2dff72519673ca72323c3d99ba5c11d7c7acc6e14b8c5da0c4663475c2e5c3adef46f73bcdec043"
   #
+  # @api public
+  #
   def sha512
     Digest::SHA512.hexdigest(self)
   end

data/lib/ronin/formatting/extensions/html.rb

@@ -0,0 +1,21 @@
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin Support.
+#
+# 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 <http://www.gnu.org/licenses/>.
+#
+
+require 'ronin/formatting/extensions/html/integer'
+require 'ronin/formatting/extensions/html/string'

data/lib/ronin/formatting/extensions/html/integer.rb

@@ -0,0 +1,126 @@
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin Support.
+#
+# 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 <http://www.gnu.org/licenses/>.
+#
+
+require 'cgi'
+
+class Integer
+
+  # Special JavaScript bytes and their escaped Strings.
+  JS_ESCAPE_BYTES = {
+    0x00 => '%u0000',
+    0x01 => '%u0001',
+    0x02 => '%u0002',
+    0x03 => '%u0003',
+    0x04 => '%u0004',
+    0x05 => '%u0005',
+    0x06 => '%u0006',
+    0x07 => '%u0007',
+    0x08 =>  '\b',
+    0x09 =>  '\t',
+    0x0a =>  '\n',
+    0x0b => '%u000b',
+    0x0c =>  '\f',
+    0x0d =>  '\r',
+    0x0e => '%u000e',
+    0x0f => '%u000f',
+    0x10 => '%u0010',
+    0x11 => '%u0011',
+    0x12 => '%u0012',
+    0x13 => '%u0013',
+    0x14 => '%u0014',
+    0x15 => '%u0015',
+    0x16 => '%u0016',
+    0x17 => '%u0017',
+    0x18 => '%u0018',
+    0x19 => '%u0019',
+    0x1a => '%u001a',
+    0x1b => '%u001b',
+    0x1c => '%u001c',
+    0x1d => '%u001d',
+    0x1e => '%u001e',
+    0x1f => '%u001f',
+    0x22 =>  '\"',
+    0x5c =>  '\\\\',
+  }
+
+  #
+  # Escapes the Integer as an HTML String.
+  #
+  # @return [String]
+  #   The escaped HTML String.
+  #
+  # @since 0.2.0
+  #
+  # @api public
+  #
+  def html_escape
+    CGI.escapeHTML(self.chr)
+  end
+
+  #
+  # Formats the Integer as a HTML String.
+  #
+  # @return [String]
+  #   The HTML String.
+  #
+  # @since 0.2.0
+  #
+  # @api public
+  #
+  def format_html
+    "&#%d;" % self
+  end
+
+  #
+  # Escapes the Integer as a JavaScript String.
+  #
+  # @return [String]
+  #   The escaped JavaScript String.
+  #
+  # @since 0.2.0
+  #
+  # @api public
+  #
+  def js_escape
+    if self > 0xff
+      format_js
+    else
+      JS_ESCAPE_BYTES.fetch(self,self.chr)
+    end
+  end
+
+  #
+  # Formats the Integer as a JavaScript escaped String.
+  #
+  # @return [String]
+  #   The escaped JavaScript String.
+  #
+  # @since 0.2.0
+  #
+  # @api public
+  #
+  def format_js
+    if self > 0xff
+      "%%u%.2X%.2X" % [(self & 0xff00) >> 8, (self & 0xff)]
+    else
+      "%%%.2X" % self
+    end
+  end
+
+end

data/lib/ronin/formatting/extensions/html/string.rb

@@ -0,0 +1,184 @@
+#
+# Copyright (c) 2006-2011 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This file is part of Ronin Support.
+#
+# 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 <http://www.gnu.org/licenses/>.
+#
+
+require 'ronin/formatting/extensions/html/integer'
+require 'ronin/formatting/extensions/text/string'
+
+require 'cgi'
+
+class String
+
+  # JavaScript characters that must be back-slashed.
+  JS_BACKSLASHED_CHARS = {
+    "\\b" => "\b",
+    "\\t" => "\t",
+    "\\n" => "\n",
+    "\\f" => "\f",
+    "\\r" => "\r",
+    "\\\"" => "\"",
+    "\\\\" => "\\"
+  }
+
+  #
+  # HTML escapes the String.
+  #
+  # @return [String]
+  #   The HTML escaped String.
+  #
+  # @see http://rubydoc.info/stdlib/cgi/1.9.2/CGI.escapeHTML
+  #
+  # @since 0.2.0
+  #
+  # @api public
+  #
+  def html_escape
+    CGI.escapeHTML(self)
+  end
+
+  #
+  # Unescapes the HTML encoded String.
+  #
+  # @return [String]
+  #   The unescaped String.
+  #
+  # @see http://rubydoc.info/stdlib/cgi/1.9.2/CGI.unescapeHTML
+  #
+  # @since 0.2.0
+  #
+  # @api public
+  #
+  def html_unescape
+    CGI.unescapeHTML(self)
+  end
+
+  #
+  # Formats the chars in the String for HTML.
+  #
+  # @param [Hash] options
+  #   Additional options for {#format_chars}.
+  #
+  # @return [String]
+  #   The formatted HTML String.
+  #
+  # @see Integer#format_html
+  #
+  # @since 0.2.0
+  #
+  # @api public
+  #
+  def format_html(options={})
+    if RUBY_VERSION < '1.9.'
+      # String#ord was not backported to Rub 1.8.7
+      format_chars(options) { |c| c[0].format_html }
+    else
+      format_chars(options) { |c| c.ord.format_html }
+    end
+  end
+
+  #
+  # Escapes a String for JavaScript.
+  #
+  # @param [Hash] options
+  #   Additional options for {#format_chars}.
+  #
+  # @return [String]
+  #   The JavaScript escaped String.
+  #
+  # @example
+  #   "hello".js_escape
+  #   # => "%u0068%u0065%u006C%u006C%u006F"
+  #
+  # @see Integer#js_escape
+  #
+  # @since 0.2.0
+  #
+  # @api public
+  #
+  def js_escape(options={})
+    if RUBY_VERSION < '1.9.'
+      # String#ord was not backported to Rub 1.8.7
+      format_chars(options) { |c| c[0].js_escape }
+    else
+      format_chars(options) { |c| c.ord.js_escape }
+    end
+  end
+
+  #
+  # Unescapes a JavaScript escaped String.
+  #
+  # @return [String]
+  #   The unescaped JavaScript String.
+  #
+  # @example
+  #   "%u0068%u0065%u006C%u006C%u006F world".js_unescape
+  #   # => "hello world"
+  #
+  # @since 0.2.0
+  #
+  # @api public
+  #
+  def js_unescape
+    unescaped = ''
+
+    scan(/([\\%]u[0-9a-fA-F]{4}|[\\%][0-9a-fA-F]{2}|\\[btnfr"\\]|.)/).each do |match|
+      c = match[0]
+
+      if c.length == 6
+        unescaped << c[2,4].to_i(16)
+      elsif c.length == 3
+        unescaped << c[1,2].to_i(16)
+      elsif c.length == 2
+        unescaped << JS_BACKSLASHED_CHARS[c]
+      else
+        unescaped << c
+      end
+    end
+
+    return unescaped
+  end
+
+  #
+  # Escapes a String for JavaScript.
+  #
+  # @param [Hash] options
+  #   Additional options for {#format_chars}.
+  #
+  # @return [String]
+  #   The JavaScript escaped String.
+  #
+  # @example
+  #   "hello".js_escape
+  #   # => "%u0068%u0065%u006C%u006C%u006F"
+  #
+  # @see Integer#js_escape
+  #
+  # @since 0.2.0
+  #
+  # @api public
+  #
+  def format_js(options={})
+    if RUBY_VERSION < '1.9.'
+      # String#ord was not backported to Rub 1.8.7
+      format_chars(options) { |c| c[0].format_js }
+    else
+      format_chars(options) { |c| c.ord.format_js }
+    end
+  end
+
+end

data/lib/ronin/formatting/extensions/http/integer.rb

@@ -28,6 +28,8 @@ class Integer
   # @return [String]
   #   The URI encoded byte.
   #
+  # @api public
+  #
   def uri_encode
     URI.encode(self.chr)
   end
@@ -38,6 +40,8 @@ class Integer
   # @return [String]
   #   The URI escaped byte.
   #
+  # @api public
+  #
   def uri_escape
     CGI.escape(self.chr)
   end
@@ -48,8 +52,10 @@ class Integer
   # @return [String]
   #   The formatted byte.
   #
+  # @api public
+  #
   def format_http
-    "%%%x" % self
+    "%%%X" % self
   end
 
 end

data/lib/ronin/formatting/extensions/http/string.rb

@@ -35,6 +35,8 @@ class String
   #   "art is graffiti".uri_encode
   #   # => "art%20is%20graffiti"
   #
+  # @api public
+  #
   def uri_encode
     URI.encode(self)
   end
@@ -49,6 +51,8 @@ class String
   #   "genre%3f".uri_decode
   #   # => "genre?"
   #
+  # @api public
+  #
   def uri_decode
     URI.decode(self)
   end
@@ -63,6 +67,8 @@ class String
   #   "x > y".uri_escape
   #   # => "x+%3E+y"
   #
+  # @api public
+  #
   def uri_escape
     CGI.escape(self)
   end
@@ -77,6 +83,8 @@ class String
   #   "sweet+%26+sour".uri_unescape
   #   # => "sweet & sour"
   #
+  # @api public
+  #
   def uri_unescape
     CGI.unescape(self)
   end
@@ -93,6 +101,8 @@ class String
   #
   # @see String#format_bytes
   #
+  # @api public
+  #
   def format_http(options={})
     format_bytes(options) { |b| b.format_http }
   end

data/lib/ronin/formatting/extensions/text.rb

@@ -19,3 +19,5 @@
 
 require 'ronin/formatting/extensions/text/string'
 require 'ronin/formatting/extensions/text/array'
+
+require 'chars/extensions'