ronin-gen 0.1.1 → 0.2.0

data/History.txt

@@ -1,3 +1,17 @@
+=== 0.2.0 / 2009-09-24
+
+* Require ronin >= 0.3.0.
+* Require rspec >= 1.2.8.
+* Require yard >= 0.2.3.5.
+* Updated the project summary and 3-point description of Ronin Gen.
+* Moved to YARD based documentation.
+* Refactored Ronin::Generators::Generator to inherit from Thor.
+* Refactored Ronin::Generators::DirGenerator.
+* Refactored Ronin::Generators::Platform::Extension.
+* Refactored Ronin::Generators::Platform::Overlay.
+* Rewrote the Ronin::UI::CommandLine generator commands to simply inherit
+  from the new Thor based generator classes within Ronin::Generators.
+
 === 0.1.1 / 2009-07-02
 
 * Use Hoe >= 2.0.0.

data/Manifest.txt

@@ -3,7 +3,6 @@ COPYING.txt
 Manifest.txt
 README.txt
 Rakefile
-TODO.txt
 bin/ronin-gen
 bin/ronin-gen-overlay
 bin/ronin-gen-extension
@@ -14,12 +13,12 @@ lib/ronin/generators/version.rb
 lib/ronin/generators/platform/static.rb
 lib/ronin/generators/platform/overlay.rb
 lib/ronin/generators/platform/extension.rb
-lib/ronin/generators/platform/spec.rb
 lib/ronin/generators/platform/extension.rb
 lib/ronin/ui/command_line/commands/gen.rb
 lib/ronin/ui/command_line/commands/gen_overlay.rb
 lib/ronin/ui/command_line/commands/gen_extension.rb
 tasks/spec.rb
+tasks/yard.rb
 spec/spec_helper.rb
 spec/generated_overlay_examples.rb
 spec/generated_extension_examples.rb
@@ -35,5 +34,6 @@ spec/generators/platform/overlay_spec.rb
 spec/generators/platform/extension_spec.rb
 spec/ui/command_line/commands/gen_overlay_spec.rb
 spec/ui/command_line/commands/gen_extension_spec.rb
-static/ronin/platform/generators/extension.rb
-static/ronin/platform/generators/spec/spec_helper.rb
+static/ronin/generators/platform/Rakefile.erb
+static/ronin/generators/platform/extension.rb
+static/ronin/generators/platform/spec/spec_helper.rb

data/README.txt

@@ -2,61 +2,63 @@
 
 * http://ronin.rubyforge.org/gen/
 * http://github.com/postmodern/ronin-gen
-* irc.freenode.net ##ronin
+* irc.freenode.net #ronin
 * Postmodern (postmodern.mod3 at gmail.com)
 
 == DESCRIPTION:
 
 Ronin Gen is a Ruby library for Ronin that provides various generators.
 
-Ronin is a Ruby platform designed for information security and data
-exploration tasks. Ronin allows for the rapid development and distribution
-of code over many of the common Source-Code-Management (SCM) systems.
+Ronin is a Ruby platform for exploit development and security research.
+Ronin allows for the rapid development and distribution of code, exploits
+or payloads over many common Source-Code-Management (SCM) systems.
 
-=== Free
+=== Ruby
 
-All source code within Ronin is licensed under the GPL-2, therefore no user
-will ever have to pay for Ronin or updates to Ronin. Not only is the
-source code free, the Ronin project will not sell enterprise grade security
-snake-oil solutions, give private training classes or later turn Ronin into
-commercial software.
+Ronin's Ruby environment allows security researchers to leverage Ruby with
+ease. The Ruby environment contains a multitude of convenience methods
+for working with data in Ruby, a Ruby Object Database, a customized Ruby
+Console and an extendable command-line interface.
 
-=== Modular
+=== Extend
 
-Ronin was not designed as one monolithic framework but instead as a
-collection of libraries which can be individually installed. This allows
-users to pick and choose what functionality they want in Ronin.
+Ronin's more specialized features are provided by additional Ronin
+libraries, which users can choose to install. These libraries can allow
+one to write and run Exploits and Payloads, scan for PHP vulnerabilities,
+perform Google Dorks  or run 3rd party scanners.
 
