Class: RiDriver

Inherits:
Object
  • Object
show all
Defined in:
lib/rdoc/ri/ri_driver.rb

Overview

####################################################################

Instance Method Summary collapse

Constructor Details

#initialize ⇒ RiDriver

Returns a new instance of RiDriver.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
 
# File 'lib/rdoc/ri/ri_driver.rb', line 14

def initialize
  @options = RI::Options.instance

  args = ARGV
  if ENV["RI"]
    args = ENV["RI"].split.concat(ARGV)
  end

  @options.parse(args)

  path = @options.path
  report_missing_documentation @options.raw_path if path.empty?

  @ri_reader = RI::RiReader.new(RI::RiCache.new(path))
  @display   = @options.displayer
end

Instance Method Details

#get_info_for(arg) ⇒ Object 



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
115
116
 
# File 'lib/rdoc/ri/ri_driver.rb', line 84

def get_info_for(arg)
  desc = NameDescriptor.new(arg)

  namespaces = @ri_reader.top_level_namespace
  
  for class_name in desc.class_names
    namespaces = @ri_reader.lookup_namespace_in(class_name, namespaces)
    if namespaces.empty?
      raise RiError.new("Nothing known about #{arg}")
    end
  end

  # at this point, if we have multiple possible namespaces, but one
  # is an exact match for our requested class, prune down to just it

  full_class_name = desc.full_class_name
  entries = namespaces.find_all {|m| m.full_name == full_class_name}
  namespaces = entries if entries.size == 1

  if desc.method_name.nil?
    report_class_stuff(namespaces)
  else
    methods = @ri_reader.find_methods(desc.method_name, 
                                      desc.is_class_method,
                                      namespaces)

    if methods.empty?
      raise RiError.new("Nothing known about #{arg}")
    else
      report_method_stuff(desc.method_name, methods)
    end
  end
end

#process_args ⇒ Object

####################################################################



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/rdoc/ri/ri_driver.rb', line 120

def process_args
  if @options.list_classes
    classes = @ri_reader.full_class_names
    @display.list_known_classes(classes)
  elsif @options.list_names
    names = @ri_reader.all_names
    @display.list_known_names(names)
  else
    if ARGV.size.zero?
      @display.display_usage
    else
      begin
        ARGV.each do |arg|
          get_info_for(arg)
        end
      rescue RiError => e
        STDERR.puts(e.message)
        exit(1)
      end
    end
  end
end

#report_class_stuff(namespaces) ⇒ Object

####################################################################



66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/rdoc/ri/ri_driver.rb', line 66

def report_class_stuff(namespaces)
  if namespaces.size == 1
    klass = @ri_reader.get_class(namespaces[0])
    @display.display_class_info(klass, @ri_reader)
  else 
#      entries = namespaces.find_all {|m| m.full_name == requested_class_name}
#      if entries.size == 1
#        klass = @ri_reader.get_class(entries[0])
#        @display.display_class_info(klass, @ri_reader)
#      else
      @display.display_class_list(namespaces)
#      end
  end
end

#report_method_stuff(requested_method_name, methods) ⇒ Object

If the list of matching methods contains exactly one entry, or if it contains an entry that exactly matches the requested method, then display that entry, otherwise display the list of matching method names



49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/rdoc/ri/ri_driver.rb', line 49

def report_method_stuff(requested_method_name, methods)
  if methods.size == 1
    method = @ri_reader.get_method(methods[0])
    @display.display_method_info(method)
  else
    entries = methods.find_all {|m| m.name == requested_method_name}
    if entries.size == 1
      method = @ri_reader.get_method(entries[0])
      @display.display_method_info(method)
    else
      @display.display_method_list(methods)
    end
  end
end

#report_missing_documentation(path) ⇒ Object

Couldn't find documentation in path, so tell the user what to do



33
34
35
36
37
38
39
40
 
# File 'lib/rdoc/ri/ri_driver.rb', line 33

def report_missing_documentation(path)
  STDERR.puts "No ri documentation found in:"
  path.each do |d|
    STDERR.puts "     #{d}"
  end
  STDERR.puts "\nWas rdoc run to create documentation?\n\n"
  RDoc::usage("Installing Documentation")
end