thor 0.13.4 → 0.14.3

data/lib/thor/shell/basic.rb

@@ -35,15 +35,17 @@ class Thor
       # say("I know you knew that.")
       #
       def say(message="", color=nil, force_new_line=(message.to_s !~ /( |\t)$/))
-        message  = message.to_s
-        message  = set_color(message, color) if color
+        message = message.to_s
+        message = set_color(message, color) if color
+
+        spaces = "  " * padding
 
         if force_new_line
-          $stdout.puts(message)
+          $stdout.puts(spaces + message)
         else
-          $stdout.print(message)
-          $stdout.flush
+          $stdout.print(spaces + message)
         end
+        $stdout.flush
       end
 
       # Say a status with the given color and appends the message. Since this
@@ -58,14 +60,16 @@ class Thor
 
         status = status.to_s.rjust(12)
         status = set_color status, color, true if color
-        say "#{status}#{spaces}#{message}", nil, true
+
+        $stdout.puts "#{status}#{spaces}#{message}"
+        $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)
+        !!(ask(statement, color) =~ is?(:yes))
       end
 
       # Make a question the to user and returns true if the user replies "n" or
@@ -81,16 +85,20 @@ class Thor
       # Array[Array[String, String, ...]]
       #
       # ==== Options
-      # ident<Integer>:: Ident the first column by ident value.
+      # ident<Integer>:: Indent the first column by ident value.
+      # colwidth<Integer>:: Force the first column to colwidth spaces wide.
       #
       def print_table(table, options={})
         return if table.empty?
 
-        formats, ident = [], options[:ident].to_i
+        formats, ident, colwidth = [], options[:ident].to_i, options[:colwidth]
         options[:truncate] = terminal_width if options[:truncate] == true
 
-        0.upto(table.first.length - 2) do |i|
-          maxima = table.max{ |a,b| a[i].size <=> b[i].size }[i].size
+        formats << "%-#{colwidth + 2}s" if colwidth
+        start = colwidth ? 1 : 0
+
+        start.upto(table.first.length - 2) do |i|
+          maxima ||= table.max{|a,b| a[i].size <=> b[i].size }[i].size
           formats << "%-#{maxima + 2}s"
         end
 
@@ -105,7 +113,35 @@ class Thor
           end
 
           sentence = truncate(sentence, options[:truncate]) if options[:truncate]
-          $stdout.puts sentence  
+          $stdout.puts sentence
+        end
+      end
+
+      # Prints a long string, word-wrapping the text to the current width of the
+      # terminal display. Ideal for printing heredocs.
+      #
+      # ==== Parameters
+      # String
+      #
+      # ==== Options
+      # ident<Integer>:: Indent each line of the printed paragraph by ident value.
+      #
+      def print_wrapped(message, options={})
+        ident = options[:ident] || 0
+        width = terminal_width - ident
+        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")}
+        end
+
+        paras.each do |para|
+          para.split("\n").each do |line|
+            $stdout.puts line.insert(0, " " * ident)
+          end
+          $stdout.puts unless para == paras.last
         end
       end
 

data/lib/thor/shell/html.rb

@@ -0,0 +1,121 @@
+require 'thor/shell/basic'
+
+class Thor
+  module Shell
+    # Inherit from Thor::Shell::Basic and add set_color behavior. Check
+    # Thor::Shell::Basic to see all available methods.
+    #
+    class HTML < Basic
+      # The start of an HTML bold sequence.
+      BOLD       = "<strong>"
+      # The end of an HTML bold sequence.
+      END_BOLD   = "</strong>"
+
+      # Embed in a String to clear previous color selection.
+      CLEAR      = "</span>"
+
+      # Set the terminal's foreground HTML color to black.
+      BLACK      = '<span style="color: black;">'
+      # Set the terminal's foreground HTML color to red.
+      RED        = '<span style="color: red;">'
+      # Set the terminal's foreground HTML color to green.
+      GREEN      = '<span style="color: green;">'
+      # Set the terminal's foreground HTML color to yellow.
+      YELLOW     = '<span style="color: yellow;">'
+      # Set the terminal's foreground HTML color to blue.
+      BLUE       = '<span style="color: blue;">'
+      # Set the terminal's foreground HTML color to magenta.
+      MAGENTA    = '<span style="color: magenta;">'
+      # Set the terminal's foreground HTML color to cyan.
+      CYAN       = '<span style="color: cyan;">'
+      # Set the terminal's foreground HTML color to white.
+      WHITE      = '<span style="color: white;">'
+
+      # Set the terminal's background HTML color to black.
+      ON_BLACK   = '<span style="background-color: black">'
+      # Set the terminal's background HTML color to red.
+      ON_RED     = '<span style="background-color: red">'
+      # Set the terminal's background HTML color to green.
+      ON_GREEN   = '<span style="background-color: green">'
+      # Set the terminal's background HTML color to yellow.
+      ON_YELLOW  = '<span style="background-color: yellow">'
+      # Set the terminal's background HTML color to blue.
+      ON_BLUE    = '<span style="background-color: blue">'
+      # Set the terminal's background HTML color to magenta.
+      ON_MAGENTA = '<span style="background-color: magenta">'
+      # Set the terminal's background HTML color to cyan.
+      ON_CYAN    = '<span style="background-color: cyan">'
+      # Set the terminal's background HTML color to white.
+      ON_WHITE   = '<span style="background-color: white">'
+
+      # Set color by using a string or one of the defined constants. If a third
+      # option is set to true, it also adds bold to the string. This is based
+      # on Highline implementation and it automatically appends CLEAR to the end
+      # of the returned String.
+      #
+      def set_color(string, color, bold=false)
+        color = self.class.const_get(color.to_s.upcase) if color.is_a?(Symbol)
+        bold, end_bold = bold ? [BOLD, END_BOLD] : ['', '']
+        "#{bold}#{color}#{string}#{CLEAR}#{end_bold}"
+      end
+
+      # Ask something to the user and receives a response.
+      #
+      # ==== Example
+      # ask("What is your name?")
+      #
+      # TODO: Implement #ask for Thor::Shell::HTML
+      def ask(statement, color=nil)
+        raise NotImplementedError, "Implement #ask for Thor::Shell::HTML"
+      end
+
+      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
+
+        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.rb

