-
Notifications
You must be signed in to change notification settings - Fork 22
/
fdoc.fy
345 lines (273 loc) · 9.8 KB
/
fdoc.fy
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
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
79
80
81
82
83
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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
# Load all of fancy.
require: "boot"
class Fancy FDoc {
"""
FDoc is a tool to generate API documentation from Fancy source.
Works as follows:
1. We setup a handler to be invoked every time an object is set documentation
See fdoc_hook.fy, its loaded even before all of lib/rbx/*.fy so we can
Also have documentation for all fancy rubinius.
2. We load boot.fy, so we get documentation for all fancy's lib.
3. We run FDoc main
which can possibly load any file/directory you specify and optionally
run specs, effectively associating them with documented objects.
4. Generate output file.
Currently the plan is to output a json formatted object.
To be loaded by an html file and use jquery to build a GUI from it.
"""
OUTPUT_DIR = "doc/api/"
def self main {
"""
FDoc will load all .fy files you give to it, and optionally run
any specified FancySpec, and later produce documentation output.
"""
output_dir = OUTPUT_DIR
ARGV for_option: "-o" do: |d| { output_dir = d }
require("fileutils")
FileUtils mkdir_p(output_dir)
# Currently we just load any files given on ARGV.
ARGV each: |file| { Fancy CodeLoader load_compiled_file(file) }
# by now simply produce a apidoc/fancy.jsonp file.
json = JSON new: @documented_objects
json write: (File expand_path("fancy.jsonp", output_dir))
["Open your browser at " ++ output_dir ++ "index.html.",
" " ++ (json classes size) ++ " classes. ",
" " ++ (json methods size) ++ " methods. ",
" " ++ (json objects size) ++ " other objects. "] println
}
class JSON {
read_slots: ['classes, 'methods, 'blocks, 'objects]
def initialize: documented {
@documented_objects = documented
is_class = |o| { o kind_of?: Module }
is_method = |o| { o kind_of?: Rubinius CompiledMethod }
is_block = |o| { o kind_of?: Rubinius BlockEnvironment }
all_other = |o| {
[is_class, is_method, is_block] all?() |b| { b call: [o] == false }
}
@classes = @documented_objects keys select: is_class
@methods = @documented_objects keys select: is_method
@blocks = @documented_objects keys select: is_block
@objects = @documented_objects keys select: all_other
}
def string_to_json: obj { obj to_s inspect }
def symbol_to_json: obj { obj to_s }
def array_to_json: obj {
str = ["["]
obj each: |i| { str << $ to_json: i } in_between: { str << ", " }
str << ["]"]
str join
}
def hash_to_json: obj {
str = ["{"]
keys = obj keys
keys each: |i| {
str << $ to_json: i
str << ":"
str << $ to_json: (obj at: i)
} in_between: { str << ", " }
str << "}"
str join
}
def to_json: obj {
# Reimplement now we have pattern matching dispatch.
match obj {
case Hash -> hash_to_json: obj
case Array -> array_to_json: obj
case Symbol -> symbol_to_json: obj
case String -> string_to_json: obj
case Numeric -> obj
case nil -> "null"
case _ -> "Dont know how to convert " ++ (obj inspect) ++ " to JSON" raise!
}
}
def popuplate_methods: cls on: attr type: type known: methods {
cls send(type ++ "s", false) each: |n| {
mattr = <[]>
exec = cls send(type, n) executable()
methods delete(exec)
mdoc = Fancy Documentation for: exec
{ next } unless: mdoc # skip methods with no documentation
if: mdoc then: {
mattr['doc]: $ mdoc format: 'fdoc
if: (mdoc meta) then: {
mattr['arg]: $ mdoc meta at: 'argnames
}
}
if: (exec class() == Rubinius CompiledMethod) then: {
relative_file = exec file()
# HACK: We simply delete everything before lib/
# TODO: Fix, either use a -r (root) option or use __FILE__
relative_file = relative_file to_s gsub(/.*lib/, "lib")
lines = exec lines() to_a()
mattr['file]: $ relative_file
# TODO calculate line numbers from compiled method
# right now we only use the first line of code in the body.
mattr['lines]: $ [lines[3], lines[3]]
}
attr[(type ++ "s") intern()] [n]: mattr
}
}
def generate_map {
map = <['title => "Fancy Documentation", 'date => Time now() to_s(),
'classes => <[]>, 'methods => <[]>, 'objects => <[]> ]>
methods = @methods dup()
@classes each: |cls| {
name = cls name() gsub("::", " ")
doc = Fancy Documentation for: cls
attr = <[
'doc => doc format: 'fdoc,
'instance_methods => <[]>,
'methods => <[]>,
'ancestors => cls ancestors() map: |c| { c name() gsub("::", " ") }
]>
popuplate_methods: cls on: attr type: 'instance_method known: methods
popuplate_methods: cls on: attr type: 'method known: methods
map['classes][name]: attr
}
methods each: |cm| {
cls = cm scope() module()
cls_name = cls name() gsub("::", " ")
cls_attr = map['classes] at: cls_name
full_name = cls_name ++ "#" ++ (cm name())
doc = Fancy Documentation for: cm
attr = <[
'args => doc meta at: 'argnames,
'doc => doc format: 'fdoc
]>
map['methods][full_name]: attr
}
map
}
def write: filename call: name ("fancy.fdoc") {
map = generate_map
json = to_json: map
js = "(function() { " ++ name ++ "(" ++ json ++ "); })();"
File open: filename modes: ['write] with: |out| { out print: js }
}
}
class Formatter {
"""
A documentation formater intended to be used by @FDoc@.
This formatter makes some transformations on a docstring
and then converts it to html using markdown.
"""
Fancy Documentation formatter: 'fdoc is: |d| { format: d }
def self format: doc {
str = doc to_s
tags = <[ ]>
str = str skip_leading_indentation
str = remove_tags: str into: tags
str = create_tags: str with: tags
str = create_class_references: str
str = create_method_references: str
str = create_code: str
str = htmlize: str
str
}
def self create_class_references: str {
"""
Creates class references for Fancy class names.
A docstring may contain class names sorounded by @
without space between the @.
Nested classes can be indicated by using :: like
Foo::Bar
This will create references for both, @Foo and @Bar
Instance methods should be written:
Foo::Bar#baz
Class methods should be written:
Foo::Bar.baz
Some examples:
A simple class reference:
@Fancy@
Nested class reference:
@Fancy::FDoc@
A fancy method without arguments:
@Fancy::FDoc::JSON#:generate_map@
A ruby method reference (will link to ruby docs if available)
@String#split@
A fancy method with many arguments:
@Fancy::Package::Installer#initialize:version:install_path:@
A singleton method:
@Fancy::FDoc::Formatter~format:@
"""
str gsub(/@[A-Z][^\r\n\s]+?@/) |cstr| {
names = cstr slice(1, cstr size() - 2) split("::")
refs = []
names each_with_index() |name, idx| {
n = name split(/[\#\~]/)
clas = names take(idx) + [n[0]] . join(" ")
html = "<code data-lang=\"fancy\" data-class-ref=\"" ++ .
clas ++ "\" class=\"class-ref selectable\">" ++ (n[0]) ++ "</code>"
refs << html
# Generate a reference for last method if availble.
if: (n[1]) then: {
method = n[1]
if: (method start_with?(":")) then: {
method = method sub(/^:/, "")
}
sigil = ""
name =~ (Regexp.new("^#")) . if_true: { sigil = "<small>#</small>" }
type = n[1] include?(":") . if_true: {
if: (sigil == "") then: {
"singleton-method-ref"
} else: {
"instance-method-ref"
}
} else: {
if: (sigil == "") then: {
"ruby-singleton-method-ref"
} else: {
"ruby-instance-method-ref"
}
}
html = sigil ++ "<code data-lang=\"fancy\" data-" ++ type ++ "=\"" ++ .
(n[1]) ++ "\" " ++ " data-owner-class=\"" ++ clas ++ "\" " ++ .
"class=\"" ++ type ++ " selectable\">" ++ method ++ "</code>"
refs << html
}
}
refs join(" ")
}
}
def self remove_tags: str into: map {
ary = str split(/\r?\n/) map: |line| {
m = /^@([a-z@]\S+?)\s+(.*)/ match(line)
if: m then: {
map[m[1]]: (m[2])
nil
} else: {
line
}
}
ary compact join("\n")
}
def self create_tags: str with: map {
tags = map map: |pair| {
name = pair[0]
value = pair[1]
"<div class=\"doctag\"><label> @" ++ name ++ .
" </label><div>" ++ value ++ "</div></div>"
}
str ++ "\n<div class=\"doctags\">" ++ (tags join()) ++ "</div>"
}
def self create_code: str {
str gsub(/@([^\s,\]\)\}\.]+)/,
"<code data-lang=\"fancy\">\\1</code>")
}
def self htmlize: str {
require("rubygems")
require("rdiscount")
RDiscount new(str) to_html()
}
def self create_method_references: str {
# First methods ending with :
str gsub(/@([a-z_:]+:)@/,
"<code data-lang=\"fancy\" data-method=\"\\1\" class=\"selectable\">\\1</code>") .
# fancy methods starting with : (argless fancy methods)
gsub(/@:([a-z_]+)@/,
"<code data-lang=\"fancy\" data-method=\":\\1\" class=\"selectable\">\\1</code>")
}
}
}
Fancy FDoc main