/usr/lib/ruby/vendor_ruby/pry/code.rb is in pry 0.10.3-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 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 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 | require 'pry/code/loc'
require 'pry/code/code_range'
require 'pry/code/code_file'
class Pry
class << self
# Convert the given object into an instance of `Pry::Code`, if it isn't
# already one.
#
# @param [Code, Method, UnboundMethod, Proc, Pry::Method, String, Array,
# IO] obj
def Code(obj)
case obj
when Code
obj
when ::Method, UnboundMethod, Proc, Pry::Method
Code.from_method(obj)
else
Code.new(obj)
end
end
end
# `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.
class Code
class << self
include MethodSource::CodeHelpers
# Instantiate a `Code` object containing code loaded from a file or
# Pry's line buffer.
#
# @param [String] filename The name of a file, or "(pry)".
# @param [Symbol] code_type The type of code the file contains.
# @return [Code]
def from_file(filename, code_type = nil)
code_file = CodeFile.new(filename, code_type)
new(code_file.code, 1, code_file.code_type)
end
# Instantiate a `Code` object containing code extracted from a
# `::Method`, `UnboundMethod`, `Proc`, or `Pry::Method` object.
#
# @param [::Method, UnboundMethod, Proc, Pry::Method] meth The method
# object.
# @param [Integer, nil] start_line The line number to start on, or nil to
# use the method's original line numbers.
# @return [Code]
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
# Attempt to extract the source code for module (or class) `mod`.
#
# @param [Module, Class] mod The module (or class) of interest.
# @param [Integer] candidate_rank The module candidate (by rank)
# to use (see `Pry::WrappedModule::Candidate` for more information).
# @param [Integer, nil] start_line The line number to start on, or nil to
# use the method's original line numbers.
# @return [Code]
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
end
# @return [Symbol] The type of code stored in this wrapper.
attr_accessor :code_type
# 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.
#
# @param [Array<String>, String, IO] lines
# @param [Integer?] start_line
# @param [Symbol?] code_type
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
end
# Append the given line. +lineno+ is one more than the last existing
# line, unless specified otherwise.
#
# @param [String] line
# @param [Integer?] lineno
# @return [String] The inserted line.
def push(line, lineno = nil)
if lineno.nil?
lineno = @lines.last.lineno + 1
end
@lines.push(LOC.new(line, lineno))
line
end
alias << push
# Filter the lines using the given block.
#
# @yield [LOC]
# @return [Code]
def select(&block)
alter do
@lines = @lines.select(&block)
end
end
# 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.
#
# @param [Range, Integer] start_line
# @param [Integer?] end_line
# @return [Code]
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
# Take `num_lines` from `start_line`, forward or backwards.
#
# @param [Integer] start_line
# @param [Integer] num_lines
# @return [Code]
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
# Remove all lines except for the +lines+ up to and excluding +lineno+.
#
# @param [Integer] lineno
# @param [Integer] lines
# @return [Code]
def before(lineno, lines = 1)
return self unless lineno
select do |loc|
loc.lineno >= lineno - lines && loc.lineno < lineno
end
end
# Remove all lines except for the +lines+ on either side of and including
# +lineno+.
#
# @param [Integer] lineno
# @param [Integer] lines
# @return [Code]
def around(lineno, lines = 1)
return self unless lineno
select do |loc|
loc.lineno >= lineno - lines && loc.lineno <= lineno + lines
end
end
# Remove all lines except for the +lines+ after and excluding +lineno+.
#
# @param [Integer] lineno
# @param [Integer] lines
# @return [Code]
def after(lineno, lines = 1)
return self unless lineno
select do |loc|
loc.lineno > lineno && loc.lineno <= lineno + lines
end
end
# Remove all lines that don't match the given `pattern`.
#
# @param [Regexp] pattern
# @return [Code]
def grep(pattern)
return self unless pattern
pattern = Regexp.new(pattern)
select do |loc|
loc.line =~ pattern
end
end
# Format output with line numbers next to it, unless `y_n` is falsy.
#
# @param [Boolean?] y_n
# @return [Code]
def with_line_numbers(y_n = true)
alter do
@with_line_numbers = y_n
end
end
# Format output with a marker next to the given +lineno+, unless +lineno+ is
# falsy.
#
# @param [Integer?] lineno
# @return [Code]
def with_marker(lineno = 1)
alter do
@with_marker = !!lineno
@marker_lineno = lineno
end
end
# Format output with the specified number of spaces in front of every line,
# unless `spaces` is falsy.
#
# @param [Integer?] spaces
# @return [Code]
def with_indentation(spaces = 0)
alter do
@with_indentation = !!spaces
@indentation_num = spaces
end
end
# @return [String]
def inspect
Object.instance_method(:to_s).bind(self).call
end
# @return [Integer] the number of digits in the last line.
def max_lineno_width
@lines.length > 0 ? @lines.last.lineno.to_s.length : 0
end
# @return [String] a formatted representation (based on the configuration of
# the object).
def to_s
print_to_output("", false)
end
# @return [String] a (possibly highlighted) copy of the source code.
def highlighted
print_to_output("", true)
end
# Writes a formatted representation (based on the configuration of the
# object) to the given output, which must respond to `#<<`.
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
# Get the comment that describes the expression on the given line number.
#
# @param [Integer] line_number (1-based)
# @return [String] the code.
def comment_describing(line_number)
self.class.comment_describing(raw, line_number)
end
# Get the multiline expression that starts on the given line number.
#
# @param [Integer] line_number (1-based)
# @return [String] the code.
def expression_at(line_number, consume = 0)
self.class.expression_at(raw, line_number, :consume => consume)
end
# Get the (approximate) Module.nesting at the give line number.
#
# @param [Integer] line_number line number starting from 1
# @param [Module] top_module the module in which this code exists
# @return [Array<Module>] a list of open modules.
def nesting_at(line_number, top_module = Object)
Pry::Indent.nesting_at(raw, line_number)
end
# Return an unformatted String of the code.
#
# @return [String]
def raw
@lines.map(&:line).join("\n") << "\n"
end
# Return the number of lines stored.
#
# @return [Integer]
def length
@lines ? @lines.length : 0
end
# 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.
#
# @param [Code, Object] other
# @return [Boolean]
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
# Forward any missing methods to the output of `#to_s`.
def method_missing(name, *args, &block)
to_s.send(name, *args, &block)
end
undef =~
protected
# An abstraction of the `dup.instance_eval` pattern used throughout this
# class.
def alter(&block)
dup.tap { |o| o.instance_eval(&block) }
end
end
end
|