thor 0.20.3 → 1.3.2

data/lib/thor/shell/basic.rb

@@ -1,8 +1,10 @@
+require_relative "column_printer"
+require_relative "table_printer"
+require_relative "wrapped_printer"
+
 class Thor
   module Shell
     class Basic
-      DEFAULT_TERMINAL_WIDTH = 80
-
       attr_accessor :base
       attr_reader   :padding
 
@@ -65,15 +67,15 @@ class Thor
       # Readline.
       #
       # ==== Example
-      # ask("What is your name?")
+      #   ask("What is your name?")
       #
-      # ask("What is the planet furthest from the sun?", :default => "Pluto")
+      #   ask("What is the planet furthest from the sun?", :default => "Neptune")
       #
-      # ask("What is your favorite Neopolitan flavor?", :limited_to => ["strawberry", "chocolate", "vanilla"])
+      #   ask("What is your favorite Neopolitan flavor?", :limited_to => ["strawberry", "chocolate", "vanilla"])
       #
-      # ask("What is your password?", :echo => false)
+      #   ask("What is your password?", :echo => false)
       #
-      # ask("Where should the file be saved?", :path => true)
+      #   ask("Where should the file be saved?", :path => true)
       #
       def ask(statement, *args)
         options = args.last.is_a?(Hash) ? args.pop : {}
@@ -91,9 +93,11 @@ class Thor
       # are passed straight to puts (behavior got from Highline).
       #
       # ==== Example
-      # say("I know you knew that.")
+      #   say("I know you knew that.")
       #
       def say(message = "", color = nil, force_new_line = (message.to_s !~ /( |\t)\Z/))
+        return if quiet?
+
         buffer = prepare_message(message, *color)
         buffer << "\n" if force_new_line && !message.to_s.end_with?("\n")
 
@@ -101,6 +105,23 @@ class Thor
         stdout.flush
       end
 
+      # Say (print) an error to the user. If the sentence ends with a whitespace
+      # or tab character, a new line is not appended (print + flush). Otherwise
+      # are passed straight to puts (behavior got from Highline).
+      #
+      # ==== Example
+      #   say_error("error: something went wrong")
+      #
+      def say_error(message = "", color = nil, force_new_line = (message.to_s !~ /( |\t)\Z/))
+        return if quiet?
+
+        buffer = prepare_message(message, *color)
+        buffer << "\n" if force_new_line && !message.to_s.end_with?("\n")
+
+        stderr.print(buffer)
+        stderr.flush
+      end
+
       # Say a status with the given color and appends the message. Since this
       # method is used frequently by actions, it allows nil or false to be given
       # in log_status, avoiding the message from being shown. If a Symbol is
@@ -109,30 +130,31 @@ class Thor
       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
-
         status = status.to_s.rjust(12)
+        margin = " " * status.length + spaces
+
+        color  = log_status.is_a?(Symbol) ? log_status : :green
         status = set_color status, color, true if color
 
-        buffer = "#{status}#{spaces}#{message}"
-        buffer = "#{buffer}\n" unless buffer.end_with?("\n")
+        message = message.to_s.chomp.gsub(/(?<!\A)^/, margin)
+        buffer = "#{status}#{spaces}#{message}\n"
 
         stdout.print(buffer)
         stdout.flush
       end
 
-      # Make a question the to user and returns true if the user replies "y" or
+      # Asks the user a question and returns true if the user replies "y" or
       # "yes".
       #
       def yes?(statement, color = nil)
