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

Instance Attribute Summary

Attributes inherited from Pry::ClassCommand

#args, #opts

Attributes inherited from Pry::Command

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

Instance Method Summary collapse

Methods inherited from Pry::ClassCommand

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

Methods inherited from Pry::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 Pry::CodeObject::Helpers

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

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 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

#code_objectObject


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

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

#contentObject


79
80
81
82
83
84
85
# File 'lib/pry/commands/play.rb', line 79

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

#content_after_optionsObject


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

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


67
68
69
# File 'lib/pry/commands/play.rb', line 67

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`


89
90
91
# File 'lib/pry/commands/play.rb', line 89

def default_file
  target.eval("__FILE__") && File.expand_path(target.eval("__FILE__"))
end

#file_contentObject


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

def file_content
  if default_file && File.exists?(default_file)
    @cc.restrict_to_lines(File.read(default_file), @cc.line_range)
  else
    raise CommandError, "File does not exist! File was: #{default_file.inspect}"
  end
end

#options(opt) ⇒ Object


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

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


45
46
47
48
# File 'lib/pry/commands/play.rb', line 45

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

#processObject


38
39
40
41
42
43
# File 'lib/pry/commands/play.rb', line 38

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

  perform_play
  show_input
end

#should_use_default_file?Boolean


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

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

#show_inputObject


50
51
52
53
54
# File 'lib/pry/commands/play.rb', line 50

def show_input
  if opts.present?(:print) or !Pry::Code.complete_expression?(eval_string)
    run "show-input"
  end
end