ronin 0.2.3 → 0.2.4

data/lib/ronin/{translators.rb → templates.rb}

@@ -21,4 +21,4 @@
 #++
 #
 
-require 'ronin/translators/translator'
+require 'ronin/templates/erb'

data/lib/ronin/templates/erb.rb

@@ -0,0 +1,56 @@
+#
+#--
+# Ronin - A Ruby platform designed for information security and data
+# exploration tasks.
+#
+# Copyright (c) 2006-2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+#++
+#
+
+require 'erb'
+
+module Ronin
+  module Templates
+    module Erb
+      #
+      # Renders the specified inline ERB _template_ in the scope of the
+      # object, returning the resulting +String+.
+      #
+      #   @user = 'lolcats'
+      #
+      #   erb %{
+      #   USER: <%= @user %>
+      #   PASSWORD: <%= @user.reverse %>
+      #   }
+      #   # => "\nUSER: lolcats\nPASSWORD: staclol\n"
+      #
+      def erb(template)
+        ERB.new(template).result(binding)
+      end
+
+      #
+      # Renders the ERB template at the specified _path_ in the scope of the
+      # object, returning the resulting +String+.
+      #
+      #   erb_file 'path/to/template.erb'
+      #
+      def erb_file(path)
+        erb(File.read(path))
+      end
+    end
+  end
+end

data/lib/ronin/ui/command_line/command_line.rb

@@ -67,12 +67,21 @@ module Ronin
       # Returns the Command registered with the command-line utility
       # with the specified _name_.
       #
+      #   CommandLine.get_command('gen_overlay')
+      #   # => Ronin::UI::CommandLine::Commands::GenOverlay
+      #
       def CommandLine.get_command(name)
         name = name.to_s
 
+        #eventually someone is going to use a space or - which is going mess things up
+        #we will take care of this ahead of time here
+        name.gsub!(/[\s-]/, '_')
+
         begin
           require File.join(COMMANDS_DIR,name)
-        rescue LoadError
+        rescue Gem::LoadError => e
+          raise(e)
+        rescue ::LoadError
           raise(UnknownCommand,"unable to load the command #{name.dump}",caller)
         end
 

data/lib/ronin/ui/command_line/commands/{ls.rb → list.rb}

@@ -28,7 +28,7 @@ module Ronin
   module UI
     module CommandLine
       module Commands
-        class Ls < Command
+        class List < Command
 
           def defaults
             @cache = nil

data/lib/ronin/ui/command_line/commands/{rm.rb → remove.rb}

@@ -28,7 +28,7 @@ module Ronin
   module UI
     module CommandLine
       module Commands
-        class Rm < Command
+        class Remove < Command
 
           def defaults
             @cache = nil

data/lib/ronin/ui/command_line/commands/uninstall.rb

@@ -59,8 +59,8 @@ module Ronin
             Platform.load_overlays(@cache) if @cache
 
             args.each do |name|
-              Platform.uninstall(name) do |overlay|
-                puts "Uninstalling Overlay #{overlay.name.dump} ..."
+              Platform.uninstall(name) do
+                puts "Uninstalling Overlay #{name.dump} ..."
               end
             end
           end

data/lib/ronin/ui/console.rb

@@ -24,16 +24,27 @@
 require 'ronin/config'
 
 require 'irb'
-require 'irb/completion'
 
 module Ronin
   module UI
     module Console
+      # Default prompt style.
+      PROMPT = :SIMPLE
+
+      # Default indentation mode.
+      INDENT = true
+
+      # Default backtrace depth.
+      BACKTRACE_DEPTH = 5
+
+      # Default completion mode.
+      COMPLETION = true
+
       #
-      # Returns the default Console prompt style
+      # Returns the default Console prompt style, defaults to +PROMPT+.
       #
       def Console.prompt
-        @@ronin_console_prompt ||= :SIMPLE
+        @@ronin_console_prompt ||= PROMPT
       end
 
       #
@@ -44,17 +55,54 @@ module Ronin
       end
 
       #
-      # Returns the default Console indent setting.
+      # Returns the default Console indent setting, defaults to +INDENT+.
       #
       def Console.indent
-        @@ronin_console_indent ||= true
+        @@ronin_console_indent ||= INDENT
+      end
+
+      #
+      # Sets the default Console indent setting to the specified _mode_.
+      #
+      #   Console.indent = false
+      #   # => false
+      #
+      def Console.indent=(mode)
+        @@ronin_console_indent = mode
+      end
+
+      #
+      # Returns the default Console back trace limit, defaults to
+      # +BACKTRACE_DEPTH+.
+      #
+      def Console.backtrace_depth
+        @@ronin_console_backtrace_depth ||= BACKTRACE_DEPTH
       end
 
       #
