ronin-gen 0.2.0 → 1.0.0.pre1

data/lib/ronin/{ui/command_line/commands/gen_extension.rb → gen/generators.rb}

@@ -1,7 +1,7 @@
 #
 # Ronin Gen - A Ruby library for Ronin that provides various generators.
 #
-# Copyright (c) 2009 Hal Brodigan (postmodern.mod3 at gmail.com)
+# Copyright (c) 2009-2010 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
@@ -18,16 +18,15 @@
 # Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #
 
-require 'ronin/generators/platform/extension'
+require 'open_namespace'
 
 module Ronin
-  module UI
-    module CommandLine
-      module Commands
-        class GenExtension < Generators::Platform::Extension
-
-        end
-      end
+  module Gen
+    #
+    # {Generators} is the namespace where all generators are loaded from.
+    #
+    module Generators
+      include OpenNamespace
     end
   end
 end

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

@@ -0,0 +1,196 @@
+#
+# Ronin Gen - A Ruby library for Ronin that provides various generators.
+#
+# Copyright (c) 2009-2010 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/ui/cli/commands'
+require 'ronin/gen/dir_generator'
+require 'ronin/gen/config'
+require 'ronin/gen/version'
+require 'ronin/support/version'
+require 'ronin/version'
+
+module Ronin
+  module Gen
+    module Generators
+      #
+      # Generates a completely new Ronin library.
+      #
+      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
+        class_option :commands, :type => :array, :default => []
+        class_option :generators, :type => :array, :default => []
+        class_option :no_git, :type => :boolean
+
+        def setup
+          @name = (options[:name] || File.basename(self.path))
+          @dir_name = @name.gsub(/^ronin[-_]/,'')
+          @module_name = @dir_name.capitalize
+
+          @title = @name.split(/[\s_-]+/).map { |word|
+            word.capitalize
+          }.join(' ')
+
+          @license = DEFAULT_LICENSE
+
+          @author = options[:author]
+          @email = options[:email]
+          @safe_email = @email.gsub(/\s*@\s*/,' at ')
+          @homepage = options[:homepage]
+        end
+
+        #
+        # Generates top-level files.
+        #
+        def generate
+          unless options[:no_git]
+            run("git init #{self.destination_root}")
+          end
+
+          erb File.join('ronin','gen','library','Gemfile.erb'), 'Gemfile'
+          cp File.join('ronin','gen','library','Rakefile'), 'Rakefile'
+
+          erb File.join('ronin','gen','library','library.gemspec.erb'),
+              "#{@name}.gemspec"
+          erb File.join('ronin','gen','library','gemspec.yml.erb'),
+              'gemspec.yml'
+
+          unless options[:no_git]
+            cp File.join('ronin','gen','library','.gitignore'), '.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 File.join('ronin','gen','library','COPYING.txt'), '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
+
+        #
+        # Generates the contents of the `bin` directory.
+        #
+        def bin
+          mkdir 'bin'
+          erb File.join('ronin','gen','library','bin','ronin-name.erb'),
+              File.join('bin',"ronin-#{@dir_name}")
+        end
+
+        #
+        # Generates the contents of the `lib` directory.
+        #
+        def lib
+          mkdir File.join('lib','ronin',@dir_name)
+
+          erb File.join('ronin','gen','library','lib','ronin','name.rb.erb'),
+              File.join('lib','ronin',"#{@dir_name}.rb")
+
+          erb File.join('ronin','gen','library','lib','ronin','name','version.rb.erb'),
+              File.join('lib','ronin',@dir_name,'version.rb')
+        end
+
+        #
+        # 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')
+
+          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")
+        end
+
+        #
+        # Generates any optional commands for the library.
+        #
+        def command_line
+          unless options[:commands].empty?
+            mkdir COMMANDS_DIR
+
+            options[: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('_','-'))
+
+              erb File.join('ronin','gen','library',COMMANDS_DIR,'command.rb.erb'),
+                  File.join(COMMANDS_DIR,"#{@command_file}.rb")
+            end
+          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
+
+              erb File.join('ronin','gen','library',GENERATORS_DIR,'generator.rb.erb'),
+                  File.join(GENERATORS_DIR,"#{@generator_file}.rb")
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

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

