Class: RI::RiWriter

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_dir) ⇒ RiWriter

Returns a new instance of RiWriter.



24
25
26
 
# File 'lib/rdoc/ri/ri_writer.rb', line 24

def initialize(base_dir)
  @base_dir = base_dir
end

Class Method Details

.class_desc_path(dir, class_desc) ⇒ Object 



6
7
8
 
# File 'lib/rdoc/ri/ri_writer.rb', line 6

def RiWriter.class_desc_path(dir, class_desc)
  File.join(dir, "cdesc-" + class_desc.name + ".yaml")
end

.external_to_internal(name) ⇒ Object

And the reverse operation



20
21
22
 
# File 'lib/rdoc/ri/ri_writer.rb', line 20

def RiWriter.external_to_internal(name)
  name.gsub(/%([0-9a-f]{2,2})/) { $1.to_i(16).chr }
end

.internal_to_external(name) ⇒ Object

Convert a name from internal form (containing punctuation) to an external form (where punctuation is replaced by %xx)



15
16
17
 
# File 'lib/rdoc/ri/ri_writer.rb', line 15

def RiWriter.internal_to_external(name)
  name.gsub(/\W/) { sprintf("%%%02x", $&[0]) }
end

Instance Method Details

#add_class(class_desc) ⇒ Object 



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

def add_class(class_desc)
  dir = path_to_dir(class_desc.full_name)
  FileUtils.mkdir_p(dir)
  class_file_name = RiWriter.class_desc_path(dir, class_desc)
  File.open(class_file_name, "w") do |f|
    f.write(class_desc.serialize)
  end
end

#add_method(class_desc, method_desc) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/rdoc/ri/ri_writer.rb', line 41

def add_method(class_desc, method_desc)
  dir = path_to_dir(class_desc.full_name)
  file_name = RiWriter.internal_to_external(method_desc.name)
  meth_file_name = File.join(dir, file_name)
  if method_desc.is_singleton
    meth_file_name += "-c.yaml"
  else
    meth_file_name += "-i.yaml"
  end

  File.open(meth_file_name, "w") do |f|
    f.write(method_desc.serialize)
  end
end

#remove_class(class_desc) ⇒ Object 



28
29
30
 
# File 'lib/rdoc/ri/ri_writer.rb', line 28

def remove_class(class_desc)
  FileUtils.rm_rf(path_to_dir(class_desc.full_name))
end