-        !!(ask(statement, color, :add_to_history => false) =~ is?(:yes))
+        !!(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
+      # Asks the user a question and returns true if the user replies "n" or
       # "no".
       #
       def no?(statement, color = nil)
-        !!(ask(statement, color, :add_to_history => false) =~ is?(:no))
+        !!(ask(statement, color, add_to_history: false) =~ is?(:no))
       end
 
       # Prints values in columns
@@ -141,16 +163,8 @@ class Thor
       # Array[String, String, ...]
       #
       def print_in_columns(array)
-        return if array.empty?
-        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
-            stdout.puts value
-          else
-            stdout.printf("%-#{colwidth}s", value)
-          end
-        end
+        printer = ColumnPrinter.new(stdout)
+        printer.print(array)
       end
 
       # Prints a table.
@@ -161,58 +175,11 @@ class Thor
       # ==== Options
       # indent<Integer>:: Indent the first column by indent value.
       # colwidth<Integer>:: Force the first column to colwidth spaces wide.
+      # borders<Boolean>:: Adds ascii borders.
       #
-      def print_table(array, options = {}) # rubocop:disable MethodLength
-        return if array.empty?
-
-        formats = []
-        indent = options[:indent].to_i
-        colwidth = options[:colwidth]
-        options[:truncate] = terminal_width if options[:truncate] == true
-
-        formats << "%-#{colwidth + 2}s".dup if colwidth
-        start = colwidth ? 1 : 0
-
-        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
-          maximas << maxima
-          formats << if index == colcount - 1
-                       # Don't output 2 trailing spaces when printing the last column
-                       "%-s".dup
-                     else
-                       "%-#{maxima + 2}s".dup
-                     end
-        end
-
-        formats[0] = formats[0].insert(0, " " * indent)
-        formats << "%s"
-
-        array.each do |row|
-          sentence = "".dup
-
-          row.each_with_index do |column, index|
-            maxima = maximas[index]
-
-            f = if column.is_a?(Numeric)
-              if index == row.size - 1
-                # Don't output 2 trailing spaces when printing the last column
-                "%#{maxima}s"
-              else
-                "%#{maxima}s  "
-              end
-            else
-              formats[index]
-            end
-            sentence << f % column.to_s
-          end
-
-          sentence = truncate(sentence, options[:truncate]) if options[:truncate]
-          stdout.puts sentence
-        end
+      def print_table(array, options = {}) # rubocop:disable Metrics/MethodLength
+        printer = TablePrinter.new(stdout, options)
+        printer.print(array)
       end
 
       # Prints a long string, word-wrapping the text to the current width of the
@@ -225,32 +192,8 @@ class Thor
       # indent<Integer>:: Indent each line of the printed paragraph by indent value.
       #
       def print_wrapped(message, options = {})
-        indent = options[:indent] || 0
-        width = terminal_width - indent
-        paras = message.split("\n\n")
-
-        paras.map! do |unwrapped|
-          counter = 0
-          unwrapped.split(" ").inject do |memo, word|
-            word = word.gsub(/\n\005/, "\n").gsub(/\005/, "\n")
-            counter = 0 if word.include? "\n"
-            if (counter + word.length + 1) < width
-              memo = "#{memo} #{word}"
-              counter += (word.length + 1)
-            else
-              memo = "#{memo}\n#{word}"
-              counter = word.length
-            end
-            memo
-          end
-        end.compact!
-
-        paras.each do |para|
-          para.split("\n").each do |line|
-            stdout.puts line.insert(0, " " * indent)
-          end
-          stdout.puts unless para == paras.last
-        end
+        printer = WrappedPrinter.new(stdout, options)
+        printer.print(message)
       end
 
       # Deals with file collision and returns true if the file should be
@@ -268,7 +211,7 @@ class Thor
         loop do
           answer = ask(
             %[Overwrite #{destination}? (enter "h" for help) #{options}],
-            :add_to_history => false
+            add_to_history: false
           )
 
           case answer
@@ -295,24 +238,11 @@ class Thor
 
             say "Please specify merge tool to `THOR_MERGE` env."
           else
-            say file_collision_help
+            say file_collision_help(block_given?)
           end
         end
       end
 
-      # This code was copied from Rake, available under MIT-LICENSE
-      # Copyright (c) 2003, 2004 Jim Weirich
-      def terminal_width
-        result = if ENV["THOR_COLUMNS"]
-          ENV["THOR_COLUMNS"].to_i
-        else
-          unix? ? dynamic_width : DEFAULT_TERMINAL_WIDTH
-        end
-        result < 10 ? DEFAULT_TERMINAL_WIDTH : result
-      rescue
-        DEFAULT_TERMINAL_WIDTH
-      end
-
       # Called if something goes wrong during the execution. This is used by Thor
       # internally and should not be used inside your scripts. If something went
       # wrong, you can always raise an exception. If you raise a Thor::Error, it
@@ -363,16 +293,21 @@ class Thor
         end
       end
 
-      def file_collision_help #:nodoc:
-        <<-HELP
+      def file_collision_help(block_given) #:nodoc:
+        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
-        m - merge, run merge tool
         HELP
+        if block_given
+          help << <<-HELP
+        d - diff, show the differences between the old and the new
+        m - merge, run merge tool
+          HELP
+        end
+        help
       end
 
       def show_diff(destination, content) #:nodoc:
@@ -390,46 +325,8 @@ class Thor
         mute? || (base && base.options[:quiet])
       end
 
-      # Calculate the dynamic width of the terminal
-      def dynamic_width
-        @dynamic_width ||= (dynamic_width_stty.nonzero? || dynamic_width_tput)
-      end
-
-      def dynamic_width_stty
-        `stty size 2>/dev/null`.split[1].to_i
-      end
-
-      def dynamic_width_tput
-        `tput cols 2>/dev/null`.to_i
-      end
-
       def unix?
-        RUBY_PLATFORM =~ /(aix|darwin|linux|(net|free|open)bsd|cygwin|solaris|irix|hpux)/i
-      end
-
-      def truncate(string, width)
-        as_unicode do
-          chars = string.chars.to_a
-          if chars.length <= width
-            chars.join
-          else
-            chars[0, width - 3].join + "..."
-          end
-        end
-      end
-
-      if "".respond_to?(:encode)
-        def as_unicode
-          yield
-        end
-      else
-        def as_unicode
-          old = $KCODE
-          $KCODE = "U"
-          yield
-        ensure
-          $KCODE = old
-        end
+        Terminal.unix?
       end
 
       def ask_simply(statement, color, options)
@@ -451,16 +348,25 @@ class Thor
 
       def ask_filtered(statement, color, options)
         answer_set = options[:limited_to]
+        case_insensitive = options.fetch(:case_insensitive, false)
         correct_answer = nil
         until correct_answer
           answers = answer_set.join(", ")
           answer = ask_simply("#{statement} [#{answers}]", color, options)
-          correct_answer = answer_set.include?(answer) ? answer : nil
+          correct_answer = answer_match(answer_set, answer, case_insensitive)
           say("Your response must be one of: [#{answers}]. Please try again.") unless correct_answer
         end
         correct_answer
       end
 
+      def answer_match(possibilities, answer, case_insensitive)
+        if case_insensitive
+          possibilities.detect{ |possibility| possibility.downcase == answer.downcase }
+        else
+          possibilities.detect{ |possibility| possibility == answer }
+        end
+      end
+
       def merge(destination, content) #:nodoc:
         require "tempfile"
         Tempfile.open([File.basename(destination), File.extname(destination)], File.dirname(destination)) do |temp|

data/lib/thor/shell/color.rb

@@ -1,4 +1,5 @@
-require "thor/shell/basic"
+require_relative "basic"
+require_relative "lcs_diff"
 
 class Thor
   module Shell
@@ -6,6 +7,8 @@ class Thor
     # Thor::Shell::Basic to see all available methods.
     #
     class Color < Basic
+      include LCSDiff
+
       # Embed in a String to clear all previous ANSI sequences.
       CLEAR      = "\e[0m"
       # The start of an ANSI bold sequence.
@@ -97,52 +100,15 @@ class Thor
     protected
 
       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")
-
-          Diff::LCS.sdiff(actual, content).each do |diff|
-            output_diff_line(diff)
-          end
-        else
-          super
-        end
+        are_colors_supported? && !are_colors_disabled?
       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 are_colors_supported?
+        stdout.tty? && ENV["TERM"] != "dumb"
       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?
-
-        @diff_lcs_loaded = begin
-          require "diff/lcs"
-          true
-        rescue LoadError
-          false
-        end
+      def are_colors_disabled?
+        !ENV["NO_COLOR"].nil? && !ENV["NO_COLOR"].empty?
       end
     end
   end

data/lib/thor/shell/column_printer.rb

@@ -0,0 +1,29 @@
+require_relative "terminal"
+
+class Thor
+  module Shell
+    class ColumnPrinter
+      attr_reader :stdout, :options
+
+      def initialize(stdout, options = {})
+        @stdout = stdout
+        @options = options
+        @indent = options[:indent].to_i
+      end
+
+      def print(array)
+        return if array.empty?
+        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.terminal_width / colwidth))).zero? && !index.zero?) || index + 1 == array.length
+            stdout.puts value
+          else
+            stdout.printf("%-#{colwidth}s", value)
+          end
+        end
+      end
+    end
+  end
+end
+

