Class: RDoc::RI::Writer

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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(base_dir) ⇒ Writer

Returns a new instance of Writer.



29
30
31
 
# File 'lib/rdoc/ri/writer.rb', line 29

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/writer.rb', line 6

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

.external_to_internal(name) ⇒ Object

And the reverse operation



25
26
27
 
# File 'lib/rdoc/ri/writer.rb', line 25

def self.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)



14
15
16
17
18
19
20
 
# File 'lib/rdoc/ri/writer.rb', line 14

def self.internal_to_external(name)
  if ''.respond_to? :ord then
    name.gsub(/\W/) { "%%%02x" % $&[0].ord }
  else
    name.gsub(/\W/) { "%%%02x" % $&[0] }
  end
end

Instance Method Details

#add_class(class_desc) ⇒ Object 



37
38
39
40
41
42
43
44
 
# File 'lib/rdoc/ri/writer.rb', line 37

def add_class(class_desc)
  dir = path_to_dir(class_desc.full_name)
  FileUtils.mkdir_p(dir)
  class_file_name = self.class.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 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/rdoc/ri/writer.rb', line 46

def add_method(class_desc, method_desc)
  dir = path_to_dir(class_desc.full_name)
  file_name = self.class.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 



33
34
35
 
# File 'lib/rdoc/ri/writer.rb', line 33

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