Class: Docbook::Output::Formats::DistFormat

Inherits:
BaseFormat
  • Object
show all
Defined in:
lib/docbook/output/formats/dist_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

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

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

  data_filename = "data/book.json"
  File.write(File.join(dir, data_filename), JSON.generate(guide))

  data_script = "window.DOCBOOK_DATA_SOURCE = '#{data_filename}'; window.DOCBOOK_FORMAT = 'dist';"
  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

#write_library(output_path, guides, manifest:, title: nil) ⇒ Object 



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

def write_library(output_path, guides, manifest:, title: nil)
  dir = ensure_directory(output_path)
  FileUtils.mkdir_p(File.join(dir, "data"))

  title ||= manifest.name || "DocBook Library"

  books_meta = manifest.books.each_with_index.map do |book, i|
    guide = guides[i]
    data_filename = "data/#{book.id}.json"
    File.write(File.join(dir, data_filename), JSON.generate(guide))

    meta = guide["meta"] || {}
    cover = resolve_cover_dist(book, guide, dir)

    {
      "id" => book.id,
      "title" => meta["title"] || book.title || book.id,
      "author" => book.author || meta["author"],
      "description" => book.description,
      "cover" => cover,
      "source" => data_filename,
    }.compact
  end

  collection = { "name" => title,
                 "description" => manifest.description, "books" => books_meta }
  data_script = "window.DOCBOOK_COLLECTION = #{safe_json(collection)}; window.DOCBOOK_FORMAT = 'dist';"
  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