data/lib/thor/shell/html.rb

@@ -1,4 +1,5 @@
-require "thor/shell/basic"
+require_relative "basic"
+require_relative "lcs_diff"
 
 class Thor
   module Shell
@@ -6,6 +7,8 @@ class Thor
     # Thor::Shell::Basic to see all available methods.
     #
     class HTML < Basic
+      include LCSDiff
+
       # The start of an HTML bold sequence.
       BOLD       = "font-weight: bold"
 
@@ -51,20 +54,20 @@ class Thor
       def set_color(string, *colors)
         if colors.all? { |color| color.is_a?(Symbol) || color.is_a?(String) }
           html_colors = colors.map { |color| lookup_color(color) }
-          "<span style=\"#{html_colors.join('; ')};\">#{string}</span>"
+          "<span style=\"#{html_colors.join('; ')};\">#{Thor::Util.escape_html(string)}</span>"
         else
           color, bold = colors
           html_color = self.class.const_get(color.to_s.upcase) if color.is_a?(Symbol)
           styles = [html_color]
           styles << BOLD if bold
-          "<span style=\"#{styles.join('; ')};\">#{string}</span>"
+          "<span style=\"#{styles.join('; ')};\">#{Thor::Util.escape_html(string)}</span>"
         end
       end
 
       # Ask something to the user and receives a response.
       #
       # ==== Example
-      # ask("What is your name?")
+      #   ask("What is your name?")
       #
       # TODO: Implement #ask for Thor::Shell::HTML
       def ask(statement, color = nil)
@@ -76,51 +79,6 @@ class Thor
       def can_display_colors?
         true
       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")
-
-          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
-      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?
-
-        @diff_lcs_loaded = begin
-          require "diff/lcs"
-          true
-        rescue LoadError
-          false
-        end
-      end
     end
   end
 end

data/lib/thor/shell/lcs_diff.rb

@@ -0,0 +1,49 @@
+module LCSDiff
+protected
+
+  # 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
+    end
+  end
+
+private
+
+  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?
+
+    @diff_lcs_loaded = begin
+      require "diff/lcs"
+      true
+    rescue LoadError
+      false
+    end
+  end
+
+end