thor 0.12.0 → 0.12.3

data/CHANGELOG.rdoc

@@ -1,9 +1,7 @@
-== TODO
-
-* Improve spec coverage for Thor::Runner
-
-== 0.12, released 2009-11-06
+== 0.12, released 2010-01-02
 
+* Removed rr in favor to rspec mock framework
+* Improved output for thor -T
 * [#7] Do not force white color on status
 * [#8] Yield a block with the filename on directory
 

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/bin/thor

@@ -4,4 +4,5 @@
 require 'thor'
 require 'thor/runner'
 
+$thor_runner = true
 Thor::Runner.start

data/lib/thor/actions/create_file.rb

@@ -42,7 +42,7 @@ class Thor
       # Boolean:: true if it is identical, false otherwise.
       #
       def identical?
-        exists? && File.read(destination) == render
+        exists? && File.binread(destination) == render
       end
 
       # Holds the content to be added to the file.
@@ -58,7 +58,7 @@ class Thor
       def invoke!
         invoke_with_conflict_check do
           FileUtils.mkdir_p(File.dirname(destination))
-          File.open(destination, 'w'){ |f| f.write render }
+          File.open(destination, 'wb') { |f| f.write render }
         end
         given_destination
       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.binread(source)
+        content = block.call(content) if block
+        content
       end
     end
 
@@ -46,7 +48,7 @@ class Thor
     #
     def get(source, destination=nil, config={}, &block)
       source = File.expand_path(find_in_source_paths(source.to_s)) unless source =~ /^http\:\/\//
-      render = open(source).read
+      render = File.binread(source)
 
       destination ||= if block_given?
         block.arity == 1 ? block.call(render) : block.call
@@ -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.binread(source), nil, '-').result(context)
+        content = block.call(content) if block
+        content
       end
     end
 
@@ -189,7 +193,7 @@ class Thor
       say_status :gsub, relative_to_original_destination_root(path), config.fetch(:verbose, true)
 
       unless options[:pretend]
-        content = File.read(path)
+        content = File.binread(path)
         content.gsub!(flag, *args, &block)
         File.open(path, 'wb') { |file| file.write(content) }
       end

data/lib/thor/actions/inject_into_file.rb

@@ -90,7 +90,7 @@ class Thor
         #
         def replace!(regexp, string)
           unless base.options[:pretend]
-            content = File.read(destination)
+            content = File.binread(destination)
             content.gsub!(regexp, string)
             File.open(destination, 'wb') { |file| file.write(content) }
           end

data/lib/thor/actions.rb

@@ -1,4 +1,5 @@
 require 'fileutils'
+require 'thor/core_ext/file_binary_read'
 
 Dir[File.join(File.dirname(__FILE__), "actions", "*.rb")].each do |action|
   require action
@@ -38,17 +39,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/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/core_ext/file_binary_read.rb

@@ -0,0 +1,9 @@
+class File #:nodoc:
+
+  unless File.respond_to?(:binread)
+    def self.binread(file)
+      File.open(file, 'rb') { |f| f.read }
+    end
+  end
+
+end

data/lib/thor/group.rb

@@ -41,16 +41,12 @@ class Thor::Group
     # ==== Options
     # short:: When true, shows only usage.
     #
-    def help(shell, options={})
-      if options[:short]
-        shell.say banner
-      else
-        shell.say "Usage:"
-        shell.say "  #{banner}"
-        shell.say
-        class_options_help(shell)
-        shell.say self.desc if self.desc
-      end
+    def help(shell)
+      shell.say "Usage:"
+      shell.say "  #{banner}\n"
+      shell.say
+      class_options_help(shell)
+      shell.say self.desc if self.desc
     end
 
     # Stores invocations for this class merging with superclass values.
@@ -177,15 +173,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
@@ -218,13 +210,27 @@ class Thor::Group
       end
     end
 
+    # Returns tasks ready to be printed.
+    def printable_tasks(*)
+      item = []
+      item << banner
+      item << (desc ? "# #{desc.gsub(/\s+/m,' ')}" : "")
+      [item]
+    end
+
     protected
 
       # The banner for this class. You can customize it if you are invoking the
       # thor class by another ways which is not the Thor::Runner.
       #
       def banner
-        "#{self.namespace} #{self.arguments.map {|a| a.usage }.join(' ')}"
+        base = $thor_runner ? "thor" : File.basename($0.split(" ").first)
+        "#{base} #{self_task.formatted_usage(self, false)}"
+      end
+
+      # Represents the whole class as a task.
+      def self_task #:nodoc:
+        Thor::Task::Dynamic.new(self.namespace, class_options)
       end
 
       def baseclass #:nodoc:
@@ -241,23 +247,25 @@ class Thor::Group
 
   protected
 
-    # Shortcut to invoke with padding and block handling. Use internally by
-    # invoke and invoke_from_option class methods.
-    #
-    def _invoke_for_class_method(klass, task=nil, *args, &block) #:nodoc:
-      shell.padding += 1
-
-      result = if block_given?
-        if block.arity == 2
-          block.call(self, klass)
-        else
-          block.call(self, klass, task)
-        end
-      else
-        invoke klass, task, *args
+  # Shortcut to invoke with padding and block handling. Use internally by
+  # invoke and invoke_from_option class methods.
+  def _invoke_for_class_method(klass, task=nil, *args, &block) #:nodoc:
+    shell.padding += 1
+
+    result = if block_given?
+      case block.arity
+      when 3
+        block.call(self, klass, task)
+      when 2
+        block.call(self, klass)
+      when 1
+        instance_exec(klass, &block)
       end
-
-      shell.padding -= 1
-      result
+    else
+      invoke klass, task, *args
     end
+
+    shell.padding -= 1
+    result
+  end
 end

data/lib/thor/runner.rb

@@ -124,11 +124,7 @@ class Thor::Runner < Thor #:nodoc:
   method_options :internal => :boolean
   def installed
     initialize_thorfiles(nil, true)
-
-    klasses = Thor::Base.subclasses
-    klasses -= [Thor, Thor::Runner] unless options["internal"]
-
-    display_klasses(true, klasses)
+    display_klasses(true, options["internal"])
   end
 
   desc "list [SEARCH]", "List the available thor tasks (--substring means .*SEARCH)"
@@ -144,11 +140,15 @@ class Thor::Runner < Thor #:nodoc:
       (options[:all] || k.group == group) && k.namespace =~ search
     end
 
-    display_klasses(false, klasses)
+    display_klasses(false, false, klasses)
   end
 
   private
 
+    def self.banner(task)
+      "thor " + task.formatted_usage(self, false)
+    end
+
     def thor_root
       Thor::Util.thor_root
     end
@@ -156,7 +156,7 @@ class Thor::Runner < Thor #:nodoc:
     def thor_yaml
       @thor_yaml ||= begin
         yaml_file = File.join(thor_root, "thor.yml")
-        yaml      = YAML.load_file(yaml_file) if File.exists?(yaml_file)
+        yaml = YAML.load_file(yaml_file) if File.exists?(yaml_file)
         yaml || {}
       end
     end
@@ -215,9 +215,6 @@ class Thor::Runner < Thor #:nodoc:
     # 5. c:\ <-- no Thorfiles found!
     #
     def thorfiles(relevant_to=nil, skip_lookup=false)
-      # TODO Remove this dealing with deprecated thor when :namespaces: is available as constants
-      save_yaml(thor_yaml) if Thor::Util.convert_constants_to_namespaces(thor_yaml)
-
       thorfiles = []
 
       unless skip_lookup
@@ -253,47 +250,54 @@ class Thor::Runner < Thor #:nodoc:
     # Display information about the given klasses. If with_module is given,
     # it shows a table with information extracted from the yaml file.
     #
-    def display_klasses(with_modules=false, klasses=Thor.subclasses)
-      klasses -= [Thor, Thor::Runner] unless with_modules
+    def display_klasses(with_modules=false, show_internal=false, klasses=Thor::Base.subclasses)
+      klasses -= [Thor, Thor::Runner, Thor::Group] unless show_internal
+
       raise Error, "No Thor tasks available" if klasses.empty?
+      show_modules if with_modules && !thor_yaml.empty?
 
-      if with_modules && !thor_yaml.empty?
-        info  = []
-        labels = ["Modules", "Namespaces"]
+      # Remove subclasses
+      klasses.dup.each do |klass|
+        klasses -= Thor::Util.thor_classes_in(klass)
+      end
 
-        info << labels
-        info << [ "-" * labels[0].size, "-" * labels[1].size ]
+      list = Hash.new { |h,k| h[k] = [] }
+      groups = klasses.select { |k| k.ancestors.include?(Thor::Group) }
 
-        thor_yaml.each do |name, hash|
-          info << [ name, hash[:namespaces].join(", ") ]
-        end
+      # Get classes which inherit from Thor
+      (klasses - groups).each { |k| list[k.namespace] += k.printable_tasks(false) }
 
-        print_table info
-        say ""
-      end
+      # Get classes which inherit from Thor::Base
+      groups.map! { |k| k.printable_tasks(false).first }
+      list["root"] = groups
 
-      unless klasses.empty?
-        klasses.dup.each do |klass|
-          klasses -= Thor::Util.thor_classes_in(klass)
-        end
+      # Order namespaces with default coming first
+      list = list.sort{ |a,b| a[0].sub(/^default/, '') <=> b[0].sub(/^default/, '') }
+      list.each { |n, tasks| display_tasks(n, tasks) unless tasks.empty? }
+    end
 
-        klasses.each { |k| display_tasks(k) }
-      else
-        say "\033[1;34mNo Thor tasks available\033[0m"
-      end
+    def display_tasks(namespace, list) #:nodoc:
+      list.sort!{ |a,b| a[0] <=> b[0] }
+
+      say shell.set_color(namespace, :blue, true)
+      say "-" * namespace.size
+
+      print_table(list, :truncate => true)
+      say
     end
 
-    # Display tasks from the given Thor class.
-    #
-    def display_tasks(klass)
-      unless klass.tasks.empty?
-        base = klass.namespace
+    def show_modules #:nodoc:
+      info  = []
+      labels = ["Modules", "Namespaces"]
 
-        color = base == "default" ? :magenta : :blue
-        say shell.set_color(base, color, true)
-        say "-" * base.length
+      info << labels
+      info << [ "-" * labels[0].size, "-" * labels[1].size ]
 
-        klass.help(shell, :short => true, :ident => 0, :namespace => true)
+      thor_yaml.each do |name, hash|
+        info << [ name, hash[:namespaces].join(", ") ]
       end
+
+      print_table info
+      say ""
     end
 end

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

data/lib/thor/shell/color.rb

@@ -63,7 +63,7 @@ class Thor
         #
         def show_diff(destination, content) #:nodoc:
           if diff_lcs_loaded? && ENV['THOR_DIFF'].nil? && ENV['RAILS_DIFF'].nil?
-            actual  = File.read(destination).to_s.split("\n")
+            actual  = File.binread(destination).to_s.split("\n")
             content = content.to_s.split("\n")
 
             Diff::LCS.sdiff(actual, content).each do |diff|

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.
     #