ronin-gen 0.1.0 → 0.1.1

data/History.txt

@@ -1,3 +1,21 @@
+=== 0.1.1 / 2009-07-02
+
+* Use Hoe >= 2.0.0.
+* Require Ronin >= 0.2.4.
+* Added Generator#touch.
+* Added Ronin::UI::CommandLine::Commands::Gen for listing and
+  invoking generators.
+* Added more defaults to Ronin::Generators::Platform::Overlay:
+  * Default maintainer.
+  * Default license.
+  * Default description.
+* Added the --version option to the ronin-gen command.
+* Removed the --list option from the ronin-gen command.
+* Make sure Ronin::Generators::Platform::Overlay creates an
+  empty lib/init.rb file.
+* Fixed a bug in the ronin-gen command, where generator names
+  were not being sanitized.
+
 === 0.1.0 / 2009-03-27
 
 * Initial release.

data/Manifest.txt

@@ -16,6 +16,7 @@ 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
@@ -23,10 +24,11 @@ spec/spec_helper.rb
 spec/generated_overlay_examples.rb
 spec/generated_extension_examples.rb
 spec/generators/helpers/generators.rb
-spec/generators/helpers/generators/file_generator.rb
-spec/generators/helpers/generators/dir_generator.rb
-spec/generators/helpers/generators/templated_generator.rb
 spec/generators/helpers/static/generators/templated.txt.erb
+spec/generators/classes/file_generator.rb
+spec/generators/classes/touch_generator.rb
+spec/generators/classes/dir_generator.rb
+spec/generators/classes/templated_generator.rb
 spec/generators/generator_spec.rb
 spec/generators/generators_spec.rb
 spec/generators/platform/overlay_spec.rb

data/Rakefile

@@ -2,14 +2,14 @@
 
 require 'rubygems'
 require 'hoe'
+require 'hoe/signing'
 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']]
+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']]
 end
 
 # vim: syntax=Ruby

data/bin/ronin-gen

@@ -7,10 +7,13 @@ unless $LOAD_PATH.include?(lib_dir)
   $LOAD_PATH << lib_dir
 end
 
+require 'ronin/ui/command_line/commands/gen'
 require 'ronin/ui/command_line'
 
-if ARGV.length > 0
-  ARGV[0] = "gen-#{ARGV.first}"
-end
+if (ARGV.length > 0 && ARGV.first[0..0] != '-')
+  ARGV[0] = "gen_#{ARGV.first}"
 
-Ronin::UI::CommandLine.run(*ARGV)
+  Ronin::UI::CommandLine.run(*ARGV)
+else
+  Ronin::UI::CommandLine::Commands::Gen.run(*ARGV)
+end

data/lib/ronin/generators/generator.rb

@@ -21,15 +21,16 @@
 #
 
 require 'ronin/static/finders'
+require 'ronin/templates/erb'
 
 require 'fileutils'
-require 'erb'
 
 module Ronin
   module Generators
     class Generator
 
       include Static::Finders
+      include Templates::Erb
 
       #
       # Runs the generator with the specified _path_.
@@ -73,6 +74,18 @@ module Ronin
         puts "  #{sub_path}"
       end
 
+      #
+      # Touches the file at the specified _sub_path_.
+      #
+      #   touch 'init.rb'
+      #
+      def touch(sub_path)
+        FileUtils.touch(expand_path(sub_path))
+
+        print_path(sub_path)
+        return 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.
@@ -126,10 +139,7 @@ module Ronin
       #   # => "..."
       #
       def render_template(static_file)
-        static_file = find_static_file(static_file)
-        erb = ERB.new(File.read(static_file))
-
-        return erb.result(binding)
+        erb_file(find_static_file(static_file))
       end
 
       #

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

@@ -47,6 +47,15 @@ module Ronin
         # The Overlay objects directory
         OBJECTS_DIR = Ronin::Platform::Overlay::OBJECTS_DIR
 
+        # Default license to use
+        DEFAULT_LICENSE = 'CC-by'
+
+        # Default maintainer to use
+        DEFAULT_MAINTAINER = {:name => 'Name', :email => 'name@example.com'}
+
+        # Default description to use
+        DEFAULT_DESCRIPTION = 'This is an Overlay'
+
         # Title of the overlay
         attr_accessor :title
 
@@ -79,23 +88,26 @@ module Ronin
         # <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>: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]
+          @license = (options[:license] || DEFAULT_LICENSE)
           @maintainers = []
           
           if options[:maintainers]
             @maintainers.merge!(options[:maintainers])
           end
 
