Class: Metanorma::CollectionRenderer

Inherits:
Object
  • Object
show all
Defined in:
lib/metanorma/collection_renderer.rb

Overview

XML collection renderer

Defined Under Namespace

Classes: Dummy

Constant Summary collapse

FORMATS = 
i[html xml doc pdf].freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(xml, folder, options = {}) ⇒ CollectionRenderer

This is only going to render the HTML collection We presuppose that the bibdata of the document is equivalent to that of the collection, and that the flavour gem can sensibly process it. We may need to enhance metadata in the flavour gems isodoc/metadata.rb with collection metadata

Parameters:

  • xml (Metanorma::Collection) —

    input XML collection

  • folder (String) —

    input folder

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :coverpage (String) —

    cover page HTML (Liquid template)

  • :format (Array<Symbol>) —

    list of formats (xml,html,doc,pdf)

  • :ourput_folder (String) —

    output directory



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/metanorma/collection_renderer.rb', line 22

def initialize(xml, folder, options = {}) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
  check_options options
  @xml = Nokogiri::XML xml # @xml is the collection manifest
  @lang = @xml&.at(ns("//bibdata/language"))&.text || "en"
  @script = @xml&.at(ns("//bibdata/script"))&.text || "Latn"
  @doctype = doctype
  require "metanorma-#{@doctype}"

  # output processor for flavour
  @isodoc = isodoc

  @outdir = options[:output_folder]
  @coverpage = options[:coverpage]
  @format = options[:format]
  @compile_options = options[:compile] || {}

  # list of files in the collection
  @files = read_files folder
  FileUtils.rm_rf @outdir
  FileUtils.mkdir_p @outdir
end

Class Method Details

.render(col, options = {}) ⇒ Object

Parameters:

Options Hash (options):

  • :coverpage (String) —

    cover page HTML (Liquid template)

  • :format (Array<Synbol>) —

    list of formats

  • :ourput_folder (Strong) —

    output directory



49
50
51
52
53
54
55
 
# File 'lib/metanorma/collection_renderer.rb', line 49

def self.render(col, options = {})
  folder = File.dirname col.file
  cr = new(col.to_xml, folder, options)
  cr.files
  cr.concatenate(col, options)
  cr.coverpage if options[:format]&.include?(:html)
end

Instance Method Details

#add_document_suffix(identifier, doc) ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/metanorma/collection_renderer.rb', line 147

def add_document_suffix(identifier, doc)
  document_suffix = Asciidoctor::Standoc::Cleanup.to_ncname(identifier)
  [%w[* id],
  %w[* bibitemid],
  %w[review from],
  %w[review to],
  %w[index to],
  %w[xref target],
  %w[callout target]]
  .each do |(tag_name, attribute_name)|
    add_suffix_to_attributes(doc, document_suffix, tag_name, attribute_name)
  end
end

#add_suffix_to_attributes(doc, suffix, tag_name, attribute_name) ⇒ Object 



140
141
142
143
144
145
 
# File 'lib/metanorma/collection_renderer.rb', line 140

def add_suffix_to_attributes(doc, suffix, tag_name, attribute_name)
  doc.xpath(ns("//#{tag_name}[@#{attribute_name}]")).each do |elem|
    elem.attributes[attribute_name].value =
      "#{elem.attributes[attribute_name].value}_#{suffix}"
  end
end

#concatenate(col, options) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/metanorma/collection_renderer.rb', line 57

def concatenate(col, options)
  options[:format] << :presentation if options[:format].include?(:pdf)
  options[:format].uniq.each do |e|
    next unless i(presentation xml).include?(e)
    ext = e == :presentation ? "presentation.xml" : e.to_s
    out = col.clone
    out.directives << "documents-inline"
    out.documents.keys.each do |id|
      filename = @files[id][:outputs][e]
      out.documents[id] = Metanorma::Document.raw_file(filename)
    end
    File.open(File.join(@outdir, "collection.#{ext}"), "w:UTF-8") { |f| f.write(out.to_xml) }
  end
  options[:format].include?(:pdf) and
    pdfconv.convert(File.join(@outdir, "collection.presentation.xml"))
