josevalim-thor 0.10.0

data/lib/thor/actions.rb

@@ -0,0 +1,147 @@
+require 'fileutils'
+
+Dir[File.join(File.dirname(__FILE__), "actions", "*.rb")].each do |action|
+  require action
+end
+
+class Thor
+  module Actions
+    attr_accessor :behavior
+
+    # On inclusion, add some options to base.
+    #
+    def self.included(base) #:nodoc:
+      return unless base.respond_to?(:class_option)
+
+      base.class_option :pretend, :type => :boolean, :aliases => "-p",
+                                  :desc => "Run but do not make any changes"
+
+      base.class_option :force, :type => :boolean, :aliases => "-f",
+                                :desc => "Overwrite files that already exist"
+
+      base.class_option :skip, :type => :boolean, :aliases => "-s",
+                               :desc => "Skip files that already exist"
+
+      base.class_option :quiet, :type => :boolean, :aliases => "-q",
+                                :desc => "Supress status output"
+
+      # TODO Add git support
+      base.class_option :git, :type => :boolean, :aliases => "-g",
+                              :desc => "Modify files with git (note: git must be on the path)"
+
+      # TODO Add chmod support
+      base.class_option :chmod, :type => :string, :aliases => "-c",
+                                :desc => "Set the mode of added/copied files"
+    end
+
+    # Extends initializer to add more configuration options.
+    #
+    # ==== Configuration
+    # behavior<Symbol>:: The actions default behavior. Can be :invoke or :revoke.
+    #                    It also accepts :force, :skip and :pretend to set the behavior
+    #                    and the respective option.
+    #
+    # root<String>:: The root directory needed for some actions. It's also known
+    #                as destination root.
+    #
+    # in_root<Boolean>:: When true, creates the root directory if it does not exist
+    #                    and move to it. False by default.
+    #
+    def initialize(args=[], options={}, config={})
+      self.behavior = case config[:behavior]
+        when :force
+          options.merge!(:force => true, 'force' => true)
+          :invoke
+        when :skip
+          options.merge!(:skip => true, 'skip' => true)
+          :invoke
+        when :pretend
+          options.merge!(:pretend => true, 'pretend' => true)
+          :invoke
+        when :revoke
+          :revoke
+        else
+          :invoke
+      end
+
+      self.root = config[:root]
+      if config[:in_root]
+        FileUtils.mkdir_p(root) unless File.exist?(root)
+        FileUtils.cd(root)
+      end
+
+      super
+    end
+
+    # Wraps an action object and call it accordingly to the thor class behavior.
+    #
+    def action(instance)
+      if behavior == :revoke
+        instance.revoke!
+      else
+        instance.invoke!
+      end
+    end
+
+    # Returns the root for this thor class (also aliased as destination root).
+    #
+    def root
+      @root_stack.last
+    end
+    alias :destination_root :root
+
+    # Sets the root for this thor class. Relatives path are added to the
+    # directory where the script was invoked and expanded.
+    #
+    def root=(root)
+      @root_stack ||= []
+      @root_stack[0] = File.expand_path(root || '')
+    end
+
+    # Returns the given path relative to the absolute root (ie, root where
+    # the script started).
+    #
+    def relative_to_absolute_root(path, remove_dot=true)
+      path = path.gsub(@root_stack[0], '.')
+      remove_dot ? path[2..-1] : path
+    end
+
+    # Get the source root in the class. Raises an error if a source root is
+    # not specified in the thor class.
+    #
+    def source_root
+      self.class.source_root
+    rescue NoMethodError => e
+      raise NoMethodError, "You have to specify the class method source_root in your thor class."
+    end
+
+    # Do something in the root or on a provided subfolder. If a relative path
+    # is given it's referenced from the current root. The full path is yielded
+    # to the block you provide. The path is set back to the previous path when
+    # the method exits.
+    #
+    # ==== Parameters
+    # dir<String>:: the directory to move to.
+    #
+    def inside(dir='', &block)
+      @root_stack.push File.expand_path(dir, root)
+      FileUtils.mkdir_p(root) unless File.exist?(root)
+      FileUtils.cd(root) { block.arity == 1 ? yield(root) : yield }
+      @root_stack.pop
+    end
+
+    # Goes to the root and execute the given block.
+    #
+    def in_root
+      inside(@root_stack.first) { yield }
+    end
+
+    protected
+
+      def say_status_if_log(status, message, log_status)
+        color = log_status.is_a?(Symbol) ? log_status : :green
+        shell.say_status status, message, color if log_status
+      end
+
+  end
+end

data/lib/thor/actions/commands.rb

