thor 1.1.0 → 1.4.0

data/lib/thor/runner.rb

@@ -1,13 +1,10 @@
 require_relative "../thor"
 require_relative "group"
 
-require "yaml"
-require "digest/md5"
+require "digest/sha2"
 require "pathname"
 
-class Thor::Runner < Thor #:nodoc: # rubocop:disable ClassLength
-  autoload :OpenURI, "open-uri"
-
+class Thor::Runner < Thor #:nodoc:
   map "-T" => :list, "-i" => :install, "-u" => :update, "-v" => :version
 
   def self.banner(command, all = false, subcommand = false)
@@ -25,7 +22,7 @@ class Thor::Runner < Thor #:nodoc: # rubocop:disable ClassLength
       initialize_thorfiles(meth)
       klass, command = Thor::Util.find_class_and_command_by_namespace(meth)
       self.class.handle_no_command_error(command, false) if klass.nil?
-      klass.start(["-h", command].compact, :shell => shell)
+      klass.start(["-h", command].compact, shell: shell)
     else
       super
     end
@@ -40,30 +37,42 @@ class Thor::Runner < Thor #:nodoc: # rubocop:disable ClassLength
     klass, command = Thor::Util.find_class_and_command_by_namespace(meth)
     self.class.handle_no_command_error(command, false) if klass.nil?
     args.unshift(command) if command
-    klass.start(args, :shell => shell)
+    klass.start(args, shell: shell)
   end
 
   desc "install NAME", "Install an optionally named Thor file into your system commands"
-  method_options :as => :string, :relative => :boolean, :force => :boolean
-  def install(name) # rubocop:disable MethodLength
+  method_options as: :string, relative: :boolean, force: :boolean
+  def install(name) # rubocop:disable Metrics/MethodLength
     initialize_thorfiles
 
-    # If a directory name is provided as the argument, look for a 'main.thor'
-    # command in said directory.
-    begin
-      if File.directory?(File.expand_path(name))
-        base = File.join(name, "main.thor")
-        package = :directory
-        contents = open(base, &:read)
-      else
-        base = name
-        package = :file
-        contents = open(name, &:read)
+    is_uri  = name =~ %r{^https?\://}
+
+    if is_uri
+      base = name
+      package = :file
+      require "open-uri"
+      begin
+        contents = URI.open(name, &:read)
+      rescue OpenURI::HTTPError
+        raise Error, "Error opening URI '#{name}'"
+      end
+    else
+      # If a directory name is provided as the argument, look for a 'main.thor'
+      # command in said directory.
+      begin
+        if File.directory?(File.expand_path(name))
+          base = File.join(name, "main.thor")
+          package = :directory
+          contents = File.open(base, &:read)
+        else
+          base = name
+          package = :file
+          require "open-uri"
+          contents = URI.open(name, &:read)
+        end
+      rescue Errno::ENOENT
+        raise Error, "Error opening file '#{name}'"
       end
-    rescue OpenURI::HTTPError
-      raise Error, "Error opening URI '#{name}'"
-    rescue Errno::ENOENT
-      raise Error, "Error opening file '#{name}'"
     end
 
     say "Your Thorfile contains:"
@@ -84,16 +93,16 @@ class Thor::Runner < Thor #:nodoc: # rubocop:disable ClassLength
       as = basename if as.empty?
     end
 
-    location = if options[:relative] || name =~ %r{^https?://}
+    location = if options[:relative] || is_uri
       name
     else
       File.expand_path(name)
     end
 
     thor_yaml[as] = {
-      :filename   => Digest::MD5.hexdigest(name + as),
-      :location   => location,
-      :namespaces => Thor::Util.namespaces_in_content(contents, base)
+      filename: Digest::SHA256.hexdigest(name + as),
+      location: location,
+      namespaces: Thor::Util.namespaces_in_content(contents, base)
     }
 
     save_yaml(thor_yaml)
@@ -154,14 +163,14 @@ class Thor::Runner < Thor #:nodoc: # rubocop:disable ClassLength
   end
 
   desc "installed", "List the installed Thor modules and commands"
-  method_options :internal => :boolean
+  method_options internal: :boolean
   def installed
     initialize_thorfiles(nil, true)
     display_klasses(true, options["internal"])
   end
 
   desc "list [SEARCH]", "List the available thor commands (--substring means .*SEARCH)"
-  method_options :substring => :boolean, :group => :string, :all => :boolean, :debug => :boolean
+  method_options substring: :boolean, group: :string, all: :boolean, debug: :boolean
   def list(search = "")
     initialize_thorfiles
 
@@ -185,6 +194,7 @@ private
   def thor_yaml
     @thor_yaml ||= begin
       yaml_file = File.join(thor_root, "thor.yml")
+      require "yaml"
       yaml = YAML.load_file(yaml_file) if File.exist?(yaml_file)
       yaml || {}
     end
@@ -303,7 +313,7 @@ private
     say shell.set_color(namespace, :blue, true)
     say "-" * namespace.size
 
-    print_table(list, :truncate => true)
+    print_table(list, truncate: true)
     say
   end
   alias_method :display_tasks, :display_commands

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,7 +93,7 @@ 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?
@@ -103,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
@@ -111,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
@@ -143,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.
@@ -163,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
@@ -227,33 +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|
-          words = unwrapped.split(" ")
-          counter = words.first.length
-          words.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
@@ -271,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
@@ -298,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
@@ -366,23 +293,28 @@ 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:
         diff_cmd = ENV["THOR_DIFF"] || ENV["RAILS_DIFF"] || "diff -u"
 
         require "tempfile"
-        Tempfile.open(File.basename(destination), File.dirname(destination)) do |temp|
+        Tempfile.open(File.basename(destination), File.dirname(destination), binmode: true) do |temp|
           temp.write content
           temp.rewind
           system %(#{diff_cmd} "#{destination}" "#{temp.path}")
@@ -393,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)
@@ -478,16 +372,12 @@ class Thor
         Tempfile.open([File.basename(destination), File.extname(destination)], File.dirname(destination)) do |temp|
           temp.write content
           temp.rewind
-          system %(#{merge_tool} "#{temp.path}" "#{destination}")
+          system(merge_tool, temp.path, destination)
         end
       end
 
       def merge_tool #:nodoc:
-        @merge_tool ||= ENV["THOR_MERGE"] || git_merge_tool
-      end
-
-      def git_merge_tool #:nodoc:
-        `git config merge.tool`.rstrip rescue ""
+        @merge_tool ||= ENV["THOR_MERGE"] || "git difftool --no-index"
       end
     end
   end

data/lib/thor/shell/color.rb

@@ -1,4 +1,5 @@
 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.
@@ -105,52 +108,7 @@ class Thor
       end
 
       def are_colors_disabled?
-        !ENV['NO_COLOR'].nil?
-      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
+        !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_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"
 
@@ -64,7 +67,7 @@ class Thor
       # 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