end

#coverpage ⇒ Object

populate liquid template of ARGV with metadata extracted from collection manifest



181
182
183
184
185
 
# File 'lib/metanorma/collection_renderer.rb', line 181

def coverpage
  File.open(File.join(@outdir, "index.html"), "w:UTF-8") do |f|
    f.write @isodoc.populate_template(File.read(@coverpage))
  end
end

#docrefs(elm, builder) ⇒ Object

Parameters:

  • elm (Nokogiri::XML::Element)
  • builder (Nokogiri::XML::Builder) 


208
209
210
211
212
213
214
215
216
 
# File 'lib/metanorma/collection_renderer.rb', line 208

def docrefs(elm, builder)
  elm.xpath(ns("./docref")).each do |d|
    identifier = d.at(ns("./identifier")).text
    link = if d["fileref"] then d["fileref"].sub(/\.xml$/, ".html")
           else d["id"] + ".html"
           end
    builder.li { builder.a identifier, href: link }
  end
end

#doctype ⇒ Object

infer the flavour from the first document identifier; relaton does that



102
103
104
105
106
107
108
109
110
111
 
# File 'lib/metanorma/collection_renderer.rb', line 102

def doctype
  if (docid = @xml&.at(ns("//bibdata/docidentifier/@type"))&.text)
    dt = docid.downcase
  elsif (docid = @xml&.at(ns("//bibdata/docidentifier"))&.text)
    dt = docid.sub(/\s.*$/, "").lowercase
  else return "standoc"
  end
  @registry = Metanorma::Registry.instance
  @registry.alias(dt.to_sym)&.to_s || dt
end

#files ⇒ Object

process each file in the collection files are held in memory, and altered as postprocessing



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/metanorma/collection_renderer.rb', line 342

def files # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
  @files.each do |identifier, x|
    file, filename = targetfile(x, true)
    file = update_xrefs(file, identifier)
    Tempfile.open(["collection", ".xml"], encoding: "utf-8") do |f|
      f.write(file)
      f.close
      # warn "metanorma compile -x html #{f.path}"
      c = Compile.new
      options = { format: :asciidoc, extension_keys: @format }.merge @compile_options
      c.compile f.path, options
      @files[identifier][:outputs] = {}
      @format.each do |e|
        ext = c.processor.output_formats[e]
        fn = File.basename(filename).sub(/(?<=\.)[^\.]+$/, ext.to_s)
        FileUtils.mv f.path.sub(/\.xml$/, ".#{ext}"), File.join(@outdir, fn)
        @files[identifier][:outputs][e] = File.join(@outdir, fn)
      end
    end
  end
end

#indexfile(elm) ⇒ String

single level navigation list, with hierarchical nesting if multiple lists are needed as separate HTML fragments, multiple instances of this function will be needed, and associated to different variables in the call to @isodoc.metadata_init (including possibly an array of HTML fragments)

Parameters:

  • elm (Nokogiri::XML::Element)

Returns:

  • (String) —

    XML



226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/metanorma/collection_renderer.rb', line 226

def indexfile(elm)
  Nokogiri::HTML::Builder.new do |b|
    b.ul do
      b.li indexfile_title(elm)
      indexfile_docref(elm, b)
      elm.xpath(ns("./manifest")).each do |d|
        b << indexfile(d)
      end
    end
  end.doc.root.to_html
end

#indexfile_docref(elm, builder) ⇒ Object

uses the identifier to label documents; other attributes (title) can be looked up in @files[:bibdata]

Parameters:

  • elm (Nokogiri::XML::Element)
  • builder (Nokogiri::XML::Builder) 


200
201
202
203
204
 
# File 'lib/metanorma/collection_renderer.rb', line 200

def indexfile_docref(elm, builder)
  return "" unless elm.at(ns("./docref"))

  builder.ul { |b| docrefs(elm, b) }
end

#indexfile_title(elm) ⇒ String

Parameters:

  • elm (Nokogiri::XML::Element)

Returns:

  • (String) 


189
190
191
192
193
 
# File 'lib/metanorma/collection_renderer.rb', line 189

