Class: RI::RiReader

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

Instance Method Summary collapse

Constructor Details

#initialize(ri_cache) ⇒ RiReader

Returns a new instance of RiReader.



8
9
10
 
# File 'lib/rdoc/ri/ri_reader.rb', line 8

def initialize(ri_cache)
  @cache = ri_cache
end

Instance Method Details

#all_names ⇒ Object

return a list of all classes, modules, and methods



71
72
73
74
 
# File 'lib/rdoc/ri/ri_reader.rb', line 71

def all_names
  res = []
  find_names_in(res, @cache.toplevel)
end

#find_class_by_name(full_name) ⇒ Object 



24
25
26
27
28
29
30
31
32
 
# File 'lib/rdoc/ri/ri_reader.rb', line 24

def find_class_by_name(full_name)
  names = full_name.split(/::/)
  ns = @cache.toplevel
  for name in names
    ns = ns.contained_class_named(name)
    return nil if ns.nil?
  end
  get_class(ns)
end

#find_methods(name, is_class_method, namespaces) ⇒ Object 



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

def find_methods(name, is_class_method, namespaces)
  result = []
  namespaces.each do |ns|
    result.concat ns.methods_matching(name, is_class_method)
  end
  result
end

#full_class_names ⇒ Object

return the names of all classes and modules



65
66
67
68
 
# File 'lib/rdoc/ri/ri_reader.rb', line 65

def full_class_names
  res = []
  find_classes_in(res, @cache.toplevel)
end

#get_class(class_entry) ⇒ Object

Return a class description



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

def get_class(class_entry)
  result = nil
  for path in class_entry.path_names
    path = RiWriter.class_desc_path(path, class_entry)
    desc = File.open(path) {|f| RI::Description.deserialize(f) }
    if result
      result.merge_in(desc)
    else
      result = desc
    end
  end
  result
end

#get_method(method_entry) ⇒ Object

return the MethodDescription for a given MethodEntry by deserializing the YAML



44
45
46
47
 
# File 'lib/rdoc/ri/ri_reader.rb', line 44

def get_method(method_entry)
  path = method_entry.path_name
  File.open(path) { |f| RI::Description.deserialize(f) }
end

#lookup_namespace_in(target, namespaces) ⇒ Object 



16
17
18
19
20
21
22
 
# File 'lib/rdoc/ri/ri_reader.rb', line 16

def lookup_namespace_in(target, namespaces)
  result = []
  for n in namespaces
    result.concat(n.contained_modules_matching(target))
  end
  result
end

#top_level_namespace ⇒ Object 



12
13
14
 
# File 'lib/rdoc/ri/ri_reader.rb', line 12

def top_level_namespace
  [ @cache.toplevel ]
end