Class: Rice::Doc::Mkdocs

Inherits:
Object
  • Object
show all
Defined in:
lib/rice/doc/mkdocs.rb

Constant Summary collapse

ESCAPE_METHODS = 
{'*' => '\*',
'+' => '\+',
'-' => '\-',
'.' => '\.',
'!' => '\!',
'|' => '\|',
'[]' => '\[\]',
'[]=' => '\[\]='}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(klasses, doc_resolvers, output) ⇒ Mkdocs

Returns a new instance of Mkdocs.



17
18
19
20
21
 
# File 'lib/rice/doc/mkdocs.rb', line 17

def initialize(klasses, doc_resolvers, output)
  @klasses = klasses
  @doc_resolvers = doc_resolvers
  @output = output
end

Instance Attribute Details

#klasses ⇒ Object (readonly)

Returns the value of attribute klasses.



15
16
17
 
# File 'lib/rice/doc/mkdocs.rb', line 15

def klasses
  @klasses
end

#output ⇒ Object (readonly)

Returns the value of attribute output.



15
16
17
 
# File 'lib/rice/doc/mkdocs.rb', line 15

def output
  @output
end

Instance Method Details

#attribute_sig(klass, native_attributes) ⇒ Object 



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/rice/doc/mkdocs.rb', line 220

def attribute_sig(klass, native_attributes)
  attr_type = if native_attributes.size == 2
                "read/write"
              elsif native_attributes.first.kind == NativeKind::AttributeReader
                "read"
              else
                "write"
              end

  native_attribute = native_attributes.first

  attribute_resolver = resolver(klass)
  attribute_url = attribute_resolver&.attribute_url(klass, native_attribute)

  type_url = type_url(native_attribute.return_klass)

  if attribute_url
    "[#{native_attribute.name}](#{attribute_url}): [#{native_attribute.return_klass}](#{type_url}) (#{attr_type})"
  else
    "#{native_attribute.name}: [#{native_attribute.return_klass}](#{type_url}) (#{attr_type})"
  end
end

#class_sig(klass) ⇒ Object 



105
106
107
108
109
110
111
112
113
114
 
# File 'lib/rice/doc/mkdocs.rb', line 105

def class_sig(klass)
  klass_name = klass.name.split("::").last

  url = resolver(klass)&.class_url(klass)
  if url
    "#[#{klass_name}](#{url})"
  else
    "##{klass_name}"
  end
end

#constructor_sig(klass, native) ⇒ Object 



188
189
190
191
192
193
194
195
196
 
# File 'lib/rice/doc/mkdocs.rb', line 188

def constructor_sig(klass, native)
  url =  resolver(klass)&.method_url(klass, native)

  if url
    "[initialize](#{url})(#{parameters_sig(klass, native)})"
  else
    "initialize(#{parameters_sig(klass, native)})"
  end
end

#create_indexes ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/rice/doc/mkdocs.rb', line 42

def create_indexes
  # Find all directories (including output root)
  directories = Dir.glob(File.join(@output, '**', '*')).select { |f| File.directory?(f) }
  directories.unshift(@output)

  directories.each do |dir|
    entries = []
    has_index = File.exist?(File.join(dir, 'index.md'))

    # Get all .md files in this directory (excluding index.md)
    Dir.glob(File.join(dir, '*.md')).each do |file|
      basename = File.basename(file)
      entries << basename unless basename == 'index.md'
    end

    # Get all subdirectories
    Dir.glob(File.join(dir, '*')).each do |path|
      if File.directory?(path)
        entries << File.basename(path)
      end
    end

    # Sort alphabetically
    entries.sort!

    # Prepend index.md if it exists
    entries.unshift('index.md') if has_index

    pages_path = File.join(dir, '.pages')
    File.open(pages_path, 'w') do |file|
      file << "nav:\n"
      entries.each do |entry|
        file << "  - #{entry}\n"
      end
    end
  end
end

#enum_sig(klass) ⇒ Object 



116
117
118
119
120
121
122
123
124
 