def indexfile_title(elm)
  lvl = elm&.at(ns("./level"))&.text&.capitalize
  lbl = elm&.at(ns("./title"))&.text
  "#{lvl}#{lvl && lbl ? ': ' : ''}#{lbl}"
end

#isodoc ⇒ Object

The isodoc class for the metanorma flavour we are using



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/metanorma/collection_renderer.rb', line 85

def isodoc # rubocop:disable Metrics/MethodLength
  x = Asciidoctor.load nil, backend: @doctype.to_sym
  isodoc = x.converter.html_converter(Dummy.new)
  isodoc.i18n_init(@lang, @script) # read in internationalisation
  # create the @meta class of isodoc, with "navigation" set to the index bar
  # extracted from the manifest
  nav = indexfile(@xml.at(ns("//manifest")))
  i18n = isodoc.i18n
  i18n.set(:navigation, nav)
  isodoc.metadata_init(@lang, @script, i18n)
  # populate the @meta class of isodoc with the various metadata fields
  # native to the flavour; used to populate Liquid
  isodoc.info(@xml, nil)
  isodoc
end

#ns(xpath) ⇒ Object 



113
114
115
 
# File 'lib/metanorma/collection_renderer.rb', line 113

def ns(xpath)
  IsoDoc::Convert.new({}).ns(xpath)
end

#pdfconv ⇒ Object 



74
75
76
77
 
# File 'lib/metanorma/collection_renderer.rb', line 74

def pdfconv
  x = Asciidoctor.load nil, backend: @doctype.to_sym
  x.converter.pdf_converter(Dummy.new)
end

#read_anchors(xml) ⇒ Object

map locality type and label (e.g. “clause” “1”) to id = anchor for a document



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/metanorma/collection_renderer.rb', line 163

def read_anchors(xml)
  ret = {}
  xrefs = @isodoc.xref_init(@lang, @script, @isodoc, @isodoc.i18n, {})
  xrefs.parse xml
  xrefs.get.each do |k, v|
    ret[v[:type]] ||= {}
    index = v[:container] || v[:label].nil? || v[:label].empty? ? 
      UUIDTools::UUID.random_create.to_s : v[:label]
    # Note: will only key clauses, which have unambiguous reference label in locality.
    # Notes, examples etc with containers are just plunked agaisnt UUIDs, so that their
    # IDs can at least be registered to be tracked as existing.
    ret[v[:type]][index] = k
  end
  ret
end

#read_files(path) ⇒ Hash{String=>Hash}

hash for each document in collection of document identifier to: document reference (fileref or id), type of document reference, and bibdata entry for that file

Parameters:

  • path (String) —

    path to collection

Returns:

  • (Hash{String=>Hash}) 


122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/metanorma/collection_renderer.rb', line 122

def read_files(path) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
  files = {}
  @xml.xpath(ns("//docref")).each do |d|
    identifier = d.at(ns("./identifier")).text
    files[identifier] = if d["fileref"]
                          { type: "fileref",
                            ref: File.join(path, d["fileref"]) }
                        else { type: "id", ref: d["id"] }
                        end
    file, _filename = targetfile(files[identifier], true)
    xml = Nokogiri::XML(file)
    add_document_suffix(identifier, xml)
    files[identifier][:anchors] = read_anchors(xml)
    files[identifier][:bibdata] = xml.at(ns("//bibdata"))
  end
  files
end

#ref_file(ref, read) ⇒ Array<String, nil>

Parameters:

  • ref (String)
  • read (Boolean)

Returns:

  • (Array<String, nil>) 


252
253
254
255
256
 
# File 'lib/metanorma/collection_renderer.rb', line 252

def ref_file(ref, read)
  file = File.read(ref, encoding: "utf-8") if read
  filename = ref.sub(/\.xml$/, ".html")
  [file, filename]
end

#targetfile(data, read = false) ⇒ Array<String, nil>

return file contents + output filename for each file in the collection, given a docref entry

Parameters:

  • data (Hash)
  • read (Boolean) (defaults to: false)

Returns:

  • (Array<String, nil>) 


243
244
245
246
247
 
# File 'lib/metanorma/collection_renderer.rb', line 243

