Class: JsDuck::Renderer

Inherits:
Object
  • Object
show all
Defined in:
lib/jsduck/renderer.rb

Overview

Ruby-side implementation of class docs Renderer. Uses PhantomJS to run Docs.Renderer JavaScript.

Instance Method Summary collapse

Constructor Details

#initialize(opts) ⇒ Renderer

Returns a new instance of Renderer.



10
11
12
 
# File 'lib/jsduck/renderer.rb', line 10

def initialize(opts)
  @opts = opts
end

Instance Method Details

#render(cls) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/jsduck/renderer.rb', line 14

def render(cls)
    @cls = cls
    @signature = SignatureRenderer.new(cls)

    return [
      "<div>",
        render_sidebar,
        "<div class='doc-contents'>",
          render_meta_data(@cls[:html_meta], :top),
          render_private_class_notice,
          @cls[:doc],
          render_enum_class_notice,
          render_meta_data(@cls[:html_meta], :bottom),
        "</div>",
        "<div class='members'>",
          render_all_sections,
        "</div>",
      "</div>",
    ].flatten.compact.join
end

#render_all_sections ⇒ Object 



145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/jsduck/renderer.rb', line 145

def render_all_sections
  sections = [
    {:type => :property, :title => "Properties"},
    {:type => :method, :title => "Methods"},
    {:type => :event, :title => "Events"},
    {:type => :css_var, :title => "CSS Variables"},
    {:type => :css_mixin, :title => "CSS Mixins"},
  ]

  render_configs_section + sections.map {|sec| render_section(sec) }
end

#render_alternate_class_names ⇒ Object 



87
88
89
90
91
92
93
 
# File 'lib/jsduck/renderer.rb', line 87

def render_alternate_class_names
  return if @cls[:alternateClassNames].length == 0
  return [
    "<h4>Alternate names</h4>",
    @cls[:alternateClassNames].map {|name| "<div class='alternate-class-name'>#{name}</div>" },
  ]
end

#render_class_tree(classes, i = 0) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/jsduck/renderer.rb', line 127

def render_class_tree(classes, i=0)
  return "" if classes.length <= i

  name = classes[i]
  return [
    "<div class='subclass #{i == 0 ? 'first-child' : ''}'>",
      classes.length-1 == i ? "<strong>#{name}</strong>" : (name.exists? ? render_link(name) : name),
      render_class_tree(classes, i+1),
    "</div>",
  ]
end

#render_configs_section ⇒ Object 



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/jsduck/renderer.rb', line 157

def render_configs_section
  configs = @cls[:members][:cfg] + @cls[:statics][:cfg]

  if configs.length > 0
    required, optional = configs.partition {|c| c[:meta][:required] }
    return [
      "<div class='members-section'>",
        required.length == 0 ? "<div class='definedBy'>Defined By</div>" : "",
        "<h3 class='members-title icon-cfg'>Config options</h3>",
        render_subsection(required, "Required Config options"),
        render_subsection(optional, required.length > 0 ? "Optional Config options" : nil),
      "</div>",
    ]
  else
    return []
  end
end

#render_dependencies(type, title) ⇒ Object 



95
96
97
98
99
100
101
 
# File 'lib/jsduck/renderer.rb', line 95

def render_dependencies(type, title)
  return if !@cls[type] || @cls[type].length == 0
  return [
    "<h4>#{title}</h4>",
    @cls[type].map {|name| "<div class='dependency'>#{name.exists? ? render_link(name) : name}</div>" },
  ]
end

#render_enum_class_notice ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/jsduck/renderer.rb', line 44

def render_enum_class_notice
  return if !@cls[:enum]

  if @cls[:enum][:doc_only]
    first = @cls[:members][:property][0] || {:name => 'foo', :default => '"foo"'}
    [
      "<p class='enum'><strong>ENUM:</strong> ",
      "This enumeration defines a set of String values. ",
      "It exists primarily for documentation purposes - ",
      "in code use the actual string values like #{first[:default]}, ",
      "don't reference them through this class like #{@cls[:name]}.#{first[:name]}.</p>",
    ]
  else
    [
      "<p class='enum'><strong>ENUM:</strong> ",
      "This enumeration defines a set of #{@cls[:enum][:type]} values.</p>",
    ]
  end
end

#render_files ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/jsduck/renderer.rb', line 103