@@ -0,0 +1,130 @@
+#
+# Ronin Gen - A Ruby library for Ronin that provides various generators.
+#
+# Copyright (c) 2009-2010 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/gen/config'
+require 'ronin/gen/dir_generator'
+require 'ronin/repository'
+require 'ronin/version'
+
+require 'set'
+
+module Ronin
+  module Gen
+    module Generators
+      #
+      # Generates a completely new Ronin Repository.
+      #
+      class Repository < DirGenerator
+
+        # The repository metadata file
+        METADATA_FILE = Ronin::Repository::METADATA_FILE
+
+        # The repository lib directory
+        LIB_DIR = Ronin::Repository::LIB_DIR
+
+        # Default license to use
+        DEFAULT_LICENSE = 'CC-by'
+
+        # Default authors to use
+        DEFAULT_AUTHORS = {'Name' => 'name@example.com'}
+
+        # Default description to use
+        DEFAULT_DESCRIPTION = 'This is a Ronin 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
+        class_option :license, :type => :string, :default => DEFAULT_LICENSE
+        class_option :description, :type => :string, :default => DEFAULT_DESCRIPTION
+        class_option :authors, :type => :hash, :default => DEFAULT_AUTHORS, :banner => 'NAME:EMAIL ...'
+        class_option :test_suite, :type => :string, :banner => 'test_unit|rspec'
+        class_option :docs, :type => :boolean
+
+        def setup
+          @title = options[:title]
+          @uri = options[:uri]
+          @source = options[:source]
+          @website = options[:website]
+          @license = options[:license]
+          @description = options[:description]
+          @authors = options[:authors]
+          @gems = options[:gems]
+          @test_suite = case options[:test_suite]
+                        when 'test', 'test_unit'
+                          :test_unit
+                        when 'spec', 'rspec'
+                          :rspec
+                        end
+
+          @docs = options[:docs]
+
+          @title ||= File.basename(self.path).gsub(/[_\s]+/,' ').capitalize
+          @website ||= @source
+        end
+
+        #
+        # Generates a skeleton repository.
+        #
+        def generate
+          mkdir LIB_DIR
+          mkdir File.join(LIB_DIR,'ronin')
+          touch File.join(LIB_DIR,Ronin::Repository::INIT_FILE)
+
+          mkdir Ronin::Repository::DATA_DIR
+          mkdir Ronin::Repository::CACHE_DIR
+        end
+
+        #
+        # Generates the Rakefile of the repository.
+        #
+        def rakefile
+          erb File.join('ronin','gen','repository','Rakefile.erb'), 'Rakefile'
+        end
+
+        #
+        # Generates a base test suite for the repository.
+        #
+        def test_suite
+          case @test_suite
+          when :test_unit
+            mkdir 'test'
+          when :rspec
+            cp File.join('ronin','gen','repository','.rspec'), '.rspec'
+
+            mkdir 'spec'
+            cp File.join('ronin','gen','repository','spec','spec_helper.rb'),
+               File.join('spec','spec_helper.rb')
+          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
+end

data/lib/ronin/gen/ruby_generator.rb

@@ -0,0 +1,34 @@
+#
+# Ronin Gen - A Ruby library for Ronin that provides various generators.
+#
+# Copyright (c) 2009-2010 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/gen/source_code_generator'
+
+module Ronin
+  module Gen
+    #
+    # A {SourceCodeGenerator} class for creating Ruby files.
+    #
+    class RubyGenerator < SourceCodeGenerator
+
+      file_extension! :rb
+
+    end
+  end
+end

data/lib/ronin/gen/source_code_generator.rb

@@ -0,0 +1,46 @@
+#
+# Ronin Gen - A Ruby library for Ronin that provides various generators.
+#
+# Copyright (c) 2009-2010 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/gen/file_generator'
+
+module Ronin
+  module Gen
+    #
+    # A {FileGenerator} class for creating Ruby files.
+    #
+    class SourceCodeGenerator < FileGenerator
+
+      class_option :editor, :default => ENV['EDITOR']
+      class_option :no_edit, :type => :boolean, :default => false
+
+      #
+      # Generates the source-code file and spawns a text-editor.
+      #
+      def self.generate(options={},arguments=[],&block)
+        generator = super(options,arguments,&block)
+
+        if (generator.options.no_edit? && generator.options.editor)
+          system(generator.options.editor,generator.path)
+        end
+      end
+
+    end
+  end
+end

data/lib/ronin/{generators → gen}/version.rb

@@ -1,7 +1,7 @@
 #
 # Ronin Gen - A Ruby library for Ronin that provides various generators.
 #
-# Copyright (c) 2009 Hal Brodigan (postmodern.mod3 at example.com)
+# Copyright (c) 2009-2010 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
@@ -19,8 +19,8 @@
 #
 
 module Ronin
-  module Generators
+  module Gen
     # Ronin Gen version
-    VERSION = '0.2.0'
+    VERSION = '1.0.0.pre1'
   end
 end