ronin-gen 1.0.1 → 1.1.0.rc1

data/lib/ronin/gen/generators/library.rb

@@ -32,48 +32,47 @@ module Ronin
       #
       class Library < DirGenerator
 
-        # Default version of the library
-        DEFAULT_VERSION = '0.1.0'
-
         # Default license of the library
         DEFAULT_LICENSE = 'GPL-2'
 
-        # Default author of the library
-        DEFAULT_AUTHOR = 'Author'
-
-        # Default email of the library
-        DEFAULT_EMAIL = 'name@host.com'
-
-        # Default homepage for the library
-        DEFAULT_HOMEPAGE = 'http://ronin-ruby.github.com/'
-
         # Directory to store command classes in
         COMMANDS_DIR = File.join('lib',UI::CLI::Commands.namespace_root)
 
         # Directory to store generator classes in
         GENERATORS_DIR = File.join('lib',Generators.namespace_root)
 
-        desc 'Generates a new Ronin library'
-        class_option :name, :type => :string
-        class_option :version, :type => :string, :default => DEFAULT_VERSION
-        class_option :author, :type => :string, :default => DEFAULT_AUTHOR
-        class_option :email, :type => :string, :default => DEFAULT_EMAIL
-        class_option :homepage, :type => :string,
-                                :default => DEFAULT_HOMEPAGE
+        data_dir File.join('ronin','gen','library')
+
+        parameter :name, :type => String
+
+        parameter :version, :type    => String,
+                            :default => '0.1.0'
+
+        parameter :author, :type    => String,
+                          :default => 'Author'
+
+        parameter :email, :type    => String,
+                          :default => 'name@host.com'
+
+        parameter :homepage, :type    => String,
+                             :default => 'http://ronin-ruby.github.com/'
 
-        class_option :commands, :type => :array,
-                                :default => [],
-                                :banner => 'NAME [...]'
+        parameter :commands, :type    => Array[String],
+                             :default => []
 
-        class_option :generators, :type => :array,
-                                  :default => [],
-                                  :banner => 'NAME [...]'
+        parameter :generators, :type    => Array[String],
+                               :default => []
 
-        class_option :no_git, :type => :boolean
+        parameter :no_git, :type => true
 
+        #
+        # Sets up the library generator.
+        #
         def setup
