ronin 0.1.2 → 0.1.3

data/lib/ronin/context.rb

@@ -1,236 +0,0 @@
-#
-#--
-# Ronin - A Ruby platform designed for information security and data
-# exploration tasks.
-#
-# Copyright (c) 2006-2008 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 'ronin/exceptions/unknown_context'
-require 'ronin/exceptions/context_not_found'
-require 'ronin/pending_context'
-require 'ronin/extensions/meta'
-
-module Ronin
-  module Context
-    def self.included(base)
-      base.module_eval do
-        def self.contextify(name)
-          name = name.to_sym
-
-          Context.contexts[name] = self
-
-          meta_def(:context_name) { name }
-
-          class_def(:context_name) { name }
-
-          meta_def(:load_context) do |path,*args|
-            Context.load_context(self.context_name,path,*args)
-          end
-
-          # define the top-level context wrappers
-          Kernel.module_eval %{
-            def ronin_#{name}(*args,&block)
-              if (args.empty? && Ronin::Context.is_pending?)
-                Ronin::Context.pending.blocks[:#{name}] = block
-                return nil
-              else
-                new_context = #{self}.new(*args)
-                new_context.instance_eval(&block) if block
-                return new_context
-              end
-            end
-          }
-
-          # define the Ronin-level context loader
-          Ronin.module_eval %{
-            def ronin_load_#{name}(path,*args,&block)
-              new_context = #{self}.load_context(path,*args)
-
-              block.call(new_context) if block
-              return new_context
-            end
-          }
-        end
-      end
-    end
-
-    #
-    # Returns a Hash of all defined contexts.
-    #
-    def Context.contexts
-      @@ronin_contexts ||= {}
-    end
-
-    #
-    # Returns +true+ if there is a context defined with the specified
-    # _name_, returns +false+ otherwise.
-    #
-    def Context.is_context?(name)
-      Context.contexts.has_key?(name.to_sym)
-    end
-
-    #
-    # Converts the name of the _base_ class to a context name, returning
-    # it in +String+ form.
-    #
-    #   Context.namify(Ronin::Resources) # => "ronin_resources"
-    #
-    #   Context.namify(Analysis::Audio) # => "ronin_analysis_audio"
-    #
-    def Context.namify(base)
-      base.to_s.downcase.gsub(/::/,'_').gsub(/^ronin_/,'').to_sym
-    end
-
-    #
-    # Returns the Array of contexts which are waiting to be loaded.
-    #
-    def Context.waiting
-      @@ronin_waiting_contexts ||= []
-    end
-
-    #
-    # Returns the pending context being loaded.
-    #
-    def Context.pending
-      Context.waiting.first
-    end
-
-    #
-    # Returns +true+ if there is a pending context present, returns
-    # +false+ otherwise.
-    #
-    def Context.is_pending?
-      !(Context.waiting.empty?)
-    end
-
-    #
-    # Returns the first pending context with the specified _path_.
-    #
-    def Context.loading(path)
-      Context.waiting.each do |pending|
-        if pending.path == path
-          return pending
-        end
-      end
-
-      return nil
-    end
-
-    #
-    # Returns +true+ if the pending context with the specified _path_
-    # is present, returns +false+ otherwise.
-    #
-    def Context.is_loading?(path)
-      !(Context.loading(path).nil?)
-    end
-
-    #
-    # Loads all context blocks from the specified _path_, returning a
-    # PendingContext object containing the context blocks.
-    #
-    def Context.load_blocks(path,&block)
-      path = File.expand_path(path)
-
-      unless File.file?(path)
-        raise(ContextNotFound,"context #{path.dump} doest not exist",caller)
-      end
-
-      # prevent circular loading of contexts
-      unless Context.is_pending?
-        # push on the new pending context
-        Context.waiting.unshift(PendingContext.new(path))
-
-        load(path)
-      end
-
-      # pop off and return the pending context
-      pending_context = Context.waiting.shift
-
-      block.call(pending_context) if block
-      return pending_context
-    end
-
-    #
-    # Loads the context block of the specified _name_ from the specified
-    # _path_, returning the context block. If a _block_ is given it will
-    # be passed the loaded context block.
-    #
-    #   Context.load_block('/path/to/my_exploit.rb',:exploit) # => Proc
-    #
-    #   Context.load_block('/path/to/my_shellcode.rb',:shellcode)
-    #     do |block|
-    #     ...
-    #   end
-    #
-    def Context.load_block(name,path,&block)
-      context_block = Context.load_blocks(path).blocks[name.to_sym]
-
-      block.call(context_block) if block
-      return context_block
-    end
-
-    #
-    # Loads the context of the specified _name_ and from the specified
-    # _path_ with the given _args_. If no contexts were defined with the
-    # specified _name_, an UnknownContext exception will be raised.
-    #
-    #   Context.load_context(:note,'/path/to/my_notes.rb') # => Note
-    #
-    def Context.load_context(name,path,*args)
-      name = name.to_sym
-
-      unless Context.is_context?(name)
-        raise(UnknownContext,"unknown context '#{name}'",caller)
-      end
-
-      new_context = Context.contexts[name].new(*args)
-
-      Context.load_block(name,path) do |context_block|
-        new_context.instance_eval(&context_block) if context_block
-      end
-
-      return new_context
-    end
-
-    #
-    # Loads all contexts from the specified _path_ returning an +Array+
-    # of loaded contexts. If a _block_ is given, it will be passed
-    # each loaded context.
-    #
-    #   Context.load_contexts('/path/to/misc_contexts.rb') # => [...]
-    #
-    def Context.load_contexts(path,&block)
-      new_objs = []
-
-      Context.load_blocks(path) do |pending|
-        pending.each_block do |name,context_block|
-          if Context.is_context?(name)
-            new_obj = Context.contexts[name].new
-            new_obj.instance_eval(&context_block)
-
-            block.call(new_obj) if block
-            new_objs << new_obj
-          end
-        end
-      end
-
-      return new_objs
-    end
-  end
-end

data/spec/context/context_spec.rb

@@ -1,84 +0,0 @@
-require 'ronin/context'
-
-require 'spec_helper'
-
-describe Ronin do
-  describe Context do
-    before(:all) do
-      require 'context/helpers/book_context'
-      require 'context/helpers/book_review_context'
-
-      @contexts_dir = File.expand_path(File.join(File.dirname(__FILE__),'helpers','contexts'))
-      @snow_crash_path = File.join(@contexts_dir,'snow_crash.rb')
-      @neuromancer_path = File.join(@contexts_dir,'neuromancer_review.rb')
-    end
-
-    it "should contain defined contexts" do
-      Context.is_context?(:book).should == true
-    end
-
-    it "should create a class-level context name" do
-      Book.context_name.should == :book
-    end
-
-    it "should raise an UnknownContext exception when loading unknwon-contexts" do
-      lambda {
-        Context.load_context(:nothing, 'some_path.rb')
-      }.should raise_error(UnknownContext)
-    end
-
-    it "should raise a ContextNotFound exception when loading from non-existant files" do
-      lambda {
-        Context.load_context(:book, 'not_here.rb')
-      }.should raise_error(ContextNotFound)
-    end
-
-    it "should load contexts by context-name from a file" do
-      @book = Context.load_context(:book, @snow_crash_path)
-      @book.should_not be_nil
-      @book.class.should == Book
-    end
-
-    it "should load a specific context from a file with multiple contexts" do
-      @book = Context.load_context(:book, @neuromancer_path)
-      @book.should_not be_nil
-      @book.class.should == Book
-
-      @review = Context.load_context(:book_review, @neuromancer_path)
-      @review.should_not be_nil
-      @review.class.should == BookReview
-    end
-
-    it "should provide class-level methods for loading a context" do
-      @book = Book.load_context(@snow_crash_path)
-      @book.should_not be_nil
-      @book.class.should == Book
-    end
-
-    it "should provide top-level ronin methods for loading a context" do
-      @book = ronin_load_book(@snow_crash_path)
-      @book.should_not be_nil
-      @book.class.should == Book
-    end
-
-    describe "loaded contexts" do
-      before(:all) do
-        @book = Book.load_context(@snow_crash_path)
-      end
-
-      it "should have a context name" do
-        @book.context_name.should == :book
-      end
-
-      it "should have attributes" do
-        @book.title.should == 'Snow Crash'
-        @book.author.should == 'Neal Stephenson'
-      end
-
-      it "should have instance methods" do
-        @book.methods.include?('rating').should == true
-        @book.rating.should == 10
-      end
-    end
-  end
-end

data/spec/context/helpers/book_context.rb

@@ -1,15 +0,0 @@
-require 'ronin/context'
-
-class Book
-
-  include Context
-
-  contextify :book
-
-  # Title of the book
-  attr_accessor :title
-
-  # Author of the book
-  attr_accessor :author
-
-end

data/spec/context/helpers/book_review_context.rb

@@ -1,21 +0,0 @@
-require 'ronin/context'
-
-class BookReview
-
-  include Context
-
-  contextify :book_review
-
-  # Title of the book
-  attr_accessor :book_title
-
-  # Author of the book
-  attr_accessor :book_author
-
-  # Author of this review
-  attr_accessor :author
-
-  # Summary
-  attr_accessor :summary
-
-end

data/spec/context/helpers/contexts/neuromancer_review.rb

@@ -1,15 +0,0 @@
-ronin_book do
-  @title = 'Neuromancer'
-  @author = 'William Gibson'
-end
-
-ronin_book_review do
-  @book_title = 'Neuromancer'
-  @book_author = 'William Gibson'
-
-  @author = 'postmodern'
-  @summary = %{
-    Classic cyber-punk book. Provides you with a very realistic and gritty
-    vision of the future and the characters that inhabit it.
-  }
-end

data/spec/context/helpers/contexts/snow_crash.rb

@@ -1,8 +0,0 @@
-ronin_book do
-  @title = 'Snow Crash'
-  @author = 'Neal Stephenson'
-
-  def rating
-    10
-  end
-end

data/static/extension.rb.erb

@@ -1,16 +0,0 @@
-ronin_extension do
-<%
-  unless @uses.empty?
-    @uses.each do |name| %>
-<%= "  uses #{name.dump}" %>
-<%
-    end
-  end
-%>
-  setup do
-  end
-
-  teardown do
-  end
-
-end