pry--pry/lib/pry/default_commands/introspection.rb

require 'tempfile'

class Pry
  module DefaultCommands

    # For show-doc and show-source
    module ModuleIntrospectionHelpers
      attr_accessor :module_object

      def module?(name)
        self.module_object = Pry::WrappedModule.from_str(name, target)
      end

      def method?
        !!method_object
      rescue CommandError
        false
      end

      def process(name)
        if module?(name)
          code_or_doc = process_module
        else method?
          code_or_doc = process_method
        end

        render_output(code_or_doc, opts)
      end

      def module_start_line(mod, candidate=0)
        if opts.present?(:'base-one')
          1
        else
          mod.source_line_for_candidate(candidate)
        end
      end

      def use_line_numbers?
        opts.present?(:b) || opts.present?(:l)
      end
    end

    Introspection = Pry::CommandSet.new do

      create_command "show-doc", "Show the documentation for a method or class. Aliases: \?", :shellwords => false do
        include ModuleIntrospectionHelpers
        include Helpers::DocumentationHelpers
        extend Helpers::BaseHelpers

        banner <<-BANNER
          Usage: show-doc [OPTIONS] [METH]
          Aliases: ?

          Show the documentation for a method or class. Tries instance methods first and then methods by default.
          e.g show-doc hello_method    # docs for hello_method
          e.g show-doc Pry             # docs for Pry class
          e.g show-doc Pry -a          # docs for all definitions of Pry class (all monkey patches)
        BANNER

        options :requires_gem => "ruby18_source_location" if mri_18?

        def setup
          require 'ruby18_source_location' if mri_18?
        end

        def options(opt)
          method_options(opt)
          opt.on :l, "line-numbers", "Show line numbers."
          opt.on :b, "base-one", "Show line numbers but start numbering at 1 (useful for `amend-line` and `play` commands)."
          opt.on :f, :flood, "Do not use a pager to view text longer than one screen."
          opt.on :a, :all, "Show docs for all definitions and monkeypatches of the module/class"
        end

        def process_module
          if opts.present?(:all)
            all_modules
          else
            normal_module
          end
        end

        def normal_module
          mod = module_object

          # source_file reveals the underlying .c file in case of core
          # classes on MRI. This is different to source_location, which
          # will return nil.
          if mod.yard_docs?
            file_name, line = mod.source_file, nil
          else
            file_name, line = mod.source_location
          end

          if mod.doc.empty?
            output.puts "No documentation found."
            ""
          else
            set_file_and_dir_locals(file_name) if !mod.yard_docs?
            doc = ""
            doc << mod.doc

            doc = Code.new(doc, module_start_line(mod), :text).
              with_line_numbers(use_line_numbers?).to_s

            doc.insert(0, "\n#{Pry::Helpers::Text.bold('From:')} #{file_name} @ line #{line ? line : "N/A"}:\n\n")
          end
        end

        def all_modules
          mod = module_object

          doc = ""
          doc << "Found #{mod.number_of_candidates} candidates for `#{mod.name}` definition:\n"
          mod.number_of_candidates.times do |v|
            begin
              doc << "\nCandidate #{v+1}/#{mod.number_of_candidates}: #{mod.source_file_for_candidate(v)} @ #{mod.source_line_for_candidate(v)}:\n\n"
              dc = mod.doc_for_candidate(v)
              doc << (dc.empty? ? "No documentation found.\n" : dc)
            rescue Pry::RescuableException
              next
            end
          end
          doc
        end

        def process_method
          meth = method_object
          raise Pry::CommandError, "No documentation found." if meth.doc.nil? || meth.doc.empty?

          doc = process_comment_markup(meth.doc, meth.source_type)
          output.puts make_header(meth, doc)
          output.puts "#{text.bold("Owner:")} #{meth.owner || "N/A"}"
          output.puts "#{text.bold("Visibility:")} #{meth.visibility}"
          output.puts "#{text.bold("Signature:")} #{meth.signature}"
          output.puts

          if use_line_numbers?
            doc = Code.new(doc, start_line, :text).
              with_line_numbers(true).to_s
          end

          doc
        end

        def module_start_line(mod, candidate=0)
          if opts.present?(:'base-one')
            1
          else
            if mod.source_line_for_candidate(candidate)
              mod.source_line_for_candidate(candidate) - mod.doc_for_candidate(candidate).lines.count
            else
              1
            end
          end
        end

        def start_line
          if opts.present?(:'base-one')
             1
          else
            (method_object.source_line - method_object.doc.lines.count) || 1
          end
        end
      end

      alias_command "?", "show-doc"

      create_command "stat", "View method information and set _file_ and _dir_ locals.", :shellwords => false do
        banner <<-BANNER
            Usage: stat [OPTIONS] [METH]
            Show method information for method METH and set _file_ and _dir_ locals.
            e.g: stat hello_method
        BANNER

        def options(opt)
          method_options(opt)
        end

        def process
          meth = method_object
          output.puts unindent <<-EOS
            Method Information:
            --
            Name: #{meth.name}
            Owner: #{meth.owner ? meth.owner : "Unknown"}
            Visibility: #{meth.visibility}
            Type: #{meth.is_a?(::Method) ? "Bound" : "Unbound"}
            Arity: #{meth.arity}
            Method Signature: #{meth.signature}
            Source Location: #{meth.source_location ? meth.source_location.join(":") : "Not found."}
          EOS
        end
      end

      create_command "show-source" do
        include ModuleIntrospectionHelpers
        extend Helpers::BaseHelpers

        description "Show the source for a method or class. Aliases: $, show-method"

        banner <<-BANNER
          Usage: show-source [OPTIONS] [METH|CLASS]
          Aliases: $, show-method

          Show the source for a method or class. Tries instance methods first and then methods by default.

          e.g: `show-source hello_method`
          e.g: `show-source -m hello_method`
          e.g: `show-source Pry#rep`         # source for Pry#rep method
          e.g: `show-source Pry`             # source for Pry class
          e.g: `show-source Pry -a`          # source for all Pry class definitions (all monkey patches)

          https://github.com/pry/pry/wiki/Source-browsing#wiki-Show_method
        BANNER

        options :shellwords => false
        options :requires_gem => "ruby18_source_location" if mri_18?

        def setup
          require 'ruby18_source_location' if mri_18?
        end

        def options(opt)
          method_options(opt)
          opt.on :l, "line-numbers", "Show line numbers."
          opt.on :b, "base-one", "Show line numbers but start numbering at 1 (useful for `amend-line` and `play` commands)."
          opt.on :f, :flood, "Do not use a pager to view text longer than one screen."
          opt.on :a, :all, "Show source for all definitions and monkeypatches of the module/class"
        end

        def process_method
          raise CommandError, "Could not find method source" unless method_object.source

          code = ""
          code << make_header(method_object)
          code << "#{text.bold("Owner:")} #{method_object.owner || "N/A"}\n"
          code << "#{text.bold("Visibility:")} #{method_object.visibility}\n"
          code << "\n"

          code << Code.from_method(method_object, start_line).
                   with_line_numbers(use_line_numbers?).to_s
        end

        def process_module
          if opts.present?(:all)
            all_modules
          else
            normal_module
          end
        end

        def normal_module
          mod = module_object

          file_name, line = mod.source_location
          set_file_and_dir_locals(file_name)
          code = Code.from_module(mod, module_start_line(mod)).with_line_numbers(use_line_numbers?).to_s
          result = ""
          result << "\n#{Pry::Helpers::Text.bold('From:')} #{file_name} @ line #{line}:\n"
          result << "#{Pry::Helpers::Text.bold('Number of lines:')} #{code.lines.count}\n\n"
          result << code
        end

        def all_modules
          mod = module_object

          result = ""
          result << "Found #{mod.number_of_candidates} candidates for `#{mod.name}` definition:\n"
          mod.number_of_candidates.times do |v|
            begin
              code = Code.new(mod.source_for_candidate(v), module_start_line(mod, v)).with_line_numbers(use_line_numbers?).to_s
              result << "\nCandidate #{v+1}/#{mod.number_of_candidates}: #{mod.source_file_for_candidate(v)} @ line #{mod.source_line_for_candidate(v)}:\n"
              result << "Number of lines: #{code.lines.count}\n\n"
              result << code
            rescue Pry::RescuableException
              next
            end
          end
          result
        end

        def use_line_numbers?
          opts.present?(:b) || opts.present?(:l)
        end

        def start_line
          if opts.present?(:'base-one')
            1
          else
            method_object.source_line || 1
          end
        end
      end

      alias_command "show-method", "show-source"
      alias_command "$", "show-source"

      command "show-command", "Show the source for CMD." do |*args|
        target = target()

        opts = Slop.parse!(args) do |opt|
          opt.banner unindent <<-USAGE
            Usage: show-command [OPTIONS] [CMD]
            Show the source for command CMD.
            e.g: show-command show-method
          USAGE

          opt.on :l, "line-numbers", "Show line numbers."
          opt.on :f, :flood, "Do not use a pager to view text longer than one screen."
          opt.on :h, :help, "This message." do
            output.puts opt.help
          end
        end

        next if opts.present?(:help)

        command_name = args.shift
        if !command_name
          raise CommandError, "You must provide a command name."
        end

        if find_command(command_name)
          block = Pry::Method.new(find_command(command_name).block)

          next unless block.source
          set_file_and_dir_locals(block.source_file)

          output.puts make_header(block)
          output.puts

          code = Code.from_method(block).with_line_numbers(opts.present?(:'line-numbers')).to_s

          render_output(code, opts)
        else
          raise CommandError, "No such command: #{command_name}."
        end
      end

      create_command "ri", "View ri documentation. e.g `ri Array#each`" do
        banner <<-BANNER
          Usage: ri [spec]
          e.g. ri Array#each

          Relies on the rdoc gem being installed. See also: show-doc.
        BANNER

        def process(spec)
          # Lazily load RI
          require 'rdoc/ri/driver'

          unless defined? RDoc::RI::PryDriver

            # Subclass RI so that it formats its output nicely, and uses `lesspipe`.
            subclass = Class.new(RDoc::RI::Driver) # the hard way.

            subclass.class_eval do
              def page
                Pry::Helpers::BaseHelpers.lesspipe {|less| yield less}
              end

              def formatter(io)
                if @formatter_klass then
                  @formatter_klass.new
                else
                  RDoc::Markup::ToAnsi.new
                end
              end
            end

            RDoc::RI.const_set :PryDriver, subclass   # hook it up!
          end

          # Spin-up an RI insance.
          ri = RDoc::RI::PryDriver.new :use_stdout => true, :interactive => false

          begin
            ri.display_names [spec]  # Get the documentation (finally!)
          rescue RDoc::RI::Driver::NotFoundError => e
            output.puts "error: '#{e.name}' not found"
          end
        end

      end

    end
  end
end