ronin-gen 1.1.1 → 1.2.0.rc1

data/lib/ronin/gen/dir_generator.rb

@@ -28,34 +28,48 @@ module Ronin
     #
     class DirGenerator < Generator
 
-      # The destination path for the generator
-      parameter :path, :type        => String,
-                       :description => 'The destination path'
+      # The directory to generate
+      attr_accessor :path
 
       #
-      # Invokes the new Dir Generator.
+      # Initializes the directory generator.
       #
       # @param [String] path
-      #   The path for the generator.
+      #   The path to the directory to be generated.
       #
       # @param [Hash{Symbol => Object}] options
       #   Additional options for the generator.
       #
-      # @api public
+      # @yield [generator]
+      #   The given block will be passed the newly created generator.
+      #
+      # @yieldparam [DirGenerator]
+      #   The newly created generator.
+      #
+      # @api semipublic
+      #
+      # @since 1.2.0
       #
-      def self.generate(path,options={})
-        super(options.merge(:path => path))
+      def initialize(path=nil,options={},&block)
+        @path = path
+
+        super(options,&block)
       end
 
       #
       # Creates the directory and invokes the generator.
       #
-      # @api semipublic
+      # @raise [RuntimeError]
+      #   {#path} was not set.
+      #
+      # @api public
       #
       # @since 1.1.0
       #
       def generate!
-        require_params :path
+        unless @path
+          raise("#{self.class}#path was not set")
+        end
 
         FileUtils.mkdir_p(@path)
         FileUtils.chdir(@path) { super }

data/lib/ronin/gen/file_generator.rb

@@ -26,23 +26,50 @@ module Ronin
     #
     class FileGenerator < Generator
 
-      # The destination path for the generator
-      parameter :path, :type        => String,
-                       :description => 'File to generate'
+      # The file to generate
+      attr_accessor :path
 
       #
-      # Invokes the new File Generator.
+      # Initializes the file generator.
       #
       # @param [String] path
-      #   The path for the generator.
+      #   The path to the file to be generated.
       #
       # @param [Hash{Symbol => Object}] options
       #   Additional options for the generator.
       #
+      # @yield [generator]
+      #   The given block will be passed the newly created generator.
+      #
+      # @yieldparam [FileGenerator]
+      #   The newly created generator.
+      #
+      # @api semipublic
+      #
+      # @since 1.2.0
+      #
+      def initialize(path=nil,options={},&block)
+        @path = path
+
+        super(options,&block)
+      end
+
+      #
+      # Sets up the generator and calls {#generate}.
+      #
+      # @raise [RuntimeError]
+      #   {#path} was not set.
+      #
+      # @since 1.2.0
+      #
       # @api public
       #
-      def self.generate(path,options={})
-        super(options.merge(:path => path))
+      def generate!
+        unless @path
+          raise("#{self.class}#path was not set")
+        end
+
+        super
       end
 
       #
@@ -53,8 +80,6 @@ module Ronin
       # @api semipublic
       #
       def setup
-        require_params :path
-
         if (self.class.file_extension && File.extname(@path).empty?)
           @path += ".#{self.class.file_extension}"
         end

data/lib/ronin/gen/gen.rb

@@ -73,7 +73,7 @@ module Ronin
       if @generators.empty?
         directory = File.join('lib',Generators.namespace_root)
 
-        Installation.each_file_in(directory,:rb) do |path|
+        Installation.each_file_in(directory,'rb') do |path|
           # strip the tailing '.rb' file extension
           name = path.chomp('.rb')
 

data/lib/ronin/gen/generator.rb

@@ -18,13 +18,11 @@
 #
 
 require 'ronin/gen/config'
+require 'ronin/gen/actions'
 require 'ronin/support/inflector'
-require 'ronin/templates/erb'
-require 'ronin/ui/output'
 
 require 'parameters'
 require 'data_paths/finders'
-require 'fileutils'
 
 module Ronin
   module Gen
@@ -93,15 +91,11 @@ module Ronin
 
       include Parameters
       include DataPaths::Finders
-      include FileUtils
-      include Templates::Erb
+      include Actions
 
       #
       # Initializes the generator.
       #
-      # @param [String] path
-      #   The destination path for the generator.
-      #
       # @param [Hash{Symbol => Object}] options
       #   The options for the generator.
       #
@@ -134,43 +128,16 @@ module Ronin
       # @api semipublic
       #
       def self.generator_name
