Class: Pry::Command::Play

Inherits:
Pry::ClassCommand show all
Defined in:
lib/pry/commands/play.rb

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, #complete, 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, #complete, 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

#code_objectObject


74
75
76
# File 'lib/pry/commands/play.rb', line 74

def code_object
  Pry::Code.new(content)
end

#contentObject


82
83
84
85
86
87
88
# File 'lib/pry/commands/play.rb', line 82

def content
  if should_use_default_file?
    file_content
  else
    @cc.content
  end
end

#content_after_optionsObject


60
61
62
63
64
65
66
67
68
# File 'lib/pry/commands/play.rb', line 60

def content_after_options
  if opts.present?(:open)
    restrict_to_lines(content, (0..-2))
  elsif opts.present?(:expression)
    content_at_expression
  else
    content
  end
end

#content_at_expressionObject


70
71
72
# File 'lib/pry/commands/play.rb', line 70

def content_at_expression
  code_object.expression_at(opts[:expression])
end

#default_fileObject

The file to play from when no code object is specified. e.g play --lines 4..10


92
93
94
95
96
97
98
99
100
# File 'lib/pry/commands/play.rb', line 92

def default_file
  file =
    if target.respond_to?(:source_location)
      target.source_location.first
    else
      target.eval("__FILE__")
    end
  file && File.expand_path(file)
end

#file_contentObject


102
103
104
105
106
107
108
# File 'lib/pry/commands/play.rb', line 102

def file_content
  if !default_file || !File.exist?(default_file)
    raise CommandError, "File does not exist! File was: #{default_file.inspect}"
  end

  @cc.restrict_to_lines(File.read(default_file), @cc.line_range)
end

#options(opt) ⇒ Object


29
30
31
32
33
34
35
36
37
38
39
# File 'lib/pry/commands/play.rb', line 29

def options(opt)
  CodeCollector.inject_options(opt)

  opt.on :open, 'Plays the selected content except the last line. Useful' \
                ' for replaying methods and leaving the method definition' \
                ' "open". `amend-line` can then be used to' \
                ' modify the method.'

  opt.on :e, :expression=, 'Executes until end of valid expression', as: Integer
  opt.on :p, :print, 'Prints executed code'
end

#perform_playObject


48
49
50
51
# File 'lib/pry/commands/play.rb', line 48

def perform_play
  eval_string << content_after_options
  run "fix-indent"
end

#processObject


41
42
43
44
45
46
# File 'lib/pry/commands/play.rb', line 41

def process
  @cc = CodeCollector.new(args, opts, pry_instance)

  perform_play
  show_input
end

#should_use_default_file?Boolean

Returns:

  • (Boolean)

78
79
80
# File 'lib/pry/commands/play.rb', line 78

def should_use_default_file?
  !args.first && !opts.present?(:in) && !opts.present?(:out)
end

#show_inputObject


53
54
55
56
57
58
# File 'lib/pry/commands/play.rb', line 53

def show_input
  return unless opts.present?(:print)
  return unless Pry::Code.complete_expression?(eval_string)

  run 'show-input'
end