Module: Bundler::Thor::Base::ClassMethods
- Defined in:
- lib/bundler/vendor/thor/lib/thor/base.rb
Instance Method Summary collapse
-
#all_commands ⇒ Object
(also: #all_tasks)
Returns the commands for this Bundler::Thor class and all subclasses.
-
#argument(name, options = {}) ⇒ Object
Adds an argument to the class and creates an attr_accessor for it.
-
#arguments ⇒ Object
Returns this class arguments, looking up in the ancestors chain.
-
#attr_accessor ⇒ Object
:nodoc:.
-
#attr_reader ⇒ Object
:nodoc:.
-
#attr_writer ⇒ Object
:nodoc:.
-
#check_unknown_options ⇒ Object
:nodoc:.
-
#check_unknown_options! ⇒ Object
If you want to raise an error for unknown options, call check_unknown_options! This is disabled by default to allow dynamic invocations.
-
#check_unknown_options?(config) ⇒ Boolean
:nodoc:.
-
#class_option(name, options = {}) ⇒ Object
Adds an option to the set of class options.
-
#class_options(options = nil) ⇒ Object
Adds a bunch of options to the set of class options.
-
#commands ⇒ Object
(also: #tasks)
Returns the commands for this Bundler::Thor class.
-
#group(name = nil) ⇒ Object
Defines the group.
-
#handle_argument_error(command, error, args, arity) ⇒ Object
:nodoc:.
-
#handle_no_command_error(command, has_namespace = $thor_runner) ⇒ Object
(also: #handle_no_task_error)
:nodoc:.
-
#namespace(name = nil) ⇒ Object
Sets the namespace for the Bundler::Thor or Bundler::Thor::Group class.
-
#no_commands ⇒ Object
(also: #no_tasks)
All methods defined inside the given block are not added as commands.
-
#public_command(*names) ⇒ Object
(also: #public_task)
Allows to use private methods from parent in child classes as commands.
-
#remove_argument(*names) ⇒ Object
Removes a previous defined argument.
-
#remove_class_option(*names) ⇒ Object
Removes a previous defined class option.
-
#remove_command(*names) ⇒ Object
(also: #remove_task)
Removes a given command from this Bundler::Thor class.
-
#start(given_args = ARGV, config = {}) ⇒ Object
Parses the command and options from the given args, instantiate the class and invoke the command.
-
#stop_on_unknown_option?(command_name) ⇒ Boolean
If true, option parsing is suspended as soon as an unknown option or a regular argument is encountered.
-
#strict_args_position ⇒ Object
:nodoc:.
-
#strict_args_position! ⇒ Object
If you want only strict string args (useful when cascading thor classes), call strict_args_position! This is disabled by default to allow dynamic invocations.
-
#strict_args_position?(config) ⇒ Boolean
:nodoc:.
Instance Method Details
#all_commands ⇒ Object Also known as: all_tasks
Returns the commands for this Bundler::Thor class and all subclasses.
Returns
- OrderedHash
-
An ordered hash with commands names as keys and Bundler::Thor::Command objects as values.
344 345 346 347 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 344 def all_commands @all_commands ||= from_superclass(:all_commands, Bundler::Thor::CoreExt::OrderedHash.new) @all_commands.merge(commands) end |
#argument(name, options = {}) ⇒ Object
Adds an argument to the class and creates an attr_accessor for it.
Arguments are different from options in several aspects. The first one is how they are parsed from the command line, arguments are retrieved from position:
thor command NAME
Instead of:
thor command --name=NAME
Besides, arguments are used inside your code as an accessor (self.argument), while options are all kept in a hash (self.options).
Finally, arguments cannot have type :default or :boolean but can be optional (supplying :optional => :true or :required => false), although you cannot have a required argument after a non-required argument. If you try it, an error is raised.
Parameters
- name<Symbol>
-
The name of the argument.
- options<Hash>
-
Described below.
Options
:desc - Description for the argument. :required - If the argument is required or not. :optional - If the argument is optional or not. :type - The type of the argument, can be :string, :hash, :array, :numeric. :default - Default value for this argument. It cannot be required and have default values. :banner - String to show on usage notes.
Errors
- ArgumentError
-
Raised if you supply a required argument after a non required one.
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 208 def argument(name, = {}) # rubocop:disable MethodLength is_thor_reserved_word?(name, :argument) no_commands { attr_accessor name } required = if .key?(:optional) ![:optional] elsif .key?(:required) [:required] else [:default].nil? end remove_argument name arguments.each do |argument| next if argument.required? fail ArgumentError, "You cannot have #{name.to_s.inspect} as required argument after " << "the non-required argument #{argument.human_name.inspect}." end if required [:required] = required arguments << Bundler::Thor::Argument.new(name, ) end |
#arguments ⇒ Object
238 239 240 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 238 def arguments @arguments ||= from_superclass(:arguments, []) end |
#attr_accessor ⇒ Object
:nodoc:
133 134 135 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 133 def attr_accessor(*) #:nodoc: no_commands { super } end |
#attr_reader ⇒ Object
:nodoc:
125 126 127 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 125 def attr_reader(*) #:nodoc: no_commands { super } end |
#attr_writer ⇒ Object
:nodoc:
129 130 131 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 129 def attr_writer(*) #:nodoc: no_commands { super } end |
#check_unknown_options ⇒ Object
:nodoc:
143 144 145 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 143 def #:nodoc: @check_unknown_options ||= from_superclass(:check_unknown_options, false) end |
#check_unknown_options! ⇒ Object
If you want to raise an error for unknown options, call check_unknown_options! This is disabled by default to allow dynamic invocations.
139 140 141 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 139 def @check_unknown_options = true end |
#check_unknown_options?(config) ⇒ Boolean
:nodoc:
147 148 149 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 147 def (config) #:nodoc: !! end |
#class_option(name, options = {}) ⇒ Object
Adds an option to the set of class options
Parameters
- name<Symbol>
-
The name of the argument.
- options<Hash>
-
Described below.
Options
- :desc
-
– Description for the argument.
- :required
-
– If the argument is required or not.
- :default
-
– Default value for this argument.
- :group
-
– The group for this options. Use by class options to output options in different levels.
- :aliases
-
– Aliases for this option. Note: Bundler::Thor follows a convention of one-dash-one-letter options. Thus aliases like “-something” wouldn’t be parsed; use either “--something” or “-s” instead.
- :type
-
– The type of the argument, can be :string, :hash, :array, :numeric or :boolean.
- :banner
-
– String to show on usage notes.
- :hide
-
– If you want to hide this option from the help.
273 274 275 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 273 def class_option(name, = {}) build_option(name, , ) end |
#class_options(options = nil) ⇒ Object
Adds a bunch of options to the set of class options.
:foo => false, :bar => :required, :baz => :string
If you prefer more detailed declaration, check class_option.
Parameters
Hash[Symbol => Object]
251 252 253 254 255 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 251 def ( = nil) @class_options ||= from_superclass(:class_options, {}) (, @class_options) if @class_options end |
#commands ⇒ Object Also known as: tasks
Returns the commands for this Bundler::Thor class.
Returns
- OrderedHash
-
An ordered hash with commands names as keys and Bundler::Thor::Command objects as values.
333 334 335 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 333 def commands @commands ||= Bundler::Thor::CoreExt::OrderedHash.new end |
#group(name = nil) ⇒ Object
Defines the group. This is used when thor list is invoked so you can specify that only commands from a pre-defined group will be shown. Defaults to standard.
Parameters
name<String|Symbol>
319 320 321 322 323 324 325 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 319 def group(name = nil) if name @group = name.to_s else @group ||= from_superclass(:group, "standard") end end |
#handle_argument_error(command, error, args, arity) ⇒ Object
:nodoc:
478 479 480 481 482 483 484 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 478 def handle_argument_error(command, error, args, arity) #:nodoc: msg = "ERROR: \"#{basename} #{command.name}\" was called with " msg << "no arguments" if args.empty? msg << "arguments " << args.inspect unless args.empty? msg << "\nUsage: #{(command).inspect}" fail InvocationError, msg end |
#handle_no_command_error(command, has_namespace = $thor_runner) ⇒ Object Also known as: handle_no_task_error
:nodoc:
469 470 471 472 473 474 475 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 469 def handle_no_command_error(command, has_namespace = $thor_runner) #:nodoc: if has_namespace fail UndefinedCommandError, "Could not find command #{command.inspect} in #{namespace.inspect} namespace." else fail UndefinedCommandError, "Could not find command #{command.inspect}." end end |
#namespace(name = nil) ⇒ Object
Sets the namespace for the Bundler::Thor or Bundler::Thor::Group class. By default the namespace is retrieved from the class name. If your Bundler::Thor class is named Scripts::MyScript, the help method, for example, will be called as:
thor scripts:my_script -h
If you change the namespace:
namespace :my_scripts
You change how your commands are invoked:
thor my_scripts -h
Finally, if you change your namespace to default:
namespace :default
Your commands can be invoked with a shortcut. Instead of:
thor :my_command
422 423 424 425 426 427 428 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 422 def namespace(name = nil) if name @namespace = name.to_s else @namespace ||= Bundler::Thor::Util.namespace_from_thor_class(self) end end |
#no_commands ⇒ Object Also known as: no_tasks
All methods defined inside the given block are not added as commands.
So you can do:
class MyScript < Bundler::Thor
no_commands do
def this_is_not_a_command
end
end
end
You can also add the method and remove it from the command list:
class MyScript < Bundler::Thor
def this_is_not_a_command
end
remove_command :this_is_not_a_command
end
392 393 394 395 396 397 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 392 def no_commands @no_commands = true yield ensure @no_commands = false end |
#public_command(*names) ⇒ Object Also known as: public_task
Allows to use private methods from parent in child classes as commands.
Parameters
names<Array>:: Method names to be used as commands
Examples
public_command :foo
public_command :foo, :bar, :baz
462 463 464 465 466 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 462 def public_command(*names) names.each do |name| class_eval "def #{name}(*); super end" end end |
#remove_argument(*names) ⇒ Object
Removes a previous defined argument. If :undefine is given, undefine accessors as well.
Parameters
- names<Array>
-
Arguments to be removed
Examples
remove_argument :foo
remove_argument :foo, :bar, :baz, :undefine => true
288 289 290 291 292 293 294 295 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 288 def remove_argument(*names) = names.last.is_a?(Hash) ? names.pop : {} names.each do |name| arguments.delete_if { |a| a.name == name.to_s } undef_method name, "#{name}=" if [:undefine] end end |
#remove_class_option(*names) ⇒ Object
Removes a previous defined class option.
Parameters
- names<Array>
-
Class options to be removed
Examples
remove_class_option :foo
remove_class_option :foo, :bar, :baz
307 308 309 310 311 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 307 def remove_class_option(*names) names.each do |name| .delete(name) end end |
#remove_command(*names) ⇒ Object Also known as: remove_task
Removes a given command from this Bundler::Thor class. This is usually done if you are inheriting from another class and don’t want it to be available anymore.
By default it only remove the mapping to the command. But you can supply :undefine => true to undefine the method from the class as well.
Parameters
- name<Symbol|String>
-
The name of the command to be removed
- options<Hash>
-
You can give :undefine => true if you want commands the method to be undefined from the class as well.
362 363 364 365 366 367 368 369 370 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 362 def remove_command(*names) = names.last.is_a?(Hash) ? names.pop : {} names.each do |name| commands.delete(name.to_s) all_commands.delete(name.to_s) undef_method name if [:undefine] end end |
#start(given_args = ARGV, config = {}) ⇒ Object
Parses the command and options from the given args, instantiate the class and invoke the command. This method is used when the arguments must be parsed from an array. If you are inside Ruby and want to use a Bundler::Thor class, you can simply initialize it:
script = MyScript.new(args, , config)
script.invoke(:command, first_arg, second_arg, third_arg)
438 439 440 441 442 443 444 445 446 447 448 449 450 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 438 def start(given_args = ARGV, config = {}) config[:shell] ||= Bundler::Thor::Base.shell.new dispatch(nil, given_args.dup, nil, config) rescue Bundler::Thor::Error => e config[:debug] || ENV["THOR_DEBUG"] == "1" ? (raise e) : config[:shell].error(e.) exit(1) if exit_on_failure? rescue Errno::EPIPE # This happens if a thor command is piped to something like `head`, # which closes the pipe when it's done reading. This will also # mean that if the pipe is closed, further unnecessary # computation will not occur. exit(0) end |
#stop_on_unknown_option?(command_name) ⇒ Boolean
If true, option parsing is suspended as soon as an unknown option or a regular argument is encountered. All remaining arguments are passed to the command as regular arguments.
154 155 156 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 154 def stop_on_unknown_option?(command_name) #:nodoc: false end |
#strict_args_position ⇒ Object
:nodoc:
165 166 167 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 165 def strict_args_position #:nodoc: @strict_args_position ||= from_superclass(:strict_args_position, false) end |
#strict_args_position! ⇒ Object
If you want only strict string args (useful when cascading thor classes), call strict_args_position! This is disabled by default to allow dynamic invocations.
161 162 163 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 161 def strict_args_position! @strict_args_position = true end |
#strict_args_position?(config) ⇒ Boolean
:nodoc:
169 170 171 |
# File 'lib/bundler/vendor/thor/lib/thor/base.rb', line 169 def strict_args_position?(config) #:nodoc: !!strict_args_position end |