def render_files
  return if @cls[:files].length == 0 || @cls[:files][0][:filename] == ""
  return [
    "<h4>Files</h4>",
    @cls[:files].map do |file|
      url = "source/" + file[:href]
      title = File.basename(file[:filename])
      "<div class='dependency'><a href='#{url}' target='_blank'>#{title}</a></div>"
    end
  ]
end

#render_link(cls_name, member = nil) ⇒ Object 



139
140
141
142
143
 
# File 'lib/jsduck/renderer.rb', line 139

def render_link(cls_name, member=nil)
  id = member ? cls_name + "-" + member[:id] : cls_name
  label = member ? cls_name + "." + member[:name] : cls_name
  return "<a href='#!/api/#{id}' rel='#{id}' class='docClass'>#{label}</a>"
end

#render_long_doc(m) ⇒ Object 



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/jsduck/renderer.rb', line 247

def render_long_doc(m)
  doc = []

  doc << render_meta_data(m[:html_meta], :top)

  doc << m[:doc]

  if m[:default] && m[:default] != "undefined"
    doc << "<p>Defaults to: <code>" + Util::HTML.escape(m[:default]) + "</code></p>"
  end

  doc << render_meta_data(m[:html_meta], :bottom)

  doc << render_params_and_return(m)

  if m[:overrides]
    overrides = m[:overrides].map {|o| render_link(o[:owner], o) }.join(", ")
    doc << "<p>Overrides: #{overrides}</p>"
  end

  doc
end

#render_long_param(p) ⇒ Object 



313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/jsduck/renderer.rb', line 313

def render_long_param(p)
  return [
    "<li>",
      "<span class='pre'>#{p[:name]}</span> : ",
      p[:html_type],
      p[:optional] ? " (optional)" : "",
      "<div class='sub-desc'>",
        p[:doc],
        p[:default] ? "<p>Defaults to: <code>#{Util::HTML.escape(p[:default])}</code></p>" : "",
        p[:properties] && p[:properties].length > 0 ? render_params_and_return(p) : "",
      "</div>",
    "</li>",
  ]
end

#render_member(m, is_first) ⇒ Object 



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
 
# File 'lib/jsduck/renderer.rb', line 205

def render_member(m, is_first)
  # use classname "first-child" when it's first member in its category
  first_child = is_first ? "first-child" : ""
  # shorthand to owner class
  owner = m[:owner]
  # is this method inherited from parent?
  inherited = (owner != @cls[:name])

  return [
    "<div id='#{m[:id]}' class='member #{first_child} #{inherited ? 'inherited' : 'not-inherited'}'>",
      # leftmost column: expand button
      "<a href='#' class='side expandable'>",
        "<span>&nbsp;</span>",
      "</a>",
      # member name and type + link to owner class and source
      "<div class='title'>",
        "<div class='meta'>",
          inherited ? "<a href='#!/api/#{owner}' rel='#{owner}' class='defined-in docClass'>#{owner}</a>" :
                      "<span class='defined-in' rel='#{owner}'>#{owner}</span>",
          "<br/>",
          @opts.source ? "<a href='source/#{m[:files][0][:href]}' target='_blank' class='view-source'>view source</a>" : "",
        "</div>",
        # method params signature or property type signature
        render_signature(m),
      "</div>",
      # short and long descriptions
      "<div class='description'>",
        "<div class='short'>",
          m[:shortDoc] ? m[:shortDoc] : m[:doc],
        "</div>",
        "<div class='long'>",
          render_long_doc(m),
        "</div>",
      "</div>",
    "</div>",
  ]
end

#render_meta_data(meta_data, position) ⇒ Object 



64
65
66
 
# File 'lib/jsduck/renderer.rb', line 64

def render_meta_data(meta_data, position)
  MetaTagRenderer.render(meta_data, position)
end

#render_params_and_return(item) ⇒ Object

Handles both rendering of method parameters and return value. Plus the rendering of object properties, which could also be functions in which case they too will be rendered with parameters and return value.



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
 
# File 'lib/jsduck/renderer.rb', line 274