-      # Sets the default Console indent setting.
+      # Sets the default Console back trace depth to the specified _depth_.
       #
-      def Console.indent=(value)
-        @@ronin_console_indent = value
+      def Console.backtrace_depth=(depth)
+        @@ronin_console_backtrace_depth = depth
+      end
+
+      #
+      # Returns the default Console tab-completion mode, defaults to
+      # +COMPLETION+.
+      #
+      def Console.completion
+        @@ronin_console_completion ||= COMPLETION
+      end
+
+      #
+      # Sets the default Console tab-completion mode to the specified
+      # _mode_.
+      #
+      #   Console.completion = false
+      #   # => false
+      #
+      def Console.completion=(mode)
+        @@ronin_console_completion = mode
       end
 
       #
@@ -79,17 +127,22 @@ module Ronin
       def Console.start(script=nil,&block)
         IRB.setup(script)
 
+        # configure IRB
         IRB.conf[:IRB_NAME] = 'ronin'
         IRB.conf[:PROMPT_MODE] = Console.prompt
         IRB.conf[:AUTO_INDENT] = Console.indent
+        IRB.conf[:BACK_TRACE_LIMIT] = Console.backtrace_depth
 
         irb = IRB::Irb.new(nil,script)
 
-        # configure the irb workspace
+        # configure the IRB context
         irb.context.main.instance_eval do
           require 'ronin/environment'
           require 'ronin/platform'
 
+          require 'irb/completion' if Ronin::UI::Console.completion
+
+          # require any of the auto-load paths
           Ronin::UI::Console.auto_load.each do |path|
             require path
           end
@@ -97,22 +150,18 @@ module Ronin
           include Ronin
         end
 
+        # run any setup-blocks
         Console.setup_blocks.each do |setup_block|
           irb.context.main.instance_eval(&setup_block)
         end
 
-        # Load console configuration block is given
+        # run the supplied configuration block is given
         irb.context.main.instance_eval(&block) if block
 
         IRB.conf[:MAIN_CONTEXT] = irb.context
 
-        trap('SIGINT') do
-          irb.signal_handle
-        end
-
-        catch(:IRB_EXIT) do
-          irb.eval_input
-        end
+        trap('SIGINT') { irb.signal_handle }
+        catch(:IRB_EXIT) { irb.eval_input }
 
         putc "\n"
         return nil

data/lib/ronin/ui/shell.rb

@@ -22,45 +22,30 @@
 #
 
 module Ronin
-  class Shell
+  module Shell
 
     # Default shell prompt
     DEFAULT_PROMPT = '>'
 
-    # Shell name to use
-    attr_accessor :name
-
-    # Shell prompt
-    attr_accessor :prompt
-
-    #
-    # Creates a new Shell object with the given _options_.
-    #
-    # _options_ may contain the following keys:
-    # <tt>:name</tt>:: The name of the shell.
-    # <tt>:prompt</tt>::The prompt to use for the shell.
-    #
-    def initialize(options={})
-      @name = options[:name]
-      @prompt = (options[:prompt] || DEFAULT_PROMPT)
-    end
-
     #
     # Creates and starts a new Shell object with the specified _options_.
     # If a _block_ is given, it will be passed every command.
     #
-    def self.start(options={},&block)
-      self.new(options).start(&block)
-    end
-
+    # _options_ may contain the following keys:
+    # <tt>:name</tt>:: Name of the shell.
+    # <tt>:prompt</tt>:: Prompt to use for the shell, defaults to
+    #                    +DEFAULT_PROMPT+.
     #
-    # Starts the shell using the given _block_ to process commands.
+    #   Shell.start(:prompt => '$') { |shell,line| system(line) }
     #
-    def start(&block)
+    def Shell.start(options={},&block)
+      name = (options[:name] || '')
+      prompt = (options[:prompt] || DEFAULT_PROMPT)
+
       history_rollback = 0
 
       loop do
-        line = Readline.readline("#{@name}#{@prompt} ")
+        line = Readline.readline("#{name}#{prompt} ")
 
         if line =~ /^\s*exit\s*$/
           break
@@ -76,40 +61,35 @@ module Ronin
         end
       end
 
-      history_rollback.times do
-        Readline::HISTORY.pop
-      end
-
+      history_rollback.times { Readline::HISTORY.pop }
       return nil
     end
 
     #
     # Equivalent to <tt>STDOUT.putc(char)</tt>.
     #
