1
0
Fork 0
mirror of https://github.com/pry/pry.git synced 2022-11-09 12:35:05 -05:00
pry--pry/lib/pry/module_candidate.rb

131 lines
4.9 KiB
Ruby
Raw Normal View History

require 'pry/helpers/documentation_helpers'
require 'forwardable'
class Pry
class WrappedModule
# This class represents a single candidate for a module/class definition.
# It provides access to the source, documentation, line and file
2012-06-23 04:14:10 -04:00
# for a monkeypatch (reopening) of a class/module.
class Candidate
extend Forwardable
# @return [String] The file where the module definition is located.
attr_reader :file
# @return [Fixnum] The line where the module definition is located.
attr_reader :line
# Methods to delegate to associated `Pry::WrappedModule instance`.
to_delegate = [:lines_for_file, :method_candidates, :name, :wrapped,
:yard_docs?, :number_of_candidates, :process_doc,
:strip_leading_whitespace]
def_delegators :@wrapper, *to_delegate
2012-07-02 02:10:10 -04:00
private(*to_delegate)
2012-06-23 04:14:10 -04:00
# @raise [Pry::CommandError] If `rank` is out of bounds.
# @param [Pry::WrappedModule] wrapper The associated
# `Pry::WrappedModule` instance that owns the candidates.
# @param [Fixnum] rank The rank of the candidate to
# retrieve. Passing 0 returns 'primary candidate' (the candidate with largest
# number of methods), passing 1 retrieves candidate with
# second largest number of methods, and so on, up to
# `Pry::WrappedModule#number_of_candidates() - 1`
def initialize(wrapper, rank)
@wrapper = wrapper
2012-06-23 04:14:10 -04:00
if number_of_candidates <= 0
raise CommandError, "Cannot find a definition for #{name} module!"
elsif rank > (number_of_candidates - 1)
raise CommandError, "No such module candidate. Allowed candidates range is from 0 to #{number_of_candidates - 1}"
end
@rank = rank
@file, @line = source_location
end
# @raise [Pry::CommandError] If source code cannot be found.
# @return [String] The source for the candidate, i.e the
# complete module/class definition.
def source
return @source if @source
raise CommandError, "Could not locate source for #{wrapped}!" if file.nil?
@source = strip_leading_whitespace(Pry::Code.from_file(file).expression_at(line, number_of_lines_in_first_chunk))
end
# @raise [Pry::CommandError] If documentation cannot be found.
# @return [String] The documentation for the candidate.
def doc
return @doc if @doc
raise CommandError, "Could not locate doc for #{wrapped}!" if file.nil?
@doc = process_doc(Pry::Code.from_file(file).comment_describing(line))
end
# @return [Array, nil] A `[String, Fixnum]` pair representing the
# source location (file and line) for the candidate or `nil`
# if no source location found.
def source_location
return @source_location if @source_location
mod_type_string = wrapped.class.to_s.downcase
file, line = first_method_source_location
return nil if !file.is_a?(String)
class_regexes = [/^\s*#{mod_type_string}\s*(\w*)(::)?#{wrapped.name.split(/::/).last}/,
/^\s*(::)?#{wrapped.name.split(/::/).last}\s*?=\s*?#{wrapped.class}/,
/^\s*(::)?#{wrapped.name.split(/::/).last}\.(class|instance)_eval/]
host_file_lines = lines_for_file(file)
search_lines = host_file_lines[0..(line - 2)]
idx = search_lines.rindex { |v| class_regexes.any? { |r| r =~ v } }
@source_location = [file, idx + 1]
rescue Pry::RescuableException
nil
end
private
# This method is used by `Candidate#source_location` as a
# starting point for the search for the candidate's definition.
# @return [Array] The source location of the base method used to
# calculate the source location of the candidate.
def first_method_source_location
@first_method_source_location ||= adjusted_source_location(method_candidates[@rank].first.source_location)
end
# @return [Array] The source location of the last method in this
# candidate's module definition.
def last_method_source_location
@end_method_source_location ||= adjusted_source_location(method_candidates[@rank].last.source_location)
end
# Return the number of lines between the start of the class definition
# and the start of the last method. We use this value so we can
# quickly grab these lines from the file (without having to
# check each intervening line for validity, which is expensive) speeding up source extraction.
# @return [Fixum] Number of lines.
def number_of_lines_in_first_chunk
end_method_line = last_method_source_location.last
end_method_line - line
end
def adjusted_source_location(sl)
file, line = sl
if file && RbxPath.is_core_path?(file)
file = RbxPath.convert_path_to_full(file)
end
[file, line]
end
end
end
end