def render_params_and_return(item)
  doc = []

  if item[:params] && item[:params].length > 0
    params = item[:params]
  elsif item[:properties] && item[:properties].length > 0
    params = item[:properties]
    # If the name of last property is "return"
    # remove it from params list and handle it separately afterwards
    if params.last[:name] == "return"
      ret = params.last
      params = params.slice(0, params.length-1)
    end
  end

  if params
    if item[:type] == "Function" || item[:tagname] == :method || item[:tagname] == :event
      doc << '<h3 class="pa">Parameters</h3>'
    end
    doc << [
      "<ul>",
      params.map {|p| render_long_param(p) },
      "</ul>",
    ]
  end

  if item[:return]
    doc << render_return(item[:return])
  elsif ret
    doc << render_return(ret)
  end

  if item[:throws]
    doc << render_throws(item[:throws])
  end

  doc
end

#render_private_class_notice ⇒ Object 



35
36
37
38
39
40
41
42
 
# File 'lib/jsduck/renderer.rb', line 35

def render_private_class_notice
  return if !@cls[:private]
  return [
    "<p class='private'><strong>NOTE</strong> ",
    "This is a private utility class for internal use by the framework. ",
    "Don't rely on its existence.</p>",
  ]
end

#render_return(ret) ⇒ Object 



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/jsduck/renderer.rb', line 328

def render_return(ret)
  return if ret[:type] == "undefined"
  return [
    "<h3 class='pa'>Returns</h3>",
    "<ul>",
      "<li>",
        "<span class='pre'>#{ret[:html_type]}</span>",
        "<div class='sub-desc'>",
          ret[:doc],
          ret[:properties] && ret[:properties].length > 0 ? render_params_and_return(ret) : "",
        "</div>",
      "</li>",
    "</ul>",
  ]
end

#render_section(sec) ⇒ Object 



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/jsduck/renderer.rb', line 175

def render_section(sec)
  members = @cls[:members][sec[:type]]
  statics = @cls[:statics][sec[:type]]

  # Skip rendering empty sections
  if members.length > 0 || statics.length > 0
    return [
      "<div class='members-section'>",
        statics.length == 0 ? "<div class='definedBy'>Defined By</div>" : "",
        "<h3 class='members-title icon-#{sec[:type]}'>#{sec[:title]}</h3>",
        render_subsection(members, statics.length > 0 ? "Instance #{sec[:title]}" : nil),
        render_subsection(statics, "Static #{sec[:title]}"),
      "</div>",
    ]
  else
    return []
  end
end

#render_sidebar ⇒ Object 



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/jsduck/renderer.rb', line 68

def render_sidebar
  items = [
    render_alternate_class_names,
    render_tree,
    render_dependencies(:mixins, "Mixins"),
    render_dependencies(:parentMixins, "Inherited mixins"),
    render_dependencies(:requires, "Requires"),
    render_dependencies(:subclasses, "Subclasses"),
    render_dependencies(:mixedInto, "Mixed into"),
    render_dependencies(:uses, "Uses"),
    @opts.source ? render_files : nil,
  ]
  if items.compact.length > 0
    return ['<pre class="hierarchy">', items, '</pre>']
  else
    return nil
  end
end

#render_signature(m) ⇒ Object 



243
244
245
 
# File 'lib/jsduck/renderer.rb', line 243

def render_signature(m)
  @signature.render(m)
end

#render_subsection(members, title) ⇒ Object 



194
195
196
197
198
199
200
201
202
203
 
# File 'lib/jsduck/renderer.rb', line 194

def render_subsection(members, title)
  return if members.length == 0
  index = 0
  return [
    "<div class='subsection'>",
      title ? "<div class='definedBy'>Defined By</div><h4 class='members-subtitle'>#{title}</h3>" : "",
      members.map {|m| index += 1; render_member(m, index == 1) },
    "</div>",
  ]
end

#render_throws(throws) ⇒ Object 



344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/jsduck/renderer.rb', line 344

def render_throws(throws)
  return [
    "<h3 class='pa'>Throws</h3>",
    "<ul>",
      throws.map do |thr|
        [
          "<li>",
            "<span class='pre'>#{thr[:html_type]}</span>",
            "<div class='sub-desc'>#{thr[:doc]}</div>",
          "</li>",
        ]
      end,
    "</ul>",
  ]
end

#render_tree ⇒ Object

Take care of the special case where class has parent for which we have no docs. In that case the “extends” property exists but “superclasses” is empty. We still create the tree, but without links in it.



118
119
120
121
122
123
124
125
 
# File 'lib/jsduck/renderer.rb', line 118

def render_tree
  return if !@cls[:extends] || @cls[:extends] == "Object"

  return [
    "<h4>Hierarchy</h4>",
    render_class_tree(@cls[:superclasses] + [@cls[:name]])
  ]
end