ronin-support 0.1.0 → 0.2.0.rc1

data/lib/ronin/templates/template.rb

@@ -37,6 +37,8 @@ module Ronin
       # @return [Array]
       #   The stack of directory paths.
       #
+      # @api semipublic
+      #
       def template_dirs
         @template_dirs ||= []
       end
@@ -49,6 +51,8 @@ module Ronin
       #   Returns the first path in {#template_dirs}, or `nil` if
       #   {#template_dirs} is empty.
       #
+      # @api semipublic
+      #
       def template_dir
         template_dirs.first
       end
@@ -68,6 +72,8 @@ module Ronin
       # @example
       #   find_template 'sub/path/template.erb'
       #
+      # @api semipublic
+      #
       def find_template(sub_path)
         sub_path = sub_path.to_s
 
@@ -107,6 +113,8 @@ module Ronin
       #     # do stuff with the full path
       #   end
       #
+      # @api semipublic
+      #
       def enter_template(sub_path)
         sub_path = sub_path.to_s
 
@@ -143,6 +151,8 @@ module Ronin
       #     # ...
       #   end
       #
+      # @api semipublic
+      #
       def read_template(template_path)
         enter_template(template_path) do |path|
           contents = File.read(path)

data/spec/extensions/string_spec.rb

@@ -107,27 +107,27 @@ describe String do
     end
   end
 
-  describe "#common_postfix" do
+  describe "#common_suffix" do
     it "should find the common postfix between two Strings" do
       one = 'Tell me baby whats my name'
       two = "Can't you guess my name"
       common = 's my name'
 
-      one.common_postfix(two).should == common
+      one.common_suffix(two).should == common
     end
 
     it "should return an empty String if there is no common postfix" do
       one = 'You got to right up, stand up'
       two = 'stand up for your rights'
 
-      one.common_postfix(two).should == ''
+      one.common_suffix(two).should == ''
     end
 
     it "should return an empty String if one of the strings is also empty" do
       one = 'You and I must fight for our rights'
       two = ''
 
-      one.common_postfix(two).should == ''
+      one.common_suffix(two).should == ''
     end
   end
 

data/spec/formatting/html/integer_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+require 'ronin/formatting/extensions/html/integer'
+
+describe Integer do
+  subject { 0x26 }
+
+  it "should provide String#html_escape" do
+    should respond_to(:html_escape)
+  end
+
+  it "should provide String#format_html" do
+    should respond_to(:format_html)
+  end
+
+  it "should provide String#js_escape" do
+    should respond_to(:js_escape)
+  end
+
+  it "should provide String#format_js" do
+    should respond_to(:format_js)
+  end
+
+  describe "#html_escape" do
+    let(:html_escaped) { "&" }
+
+    it "should HTML escape itself" do
+      subject.html_escape.should == html_escaped
+    end
+  end
+
+  describe "#format_html" do
+    let(:formatted_html) { "&" }
+
+    it "should HTML format all chars" do
+      subject.format_html.should == formatted_html
+    end
+  end
+
+  describe "#js_escape" do
+    let(:special_byte) { 0x0a }
+    let(:escaped_special_byte) { '\n' }
+
+    let(:normal_byte) { 0x41 }
+    let(:normal_char) { 'A' }
+
+    it "should escape special JavaScript characters" do
+      special_byte.js_escape.should == escaped_special_byte
+    end
+
+    it "should ignore normal characters" do
+      normal_byte.js_escape.should == normal_char
+    end
+  end
+
+  describe "#format_js" do
+    let(:js_escaped) { "%26" }
+
+    it "should JavaScript format ascii bytes" do
+      subject.format_js.should == js_escaped
+    end
+
+    it "should JavaScript format unicode bytes" do
+      0xd556.format_js.should == "%uD556"
+    end
+  end
+end

