Module: Jazzy::DocBuilder

Defined in:
lib/jazzy/doc_builder.rb,
lib/jazzy/docset_builder.rb

Overview

This module handles HTML generation, file writing, asset copying, and generally building docs given sourcekitten output

Defined Under Namespace

Classes: DocsetBuilder

Class Method Summary collapse

Class Method Details

.build(options) ⇒ SourceModule

Build documentation from the given options

Parameters:

Returns:



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/jazzy/doc_builder.rb', line 71

def self.build(options)
  if options.sourcekitten_sourcefile_configured
    stdout = "[#{options.sourcekitten_sourcefile.map(&:read).join(',')}]"
  elsif options.podspec_configured
    pod_documenter = PodspecDocumenter.new(options.podspec)
    stdout = pod_documenter.sourcekitten_output(options)
  elsif options.swift_build_tool == :symbolgraph
    stdout = SymbolGraph.build(options)
  else
    stdout = Dir.chdir(options.source_directory) do
      arguments = SourceKitten.arguments_from_options(options)
      SourceKitten.run_sourcekitten(arguments)
    end
  end

  build_docs_for_sourcekitten_output(stdout, options)
end

.build_docs(output_dir, docs, source_module) ⇒ Object

Build & write HTML docs to disk from structured docs array

Parameters:

  • output_dir (String) —

    Root directory to write docs

  • docs (Array) —

    Array of structured docs

  • options (Config) —

    Build options

  • doc_structure (Array) —

    @see #doc_structure_for_docs



94
95
96
97
98
99
100
101
102
103
 
# File 'lib/jazzy/doc_builder.rb', line 94

def self.build_docs(output_dir, docs, source_module)
  each_doc(output_dir, docs) do |doc, path|
    prepare_output_dir(path.parent, false)
    depth = path.relative_path_from(output_dir).each_filename.count - 1
    path_to_root = '../' * depth
    path.open('w') do |file|
      file.write(document(source_module, doc, path_to_root))
    end
  end
end

.build_docs_for_sourcekitten_output(sourcekitten_output, options) ⇒ SourceModule

Build docs given sourcekitten output

Parameters:

  • sourcekitten_output (String) —

    Output of sourcekitten command

  • options (Config) —

    Build options

Returns:



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/jazzy/doc_builder.rb', line 154

def self.build_docs_for_sourcekitten_output(sourcekitten_output, options)
  (docs, stats) = SourceKitten.parse(
    sourcekitten_output,
    options.min_acl,
    options.skip_undocumented,
    DocumentationGenerator.source_docs,
  )

  prepare_output_dir(options.output, options.clean)

  stats.report

  unless options.skip_documentation
    build_site(docs, stats.doc_coverage, options)
  end

  write_lint_report(stats.undocumented_decls, options)
end

.build_site(docs, coverage, options) ⇒ Object 



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
 
# File 'lib/jazzy/doc_builder.rb', line 120

def self.build_site(docs, coverage, options)
  warn 'building site'

  structure = doc_structure_for_docs(docs)

  docs << SourceDocument.make_index(options.readme_path)

  source_module = SourceModule.new(options, docs, structure, coverage)

  output_dir = options.output
  build_docs(output_dir, source_module.docs, source_module)

  unless options.disable_search
    warn 'building search index'
    SearchBuilder.build(source_module, output_dir)
  end

  copy_extensions(source_module, output_dir)
  copy_theme_assets(output_dir)

  DocsetBuilder.new(output_dir, source_module).build!

  generate_badge(source_module.doc_coverage, options)

  friendly_path = relative_path_if_inside(output_dir, Pathname.pwd)
  puts "jam out ♪♫ to your fresh new docs in `#{friendly_path}`"

  source_module
end

.children_for_doc(doc) ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/jazzy/doc_builder.rb', line 54

def self.children_for_doc(doc)
  doc.children
    .sort_by { |c| [c.nav_order, c.name, c.usr || ''] }
    .flat_map do |child|
    # FIXME: include arbitrarily nested extensible types
    [{ name: child.name, url: child.url }] +
      Array(child.children.select do |sub_child|
        sub_child.type.swift_extensible? || sub_child.type.extension?
      end).map do |sub_child|
        { name: "– #{sub_child.name}", url: sub_child.url }
      end
  end
end

.color_for_coverage(coverage) ⇒ Object

Returns the appropriate color for the provided percentage, used for generating a badge on shields.io

