thor 0.12.0 → 0.12.2

data/Thorfile

@@ -1,6 +1,7 @@
 # enconding: utf-8
 
 require File.join(File.dirname(__FILE__), "lib", "thor", "version")
+require 'rubygems'
 require 'thor/rake_compat'
 require 'spec/rake/spectask'
 require 'rdoc/task'
@@ -52,7 +53,7 @@ class Default < Thor
       s.bindir = "bin"
       s.executables = %w( thor rake2thor )
       s.files = s.extra_rdoc_files + Dir.glob("{bin,lib}/**/*")
-      s.files.exclude 'spec/sandbox/**/*'
+      s.test_files.include 'spec/**/*'
       s.test_files.exclude 'spec/sandbox/**/*'
     end
 

data/lib/thor.rb

@@ -78,14 +78,14 @@ class Thor
       @method_options
     end
 
-    # Adds an option to the set of class options. If :for is given as option,
+    # Adds an option to the set of method options. If :for is given as option,
     # it allows you to change the options from a previous defined task.
     #
     #   def previous_task
     #     # magic
     #   end
     #
-    #   method_options :foo => :bar, :for => :previous_task
+    #   method_option :foo => :bar, :for => :previous_task
     #
     #   def next_task
     #     # magic
@@ -101,7 +101,6 @@ class Thor
     # :default  - Default value for this argument. It cannot be required and have default values.
     # :aliases  - Aliases for this option.
     # :type     - The type of the argument, can be :string, :hash, :array, :numeric or :boolean.
-    # :group    - The group for this options. Use by class options to output options in different levels.
     # :banner   - String to show on usage notes.
     #
     def method_option(name, options={})
@@ -150,39 +149,42 @@ class Thor
     # namespace:: When true, shows the namespace in the output before the usage.
     # skip_inherited:: When true, does not show tasks from superclass.
     #
-    def help(shell, meth=nil, options={})
-      meth, options = nil, meth if meth.is_a?(Hash)
-
-      if meth
-        task = all_tasks[meth]
-        raise UndefinedTaskError, "task '#{meth}' could not be found in namespace '#{self.namespace}'" unless task
+    def help(shell, options={})
+      if options[:task]
+        task = all_tasks[options[:task]]
+        raise UndefinedTaskError, "task '#{options[:task]}' could not be found in namespace '#{self.namespace}'" unless task
 
         shell.say "Usage:"
-        shell.say "  #{banner(task, options[:namespace], false)}"
+        shell.say "  #{banner(task)}"
         shell.say
-        class_options_help(shell, "Class", :Method => task.options.map { |_, o| o })
+        class_options_help(shell, nil => task.options.map { |_, o| o })
         shell.say task.description
       else
-        list = (options[:short] ? tasks : all_tasks).map do |_, task|
-          item = [ banner(task, options[:namespace]) ]
-          item << "# #{task.short_description}" if task.short_description
-          item << " "
+        list = printable_tasks(!options[:short])
+
+        Thor::Util.thor_classes_in(self).each do |klass|
+          list += klass.printable_tasks(false)
         end
 
-        options[:ident] ||= 2
+        list.sort!{ |a,b| a[0] <=> b[0] }
+
         if options[:short]
-          shell.print_list(list, :ident => options[:ident])
+          shell.print_table(list, :truncate => true)
         else
           shell.say "Tasks:"
