ronin-gen 0.1.1 → 0.2.0

data/lib/ronin/generators/platform/extension.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/platform/static'
@@ -33,21 +31,19 @@ module Ronin
         LIB_DIR = Ronin::Platform::Extension::LIB_DIR
 
         # The default extension file
-        EXTENSION_FILE = File.join('ronin','platform','generators','extension.rb')
-
-        protected
+        EXTENSION_FILE = File.join('ronin','generators','platform','extension.rb')
 
         #
         # Generates a skeleton Extension.
         #
-        def generate!
-          name = File.basename(@path)
+        def generate
+          name = File.basename(self.path)
 
-          directory LIB_DIR
-          file File.join(LIB_DIR,name + '.rb')
-          directory File.join(LIB_DIR,name)
+          mkdir LIB_DIR
+          touch File.join(LIB_DIR,name + '.rb')
+          mkdir File.join(LIB_DIR,name)
 
-          copy EXTENSION_FILE, Ronin::Platform::Extension::EXTENSION_FILE
+          copy_file EXTENSION_FILE, Ronin::Platform::Extension::EXTENSION_FILE
         end
 
       end

data/lib/ronin/generators/platform/overlay.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/platform/static'
@@ -39,7 +37,7 @@ module Ronin
         METADATA_FILE = Ronin::Platform::Overlay::METADATA_FILE
 
         # The Overlay metadata XSL URL
-        METADATA_XSL = 'http://ronin.rubyforge.org/static/ronin/platform/overlay.xsl'
+        METADATA_XSL = File.join('ronin','platform','overlay.xsl')
 
         # The Overlay lib directory
         LIB_DIR = Ronin::Platform::Overlay::LIB_DIR
@@ -51,123 +49,99 @@ module Ronin
         DEFAULT_LICENSE = 'CC-by'
 
         # Default maintainer to use
-        DEFAULT_MAINTAINER = {:name => 'Name', :email => 'name@example.com'}
+        DEFAULT_MAINTAINER = {'Name' => 'name@example.com'}
 
         # Default description to use
         DEFAULT_DESCRIPTION = 'This is an Overlay'
 
-        # 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. Defaults to
-        #                     DEFUALT_LICENSE, if not given.
-        # <tt>:maintainers</tt>:: List of maintainers for the overlay.
-        # <tt>:description</tt>:: The description of the overlay.
-        #                         Defaults to DEFAULT_DESCRIPTION,
-        #                         if not given.
-        #
-        def initialize(options={})
-          @title = options[:title]
-          @source = options[:source]
-          @source_view = options[:source_view]
-          @website = options[:website]
-          @license = (options[:license] || DEFAULT_LICENSE)
-          @maintainers = []
-          
-          if options[:maintainers]
-            @maintainers.merge!(options[:maintainers])
-          end
-
-          @description = (options[:description] || DEFAULT_DESCRIPTION)
-          @tasks = Set[]
+        class_option :title, :type => :string
+        class_option :source, :type => :string
+        class_option :source_view, :type => :string
+        class_option :website, :type => :string
+        class_option :license, :type => :string, :default => DEFAULT_LICENSE
+        class_option :description, :type => :string, :default => DEFAULT_DESCRIPTION
+        class_option :maintainers, :type => :hash, :default => {}, :banner => 'NAME:EMAIL ...'
+        class_option :gems, :type => :array, :default => [], :banner => 'GEM ...'
+        class_option :tasks, :type => :array, :default => [], :banner => 'TASK ...'
+        class_option :test_suite, :type => :string, :banner => 'test|spec'
+
+        no_tasks do
+          def invoke(*names,&block)
+            @title = options[:title]
+            @source = options[:source]
+            @source_view = options[:source_view]
+            @website = options[:website]
+            @license = options[:license]
+            @description = options[:description]
+            @maintainers = options[:maintainers]
+            @gems = options[:gems]
+            @tasks = options[:tasks]
+            @test_suite = options[:test_suite]
+
+            @title ||= File.basename(self.path).gsub(/[_\s]+/,' ').capitalize
+            @source_view ||= @source
+            @website ||= @source_view
+
+            if @maintainers
+              @maintainers = DEFAULT_MAINTAINER
+            end
 