Parameters:

  • coverage (Number) —

    The documentation coverage percentage



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/jazzy/doc_builder.rb', line 278

def self.color_for_coverage(coverage)
  if coverage < 10
    'e05d44' # red
  elsif coverage < 30
    'fe7d37' # orange
  elsif coverage < 60
    'dfb317' # yellow
  elsif coverage < 85
    'a4a61d' # yellowgreen
  elsif coverage < 90
    '97CA00' # green
  else
    '4c1' # brightgreen
  end
end

.copy_extension(name, destination) ⇒ Object 



229
230
231
232
 
# File 'lib/jazzy/doc_builder.rb', line 229

def self.copy_extension(name, destination)
  ext_directory = Pathname(__dir__) / 'extensions' / name
  FileUtils.cp_r(ext_directory.children, destination)
end

.copy_extensions(source_module, destination) ⇒ Object 



222
223
224
225
226
227
 
# File 'lib/jazzy/doc_builder.rb', line 222

def self.copy_extensions(source_module, destination)
  if source_host = source_module.host&.extension
    copy_extension(source_host, destination)
  end
  copy_extension('katex', destination) if Markdown.has_math
end

.copy_theme_assets(destination) ⇒ Object 



211
212
213
214
215
216
217
218
219
220
 
# File 'lib/jazzy/doc_builder.rb', line 211

def self.copy_theme_assets(destination)
  assets_directory = Config.instance.theme_directory + 'assets'
  FileUtils.cp_r(assets_directory.children, destination)
  Pathname.glob(destination + 'css/**/*.scss').each do |scss|
    css = SassC::Engine.new(scss.read).render
    css_filename = scss.sub(/\.scss$/, '')
    css_filename.open('w') { |f| f.write(css) }
    FileUtils.rm scss
  end
end

.doc_structure_for_docs(docs) ⇒ Array

Generate doc structure to be used in sidebar navigation

Returns:

  • (Array) —

    doc structure comprised of section names & child names & URLs



34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/jazzy/doc_builder.rb', line 34

def self.doc_structure_for_docs(docs)
  docs
    .map do |doc|
      children = children_for_doc(doc)
      {
        section: doc.name,
        url: doc.url,
        children: children,
      }
    end
    .select do |structure|
      if Config.instance.hide_unlisted_documentation
        unlisted_prefix = Config.instance.custom_categories_unlisted_prefix
        structure[:section] != "#{unlisted_prefix}Guides"
      else
        true
      end
    end
end

.document(source_module, doc_model, path_to_root) ⇒ Object

rubocop:disable Metrics/MethodLength Build Mustache document from single parsed decl

Parameters:

  • module-wide (SourceModule) —

    settings

  • doc_model (Hash) —

    Parsed doc. @see SourceKitten.parse

  • path_to_root (String) 


413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
 
# File 'lib/jazzy/doc_builder.rb', line 413

def self.document(source_module, doc_model, path_to_root)
  if doc_model.type.markdown?
    return document_markdown(source_module, doc_model, path_to_root)
  end

  overview = (doc_model.abstract || '') + (doc_model.discussion || '')
  alternative_abstract = doc_model.alternative_abstract
  if alternative_abstract
    overview = render(doc_model, alternative_abstract) + overview
  end

  doc = new_document(source_module, doc_model)
  doc[:name] = doc_model.name
  doc[:kind] = doc_model.type.name
  doc[:dash_type] = doc_model.type.dash_type
  doc[:declaration] = doc_model.display_declaration
  doc[:language] = doc_model.display_language
  doc[:other_language_declaration] =
    doc_model.display_other_language_declaration
  doc[:overview] = overview
  doc[:parameters] = doc_model.parameters
  doc[:return] = doc_model.return
  doc[:tasks] = render_tasks(source_module, doc_model.children)
  doc[:path_to_root] = path_to_root
  doc[:deprecation_message] = doc_model.deprecation_message
  doc[:unavailable_message] = doc_model.unavailable_message
  doc[:usage_discouraged] = doc_model.usage_discouraged?
  doc.render.gsub(ELIDED_AUTOLINK_TOKEN, path_to_root)
end

.document_markdown(source_module, doc_model, path_to_root) ⇒ Object

Build Mustache document from a markdown source file

Parameters:

  • module-wide (SourceModule) —

    settings

  • doc_model (Hash) —

    Parsed doc. @see SourceKitten.parse

  • path_to_root (String) 


