Class: Pry::Code

Inherits:
Object show all
Extended by:
MethodSource::CodeHelpers
Defined in:
lib/pry/code.rb,
lib/pry/code/loc.rb,
lib/pry/code/code_range.rb

Overview

Pry::Code is a class that encapsulates lines of source code and their line numbers and formats them for terminal output. It can read from a file or method definition or be instantiated with a String or an Array.

In general, the formatting methods in Code return a new Code object which will format the text as specified when #to_s is called. This allows arbitrary chaining of formatting methods without mutating the original object.

Defined Under Namespace

Classes: CodeRange, LOC

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(lines = [], start_line = 1, code_type = :ruby) ⇒ Code

Instantiate a Code object containing code from the given Array, String, or IO. The first line will be line 1 unless specified otherwise. If you need non-contiguous line numbers, you can create an empty Code object and then use #push to insert the lines.

Parameters:

  • lines (Array<String>, String, IO) (defaults to: [])
  • start_line (Integer?) (defaults to: 1)
  • code_type (Symbol?) (defaults to: :ruby)


87
88
89
90
91
92
93
94
95
96
# File 'lib/pry/code.rb', line 87

def initialize(lines = [], start_line = 1, code_type = :ruby)
  if lines.is_a? String
    lines = lines.lines
  end
  @lines = lines.each_with_index.map { |line, lineno|
    LOC.new(line, lineno + start_line.to_i) }
  @code_type = code_type

  @with_marker = @with_indentation = nil
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args, &block) ⇒ Object

Forward any missing methods to the output of #to_s.



335
336
337
# File 'lib/pry/code.rb', line 335

def method_missing(name, *args, &block)
  to_s.send(name, *args, &block)
end

Instance Attribute Details

#code_typeSymbol

Returns The type of code stored in this wrapper.

Returns:

  • (Symbol)

    The type of code stored in this wrapper.



77
78
79
# File 'lib/pry/code.rb', line 77

def code_type
  @code_type
end

Class Method Details

.from_file(filename, code_type = nil) ⇒ Code

Instantiate a Code object containing code loaded from a file or Pry's line buffer.

Parameters:

  • filename (String)

    The name of a file, or "(pry)".

  • code_type (Symbol) (defaults to: nil)

    The type of code the file contains.

Returns:



42
43
44
45
# File 'lib/pry/code.rb', line 42

def from_file(filename, code_type = nil)
  code_file = CodeFile.new(filename, code_type)
  new(code_file.code, 1, code_file.code_type)
end

.from_method(meth, start_line = nil) ⇒ Code

Instantiate a Code object containing code extracted from a ::Method, UnboundMethod, Proc, or Pry::Method object.

Parameters:

  • meth (::Method, UnboundMethod, Proc, Pry::Method)

    The method object.

  • start_line (Integer, nil) (defaults to: nil)

    The line number to start on, or nil to use the method's original line numbers.

Returns:



55
56
57
58
59
# File 'lib/pry/code.rb', line 55

def from_method(meth, start_line = nil)
  meth = Pry::Method(meth)
  start_line ||= meth.source_line || 1
  new(meth.source, start_line, meth.source_type)
end

.from_module(mod, candidate_rank = 0, start_line = nil) ⇒ Code

Attempt to extract the source code for module (or class) mod.

Parameters:

  • mod (Module, Class)

    The module (or class) of interest.

  • candidate_rank (Integer) (defaults to: 0)

    The module candidate (by rank) to use (see Pry::WrappedModule::Candidate for more information).

  • start_line (Integer, nil) (defaults to: nil)

    The line number to start on, or nil to use the method's original line numbers.

Returns:



69
70
71
72
73
# File 'lib/pry/code.rb', line 69

def from_module(mod, candidate_rank = 0, start_line=nil)
  candidate = Pry::WrappedModule(mod).candidate(candidate_rank)
  start_line ||= candidate.line
  new(candidate.source, start_line, :ruby)
end

Instance Method Details

#==(other) ⇒ Boolean

Two Code objects are equal if they contain the same lines with the same numbers. Otherwise, call to_s and chomp and compare as Strings.

Parameters:

Returns:

  • (Boolean)


325
326
327
328
329
330
331
332
# File 'lib/pry/code.rb', line 325