-          @name = (options[:name] || File.basename(self.path))
-          @dir_name = @name.gsub(/^ronin[-_]/,'')
+          super
+
+          @name      ||= File.basename(@path)
+          @dir_name    = @name.gsub(/^ronin[-_]/,'')
           @module_name = @dir_name.capitalize
 
           @title = @name.split(/[\s_-]+/).map { |word|
@@ -82,133 +81,100 @@ module Ronin
 
           @license = DEFAULT_LICENSE
 
-          @author = options[:author]
-          @email = options[:email]
           @safe_email = @email.gsub(/\s*@\s*/,' at ')
-          @homepage = options[:homepage]
+
+          @bin_script = File.join('bin',"ronin-#{@dir_name}")
         end
 
         #
         # Generates top-level files.
         #
         def generate
-          unless options[:no_git]
-            inside { run "git init" }
+          unless no_git?
+            run "git init"
           end
 
-          erb File.join('ronin','gen','library','Gemfile.erb'), 'Gemfile'
-          cp File.join('ronin','gen','library','Rakefile'), 'Rakefile'
+          template 'Gemfile.erb', 'Gemfile'
+          cp 'Rakefile'
 
-          erb File.join('ronin','gen','library','name.gemspec.erb'),
-              "#{@name}.gemspec"
-          erb File.join('ronin','gen','library','gemspec.yml.erb'),
-              'gemspec.yml'
+          template 'name.gemspec.erb', "#{@name}.gemspec"
+          template 'gemspec.yml.erb', 'gemspec.yml'
 
-          unless options[:no_git]
-            cp File.join('ronin','gen','library','.gitignore'), '.gitignore'
+          unless no_git?
+            cp '.gitignore'
           end
 
-          cp File.join('ronin','gen','library','.rspec'), '.rspec'
-          cp File.join('ronin','gen','library','.document'), '.document'
-          erb File.join('ronin','gen','library','.yardopts.erb'),
-              '.yardopts'
+          cp '.rspec'
+          cp '.document'
+          template '.yardopts.erb', '.yardopts'
 
-          cp File.join('ronin','gen','library','COPYING.txt'), 'COPYING.txt'
+          cp 'COPYING.txt'
 
-          erb File.join('ronin','gen','library','ChangeLog.md.erb'),
-             'ChangeLog.md'
-
-          erb File.join('ronin','gen','library','README.md.erb'),
-             'README.md'
-
-          mkdir 'data'
-        end
+          template 'ChangeLog.md.erb', 'ChangeLog.md'
+          template 'README.md.erb', 'README.md'
 
-        #
-        # Generates the contents of the `bin` directory.
-        #
-        def bin
           mkdir 'bin'
 
-          bin_script = File.join('bin',"ronin-#{@dir_name}")
+          template File.join('bin','ronin-name.erb'), @bin_script
+          chmod 0755, @bin_script
 
-          erb File.join('ronin','gen','library','bin','ronin-name.erb'),
-              bin_script
-          chmod bin_script, 0755
-        end
+          mkdir_p File.join('lib','ronin',@dir_name)
 
-        #
-        # Generates the contents of the `lib` directory.
-        #
-        def lib
-          mkdir File.join('lib','ronin',@dir_name)
+          template File.join('lib','ronin','name.rb.erb'),
+                   File.join('lib','ronin',"#{@dir_name}.rb")
 
-          erb File.join('ronin','gen','library','lib','ronin','name.rb.erb'),
-              File.join('lib','ronin',"#{@dir_name}.rb")
+          template File.join('lib','ronin','name','version.rb.erb'),
+                   File.join('lib','ronin',@dir_name,'version.rb')
 
-          erb File.join('ronin','gen','library','lib','ronin','name','version.rb.erb'),
-              File.join('lib','ronin',@dir_name,'version.rb')
-        end
+          mkdir 'data'
 
-        #
-        # Generates the test suite.
-        #
-        def test_suite
           mkdir 'spec'
-          erb File.join('ronin','gen','library','spec','spec_helper.rb.erb'),
-              File.join('spec','spec_helper.rb')
+          template File.join('spec','spec_helper.rb.erb'),
+                   File.join('spec','spec_helper.rb')
 
           mkdir File.join('spec',@dir_name)
-          erb File.join('ronin','gen','library','spec','name','name_spec.rb.erb'),
-              File.join('spec',@dir_name,"#{@dir_name}_spec.rb")
+          template File.join('spec','name','name_spec.rb.erb'),
+                   File.join('spec',@dir_name,"#{@dir_name}_spec.rb")
+
+          generate_commands   unless @commands.empty?
+          generate_generators unless @generators.empty?
+
+          unless no_git?
+            run 'git add .'
+            run 'git commit -m "Initial commit."'
+          end
         end
 
         #
         # Generates any optional commands for the library.
         #
-        def commands
-          unless options[:commands].empty?
-            mkdir COMMANDS_DIR
+        def generate_commands
+          mkdir COMMANDS_DIR
 
-            options[:commands].each do |name|
-              @command_file = name.downcase.gsub(/[_-]+/,'_')
-              @command_class = @command_file.to_const_string
+          @commands.each do |name|
+            @command_file  = name.downcase.gsub(/[_-]+/,'_')
+            @command_class = @command_file.to_const_string
 
-              erb File.join('ronin','gen','library','bin','ronin-command.erb'),
-                  File.join('bin','ronin-' + @command_file.gsub('_','-'))
+            template File.join('bin','ronin-command.erb'),
+              File.join('bin','ronin-' + @command_file.gsub('_','-'))
 
-              erb File.join('ronin','gen','library',COMMANDS_DIR,'command.rb.erb'),
-                  File.join(COMMANDS_DIR,"#{@command_file}.rb")
-            end
+            template File.join(COMMANDS_DIR,'command.rb.erb'),
+                     File.join(COMMANDS_DIR,"#{@command_file}.rb")
           end
         end
 
         #
         # Generates any optional generators for the library.
         #
-        def gen
-          unless options[:generators].empty?
-            mkdir GENERATORS_DIR
-
-            options[:generators].each do |name|
-              @generator_file = name.downcase.gsub(/[_-]+/,'_')
-              @generator_class = @generator_file.to_const_string
+        def generate_generators
+          mkdir GENERATORS_DIR
 
-              erb File.join('ronin','gen','library',GENERATORS_DIR,'generator.rb.erb'),
-                  File.join(GENERATORS_DIR,"#{@generator_file}.rb")
-            end
-          end
-        end
+          @generators.each do |name|
+            @generator_file  = name.downcase.gsub(/[_-]+/,'_')
+            @generator_class = @generator_file.to_const_string
 
-        #
-        # Finalizes the generated library.
-        #
-        def finalize
-          unless options[:no_git]
-            inside do
-              run('git add .')
-              run('git commit -m "Initial commit."')
-            end
+            template File.join(GENERATORS_DIR,'generator.rb.erb'),
+                     File.join(GENERATORS_DIR,"#{@generator_file}.rb")
           end
         end
 

data/lib/ronin/gen/generators/repository.rb

@@ -22,8 +22,6 @@ require 'ronin/gen/dir_generator'
 require 'ronin/repository'
 require 'ronin/version'
 
-require 'set'
-
 module Ronin
   module Gen
     module Generators
@@ -41,103 +39,66 @@ module Ronin
         # The primary script directory
         SCRIPT_DIR = Ronin::Repository::SCRIPT_DIRS.first
 
-        # Default license to use
-        DEFAULT_LICENSE = 'CC-by'
-
         # Default authors to use
-        DEFAULT_AUTHORS = ['Anonymous']
+        DEFAULT_AUTHOR = 'Anonymous'
 
-        # Default description to use
-        DEFAULT_DESCRIPTION = 'This is a Ronin Repository'
+        data_dir File.join('ronin','gen','repository')
 
-        desc 'Generates a new Ronin Repository'
-        class_option :title, :type => :string
-        class_option :uri, :type => :string
-        class_option :source, :type => :string
-        class_option :website, :type => :string
+        parameter :title, :type => String
+        parameter :uri, :type => String
+        parameter :source, :type => String
+        parameter :website, :type => String
 
-        class_option :license, :type => :string,
-                               :default => DEFAULT_LICENSE,
-                               :banner => 'LICENSE'
+        parameter :license, :type    => String,
+                            :default => 'CC-by'
 
-        class_option :description, :type => :string,
-                                   :default => DEFAULT_DESCRIPTION,
-                                   :banner => 'TEXT'
+        parameter :description, :type    => String,
+                                :default => 'This is a Ronin Repository'
 
-        class_option :authors, :type => :array,
-                               :default => DEFAULT_AUTHORS,
-                               :banner => 'NAME [...]'
+        parameter :authors, :type    => Array[String],
+                            :default => []
 
-        class_option :tests, :type => :boolean
-        class_option :docs, :type => :boolean
+        parameter :tests, :type => true
+        parameter :docs, :type => true
 
+        #
+        # Sets up the repository generator.
+        #
         def setup
-          @title = options[:title]
-          @uri = options[:uri]
-          @source = options[:source]
-          @website = options[:website]
-          @license = options[:license]
-          @description = options[:description]
-          @authors = options[:authors]
-
-          @test_suite = options[:test]
-          @docs = options[:docs]
-
-          @title ||= File.basename(self.path).gsub(/[_\s]+/,' ').capitalize
+          @title   ||= File.basename(@path).gsub(/[_\s]+/,' ').capitalize
           @website ||= @source
+
+          if @authors.empty?
+            @authors << DEFAULT_AUTHOR
+          end
         end
 
         #
         # Generates a skeleton repository.
         #
         def generate
+          template 'ronin.yml.erb', 'ronin.yml'
+          template 'Rakefile.erb', 'Rakefile'
+
           mkdir LIB_DIR
           mkdir File.join(LIB_DIR,'ronin')
           touch File.join(LIB_DIR,Ronin::Repository::INIT_FILE)
 
           mkdir SCRIPT_DIR
           mkdir Ronin::Repository::DATA_DIR
-        end
 
-        #
-        # Generates the Rakefile of the repository.
-        #
-        def rakefile
-          erb File.join('ronin','gen','repository','Rakefile.erb'),
-              'Rakefile'
-        end
+          if docs?
+            template '.yardopts.erb', '.yardopts'
+          end
 
-        #
-        # Generates a base RSpec test-suite for the repository.
-        #
-        def tests
-          if options.tests?
-            cp File.join('ronin','gen','repository','.rspec'), '.rspec'
+          if tests?
+            cp '.rspec'
 
             mkdir 'spec'
-            cp File.join('ronin','gen','repository','spec','spec_helper.rb'),
-               File.join('spec','spec_helper.rb')
+            cp File.join('spec','spec_helper.rb')
           end
         end
 
-        #
-        # Generate files needed for documentation.
-        #
-        def docs
-          if options.docs?
-            erb File.join('ronin','gen','repository','.yardopts.erb'),
-                '.yardopts'
-          end
-        end
-
-        #
-        # Generates the XML metadata file for the repository.
-        #
-        def metadata
-          erb File.join('ronin','gen','repository','ronin.yml.erb'),
-              'ronin.yml'
-        end
-
       end
     end
   end

data/lib/ronin/gen/ruby_generator.rb

@@ -26,7 +26,7 @@ module Ronin
     #
     class RubyGenerator < SourceCodeGenerator
 
-      file_extension! :rb
+      file_extension :rb
 
     end
   end

data/lib/ronin/gen/source_code_generator.rb

@@ -22,21 +22,54 @@ require 'ronin/gen/file_generator'
 module Ronin
   module Gen
     #
-    # A {FileGenerator} class for creating Ruby files.
+    # A {FileGenerator} class for creating source-code files.
     #
     class SourceCodeGenerator < FileGenerator
 
-      class_option :editor, :default => ENV['EDITOR']
-      class_option :no_edit, :type => :boolean, :default => false
+      parameter :editor, :type => String,
+                         :default => ENV['EDITOR']
 
+      parameter :no_edit, :type => true,
+                          :default => false
+
+      #
+      # Generates the source code file and spawns a text-editor.
       #
-      # Generates the source-code file and spawns a text-editor.
+      # @since 1.1.0
       #
-      def self.generate(options={},arguments=[],&block)
-        generator = super(options,arguments,&block)
+      # @api semipublic
+      #
+      def generate
+        template self.class.template, @path
+
+        if (no_edit? && editor?)
+          # spawn the text editor for the newly generated file
+          system(editor,@path)
+        end
+      end
+
+      protected
 
-        if (generator.options.no_edit? && generator.options.editor)
-          system(generator.options.editor,generator.path)
+      #
+      # The template the Source Code Generator will use.
+      #
+      # @param [String] name
+      #   The new template name.
+      #
+      # @return [String]
+      #   The template the Source Code Generator will use.
+      #
+      # @since 1.1.0
+      #
+      # @api semipublic
+      #
+      def self.template(name=nil)
+        if name
+          @template = name
+        else
+          @template ||= if superclass < SourceCodeGenerator
+                          superclass.template
+                        end
         end
       end