Class: Bundler::Thor::Command
- Inherits:
-
Struct
- Object
- Struct
- Bundler::Thor::Command
- Defined in:
- lib/bundler/vendor/thor/lib/thor/command.rb
Direct Known Subclasses
Constant Summary collapse
- FILE_REGEXP =
/^#{Regexp.escape(File.dirname(__FILE__))}/
Instance Attribute Summary collapse
-
#description ⇒ Object
Returns the value of attribute description.
-
#long_description ⇒ Object
Returns the value of attribute long_description.
-
#name ⇒ Object
Returns the value of attribute name.
-
#options ⇒ Object
Returns the value of attribute options.
-
#usage ⇒ Object
Returns the value of attribute usage.
Instance Method Summary collapse
-
#formatted_usage(klass, namespace = true, subcommand = false) ⇒ Object
Returns the formatted usage by injecting given required arguments and required options into the given usage.
- #hidden? ⇒ Boolean
-
#initialize(name, description, long_description, usage, options = nil) ⇒ Command
constructor
A new instance of Command.
-
#initialize_copy(other) ⇒ Object
:nodoc:.
-
#run(instance, args = []) ⇒ Object
By default, a command invokes a method in the thor class.
Constructor Details
#initialize(name, description, long_description, usage, options = nil) ⇒ Command
Returns a new instance of Command.
5 6 7 |
# File 'lib/bundler/vendor/thor/lib/thor/command.rb', line 5 def initialize(name, description, long_description, usage, = nil) super(name.to_s, description, long_description, usage, || {}) end |
Instance Attribute Details
#description ⇒ Object
Returns the value of attribute description
2 3 4 |
# File 'lib/bundler/vendor/thor/lib/thor/command.rb', line 2 def description @description end |
#long_description ⇒ Object
Returns the value of attribute long_description
2 3 4 |
# File 'lib/bundler/vendor/thor/lib/thor/command.rb', line 2 def long_description @long_description end |
#name ⇒ Object
Returns the value of attribute name
2 3 4 |
# File 'lib/bundler/vendor/thor/lib/thor/command.rb', line 2 def name @name end |
#options ⇒ Object
Returns the value of attribute options
2 3 4 |
# File 'lib/bundler/vendor/thor/lib/thor/command.rb', line 2 def @options end |
#usage ⇒ Object
Returns the value of attribute usage
2 3 4 |
# File 'lib/bundler/vendor/thor/lib/thor/command.rb', line 2 def usage @usage end |
Instance Method Details
#formatted_usage(klass, namespace = true, subcommand = false) ⇒ Object
Returns the formatted usage by injecting given required arguments and required options into the given usage.
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
# File 'lib/bundler/vendor/thor/lib/thor/command.rb', line 41 def formatted_usage(klass, namespace = true, subcommand = false) if namespace namespace = klass.namespace formatted = "#{namespace.gsub(/^(default)/, '')}:" end formatted = "#{klass.namespace.split(':').last} " if subcommand 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 << " #{}" # Strip and go! formatted.strip end |
#hidden? ⇒ Boolean
14 15 16 |
# File 'lib/bundler/vendor/thor/lib/thor/command.rb', line 14 def hidden? false end |
#initialize_copy(other) ⇒ Object
:nodoc:
9 10 11 12 |
# File 'lib/bundler/vendor/thor/lib/thor/command.rb', line 9 def initialize_copy(other) #:nodoc: super(other) self. = other..dup if other. end |
#run(instance, args = []) ⇒ Object
By default, a command invokes a method in the thor class. You can change this implementation to create custom commands.
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
# File 'lib/bundler/vendor/thor/lib/thor/command.rb', line 20 def run(instance, args = []) arity = nil if private_method?(instance) instance.class.handle_no_command_error(name) elsif public_method?(instance) arity = instance.method(name).arity instance.__send__(name, *args) elsif local_method?(instance, :method_missing) instance.__send__(:method_missing, name.to_sym, *args) else instance.class.handle_no_command_error(name) end rescue ArgumentError => e handle_argument_error?(instance, e, caller) ? instance.class.handle_argument_error(self, e, args, arity) : (raise e) rescue NoMethodError => e handle_no_method_error?(instance, e, caller) ? instance.class.handle_no_command_error(name) : (fail e) end |