data/spec/formatting/html/string_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+require 'ronin/formatting/extensions/html/string'
+
+describe String do
+  subject { "one & two" }
+
+  it "should provide String#html_escape" do
+    should respond_to(:html_escape)
+  end
+
+  it "should provide String#html_unescape" do
+    should respond_to(:html_unescape)
+  end
+
+  it "should provide String#format_html" do
+    should respond_to(:format_html)
+  end
+
+  it "should provide String#js_escape" do
+    should respond_to(:js_escape)
+  end
+
+  it "should provide String#js_unescape" do
+    should respond_to(:js_unescape)
+  end
+
+  it "should provide String#format_js" do
+    should respond_to(:format_js)
+  end
+
+  describe "#html_escape" do
+    let(:html_escaped) { "one & two" }
+
+    it "should HTML escape itself" do
+      subject.html_escape.should == html_escaped
+    end
+  end
+
+  describe "#html_unescape" do
+    let(:html_escaped) { "one & two" }
+
+    it "should HTML unescape itself" do
+      html_escaped.html_unescape.should == subject
+    end
+  end
+
+  describe "#format_html" do
+    let(:formatted_html) do
+      "one & two"
+    end
+
+    it "should HTML format all chars" do
+      subject.format_html.should == formatted_html
+    end
+  end
+
+  describe "#js_escape" do
+    let(:special_chars) { "\t\n\r" }
+    let(:escaped_special_chars) { '\t\n\r' }
+
+    let(:normal_chars) { "abc" }
+
+    it "should escape special JavaScript characters" do
+      special_chars.js_escape.should == escaped_special_chars
+    end
+
+    it "should ignore normal characters" do
+      normal_chars.js_escape.should == normal_chars
+    end
+  end
+
+  describe "#js_unescape" do
+    let(:js_unicode) do
+      "%u006F%u006E%u0065%u0020%u0026%u0020%u0074%u0077%u006F"
+    end
+    let(:js_hex) { "%6F%6E%65%20%26%20%74%77%6F" }
+    let(:js_mixed) { "one %26 two" }
+
+    it "should unescape JavaScript unicode characters" do
+      js_unicode.js_unescape.should == subject
+    end
+
+    it "should unescape JavaScript hex characters" do
+      js_hex.js_unescape.should == subject
+    end
+
+    it "should unescape backslash-escaped characters" do
+      "\\b\\t\\n\\f\\r\\\"\\\\".js_unescape.should == "\b\t\n\f\r\"\\"
+    end
+
+    it "should ignore non-escaped characters" do
+      js_mixed.js_unescape.should == subject
+    end
+  end
+
+  describe "#format_js" do
+    let(:js_formatted) { "%6F%6E%65%20%26%20%74%77%6F" }
+
+    it "should JavaScript escape all characters" do
+      subject.format_js.should == js_formatted
+    end
+  end
+end

data/spec/formatting/http/string_spec.rb

@@ -67,7 +67,7 @@ describe String do
   describe "#format_http" do
     subject { "mod % 3" }
 
-    let(:http_formatted) { "%6d%6f%64%20%25%20%33" }
+    let(:http_formatted) { "%6D%6F%64%20%25%20%33" }
 
     it "should format each byte of the String" do
       subject.format_http.should == http_formatted

data/spec/formatting/text/string_spec.rb

@@ -24,62 +24,6 @@ describe String do
     should respond_to(:insert_after)
   end
 
-  describe "#format_chars" do
-    it "should format each character in the String" do
-      subject.format_chars { |c|
-        "_#{c}"
-      }.should == "_h_e_l_l_o"
-    end
-
-    it "should format specific bytes in a String" do
-      subject.format_chars(:include => [104, 108]) { |c|
-        c.upcase
-      }.should == 'HeLLo'
-    end
-
-    it "should not format specific bytes in a String" do
-      subject.format_chars(:exclude => [101, 111]) { |c|
-        c.upcase
-      }.should == 'HeLLo'
-    end
-
-    it "should format ranges of bytes in a String" do
-      subject.format_chars(:include => (104..108)) { |c|
-        c.upcase
-      }.should == 'HeLLo'
-    end
-
-    it "should not format ranges of bytes in a String" do
-      subject.format_chars(:exclude => (104..108)) { |c|
-        c.upcase
-      }.should == 'hEllO'
-    end
-
-    it "should format specific chars in a String" do
-      subject.format_chars(:include => ['h', 'l']) { |c|
-        c.upcase
-      }.should == 'HeLLo'
-    end
-
-    it "should not format specific bytes in a String" do
-      subject.format_chars(:exclude => ['e', 'o']) { |c|
-        c.upcase
-      }.should == 'HeLLo'
-    end
-
-    it "should format ranges of chars in a String" do
-      subject.format_chars(:include => ('h'..'l')) { |c|
-        c.upcase
-      }.should == 'HeLLo'
-    end
-
-    it "should not format ranges of chars in a String" do
-      subject.format_chars(:exclude => ('h'..'l')) { |c|
-        c.upcase
-      }.should == 'hEllO'
-    end
-  end
-
   describe "#format_bytes" do
     it "should format each byte in the String" do
       subject.format_bytes { |b|
@@ -110,28 +54,36 @@ describe String do
         b - 32
       }.should == 'hEllO'
     end
