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:



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/jazzy/doc_builder.rb', line 57

def self.build(options)
  if options.sourcekitten_sourcefile
    stdout = options.sourcekitten_sourcefile.read
  else
    if options.podspec_configured
      pod_documenter = PodspecDocumenter.new(options.podspec)
      stdout = pod_documenter.sourcekitten_output(options)
    else
      stdout = Dir.chdir(options.source_directory) do
        arguments = SourceKitten.arguments_from_options(options)
        SourceKitten.run_sourcekitten(arguments)
      end
    end
    unless $?.success?
      warn 'Please pass in xcodebuild arguments using -x'
      warn 'If build arguments are correct, please file an issue on ' \
        'https://github.com/realm/jazzy/issues'
      exit $?.exitstatus || 1
    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



86
87
88
89
90
91
92
93
94
95
 
# File 'lib/jazzy/doc_builder.rb', line 86

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:



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/jazzy/doc_builder.rb', line 145

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

  prepare_output_dir(options.output, options.clean)

  puts "#{coverage}\% documentation coverage " \
    "with #{undocumented.count} undocumented symbol" \
    "#{undocumented.count == 1 ? '' : 's'}"

  unless options.skip_documentation
    build_site(docs, coverage, options)
  end

  write_lint_report(undocumented, options)
end

.build_site(docs, coverage, options) ⇒ Object 



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

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_assets(output_dir)

  DocsetBuilder.new(output_dir, source_module).build!

  download_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

.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



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

def self.color_for_coverage(coverage)
  if coverage < 10
    'red'
  elsif coverage < 30
    'orange'
  elsif coverage < 60
    'yellow'
  elsif coverage < 85
    'yellowgreen'
  elsif coverage < 90
    'green'
  else
    'brightgreen'
  end
end

.copy_assets(destination) ⇒ Object 



201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/jazzy/doc_builder.rb', line 201

def self.copy_assets(destination)
  assets_directory = Config.instance.theme_directory + 'assets'
  FileUtils.cp_r(assets_directory.children, destination)
  Pathname.glob(destination + 'css/**/*.scss').each do |scss|
    contents = scss.read
    css = Sass::Engine.new(contents, syntax: :scss).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 = 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?
        end).map do |sub_child|
          { name: "– #{sub_child.name}", url: sub_child.url }
        end
    end
    {
      section: doc.name,
      children: children,
    }
  end
end

.document(source_module, doc_model, path_to_root) ⇒ Object

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

Parameters:

  • options (Config) —

    Build options

  • doc_model (Hash) —

    Parsed doc. @see SourceKitten.parse

  • path_to_root (String)
  • doc_structure (Array) —

    doc structure comprised of section names and child names and URLs. @see doc_structure_for_docs



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/jazzy/doc_builder.rb', line 361

def self.document(source_module, doc_model, path_to_root)
  if doc_model.type.kind == 'document.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 = Markdown.render(alternative_abstract) + overview
  end

  doc = Doc.new # Mustache model instance
  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[:name] = doc_model.name
  doc[:kind] = doc_model.type.name
  doc[:dash_type] = doc_model.type.dash_type
  doc[:declaration] = doc_model.declaration
  doc[:overview] = overview
  doc[:structure] = source_module.doc_structure
  doc[:tasks] = render_tasks(source_module, doc_model.children)
  doc[:module_name] = source_module.name
  doc[:author_name] = source_module.author_name
  doc[:github_url] = source_module.github_url
  doc[:dash_url] = source_module.dash_url
  doc[:path_to_root] = path_to_root
  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:

  • options (Config) —

    Build options

  • doc_model (Hash) —

    Parsed doc. @see SourceKitten.parse

  • path_to_root (String)
  • doc_structure (Array) —

    doc structure comprised of section names and child names and URLs. @see doc_structure_for_docs



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/jazzy/doc_builder.rb', line 219

def self.document_markdown(source_module, doc_model, path_to_root)
  doc = Doc.new # Mustache model instance
  name = doc_model.name == 'index' ? source_module.name : doc_model.name
  doc[:name] = name
  doc[:overview] = Markdown.render(doc_model.content(source_module))
  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
  doc[:github_url] = source_module.github_url
  doc[:dash_url] = source_module.dash_url
  doc[:path_to_root] = path_to_root
  doc[:hide_name] = true
  doc.render