-          @description = options[:description]
+          @description = (options[:description] || DEFAULT_DESCRIPTION)
           @tasks = Set[]
 
           if options[:tasks]
@@ -119,8 +131,11 @@ module Ronin
           @title ||= File.basename(@path).gsub(/[_\s]+/,' ').capitalize
           @source_view ||= @source
           @website ||= @source_view
+          @maintainers << DEFAULT_MAINTAINER if @maintainers.empty?
 
           directory LIB_DIR
+          touch File.join(LIB_DIR,Ronin::Platform::Overlay::INIT_FILE)
+
           directory OBJECTS_DIR
           directory 'tasks'
 
@@ -180,43 +195,37 @@ module Ronin
               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)
+            license_tag = XML::Node.new('license',doc)
+            license_tag << XML::Text.new(@license,doc)
+            root << license_tag
 
-              @maintainers.each do |author|
-                if (author[:name] || author[:email])
-                  maintainer_tag = XML::Node.new('maintainer',doc)
+            maintainers_tag = XML::Node.new('maintainers',doc)
 
-                  if author[:name]
-                    name_tag = XML::Node.new('name',doc)
-                    name_tag << XML::Text.new(author[:name],doc)
-                    maintainer_tag << name_tag
-                  end
+            @maintainers.each do |author|
+              if (author[:name] || author[:email])
+                maintainer_tag = XML::Node.new('maintainer',doc)
 
-                  if author[:email]
-                    email_tag = XML::Node.new('email',doc)
-                    email_tag << XML::Text.new(author[:email],doc)
-                    maintainer_tag << email_tag
-                  end
+                if author[:name]
+                  name_tag = XML::Node.new('name',doc)
+                  name_tag << XML::Text.new(author[:name],doc)
+                  maintainer_tag << name_tag
+                end
 
-                  maintainers_tag << maintainer_tag
+                if author[:email]
+                  email_tag = XML::Node.new('email',doc)
+                  email_tag << XML::Text.new(author[:email],doc)
+                  maintainer_tag << email_tag
                 end
-              end
 
-              root << maintainers_tag
+                maintainers_tag << maintainer_tag
+              end
             end
 
-            if @description
-              description_tag = XML::Node.new('description',doc)
-              description_tag << XML::Text.new(@description,doc)
-              root << description_tag
-            end
+            root << maintainers_tag
+
+            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)

data/lib/ronin/generators/version.rb

@@ -23,6 +23,6 @@
 module Ronin
   module Generators
     # Ronin Gen version
-    VERSION = '0.1.0'
+    VERSION = '0.1.1'
   end
 end

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

@@ -0,0 +1,63 @@
+#
+#--
+# 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/version'
+require 'ronin/ui/command_line/command'
+require 'ronin/ui/command_line/command_line'
+
+module Ronin
+  module UI
+    module CommandLine
+      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')
+          end
+
+          def arguments(*args)
+            puts CommandLine.commands.map { |name|
+              if name =~ /^gen_/
+                name.gsub(/^gen_/,'  ')
+              else
+                nil
+              end
+            }.compact.sort
+          end
+
+        end
+      end
+    end
+  end
+end

data/spec/generators/classes/touch_generator.rb

@@ -0,0 +1,11 @@
+require 'ronin/generators/generator'
+
+class TouchGenerator < Generators::Generator
+
+  protected
+
+  def generate!
+    touch('test2.txt')
+  end
+
+end

data/spec/generators/generator_spec.rb

@@ -2,6 +2,11 @@ require 'ronin/generators/generator'
 
 require 'spec_helper'
 require 'generators/helpers/generators'
+require 'generators/classes/file_generator'
+require 'generators/classes/touch_generator'
+require 'generators/classes/dir_generator'
+require 'generators/classes/templated_generator'
+
 
 require 'tmpdir'
 require 'fileutils'
@@ -20,6 +25,13 @@ describe Generators::Generator do
     File.read(File.join(@dir,'test.txt')).should == "hello\n"
   end
 
+  it "should touch files" do
+    generator = TouchGenerator.new
+    generator.run(@dir)
+
+    File.file?(File.join(@dir,'test2.txt')).should == true
+  end
+
   it "should generate directories" do
     generator = DirGenerator.new
     generator.run(@dir)

data/spec/generators/helpers/generators.rb

@@ -1,7 +1,3 @@
 require 'ronin/static/static'
 
