thor 0.12.0 → 0.12.2

data/lib/thor/task.rb

@@ -25,10 +25,6 @@ class Thor
       self.options = other.options.dup if other.options
     end
 
-    def short_description
-      description.split("\n").first if description
-    end
-
     # By default, a task invokes a method in the thor class. You can change this
     # implementation to create custom tasks.
     #
@@ -36,49 +32,51 @@ class Thor
       raise UndefinedTaskError, "the '#{name}' task of #{instance.class} is private" unless public_method?(instance)
       instance.send(name, *args)
     rescue ArgumentError => e
+      raise e if instance.class.respond_to?(:debugging) && instance.class.debugging
       parse_argument_error(instance, e, caller)
     rescue NoMethodError => e
+      raise e if instance.class.respond_to?(:debugging) && instance.class.debugging
       parse_no_method_error(instance, e)
     end
 
-    # Returns the formatted usage. If a class is given, the class arguments are
-    # injected in the usage.
-    #
-    def formatted_usage(klass=nil, namespace=false, show_options=true)
-      formatted = if namespace.is_a?(String)
-        "#{namespace}:"
-      elsif klass && namespace
-        "#{klass.namespace.gsub(/^default/,'')}:"
+    # Returns the formatted usage by injecting given required arguments 
+    # and required options into the given usage.
+    def formatted_usage(klass, namespace=nil)
+      namespace = klass.namespace if namespace.nil?
+
+      # Add namespace
+      formatted = if namespace
+        "#{namespace.gsub(/^(default|thor:runner:)/,'')}:"
       else
         ""
       end
 
