Class: Pry::Command::Hist

Inherits:
Pry::ClassCommand show all
Defined in:
lib/pry/commands/hist.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 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 Pry::CodeObject::Helpers

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

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

#check_for_juxtaposed_replay(replay_sequence) ⇒ Boolean (private)

Checks +replay_sequence+ for the presence of neighboring replay calls.

Examples:

[1] pry(main)> hist --show 46894
46894: hist --replay 46675..46677
[2] pry(main)> hist --show 46675..46677
46675: 1+1
46676: a = 100
46677: hist --tail
[3] pry(main)> hist --replay 46894
Error: Replay index 46894 points out to another replay call:
`hist -r 46675..46677`
[4] pry(main)>

Parameters:

  • replay_sequence (String) —

    The sequence of commands to be replayed (per saltum)

Returns:

  • (Boolean) —

    false if +replay_sequence+ does not contain another "hist --replay" call

Raises:


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/pry/commands/hist.rb', line 143

def check_for_juxtaposed_replay(replay_sequence)
  if replay_sequence =~ /\Ahist(?:ory)?\b/
    # Create *fresh* instance of Options for parsing of "hist" command.
    slop_instance = slop
    slop_instance.parse(replay_sequence.split(' ')[1..-1])

    if slop_instance.present?(:r)
      replay_sequence = replay_sequence.split("\n").join('; ')
      index = opts[:r]
      index = index.min if index.min == index.max || index.max.nil?

      raise CommandError,
            "Replay index #{index} points out to another replay call: " \
            "`#{replay_sequence}`"
    end
  else
    false
  end
end

#find_history ⇒ Pry::Code (private)

Finds history depending on the given switch.

Returns:

  • (Pry::Code) —

    if it finds --all (or -a) switch, returns all entries in history. Without the switch returns only the entries from the current Pry session.


168
169
170
171
172
173
174
175
176
 
# File 'lib/pry/commands/hist.rb', line 168

def find_history
  h = if opts.present?(:all)
        Pry.history.to_a
      else
        Pry.history.to_a.last(Pry.history.session_line_count)
      end

  Pry::Code(Pry.history.filter(h[0..-2]))
end

#options(opt) ⇒ Object 


25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/pry/commands/hist.rb', line 25

def options(opt)
  opt.on :a, :all, "Display all history"
  opt.on :H, :head, "Display the first N items",
         optional_argument: true, as: Integer
  opt.on :T, :tail, "Display the last N items",
         optional_argument: true, as: Integer
  opt.on :s, :show, "Show the given range of lines",
         optional_argument: true, as: Range
  opt.on :G, :grep, "Show lines matching the given pattern",
         argument: true, as: String
  opt.on :c, :clear, "Clear the current session's history"
  opt.on :r, :replay, "Replay a line or range of lines",
         argument: true, as: Range
  opt.on :save, "Save history to a file", argument: true, as: Range
  opt.on :e, :'exclude-pry', "Exclude Pry commands from the history"
  opt.on :n, :'no-numbers',  "Omit line numbers"
end

#process ⇒ Object 


43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/pry/commands/hist.rb', line 43

def process
  @history = find_history

  @history = @history.between(opts[:show]) if opts.present?(:show)

  @history = @history.grep(opts[:grep]) if opts.present?(:grep)

  @history =
    if opts.present?(:head)
      @history.take_lines(1, opts[:head] || 10)
    elsif opts.present?(:tail)
      @history.take_lines(-(opts[:tail] || 10), opts[:tail] || 10)
    else
      @history
    end

  if opts.present?(:'exclude-pry')
    @history = @history.reject do |loc|
      command_set.valid_command?(loc.line)
    end
  end

  if opts.present?(:save)
    process_save
  elsif opts.present?(:clear)
    process_clear
  elsif opts.present?(:replay)
    process_replay
  else
    process_display
  end
end

#process_clear ⇒ Object (private) 


105
106
107
108
 
# File 'lib/pry/commands/hist.rb', line 105

def process_clear
  Pry.history.clear
  output.puts "History cleared."
end

#process_display ⇒ Object (private) 


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

def process_display
  @history = @history.with_line_numbers unless opts.present?(:'no-numbers')

  pry_instance.pager.open do |pager|
    @history.print_to_output(pager, true)
  end
end

#process_replay ⇒ Object (private) 


110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/pry/commands/hist.rb', line 110

def process_replay
  @history = @history.between(opts[:r])
  replay_sequence = @history.raw

  # If we met follow-up "hist" call, check for the "--replay" option
  # presence. If "hist" command is called with other options, proceed
  # further.
  check_for_juxtaposed_replay(replay_sequence)

  replay_sequence.lines.each do |line|
    pry_instance.eval line, generated: true
  end
end

#process_save ⇒ Object (private) 


86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/pry/commands/hist.rb', line 86

def process_save
  case opts[:save]
  when Range
    @history = @history.between(opts[:save])

    raise CommandError, "Must provide a file name." unless args.first

    file_name = File.expand_path(args.first)
  when String
    file_name = File.expand_path(opts[:save])
  end

  output.puts "Saving history in #{file_name}..."

  File.open(file_name, 'w') { |f| f.write(@history.raw) }

  output.puts "History saved."
end