-          shell.print_list(list, :ident => options[:ident])
-        end
-
-        Thor::Util.thor_classes_in(self).each do |subclass|
-          namespace = options[:namespace] == true || subclass.namespace.gsub(/^#{self.namespace}:/, '')
-          subclass.help(shell, options.merge(:short => true, :namespace => namespace))
+          shell.print_table(list, :ident => 2, :truncate => true)
+          shell.say
+          class_options_help(shell)
         end
+      end
+    end
 
-        class_options_help(shell, "Class") unless options[:short]
+    def printable_tasks(all=true)
+      (all ? all_tasks : tasks).map do |_, task|
+        item = []
+        item << banner(task)
+        item << "# #{task.description}" if task.description
+        item
       end
     end
 
@@ -193,8 +195,8 @@ class Thor
       # the task that is going to be invoked and a boolean which indicates if
       # the namespace should be displayed as arguments.
       #
-      def banner(task, namespace=true, show_options=true)
-        task.formatted_usage(self, namespace, show_options)
+      def banner(task)
+        "thor " + task.formatted_usage(self)
       end
 
       def baseclass #:nodoc:
@@ -237,6 +239,6 @@ class Thor
 
   desc "help [TASK]", "Describe available tasks or one specific task"
   def help(task=nil)
-    self.class.help(shell, task, :namespace => task && task.include?(?:))
+    self.class.help(shell, :task => task)
   end
 end

data/lib/thor/actions.rb

@@ -38,17 +38,17 @@ class Thor
       # Add runtime options that help actions execution.
       #
       def add_runtime_options!
-        class_option :pretend, :type => :boolean, :aliases => "-p", :group => :runtime,
-                               :desc => "Run but do not make any changes"
-
         class_option :force, :type => :boolean, :aliases => "-f", :group => :runtime,
                              :desc => "Overwrite files that already exist"
 
-        class_option :skip, :type => :boolean, :aliases => "-s", :group => :runtime,
-                            :desc => "Skip files that already exist"
+        class_option :pretend, :type => :boolean, :aliases => "-p", :group => :runtime,
+                               :desc => "Run but do not make any changes"
 
         class_option :quiet, :type => :boolean, :aliases => "-q", :group => :runtime,
                              :desc => "Supress status output"
+
+        class_option :skip, :type => :boolean, :aliases => "-s", :group => :runtime,
+                            :desc => "Skip files that already exist"
       end
     end
 

data/lib/thor/actions/directory.rb

@@ -79,11 +79,9 @@ class Thor
                 next if dirname == given_destination
                 base.empty_directory(dirname, config)
               when /\.tt$/
-                destination = base.template(file_source, file_destination[0..-4], config)
-                @block.call(destination) if @block
+                destination = base.template(file_source, file_destination[0..-4], config, &@block)
               else
-                destination = base.copy_file(file_source, file_destination, config)
-                @block.call(destination) if @block
+                destination = base.copy_file(file_source, file_destination, config, &@block)
             end
           end
         end

data/lib/thor/actions/file_manipulation.rb

@@ -18,12 +18,14 @@ class Thor
     #
     #   copy_file "doc/README"
     #
-    def copy_file(source, destination=nil, config={})
+    def copy_file(source, destination=nil, config={}, &block)
       destination ||= source
       source = File.expand_path(find_in_source_paths(source.to_s))
 
       create_file destination, nil, config do
-        File.read(source)
+        content = File.read(source)
+        content = block.call(content) if block
+        content
       end
     end
 
@@ -72,13 +74,15 @@ class Thor
     #
     #   template "doc/README"
     #
-    def template(source, destination=nil, config={})
+    def template(source, destination=nil, config={}, &block)
       destination ||= source
       source  = File.expand_path(find_in_source_paths(source.to_s))
       context = instance_eval('binding')
 
       create_file destination, nil, config do
-        ERB.new(::File.read(source), nil, '-').result(context)
+        content = ERB.new(::File.read(source), nil, '-').result(context)
+        content = block.call(content) if block
+        content
       end
     end
 

data/lib/thor/base.rb

@@ -92,6 +92,8 @@ class Thor
     end
 
     module ClassMethods
+      attr_accessor :debugging
+
       # Adds an argument to the class and creates an attr_accessor for it.
       #
       # Arguments are different from options in several aspects. The first one
@@ -347,10 +349,11 @@ class Thor
       # Default way to start generators from the command line.
       #
       def start(given_args=ARGV, config={})
+        self.debugging = given_args.include?("--debug")
         config[:shell] ||= Thor::Base.shell.new
         yield
       rescue Thor::Error => e
-        if given_args.include?("--debug")
+        if debugging
           raise e
         else
           config[:shell].error e.message
@@ -361,48 +364,43 @@ class Thor
       protected
 
         # Prints the class options per group. If an option does not belong to
-        # any group, it uses the ungrouped name value. This method provide to
-        # hooks to add extra options, one of them if the third argument called
-        # extra_group that should be a hash in the format :group => Array[Options].
-        #
-        # The second is by returning a lambda used to print values. The lambda
-        # requires two options: the group name and the array of options.
+        # any group, it's printed as Class option.
         #
-        def class_options_help(shell, ungrouped_name=nil, extra_group=nil) #:nodoc:
-          groups = {}
-
+        def class_options_help(shell, groups={}) #:nodoc:
+          # Group options by group
           class_options.each do |_, value|
             groups[value.group] ||= []
             groups[value.group] << value
           end
 
-          printer = proc do |group_name, options|
-            list = []
-            padding = options.collect{ |o| o.aliases.size  }.max.to_i * 4
+          # Deal with default group
+          global_options = groups.delete(nil) || []
+          print_options(shell, global_options)
+
+          # Print all others
+          groups.each do |group_name, options|
+            print_options(shell, options, group_name)
+          end
+        end
+
+        # Receives a set of options and print them.
+        def print_options(shell, options, group_name=nil)
+          return if options.empty?
 
-            options.each do |option|
-              item = [ option.usage(padding) ]
-              item.push(option.description ? "# #{option.description}" : "")
+          list = []
+          padding = options.collect{ |o| o.aliases.size }.max.to_i * 4
 
-              list << item
-              list << [ "", "# Default: #{option.default}" ] if option.show_default?
-            end
+          options.each do |option|
+            item = [ option.usage(padding) ]
+            item.push(option.description ? "# #{option.description}" : "")
 
-            unless list.empty?
-              shell.say(group_name ? "#{group_name} options:" : "Options:")
-              shell.print_table(list, :ident => 2)
-              shell.say ""
-            end
+            list << item
+            list << [ "", "# Default: #{option.default}" ] if option.show_default?
           end
 
-          # Deal with default group
-          global_options = groups.delete(nil) || []
-          printer.call(ungrouped_name, global_options) if global_options
-
-          # Print all others
-          groups = extra_group.merge(groups) if extra_group
-          groups.each(&printer)
-          printer
+          shell.say(group_name ? "#{group_name} options:" : "Options:")
+          shell.print_table(list, :ident => 2)
+          shell.say ""
         end
 
         # Raises an error if the word given is a Thor reserved word.

data/lib/thor/group.rb

@@ -46,8 +46,8 @@ class Thor::Group
         shell.say banner
       else
         shell.say "Usage:"
-        shell.say "  #{banner}"
-        shell.say
+        shell.say "  #{banner}\n"
+        shell.say ""
         class_options_help(shell)
         shell.say self.desc if self.desc
       end
@@ -177,15 +177,11 @@ class Thor::Group
     # Overwrite class options help to allow invoked generators options to be
     # shown recursively when invoking a generator.
     #
-    def class_options_help(shell, ungrouped_name=nil, extra_group=nil) #:nodoc:
-      group_options = {}
-
-      get_options_from_invocations(group_options, class_options) do |klass|
-        klass.send(:get_options_from_invocations, group_options, class_options)
+    def class_options_help(shell, groups={}) #:nodoc:
+      get_options_from_invocations(groups, class_options) do |klass|
+        klass.send(:get_options_from_invocations, groups, class_options)
       end
-
-      group_options.merge!(extra_group) if extra_group
-      super(shell, ungrouped_name, group_options)
+      super(shell, groups)
     end
 
     # Get invocations array and merge options from invocations. Those
@@ -224,7 +220,7 @@ class Thor::Group
       # thor class by another ways which is not the Thor::Runner.
       #
       def banner
-        "#{self.namespace} #{self.arguments.map {|a| a.usage }.join(' ')}"
+        "thor #{self.namespace} #{self.arguments.map {|a| a.usage }.join(' ')}"
       end
 
       def baseclass #:nodoc:

data/lib/thor/runner.rb

@@ -149,6 +149,10 @@ class Thor::Runner < Thor #:nodoc:
 
   private
 
+    def self.banner(task)
+      "thor " + task.formatted_usage(self, false)
+    end
+
     def thor_root
       Thor::Util.thor_root
     end
@@ -289,11 +293,11 @@ class Thor::Runner < Thor #:nodoc:
       unless klass.tasks.empty?
         base = klass.namespace
 
-        color = base == "default" ? :magenta : :blue
-        say shell.set_color(base, color, true)
+        say shell.set_color(base, :blue, true)
         say "-" * base.length
 
-        klass.help(shell, :short => true, :ident => 0, :namespace => true)
+        klass.help(shell, :short => true)
+        say
       end
     end
 end

data/lib/thor/shell.rb

@@ -22,7 +22,7 @@ class Thor
   end
 
   module Shell
-    SHELL_DELEGATED_METHODS = [:ask, :yes?, :no?, :say, :say_status, :print_list, :print_table]
+    SHELL_DELEGATED_METHODS = [:ask, :yes?, :no?, :say, :say_status, :print_table]
 
     # Add shell to initialize config values.
     #

data/lib/thor/shell/basic.rb

@@ -75,30 +75,6 @@ class Thor
         !yes?(statement, color)
       end
 
-      # Prints a list of items.
-      #
-      # ==== Parameters
-      # list<Array[String, String, ...]>
-      #
-      # ==== Options
-      # mode:: Can be :rows or :inline. Defaults to :rows.
-      # ident:: Ident each item with the value given.
-      #
-      def print_list(list, options={})
-        return if list.empty?
-
-        ident   = " " * (options[:ident] || 0)
-        content = case options[:mode]
-          when :inline
-            last = list.pop
-            "#{list.join(", ")}, and #{last}"
-          else # rows
-            ident + list.join("\n#{ident}")
-        end
-
-        $stdout.puts content
-      end
-
       # Prints a table.
       #
       # ==== Parameters
@@ -110,20 +86,26 @@ class Thor
       def print_table(table, options={})
         return if table.empty?
 
-        formats = []
+        formats, ident = [], options[:ident].to_i
+        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 << "%-#{maxima + 2}s"
         end
 
-        formats[0] = formats[0].insert(0, " " * options[:ident]) if options[:ident]
+        formats[0] = formats[0].insert(0, " " * ident)
         formats << "%s"
 
         table.each do |row|
+          sentence = ""
+
           row.each_with_index do |column, i|
-            $stdout.print formats[i] % column.to_s
+            sentence << formats[i] % column.to_s
           end
-          $stdout.puts
+
+          sentence = truncate(sentence, options[:truncate]) if options[:truncate]
+          $stdout.puts sentence  
         end
       end
 
@@ -143,7 +125,7 @@ class Thor
           answer = ask %[Overwrite #{destination}? (enter "h" for help) #{options}]
 
           case answer
-            when is?(:yes), is?(:force)
+            when is?(:yes), is?(:force), ""
               return true
             when is?(:no), is?(:skip)
               return false
@@ -214,6 +196,44 @@ HELP
           base && base.options[:quiet]
         end
 
+        # 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
+          else
+            result = unix? ? dynamic_width : 80
+          end
+          (result < 10) ? 80 : result
+        rescue
+          80
+        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
+          %x{stty size 2>/dev/null}.split[1].to_i
+        end
+
+        def dynamic_width_tput
+          %x{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)
+          if string.length <= width
+            string
+          else
+            ( string[0, width-3] || "" ) + "..."
+          end
+        end
+
     end
   end
 end