-          if options[:tasks]
-            @tasks.merge!(options[:tasks])
+            super(*names,&block)
           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
-          @maintainers << DEFAULT_MAINTAINER if @maintainers.empty?
+        def generate
+          mkdir 'static'
 
-          directory LIB_DIR
-          touch File.join(LIB_DIR,Ronin::Platform::Overlay::INIT_FILE)
+          inside File.join('static','ronin','platform') do
+            copy_file METADATA_XSL, File.basename(METADATA_XSL)
+          end
 
-          directory OBJECTS_DIR
-          directory 'tasks'
+          mkdir LIB_DIR
+          touch File.join(LIB_DIR,Ronin::Platform::Overlay::INIT_FILE)
 
-          generate_rakefile!
-          generate_metadata!
+          mkdir OBJECTS_DIR
+          mkdir 'tasks'
         end
 
         #
         # Generates the Rakefile of the Overlay.
         #
-        def generate_rakefile!
-          file('Rakefile') do |rakefile|
-            rakefile << "# -*- ruby -*-\n\n"
+        def rakefile
+          case @test_suite
+          when 'rspec', 'spec'
+            @tasks << 'spec' unless @tasks.include?('spec')
+          end
 
-            @tasks.each do |task|
-              rakefile << "require 'ronin/platform/tasks/#{task}'"
-            end
+          template File.join('ronin','generators','platform','Rakefile.erb'), 'Rakefile'
+        end
 
-            rakefile << "\n# vim: syntax=Ruby"
+        #
+        # Generates a base test suite for the Overlay.
+        #
+        def test_suite
+          case @test_suite
+          when 'test','unit'
+            mkdir 'test'
+          when 'rspec', 'spec'
+            mkdir 'spec'
+            copy_file File.join('ronin','generators','platform','spec','spec_helper.rb'),'spec'
           end
         end
 
         #
         # Generates the XML metadata file for the Overlay.
         #
-        def generate_metadata!
-          file(METADATA_FILE) do |metadata_file|
+        def metadata
+          create_file(METADATA_FILE) do
             doc = XML::Document.new
             doc << XML::ProcessingInstruction.new(
               doc,
               'xml-stylesheet',
-              "type=\"text/xsl\" href=\"#{METADATA_XSL}\""
+              "type=\"text/xsl\" href=\"static/#{METADATA_XSL}\""
             )
 
             root = XML::Node.new('ronin-overlay',doc)
@@ -177,7 +151,7 @@ module Ronin
             title_tag << XML::Text.new(@title,doc)
             root << title_tag
 
-            if @source
+            if options[:source]
               source_tag = XML::Node.new('source',doc)
               source_tag << XML::Text.new(@source,doc)
               root << source_tag
@@ -201,34 +175,45 @@ module Ronin
 
             maintainers_tag = XML::Node.new('maintainers',doc)
 
-            @maintainers.each do |author|
-              if (author[:name] || author[:email])
-                maintainer_tag = XML::Node.new('maintainer',doc)
+            @maintainers.each do |name,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
+              if name
+                name_tag = XML::Node.new('name',doc)
+                name_tag << XML::Text.new(name,doc)
+                maintainer_tag << name_tag
+              end
 
-                maintainers_tag << maintainer_tag
+              if email
+                email_tag = XML::Node.new('email',doc)
+                email_tag << XML::Text.new(email,doc)
+                maintainer_tag << email_tag
               end
+
+              maintainers_tag << maintainer_tag
             end
 
             root << maintainers_tag
 
+            unless @gems.empty?
+              dependencies_tag = XML::Node.new('dependencies',doc)
+              dependencies_tag << XML::Text.new(gems_tag,doc)
+
+              @gems.each do |gem_name|
+                gem_tag = XML::Node.new('gem',doc)
+                gem_tag << XML::Text.new(gem_name,doc)
+                dependencies_tag << gem_tag
+              end
+
+              root << dependencies_tag
+            end
+
             description_tag = XML::Node.new('description',doc)
             description_tag << XML::Text.new(@description,doc)
             root << description_tag
 
             doc << root
-            doc.write_xml_to(metadata_file)
+            doc.to_xml
           end
         end
 

data/lib/ronin/generators/platform/static.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,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/static'