-        class_name = self.name.sub('Ronin::Gen::Generators::','')
-
-        return Support::Inflector.underscore(class_name.gsub('::',':'))
-      end
-
-      #
-      # The default data directory of the generator.
-      #
-      # @param [String] new_dir
-      #   The new data directory.
-      #
-      # @return [String, nil]
-      #   The data directory that the generator will search for source files
-      #   within.
-      #
-      # @since 1.1.0
-      #
-      # @api semipublic
-      #
-      def self.data_dir(new_dir=nil)
-        if new_dir
-          @data_dir = new_dir
-        else
-          @data_dir ||= if superclass < Generator
-                          superclass.data_dir
-                        end
-        end
+        @generator_name ||= Support::Inflector.underscore(
+          self.name.sub('Ronin::Gen::Generators::','').gsub('::',':')
+        )
       end
 
       #
       # Invokes the generator.
       #
-      # @param [Hash] options
-      #   Class options to use with the generator.
-      #
       # @param [Array] arguments
-      #   Additional arguments for the generator.
+      #   Arguments for {#initialize}.
       #
       # @yield [generator]
       #   The given block will be passed the new generator.
@@ -188,8 +155,8 @@ module Ronin
       #
       # @api public
       #
-      def self.generate(options={},&block)
-        generator = new(options,&block)
+      def self.generate(*arguments,&block)
+        generator = new(*arguments,&block)
 
         generator.generate!
         return generator
@@ -234,473 +201,29 @@ module Ronin
       protected
 
       #