def targetfile(data, read = false)
  if data[:type] == "fileref" then ref_file data[:ref], read
  else xml_file data[:id], read
  end
end

#update_anchors(bib, docxml, _id) ⇒ Object

if there is a crossref to another document, with no anchor, retrieve the anchor given the locality, and insert it into the crossref



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/metanorma/collection_renderer.rb', line 316

def update_anchors(bib, docxml, _id) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
  docid = bib&.at(ns("./docidentifier"))&.text
  document_suffix = Asciidoctor::Standoc::Cleanup.to_ncname(docid)
  docxml.xpath("//xmlns:eref[@citeas = '#{docid}']").each do |e|
    if loc = e.at(ns(".//locality[@type = 'anchor']"))
      ref = loc.at(ns("./referenceFrom")) || next
      anchor = "#{ref.text}_#{document_suffix}"
      next unless @files[docid][:anchors].inject([]) { |m, (_, x)| m+= x.values }.include?(anchor)
      ref.content = anchor
    else
      ins = e.at(ns("./localityStack")) || next
      type = ins&.at(ns("./locality/@type"))&.text
      ref = ins&.at(ns("./locality/referenceFrom"))&.text
      (anchor = @files[docid][:anchors][type][ref]) || next
      ref_from = Nokogiri::XML::Node.new "referenceFrom", bib
      ref_from.content = anchor.sub(/^_/, "")
      locality = Nokogiri::XML::Node.new "locality", bib
      locality[:type] = "anchor"
      locality.add_child ref_from
      ins << locality
    end
  end
end

#update_bibitem(bib, identifier) ⇒ Object

Parameters:

  • bib (Nokogiri::XML::Element)
  • identifier (String) 


269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/metanorma/collection_renderer.rb', line 269

def update_bibitem(bib, identifier) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
  docid = bib&.at(ns("./docidentifier"))&.text
  unless @files[docid]
    warn "Cannot find crossreference to document #{docid} in document "\
      "#{identifier}!"
    abort
  end
  id = bib["id"]
  newbib = bib.replace(@files[docid][:bibdata])
  newbib.name = "bibitem"
  newbib["id"] = id
  newbib["hidden"] = "true"
  newbib&.at(ns("./ext"))&.remove
  _file, url = targetfile(@files[docid], false)
  uri_node = Nokogiri::XML::Node.new "uri", newbib
  uri_node[:type] = "citation"
  uri_node.content = url
  newbib.at(ns("./docidentifier")).previous = uri_node
end

#update_xrefs(file, identifier) ⇒ String

TODO: update crossreferences to other files in the selection repo(current-metanorma-collection/ISO 17301-1:2016) replaced by bibdata of “ISO 17301-1:2016” in situ as bibitem Any erefs to that bibitem id are replaced with relative URL Preferably with anchor, and is a job to realise dynamic lookup of localities

Parameters:

  • file (String) —

    XML content

  • identifier (String) —

    docid

Returns:

  • (String) —

    XML content



299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/metanorma/collection_renderer.rb', line 299

def update_xrefs(file, identifier)
  docxml = Nokogiri::XML(file)
  add_document_suffix(identifier, docxml)
  docxml.xpath(ns("//bibitem[not(ancestor::bibitem)]")).each do |b|
    docid = b&.at(ns("./docidentifier[@type = 'repository']"))&.text
    next unless docid && %r{^current-metanorma-collection/}.match(docid)
    update_bibitem(b, identifier)
    update_anchors(b, docxml, docid)
  end
  docxml.xpath(ns("//references[not(./bibitem[not(@hidden) or @hidden = 'false'])]")).each do |f|
    f["hidden"] = "true"
  end
  docxml.to_xml
end

#xml_file(id, read) ⇒ Array<String, nil>

Parameters:

  • id (String)
  • read (Boolean)

Returns:

  • (Array<String, nil>) 


261
262
263
264
265
 
# File 'lib/metanorma/collection_renderer.rb', line 261

def xml_file(id, read)
  file = @xml.at(ns("//doc-container[@id = '#{id}']")).to_xml if read
  filename = id + ".html"
  [file, filename]
end