123456789_123456789_123456789_123456789_123456789_

Class: IRB::ExtendCommand::ShowSource

Do not use. This class is for internal use only.
Relationships & Source Files
Namespace Children
Classes:
Source
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Nop
Instance Chain:
self, Nop
Inherits: IRB::ExtendCommand::Nop
Defined in: lib/irb/cmd/show_source.rb

Class Method Summary

Nop - Inherited

.category, .description,
.execute

See additional method definition at line 39.
.new, .string_literal?

Instance Attribute Summary

Nop - Inherited

#irb_context

Instance Method Summary

Nop - Inherited

#execute, #irb

Constructor Details

This class inherits a constructor from IRB::ExtendCommand::Nop

Class Method Details

.find_end(file, first_line) (private)

[ GitHub ] 

  


# File 'lib/irb/cmd/show_source.rb', line 49



def find_end(file, first_line)
  return first_line unless File.exist?(file)
  lex = RubyLex.new
  lines = File.read(file).lines[(first_line - 1)..-1]
  tokens = RubyLex.ripper_lex_without_warning(lines.join)
  prev_tokens = []

  # chunk with line number
  tokens.chunk { |tok| tok.pos[0] }.each do |lnum, chunk|
    code = lines[0..lnum].join
    prev_tokens.concat chunk
    continue = lex.process_continue(prev_tokens)
    code_block_open = lex.check_code_block(code, prev_tokens)
    if !continue && !code_block_open
      return first_line + lnum
    end
  end
  first_line
end


  








  

    .find_source(str, irb_context)  
  

  [ GitHub ]


  

  


# File 'lib/irb/cmd/show_source.rb', line 25



def find_source(str, irb_context)
  case str
  when /\A[A-Z]\w*(::[A-Z]\w*)*\z/ # Const::Name
    eval(str, irb_context.workspace.binding) # trigger autoload
    base = irb_context.workspace.binding.receiver.yield_self { |r| r.is_a?(Module) ? r : Object }
    file, line = base.const_source_location(str) if base.respond_to?(:const_source_location) # Ruby 2.7+
  when /\A(?<owner>[A-Z]\w*(::[A-Z]\w*)*)#(?<method>[^ :.]+)\z/ # Class#method
    owner = eval(Regexp.last_match[:owner], irb_context.workspace.binding)
    method = Regexp.last_match[:method]
    if owner.respond_to?(:instance_method) && owner.instance_methods.include?(method.to_sym)
      file, line = owner.instance_method(method).source_location
    end
  when /\A((?<receiver>.+)(\.|::))?(?<method>[^ :.]+)\z/ # method, receiver.method, receiver::method
    receiver = eval(Regexp.last_match[:receiver] || 'self', irb_context.workspace.binding)
    method = Regexp.last_match[:method]
    file, line = receiver.method(method).source_location if receiver.respond_to?(method)
  end
  if file && line
    Source.new(file: file, first_line: line, last_line: find_end(file, line))
  end
end


  








  

    .transform_args(args)  
  

  [ GitHub ]


  

  


# File 'lib/irb/cmd/show_source.rb', line 16



def transform_args(args)
  # Return a string literal as is for backward compatibility
  if args.empty? || string_literal?(args)
    args
  else # Otherwise, consider the input as a String for convenience
    args.strip.dump
  end
end


  







Instance Method Details



  

    #bold(str)   (private)
  

  [ GitHub ]


  

  


# File 'lib/irb/cmd/show_source.rb', line 97



def bold(str)
  Color.colorize(str, [:BOLD])
end


  








  

    #execute(str = nil)  
  

  [ GitHub ]


  

  


# File 'lib/irb/cmd/show_source.rb', line 70



def execute(str = nil)
  unless str.is_a?(String)
    puts "Error: Expected a string but got #{str.inspect}"
    return
  end

  source = self.class.find_source(str, @irb_context)
  if source && File.exist?(source.file)
    show_source(source)
  else
    puts "Error: Couldn't locate a definition for #{str}"
  end
  nil
end


  








  

    #show_source(source)   (private)
  



  

    
  





  
Parameters:





  [ GitHub ]


  

  


# File 'lib/irb/cmd/show_source.rb', line 88



def show_source(source)
  puts
  puts "#{bold("From")}: #{source.file}:#{source.first_line}"
  puts
  code = IRB::Color.colorize_code(File.read(source.file))
  puts code.lines[(source.first_line - 1)...source.last_line].join
  puts
end