thor 0.18.1 → 0.19.0

data/lib/thor/shell.rb

@@ -1,33 +1,32 @@
-require 'rbconfig'
+require "rbconfig"
 
 class Thor
   module Base
-    # Returns the shell used in all Thor classes. If you are in a Unix platform
-    # it will use a colored log, otherwise it will use a basic one without color.
-    #
-    def self.shell
-      @shell ||= if ENV['THOR_SHELL'] && ENV['THOR_SHELL'].size > 0
-        Thor::Shell.const_get(ENV['THOR_SHELL'])
-      elsif ((RbConfig::CONFIG['host_os'] =~ /mswin|mingw/) && !(ENV['ANSICON']))
-        Thor::Shell::Basic
-      else
-        Thor::Shell::Color
-      end
-    end
+    class << self
+      attr_writer :shell
 
-    # Sets the shell used in all Thor classes.
-    #
-    def self.shell=(klass)
-      @shell = klass
+      # Returns the shell used in all Thor classes. If you are in a Unix platform
+      # it will use a colored log, otherwise it will use a basic one without color.
+      #
+      def shell
+        @shell ||= if ENV["THOR_SHELL"] && ENV["THOR_SHELL"].size > 0
+          Thor::Shell.const_get(ENV["THOR_SHELL"])
+        elsif RbConfig::CONFIG["host_os"] =~ /mswin|mingw/ && !ENV["ANSICON"]
+          Thor::Shell::Basic
+        else
+          Thor::Shell::Color
+        end
+      end
     end
   end
 
   module Shell
     SHELL_DELEGATED_METHODS = [:ask, :error, :set_color, :yes?, :no?, :say, :say_status, :print_in_columns, :print_table, :print_wrapped, :file_collision, :terminal_width]
+    attr_writer :shell
 
-    autoload :Basic, 'thor/shell/basic'
-    autoload :Color, 'thor/shell/color'
-    autoload :HTML,  'thor/shell/html'
+    autoload :Basic, "thor/shell/basic"
+    autoload :Color, "thor/shell/color"
+    autoload :HTML,  "thor/shell/html"
 
     # Add shell to initialize config values.
     #
@@ -42,10 +41,10 @@ class Thor
     #
     #   MyScript.new [1.0], { :foo => :bar }, :shell => Thor::Shell::Basic.new
     #
-    def initialize(args=[], options={}, config={})
+    def initialize(args = [], options = {}, config = {})
       super
       self.shell = config[:shell]
-      self.shell.base ||= self if self.shell.respond_to?(:base)
+      shell.base ||= self if shell.respond_to?(:base)
     end
 
     # Holds the shell for the given Thor instance. If no shell is given,
@@ -54,11 +53,6 @@ class Thor
       @shell ||= Thor::Base.shell.new
     end
 
-    # Sets the shell for this thor class.
-    def shell=(shell)
-      @shell = shell
-    end
-
     # Common methods that are delegated to the shell.
     SHELL_DELEGATED_METHODS.each do |method|
       module_eval <<-METHOD, __FILE__, __LINE__
@@ -76,13 +70,12 @@ class Thor
       shell.padding -= 1
     end
 
-    protected
-
-      # Allow shell to be shared between invocations.
-      #
-      def _shared_configuration #:nodoc:
-        super.merge!(:shell => self.shell)
-      end
+  protected
 
+    # Allow shell to be shared between invocations.
+    #
+    def _shared_configuration #:nodoc:
+      super.merge!(:shell => shell)
+    end
   end
 end

data/lib/thor/shell/basic.rb

@@ -1,15 +1,16 @@
-require 'tempfile'
+require "tempfile"
+require "io/console" if RUBY_VERSION > "1.9.2"
 
 class Thor
   module Shell
-    class Basic
+    class Basic # rubocop:disable ClassLength
       attr_accessor :base
       attr_reader   :padding
 
       # Initialize base, mute and padding to nil.
       #
       def initialize #:nodoc:
-        @base, @mute, @padding = nil, false, 0
+        @base, @mute, @padding, @always_force = nil, false, 0, false
       end
 
       # Mute everything that's inside given block
@@ -23,7 +24,7 @@ class Thor
 
       # Check if base is muted
       #
-      def mute?
+      def mute? # rubocop:disable TrivialAccessors
         @mute
       end
 
@@ -40,15 +41,32 @@ class Thor
       # they will be shown a message stating that one of those answers
       # must be given and re-asked the question.
       #
+      # If asking for sensitive information, the :echo option can be set
+      # to false to mask user input from $stdin.
+      #
+      # If the required input is a path, then set the path option to
+      # true. This will enable tab completion for file paths relative
+      # to the current working directory on systems that support
+      # Readline.
+      #
       # ==== Example
       # ask("What is your name?")
       #
       # ask("What is your favorite Neopolitan flavor?", :limited_to => ["strawberry", "chocolate", "vanilla"])
       #