@@ -0,0 +1,61 @@
+class Thor
+  module Actions
+    # Executes a command.
+    #
+    # ==== Parameters
+    # command<String>:: the command to be executed.
+    # log_status<Boolean>:: if false, does not log the status. True by default.
+    #                       If a symbol is given, uses it as the output color.
+    #
+    # ==== Example
+    #
+    #   inside('vendor') do
+    #     run('ln -s ~/edge rails')
+    #   end
+    #
+    def run(command, log_status=true)
+      say_status_if_log :run, "#{command} from #{relative_to_absolute_root(root, false)}", log_status
+      `#{command}` unless options[:pretend]
+    end
+
+    # Executes a ruby script (taking into account WIN32 platform quirks).
+    #
+    # ==== Parameters
+    # command<String>:: the command to be executed.
+    # log_status<Boolean>:: if false, does not log the status. True by default.
+    #                       If a symbol is given, uses it as the output color.
+    #
+    def run_ruby_script(command, log_status=true)
+      run("ruby #{command}", log_status)
+    end
+
+    # Run a thor command. A hash of options can be given and it's converted to 
+    # switches.
+    #
+    # ==== Parameters
+    # task<String>:: the task to be invoked
+    # args<Array>:: arguments to the task
+    # options<Hash>:: a hash with options used on invocation
+    # log_status<Boolean>:: if false, does not log the status. True by default.
+    #                       If a symbol is given, uses it as the output color.
+    #
+    # ==== Examples
+    #
+    #   thor :install, "http://gist.github.com/103208"
+    #   #=> thor install http://gist.github.com/103208
+    #
+    #   thor :list, :all => true, :substring => 'rails'
+    #   #=> thor list --all --substring=rails
+    #
+    def thor(task, *args)
+      log_status = args.last.is_a?(Symbol) || [true, false].include?(args.last) ? args.pop : true
+      options = args.last.is_a?(Hash) ? args.pop : {}
+
+      in_root do
+        args.unshift "thor #{task}"
+        args.push Thor::Options.to_switches(options)
+        run args.join(' ').strip, log_status
+      end
+    end
+  end
+end

data/lib/thor/actions/copy_file.rb

@@ -0,0 +1,32 @@
+require 'thor/actions/templater'
+
+class Thor
+  module Actions
+
+    # Copies the file from the relative source to the relative destination. If
+    # the destination is not given it's assumed to be equal to the source.
+    #
+    # ==== Parameters
+    # source<String>:: the relative path to the source root
+    # destination<String>:: the relative path to the destination root
+    # log_status<Boolean>:: if false, does not log the status. True by default.
+    #
+    # ==== Examples
+    #
+    #   copy_file "README", "doc/README"
+    #
+    #   copy_file "doc/README"
+    #
+    def copy_file(source, destination=nil, log_status=true)
+      action CopyFile.new(self, source, destination || source, log_status)
+    end
+
+    class CopyFile < Templater #:nodoc:
+
+      def render
+        @render ||= ::File.read(source)
+      end
+
+    end
+  end
+end

data/lib/thor/actions/create_file.rb

@@ -0,0 +1,48 @@
+require 'thor/actions/templater'
+
+class Thor
+  module Actions
+
+    # Create a new file relative to the destination root with the given data,
+    # which is the return value of a block or a data string.
+    #
+    # ==== Parameters
+    # destination<String>:: the relative path to the destination root.
+    # data<String|NilClass>:: the data to append to the file.
+    # log_status<Boolean>:: if false, does not log the status. True by default.
+    #
+    # ==== Examples
+    #
+    #   create_file "lib/fun_party.rb" do
+    #     hostname = ask("What is the virtual hostname I should use?")
+    #     "vhost.name = #{hostname}"
+    #   end
+    #
+    #   create_file "config/apach.conf", "your apache config"
+    #
+    def create_file(destination, data=nil, log_status=true, &block)
+      action AddFile.new(self, destination, block || data.to_s, log_status)
+    end
+
+    # AddFile is a subset of Template, which instead of rendering a file with
+    # ERB, it gets the content from the user.
+    #
+    class CreateFile < Templater #:nodoc:
+      attr_reader :data
+
+      def initialize(base, destination, data, log_status)
+        super(base, nil, destination, log_status)
+        @data = data
+      end
+
+      def render
+        @render ||= if data.is_a?(Proc)
+          data.call
+        else
+          data
+        end
+      end
+
+    end
+  end
+end

data/lib/thor/actions/directory.rb

@@ -0,0 +1,36 @@
+require 'thor/actions/templater'
+
+class Thor
+  module Actions
+
+    # Copies interactively the files from source directory to root directory.
+    # Use it just to copy static files.
+    #
+    # ==== Parameters
+    # source<String>:: the relative path to the source root
+    # destination<String>:: the relative path to the destination root
+    # log_status<Boolean>:: if false, does not log the status. True by default.
+    #
+    # ==== Examples
+    #
+    #   directory "doc"
+    #
+    def directory(source, destination=nil, log_status=true)
+      action Directory.new(self, source, destination || source, log_status)
+    end
+
+    class Directory < Templater #:nodoc:
+
+      def invoke!
+        files = Dir[File.join(source, '**', '*')].select{ |f| !File.directory?(f) }
+
+        files.each do |file_source|
+          file_destination = File.join(relative_destination, file_source.gsub(source, ''))
+          file_source.gsub!(base.source_root, '.')
+          base.copy_file(file_source, file_destination, @log_status)
+        end
+      end
+
+    end
+  end
+end

data/lib/thor/actions/empty_directory.rb

