class Thor::Task
def formatted_usage(klass, namespace = true, subcommand = false)
Returns the formatted usage by injecting given required arguments
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| match << " " << klass.arguments.map{ |a| a.usage }.compact.join(' ') end else usage.to_s end # Add required options formatted << " #{required_options}" # Strip and go! formatted.strip end
def handle_argument_error?(instance, error, caller)
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)
def handle_no_method_error?(instance, error, caller) not_debugging?(instance) && error.message =~ /^undefined method `#{name}' for #{Regexp.escape(instance.to_s)}$/ end
def hidden?
def hidden? false end
def initialize(name, description, long_description, usage, options=nil)
def initialize(name, description, long_description, usage, options=nil) super(name.to_s, description, long_description, usage, options || {}) end
def initialize_copy(other) #:nodoc:
def initialize_copy(other) #:nodoc: super(other) self.options = other.options.dup if other.options end
def not_debugging?(instance)
def not_debugging?(instance) !(instance.class.respond_to?(:debugging) && instance.class.debugging) end
def public_method?(instance) #:nodoc:
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 required_options
def required_options @required_options ||= options.map{ |_, o| o.usage if o.required? }.compact.sort.join(" ") end
def run(instance, args=[])
By default, a task invokes a method in the thor class. You can change this
def run(instance, args=[]) public_method?(instance) ? instance.send(name, *args) : instance.class.handle_no_task_error(name) rescue ArgumentError => e handle_argument_error?(instance, e, caller) ? instance.class.handle_argument_error(self, e) : (raise e) rescue NoMethodError => e handle_no_method_error?(instance, e, caller) ? instance.class.handle_no_task_error(name) : (raise e) end
def sans_backtrace(backtrace, caller) #:nodoc:
def sans_backtrace(backtrace, caller) #:nodoc: saned = backtrace.reject { |frame| frame =~ FILE_REGEXP } saned -= caller end