class Pry::CodeFile
Constants
- DEFAULT_EXT
- EXTENSIONS
List of all supported languages. @return [Hash]
- FILES
- INITIAL_PWD
Store the current working directory. This allows show-source etc. to work if your process has changed directory since boot. [Issue #675]
Attributes
@return [Symbol] The type of code stored in this wrapper.
Public Class Methods
@param [String] filename The name of a file with code to be detected @param [Symbol] code_type
The type of code the `filename` contains
# File lib/pry/code/code_file.rb, line 41 def initialize(filename, code_type = type_from_filename(filename)) @filename = filename @code_type = code_type end
Public Instance Methods
@return [String] The code contained in the current `@filename`.
# File lib/pry/code/code_file.rb, line 47 def code if @filename == Pry.eval_path Pry.line_buffer.drop(1) elsif Pry::Method::Patcher.code_for(@filename) Pry::Method::Patcher.code_for(@filename) else path = abs_path @code_type = type_from_filename(path) File.read(path) end end
Private Instance Methods
@raise [MethodSource::SourceNotFoundError] if the `filename` is not
readable for some reason.
@return [String] absolute path for the given `filename`.
# File lib/pry/code/code_file.rb, line 64 def abs_path code_path.detect { |path| readable?(path) } || raise(MethodSource::SourceNotFoundError, "Cannot open #{@filename.inspect} for reading.") end
@return [Array] All the paths that contain code that Pry
can use for its
API's. Skips directories.
# File lib/pry/code/code_file.rb, line 80 def code_path [from_pwd, from_pry_init_pwd, *from_load_path] end
@return [String]
# File lib/pry/code/code_file.rb, line 110 def from_load_path $LOAD_PATH.map { |path| File.expand_path(@filename, path) } end
@return [String]
# File lib/pry/code/code_file.rb, line 105 def from_pry_init_pwd File.expand_path(@filename, INITIAL_PWD) end
@return [String]
# File lib/pry/code/code_file.rb, line 100 def from_pwd File.expand_path(@filename, Dir.pwd) end
@param [String] path @return [Boolean] if the path, with or without the default ext,
is a readable file then `true`, otherwise `false`.
# File lib/pry/code/code_file.rb, line 73 def readable?(path) File.readable?(path) && !File.directory?(path) || File.readable?(path << DEFAULT_EXT) end
@param [String] filename @param [Symbol] default (:unknown) the file type to assume if none could be
detected.
@return [Symbol, nil] The SyntaxHighlighter
type of a file from its
extension, or `nil` if `:unknown`.
# File lib/pry/code/code_file.rb, line 89 def type_from_filename(filename, default = :unknown) _, @code_type = EXTENSIONS.find do |k, _| k.any? { |ext| ext == File.extname(filename) } end || FILES.find do |k, _| k.any? { |file_name| file_name == File.basename(filename) } end code_type || default end