Class: Docbook::Output::Formats::ChunkedFormat

Inherits:
BaseFormat
  • Object
show all
Defined in:
lib/docbook/output/formats/chunked_format.rb

Constant Summary

Constants inherited from BaseFormat

BaseFormat::DEFAULT_DIST_DIR

Instance Attribute Summary

Attributes inherited from BaseFormat

#dist_dir

Instance Method Summary collapse

Methods inherited from BaseFormat

default_dist_dir, #initialize, #write_library

Constructor Details

This class inherits a constructor from Docbook::Output::Formats::BaseFormat

Instance Method Details

#write(output_path, guide, title: "DocBook", _manifest: nil) ⇒ Object 



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
 
# File 'lib/docbook/output/formats/chunked_format.rb', line 9

def write(output_path, guide, title: "DocBook", _manifest: nil)
  dir = ensure_directory(output_path)
  FileUtils.mkdir_p(File.join(dir, "sections"))

  sections = split_into_chunks(guide["content"] || [])
  # Assign stable IDs to chunks that have no section boundary (nil ids)
  sections.each_with_index do |chunk, i|
    chunk[0] ||= "chunk-#{i + 1}"
  end
  section_ids = sections.map { |(id, _)| id }

  sections.each_with_index do |(section_id, nodes), i|
    section_data = {
      "id" => section_id,
      "content" => nodes,
      "next" => section_ids[i + 1],
      "prev" => i.positive? ? section_ids[i - 1] : nil,
    }
    File.write(File.join(dir, "sections", "#{section_id}.json"),
               JSON.generate(section_data))
  end

  manifest = {
    "meta" => guide["meta"] || {},
    "toc" => guide["toc"] || {},
    "total_sections" => sections.size,
    "section_ids" => section_ids,
  }
  File.write(File.join(dir, "manifest.json"), JSON.generate(manifest))

  data_script = "window.DOCBOOK_FORMAT = 'chunked'; window.DOCBOOK_MANIFEST = 'manifest.json';"
  html = html_boilerplate(title: title, body_content: '<div id="docbook-app"></div>',
                          script_data: data_script)
  File.write(File.join(dir, "index.html"), html)
  copy_service_worker(dir)
  dir
end