-      # Runs a command.
-      #
-      # @param [String] command
-      #   The command or program to run.
-      #
-      # @param [Array<String>] arguments
-      #   Additional arguments to run the program with.
-      #
-      # @since 1.1.0
-      #
-      # @api semipublic
-      #
-      def run(command,*arguments)
-        print_action command, *arguments
-
-        system(command,*arguments)
-      end
-
-      #
-      # Changes the permissions of a files or directories.
-      #
-      # @param [String, Integer] mode
-      #   The new permissions for the files or directories.
-      #
-      # @param [Array<String>] paths
-      #   The path to the files or directories.
-      #
-      # @since 1.1.0
-      #
-      # @api semipublic
-      #
-      # @see http://rubydoc.info/stdlib/fileutils/FileUtils#chmod-instance_method
-      #
-      def chmod(mode,paths)
-        print_action 'chmod', mode.to_s(8), *paths
-
-        super(mode,paths)
-      end
-
-      #
-      # Changes the permissions of files/directories, recursively.
-      #
-      # @param [String, Integer] mode
-      #   The new permissions for the files or directories.
-      #
-      # @param [Array<String>] paths
-      #   The path to the files or directories.
-      #
-      # @since 1.1.0
-      #
-      # @api semipublic
-      #
-      # @see http://rubydoc.info/stdlib/fileutils/FileUtils#chmod_R-instance_method
-      #
-      def chmod_R(mode,paths)
-        print_action 'chmod -R', mode.to_s(8)
-
-        super(mode,paths)
-      end
-
-      #
-      # Changes ownership of files or directories.
-      #
-      # @param [String, nil] user
-      #   The new owner of the files or directories.
-      #
-      # @param [String, nil] group
-      #   The new group for the files or directories.
-      #
-      # @param [Array<String>] paths
-      #   The path to the files or directories.
-      #
-      # @since 1.1.0
-      #
-      # @api semipublic
-      #
-      # @see http://rubydoc.info/stdlib/fileutils/FileUtils#chown-instance_method
-      #
-      def chown(user,group,paths)
-        print_action 'chown', "#{user}:#{group}", *paths
-
-        super(user,group,paths)
-      end
-
-      #
-      # Changes ownership of files/directories, recursively.
-      #
-      # @param [String, nil] user
-      #   The new owner of the files or directories.
-      #
-      # @param [String, nil] group
-      #   The new group for the files or directories.
-      #
-      # @param [Array<String>] paths
-      #   The path to the files or directories.
-      #
-      # @since 1.1.0
-      #
-      # @api semipublic
-      #
-      # @see http://rubydoc.info/stdlib/fileutils/FileUtils#chown_R-instance_method
-      #
-      def chown_R(user,group,paths)
-        print_action 'chown -R', "#{user}:#{group}", *paths
-
-        super(user,group,paths)
-      end
-
-      #
-      # Copies a data file.
-      #
-      # @param [String] file
-      #   The relative path to the data file.
-      #
-      # @param [String] destination
-      #   The destination to copy the data file to.
-      #
-      # @since 0.2.0
-      #
-      # @see http://rubydoc.info/stdlib/fileutils/FileUtils#cp-instance_method
-      #
-      def cp(file,destination=file)
-        print_action 'cp', destination
-
-        super(data_file(file),destination)
-      end
-
-      #
-      # Copies the contents of all data directories.
-      #
-      # @param [String] directory
-      #   The data directories to copy from.
-      #
-      # @param [String, nil] destination
-      #   The optional destination directory to copy the files to.
-      #
-      # @param [Hash] config
-      #   The optional configuration information.
-      #
-      # @option config [Boolean] :recursive (false)
-      #   Recursively copies the contents.
-      #
-      # @since 1.0.0
-      #
-      # @see http://rubydoc.info/stdlib/fileutils/FileUtils#cp_r-instance_method
-      #
-      def cp_r(directory,destination=directory)
-        print_action 'cp -r', destination
-
-        data_dirs(directory) do |dir|
-          super(dir,destination)
-        end
-      end
-
-      #
-      # Installs a file.
-      #
-      # @param [String] src
-      #   The file to install.
-      #
-      # @param [String] dest
-      #   The destination path for the file.
-      #
-      # @param [Hash] options
-      #   Additional options.
-      #
-      # @option options [String, Integer] :mode
-      #   The permissions of the installed file.
-      #
-      # @since 1.1.0
-      #
-      # @api semipublic
-      #
-      # @see http://rubydoc.info/stdlib/fileutils/FileUtils#install-instance_method
-      #
-      def install(src,dest,options={})
-        options = {:mode => options[:mode]} # only pass in :mode
-
-        print_action 'install', src, dest
-
-        super(data_file(src),dest,options)
-      end
-
-      #
-      # Creates a hard link.
-      #
-      # @param [String] src
-      #   The path file/directory for the hard link.
-      # 
-      # @param [String] dest
-      #   The destination file/directory of the hard link.
-      #
-      # @since 1.1.0
-      #
-      # @api semipublic
-      #
-      # @see http://rubydoc.info/stdlib/fileutils/FileUtils#ln-instance_method
-      #
-      def ln(src,dest)
-        print_action 'ln', src, dest
-
-        super(src,dest)
-      end
-
-      #
-      # Creates a symbolic link.
-      #
-      # @param [String] src
-      #   The path file/directory for the symbolic link.
-      # 
-      # @param [String] dest
-      #   The destination file/directory of the symbolic link.
-      #
-      # @since 1.1.0
-      #
-      # @api semipublic
-      #
-      # @see http://rubydoc.info/stdlib/fileutils/FileUtils#ln_s-instance_method
-      #
-      def ln_s(src,dest)
-        print_action 'ln -s', src, dest
-
-        super(src,dest)
-      end
-
-      #
-      # Forcibly creates a symbolic link.
-      #
-      # @param [String] src
-      #   The path file/directory for the symbolic link.
-      # 
-      # @param [String] dest
-      #   The destination file/directory of the symbolic link.
-      #
-      # @since 1.1.0
-      #
-      # @api semipublic
-      #
-      # @see http://rubydoc.info/stdlib/fileutils/FileUtils#ln_sf-instance_method
-      #
-      def ln_sf(src,dest)
-        print_action 'ln -sf', src, dest
-
-        super(src,dest)
-      end
-
-      #
-      # Creates an empty directory.
-      #
-      # @param [String] dir
-      #   The relative path of the directory to create.
-      #
-      # @example
-      #   mkdir 'sub/dir'
-      #
-      # @since 0.2.0
-      #
-      # @see http://rubydoc.info/stdlib/fileutils/FileUtils#mkdir-instance_method
-      #
-      def mkdir(dir)
-        print_action 'mkdir', dir
-
-        super(dir)
-      end
-
-      #
-      # Creates an empty directory.
-      #
-      # @param [String] dir
-      #   The relative path of the directory to create.
-      #
-      # @example
-      #   mkdir 'sub/dir'
-      #
-      # @since 0.2.0
-      #
-      # @see http://rubydoc.info/stdlib/fileutils/FileUtils#mkdir_p-instance_method
-      #
-      def mkdir_p(dir)
-        print_action 'mkdir -p', dir
-
-        super(dir)
-      end
-
-      #
-      # Moves a file or directory.
-      #
-      # @param [String] src
-      #   The path to the file or directory.
-      #
-      # @param [String] dest
-      #   The new path to move the file or directory to.
-      #
-      # @api semipublic
-      #
-      # @since 1.1.0
-      #
-      # @see http://rubydoc.info/stdlib/fileutils/FileUtils#mv-instance_method
-      #
-      def mv(src,dest)
-        print_action 'mv', src, dest
-
-        super(src,dest)
-      end
-
-      #
-      # Removes one or more files.
-      #
-      # @param [Array<String>] paths
-      #   The paths of the files and directories to remove.
-      #
-      # @param [Hash] options
-      #   Additional options.
-      #
-      # @option options [Boolean] :force
-      #   Specifies whether to forcible remove the files.
-      #
-      # @since 1.1.0
-      #
-      # @api semipublic
-      #
-      # @see http://rubydoc.info/stdlib/fileutils/FileUtils#rm-instance_method
-      #
-      def rm(paths,options={})
-        options = {:force => options[:force]} # only pass in :force
-
-        print_action 'rm', *paths
-
-        super(paths,options)
-      end
-
-      #
-      # Recursively removes files and directories.
-      #
-      # @param [Array<String>] paths
-      #   The paths of the files and directories to remove.
-      #
-      # @param [Hash] options
-      #   Additional options.
-      #
-      # @option options [Boolean] :force
-      #   Specifies whether to forcible remove the files.
-      #
-      # @since 1.1.0
-      #
-      # @api semipublic
-      #
-      # @see http://rubydoc.info/stdlib/fileutils/FileUtils#rm_r-instance_method
-      #
-      def rm_r(paths,options={})
-        options = {:force => options[:force]} # only pass in :force
-
-        print_action 'rm -r', *paths
-
-        super(paths,options)
-      end
-
-      #
-      # Forcibly removes files and directories, recursively.
-      #
-      # @param [Array<String>] paths
-      #   The paths of the files and directories to remove.
-      #
-      # @since 1.1.0
-      #
-      # @api semipublic
-      #
-      # @see http://rubydoc.info/stdlib/fileutils/FileUtils#rm_rf-instance_method
-      #
-      def rm_rf(paths)
-        print_action 'rm -rf', *paths
-
-        super(paths)
-      end
-
-      #
-      # Removes one or more directories.
-      #
-      # @param [Array<String>] dirs
-      #   The paths of the directories.
-      #
-      # @since 1.1.0
-      #
-      # @api semipublic
-      #
-      # @see http://rubydoc.info/stdlib/fileutils/FileUtils#rmdir-instance_method
-      #
-      def rmdir(dirs)
-        print_action 'rmdir', *dirs
-
-        super(dirs)
-      end
-
-      #
-      # Touches a file.
-      #
-      # @param [String] destination
-      #   The relative path to the file to touch.
-      #
-      # @example
-      #   touch 'TODO.txt'
-      #
-      # @since 0.2.0
-      #
-      # @see http://rubydoc.info/stdlib/fileutils/FileUtils#touch-instance_method
-      #
-      def touch(file)
-        print_action 'touch', file
-
-        return super(file)
-      end
-
-      #
-      # Opens a file for writing.
-      #
-      # @param [String] path
-      #   The path of the file to write to.
+      # The default data directory of the generator.
       #