-=== Decentralized
+=== Publish
 
-Ronin does not have a central repository of exploits and payloads which
-all developers contribute to. Instead Ronin has Overlays, repositories of
-code that can be hosted on any CVS/SVN/Git/Rsync server. Users can then use
-Ronin to quickly install or update Overlays. This allows developers and
-users to form their own communities, independent of the main developers
-of Ronin.
+Ronin allows users to publish and share code, exploits, payloads or other
+data via Overlays. Overlays are directories of code and data that can be
+hosted on any SVN, Hg, Git or Rsync server. Ronin makes it easy to create,
+install or update Overlays.
 
 == FEATURES:
 
+* Provides {Ronin::Generators::Generator}, a Thor based generator class that
+  can be used to create new generators.
+* Provides {Ronin::Generators::DirGenerator}, a Thor based generator that
+  can be used to create new directory generators.
 * Generators for Overlays and Extensions.
 
-== REQUIREMENTS:
+== SYNOPSIS:
 
-* {ronin}[http://ronin.rubyforge.org/] >= 0.2.2
+* Generate a skeleton Overlay:
 
-== INSTALL:
+    $ ronin-gen overlay PATH [options]
 
-  $ sudo gem install ronin-gem
+* Generate a skeleton Extension:
 
-== SYNOPSIS:
+    $ ronin-gen extension PATH
 
-* Generate a skeleton Overlay:
+== REQUIREMENTS:
 
-  $ ronin-gen overlay [options] PATH
+* {ronin}[http://ronin.rubyforge.org/] >= 0.3.0
 
-* Generate a skeleton Extension:
+== INSTALL:
 
-  $ ronin-gen extension PATH
+  $ sudo gem install ronin-gen
 
 == LICENSE:
 

data/Rakefile

@@ -4,12 +4,22 @@ require 'rubygems'
 require 'hoe'
 require 'hoe/signing'
 require './tasks/spec.rb'
+require './tasks/yard.rb'
 
 Hoe.spec('ronin-gen') do
   self.rubyforge_name = 'ronin'
   self.developer('Postmodern', 'postmodern.mod3@gmail.com')
   self.remote_rdoc_dir = 'docs/ronin-gen'
-  self.extra_deps = [['ronin', '>=0.2.4']]
+  self.extra_deps = [
+    ['ronin', '>=0.3.0']
+  ]
+
+  self.extra_dev_deps = [
+    ['rspec', '>=1.2.8'],
+    ['yard', '>=0.2.3.5']
+  ]
+
+  self.spec_extras = {:has_rdoc => 'yard'}
 end
 
 # vim: syntax=Ruby

data/bin/ronin-gen

@@ -13,7 +13,7 @@ require 'ronin/ui/command_line'
 if (ARGV.length > 0 && ARGV.first[0..0] != '-')
   ARGV[0] = "gen_#{ARGV.first}"
 
-  Ronin::UI::CommandLine.run(*ARGV)
+  Ronin::UI::CommandLine.start
 else
-  Ronin::UI::CommandLine::Commands::Gen.run(*ARGV)
+  Ronin::UI::CommandLine::Commands::Gen.start
 end

data/bin/ronin-gen-extension

@@ -9,4 +9,4 @@ end
 
 require 'ronin/ui/command_line/commands/gen_extension'
 
-Ronin::UI::CommandLine::Commands::GenExtension.run(*ARGV)
+Ronin::UI::CommandLine::Commands::GenExtension.start

data/bin/ronin-gen-overlay

@@ -9,4 +9,4 @@ end
 
 require 'ronin/ui/command_line/commands/gen_overlay'
 
-Ronin::UI::CommandLine::Commands::GenOverlay.run(*ARGV)
+Ronin::UI::CommandLine::Commands::GenOverlay.start

data/lib/ronin/generators.rb

@@ -1,5 +1,4 @@
 #
-#--
 # Ronin Gen - A Ruby library for Ronin that provides various generators.
 #
 # Copyright (c) 2009 Hal Brodigan (postmodern.mod3 at gmail.com)
@@ -17,7 +16,6 @@
 # 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/generators/generator'

data/lib/ronin/generators/dir_generator.rb

@@ -1,5 +1,4 @@
 #
-#--
 # Ronin Gen - A Ruby library for Ronin that provides various generators.
 #
 # Copyright (c) 2009 Hal Brodigan (postmodern.mod3 at gmail.com)
@@ -17,24 +16,56 @@
 # 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/generators/generator'
 
+require 'fileutils'
+
 module Ronin
   module Generators
     class DirGenerator < Generator
 
+      argument :path, :type => :string, :require => true
+
+      #
+      # Invokes the generator.
+      #
+      # @param [String] path
+      #   The directory to generate within.
+      #
+      # @param [Hash] options
+      #   Additional command-line options for the generator.
       #
-      # Creates a directory at the specified _path_ then runs the
-      # generator.
+      # @param [Array] arguments
+      #   Additional command-line arguments for the generator.
       #
-      def run(path)
+      # @example
+      #   gen.generate('path/to/dir')
+      #
+      def self.generate(path,options={},arguments=[])
         path = File.expand_path(path)
-        FileUtils.mkdir_p(path)
 
-        return super(path)
+        generator = self.new([path] + arguments, options)
+        generator.invoke()
+      end
+
+      no_tasks do
+        #
+        # Invokes the tasks of the generator.
+        #
+        # @param [Array] names
+        #   The task names to invoke.
+        #
+        def invoke(*names,&block)
+          if self.path
+            self.destination_root = self.path
+          end
+
+          inside() do |path|
+            super(*names,&block)
+          end
+        end
       end
 
     end

data/lib/ronin/generators/generator.rb

@@ -1,5 +1,4 @@
 #
-#--
 # Ronin Gen - A Ruby library for Ronin that provides various generators.
 #
 # Copyright (c) 2009 Hal Brodigan (postmodern.mod3 at example.com)
@@ -17,141 +16,147 @@
 # 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/templates/template'
 require 'ronin/static/finders'
-require 'ronin/templates/erb'
 
-require 'fileutils'
+require 'extlib'
+require 'erb'
+require 'thor'
 
 module Ronin
   module Generators
-    class Generator
+    class Generator < Thor::Group
 
+      include Thor::Actions
+      include Templates::Template
       include Static::Finders
-      include Templates::Erb
 
-      #
-      # Runs the generator with the specified _path_.
-      #
-      def run(path)
-        path = File.expand_path(path)
-        @path = path
-
-        generate!
-
-        @path = nil
-        return path
+      def self.inherited(super_class)
+        class_name = super_class.name.split('::').last.snake_case
+        super_class.namespace("ronin #{class_name}")
       end
 
-      protected
-
       #
-      # Default method which invokes the generator.
+      # Defines the default source root of the generator as the current
+      # working directory.
       #
-      def generate!
+      # @since 0.2.0
+      #
+      def self.source_root
+        Dir.pwd
       end
 
       #
-      # Returns the absolute form of the specified _path_, with respect to
-      # the +path+ instance variable.
+      # Invokes the generator.
       #
-      def expand_path(sub_path)
-        return @path if (sub_path.nil? || sub_path == @path)
-        return File.expand_path(File.join(@path,sub_path))
-      end
-
+      # @param [Hash] options
+      #   Class options to use with the generator.
       #
-      # Prints the specified _sub_path_.
+      # @param [Array] arguments
+      #   Additional arguments for the generator.
       #
-      def print_path(sub_path)
-        full_path = expand_path(sub_path)
-
-        sub_path = File.join('.',sub_path)
-        sub_path << File::SEPARATOR if File.directory?(full_path)
-
-        puts "  #{sub_path}"
+      # @example
+      #   gen.generate
+      #
+      # @since 0.2.0
+      #
+      def self.generate(options={},arguments=[])
+        generator = self.new(arguments, options)
+        generator.invoke()
       end
 
+      desc "default generator task"
+
       #
-      # Touches the file at the specified _sub_path_.
+      # Default generator method.
       #
-      #   touch 'init.rb'
+      # @since 0.2.0
       #
-      def touch(sub_path)
-        FileUtils.touch(expand_path(sub_path))
-
-        print_path(sub_path)
-        return sub_path
+      def generate
       end
 
+      protected
+
       #
-      # Opens the file at the specified _sub_path_. If a _block_ is given,
-      # it will be passed a newly created File object.
+      # Touches a file.
       #
-      #   file('metadata.xml') do |file|
-      #     ...
-      #   end
+      # @param [String] destination
+      #   The relative path to the file to touch.
       #
-      def file(sub_path,&block)
-        File.open(expand_path(sub_path),'w',&block)
-
-        print_path(sub_path)
-        return sub_path
+      # @example
+      #   touch 'TODO.txt'
+      #
+      # @since 0.2.0
+      #
+      def touch(destination)
+        create_file(destination)
       end
 
       #
-      # Creates a directory at the specified _sub_path_. If a _block_ is
-      # given, it will be passed the _sub_path_ after the directory has
-      # been created.
+      # Creates an empty directory.
       #
-      #   directory 'objects'
-      #   # => "objects"
+      # @param [String] destination
+      #   The relative path of the directory to create.
       #
-      def directory(sub_path,&block)
-        FileUtils.mkdir_p(expand_path(sub_path))
-
-        print_path(sub_path)
-        block.call(sub_path) if block
-        return sub_path
+      # @example
+      #   directory 'sub/dir'
+      #
+      # @since 0.2.0
+      #
+      def mkdir(destination)
+        empty_directory(destination)
       end
 
       #
-      # Copies the _static_file_ to the specified _sub_path_.
+      # Copies a static-file.
       #
-      #   copy 'ronin/platform/generators/extension.rb', 'myext/extension.rb'
-      #   # => "myext/extension.rb"
+      # @param [String] static_file
+      #   The relative path to the static file.
       #
-      def copy(static_file,sub_path)
-        static_file = find_static_file(static_file)
-
-        FileUtils.cp(static_file,expand_path(sub_path))
-
-        print_path(sub_path)
-        return sub_path
-      end
-
+      # @param [String] destination
+      #   The destination to copy the static file to.
       #
-      # Renders the ERB template using the specified _static_file_.
+      # @example
+      #   copy_file 'ronin/platform/generators/extension.rb',
+      #             'myext/extension.rb'
       #
-      #   render_template 'ronin/platform/generators/Rakefile.erb'
-      #   # => "..."
+      # @since 0.2.0
       #
-      def render_template(static_file)
-        erb_file(find_static_file(static_file))
+      def copy_file(static_file,destination)
+        super(find_static_file(static_file),destination)
       end
 
       #
-      # Renders the ERB template using the specified _static_file_,
-      # saving the result to the specified _sub_path_.
+      # Renders the ERB template at the specified _template_path_ and
+      # saves the result at the given _destination_.
+      #
+      # @param [String] template_path
+      #   The relative path to the template.
+      #
+      # @param [String, nil] destination
+      #   The destination to write the result of the rendered template to.
+      #
+      # @return [nil, String]
+      #   If destination is +nil+, the result of the rendered template
+      #   will be returned.
+      #
+      # @example
+      #   template 'ronin/platform/generators/Rakefile.erb', 'Rakefile.erb'
+      #
+      # @example
+      #   template '_helpers.erb'
       #
-      #   render_file 'ronin/platform/generators/Rakefile.erb', 'Rakefile'
-      #   # => nil
+      # @since 0.2.0
       #
-      def render_file(static_file,sub_path)
-        file(sub_path) do |file|
-          file.write(render_template(static_file))
+      def template(template_path,destination=nil)
+        enter_template(template_path) do |path|
+          if destination
+            super(path,destination)
+          else
+            ERB.new(File.read(path)).result(binding).chomp
+          end
         end
       end