+      # ask("What is your password?", :echo => false)
+      #
+      # ask("Where should the file be saved?", :path => true)
+      #
       def ask(statement, *args)
         options = args.last.is_a?(Hash) ? args.pop : {}
+        color = args.first
 
-        options[:limited_to] ? ask_filtered(statement, options[:limited_to], *args) : ask_simply(statement, *args)
+        if options[:limited_to]
+          ask_filtered(statement, color, options)
+        else
+          ask_simply(statement, color, options)
+        end
       end
 
       # Say (print) something to the user. If the sentence ends with a whitespace
@@ -58,18 +76,11 @@ class Thor
       # ==== Example
       # say("I know you knew that.")
       #
-      def say(message="", color=nil, force_new_line=(message.to_s !~ /( |\t)\Z/))
-        message = message.to_s
+      def say(message = "", color = nil, force_new_line = (message.to_s !~ /( |\t)\Z/))
+        buffer = prepare_message(message, *color)
+        buffer << "\n" if force_new_line && !message.end_with?("\n")
 
-        message = set_color(message, *color) if color && can_display_colors?
-
-        spaces = "  " * padding
-
-        if force_new_line
-          stdout.puts(spaces + message)
-        else
-          stdout.print(spaces + message)
-        end
+        stdout.print(buffer)
         stdout.flush
       end
 
@@ -78,7 +89,7 @@ class Thor
       # in log_status, avoiding the message from being shown. If a Symbol is
       # given in log_status, it's used as the color.
       #
-      def say_status(status, message, log_status=true)
+      def say_status(status, message, log_status = true)
         return if quiet? || log_status == false
         spaces = "  " * (padding + 1)
         color  = log_status.is_a?(Symbol) ? log_status : :green
@@ -86,22 +97,25 @@ class Thor
         status = status.to_s.rjust(12)
         status = set_color status, color, true if color
 
-        stdout.puts "#{status}#{spaces}#{message}"
+        buffer = "#{status}#{spaces}#{message}"
+        buffer << "\n" unless buffer.end_with?("\n")
+
+        stdout.print(buffer)
         stdout.flush
       end
 
       # Make a question the to user and returns true if the user replies "y" or
       # "yes".
       #
-      def yes?(statement, color=nil)
-        !!(ask(statement, color) =~ is?(:yes))
+      def yes?(statement, color = nil)
+        !!(ask(statement, color, :add_to_history => false) =~ is?(:yes))
       end
 
       # Make a question the to user and returns true if the user replies "n" or
       # "no".
       #
-      def no?(statement, color=nil)
-        !yes?(statement, color)
+      def no?(statement, color = nil)
+        !!(ask(statement, color, :add_to_history => false) =~ is?(:no))
       end
 
       # Prints values in columns
@@ -111,7 +125,7 @@ class Thor
       #
       def print_in_columns(array)
         return if array.empty?
-        colwidth = (array.map{|el| el.to_s.size}.max || 0) + 2
+        colwidth = (array.map { |el| el.to_s.size }.max || 0) + 2
         array.each_with_index do |value, index|
           # Don't output trailing spaces when printing the last column
           if ((((index + 1) % (terminal_width / colwidth))).zero? && !index.zero?) || index + 1 == array.length
@@ -131,7 +145,7 @@ class Thor
       # indent<Integer>:: Indent the first column by indent value.
       # colwidth<Integer>:: Force the first column to colwidth spaces wide.
       #
-      def print_table(array, options={})
+      def print_table(array, options = {}) # rubocop:disable MethodLength
         return if array.empty?
 
         formats, indent, colwidth = [], options[:indent].to_i, options[:colwidth]
@@ -140,12 +154,12 @@ class Thor
         formats << "%-#{colwidth + 2}s" if colwidth
         start = colwidth ? 1 : 0
 
-        colcount = array.max{|a,b| a.size <=> b.size }.size
+        colcount = array.max { |a, b| a.size <=> b.size }.size
 
         maximas = []
 
         start.upto(colcount - 1) do |index|
-          maxima = array.map {|row| row[index] ? row[index].to_s.size : 0 }.max
+          maxima = array.map { |row| row[index] ? row[index].to_s.size : 0 }.max
           maximas << maxima
           if index == colcount - 1
             # Don't output 2 trailing spaces when printing the last column
@@ -191,15 +205,13 @@ class Thor
       # ==== Options
       # indent<Integer>:: Indent each line of the printed paragraph by indent value.
       #
-      def print_wrapped(message, options={})
+      def print_wrapped(message, options = {})
         indent = options[:indent] || 0
         width = terminal_width - indent
         paras = message.split("\n\n")
 
         paras.map! do |unwrapped|
