pry--pry/lib/pry/commands/show_doc.rb

class Pry
  Pry::Commands.create_command "show-doc" do
    include Pry::Helpers::DocumentationHelpers
    extend  Pry::Helpers::BaseHelpers

    group 'Introspection'
    description "Show the documentation for a method or class. Aliases: \?"
    command_options :shellwords => false
    command_options :requires_gem => "ruby18_source_location" if mri_18?

    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

    def setup
      require 'ruby18_source_location' if mri_18?
    end

    def options(opt)
      opt.on :s, :super, "Select the 'super' method. Can be repeated to traverse the ancestors.", :as => :count
      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
      code_object = Pry::CodeObject.lookup obj_name, target, _pry_, :super => opts[:super]

      if !code_object
        raise Pry::CommandError, "Couldn't locate #{obj_name}!"
      end

      if code_object.is_a?(Pry::WrappedModule) && opts.present?(:all)
        # show all monkey patches for a module
        # docs_for_all_modules_candidates writes its own headers
        result = docs_for_all_module_candidates(code_object)
      else
        # show the source for a specific code object
        result = header(code_object)
          result << Code.new(render_doc_markup_for(code_object),
                             opts.present?(:b) ? 1 : start_line_for(code_object),
                             :text).
          with_line_numbers(use_line_numbers?).to_s
        set_file_and_dir_locals(code_object.source_file)
      end

      stagger_output result
    end

    # simple utility function to piece together the name of the object
    # passed in from the arg list
    def obj_name
      @obj_name ||= args.empty? ? nil : args.join(" ")
    end

    # process the markup (if necessary) and apply colors
    def render_doc_markup_for(code_object)
      docs = docs_for(code_object)

      if code_object_is_command?(code_object)
        # command 'help' doesn't want markup highlighting
        docs
      else
        process_comment_markup(docs)
      end
    end

    # Return docs for the code_object, adjusting for whether the code_object
    # has yard docs available, in which case it returns those.
    # (note we only have to check yard docs for modules since they can
    # have multiple docs, but methods can only be doc'd once so we
    # dont need to check them)
    def docs_for(code_object)
      if code_object.is_a?(WrappedModule) && code_object.yard_docs?
        # yard docs
        code_object.yard_doc
      else
        # normal docs (i.e comments above method/module/command)
        code_object.doc
      end
    end

    # we need this helper as some Pry::Method objects can wrap Procs
    # @return [Boolean]
    def real_method_object?(code_object)
      code_object.is_a?(::Method) || code_object.is_a?(::UnboundMethod)
    end

    # takes into account possible yard docs, and returns yard_file / yard_line
    # Also adjusts for start line of comments (using start_line_for), which it has to infer
    # by subtracting number of lines of comment from start line of code_object
    def file_and_line_for(code_object)
      if code_object.is_a?(WrappedModule) && code_object.yard_docs?
        [code_object.yard_file, code_object.yard_line]
      else
        [code_object.source_file, start_line_for(code_object)]
      end
    end

    # Generate a header (meta-data information) for all the code
    # object types: methods, modules, commands, procs...
    def header(code_object)
      file_name, line_num = file_and_line_for(code_object)
      h = "\n#{Pry::Helpers::Text.bold('From:')} #{file_name} "
      if real_method_object?(code_object) && code_object.source_type == :c
        h << "(C Method):"
      else
        h << "@ line #{line_num}:"
      end

      if real_method_object?(code_object)
        h << "\n#{text.bold("Owner:")} #{code_object.owner || "N/A"}\n"
        h << "#{text.bold("Visibility:")} #{code_object.visibility}\n"
        h << "#{text.bold("Signature:")} #{code_object.signature}"
      end
      h << "\n#{Pry::Helpers::Text.bold('Number of lines:')} " <<
        "#{docs_for(code_object).lines.count}\n\n"
    end

    def docs_for_all_module_candidates(mod)
      result = "Found #{mod.number_of_candidates} candidates for `#{mod.name}` definition:\n"
      mod.number_of_candidates.times do |v|
        candidate = mod.candidate(v)
        begin
          result << "\nCandidate #{v+1}/#{mod.number_of_candidates}: #{candidate.source_file} @ line #{candidate.source_line}:\n"
          doc = Code.new(render_doc_markup_for(candidate),
                         opts.present?(:b) ? 1 : candidate.source_line,
                         :text).with_line_numbers(use_line_numbers?).to_s
          result << "Number of lines: #{doc.lines.count}\n\n" << doc
        rescue Pry::RescuableException
          result << "\nNo code found.\n"
          next
        end
      end
      result
    end

    def code_object_is_command?(code_object)
      code_object.is_a?(Module) && code_object <= Pry::Command
    end

    # figure out start line of docs by back calculating based on
    # number of lines in the comment and the start line of the code_object
    # @return [Fixnum] start line of docs
    def start_line_for(code_object)
      if code_object_is_command?(code_object)
         1
      else
        code_object.source_line.nil? ? 1 :
          (code_object.source_line - code_object.doc.lines.count)
      end
    end

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

    def complete(input)
      if input =~ /([^ ]*)#([a-z0-9_]*)\z/
        prefix, search = [$1, $2]
        methods = begin
                    Pry::Method.all_from_class(binding.eval(prefix))
                  rescue RescuableException => e
                    return super
                  end
        methods.map do |method|
          [prefix, method.name].join('#') if method.name.start_with?(search)
        end.compact
      else
        super
      end
    end
  end
  Pry::Commands.alias_command "?", "show-doc"
end