265
266
267
268
269
270
271
272
273
 
# File 'lib/jazzy/doc_builder.rb', line 265

def self.document_markdown(source_module, doc_model, path_to_root)
  doc = new_document(source_module, doc_model)
  name = doc_model.name == 'index' ? source_module.name : doc_model.name
  doc[:name] = name
  doc[:overview] = render(doc_model, doc_model.content(source_module))
  doc[:path_to_root] = path_to_root
  doc[:hide_name] = true
  doc.render.gsub(ELIDED_AUTOLINK_TOKEN, path_to_root)
end

.each_doc(output_dir, docs, &block) ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/jazzy/doc_builder.rb', line 105

def self.each_doc(output_dir, docs, &block)
  docs.each do |doc|
    next unless doc.render_as_page?

    # Filepath is relative to documentation root:
    path = output_dir + doc.filepath
    block.call(doc, path)
    each_doc(
      output_dir,
      doc.children,
      &block
    )
  end
end

.generate_badge(coverage, options) ⇒ Object

Generates an SVG similar to those from shields.io displaying the documentation percentage

Parameters:

  • coverage (Number) —

    The documentation coverage percentage

  • options (Config) —

    Build options



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
 
# File 'lib/jazzy/doc_builder.rb', line 300

def self.generate_badge(coverage, options)
  return if options.hide_documentation_coverage

  coverage_length = coverage.to_s.size.succ
  percent_string_length = coverage_length * 80 + 10
  percent_string_offset = coverage_length * 40 + 975
  width = coverage_length * 8 + 104
  svg = <<-SVG.gsub(/^ {8}/, '')
    <svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="#{width}" height="20">
      <linearGradient id="b" x2="0" y2="100%">
        <stop offset="0" stop-color="#bbb" stop-opacity=".1"/>
        <stop offset="1" stop-opacity=".1"/>
      </linearGradient>
      <clipPath id="a">
        <rect width="#{width}" height="20" rx="3" fill="#fff"/>
      </clipPath>
      <g clip-path="url(#a)">
        <path fill="#555" d="M0 0h93v20H0z"/>
        <path fill="##{color_for_coverage(coverage)}" d="M93 0h#{percent_string_length / 10 + 10}v20H93z"/>
        <path fill="url(#b)" d="M0 0h#{width}v20H0z"/>
      </g>
      <g fill="#fff" text-anchor="middle" font-family="DejaVu Sans,Verdana,Geneva,sans-serif" font-size="110">
        <text x="475" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="830">
          documentation
        </text>
        <text x="475" y="140" transform="scale(.1)" textLength="830">
          documentation
        </text>
        <text x="#{percent_string_offset}" y="150" fill="#010101" fill-opacity=".3" transform="scale(.1)" textLength="#{percent_string_length}">
          #{coverage}%
        </text>
        <text x="#{percent_string_offset}" y="140" transform="scale(.1)" textLength="#{percent_string_length}">
          #{coverage}%
        </text>
      </g>
    </svg>
  SVG

  badge_output = options.output + 'badge.svg'
  File.open(badge_output, 'w') { |f| f << svg }
end

.make_task(mark, uid, items, doc_model) ⇒ Object

rubocop:enable Metrics/MethodLength



377
378
379
380
381
382
383
384
385
386
 
# File 'lib/jazzy/doc_builder.rb', line 377

def self.make_task(mark, uid, items, doc_model)
  {
    name: mark.name,
    name_html: (render(doc_model, mark.name) if mark.name),
    uid: ERB::Util.url_encode(uid),
    items: items,
    pre_separator: mark.has_start_dash,
    post_separator: mark.has_end_dash,
  }
end

.new_document(source_module, doc_model) ⇒ Object

Build Mustache document - common fields between page types



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/jazzy/doc_builder.rb', line 240

def self.new_document(source_module, doc_model)
  Doc.new.tap do |doc|
    doc[:custom_head] = Config.instance.custom_head
    doc[:disable_search] = Config.instance.disable_search
    doc[:doc_coverage] = source_module.doc_coverage unless
      Config.instance.hide_documentation_coverage
    doc[:structure] = source_module.doc_structure
    doc[:module_name] = source_module.name
    doc[:author_name] = source_module.author_name
    if source_host = source_module.host
      doc[:source_host_name] = source_host.name
      doc[:source_host_url] = source_host.url
      doc[:source_host_image] = source_host.image
      doc[:source_host_item_url] = source_host.item_url(doc_model)
      doc[:github_url] = doc[:source_host_url]
      doc[:github_token_url] = doc[:source_host_item_url]
    end
    doc[:dash_url] = source_module.dash_url
  end