def ==(other)
  if other.is_a?(Code)
    other_lines = other.instance_variable_get(:@lines)
    @lines.each_with_index.all? { |loc, i| loc == other_lines[i] }
  else
    to_s.chomp == other.to_s.chomp
  end
end

#after(lineno, lines = 1) ⇒ Code

Remove all lines except for the +lines+ after and excluding +lineno+.

Parameters:

  • lineno (Integer)
  • lines (Integer) (defaults to: 1)

Returns:



190
191
192
193
194
195
196
# File 'lib/pry/code.rb', line 190

def after(lineno, lines = 1)
  return self unless lineno

  select do |loc|
    loc.lineno > lineno && loc.lineno <= lineno + lines
  end
end

#around(lineno, lines = 1) ⇒ Code

Remove all lines except for the +lines+ on either side of and including +lineno+.

Parameters:

  • lineno (Integer)
  • lines (Integer) (defaults to: 1)

Returns:



177
178
179
180
181
182
183
# File 'lib/pry/code.rb', line 177

def around(lineno, lines = 1)
  return self unless lineno

  select do |loc|
    loc.lineno >= lineno - lines && loc.lineno <= lineno + lines
  end
end

#before(lineno, lines = 1) ⇒ Code

Remove all lines except for the +lines+ up to and excluding +lineno+.

Parameters:

  • lineno (Integer)
  • lines (Integer) (defaults to: 1)

Returns:



163
164
165
166
167
168
169
# File 'lib/pry/code.rb', line 163

def before(lineno, lines = 1)
  return self unless lineno

  select do |loc|
    loc.lineno >= lineno - lines && loc.lineno < lineno
  end
end

#between(start_line, end_line = nil) ⇒ Code

Remove all lines that aren't in the given range, expressed either as a Range object or a first and last line number (inclusive). Negative indices count from the end of the array of lines.

Parameters:

  • start_line (Range, Integer)
  • end_line (Integer?) (defaults to: nil)

Returns:



130
131
132
133
134
135
136
137
138
# File 'lib/pry/code.rb', line 130

def between(start_line, end_line = nil)
  return self unless start_line

  code_range = CodeRange.new(start_line, end_line)

  alter do
    @lines = @lines[code_range.indices_range(@lines)] || []
  end
end

#comment_describing(line_number) ⇒ String

Get the comment that describes the expression on the given line number.

Parameters:

  • line_number (Integer)

    (1-based)

Returns:

  • (String)

    the code.



285
286
287
# File 'lib/pry/code.rb', line 285

def comment_describing(line_number)
  self.class.comment_describing(raw, line_number)
end

#expression_at(line_number, consume = 0) ⇒ String

Get the multiline expression that starts on the given line number.

Parameters:

  • line_number (Integer)

    (1-based)

Returns:

  • (String)

    the code.



293
294
295
# File 'lib/pry/code.rb', line 293

def expression_at(line_number, consume = 0)
  self.class.expression_at(raw, line_number, :consume => consume)
end

#grep(pattern) ⇒ Code

Remove all lines that don't match the given pattern.

Parameters:

  • pattern (Regexp)

Returns:



202
203
204
205
206
207
208
209
# File 'lib/pry/code.rb', line 202

def grep(pattern)
  return self unless pattern
  pattern = Regexp.new(pattern)

  select do |loc|
    loc.line =~ pattern
  end
end

#highlightedString

Returns a (possibly highlighted) copy of the source code.

Returns:

  • (String)

    a (possibly highlighted) copy of the source code.



262
263
264
# File 'lib/pry/code.rb', line 262

def highlighted
  print_to_output("", true)
end

#inspectString

Returns:

  • (String)


246
247
248
# File 'lib/pry/code.rb', line 246

def inspect
  Object.instance_method(:to_s).bind(self).call
end

#lengthInteger

Return the number of lines stored.

Returns:

  • (Integer)


316
317
318
# File 'lib/pry/code.rb', line 316

def length
  @lines ? @lines.length : 0
end

#max_lineno_widthInteger

Returns the number of digits in the last line.

Returns:

  • (Integer)

    the number of digits in the last line.



251
252
253
# File 'lib/pry/code.rb', line 251