@@ -0,0 +1,30 @@
+require 'thor/actions/templater'
+
+class Thor
+  module Actions
+
+    # Creates an empty directory.
+    #
+    # ==== Parameters
+    # destination<String>:: the relative path to the destination root
+    # log_status<Boolean>:: if false, does not log the status. True by default.
+    #
+    # ==== Examples
+    #
+    #   empty_directory "doc"
+    #
+    def empty_directory(destination, log_status=true)
+      action EmptyDirectory.new(self, nil, destination, log_status)
+    end
+
+    class EmptyDirectory < Templater #:nodoc:
+
+      def invoke!
+        invoke_with_options!(base.options) do
+          ::FileUtils.mkdir_p(destination)
+        end
+      end
+
+    end
+  end
+end

data/lib/thor/actions/get.rb

@@ -0,0 +1,58 @@
+require 'thor/actions/templater'
+require 'open-uri'
+
+class Thor
+  module Actions
+
+    # Gets the content at the given address and places it at the given relative
+    # destination. If a block is given instead of destination, the content of
+    # the url is yielded and used as location.
+    #
+    # ==== Parameters
+    # source<String>:: the address of the given content
+    # destination<String>:: the relative path to the destination root
+    # log_status<Boolean>:: if false, does not log the status. True by default.
+    #
+    # ==== Examples
+    #
+    #   get "http://gist.github.com/103208", "doc/README"
+    #
+    #   get "http://gist.github.com/103208" do |content|
+    #     content.split("\n").first
+    #   end
+    #
+    def get(source, destination=nil, log_status=true, &block)
+      action Get.new(self, source, block || destination, log_status)
+    end
+
+    class Get < Templater #:nodoc:
+
+      def render
+        @render ||= open(source).read
+      end
+
+      protected
+
+        def source=(source)
+          if source =~ /^http\:\/\//
+            @source = source
+          else
+            super(source)
+          end
+        end
+
+        def destination=(destination)
+          destination = if destination.nil?
+            File.basename(source)
+          elsif destination.is_a?(Proc)
+            destination.arity == 1 ? destination.call(render) : destination.call
+          else
+            destination
+          end
+
+          super(destination)
+        end
+
+    end
+  end
+end

data/lib/thor/actions/gsub_file.rb

@@ -0,0 +1,77 @@
+class Thor
+  module Actions
+
+    # Run a regular expression replacement on a file.
+    #
+    # ==== Parameters
+    # path<String>:: path of the file to be changed
+    # flag<Regexp|String>:: the regexp or string to be replaced
+    # replacement<String>:: the replacement, can be also given as a block
+    # log_status<Boolean>:: if false, does not log the status. True by default.
+    #                       If a symbol is given, uses it as the output color.
+    #
+    # ==== Example
+    #
+    #   gsub_file 'app/controllers/application_controller.rb', /#\s*(filter_parameter_logging :password)/, '\1'
+    #
+    #   gsub_file 'README', /rake/, :green do |match|
+    #     match << " no more. Use thor!"
+    #   end
+    #
+    def gsub_file(path, flag, *args, &block)
+      log_status = args.last.is_a?(Symbol) || [ true, false ].include?(args.last) ? args.pop : true
+
+      path = File.expand_path(path, root)
+      say_status_if_log :gsub, relative_to_absolute_root(path), log_status
+
+      unless options[:pretend]
+        content = File.read(path)
+        content.gsub!(flag, *args, &block)
+        File.open(path, 'wb') { |file| file.write(content) }
+      end
+    end
+
+    # Append text to a file.
+    #
+    # ==== Parameters
+    # path<String>:: path of the file to be changed
+    # data<String>:: the data to append to the file, can be also given as a block.
+    # log_status<Boolean>:: if false, does not log the status. True by default.
+    #                       If a symbol is given, uses it as the output color.
+    #
+    # ==== Example
+    #
+    #   append_file 'config/environments/test.rb', 'config.gem "rspec"'
+    #
+    def append_file(path, data=nil, log_status=true, &block)
+      path = File.expand_path(path, root)
+      say_status_if_log :append, relative_to_absolute_root(path), log_status
+
+      File.open(path, 'ab') { |file| file.write(data || block.call) } unless options[:pretend]
+    end
+
+    # Prepend text to a file.
+    #
+    # ==== Parameters
+    # path<String>:: path of the file to be changed
+    # data<String>:: the data to prepend to the file, can be also given as a block.
+    # log_status<Boolean>:: if false, does not log the status. True by default.
+    #                       If a symbol is given, uses it as the output color.
+    #
+    # ==== Example
+    #
+    #   prepend_file 'config/environments/test.rb', 'config.gem "rspec"'
+    #
+    def prepend_file(path, data=nil, log_status=true, &block)
+      path = File.expand_path(path, root)
+      say_status_if_log :prepend, relative_to_absolute_root(path), log_status
+
+      unless options[:pretend]
+        content = data || block.call
+        content << File.read(path)
+        File.open(path, 'wb') { |file| file.write(content) }
+      end
+    end
+
+  end
+end