-      # @yield [file]
-      #   The given block will be passed the newly opened file.
+      # @param [String] new_dir
+      #   The new data directory.
       #
-      # @yieldparam [File]
-      #   The new file file, opened for writing.
+      # @return [String, nil]
+      #   The data directory that the generator will search for source files
+      #   within.
       #
       # @since 1.1.0
       #
       # @api semipublic
       #
-      def write(path,&block)
-        File.open(path,'wb',&block)
-      end
-
-      #
-      # Renders the ERB template and saves the result.
-      #
-      # @param [String] template_path
-      #   The relative path to the template.
-      #
-      # @param [String, nil] destination
-      #   The destination to write the result of the rendered template to.
-      #
-      # @return [nil, String]
-      #   If destination is `nil`, the result of the rendered template
-      #   will be returned.
-      #
-      # @example
-      #   template 'Rakefile.erb', 'Rakefile'
-      #
-      # @example
-      #   template '_helpers.erb'
-      #
-      # @since 0.2.0
-      #
-      def template(template_path,dest=nil)
-        if dest
-          print_action 'erb', dest
-
-          File.open(dest,'w') do |file|
-            file.write(erb_file(template_path))
-          end
+      def self.data_dir(new_dir=nil)
+        if new_dir
+          @data_dir = new_dir
         else
-          erb_file(template_path).chomp
+          @data_dir ||= if superclass < Generator
+                          superclass.data_dir
+                        end
         end
       end
 
-      private
-
       #
       # Joins the path with the Generators {data_dir}.
       #
@@ -790,40 +313,6 @@ module Ronin
         each_data_dir(data_path(directory),&block)
       end
 
-      # ANSI Bold code
-      BOLD = "\e[1m"
-
-      # ANSI Green code
-      GREEN = "\e[32m"
-
-      # ANSI Clear code
-      CLEAR = "\e[0m"
-
-      #
-      # Prints a file action.
-      #
-      # @param [String] command
-      #   The command/options that represents the file action.
-      #
-      # @param [Array<String>] arguments
-      #   Additional arguments related to the file action.
-      #
-      # @since 1.1.0
-      #
-      # @api private
-      #
-      def print_action(command,*arguments)
-        unless UI::Output.silent?
-          arguments = arguments.join(' ')
-
-          if $stdout.tty?
-            command = BOLD + GREEN + command + CLEAR
-          end
-
-          puts "\t#{command}\t#{arguments}"
-        end
-      end
-
     end
   end
 end