end

.prepare_output_dir(output_dir, clean) ⇒ Object

mkdir -p output directory and clean if option is set



26
27
28
29
 
# File 'lib/jazzy/doc_builder.rb', line 26

def self.prepare_output_dir(output_dir, clean)
  FileUtils.rm_r output_dir if clean && output_dir.directory?
  FileUtils.mkdir_p output_dir
end

.relative_path_if_inside(path, base_path) ⇒ Object 



173
174
175
176
177
178
179
180
 
# File 'lib/jazzy/doc_builder.rb', line 173

def self.relative_path_if_inside(path, base_path)
  relative = path.relative_path_from(base_path)
  if relative.to_path =~ %r{/^..(/|$)/}
    path
  else
    relative
  end
end

.render(doc_model, markdown) ⇒ Object 



234
235
236
237
 
# File 'lib/jazzy/doc_builder.rb', line 234

def self.render(doc_model, markdown)
  html = Markdown.render(markdown)
  SourceKitten.autolink_document(html, doc_model)
end

.render_item(item, source_module) ⇒ Object

Build mustache item for a top-level doc rubocop:disable Metrics/MethodLength

Parameters:

  • item (Hash) —

    Parsed doc child item

  • options (Config) —

    Build options



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/jazzy/doc_builder.rb', line 347

def self.render_item(item, source_module)
  # Combine abstract and discussion into abstract
  abstract = (item.abstract || '') + (item.discussion || '')
  source_host_item_url = source_module.host&.item_url(item)
  {
    name: item.name,
    name_html: item.name.gsub(':', ':<wbr>'),
    abstract: abstract,
    declaration: item.display_declaration,
    language: item.display_language,
    other_language_declaration: item.display_other_language_declaration,
    usr: item.usr,
    dash_type: item.type.dash_type,
    source_host_item_url: source_host_item_url,
    github_token_url: source_host_item_url,
    default_impl_abstract: item.default_impl_abstract,
    from_protocol_extension: item.from_protocol_extension,
    return: item.return,
    parameters: (item.parameters if item.parameters.any?),
    url: (item.url if item.render_as_page?),
    start_line: item.start_line,
    end_line: item.end_line,
    direct_link: item.omit_content_from_parent?,
    deprecation_message: item.deprecation_message,
    unavailable_message: item.unavailable_message,
    usage_discouraged: item.usage_discouraged?,
  }
end

.render_tasks(source_module, children) ⇒ Object

Render tasks for Mustache document

Parameters:

  • options (Config) —

    Build options

  • doc_model (Hash) —

    Parsed doc. @see SourceKitten.parse



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/jazzy/doc_builder.rb', line 391

def self.render_tasks(source_module, children)
  marks = children.map(&:mark).uniq.compact
  mark_names_counts = {}
  marks.map do |mark|
    mark_children = children.select { |child| child.mark == mark }
    items = mark_children.map { |child| render_item(child, source_module) }
    uid = (mark.name || 'Unnamed').to_s
    if mark_names_counts.key?(uid)
      mark_names_counts[uid] += 1
      uid += (mark_names_counts[uid]).to_s
    else
      mark_names_counts[uid] = 1
    end
    make_task(mark, uid, items, mark_children.first)
  end
end

.undocumented_warnings(decls) ⇒ Object 



182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/jazzy/doc_builder.rb', line 182

def self.undocumented_warnings(decls)
  decls.map do |decl|
    {
      file: decl.file,
      line: decl.line || decl.start_line,
      symbol: decl.fully_qualified_name,
      symbol_kind: decl.type.kind,
      warning: 'undocumented',
    }
  end
end

.write_lint_report(undocumented, options) ⇒ Object 



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/jazzy/doc_builder.rb', line 194

def self.write_lint_report(undocumented, options)
  (options.output + 'undocumented.json').open('w') do |f|
    warnings = undocumented_warnings(undocumented)

    lint_report = {
      warnings: warnings.sort_by do |w|
        [w[:file] || Pathname(''),
         w[:line] || 0,
         w[:symbol],
         w[:symbol_kind]]
      end,
      source_directory: options.source_directory,
    }
    f.write(JSON.pretty_generate(lint_report))
  end
end