Class: Pry::BlockCommand

Inherits:
Command show all
Defined in:
lib/pry/block_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

Constants included from Helpers::DocumentationHelpers

Helpers::DocumentationHelpers::YARD_TAGS

Constants included from Helpers::Text

Helpers::Text::COLORS

Instance Attribute Summary

Attributes inherited from Command

#arg_string, #captures, #command_block, #command_set, #context, #eval_string, #hooks, #output, #pry_instance, #target

Instance Method Summary collapse

Methods inherited from Command

#_pry_, banner, #block, #check_for_command_collision, command_name, #command_name, #command_options, command_regex, #commands, #complete, convert_to_regex, default_options, #description, doc, group, #initialize, inspect, #interpolate_string, #match, match_score, matches?, name, #name, options, #process_line, #run, source, #source, source_file, source_line, state, #state, subclass, #target_self, #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?, #c_module?, #command?, #module_with_yard_docs?, #real_method_object?

Methods included from Helpers::Text

#bold, #default, #indent, #no_color, #no_pager, #strip_color, #with_line_numbers

Methods included from Helpers::CommandHelpers

#absolute_index_number, #absolute_index_range, #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, #find_command, #heading, #highlight, #not_a_real_file?, #safe_send, #silence_warnings, #stagger_output, #use_ansi_codes?

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



14
15
16
# File 'lib/pry/block_command.rb', line 14

def call(*args)
  instance_exec(*normalize_method_args(block, args), &block)
end

#helpObject



18
19
20
# File 'lib/pry/block_command.rb', line 18

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