Class: Pry::Command::AmendLine

Inherits:
Pry::ClassCommand show all
Defined in:
lib/pry/commands/amend_line.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, #options, #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

#amend_input ⇒ String (private)

Returns A new string with the amendments applied to it.

Returns:

  • (String) —

    A new string with the amendments applied to it.



33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/pry/commands/amend_line.rb', line 33

def amend_input
  input_array = eval_string.each_line.to_a

  if arg_string == "!"
    delete_from_array(input_array, line_range)
  elsif arg_string.start_with?(">")
    insert_into_array(input_array, line_range)
  else
    replace_in_array(input_array, line_range)
  end

  input_array.join
end

#delete_from_array(array, range) ⇒ Object (private) 



47
48
49
 
# File 'lib/pry/commands/amend_line.rb', line 47

def delete_from_array(array, range)
  array.slice!(range)
end

#insert_into_array(array, range) ⇒ Object (private) 



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

def insert_into_array(array, range)
  insert_slot = Array(range).first
  array.insert(insert_slot, arg_string[1..-1] << "\n")
end

#line_count ⇒ Fixnum (private)

Returns The number of lines currently in eval_string (the input buffer).

Returns:

  • (Fixnum) —

    The number of lines currently in eval_string (the input buffer)



62
63
64
 
# File 'lib/pry/commands/amend_line.rb', line 62

def line_count
  eval_string.lines.count
end

#line_range ⇒ Range, Fixnum (private)

The lines (or line) that will be modified by the amend-line.

Returns:

  • (Range, Fixnum) —

    The lines or line.



90
91
92
93
94
95
96
97
98
 
# File 'lib/pry/commands/amend_line.rb', line 90

def line_range
  start_line_number, end_line_number = start_and_end_line_number
  if start_line_number
    zero_indexed_range_from_one_indexed_numbers(start_line_number,
                                                end_line_number)
  else
    line_count - 1
  end
end

#process ⇒ Object

Raises:



22
23
24
25
26
27
28
 
# File 'lib/pry/commands/amend_line.rb', line 22

def process
  raise CommandError, "No input to amend." if eval_string.empty?

  eval_string.replace(amend_input)
  run "fix-indent"
  run "show-input"
end

#replace_in_array(array, range) ⇒ Object (private) 



56
57
58
 
# File 'lib/pry/commands/amend_line.rb', line 56

def replace_in_array(array, range)
  array[range] = arg_string + "\n"
end

#start_and_end_line_number ⇒ Array<Fixnum>? (private)

Returns the (one-indexed) start and end lines given by the user. The lines in this range will be affected by the amend-line. Returns nil if no lines were specified by the user.

Returns:

  • (Array<Fixnum>, nil) 


70
71
72
73
74
75
 
# File 'lib/pry/commands/amend_line.rb', line 70

def start_and_end_line_number
  start_line_number, end_line_number = args
  end_line_number ||= start_line_number.to_i

  [start_line_number.to_i, end_line_number.to_i] if start_line_number
end

#zero_indexed_range_from_one_indexed_numbers(start_line_number, end_line_number) ⇒ Range (private)

Takes two numbers that are 1-indexed, and returns a range (or number) that is 0-indexed. 1-indexed means the first element is indentified by 1 rather than by 0 (as is the case for Ruby arrays).

Parameters:

  • start_line_number (Fixnum) —

    One-indexed number.

  • end_line_number (Fixnum) —

    One-indexed number.

Returns:

  • (Range) —

    The zero-indexed range.



83
84
85
86
 
# File 'lib/pry/commands/amend_line.rb', line 83

def zero_indexed_range_from_one_indexed_numbers(start_line_number, end_line_number)
  # FIXME: one_index_number is a horrible name for this method
  one_index_number(start_line_number)..one_index_number(end_line_number)
end