-      formatted << formatted_arguments(klass)
-      formatted << " #{formatted_options}" if show_options
-      formatted.strip!
-      formatted
-    end
-
-    # Injects the class arguments into the task usage.
-    #
-    def formatted_arguments(klass)
-      if klass && !klass.arguments.empty?
+      # Add usage with required arguments
+      formatted << if klass && !klass.arguments.empty?
         usage.to_s.gsub(/^#{name}/) do |match|
-          match << " " << klass.arguments.map{ |a| a.usage }.join(' ')
+          match << " " << required_arguments(klass)
         end
       else
         usage.to_s
       end
-    end
 
-    # Returns the options usage for this task.
-    #
-    def formatted_options
-      @formatted_options ||= options.map{ |_, o| o.usage }.sort.join(" ")
+      # Add required options
+      formatted << " #{required_options}"
+
+      # Strip and go!
+      formatted.strip
     end
 
     protected
 
+      def required_arguments(klass)
+        klass.arguments.map{ |a| a.usage if a.required? }.compact.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:
@@ -86,23 +84,15 @@ class Thor
         (collection & [name.to_s, name.to_sym]).empty?
       end
 
-      # Clean everything that comes from the Thor gempath and remove the caller.
-      #
-      def sans_backtrace(backtrace, caller) #:nodoc:
-        dirname = /^#{Regexp.escape(File.dirname(__FILE__))}/
-        saned  = backtrace.reject { |frame| frame =~ dirname }
-        saned -= caller
-      end
-
       def parse_argument_error(instance, e, caller) #:nodoc:
-        backtrace = sans_backtrace(e.backtrace, caller)
+        method_name = /`#{Regexp.escape(name.split(':').last)}'/
 
-        if backtrace.empty? && e.message =~ /wrong number of arguments/
+        if e.message =~ /wrong number of arguments/ && e.backtrace.first.to_s =~ method_name
           if instance.is_a?(Thor::Group)
             raise e, "'#{name}' was called incorrectly. Are you sure it has arity equals to 0?"
           else
             raise InvocationError, "'#{name}' was called incorrectly. Call as " <<
-                                   "'#{formatted_usage(instance.class, true)}'"
+                                   "'#{formatted_usage(instance.class)}'"
           end
         else
           raise e

data/lib/thor/version.rb

@@ -1,3 +1,3 @@
 class Thor
-  VERSION = "0.12.0".freeze
+  VERSION = "0.12.2".freeze
 end

data/spec/actions/directory_spec.rb

@@ -110,10 +110,11 @@ describe Thor::Actions::Directory do
     end
 
     it "yields a block" do
-      invoke!("doc") do |f|
-        %(doc/README doc/config.rb doc/rdoc.rb).must include(f)
-        %(doc/components/).must_not include(f)
+      checked = false
+      invoke!("doc") do |content|
+        checked ||= !!(content =~ /FOO/)
       end
+      checked.must be_true
     end
   end
 

data/spec/actions/file_manipulation_spec.rb

@@ -65,13 +65,19 @@ describe Thor::Actions do
       runner.inside("doc") do
         action :copy_file, "README"
       end
-
       exists_and_identical?("doc/README", "doc/README")
     end
 
     it "logs status" do
       action(:copy_file, "task.thor").must == "      create  task.thor\n"
     end
+
+    it "accepts a block to change output" do
+      action :copy_file, "task.thor" do |content|
+        "OMG" + content
+      end
+      File.read(File.join(destination_root, "task.thor")).must =~ /^OMG/
+    end
   end
 
   describe "#get" do
@@ -126,6 +132,13 @@ describe Thor::Actions do
     it "logs status" do
       capture(:stdout){ runner.template("doc/config.rb") }.must == "      create  doc/config.rb\n"
     end
+
+    it "accepts a block to change output" do
+      action :template, "doc/config.rb" do |content|
+        "OMG" + content
+      end
+      File.read(File.join(destination_root, "doc/config.rb")).must =~ /^OMG/
+    end
   end
 
   describe "when changing existent files" do

data/spec/base_spec.rb

@@ -134,7 +134,7 @@ describe Thor::Base do
     it "allows extra options to be given" do
       hash = { "Foo" => B.class_options.values }
 
-      content = capture(:stdout) { MyCounter.send(:class_options_help, Thor::Base.shell.new, nil, hash) }
+      content = capture(:stdout) { MyCounter.send(:class_options_help, Thor::Base.shell.new, hash) }
       content.must =~ /Foo options\:/
       content.must =~ /--last-name=LAST_NAME/
     end

data/spec/fixtures/bundle/main.thor

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'execute')

data/spec/fixtures/doc/%file_name%.rb.tt

@@ -0,0 +1 @@
+FOO = <%= "FOO" %>

data/spec/fixtures/doc/README

@@ -0,0 +1,3 @@
+__start__
+README
+__end__

data/spec/fixtures/group.thor

@@ -0,0 +1,83 @@
+class MyCounter < Thor::Group
+  include Thor::Actions
+  add_runtime_options!
+
+  def self.get_from_super
+    from_superclass(:get_from_super, 13)
+  end
+
+  def self.source_root
+    File.expand_path(File.dirname(__FILE__))
+  end
+  source_paths << File.expand_path("broken", File.dirname(__FILE__))
+
+  argument :first,     :type => :numeric
+  argument :second,    :type => :numeric, :default => 2
+
+  class_option :third,  :type => :numeric, :desc => "The third argument", :default => 3,
+                        :banner => "THREE", :aliases => "-t"
+  class_option :fourth, :type => :numeric, :desc => "The fourth argument"
+
+  desc <<-FOO
+Description:
+  This generator run three tasks: one, two and three.
+FOO
+
+  def one
+    first
+  end
+
+  def two
+    second
+  end
+
+  def three
+    options[:third]
+  end
+
+  def self.inherited(base)
+    super
+    base.source_paths.unshift(File.expand_path(File.join(File.dirname(__FILE__), "doc")))
+  end
+end
+
+class ClearCounter < MyCounter
+  remove_argument :first, :second, :undefine => true
+  remove_class_option :third
+
+  def self.source_root
+    File.expand_path(File.join(File.dirname(__FILE__), "bundle"))
+  end
+end
+
+class BrokenCounter < MyCounter
+  namespace "app:broken:counter"
+  class_option :fail, :type => :boolean, :default => false
+
+  class << self
+    undef_method :source_root
+  end
+
+  def one
+    options[:first]
+  end
+
+  def four
+    respond_to?(:fail)
+  end
+
+  def five
+    options[:fail] ? this_method_does_not_exist : 5
+  end
+end
+
+class WhinyGenerator < Thor::Group
+  include Thor::Actions
+
+  def self.source_root
+    File.expand_path(File.dirname(__FILE__))
+  end
+
+  def wrong_arity(required)
+  end
+end

data/spec/fixtures/invoke.thor

@@ -0,0 +1,112 @@
+class A < Thor
+  include Thor::Actions
+
+  desc "one", "invoke one"
+  def one
+    p 1
+    invoke :two
+    invoke :three
+  end
+
+  desc "two", "invoke two"
+  def two
+    p 2
+    invoke :three
+  end
+
+  desc "three", "invoke three"
+  def three
+    p 3
+  end
+
+  desc "four", "invoke four"
+  def four
+    p 4
+    invoke "defined:five"
+  end
+
+  desc "five N", "check if number is equal 5"
+  def five(number)
+    number == 5
+  end
+
+  desc "invoker", "invoke a b task"
+  def invoker(*args)
+    invoke :b, :one, ["Jose"]
+  end
+end
+
+class B < Thor
+  class_option :last_name, :type => :string
+
+  desc "one FIRST_NAME", "invoke one"
+  def one(first_name)
+    "#{options.last_name}, #{first_name}"
+  end
+
+  desc "two", "invoke two"
+  def two
+    options
+  end
+
+  desc "three", "invoke three"
+  def three
+    self
+  end
+end
+
+class C < Thor::Group
+  include Thor::Actions
+
+  def one
+    p 1
+  end
+
+  def two
+    p 2
+  end
+
+  def three
+    p 3
+  end
+end
+
+class Defined < Thor::Group
+  class_option :unused, :type => :boolean, :desc => "This option has no use"
+
+  def one
+    p 1
+    invoke "a:two"
+    invoke "a:three"
+    invoke "a:four"
+    invoke "defined:five"
+  end
+
+  def five
+    p 5
+  end
+
+  def print_status
+    say_status :finished, :counting
+  end
+end
+
+class E < Thor::Group
+  invoke Defined
+end
+
+class F < Thor::Group
+  invoke "b:one" do |instance, klass, task|
+    instance.invoke klass, task, [ "Jose" ], :last_name => "Valim"
+  end
+end
+
+class G < Thor::Group
+  class_option :invoked, :type => :string, :default => "defined"
+  invoke_from_option :invoked
+end
+
+class H < Thor::Group
+  class_option :defined, :type => :boolean, :default => true
+  invoke_from_option :defined
+end

data/spec/fixtures/script.thor

@@ -0,0 +1,130 @@
+class MyScript < Thor
+  group :script
+  default_task :example_default_task
+
+  map "-T" => :animal, ["-f", "--foo"] => :foo
+
+  desc "zoo", "zoo around"
+  def zoo
+    true
+  end
+
+  desc "animal TYPE", "horse around"
+
+  no_tasks do
+    def this_is_not_a_task
+    end
+  end
+
+  def animal(type)
+    [type]
+  end
+
+  desc "foo BAR", <<END
+do some fooing
+  This is more info!
+  Everyone likes more info!
+END
+  method_option :force, :type => :boolean, :desc => "Force to do some fooing"
+  def foo(bar)
+    [bar, options]
+  end
+
+  desc "example_default_task", "example!"
+  def example_default_task
+    options.empty? ? "default task" : options
+  end
+
+  desc "call_myself_with_wrong_arity", "get the right error"
+  def call_myself_with_wrong_arity
+    call_myself_with_wrong_arity(4)
+  end
+
+  desc "call_unexistent_method", "Call unexistent method inside a task"
+  def call_unexistent_method
+    boom!
+  end
+
+  desc "long_description", "a" * 80
+  def long_description
+  end
+
+  method_options :all => :boolean
+  desc "with_optional NAME", "invoke with optional name"
+  def with_optional(name=nil)
+    [ name, options ]
+  end
+
+  class AnotherScript < Thor
+    desc "baz", "do some bazing"
+    def baz
+    end
+  end
+
+  private
+
+    def method_missing(meth, *args)
+      if meth == :boom!
+        super
+      else
+        [meth, args]
+      end
+    end
+
+    desc "what", "what"
+    def what
+    end
+end
+
+class MyChildScript < MyScript
+  remove_task :bar
+
+  method_options :force => :boolean, :param => :numeric
+  def initialize(*args)
+    super
+  end
+
+  desc "zoo", "zoo around"
+  method_options :param => :required
+  def zoo
+    options
+  end
+
+  desc "animal TYPE", "horse around"
+  def animal(type)
+    [type, options]
+  end
+  method_option :other, :type => :string, :default => "method default", :for => :animal
+  desc "animal KIND", "fish around", :for => :animal
+
+  desc "boom", "explodes everything"
+  def boom
+  end
+
+  remove_task :boom, :undefine => true
+end
+
+module Scripts
+  class MyScript < MyChildScript
+    argument :accessor, :type => :string
+    class_options :force => :boolean
+    method_option :new_option, :type => :string, :for => :example_default_task
+
+    def zoo
+      self.accessor
+    end
+  end
+
+  class MyDefaults < Thor
+    namespace :default
+    desc "test", "prints 'test'"
+    def test
+      puts "test"
+    end
+  end
+
+  class ChildDefault < Thor
+    namespace "default:child"
+  end
+end
+