Class: Pry::Command::Ri

Inherits:
Pry::ClassCommand show all
Defined in:
lib/pry/commands/ri.rb

Constant Summary

Constants inherited from Pry::Command

VOID_VALUE

Constants included from Helpers::DocumentationHelpers

Helpers::DocumentationHelpers::YARD_TAGS

Constants included from Helpers::Text

Helpers::Text::COLORS

Instance Attribute Summary

Attributes inherited from Pry::ClassCommand

#args, #opts

Attributes inherited from Pry::Command

#arg_string, #captures, #command_block, #command_set, #context, #eval_string, #hooks, #output, #pry_instance, #target

Instance Method Summary collapse

Methods inherited from Pry::ClassCommand

#call, #complete, doc, #help, inherited, #options, #setup, #slop, source, source_file, source_line, source_location, #subcommands

Methods inherited from Pry::Command

#_pry_, banner, #block, #check_for_command_collision, command_name, #command_name, #command_options, command_regex, #commands, #complete, convert_to_regex, default_options, #description, doc, group, #initialize, inspect, #interpolate_string, #match, match_score, matches?, name, #name, options, #process_line, #run, source, #source, source_file, source_line, state, #state, subclass, #target_self, #tokenize, #void

Methods included from Helpers::DocumentationHelpers

get_comment_content, process_comment_markup, process_rdoc, process_yardoc, process_yardoc_tag, strip_comments_from_c_code, strip_leading_whitespace

Methods included from Pry::CodeObject::Helpers

#c_method?, #c_module?, #command?, #module_with_yard_docs?, #real_method_object?

Methods included from Helpers::Text

#bold, #default, #indent, #no_color, #no_pager, #strip_color, #with_line_numbers

Methods included from Helpers::CommandHelpers

#absolute_index_number, #absolute_index_range, #get_method_or_raise, #internal_binding?, #one_index_number, #one_index_range, #one_index_range_or_number, #restrict_to_lines, #set_file_and_dir_locals, #temp_file, #unindent

Methods included from Helpers::OptionsHelpers

method_object, method_options

Methods included from Helpers::BaseHelpers

#colorize_code, #find_command, #heading, #highlight, #not_a_real_file?, #safe_send, #silence_warnings, #stagger_output, #use_ansi_codes?

Constructor Details

This class inherits a constructor from Pry::Command

Instance Method Details

#process(spec) ⇒ Object 



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
 
# File 'lib/pry/commands/ri.rb', line 21

def process(spec)
  unless spec
    return output.puts(
      "Please provide a class, module, or method name (e.g: ri Array#push)"
    )
  end

  # 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 initialize(pager, opts)
        @pager = pager
        super opts
      end

      def page
        paging_text = StringIO.new
        yield paging_text
        @pager.page(paging_text.string)
      end

      def formatter(_io)
        if @formatter_klass
          @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 instance.
  ri = RDoc::RI::PryDriver.new(
    pry_instance.pager, 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