thor 0.16.0 → 1.2.1

data/lib/thor/actions.rb

@@ -1,18 +1,16 @@
-require 'fileutils'
-require 'uri'
-require 'thor/core_ext/file_binary_read'
-require 'thor/actions/create_file'
-require 'thor/actions/create_link'
-require 'thor/actions/directory'
-require 'thor/actions/empty_directory'
-require 'thor/actions/file_manipulation'
-require 'thor/actions/inject_into_file'
+require_relative "actions/create_file"
+require_relative "actions/create_link"
+require_relative "actions/directory"
+require_relative "actions/empty_directory"
+require_relative "actions/file_manipulation"
+require_relative "actions/inject_into_file"
 
 class Thor
   module Actions
     attr_accessor :behavior
 
     def self.included(base) #:nodoc:
+      super(base)
       base.extend ClassMethods
     end
 
@@ -26,9 +24,9 @@ class Thor
       end
 
       # Stores and return the source root for this class
-      def source_root(path=nil)
+      def source_root(path = nil)
         @_source_root = path if path
-        @_source_root
+        @_source_root ||= nil
       end
 
       # Returns the source paths in the following order:
@@ -39,8 +37,8 @@ class Thor
       #
       def source_paths_for_search
         paths = []
-        paths += self.source_paths
-        paths << self.source_root if self.source_root
+        paths += source_paths
+        paths << source_root if source_root
         paths += from_superclass(:source_paths, [])
         paths
       end
@@ -71,15 +69,15 @@ class Thor
     #
     # destination_root<String>:: The root directory needed for some actions.
     #
-    def initialize(args=[], options={}, config={})
+    def initialize(args = [], options = {}, config = {})
       self.behavior = case config[:behavior].to_s
-        when "force", "skip"
-          _cleanup_options_and_set(options, config[:behavior])
-          :invoke
-        when "revoke"
-          :revoke
-        else
-          :invoke
+      when "force", "skip"
+        _cleanup_options_and_set(options, config[:behavior])
+        :invoke
+      when "revoke"
+        :revoke
+      else
+        :invoke
       end
 
       super
@@ -107,16 +105,18 @@ class Thor
     #
     def destination_root=(root)
       @destination_stack ||= []
-      @destination_stack[0] = File.expand_path(root || '')
+      @destination_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_original_destination_root(path, remove_dot=true)
-      path = path.dup
-      if path.gsub!(@destination_stack[0], '.')
-        remove_dot ? (path[2..-1] || '') : path
+    def relative_to_original_destination_root(path, remove_dot = true)
+      root = @destination_stack[0]
+      if path.start_with?(root) && [File::SEPARATOR, File::ALT_SEPARATOR, nil, ''].include?(path[root.size..root.size])
+        path = path.dup
+        path[0...root.size] = '.'
+        remove_dot ? (path[2..-1] || "") : path
       else
         path
       end
@@ -131,24 +131,27 @@ class Thor
     # Receives a file or directory and search for it in the source paths.
     #
     def find_in_source_paths(file)
+      possible_files = [file, file + TEMPLATE_EXTNAME]
       relative_root = relative_to_original_destination_root(destination_root, false)
 
       source_paths.each do |source|
-        source_file = File.expand_path(file, File.join(source, relative_root))
-        return source_file if File.exists?(source_file)
+        possible_files.each do |f|
+          source_file = File.expand_path(f, File.join(source, relative_root))
+          return source_file if File.exist?(source_file)
+        end
       end
 
-      message = "Could not find #{file.inspect} in any of your source paths. "
+      message = "Could not find #{file.inspect} in any of your source paths. ".dup
 
       unless self.class.source_root
         message << "Please invoke #{self.class.name}.source_root(PATH) with the PATH containing your templates. "
       end
 
-      if source_paths.empty?
-        message << "Currently you have no source paths."
-      else
-        message << "Your current source paths are: \n#{source_paths.join("\n")}"
-      end
+      message << if source_paths.empty?
+                   "Currently you have no source paths."
+                 else
+                   "Your current source paths are: \n#{source_paths.join("\n")}"
+                 end
 
       raise Error, message
     end
@@ -158,11 +161,13 @@ class Thor
     # to the block you provide. The path is set back to the previous path when
     # the method exits.
     #
+    # Returns the value yielded by the block.
+    #
     # ==== Parameters
     # dir<String>:: the directory to move to.
     # config<Hash>:: give :verbose => true to log and use padding.
     #
-    def inside(dir='', config={}, &block)
+    def inside(dir = "", config = {}, &block)
       verbose = config.fetch(:verbose, false)
       pretend = options[:pretend]
 
@@ -172,18 +177,22 @@ class Thor
 
       # If the directory doesnt exist and we're not pretending
       if !File.exist?(destination_root) && !pretend
+        require "fileutils"
         FileUtils.mkdir_p(destination_root)
       end
 
+      result = nil
       if pretend
         # In pretend mode, just yield down to the block
-        block.arity == 1 ? yield(destination_root) : yield
+        result = block.arity == 1 ? yield(destination_root) : yield
       else