-    def putc(char)
+    def Shell.putc(char)
       STDOUT.putc(char)
     end
 
     #
     # Equivalent to <tt>STDOUT.print(string)</tt>.
     #
-    def print(string)
+    def Shell.print(string)
       STDOUT.print(string)
     end
 
     #
     # Equivalent to <tt>STDOUT.puts(string)</tt>.
     #
-    def puts(string)
+    def Shell.puts(string)
       STDOUT.puts(string)
     end
 
-    alias << puts
-
     #
     # Equivalent to <tt>STDOUT.printf(string,*objects)</tt>.
     #
-    def printf(string,*objects)
+    def Shell.printf(string,*objects)
       STDOUT.printf(string,*objects)
     end
 

data/lib/ronin/version.rb

@@ -23,5 +23,5 @@
 
 module Ronin
   # Ronin version 
-  VERSION = '0.2.3'
+  VERSION = '0.2.4'
 end

data/spec/cacheable_spec.rb

@@ -94,7 +94,7 @@ describe Cacheable do
 
       model = CacheableModel.cache(CACHEABLE_PATH)
       model.cached_timestamp -= 10
-      model.save!
+      model.save
     end
 
     it "should re-cache modified files" do

data/spec/code/classes/thing.rb

@@ -4,6 +4,10 @@ class Thing
     1
   end
 
+  def inspect
+    "#<Thing: stuff>"
+  end
+
   protected
 
   def not_exposed

data/spec/code/reference_spec.rb

@@ -56,4 +56,8 @@ describe Code::Reference do
   it "should raise a NoMethodError when trying to call a protected or private method" do
     lambda { @ref.not_exposed }.should raise_error(NoMethodError)
   end
+
+  it "should inspect the referenced object when inspect is called" do
+    @ref.inspect.should == '#<Thing: stuff>'
+  end
 end

data/spec/code/symbol_table_spec.rb

@@ -3,7 +3,7 @@ require 'ronin/code/symbol_table'
 require 'spec_helper'
 
 describe Code::SymbolTable do
-  before(:all) do
+  before(:each) do
     @one = [:a, :b, :c]
     @two = {:one => 1, :two => 2}
 
@@ -38,4 +38,8 @@ describe Code::SymbolTable do
     @table[:three].should == 3
     @table[:four].should == 4
   end
+
+  it "should display the values of the symbols when inspected" do
+    @table.inspect.should == '{:one=>[:a, :b, :c], :two=>{:one=>1, :two=>2}}'
+  end
 end

data/spec/extensions/kernel_spec.rb

@@ -3,17 +3,57 @@ require 'ronin/extensions/kernel'
 require 'spec_helper'
 
 describe Kernel do
-  it "should provide Kernel#try" do
-    Kernel.respond_to?('try').should == true
+  it "should provide Kernel#attempt" do
+    Kernel.respond_to?('attempt').should == true
   end
 
-  describe "try" do
+  describe "attempt" do
     it "should return the result of the block if nothing is raised" do
-      try { 2 + 2 }.should == 4
+      attempt { 2 + 2 }.should == 4
     end
 
     it "should return nil if an exception is raised" do
-      try { 2 + 'a' }.should be_nil
+      attempt { 2 + 'a' }.should be_nil
+    end
+
+    it "should rescue RuntimeError exceptions" do
+      lambda {
+        attempt { raise(RuntimeError,"something happened",caller) }
+      }.should_not raise_error(RuntimeError)
+    end
+
+    it "should rescue StandardError exceptions" do
+      lambda {
+        attempt { raise(StandardError,"not allowed to do that",caller) }
+      }.should_not raise_error(StandardError)
+    end
+  end
+
+  describe "catch_all" do
+    it "should run a block" do
+      var = 1
+
+      catch_all { var += 1 }
+
+      var.should == 2
+    end
+
+    it "should catch SyntaxError exceptions" do
+      lambda {
+        catch_all(false) { raise(SyntaxError,"horrible code",caller) }
+      }.should_not raise_error(SyntaxError)
+    end
+
+    it "should catch RuntimeError exceptions" do
+      lambda {
+        catch_all(false) { raise(RuntimeError,"something happened",caller) }
+      }.should_not raise_error(RuntimeError)
+    end
+
+    it "should catch StandardError exceptions" do
+      lambda {
+        catch_all(false) { raise(StandardError,"not allowed to do that",caller) }
+      }.should_not raise_error(StandardError)
     end
   end
 end