ronin-gen 0.1.0

data/Rakefile

@@ -0,0 +1,15 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './tasks/spec.rb'
+require './lib/ronin/generators/version.rb'
+
+Hoe.new('ronin-gen', Ronin::Generators::VERSION) do |p|
+  p.rubyforge_name = 'ronin'
+  p.developer('Postmodern', 'postmodern.mod3@gmail.com')
+  p.remote_rdoc_dir = 'docs/ronin-gen'
+  p.extra_deps = [['ronin', '>=0.2.2']]
+end
+
+# vim: syntax=Ruby

data/TODO.txt

@@ -0,0 +1,3 @@
+== TODO:
+
+

data/bin/ronin-gen

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+unless $LOAD_PATH.include?(lib_dir)
+  $LOAD_PATH << lib_dir
+end
+
+require 'ronin/ui/command_line'
+
+if ARGV.length > 0
+  ARGV[0] = "gen-#{ARGV.first}"
+end
+
+Ronin::UI::CommandLine.run(*ARGV)

data/bin/ronin-gen-extension

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+unless $LOAD_PATH.include?(lib_dir)
+  $LOAD_PATH << lib_dir
+end
+
+require 'ronin/ui/command_line/commands/gen_extension'
+
+Ronin::UI::CommandLine::Commands::GenExtension.run(*ARGV)

data/bin/ronin-gen-overlay

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+
+lib_dir = File.expand_path(File.join(File.dirname(__FILE__),'..','lib'))
+unless $LOAD_PATH.include?(lib_dir)
+  $LOAD_PATH << lib_dir
+end
+
+require 'ronin/ui/command_line/commands/gen_overlay'
+
+Ronin::UI::CommandLine::Commands::GenOverlay.run(*ARGV)

data/lib/ronin/generators.rb

@@ -0,0 +1,26 @@
+#
+#--
+# Ronin Gen - A Ruby library for Ronin that provides various generators.
+#
+# Copyright (c) 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 'ronin/generators/generator'
+require 'ronin/generators/dir_generator'
+require 'ronin/generators/platform'
+require 'ronin/generators/version'

data/lib/ronin/generators/dir_generator.rb

@@ -0,0 +1,42 @@
+#
+#--
+# Ronin Gen - A Ruby library for Ronin that provides various generators.
+#
+# Copyright (c) 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 'ronin/generators/generator'
+
+module Ronin
+  module Generators
+    class DirGenerator < Generator
+
+      #
+      # Creates a directory at the specified _path_ then runs the
+      # generator.
+      #
+      def run(path)
+        path = File.expand_path(path)
+        FileUtils.mkdir_p(path)
+
+        return super(path)
+      end
+
+    end
+  end
+end

data/lib/ronin/generators/generator.rb

@@ -0,0 +1,150 @@
+#
+#--
+# Ronin Gen - A Ruby library for Ronin that provides various generators.
+#
+# Copyright (c) 2009 Hal Brodigan (postmodern.mod3 at example.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/static/finders'
+
+require 'fileutils'
+require 'erb'
+
+module Ronin
+  module Generators
+    class Generator
+
+      include Static::Finders
+
+      #
+      # Runs the generator with the specified _path_.
+      #
+      def run(path)
+        path = File.expand_path(path)
+        @path = path
+
+        generate!
+
+        @path = nil
+        return path
+      end
+
+      protected
+
+      #
+      # Default method which invokes the generator.
+      #
+      def generate!
+      end
+
+      #
+      # Returns the absolute form of the specified _path_, with respect to
+      # the +path+ instance variable.
+      #
+      def expand_path(sub_path)
+        return @path if (sub_path.nil? || sub_path == @path)
+        return File.expand_path(File.join(@path,sub_path))
+      end
+
+      #
+      # Prints the specified _sub_path_.
+      #
+      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}"
+      end
+
+      #
+      # Opens the file at the specified _sub_path_. If a _block_ is given,
+      # it will be passed a newly created File object.
+      #
+      #   file('metadata.xml') do |file|
+      #     ...
+      #   end
+      #
+      def file(sub_path,&block)
+        File.open(expand_path(sub_path),'w',&block)
+
+        print_path(sub_path)
+        return sub_path
+      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.
+      #
+      #   directory 'objects'
+      #   # => "objects"
+      #
+      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
+      end
+
+      #
+      # Copies the _static_file_ to the specified _sub_path_.
+      #
+      #   copy 'ronin/platform/generators/extension.rb', 'myext/extension.rb'
+      #   # => "myext/extension.rb"
+      #
+      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
+
+      #
+      # Renders the ERB template using the specified _static_file_.
+      #
+      #   render_template 'ronin/platform/generators/Rakefile.erb'
+      #   # => "..."
+      #
+      def render_template(static_file)
+        static_file = find_static_file(static_file)
+        erb = ERB.new(File.read(static_file))
+
+        return erb.result(binding)
+      end
+
+      #
+      # Renders the ERB template using the specified _static_file_,
+      # saving the result to the specified _sub_path_.
+      #
+      #   render_file 'ronin/platform/generators/Rakefile.erb', 'Rakefile'
+      #   # => nil
+      #
+      def render_file(static_file,sub_path)
+        file(sub_path) do |file|
+          file.write(render_template(static_file))
+        end
+      end
+
+    end
+  end
+end