-        FileUtils.cd(destination_root) { block.arity == 1 ? yield(destination_root) : yield }
+        require "fileutils"
+        FileUtils.cd(destination_root) { result = block.arity == 1 ? yield(destination_root) : yield }
       end
 
       @destination_stack.pop
       shell.padding -= 1 if verbose
+      result
     end
 
     # Goes to the root and execute the given block.
@@ -204,18 +213,19 @@ class Thor
     #
     #   apply "recipes/jquery.rb"
     #
-    def apply(path, config={})
+    def apply(path, config = {})
       verbose = config.fetch(:verbose, true)
-      is_uri  = path =~ /^https?\:\/\//
+      is_uri  = path =~ %r{^https?\://}
       path    = find_in_source_paths(path) unless is_uri
 
       say_status :apply, path, verbose
       shell.padding += 1 if verbose
 
-      if is_uri
-        contents = open(path, "Accept" => "application/x-thor-template") {|io| io.read }
+      contents = if is_uri
+        require "open-uri"
+        URI.open(path, "Accept" => "application/x-thor-template", &:read)
       else
-        contents = open(path) {|io| io.read }
+        open(path, &:read)
       end
 
       instance_eval(contents, path)
@@ -227,7 +237,7 @@ class Thor
     # ==== Parameters
     # command<String>:: the command to be executed.
     # config<Hash>:: give :verbose => false to not log the status, :capture => true to hide to output. Specify :with
-    #                to append an executable to command executation.
+    #                to append an executable to command execution.
     #
     # ==== Example
     #
@@ -235,7 +245,7 @@ class Thor
     #     run('ln -s ~/edge rails')
     #   end
     #
-    def run(command, config={})
+    def run(command, config = {})
       return unless behavior == :invoke
 
       destination = relative_to_original_destination_root(destination_root, false)
@@ -248,9 +258,22 @@ class Thor
 
       say_status :run, desc, config.fetch(:verbose, true)
 
-      unless options[:pretend]
-        config[:capture] ? `#{command}` : system("#{command}")
+      return if options[:pretend]
+
+      env_splat = [config[:env]] if config[:env]
+
+      if config[:capture]
+        require "open3"
+        result, status = Open3.capture2e(*env_splat, command.to_s)
+        success = status.success?
+      else
+        result = system(*env_splat, command.to_s)
+        success = result
       end
+
+      abort if !success && config.fetch(:abort_on_failure, self.class.exit_on_failure?)
+
+      result
     end
 
     # Executes a ruby script (taking into account WIN32 platform quirks).
@@ -259,7 +282,7 @@ class Thor
     # command<String>:: the command to be executed.
     # config<Hash>:: give :verbose => false to not log the status.
     #
-    def run_ruby_script(command, config={})
+    def run_ruby_script(command, config = {})
       return unless behavior == :invoke
       run command, config.merge(:with => Thor::Util.ruby_command)
     end
@@ -268,8 +291,8 @@ class Thor
     # switches.
     #
     # ==== Parameters
-    # task<String>:: the task to be invoked
-    # args<Array>:: arguments to the task
+    # command<String>:: the command to be invoked
+    # args<Array>:: arguments to the command
     # config<Hash>:: give :verbose => false to not log the status, :capture => true to hide to output.
     #                Other options are given as parameter to Thor.
     #
@@ -282,37 +305,36 @@ class Thor
     #   thor :list, :all => true, :substring => 'rails'
     #   #=> thor list --all --substring=rails
     #
-    def thor(task, *args)
+    def thor(command, *args)
       config  = args.last.is_a?(Hash) ? args.pop : {}
       verbose = config.key?(:verbose) ? config.delete(:verbose) : true
       pretend = config.key?(:pretend) ? config.delete(:pretend) : false
       capture = config.key?(:capture) ? config.delete(:capture) : false
 
-      args.unshift task
+      args.unshift(command)
       args.push Thor::Options.to_switches(config)
-      command = args.join(' ').strip
+      command = args.join(" ").strip
 
       run command, :with => :thor, :verbose => verbose, :pretend => pretend, :capture => capture
     end
 
-    protected
+  protected
 
-      # Allow current root to be shared between invocations.
-      #
-      def _shared_configuration #:nodoc:
-        super.merge!(:destination_root => self.destination_root)
-      end
+    # Allow current root to be shared between invocations.
+    #
+    def _shared_configuration #:nodoc:
+      super.merge!(:destination_root => destination_root)
+    end
 
-      def _cleanup_options_and_set(options, key) #:nodoc:
-        case options
-          when Array
-            %w(--force -f --skip -s).each { |i| options.delete(i) }
-            options << "--#{key}"
-          when Hash
-            [:force, :skip, "force", "skip"].each { |i| options.delete(i) }
-            options.merge!(key => true)
-        end
+    def _cleanup_options_and_set(options, key) #:nodoc:
+      case options
+      when Array
+        %w(--force -f --skip -s).each { |i| options.delete(i) }
+        options << "--#{key}"
+      when Hash
+        [:force, :skip, "force", "skip"].each { |i| options.delete(i) }
+        options.merge!(key => true)
       end
-
+    end
   end
 end