summaryrefslogtreecommitdiff
path: root/lib/irb/cmd/show_source.rb
blob: 03c21b78c7a4b2750f0680ada44cbfbc9a7fa6b6 (plain)
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
# frozen_string_literal: true

require_relative "nop"
require_relative "../color"
require_relative "../ruby-lex"

module IRB
  # :stopdoc:

  module ExtendCommand
    class ShowSource < Nop
      class << self
        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

        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

        private

        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

        def string_literal?(args)
          sexp = Ripper.sexp(args)
          sexp && sexp.size == 2 && sexp.last&.first&.first == :string_literal
        end
      end

      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

      private

      # @param [IRB::ExtendCommand::ShowSource::Source] source
      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

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

      Source = Struct.new(
        :file,       # @param [String] - file name
        :first_line, # @param [String] - first line
        :last_line,  # @param [String] - last line
        keyword_init: true,
      )
      private_constant :Source
    end
  end

  # :startdoc:
end