+  end
+
+  describe "#format_chars" do
+    it "should format each character in the String" do
+      subject.format_chars { |c|
+        "#{c}."
+      }.should == "h.e.l.l.o."
+    end
 
     it "should format specific chars in a String" do
-      subject.format_bytes(:include => ['h', 'l']) { |b|
-        b - 32
+      subject.format_chars(:include => ['h', 'l']) { |c|
+        c.upcase
       }.should == 'HeLLo'
     end
 
-    it "should not format specific bytes in a String" do
-      subject.format_bytes(:exclude => ['e', 'o']) { |b|
-        b - 32
-      }.should == 'HeLLo'
+    it "should not format specific chars in a String" do
+      subject.format_chars(:exclude => ['h', 'l']) { |c|
+        c.upcase
+      }.should == 'hEllO'
     end
 
     it "should format ranges of chars in a String" do
-      subject.format_bytes(:include => ('h'..'l')) { |b|
-        b - 32
+      subject.format_chars(:include => /[h-l]/) { |c|
+        c.upcase
       }.should == 'HeLLo'
     end
 
     it "should not format ranges of chars in a String" do
-      subject.format_bytes(:exclude => ('h'..'l')) { |b|
-        b - 32
+      subject.format_chars(:exclude => /[h-l]/) { |c|
+        c.upcase
       }.should == 'hEllO'
     end
   end

data/spec/mixin_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+require 'ronin/mixin'
+
+module Mixins
+  module Test1
+  end
+
+  module Test2
+  end
+end
+
+describe Mixin do
+  subject do
+    Module.new do
+      include Mixin
+
+      mixin Mixins::Test1, Mixins::Test2
+      mixin { @var = 1 }
+    end
+  end
+
+  context "when included" do
+    before(:all) do
+      @base = Class.new
+      @base.send :include, subject
+    end
+
+    it "should include the mixed in modules" do
+      @base.should include(Mixins::Test1)
+      @base.should include(Mixins::Test2)
+    end
+
+    it "should evaluate the mixin block" do
+      @base.instance_variable_get("@var").should == 1
+    end
+  end
+
+  context "when extended" do
+    before(:all) do
+      @base = Object.new
+      @base.send :extend, subject
+    end
+
+    it "should extend the mixed in modules" do
+      @base.should be_kind_of(Mixins::Test1)
+      @base.should be_kind_of(Mixins::Test2)
+    end
+
+    it "should evaluate the mixin block" do
+      @base.instance_variable_get("@var").should == 1
+    end
+  end
+end

data/spec/network/http/http_spec.rb

@@ -35,13 +35,6 @@ describe Network::HTTP do
       options[:port].should == url.port
     end
 
-    it "should accept nil" do
-      options = subject.expand_url(nil)
-
-      options[:port].should == Net::HTTP.default_port
-      options[:path].should == '/'
-    end
-
     it "should default :path to '/'" do
       options = subject.expand_url(URI('http://example.com'))
 

data/spec/network/http/proxy_spec.rb

@@ -3,7 +3,7 @@ require 'ronin/network/http/proxy'
 
 describe Network::HTTP::Proxy do
   describe "parse" do
-    subject { Network::HTTP::Proxy }
+    subject { described_class }
 
     it "should parse host-names" do
       proxy = subject.parse('127.0.0.1')
@@ -46,7 +46,7 @@ describe Network::HTTP::Proxy do
   end
 
   describe "create" do
-    subject { Network::HTTP::Proxy }
+    subject { described_class }
 
     let(:host) { '127.0.0.1' }
     let(:port) { 8080 }