def max_lineno_width
  @lines.length > 0 ? @lines.last.lineno.to_s.length : 0
end

#nesting_at(line_number, top_module = Object) ⇒ Array<Module>

Get the (approximate) Module.nesting at the give line number.

Parameters:

  • line_number (Integer)

    line number starting from 1

  • top_module (Module) (defaults to: Object)

    the module in which this code exists

Returns:

  • (Array<Module>)

    a list of open modules.



302
303
304
# File 'lib/pry/code.rb', line 302

def nesting_at(line_number, top_module = Object)
  Pry::Indent.nesting_at(raw, line_number)
end

Writes a formatted representation (based on the configuration of the object) to the given output, which must respond to #<<.



268
269
270
271
272
273
274
275
276
277
278
279
# File 'lib/pry/code.rb', line 268

def print_to_output(output, color=false)
  @lines.each do |loc|
    loc = loc.dup
    loc.colorize(@code_type)              if color
    loc.add_line_number(max_lineno_width, color) if @with_line_numbers
    loc.add_marker(@marker_lineno)        if @with_marker
    loc.indent(@indentation_num)          if @with_indentation
    output << loc.line
    output << "\n"
  end
  output
end

#push(line, lineno = nil) ⇒ String Also known as: <<

Append the given line. +lineno+ is one more than the last existing line, unless specified otherwise.

Parameters:

  • line (String)
  • lineno (Integer?) (defaults to: nil)

Returns:

  • (String)

    The inserted line.



104
105
106
107
108
109
110
# File 'lib/pry/code.rb', line 104

def push(line, lineno = nil)
  if lineno.nil?
    lineno = @lines.last.lineno + 1
  end
  @lines.push(LOC.new(line, lineno))
  line
end

#rawString

Return an unformatted String of the code.

Returns:

  • (String)


309
310
311
# File 'lib/pry/code.rb', line 309

def raw
  @lines.map(&:line).join("\n") << "\n"
end

#select {|LOC| ... } ⇒ Code

Filter the lines using the given block.

Yields:

Returns:



117
118
119
120
121
# File 'lib/pry/code.rb', line 117

def select(&block)
  alter do
    @lines = @lines.select(&block)
  end
end

#take_lines(start_line, num_lines) ⇒ Code

Take num_lines from start_line, forward or backwards.

Parameters:

  • start_line (Integer)
  • num_lines (Integer)

Returns:



145
146
147
148
149
150
151
152
153
154
155
156
# File 'lib/pry/code.rb', line 145

def take_lines(start_line, num_lines)
  start_idx =
    if start_line >= 0
      @lines.index { |loc| loc.lineno >= start_line } || @lines.length
    else
      [@lines.length + start_line, 0].max
    end

  alter do
    @lines = @lines.slice(start_idx, num_lines)
  end
end

#to_sString

Returns a formatted representation (based on the configuration of the object).

Returns:

  • (String)

    a formatted representation (based on the configuration of the object).



257
258
259
# File 'lib/pry/code.rb', line 257

def to_s
  print_to_output("", false)
end

#with_indentation(spaces = 0) ⇒ Code

Format output with the specified number of spaces in front of every line, unless spaces is falsy.

Parameters:

  • spaces (Integer?) (defaults to: 0)

Returns:



238
239
240
241
242
243
# File 'lib/pry/code.rb', line 238

def with_indentation(spaces = 0)
  alter do
    @with_indentation = !!spaces
    @indentation_num  = spaces
  end
end

#with_line_numbers(y_n = true) ⇒ Code

Format output with line numbers next to it, unless y_n is falsy.

Parameters:

  • y_n (Boolean?) (defaults to: true)

Returns:



215
216
217
218
219
# File 'lib/pry/code.rb', line 215

def with_line_numbers(y_n = true)
  alter do
    @with_line_numbers = y_n
  end
end

#with_marker(lineno = 1) ⇒ Code

Format output with a marker next to the given +lineno+, unless +lineno+ is falsy.

Parameters:

  • lineno (Integer?) (defaults to: 1)

Returns:



226
227
228
229
230
231
# File 'lib/pry/code.rb', line 226

def with_marker(lineno = 1)
  alter do
    @with_marker   = !!lineno
    @marker_lineno = lineno
  end
end