@@ -1,5 +1,4 @@
 require 'rbconfig'
-require 'thor/shell/color'
 
 class Thor
   module Base
@@ -7,7 +6,9 @@ class Thor
     # it will use a colored log, otherwise it will use a basic one without color.
     #
     def self.shell
-      @shell ||= if Config::CONFIG['host_os'] =~ /mswin|mingw/
+      @shell ||= if ENV['THOR_SHELL'] && ENV['THOR_SHELL'].size > 0
+        Thor::Shell.const_get(ENV['THOR_SHELL'])
+      elsif RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
         Thor::Shell::Basic
       else
         Thor::Shell::Color
@@ -24,6 +25,10 @@ class Thor
   module Shell
     SHELL_DELEGATED_METHODS = [:ask, :yes?, :no?, :say, :say_status, :print_table]
 
+    autoload :Basic, 'thor/shell/basic'
+    autoload :Color, 'thor/shell/color'
+    autoload :HTML,  'thor/shell/html'
+
     # Add shell to initialize config values.
     #
     # ==== Configuration

data/lib/thor/task.rb

@@ -1,24 +1,9 @@
 class Thor
-  class Task < Struct.new(:name, :description, :usage, :options)
+  class Task < Struct.new(:name, :description, :long_description, :usage, :options)
     FILE_REGEXP = /^#{Regexp.escape(File.dirname(__FILE__))}/
 
-    # A dynamic task that handles method missing scenarios.
-    class Dynamic < Task
-      def initialize(name, options=nil)
-        super(name.to_s, "A dynamically-generated task", name.to_s, options)
-      end
-
-      def run(instance, args=[])
-        if (instance.methods & [name.to_s, name.to_sym]).empty?
-          super
-        else
-          instance.class.handle_no_task_error(name)
-        end
-      end
-    end
-
-    def initialize(name, description, usage, options=nil)
-      super(name.to_s, description, usage, options || {})
+    def initialize(name, description, long_description, usage, options=nil)
+      super(name.to_s, description, long_description, usage, options || {})
     end
 
     def initialize_copy(other) #:nodoc:
@@ -26,6 +11,10 @@ class Thor
       self.options = other.options.dup if other.options
     end
 
+    def hidden?
+      false
+    end
+
     # By default, a task invokes a method in the thor class. You can change this
     # implementation to create custom tasks.
     def run(instance, args=[])
@@ -39,18 +28,17 @@ class Thor
         instance.class.handle_no_task_error(name) : (raise e)
     end
 
-    # Returns the formatted usage by injecting given required arguments 
+    # Returns the formatted usage by injecting given required arguments
     # and required options into the given usage.
-    def formatted_usage(klass, namespace=true)
-      namespace = klass.namespace unless namespace == false
-
-      # Add namespace
-      formatted = if namespace
-        "#{namespace.gsub(/^(default|thor:runner:)/,'')}:"
-      else
-        ""
+    def formatted_usage(klass, namespace = true, subcommand = false)
+      if namespace
+        namespace = klass.namespace
+        formatted = "#{namespace.gsub(/^(default)/,'')}:"
+        formatted.sub!(/.$/, ' ') if subcommand
       end
 