data/lib/ronin/generators/platform/extension.rb

@@ -0,0 +1,56 @@
+#
+#--
+# Ronin Gen - A Ruby library for Ronin that provides various generators.
+#
+# Copyright (c) 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 'ronin/generators/platform/static'
+require 'ronin/generators/dir_generator'
+require 'ronin/platform/extension'
+
+module Ronin
+  module Generators
+    module Platform
+      class Extension < DirGenerator
+
+        # The lib/ directory of the extension
+        LIB_DIR = Ronin::Platform::Extension::LIB_DIR
+
+        # The default extension file
+        EXTENSION_FILE = File.join('ronin','platform','generators','extension.rb')
+
+        protected
+
+        #
+        # Generates a skeleton Extension.
+        #
+        def generate!
+          name = File.basename(@path)
+
+          directory LIB_DIR
+          file File.join(LIB_DIR,name + '.rb')
+          directory File.join(LIB_DIR,name)
+
+          copy EXTENSION_FILE, Ronin::Platform::Extension::EXTENSION_FILE
+        end
+
+      end
+    end
+  end
+end

data/lib/ronin/generators/platform/overlay.rb

@@ -0,0 +1,229 @@
+#
+#--
+# Ronin Gen - A Ruby library for Ronin that provides various generators.
+#
+# Copyright (c) 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 'ronin/generators/platform/static'
+require 'ronin/generators/dir_generator'
+require 'ronin/platform/overlay'
+require 'ronin/version'
+
+require 'nokogiri'
+require 'set'
+
+module Ronin
+  module Generators
+    module Platform
+      class Overlay < DirGenerator
+
+        include Nokogiri
+
+        # The Overlay metadata file
+        METADATA_FILE = Ronin::Platform::Overlay::METADATA_FILE
+
+        # The Overlay metadata XSL URL
+        METADATA_XSL = 'http://ronin.rubyforge.org/static/ronin/platform/overlay.xsl'
+
+        # The Overlay lib directory
+        LIB_DIR = Ronin::Platform::Overlay::LIB_DIR
+
+        # The Overlay objects directory
+        OBJECTS_DIR = Ronin::Platform::Overlay::OBJECTS_DIR
+
+        # Title of the overlay
+        attr_accessor :title
+
+        # Source URL for the overlay
+        attr_accessor :source
+
+        # Source View URL for the overlay
+        attr_accessor :source_view
+
+        # Website of the overlay
+        attr_accessor :website
+
+        # License of the overlay
+        attr_accessor :license
+
+        # Maintainers of the overlay
+        attr_reader :maintainers
+
+        # Description of the overlay
+        attr_accessor :description
+
+        # Tasks to require for the overlay
+        attr_reader :tasks
+
+        #
+        # Creates a new Metadata object with the given _options_.
+        #
+        # _options_ may include the following keys:
+        # <tt>:title</tt>:: Title for the overlay.
+        # <tt>:source</tt>:: Source URL for the overlay.
+        # <tt>:source_view</tt>:: Source View URL for the overlay.
+        # <tt>:website</tt>:: Website for the overlay.
+        # <tt>:license</tt>:: License for the overlay.
+        # <tt>:maintainers</tt>:: List of maintainers for the overlay.
+        # <tt>:description</tt>:: The description of the overlay.
+        #
+        def initialize(options={})
+          @title = options[:title]
+          @source = options[:source]
+          @source_view = options[:source_view]
+          @website = options[:website]
+          @license = options[:license]
+          @maintainers = []
+          
+          if options[:maintainers]
+            @maintainers.merge!(options[:maintainers])
+          end
+
+          @description = options[:description]
+          @tasks = Set[]
+
+          if options[:tasks]
+            @tasks.merge!(options[:tasks])
+          end
+        end
+
+        #
+        # Adds a new maintainer with the specified _name_ and _email_.
+        #
+        def maintainer(name,email)
+          @maintainers << {:name => name, :email => email}
+        end
+
+        protected
+
+        #
+        # Generates a skeleton Overlay.
+        #
+        def generate!
+          @title ||= File.basename(@path).gsub(/[_\s]+/,' ').capitalize
+          @source_view ||= @source
+          @website ||= @source_view
+
+          directory LIB_DIR
+          directory OBJECTS_DIR
+          directory 'tasks'
+
+          generate_rakefile!
+          generate_metadata!
+        end
+
+        #
+        # Generates the Rakefile of the Overlay.
+        #
+        def generate_rakefile!
+          file('Rakefile') do |rakefile|
+            rakefile << "# -*- ruby -*-\n\n"
+
+            @tasks.each do |task|
+              rakefile << "require 'ronin/platform/tasks/#{task}'"
+            end
+
+            rakefile << "\n# vim: syntax=Ruby"
+          end
+        end
+
+        #
+        # Generates the XML metadata file for the Overlay.
+        #
+        def generate_metadata!
+          file(METADATA_FILE) do |metadata_file|
+            doc = XML::Document.new
+            doc << XML::ProcessingInstruction.new(
+              doc,
+              'xml-stylesheet',
+              "type=\"text/xsl\" href=\"#{METADATA_XSL}\""
+            )
+
+            root = XML::Node.new('ronin-overlay',doc)
+            root['version'] = Ronin::VERSION
+
+            title_tag = XML::Node.new('title',doc)
+            title_tag << XML::Text.new(@title,doc)
+            root << title_tag
+
+            if @source
+              source_tag = XML::Node.new('source',doc)
+              source_tag << XML::Text.new(@source,doc)
+              root << source_tag
+            end
+
+            if @source_view
+              source_view_tag = XML::Node.new('source-view',doc)
+              source_view_tag << XML::Text.new(@source_view,doc)
+              root << source_view_tag
+            end
+
+            if @website
+              url_tag = XML::Node.new('website',doc)
+              url_tag << XML::Text.new(@website,doc)
+              root << url_tag
+            end
+
+            if @license
+              license_tag = XML::Node.new('license',doc)
+              license_tag << XML::Text.new(@license,doc)
+              root << license_tag
+            end
+
+            unless @maintainers.empty?
+              maintainers_tag = XML::Node.new('maintainers',doc)
+
+              @maintainers.each do |author|
+                if (author[:name] || author[:email])
+                  maintainer_tag = XML::Node.new('maintainer',doc)
+
+                  if author[:name]
+                    name_tag = XML::Node.new('name',doc)
+                    name_tag << XML::Text.new(author[:name],doc)
+                    maintainer_tag << name_tag
+                  end
+
+                  if author[:email]
+                    email_tag = XML::Node.new('email',doc)
+                    email_tag << XML::Text.new(author[:email],doc)
+                    maintainer_tag << email_tag
+                  end
+
+                  maintainers_tag << maintainer_tag
+                end
+              end
+
+              root << maintainers_tag
+            end
+
+            if @description
+              description_tag = XML::Node.new('description',doc)
+              description_tag << XML::Text.new(@description,doc)
+              root << description_tag
+            end
+
+            doc << root
+            doc.write_xml_to(metadata_file)
+          end
+        end
+
+      end
+    end
+  end
+end