Class: IRB::ExtendCommand::ShowDoc

Inherits:
Nop show all
Defined in:
lib/irb/cmd/show_doc.rb

Direct Known Subclasses

Help

Instance Attribute Summary

Attributes inherited from Nop

#irb_context

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Nop

category, description, execute, #initialize

Constructor Details

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

Class Method Details

.transform_args(args) ⇒ Object 



9
10
11
12
13
14
15
16
 
# File 'lib/irb/cmd/show_doc.rb', line 9

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

#execute(*names) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/irb/cmd/show_doc.rb', line 22

def execute(*names)
  require 'rdoc/ri/driver'

  unless ShowDoc.const_defined?(:Ri)
    opts = RDoc::RI::Driver.process_args([])
    ShowDoc.const_set(:Ri, RDoc::RI::Driver.new(opts))
  end

  if names.empty?
    Ri.interactive
  else
    names.each do |name|
      begin
        Ri.display_name(name.to_s)
      rescue RDoc::RI::Error
        puts $!.message
      end
    end
  end

  nil
rescue LoadError, SystemExit
  warn "Can't display document because `rdoc` is not installed."
end