# File 'lib/rice/doc/mkdocs.rb', line 116

def enum_sig(klass)
  klass_name = klass.name.split("::").last
  url = resolver(klass)&.enum_url(klass)
  if url
    "#[#{klass_name} Enum](#{url})"
  else
    "##{klass_name} Enum"
  end
end

#enum_value_sig(klass, value) ⇒ Object 



126
127
128
129
130
131
132
133
134
 
# File 'lib/rice/doc/mkdocs.rb', line 126

def enum_value_sig(klass, value)
  url = resolver(klass)&.enum_value_url(klass, value)

  if url
    "[#{value}](#{url})"
  else
    "#{value}"
  end
end

#generate ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/rice/doc/mkdocs.rb', line 23

def generate
  FileUtils.mkdir_p(@output)

  klasses.sort_by(&:name).each.with_index do |klass, i|
    STDOUT << klass.name << " (" << i << "/" << klasses.count << ")" << "\n"
    if klass.instance_of?(Module)
      write_module(klass)
    elsif klass.cpp_class.match(/^enum/i)
      write_enum(klass)
    elsif klass.cpp_class.match(/^union/i)
      write_union(klass)
    else
      write_class(klass)
    end
  end

  create_indexes
end

#method_sig(klass, native, singleton) ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/rice/doc/mkdocs.rb', line 198

def method_sig(klass, native, singleton)
  url = if singleton
          resolver(klass)&.singleton_method_url(klass, native)
        else
          resolver(klass)&.method_url(klass, native)
        end

  name = ESCAPE_METHODS[native.name] || native.name

  parameters_string = if native.parameters.empty?
                        ""
                      else
                        "(#{parameters_sig(klass, native)})"
                      end

  if url
    "[#{name}](#{url})#{parameters_string} -> #{return_sig(klass, native)}"
  else
    "#{name}#{parameters_string} -> #{return_sig(klass, native)}"
  end
end

#method_sigs(klass, native_methods, method_sig) ⇒ Object 



146
147
148
149
150
 
# File 'lib/rice/doc/mkdocs.rb', line 146

def method_sigs(klass, native_methods, method_sig)
  native_methods.map do |native_method|
    method_sig(klass, native_method, method_sig)
  end.join("\n\n")
end

#output_path(klass) ⇒ Object 



80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/rice/doc/mkdocs.rb', line 80

def output_path(klass)
  parts = klass.name.split("::")
  path = if klass.instance_of?(Module)
           File.join(@output, *parts[0..-1], "index.md")
         else
           File.join(@output, *parts[0..-2], "#{parts.last}.md")
         end

  unless Dir.exist?(File.dirname(path))
    FileUtils.mkdir_p((File.dirname(path)))
  end
  path
end

#parameters_sig(klass, native) ⇒ Object 



168
169
170
171
172
173
174
175
176
177
 
# File 'lib/rice/doc/mkdocs.rb', line 168

def parameters_sig(klass, native)
  native.parameters.map do |parameter|
    url = type_url(parameter.klass)
    if url
      "#{parameter.arg.name}: [#{parameter.klass}](#{url})"
    else
      "#{parameter.arg.name}: #{parameter.klass}"
    end
  end.join(", ")
end

#resolver(klass) ⇒ Object 



94
95
96
97
98
99
100
101
102
103
 
# File 'lib/rice/doc/mkdocs.rb', line 94

def resolver(klass)
  parts = klass.name.split("::")
  key = if parts.length == 1 && !klass.instance_of?(Module)
          nil
        else
          parts.first
        end

  @doc_resolvers[key]
end

#return_sig(klass, native) ⇒ Object 



179
180
181
182
183
184
185
186
 
# File 'lib/rice/doc/mkdocs.rb', line 179

def return_sig(klass, native)
  url = type_url(native.return_klass)
  if url
    "[#{native.return_klass}](#{url})"
  else
    "#{native.return_klass}"
  end
end

#type_url(klass) ⇒ Object 



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/rice/doc/mkdocs.rb', line 152