data/lib/ronin/generators/version.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,12 +16,11 @@
 # 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
-#++
 #
 
 module Ronin
   module Generators
     # Ronin Gen version
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

data/lib/ronin/ui/command_line/commands/gen.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/version'
@@ -30,26 +28,17 @@ module Ronin
       module Commands
         class Gen < Command
 
-          def define_options(opts)
-            opts.usage = '[options] NAME'
-
-            opts.options do
-              opts.on('-V','--version','Print version information and exit') do
-                success { puts "Ronin Gen #{Ronin::Generators::VERSION}" }
-              end
-            end
-
-            opts.arguments(
-              'NAME' => 'Name of the Generator to run'
-            )
-
-            opts.summary('Runs the Generator with the specified NAME and options')
+          desc "version", "Prints the version and exists"
+          def version
+            puts "Ronin Gen #{Ronin::Generators::VERSION}"
+            exit
           end
 
-          def arguments(*args)
-            puts CommandLine.commands.map { |name|
+          desc "default", "Prints the list of available generators"
+          def default
+            print_array CommandLine.commands.map { |name|
               if name =~ /^gen_/
-                name.gsub(/^gen_/,'  ')
+                name.gsub(/^gen_/,'')
               else
                 nil
               end

data/lib/ronin/ui/command_line/commands/gen_extension.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,37 +16,15 @@
 # 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/ui/command_line/command'
 require 'ronin/generators/platform/extension'
 
 module Ronin
   module UI
     module CommandLine
       module Commands
-        class GenExtension < Command
-
-          def defaults
-            @generator = Generators::Platform::Extension.new
-          end
-
-          def define_options(opts)
-            opts.usage = 'PATH [...]'
-
-            opts.arguments(
-              'PATH' => 'The PATH of the Extension to be created'
-            )
-
-            opts.summary('Create an empty Extension at the specified PATH')
-          end
-
-          def arguments(*args)
-            args.each do |path|
-              @generator.run(File.expand_path(path))
-            end
-          end
+        class GenExtension < Generators::Platform::Extension
 
         end
       end

data/lib/ronin/ui/command_line/commands/gen_overlay.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,78 +16,15 @@
 # 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/ui/command_line/command'
 require 'ronin/generators/platform/overlay'
 
 module Ronin
   module UI
     module CommandLine
       module Commands
-        class GenOverlay < Command
-
-          def defaults
-            @generator = Generators::Platform::Overlay.new
-          end
-
-          def define_options(opts)
-            opts.usage = '[options] PATH'
-
-            opts.options do
-              opts.on('-t','--title NAME','Name of the Overlay') do |title|
-                @generator.title = title
-              end
-
-              opts.on('-S','--source URL','The URL where the source of the Overlay will be hosted') do |url|
-                @generator.source = url
-              end
-
-              opts.on('-V','--source-view URL','The URL for viewing the contents of the Overlay') do |url|
-                @generator.source_view = url
-              end
-
-              opts.on('-U','--website URL','The URL of the website of the Overlay') do |url|
-                @generator.website = url
-              end
-
-              opts.on('-L','--license LICENSE','The license of the contents of the Overlay') do |license|
-                @generator.license = license
-              end
-
-              opts.on('-m','--maintainer "NAME <EMAIL>"','Name of a maintainer of the Overlay') do |text|
-                name = text.scan(/^[^<]+[^<\s]/).first
-                email = text.scan(/<([^<>]+)>\s*$/).first
-
-                email = email.first if email
-
-                @generator.maintainers << {:name => name, :email => email}
-              end
-
-              opts.on('-D','--description TEXT','The description for the Overlay') do |text|
-                @generator.description = text
-              end
-
-              opts.on('--task TASK','Add the TASK to the Overlay') do |task|
-                @generator.tasks << task.to_s
-              end
-            end
-
-            opts.arguments(
-              'PATH' => 'The PATH of the Overlay to be created'
-            )
-
-            opts.summary('Create an empty Overlay at the specified PATH')
-          end
-
-          def arguments(*args)
-            unless args.length == 1
-              fail('only one Overlay path maybe specified')
-            end
-
-            @generator.run(File.expand_path(args.first))
-          end
+        class GenOverlay < Generators::Platform::Overlay
 
         end
       end