Class: Pry::Command::WatchExpression

Inherits:
Pry::ClassCommand show all
Defined in:
lib/pry/commands/watch_expression.rb,
lib/pry/commands/watch_expression/expression.rb

Defined Under Namespace

Classes: Expression

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

#add_expression(_arguments) ⇒ Object (private)


93
94
95
96
# File 'lib/pry/commands/watch_expression.rb', line 93

def add_expression(_arguments)
  expressions << Expression.new(pry_instance, target, arg_string)
  output.puts "Watching #{Code.new(arg_string).highlighted}"
end

#add_hookObject (private)


98
99
100
101
102
103
104
105
# File 'lib/pry/commands/watch_expression.rb', line 98

def add_hook
  hook = [:after_eval, :watch_expression]
  return if pry_instance.hooks.hook_exists?(*hook)

  pry_instance.hooks.add_hook(*hook) do |_, pry_instance|
    eval_and_print_changed pry_instance.output
  end
end

#delete(index) ⇒ Object (private)


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

def delete(index)
  if index
    output.puts "Deleting watch expression ##{index}: #{expressions[index - 1]}"
    expressions.delete_at(index - 1)
  else
    output.puts "Deleting all watched expressions"
    expressions.clear
  end
end

#eval_and_print_changed(output) ⇒ Object (private)


84
85
86
87
88
89
# File 'lib/pry/commands/watch_expression.rb', line 84

def eval_and_print_changed(output)
  expressions.each do |expr|
    expr.eval!
    output.puts "#{blue 'watch'}: #{expr}" if expr.changed?
  end
end

#expressionsObject (private)


55
56
57
# File 'lib/pry/commands/watch_expression.rb', line 55

def expressions
  state.watch_expressions ||= []
end

#listObject (private)


69
70
71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/pry/commands/watch_expression.rb', line 69

def list
  if expressions.empty?
    output.puts "No watched expressions"
  else
    pry_instance.pager.open do |pager|
      pager.puts "Listing all watched expressions:"
      pager.puts ""
      expressions.each_with_index do |expr, index|
        pager.print with_line_numbers(expr.to_s, index + 1)
      end
      pager.puts ""
    end
  end
end

#options(opt) ⇒ Object


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

def options(opt)
  opt.on :d, :delete,
         "Delete the watch expression with the given index. If no index " \
         "is given; clear all watch expressions.",
         optional_argument: true, as: Integer
  opt.on :l, :list,
         "Show all current watch expressions and their values. Calling " \
         "watch with no expressions or options will also show the watch " \
         "expressions."
end

#processObject


42
43
44
45
46
47
48
49
50
51
# File 'lib/pry/commands/watch_expression.rb', line 42

def process
  if opts.present?(:delete)
    delete opts[:delete]
  elsif opts.present?(:list) || args.empty?
    list
  else
    add_hook
    add_expression(args)
  end
end