end

.download_badge(coverage, options) ⇒ Object

Downloads an SVG from shields.io displaying the documentation percentage

Parameters:

  • coverage (Number) —

    The documentation coverage percentage

  • options (Config) —

    Build options



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

def self.download_badge(coverage, options)
  return if options.hide_documentation_coverage || !options.download_badge

  warn 'downloading coverage badge'
  color = color_for_coverage(coverage)
  uri = URI.parse('https://img.shields.io')
  url_path = "/badge/documentation-#{coverage}%25-#{color}.svg"
  Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
    resp = http.get url_path
    File.open(options.output + 'badge.svg', 'wb') do |file|
      file.write resp.body
    end
  end
end

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



97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/jazzy/doc_builder.rb', line 97

def self.each_doc(output_dir, docs, &block)
  docs.each do |doc|
    next unless doc.render?
    # Assuming URL is relative to documentation root:
    path = output_dir + (doc.url || "#{doc.name}.html")
    block.call(doc, path)
    next if doc.name == 'index'
    each_doc(
      output_dir,
      doc.children,
      &block
    )
  end
end

.gh_token_url(item, source_module) ⇒ Object

Construct Github token URL

Parameters:

  • item (Hash) —

    Parsed doc child item

  • options (Config) —

    Build options



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/jazzy/doc_builder.rb', line 285

def self.gh_token_url(item, source_module)
  return unless github_prefix = source_module.github_file_prefix
  return unless should_link_to_github(item.file)
  gh_line = if item.start_line && (item.start_line != item.end_line)
              "#L#{item.start_line}-L#{item.end_line}"
            else
              "#L#{item.line}"
            end
  relative_file_path = item.file.realpath.relative_path_from(
    source_module.root_path,
  )
  "#{github_prefix}/#{relative_file_path}#{gh_line}"
end

.make_task(mark, uid, items) ⇒ Object 



324
325
326
327
328
329
330
331
332
 
# File 'lib/jazzy/doc_builder.rb', line 324

def self.make_task(mark, uid, items)
  {
    name: mark.name,
    uid: URI.encode(uid),
    items: items,
    pre_separator: mark.has_start_dash,
    post_separator: mark.has_end_dash,
  }
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 



166
167
168
169
170
171
172
173
 
# File 'lib/jazzy/doc_builder.rb', line 166

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_item(item, source_module) ⇒ Object

Build mustache item for a top-level doc

Parameters:

  • item (Hash) —

    Parsed doc child item

  • options (Config) —

    Build options



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/jazzy/doc_builder.rb', line 302

def self.render_item(item, source_module)
  # Combine abstract and discussion into abstract
  abstract = (item.abstract || '') + (item.discussion || '')
  item_render = {
    name:                       item.name,
    abstract:                   abstract,
    declaration:                item.declaration,
    other_language_declaration: item.other_language_declaration,
    usr:                        item.usr,
    dash_type:                  item.type.dash_type,
    github_token_url:           gh_token_url(item, source_module),
    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.children.any?),
    start_line:                 item.start_line,
    end_line:                   item.end_line,
  }
  item_render.reject { |_, v| v.nil? }
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



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/jazzy/doc_builder.rb', line 337

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)
  end
end

.should_link_to_github(file) ⇒ Object 



275
276
277
278
279
280
 
# File 'lib/jazzy/doc_builder.rb', line 275

def self.should_link_to_github(file)
  return unless file
  file = file.realpath.to_path
  source_directory = Config.instance.source_directory.to_path
  file.start_with?(source_directory)
end

.undocumented_warnings(decls) ⇒ Object 



175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/jazzy/doc_builder.rb', line 175

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 



187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/jazzy/doc_builder.rb', line 187

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], w[:line] || 0, w[:symbol], w[:symbol_kind]]
      end,
      source_directory: options.source_directory,
    }
    f.write(JSON.pretty_generate(lint_report))
  end
end