Class: Pry::Command::Cat

Inherits:
Pry::ClassCommand show all
Defined in:
lib/pry/commands/cat.rb,
lib/pry/commands/cat/file_formatter.rb,
lib/pry/commands/cat/abstract_formatter.rb,
lib/pry/commands/cat/exception_formatter.rb,
lib/pry/commands/cat/input_expression_formatter.rb

Defined Under Namespace

Classes: AbstractFormatter, ExceptionFormatter, FileFormatter, InputExpressionFormatter

Constant Summary

Constants inherited from Pry::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 Pry::ClassCommand

#args, #opts

Attributes inherited from Pry::Command

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

Instance Method Summary collapse

Methods inherited from Pry::ClassCommand

#call, doc, #help, inherited, #setup, #slop, source, source_file, source_line, source_location, source_object, #subcommands

Methods inherited from Pry::Command

#_pry_, #after_hooks, banner, #before_hooks, #block, #call_safely, #call_with_hooks, #check_for_command_collision, #command_name, command_name, #command_options, command_regex, #commands, convert_to_regex, default_options, #description, doc, #find_hooks, group, #initialize, inspect, #interpolate_string, #match, match_score, matches?, #name, name, #normalize_method_args, options, #pass_block, #process_line, #run, source, #source, source_file, source_line, #state, state, subclass, #target_self, #tokenize, #use_unpatched_symbol, #void

Methods included from Pry::CodeObject::Helpers

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

Methods included from Helpers::DocumentationHelpers

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

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_object, method_options, #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

#complete(search) ⇒ Object


53
54
55
# File 'lib/pry/commands/cat.rb', line 53

def complete(search)
  super | load_path_completions
end

#load_path_completionsObject


57
58
59
60
61
62
63
64
65
# File 'lib/pry/commands/cat.rb', line 57

def load_path_completions
  $LOAD_PATH.flat_map do |path|
    Dir[path + '/**/*'].map do |f|
      next if File.directory?(f)

      f.sub!(path + '/', '')
    end
  end
end

#options(opt) ⇒ Object


23
24
25
26
27
28
29
30
31
32
33
34
35
36
# File 'lib/pry/commands/cat.rb', line 23

def options(opt)
  opt.on :ex, "Show the context of the last exception",
         optional_argument: true, as: Integer
  opt.on :i, :in, "Show one or more entries from Pry's expression history",
         optional_argument: true, as: Range, default: -5..-1
  opt.on :s, :start, "Starting line (defaults to the first line)",
         optional_argument: true, as: Integer
  opt.on :e, :end, "Ending line (defaults to the last line)",
         optional_argument: true, as: Integer
  opt.on :l, :'line-numbers', "Show line numbers"
  opt.on :t, :type, "The file type for syntax highlighting " \
                    "(e.g., 'ruby' or 'python')",
         argument: true, as: Symbol
end

#processObject


38
39
40
41
42
43
44
45
46
47
48
49
50
51
# File 'lib/pry/commands/cat.rb', line 38

def process
  output =
    if opts.present?(:ex)
      ExceptionFormatter.new(
        pry_instance.last_exception, pry_instance, opts
      ).format
    elsif opts.present?(:in)
      InputExpressionFormatter.new(pry_instance.input_ring, opts).format
    else
      FileFormatter.new(args.first, pry_instance, opts).format
    end

  pry_instance.pager.page output
end