+      formatted ||= ""
+
       # Add usage with required arguments
       formatted << if klass && !klass.arguments.empty?
         usage.to_s.gsub(/^#{name}/) do |match|
@@ -67,36 +55,60 @@ class Thor
       formatted.strip
     end
 
-    protected
+  protected
 
-      def not_debugging?(instance)
-        !(instance.class.respond_to?(:debugging) && instance.class.debugging)
-      end
+    def not_debugging?(instance)
+      !(instance.class.respond_to?(:debugging) && instance.class.debugging)
+    end
 
-      def required_options
-        @required_options ||= options.map{ |_, o| o.usage if o.required? }.compact.sort.join(" ")
-      end
+    def required_options
+      @required_options ||= options.map{ |_, o| o.usage if o.required? }.compact.sort.join(" ")
+    end
 
-      # Given a target, checks if this class name is not a private/protected method.
-      def public_method?(instance) #:nodoc:
-        collection = instance.private_methods + instance.protected_methods
-        (collection & [name.to_s, name.to_sym]).empty?
-      end
+    # Given a target, checks if this class name is not a private/protected method.
+    def public_method?(instance) #:nodoc:
+      collection = instance.private_methods + instance.protected_methods
+      (collection & [name.to_s, name.to_sym]).empty?
+    end
 
-      def sans_backtrace(backtrace, caller) #:nodoc:
-        saned  = backtrace.reject { |frame| frame =~ FILE_REGEXP }
-        saned -= caller
-      end
+    def sans_backtrace(backtrace, caller) #:nodoc:
+      saned  = backtrace.reject { |frame| frame =~ FILE_REGEXP }
+      saned -= caller
+    end
 
-      def handle_argument_error?(instance, error, caller)
-        not_debugging?(instance) && error.message =~ /wrong number of arguments/ &&
-          sans_backtrace(error.backtrace, caller).empty?
+    def handle_argument_error?(instance, error, caller)
+      not_debugging?(instance) && error.message =~ /wrong number of arguments/ && begin
+        saned = sans_backtrace(error.backtrace, caller)
+        # Ruby 1.9 always include the called method in the backtrace
+        saned.empty? || (saned.size == 1 && RUBY_VERSION >= "1.9")
       end
+    end
 
-      def handle_no_method_error?(instance, error, caller)
-        not_debugging?(instance) &&
-          error.message =~ /^undefined method `#{name}' for #{Regexp.escape(instance.to_s)}$/
-      end
+    def handle_no_method_error?(instance, error, caller)
+      not_debugging?(instance) &&
+        error.message =~ /^undefined method `#{name}' for #{Regexp.escape(instance.to_s)}$/
+    end
+  end
+
+  # A task that is hidden in help messages but still invocable.
+  class HiddenTask < Task
+    def hidden?
+      true
+    end
+  end
+
+  # A dynamic task that handles method missing scenarios.
+  class DynamicTask < Task
+    def initialize(name, options=nil)
+      super(name.to_s, "A dynamically-generated task", name.to_s, name.to_s, options)
+    end
 
+    def run(instance, args=[])
+      if (instance.methods & [name.to_s, name.to_sym]).empty?
+        super
+      else
+        instance.class.handle_no_task_error(name)
+      end
+    end
   end
-end
+end

data/lib/thor/util.rb

@@ -128,38 +128,37 @@ class Thor
     # ==== Parameters
     # namespace<String>
     #
-    def self.find_class_and_task_by_namespace(namespace)
-      if namespace.include?(?:)
+    def self.find_class_and_task_by_namespace(namespace, fallback = true)
+      if namespace.include?(?:) # look for a namespaced task
         pieces = namespace.split(":")
         task   = pieces.pop
         klass  = Thor::Util.find_by_namespace(pieces.join(":"))
       end
-
-      unless klass
+      unless klass # look for a Thor::Group with the right name
         klass, task = Thor::Util.find_by_namespace(namespace), nil
       end
-
-      return klass, task
-    end
-
-    # The same as namespace_to_thor_class_and_task!, but raises an error if a klass
-    # could not be found.
-    def self.find_class_and_task_by_namespace!(namespace)
-      klass, task = find_class_and_task_by_namespace(namespace)
-      raise Error, "Could not find namespace or task #{namespace.inspect}." unless klass
+      if !klass && fallback # try a task in the default namespace
+        task = namespace
+        klass = Thor::Util.find_by_namespace('')
+      end
       return klass, task
     end
 
     # Receives a path and load the thor file in the path. The file is evaluated
     # inside the sandbox to avoid namespacing conflicts.
     #
-    def self.load_thorfile(path, content=nil)
+    def self.load_thorfile(path, content=nil, debug=false)
       content ||= File.binread(path)
 
       begin
         Thor::Sandbox.class_eval(content, path)
       rescue Exception => e
         $stderr.puts "WARNING: unable to load thorfile #{path.inspect}: #{e.message}"
+        if debug
+          $stderr.puts *e.backtrace
+        else
+          $stderr.puts e.backtrace.first
+        end
       end
     end
 
@@ -217,8 +216,8 @@ class Thor
     #
     def self.ruby_command
       @ruby_command ||= begin
-        ruby = File.join(Config::CONFIG['bindir'], Config::CONFIG['ruby_install_name'])
-        ruby << Config::CONFIG['EXEEXT']
+        ruby = File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
+        ruby << RbConfig::CONFIG['EXEEXT']
 
         # escape string in case path to ruby executable contain spaces.
         ruby.sub!(/.*\s.*/m, '"\&"')

data/lib/thor/version.rb

@@ -1,3 +1,3 @@
 class Thor
-  VERSION = "0.13.4".freeze
+  VERSION = "0.14.3".freeze
 end