def type_url(klass)
  resolver = resolver(klass)

  if klass.instance_of?(Module)
    resolver&.module_url(klass)
  elsif !klass.respond_to?(:cpp_class)
    resolver&.class_url(klass)
  elsif klass.cpp_class.match(/^enum/i)
    resolver&.enum_url(klass)
  elsif klass.cpp_class.match(/^union/i)
    resolver&.union_url(klass)
  else
    resolver&.class_url(klass)
  end
end

#union_sig(klass) ⇒ Object 



136
137
138
139
140
141
142
143
144
 
# File 'lib/rice/doc/mkdocs.rb', line 136

def union_sig(klass)
  klass_name = klass.name.split("::").last
  url =  resolver(klass)&.union_url(klass)
  if url
    "#[#{klass_name} Union](#{url})"
  else
    "##{klass_name} Union"
  end
end

#write_class(klass) ⇒ Object 



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/rice/doc/mkdocs.rb', line 258

def write_class(klass)
  native_attributes = Registries.instance.natives.native_attributes(klass).sort.group_by(&:name)
  native_singleton_functions = Registries.instance.natives.native_functions(klass.singleton_class).sort.group_by(&:name)
  native_methods = Registries.instance.natives.native_methods(klass).sort.group_by(&:name)

  path = output_path(klass)
  File.open(path, 'w') do |file|
    file << class_sig(klass) << "\n"

    # Singleton methods
    unless native_singleton_functions.empty?
      file << "## Singleton Methods" << "\n"
      native_singleton_functions.each do |name, natives|
        file << method_sigs(klass, natives, true) << "\n\n"
      end
      file << "\n"
    end

    # Constructors
    constructors = native_methods.delete("initialize")
    if constructors
      file << "## Constructors" << "\n"
      constructors.each do |constructor|
        file << constructor_sig(klass, constructor) << "\n\n"
      end
      file << "\n"
    end

    # Attributes
    unless native_attributes.empty?
      file << "## Attributes" << "\n"
      native_attributes.each do |name, natives|
        file << attribute_sig(klass, natives) << "\n\n"
      end
      file << "\n"
    end

    # Instance methods
    unless native_methods.empty?
      file << "## Methods" << "\n"
      native_methods.each do |name, natives|
        file << method_sigs(klass, natives, false) << "\n\n"
      end
      file << "\n"
    end
  end
end

#write_enum(klass) ⇒ Object 



306
307
308
309
310
311
312
313
314
315
 
# File 'lib/rice/doc/mkdocs.rb', line 306

def write_enum(klass)
  path = output_path(klass)
  File.open(path, 'w') do |file|
    file << enum_sig(klass) << "\n"
    file << "## Values" << "\n"
    klass.values.each do |value|
      file << "* " << enum_value_sig(klass, value) << "\n"
    end
  end
end

#write_module(a_module) ⇒ Object 



243
244
245
246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/rice/doc/mkdocs.rb', line 243

def write_module(a_module)
  native_singleton_functions = Registries.instance.natives.native_functions(a_module.singleton_class).sort.group_by(&:name)
  return if native_singleton_functions.empty?

  path = output_path(a_module)
  File.open(path, 'w') do |file|
    file << "#" << a_module.name << "\n"
     file << "## Singleton Methods" << "\n"
    native_singleton_functions.each do |name, natives|
      file << method_sigs(a_module, natives, false) << "\n\n"
    end
    file << "\n"
     end
end

#write_union(klass) ⇒ Object 



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/rice/doc/mkdocs.rb', line 317

def write_union(klass)
  native_attributes = Registries.instance.natives.native_attributes(klass).sort.group_by(&:name)

  path = output_path(klass)
  File.open(path, 'w') do |file|
    file << union_sig(klass) << "\n"

    # Attributes
    unless native_attributes.empty?
      file << "## Attributes" << "\n"
      native_attributes.each do |name, natives|
        file << attribute_sig(klass, natives) << "\n\n"
      end
      file << "\n"
    end
  end
end