Class: Pry::BlockCommand

Inherits:
Command show all
Defined in:
lib/pry/command.rb

Overview

A super-class for Commands that are created with a single block.

This class ensures that the block is called with the correct number of arguments and the right context.

Create subclasses using CommandSet#command.

Constant Summary

Constants inherited from Command

Command::VOID_VALUE

Instance Attribute Summary

Attributes inherited from Command

#_pry_, #arg_string, #captures, #command_block, #command_set, #context, #eval_string, #output, #target

Instance Method Summary collapse

Methods inherited from Command

banner, #block, #call_safely, #check_for_command_collision, command_name, #command_name, #command_options, command_regex, #commands, #complete, convert_to_regex, default_options, #dependencies_met?, #description, doc, group, hooks, #initialize, inspect, #interpolate_string, #match, match_score, matches?, name, #name, options, #process_line, #run, #source, source, source_file, source_line, #source_location, source_location, #state, subclass, #target_self, #text, #tokenize, #void

Methods included from Helpers::DocumentationHelpers

get_comment_content, process_comment_markup, process_rdoc, process_yardoc, process_yardoc_tag, strip_comments_from_c_code, strip_leading_whitespace

Methods included from CodeObject::Helpers

#c_method?, #command?, #module_with_yard_docs?, #real_method_object?

Methods included from Helpers::CommandHelpers

absolute_index_number, absolute_index_range, command_error, get_method_or_raise, internal_binding?, one_index_number, one_index_range, one_index_range_or_number, restrict_to_lines, set_file_and_dir_locals, temp_file, unindent

Methods included from Helpers::OptionsHelpers

method_object, method_options

Methods included from Helpers::BaseHelpers

colorize_code, command_dependencies_met?, find_command, heading, highlight, jruby?, jruby_19?, mri?, mri_19?, mri_20?, mri_21?, mri_2?, not_a_real_file?, rbx?, #safe_send, safe_send, silence_warnings, stagger_output, use_ansi_codes?, windows?, windows_ansi?

Constructor Details

This class inherits a constructor from Pry::Command

Instance Method Details

#call(*args) ⇒ Object

Call the block that was registered with this command.

Parameters:

  • args (Array<String>) —

    The arguments passed

Returns:

  • (Object) —

    The return value of the block



494
495
496
 
# File 'lib/pry/command.rb', line 494

def call(*args)
  instance_exec(*correct_arg_arity(block.arity, args), &block)
end

#help ⇒ Object 



498
499
500
 
# File 'lib/pry/command.rb', line 498

def help
  "#{command_options[:listing].to_s.ljust(18)} #{description}"
end