-require 'generators/helpers/generators/file_generator'
-require 'generators/helpers/generators/dir_generator'
-require 'generators/helpers/generators/templated_generator'
-
 Static.directory File.join(File.dirname(__FILE__),'static')

metadata

@@ -1,15 +1,36 @@
 --- !ruby/object:Gem::Specification 
 name: ronin-gen
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Postmodern
 autorequire: 
 bindir: bin
-cert_chain: []
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDQDCCAiigAwIBAgIBADANBgkqhkiG9w0BAQUFADBGMRgwFgYDVQQDDA9wb3N0
+  bW9kZXJuLm1vZDMxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixk
+  ARkWA2NvbTAeFw0wOTA2MDMwNDU5MDNaFw0xMDA2MDMwNDU5MDNaMEYxGDAWBgNV
+  BAMMD3Bvc3Rtb2Rlcm4ubW9kMzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYK
+  CZImiZPyLGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
+  1wvANkTDHFgVih5XLjuTwTZjgBq1lBGybXJiH6Id1lY2JOMqM5FB1DDHVvvij94i
+  mJabN0zkzu6VKWC70y0IwOxY7CPokr0eFdK/D0y7mCq1P8QITv76i2YqAl0eYqIt
+  W+IhIkANQ7E6uMZIZcdnfadC6lPAtlKkqtd9crvRbFgr6e3kyflmohbRnTEJHoRd
+  7SHHsybE6DSn7oTDs6XBTNrNIn5VfZA0z01eeos/+zBm1zKJOK2+/7xtLLDuDU9G
+  +Rd+ltUBbvxUrMNZmDG29pnmN2xTRH+Q8HxD2AxlvM5SRpK6OeZaHV7PaCCAVZ4L
+  T9BFl1sfMvRlABeGEkSyuQIDAQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIE
+  sDAdBgNVHQ4EFgQUKwsd+PqEYmBvyaTyoL+uRuk+PhEwDQYJKoZIhvcNAQEFBQAD
+  ggEBAB4TvHsrlbcXcKg6gX5BIb9tI+zGkpzo0Z7jnxMEcNO7NGGwmzafDBI/xZYv
+  xkRH3/HXbGGYDOi6Q6gWt5GujSx0bOImDtYTJTH8jnzN92HzEK5WdScm1QpZKF1e
+  cezArMbxbSPaosxTCtG6LQTkE28lFQsmFZ5xzouugS4h5+LVJiVMmiP+l3EfkjFa
+  GOURU+rNEMPWo8MCWivGW7jes6BMzWHcW7DQ0scNVmIcCIgdyMmpscuAEOSeghy9
+  /fFs57Ey2OXBL55nDOyvN/ZQ2Vab05UH4t+GCxjAPeirzL/29FBtePT6VD44c38j
+  pDj+ws7QjtH/Qcrr1l9jfN0ehDs=
+  -----END CERTIFICATE-----
 
-date: 2009-03-27 00:00:00 -07:00
+date: 2009-07-08 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +41,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.2.2
+        version: 0.2.4
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
@@ -30,9 +51,14 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.11.0
+        version: 2.3.2
     version: 
-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.
+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.
 email: 
 - postmodern.mod3@gmail.com
 executables: 
@@ -65,6 +91,7 @@ files:
 - lib/ronin/generators/platform/overlay.rb
 - lib/ronin/generators/platform/extension.rb
 - lib/ronin/generators/platform/spec.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
@@ -72,10 +99,11 @@ files:
 - spec/generated_overlay_examples.rb
 - spec/generated_extension_examples.rb
 - spec/generators/helpers/generators.rb
-- spec/generators/helpers/generators/file_generator.rb
-- spec/generators/helpers/generators/dir_generator.rb
-- spec/generators/helpers/generators/templated_generator.rb
 - spec/generators/helpers/static/generators/templated.txt.erb
+- spec/generators/classes/file_generator.rb
+- spec/generators/classes/touch_generator.rb
+- spec/generators/classes/dir_generator.rb
+- spec/generators/classes/templated_generator.rb
 - spec/generators/generator_spec.rb
 - spec/generators/generators_spec.rb
 - spec/generators/platform/overlay_spec.rb
@@ -86,6 +114,8 @@ files:
 - static/ronin/platform/generators/spec/spec_helper.rb
 has_rdoc: true
 homepage: http://ronin.rubyforge.org/gen/
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -107,9 +137,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: ronin
-rubygems_version: 1.3.1
+rubygems_version: 1.3.4
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Ronin Gen is a Ruby library for Ronin that provides various generators
 test_files: []