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

Helpers::Text::COLORS

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, #hooks, #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, source_object, #subcommands

Methods inherited from Pry::Command

#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, #correct_arg_arity, default_options, #dependencies_met?, #description, doc, #find_hooks, group, hooks, #initialize, inspect, #interpolate_string, #match, match_score, matches?, #name, name, options, #pass_block, #process_line, #run, source, #source, source_file, source_line, source_location, #source_location, #state, subclass, #target_self, #text, #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_number, #absolute_index_range, absolute_index_range, #command_error, command_error, #get_method_or_raise, get_method_or_raise, #internal_binding?, internal_binding?, #one_index_number, one_index_number, #one_index_range, one_index_range, #one_index_range_or_number, one_index_range_or_number, #restrict_to_lines, restrict_to_lines, #set_file_and_dir_locals, set_file_and_dir_locals, #temp_file, temp_file, #unindent, unindent

Methods included from Helpers::OptionsHelpers

#method_object, method_object, #method_options, method_options

Methods included from Helpers::BaseHelpers

#colorize_code, #command_dependencies_met?, #find_command, #heading, #highlight, #not_a_real_file?, #safe_send, #silence_warnings, #stagger_output, #use_ansi_codes?

Methods included from Platform

#jruby?, #jruby_19?, #known_engines, #linux?, #mac_osx?, #mri?, #mri_19?, #mri_2?, #rbx?, #windows?, #windows_ansi?

Constructor Details

This class inherits a constructor from Pry::Command

Instance Method Details

#add_expression(arguments) ⇒ Object (private)



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

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

#add_hookObject (private)



94
95
96
97
98
99
100
101
# File 'lib/pry/commands/watch_expression.rb', line 94

def add_hook
  hook = [:after_eval, :watch_expression]
  unless _pry_.hooks.hook_exists?(*hook)
    _pry_.hooks.add_hook(*hook) do |_, _pry_|
      eval_and_print_changed _pry_.output
    end
  end
end

#delete(index) ⇒ Object (private)



55
56
57
58
59
60
61
62
63
# File 'lib/pry/commands/watch_expression.rb', line 55

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)



80
81
82
83
84
85
86
87
# File 'lib/pry/commands/watch_expression.rb', line 80

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

#expressionsObject (private)



51
52
53
# File 'lib/pry/commands/watch_expression.rb', line 51

def expressions
  _pry_.config.watch_expressions ||= []
end

#listObject (private)



65
66
67
68
69
70
71
72
73
74
75
76
77
78
# File 'lib/pry/commands/watch_expression.rb', line 65

def list
  if expressions.empty?
    output.puts "No watched expressions"
  else
    _pry_.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



29
30
31
32
33
34
35
# File 'lib/pry/commands/watch_expression.rb', line 29

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



37
38
39
40
41
42
43
44
45
46
47
# File 'lib/pry/commands/watch_expression.rb', line 37

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