-          unwrapped.strip.gsub(/\n/, " ").squeeze(" ").
-          gsub(/.{1,#{width}}(?:\s|\Z)/){($& + 5.chr).
-          gsub(/\n\005/,"\n").gsub(/\005/,"\n")}
+          unwrapped.strip.gsub(/\n/, " ").squeeze(" ").gsub(/.{1,#{width}}(?:\s|\Z)/) { ($& + 5.chr).gsub(/\n\005/, "\n").gsub(/\005/, "\n") }
         end
 
         paras.each do |para|
@@ -218,12 +230,15 @@ class Thor
       # destination<String>:: the destination file to solve conflicts
       # block<Proc>:: an optional block that returns the value to be used in diff
       #
-      def file_collision(destination)
+      def file_collision(destination) # rubocop:disable MethodLength
         return true if @always_force
         options = block_given? ? "[Ynaqdh]" : "[Ynaqh]"
 
-        while true
-          answer = ask %[Overwrite #{destination}? (enter "h" for help) #{options}]
+        loop do
+          answer = ask(
+            %[Overwrite #{destination}? (enter "h" for help) #{options}],
+            :add_to_history => false
+          )
 
           case answer
           when is?(:yes), is?(:force), ""
@@ -233,11 +248,11 @@ class Thor
           when is?(:always)
             return @always_force = true
           when is?(:quit)
-            say 'Aborting...'
-            raise SystemExit
+            say "Aborting..."
+            fail SystemExit
           when is?(:diff)
             show_diff(destination, yield) if block_given?
-            say 'Retrying...'
+            say "Retrying..."
           else
             say file_collision_help
           end
@@ -247,12 +262,12 @@ class Thor
       # This code was copied from Rake, available under MIT-LICENSE
       # Copyright (c) 2003, 2004 Jim Weirich
       def terminal_width
-        if ENV['THOR_COLUMNS']
-          result = ENV['THOR_COLUMNS'].to_i
+        if ENV["THOR_COLUMNS"]
+          result = ENV["THOR_COLUMNS"].to_i
         else
           result = unix? ? dynamic_width : 80
         end
-        (result < 10) ? 80 : result
+        result < 10 ? 80 : result
       rescue
         80
       end
@@ -275,6 +290,11 @@ class Thor
 
     protected
 
+      def prepare_message(message, *color)
+        spaces = "  " * padding
+        spaces + set_color(message.to_s, *color)
+      end
+
       def can_display_colors?
         false
       end
@@ -288,10 +308,6 @@ class Thor
         $stdout
       end
 
-      def stdin
-        $stdin
-      end
-
       def stderr
         $stderr
       end
@@ -302,23 +318,23 @@ class Thor
         if value.size == 1
           /\A#{value}\z/i
         else
-          /\A(#{value}|#{value[0,1]})\z/i
+          /\A(#{value}|#{value[0, 1]})\z/i
         end
       end
 
       def file_collision_help #:nodoc:
-<<HELP
-Y - yes, overwrite
-n - no, do not overwrite
-a - all, overwrite this and all others
-q - quit, abort
-d - diff, show the differences between the old and the new
-h - help, show this help
-HELP
+        <<-HELP
+        Y - yes, overwrite
+        n - no, do not overwrite
+        a - all, overwrite this and all others
+        q - quit, abort
+        d - diff, show the differences between the old and the new
+        h - help, show this help
+        HELP
       end
 
       def show_diff(destination, content) #:nodoc:
-        diff_cmd = ENV['THOR_DIFF'] || ENV['RAILS_DIFF'] || 'diff -u'
+        diff_cmd = ENV["THOR_DIFF"] || ENV["RAILS_DIFF"] || "diff -u"
 
         Tempfile.open(File.basename(destination), File.dirname(destination)) do |temp|
           temp.write content
@@ -337,11 +353,11 @@ HELP
       end
 
       def dynamic_width_stty
-        %x{stty size 2>/dev/null}.split[1].to_i
+        %x(stty size 2>/dev/null).split[1].to_i
       end
 
       def dynamic_width_tput
-        %x{tput cols 2>/dev/null}.to_i
+        %x(tput cols 2>/dev/null).to_i
       end
 
       def unix?
@@ -354,7 +370,7 @@ HELP
           if chars.length <= width
             chars.join
           else
-            ( chars[0, width-3].join ) + "..."
+            ( chars[0, width - 3].join) + "..."
           end
         end
       end
@@ -372,22 +388,34 @@ HELP
         end
       end
 
-      def ask_simply(statement, color=nil)
-        say("#{statement} ", color)
-        stdin.gets.tap{|text| text.strip! if text}
+      def ask_simply(statement, color, options)
+        default = options[:default]
+        message = [statement, ("(#{default})" if default), nil].uniq.join(" ")
+        message = prepare_message(message, color)
+        result = Thor::LineEditor.readline(message, options)
+
+        return unless result
+
+        result.strip!
+
+        if default && result == ""
+          default
+        else
+          result
+        end
       end
 
-      def ask_filtered(statement, answer_set, *args)
+      def ask_filtered(statement, color, options)
+        answer_set = options[:limited_to]
         correct_answer = nil
         until correct_answer
-          answer = ask_simply("#{statement} #{answer_set.inspect}", *args)
+          answers = answer_set.join(", ")
+          answer = ask_simply("#{statement} [#{answers}]", color, options)
           correct_answer = answer_set.include?(answer) ? answer : nil
-          answers = answer_set.map(&:inspect).join(", ")
           say("Your response must be one of: [#{answers}]. Please try again.") unless correct_answer
         end
         correct_answer
       end
-
     end
   end
 end

data/lib/thor/shell/color.rb

@@ -1,4 +1,4 @@
-require 'thor/shell/basic'
+require "thor/shell/basic"
 
 class Thor
   module Shell
@@ -77,7 +77,9 @@ class Thor
       #   :on_cyan
       #   :on_white
       def set_color(string, *colors)
-        if colors.all? { |color| color.is_a?(Symbol) || color.is_a?(String) }
+        if colors.compact.empty? || !can_display_colors?
+          string
+        elsif colors.all? { |color| color.is_a?(Symbol) || color.is_a?(String) }
           ansi_colors = colors.map { |color| lookup_color(color) }
           "#{ansi_colors.join}#{string}#{CLEAR}"
         else
@@ -92,57 +94,56 @@ class Thor
         end
       end
 
-      protected
+    protected
 
-        def can_display_colors?
-          stdout.tty?
-        end
+      def can_display_colors?
+        stdout.tty?
+      end
 
-        # Overwrite show_diff to show diff with colors if Diff::LCS is
-        # available.
-        #
-        def show_diff(destination, content) #:nodoc:
-          if diff_lcs_loaded? && ENV['THOR_DIFF'].nil? && ENV['RAILS_DIFF'].nil?
-            actual  = File.binread(destination).to_s.split("\n")
-            content = content.to_s.split("\n")
+      # Overwrite show_diff to show diff with colors if Diff::LCS is
+      # available.
+      #
+      def show_diff(destination, content) #:nodoc:
+        if diff_lcs_loaded? && ENV["THOR_DIFF"].nil? && ENV["RAILS_DIFF"].nil?
+          actual  = File.binread(destination).to_s.split("\n")
+          content = content.to_s.split("\n")
 
-            Diff::LCS.sdiff(actual, content).each do |diff|
-              output_diff_line(diff)
-            end
-          else
-            super
+          Diff::LCS.sdiff(actual, content).each do |diff|
+            output_diff_line(diff)
           end
+        else
+          super
         end
+      end
 
-        def output_diff_line(diff) #:nodoc:
-          case diff.action
-          when '-'
-            say "- #{diff.old_element.chomp}", :red, true
-          when '+'
-            say "+ #{diff.new_element.chomp}", :green, true
-          when '!'
-            say "- #{diff.old_element.chomp}", :red, true
-            say "+ #{diff.new_element.chomp}", :green, true
-          else
-            say "  #{diff.old_element.chomp}", nil, true
-          end
+      def output_diff_line(diff) #:nodoc:
+        case diff.action
+        when "-"
+          say "- #{diff.old_element.chomp}", :red, true
+        when "+"
+          say "+ #{diff.new_element.chomp}", :green, true
+        when "!"
+          say "- #{diff.old_element.chomp}", :red, true
+          say "+ #{diff.new_element.chomp}", :green, true
+        else
+          say "  #{diff.old_element.chomp}", nil, true
         end
+      end
 
-        # Check if Diff::LCS is loaded. If it is, use it to create pretty output
-        # for diff.
-        #
-        def diff_lcs_loaded? #:nodoc:
-          return true  if defined?(Diff::LCS)
-          return @diff_lcs_loaded unless @diff_lcs_loaded.nil?
+      # Check if Diff::LCS is loaded. If it is, use it to create pretty output
+      # for diff.
+      #
+      def diff_lcs_loaded? #:nodoc:
+        return true  if defined?(Diff::LCS)
+        return @diff_lcs_loaded unless @diff_lcs_loaded.nil?
 
-          @diff_lcs_loaded = begin
-            require 'diff/lcs'
-            true
-          rescue LoadError
-            false
-          end
+        @diff_lcs_loaded = begin
+          require "diff/lcs"
+          true
+        rescue LoadError
+          false
         end
-
+      end
     end
   end
 end