Class: Metanorma::Collection::Renderer

Inherits:
Object
  • Object
show all
Defined in:
lib/metanorma/collection/renderer/utils.rb,
lib/metanorma/collection/renderer/renderer.rb,
lib/metanorma/collection/renderer/fileparse.rb,
lib/metanorma/collection/renderer/navigation.rb,
lib/metanorma/collection/renderer/fileprocess.rb,
lib/metanorma/collection/renderer/render_word.rb

Defined Under Namespace

Classes: DocOptionsNode, PdfOptionsNode

Constant Summary collapse

FORMATS = 
%i[html xml doc pdf].freeze
BIBITEM_NOT_REPO_XPATH = 
"//bibitem[not(ancestor::bibitem)]" \
"[not(./docidentifier[@type = 'repository'])]".freeze
SECTION_BREAK = 
'<p class="MsoNormal"><br clear="all" class="section"/></p>'
.freeze
DIV1 = 
'<div class="WordSection1">&#xa0;</div>'.freeze
DIV2 = 
'<div class="WordSection2">&#xa0;</div>'.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(collection, folder, options = {}) ⇒ Renderer

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)

  • :output_folder (String) —

    output directory



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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/metanorma/collection/renderer/renderer.rb', line 32

def initialize(collection, folder, options = {}) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
  check_options options
  @xml = Nokogiri::XML collection.to_xml # @xml is the collection manifest
  @xml.root.default_namespace = "http://metanorma.org"
  @lang = collection.bibdata.language.first || "en"
  @script = collection.bibdata.script.first || "Latn"
  @locale = @xml.at("//xmlns:bibdata/xmlns:locale")&.text
  @doctype = doctype
  @compile = Compile.new
  @compile.load_flavor(@doctype)

  @isodoc = isodoc_create # output processor for flavour
  @outdir = dir_name_cleanse(options[:output_folder])
  @coverpage = options[:coverpage] || collection.coverpage
  @format = ::Metanorma::Util.sort_extensions_execution(options[:format])
  @compile_options = options[:compile] || {}
  @compile_options[:install_fonts] = true if options[:install_fonts]
  @log = options[:log]
  @bibdata = collection.bibdata
  @documents = collection.documents
  @bibdatas = collection.documents
  @directives = collection.directives
  @dirname = collection.dirname
  @manifest = collection.manifest.config
  @disambig = Util::DisambigFiles.new
  @prefatory = collection.prefatory
  @final = collection.final
  @c = HTMLEntities.new
  @files_to_delete = []
  @nested = options[:nested] # if false, this is the root instance of Renderer
  # if true, then this is not the last time Renderer will be run
  # (e.g. this is sectionsplit)

  # list of files in the collection
  @files = Metanorma::Collection::FileLookup.new(folder, self)
  @files.add_section_split
  isodoc_populate
  create_non_existing_directory(@outdir)
end

Instance Attribute Details

#compile ⇒ Object (readonly)

Returns the value of attribute compile.



17
18
19
 
# File 'lib/metanorma/collection/renderer/renderer.rb', line 17

def compile
  @compile
end

#compile_options ⇒ Object (readonly)

Returns the value of attribute compile_options.



17
18
19
 
# File 'lib/metanorma/collection/renderer/renderer.rb', line 17

def compile_options
  @compile_options
end

#documents ⇒ Object (readonly)

Returns the value of attribute documents.



17
18
19
 
# File 'lib/metanorma/collection/renderer/renderer.rb', line 17

def documents
  @documents
end

#isodoc ⇒ Object

Returns the value of attribute isodoc.



16
17
18
 
# File 'lib/metanorma/collection/renderer/renderer.rb', line 16

def isodoc
  @isodoc
end

#manifest ⇒ Object (readonly)

Returns the value of attribute manifest.



17
18
19
 
# File 'lib/metanorma/collection/renderer/renderer.rb', line 17

def manifest
  @manifest
end

#nested ⇒ Object

Returns the value of attribute nested.



16
17
18
 
# File 'lib/metanorma/collection/renderer/renderer.rb', line 16

def nested
  @nested
end

#outdir ⇒ Object (readonly)

Returns the value of attribute outdir.



17
18
19
 
# File 'lib/metanorma/collection/renderer/renderer.rb', line 17

def outdir
  @outdir
end

#xml ⇒ Object (readonly)

Returns the value of attribute xml.



17
18
19
 
# File 'lib/metanorma/collection/renderer/renderer.rb', line 17

def xml
  @xml
end

Class Method Details

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

Parameters:

Options Hash (options):

  • :coverpage (String) —

    cover page HTML (Liquid template)

  • :format (Array<Symbol>) —

    list of formats

  • :ourput_folder (Strong) —

    output directory



84
85
86
87
88
89
90
91
92
 
# File 'lib/metanorma/collection/renderer/renderer.rb', line 84

def self.render(col, options = {})
  warn "\n\n\n\n\nRender Init: #{DateTime.now.strftime('%H:%M:%S')}"
  cr = new(col, File.dirname(col.file), options)
  cr.files
  cr.concatenate(col, options)
  options[:format]&.include?(:html) and cr.coverpage
  cr.flush_files
  cr
end

Instance Method Details

#add_hidden_bibliography(xmldoc, refs) ⇒ Object 



74
75
76
77
78
79
80
81
82
 
# File 'lib/metanorma/collection/renderer/utils.rb', line 74

def add_hidden_bibliography(xmldoc, refs)
  ins = new_hidden_ref(xmldoc)
  refs.each do |k, v|
    url = @files.url(v, {})
    ins << <<~XML
      <bibitem id="#{k}">#{docid_xml(v)}<uri type='citation'>#{url}</uri></bibitem>
    XML
  end
end

#build_indexfile1(mnf) ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/metanorma/collection/renderer/navigation.rb', line 66

def build_indexfile1(mnf)
  Nokogiri::HTML::Builder.new do |b|
    if mnf.file then docrefs(mnf, b)
    else
      b.li do |l|
        l << indexfile_title(mnf)
        l.ul do |u|
          Array(mnf.entry).each { |e| u << indexfile1(e) }
        end
      end
    end
  end
end

#cleanup_indexfile1(ret) ⇒ Object 



80
81
82
83
84
85
86
87
88
 
# File 'lib/metanorma/collection/renderer/navigation.rb', line 80

def cleanup_indexfile1(ret)
  ret = ret.doc.root
  ret.xpath("/ul").each do |u|
    if u.at("./li/ul") && !u.at("./li[text()]")
      u.replace(u.xpath("./li/ul"))
    end
  end
  ret.to_html
end

#collect_erefs(docxml) ⇒ Object 



61
62
63
64
65
66
67
 
# File 'lib/metanorma/collection/renderer/utils.rb', line 61

def collect_erefs(docxml)
  docxml.xpath(ns("//eref"))
    .each_with_object({ citeas: {}, bibitemid: {} }) do |i, m|
    m[:citeas][i["citeas"]] = true
    m[:bibitemid][i["bibitemid"]] = true
  end
end

#collection_coverpages(conv, docs) ⇒ Object 



71
72
73
74
75
76
77
78
79
 
# File 'lib/metanorma/collection/renderer/render_word.rb', line 71

def collection_coverpages(conv, docs)
  conv.wordintropage and [DIV2, SECTION_BREAK].reverse.each do |s|
    docs.unshift(Nokogiri::XML(s).root)
  end
  conv.wordcoverpage and [DIV1, SECTION_BREAK].reverse.each do |s|
    docs.unshift(Nokogiri::XML(s).root)
  end
  docs
end

#compile_options_update(identifier) ⇒ Object 



24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/metanorma/collection/renderer/fileprocess.rb', line 24

def compile_options_update(identifier)
  ret = @compile_options.dup
  @directives.detect { |d| d.key == "presentation-xml" } ||
    @files.get(identifier, :presentationxml) and
    ret.merge!(passthrough_presentation_xml: true)
  @files.get(identifier, :sectionsplit) == true and
    ret.merge!(sectionsplit: true)
  @files.get(identifier, :bare) == true and
    ret.merge!(bare: true)
  ret
end

#concat_extract_files(filename) ⇒ Object 



11
12
13
14
15
16
17
18
19
 
# File 'lib/metanorma/collection/renderer/render_word.rb', line 11

def concat_extract_files(filename)
  xml = Nokogiri::XML(File.read(filename, encoding: "UTF-8"), &:huge)
  docs = xml.xpath(ns("//doc-container")).each_with_object([]) do |x, m|
    n = Nokogiri::XML::Document.new
    n.add_child(x.elements.first.remove)
    m << n
  end
  [wrapping_doc(docs.first.dup, xml), docs]
end

#concatenate(col, options) ⇒ Object 



94
95
96
97
98
99
100
 
# File 'lib/metanorma/collection/renderer/renderer.rb', line 94

def concatenate(col, options)
  warn "\n\n\n\n\nConcatenate: #{DateTime.now.strftime('%H:%M:%S')}"
  (options[:format] & %i(pdf doc)).empty? or
    options[:format] << :presentation
  concatenate_prep(col, options)
  concatenate_outputs(options)
end

#concatenate1(out, ext) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/metanorma/collection/renderer/renderer.rb', line 122

def concatenate1(out, ext)
  out.directives << ::Metanorma::Collection::Config::Directive.new(key: "documents-inline")
  out.bibdatas.each_key do |ident|
    id = @isodoc.docid_prefix(nil, ident.dup)
    @files.get(id, :attachment) || @files.get(id, :outputs).nil? and next
    out.documents[Util::key id] =
      Metanorma::Collection::Document.raw_file(@files.get(id,
                                                          :outputs)[ext])
  end
  out
end

#concatenate_outputs(options) ⇒ Object 



116
117
118
119
120
 
# File 'lib/metanorma/collection/renderer/renderer.rb', line 116

def concatenate_outputs(options)
  pres = File.join(@outdir, "collection.presentation.xml")
  options[:format].include?(:pdf) and pdfconv.convert(pres)
  options[:format].include?(:doc) and docconv_convert(pres)
end

#concatenate_prep(col, options) ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/metanorma/collection/renderer/renderer.rb', line 102

def concatenate_prep(col, options)
  %i(xml presentation).each do |e|
    options[:format].include?(e) or next
    ext = e == :presentation ? "presentation.xml" : e.to_s
    File.open(File.join(@outdir, "collection.#{ext}"), "w:UTF-8") do |f|
      b = concatenate1(col.clone, e).to_xml
      e == :presentation and
        b.sub!("<metanorma-collection>", "<metanorma-collection xmlns='http://metanorma.org'>")
      # TODO BEING FORCED TO DO THAT BECAUSE SHALE IS NOT DEALING WITH DEFAULT NAMESPACES
      f.write(b)
    end
  end
end

#copy_file_to_dest(identifier) ⇒ Object 



48
49
50
51
52
53
54
55
56
 
# File 'lib/metanorma/collection/renderer/fileprocess.rb', line 48

def copy_file_to_dest(identifier)
  out = Pathname.new(@files.get(identifier, :out_path)).cleanpath
  out.absolute? and
    out = out.relative_path_from(File.expand_path(FileUtils.pwd))
  dest = File.join(@outdir, @disambig.source2dest_filename(out.to_s))
  FileUtils.mkdir_p(File.dirname(dest))
  source = @files.get(identifier, :ref)
  source != dest and FileUtils.cp source, dest
end

#coverpage ⇒ Object

populate liquid template of ARGV with metadata extracted from collection manifest



148
149
150
151
152
153
154
 
# File 'lib/metanorma/collection/renderer/renderer.rb', line 148

def coverpage
  @coverpage or return
  warn "\n\n\n\n\nCoverpage: #{DateTime.now.strftime('%H:%M:%S')}"
  File.open(File.join(@outdir, "index.html"), "w:UTF-8") do |f|
    f.write @isodoc.populate_template(File.read(@coverpage))
  end
end

#dir_name_cleanse(name) ⇒ Object 



4
5
6
7
8
9
10
11
12
 
# File 'lib/metanorma/collection/renderer/utils.rb', line 4

def dir_name_cleanse(name)
  path = Pathname.new(name)
  clean_regex = /[<>:"|?*\p{Zs}]/
  fallback_sym = "_"
  return name.gsub(clean_regex, fallback_sym) unless path.absolute?

  File.join(path.dirname,
            path.basename.to_s.gsub(clean_regex, fallback_sym))
end

#docconv ⇒ Object 



4
5
6
7
8
9
 
# File 'lib/metanorma/collection/renderer/render_word.rb', line 4

def docconv
  @tempfile_cache ||= []
  doctype = @doctype.to_sym
  x = Asciidoctor.load nil, backend: doctype
  x.converter.doc_converter(DocOptionsNode.new(@directives, @dirname))
end

#docconv_convert(filename) ⇒ Object 



81
82
83
84
85
86
87
 
# File 'lib/metanorma/collection/renderer/render_word.rb', line 81

def docconv_convert(filename)
  pref_file, docs = concat_extract_files(filename)
  body = docconv_convert1(docs)
  collection_conv = overall_docconv_converter(body)
  collection_coverpages(collection_conv, body)
  collection_conv.convert(filename, pref_file.to_xml, false)
end

#docconv_convert1(docs) ⇒ Object 



58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/metanorma/collection/renderer/render_word.rb', line 58

def docconv_convert1(docs)
  docs.each_with_index.with_object([]) do |(d, i), m|
    conv = docconv
    conv.convert_init(d.to_xml(encoding: "UTF-8"), "xxxx", false)
    html = conv.postprocess_cleanup(conv.convert1(d, "xxx", "."))
    @tempfile_cache += conv.tempfile_cache # hold on to the temp img files
    b = Nokogiri::XML(html).at("//body")
    i == docs.size - 1 or
      b << '<p class="MsoNormal"><br clear="all" class="section"/></p>'
    m << b.children
  end
end

#docid_to_citeas(bib) ⇒ Object 



55
56
57
58
59
 
# File 'lib/metanorma/collection/renderer/utils.rb', line 55

def docid_to_citeas(bib)
  docid = bib.at(ns("./docidentifier[@primary = 'true']")) ||
    bib.at(ns("./docidentifier")) or return
  docid_prefix(docid)
end

#docid_xml(val) ⇒ Object 



69
70
71
72
 
# File 'lib/metanorma/collection/renderer/utils.rb', line 69

def docid_xml(val)
  "<docidentifier type='repository'>current-metanorma-collection/" \
    "#{val}</docidentifier>"
end

#docref_ident(docref) ⇒ Object 



37
38
39
40
 
# File 'lib/metanorma/collection/renderer/navigation.rb', line 37

def docref_ident(docref)
  ident = docref.identifier.dup
  @c.decode(@isodoc.docid_prefix(nil, ident))
end

#docrefs(mnf, builder) ⇒ Object 



26
27
28
29
30
31
32
33
34
35
 
# File 'lib/metanorma/collection/renderer/navigation.rb', line 26

def docrefs(mnf, builder)
  ident = docref_ident(mnf)
  builder.li do |li|
    li.a href: index_link(mnf, ident) do |a|
      a << ident.split(/([<>&])/).map do |x|
        /[<>&]/.match?(x) ? x : @c.encode(x, :hexadecimal)
      end.join
    end
  end
end

#doctype ⇒ Object

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



135
136
137
138
139
140
141
142
143
144
 
# File 'lib/metanorma/collection/renderer/renderer.rb', line 135

def doctype
  if (docid = @xml.at("//bibdata/docidentifier/@type")&.text)
    dt = docid.downcase
  elsif (docid = @xml.at("//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

#dup_bibitem(docid, bib) ⇒ Object 



14
15
16
17
18
19
20
21
 
# File 'lib/metanorma/collection/renderer/utils.rb', line 14

def dup_bibitem(docid, bib)
  newbib = @files.get(docid, :bibdata).dup
  newbib.name = "bibitem"
  newbib["hidden"] = "true"
  newbib&.at("./*[local-name() = 'ext']")&.remove
  newbib["id"] = bib["id"]
  newbib
end

#eref2link(docxml) ⇒ Object 



62
63
64
65
66
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 62

def eref2link(docxml)
  isodoc = IsoDoc::PresentationXMLConvert.new({})
  isodoc.bibitem_lookup(docxml)
  isodoc.eref2link(docxml)
end

#file_compile(file, filename, identifier) ⇒ Object

compile and output individual file in collection warn “metanorma compile -x html #Metanorma::Collection::Renderer.ff.path”



12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/metanorma/collection/renderer/fileprocess.rb', line 12

def file_compile(file, filename, identifier)
  @files.get(identifier, :sectionsplit) and return
  opts = {
    format: :asciidoc,
    extension_keys: @format,
    output_dir: @outdir,
  }.merge(compile_options_update(identifier))
  @compile.compile file, opts
  @files.set(identifier, :outputs, {})
  file_compile_formats(filename, identifier)
end

#file_compile_formats(filename, identifier) ⇒ Object 



36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/metanorma/collection/renderer/fileprocess.rb', line 36

def file_compile_formats(filename, identifier)
  f = @files.get(identifier, :outputs)
  @format << :presentation if @format.include?(:pdf)
  @format.each do |e|
    ext = @compile.processor.output_formats[e]
    fn = File.basename(filename).sub(/(?<=\.)[^.]+$/, ext.to_s)
    (/html$/.match?(ext) && @files.get(identifier, :sectionsplit)) or
      f[e] = File.join(@outdir, fn)
  end
  @files.set(identifier, :outputs, f)
end

#files ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/metanorma/collection/renderer/fileprocess.rb', line 60

def files # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
  warn "\n\n\n\n\nRender Files: #{DateTime.now.strftime('%H:%M:%S')}"
  internal_refs = locate_internal_refs
  @files.keys.each_with_index do |ident, i|
    i.positive? && @directives.detect do |d|
      d.key == "bare-after-first"
    end and
      @compile_options.merge!(bare: true)
    if @files.get(ident, :attachment) then copy_file_to_dest(ident)
    else
      file, fname = @files.targetfile_id(ident, read: true)
      warn "\n\n\n\n\nProcess #{fname}: #{DateTime.now.strftime('%H:%M:%S')}"
      collection_xml = update_xrefs(file, ident, internal_refs)
      collection_filename = File.basename(fname, File.extname(fname))
      collection_xml_path = File.join(Dir.tmpdir,
                                      "#{collection_filename}.xml")
      File.write collection_xml_path, collection_xml, encoding: "UTF-8"
      file_compile(collection_xml_path, fname, ident)
      FileUtils.rm(collection_xml_path)
    end
  end
end

#flush_files ⇒ Object 



72
73
74
75
76
77
 
# File 'lib/metanorma/collection/renderer/renderer.rb', line 72

def flush_files
  warn "\n\n\n\n\nDone: #{DateTime.now.strftime('%H:%M:%S')}"
  warn @files.files_to_delete
  @files.files_to_delete.each { |f| FileUtils.rm_f(f) }
  @files_to_delete.each { |f| FileUtils.rm_f(f) }
end

#gather_internal_refs ⇒ Object

gather internal bibitem references



84
85
86
87
88
89
90
 
# File 'lib/metanorma/collection/renderer/fileprocess.rb', line 84

def gather_internal_refs
  @files.keys.each_with_object({}) do |i, refs|
    @files.get(i, :attachment) and next
    file, = @files.targetfile_id(i, read: true)
    gather_internal_refs1(file, i, refs)
  end
end

#gather_internal_refs1(file, ident, refs) ⇒ Object 



92
93
94
95
96
97
98
 
# File 'lib/metanorma/collection/renderer/fileprocess.rb', line 92

def gather_internal_refs1(file, ident, refs)
  f = Nokogiri::XML(file, &:huge)
  !@files.get(ident, :sectionsplit) and
    gather_internal_refs_indirect(f, refs)
  key = @files.get(ident, :indirect_key) and
    gather_internal_refs_sectionsplit(f, ident, key, refs)
end

#gather_internal_refs_indirect(doc, refs) ⇒ Object 



100
101
102
103
104
105
106
107
108
 
# File 'lib/metanorma/collection/renderer/fileprocess.rb', line 100

def gather_internal_refs_indirect(doc, refs)
  doc.xpath(ns("//bibitem[@type = 'internal']/" \
               "docidentifier[@type = 'repository']")).each do |d|
                 a = d.text.split(%r{/}, 2)
                 a.size > 1 or next
                 refs[a[0]] ||= {}
                 refs[a[0]][a[1]] = false
               end
end

#gather_internal_refs_sectionsplit(_doc, ident, key, refs) ⇒ Object 



110
111
112
113
114
115
 
# File 'lib/metanorma/collection/renderer/fileprocess.rb', line 110

def gather_internal_refs_sectionsplit(_doc, ident, key, refs)
  refs[key] ||= {}
  @files.get(ident, :ids).each_key do |k|
    refs[key][k] = false
  end
end

#get_bibitem_docid(bib, identifier) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/metanorma/collection/renderer/utils.rb', line 23

def get_bibitem_docid(bib, identifier)
  docid =
    bib.at(ns("./docidentifier[@type = 'metanorma-collection']")) ||
    bib.at(ns("./docidentifier[not(@type)]")) ||
    bib.at(ns("./docidentifier"))
  docid &&= docid_prefix(docid)
  if @files.get(docid) then docid
  else
    fail_update_bibitem(docid, identifier)
    nil
  end
end

#hide_refs(docxml) ⇒ Object 



36
37
38
39
40
41
 
# File 'lib/metanorma/collection/renderer/utils.rb', line 36

def hide_refs(docxml)
  docxml.xpath(ns("//references[bibitem][not(./bibitem[not(@hidden) or " \
                  "@hidden = 'false'])]")).each do |f|
    f["hidden"] = "true"
  end
end

#index?(mnf) ⇒ Boolean

Returns:

  • (Boolean) 


56
57
58
59
 
# File 'lib/metanorma/collection/renderer/navigation.rb', line 56

def index?(mnf)
  mnf.index and return true
  mnf.entry.detect { |e| index?(e) }
end

#index_link(docref, ident) ⇒ Object 



42
43
44
45
46
47
 
# File 'lib/metanorma/collection/renderer/navigation.rb', line 42

def index_link(docref, ident)
  if docref.file
    @files.get(ident, :out_path).sub(/\.xml$/, ".html")
  else "#{docref.id}.html"
  end
end

#index_object(mnf) ⇒ Object

object to construct navigation out of in Liquid



91
92
93
94
95
96
97
98
 
# File 'lib/metanorma/collection/renderer/navigation.rb', line 91

def index_object(mnf)
  mnf = Array(mnf).first
  ret = { title: indexfile_title(mnf), level: mnf.type,
          docrefs: index_object_docrefs(mnf),
          children: index_object_children(mnf) }.compact
  ret.keys == [:children] and ret = ret[:children]
  ret
end

#index_object_children(mnf) ⇒ Object 



100
101
102
103
104
105
106
107
 
# File 'lib/metanorma/collection/renderer/navigation.rb', line 100

def index_object_children(mnf)
  nonfiles = Array(mnf.entry).reject(&:file)
  c = nonfiles.each_with_object([]) do |d, b|
    b << index_object(d)
  end.flatten
  c.empty? and c = nil
  c
end

#index_object_docrefs(mnf) ⇒ Object 



109
110
111
112
113
114
115
116
117
118
 
# File 'lib/metanorma/collection/renderer/navigation.rb', line 109

def index_object_docrefs(mnf)
  files = Array(mnf.entry).select(&:file)
  files.empty? and return nil
  r = Nokogiri::HTML::Builder.new do |b|
    b.ul do |u|
      files.each { |f| docrefs(f, u) }
    end
  end
  r.doc.root&.to_html&.gsub("\n", " ")
end

#indexfile(mnf) ⇒ Object

single level navigation list, with hierarchical nesting



50
51
52
53
54
 
# File 'lib/metanorma/collection/renderer/navigation.rb', line 50

def indexfile(mnf)
  mnfs = Array(mnf)
  mnfs.empty? and return ""
  mnfs.map { |m| "<ul>#{indexfile1(m)}</ul>" }.join("\n")
end

#indexfile1(mnf) ⇒ Object 



61
62
63
64
 
# File 'lib/metanorma/collection/renderer/navigation.rb', line 61

def indexfile1(mnf)
  index?(mnf) or return ""
  cleanup_indexfile1(build_indexfile1(mnf))
end

#indexfile_docref(mnf, builder) ⇒ Object

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

Parameters:



21
22
23
24
 
# File 'lib/metanorma/collection/renderer/navigation.rb', line 21

def indexfile_docref(mnf, builder)
  Array(mnf.entry).detect(&:index) or return ""
  builder.ul { |b| docrefs(mnf, b) }
end

#indexfile_title(entry) ⇒ String

Parameters:

  • elm (Nokogiri::XML::Element)

Returns:

  • (String) 


6
7
8
9
10
11
12
13
14
 
# File 'lib/metanorma/collection/renderer/navigation.rb', line 6

def indexfile_title(entry)
  if entry.bibdata &&
      x = entry.bibdata.title.detect { |t| t.type == "main" } ||
          entry.bibdata.title.first
    x.title.content
  else
    entry.title
  end
end

#indirect_ref_key(schema, id, docxml) ⇒ Object 



171
172
173
174
175
176
177
178
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 171

def indirect_ref_key(schema, id, docxml)
  /^#{schema}_/.match?(id) and return id
  ret = "#{schema}_#{id}"
  suffix = docxml.root["document_suffix"]
  (k = docxml.root["type"]) && k != schema && suffix and
    ret = "#{ret}_#{suffix}"
  ret
end

#liquid_docrefs(mnfs) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/metanorma/collection/renderer/navigation.rb', line 120

def liquid_docrefs(mnfs)
  Array(mnfs).select(&:index).each_with_object([]) do |d, m|
    if d.file
      ident = @c.decode(@isodoc.docid_prefix(nil, d.identifier.dup))
      m << { "identifier" => ident, "file" => index_link(d, ident),
             "title" => indexfile_title(d), "level" => d.type }
    else
      liquid_docrefs(d.entry).each { |m1| m << m1 }
    end
  end
end

#locate_internal_refs ⇒ Object

resolve file location for the target of each internal reference



128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/metanorma/collection/renderer/fileprocess.rb', line 128

def locate_internal_refs
  warn "\n\n\n\n\nInternal Refs: #{DateTime.now.strftime('%H:%M:%S')}"
  refs = populate_internal_refs(gather_internal_refs)
  refs.each do |schema, ids|
    ids.each do |id, key|
      key and next
      refs[schema][id] = "Missing:#{schema}:#{id}"
      @log&.add("Cross-References", nil, refs[schema][id])
    end
  end
  refs
end

#locate_internal_refs1(refs, identifier, ident) ⇒ Object 



141
142
143
144
145
146
147
148
149
150
 
# File 'lib/metanorma/collection/renderer/fileprocess.rb', line 141

def locate_internal_refs1(refs, identifier, ident)
  file, = @files.targetfile_id(ident, read: true)
  t = locate_internal_refs1_prep(file)
  refs.each do |schema, ids|
    ids.keys.select { |id| t[id] }.each do |id|
      t[id].at("./ancestor-or-self::*[@type = '#{schema}']") and
        refs[schema][id] = identifier
    end
  end
end

#locate_internal_refs1_prep(file) ⇒ Object 



152
153
154
155
156
157
158
159
160
 
# File 'lib/metanorma/collection/renderer/fileprocess.rb', line 152

def locate_internal_refs1_prep(file)
  xml = Nokogiri::XML(file, &:huge)
  r = xml.root["document_suffix"]
  xml.xpath("//*[@id]").each_with_object({}) do |i, x|
    /^semantic_/.match?(i.name) and next
    x[i["id"]] = i
    r and x[i["id"].sub(/_#{r}$/, "")] = i
  end
end

#new_hidden_ref(xmldoc) ⇒ Object 



43
44
45
46
47
48
 
# File 'lib/metanorma/collection/renderer/utils.rb', line 43

def new_hidden_ref(xmldoc)
  ins = xmldoc.at(ns("bibliography")) or
    xmldoc.root << "<bibliography/>" and ins = xmldoc.at(ns("bibliography"))
  ins.at(ns("./referenced[@hidden = 'true']")) or
    ins.add_child("<references hidden='true' normative='false'/>").first
end

#overall_docconv_converter(body) ⇒ Object 



98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/metanorma/collection/renderer/render_word.rb', line 98

def overall_docconv_converter(body)
  collection_conv = docconv
  collection_conv.options[:collection_doc] = body.map(&:to_xml).join
  overall_docconv_cover(collection_conv)

  def collection_conv.postprocess_cleanup(result)
    ret = to_xhtml(super)
    b = ret.at("//div[@id = '_collection_placeholder']")
    b.replace(@options[:collection_doc])
    from_xhtml(ret)
  end

  collection_conv
end

#overall_docconv_cover(collection_conv) ⇒ Object 



89
90
91
92
93
94
95
96
 
# File 'lib/metanorma/collection/renderer/render_word.rb', line 89

def overall_docconv_cover(collection_conv)
  p = Util::hash_key_detect(@directives, "collection-word-coverpage", nil)
  collection_conv.wordcoverpage =
    Util::rel_path_resolve(@dirname, p)
  p = Util::hash_key_detect(@directives, "collection-word-intropage", nil)
  collection_conv.wordintropage =
    Util::rel_path_resolve(@dirname, p)
end

#populate_internal_refs(refs) ⇒ Object 



117
118
119
120
121
122
123
124
125
 
# File 'lib/metanorma/collection/renderer/fileprocess.rb', line 117

def populate_internal_refs(refs)
  @files.keys.reject do |k|
    @files.get(k, :attachment) || @files.get(k, :sectionsplit)
  end.each do |ident|
    locate_internal_refs1(refs, ident,
                          @isodoc.docid_prefix("", ident.dup))
  end
  refs
end

#set_displayorder_wrapping_doc(doc) ⇒ Object 



45
46
47
48
49
50
51
 
# File 'lib/metanorma/collection/renderer/render_word.rb', line 45

def set_displayorder_wrapping_doc(doc)
  doc.xpath(ns("//preface/* | //sections/* | //annex"))
    .each_with_index do |x, i|
    x["displayorder"] = i + 1
  end
  doc
end

#strip_eref(eref) ⇒ Object 



50
51
52
53
 
# File 'lib/metanorma/collection/renderer/utils.rb', line 50

def strip_eref(eref)
  eref.xpath(ns("./locality | ./localityStack")).each(&:remove)
  eref.replace(eref.children)
end

#strip_unresolved_repo_erefs(_document_id, bib_docid, erefs, bibitem) ⇒ Object

strip erefs if they are repository erefs, but do not point to a document within the current collection. This can happen if a collection consists of many documents, but not all are included in the current collection. Do not do this if this is a sectionsplit collection or a nested manifest. Return false if bibitem is not to be further processed



146
147
148
149
150
151
152
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 146

def strip_unresolved_repo_erefs(_document_id, bib_docid, erefs, bibitem)
  %r{^current-metanorma-collection/(?!Missing:)}.match?(bib_docid.text) and
    return true
  @nested and return false
  erefs[bibitem["id"]]&.each { |x| x.parent and strip_eref(x) }
  false
end

#suffix_anchor(ref, docid) ⇒ Object 



234
235
236
237
238
239
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 234

def suffix_anchor(ref, docid)
  @ncnames[docid] ||= Metanorma::Utils::to_ncname(docid)
  anchor = ref.text
  @files.url?(docid) or anchor = "#{@ncnames[docid]}_#{anchor}"
  anchor
end

#supply_repo_ids(doc) ⇒ Object 



71
72
73
74
75
76
77
78
79
80
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 71

def supply_repo_ids(doc)
  doc.xpath(ns(BIBITEM_NOT_REPO_XPATH)).each do |b|
    b.xpath(ns("./docidentifier")).each do |docid|
      id = @isodoc.docid_prefix(docid["type"], docid.children.to_xml)
      @files.get(id) or next
      @files.get(id, :indirect_key) and next # will resolve as indirect key
      docid.next = docid_xml(id)
    end
  end
end

#svg_datauri(docxml, docid) ⇒ Object 



82
83
84
85
86
87
88
89
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 82

def svg_datauri(docxml, docid)
  rel = @files.get(docid, :rel_path)
  parent = @files.get(docid, :parentid) and
    rel = @files.get(parent, :rel_path)
  # if sectionsplit, use orig file dir
  dir = File.join(@dirname, File.dirname(rel))
  datauri_encode(docxml, dir)
end

#svg_unnest(docxml) ⇒ Object 



103
104
105
106
107
108
109
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 103

def svg_unnest(docxml)
  docxml.xpath(ns("//svgmap//image[.//*[name() = 'image']]")).each do |i|
    s = i.elements.detect { |e| e.name == "svg" } and
      i.replace(s)
  end
  docxml
end

#svgmap_resolve(docxml, docid) ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 91

def svgmap_resolve(docxml, docid)
  ids = @files.get(docid, :ids)
  docxml = svg_unnest(svg_datauri(docxml, docid))
  isodoc = IsoDoc::PresentationXMLConvert.new({})
  isodoc.bibitem_lookup(docxml)
  docxml.xpath(ns("//svgmap//eref")).each do |e|
    svgmap_resolve_eref(e, isodoc, docxml, ids)
  end
  Vectory::SvgMapping.new(docxml, "").call
  docxml.xpath(ns("//svgmap")).each { |s| isodoc.svgmap_extract(s) }
end

#svgmap_resolve_eref(eref, isodoc, _docxml, ids) ⇒ Object 



111
112
113
114
115
116
117
118
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 111

def svgmap_resolve_eref(eref, isodoc, _docxml, ids)
  href = isodoc.eref_target(eref) or return
  href == "##{eref['bibitemid']}" ||
    (href =~ /^#/ && !ids[href.sub(/^#/, "")]) and return
  eref["target"] = href.strip
  eref.name = "link"
  eref.elements&.remove
end

#update_anchor_create_loc(_bib, eref, docid) ⇒ Object

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



243
244
245
246
247
248
249
250
251
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 243

def update_anchor_create_loc(_bib, eref, docid)
  ins = eref.at(ns("./localityStack")) or return
  type = ins.at(ns("./locality/@type"))&.text
  type = "clause" if type == "annex"
  ref = ins.at(ns("./locality/referenceFrom"))&.text
  a = @files.get(docid, :anchors).dig(type, ref) or return
  ins << "<locality type='anchor'><referenceFrom>#{a.sub(/^_/, '')}" \
         "</referenceFrom></locality>"
end

#update_anchor_loc(bib, eref, docid) ⇒ Object 



223
224
225
226
227
228
229
230
231
232
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 223

def update_anchor_loc(bib, eref, docid)
  loc = eref.at(".//xmlns:locality[@type = 'anchor']") or
    return update_anchor_create_loc(bib, eref, docid)
  ref = loc.at("./xmlns:referenceFrom") or return
  anchor = suffix_anchor(ref, docid)
  a = @files.get(docid, :anchors) or return
  a.inject([]) { |m, (_, x)| m + x.values }
    .include?(anchor) or return
  ref.content = anchor
end

#update_anchors(bib, docid, erefs) ⇒ Object

update crossrefences to other documents, to include disambiguating document suffix on id



210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 210

def update_anchors(bib, docid, erefs)
  erefs.each do |e|
    if @files.get(docid) then update_anchor_loc(bib, e, docid)
    else
      msg = "<strong>** Unresolved reference to document #{docid} " \
            "from eref</strong>"
      e << msg
      strip_eref(e)
      @log&.add("Cross-References", e, msg)
    end
  end
end

#update_bibitem(bib, identifier) ⇒ Object 



162
163
164
165
166
167
168
169
170
171
 
# File 'lib/metanorma/collection/renderer/fileprocess.rb', line 162

def update_bibitem(bib, identifier)
  docid = get_bibitem_docid(bib, identifier) or return
  newbib = dup_bibitem(docid, bib)
  url = @files.url(docid, relative: true,
                          doc: !@files.get(docid, :attachment))
  dest = newbib.at("./docidentifier") || newbib.at(ns("./docidentifier"))
  dest or dest = newbib.elements[-1]
  dest.previous = "<uri type='citation'>#{url}</uri>"
  bib.replace(newbib)
end

#update_direct_refs_to_docs(docxml, identifier) ⇒ Object

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.



125
126
127
128
129
130
131
132
133
134
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 125

def update_direct_refs_to_docs(docxml, identifier)
  erefs, erefs1 = update_direct_refs_to_docs_prep(docxml)
  docxml.xpath(ns("//bibitem")).each do |b|
    docid = b.at(ns("./docidentifier[@type = 'repository']")) or next
    strip_unresolved_repo_erefs(identifier, docid, erefs1, b) or next
    update_bibitem(b, identifier)
    docid = docid_to_citeas(b) or next
    erefs[docid] and update_anchors(b, docid, erefs[docid])
  end
end

#update_direct_refs_to_docs_prep(docxml) ⇒ Object 



136
137
138
139
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 136

def update_direct_refs_to_docs_prep(docxml)
  @ncnames = {}
  [Util::gather_citeases(docxml), Util::gather_bibitemids(docxml)]
end

#update_indirect_refs_to_docs(docxml, _docidentifier, internal_refs) ⇒ Object

Resolve erefs to a container of ids in another doc, to an anchor eref (direct link)



156
157
158
159
160
161
162
163
164
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 156

def update_indirect_refs_to_docs(docxml, _docidentifier, internal_refs)
  bibitems, erefs = update_indirect_refs_to_docs_prep(docxml)
  internal_refs.each do |schema, ids|
    ids.each do |id, file|
      k = indirect_ref_key(schema, id, docxml)
      update_indirect_refs_to_docs1(docxml, k, file, bibitems, erefs)
    end
  end
end

#update_indirect_refs_to_docs1(_docxml, key, file, bibitems, erefs) ⇒ Object 



180
181
182
183
184
185
186
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 180

def update_indirect_refs_to_docs1(_docxml, key, file, bibitems, erefs)
  erefs[key]&.each do |e|
    e["citeas"] = file
    update_indirect_refs_to_docs_anchor(e, file)
  end
  update_indirect_refs_to_docs_docid(bibitems[key], file)
end

#update_indirect_refs_to_docs_anchor(eref, file) ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 188

def update_indirect_refs_to_docs_anchor(eref, file)
  a = eref.at(ns(".//locality[@type = 'anchor']/referenceFrom")) or return
  suffix = file
  @files.get(file) && p = @files.get(file, :parentid) and
    suffix = "#{p}_#{suffix}"
  existing = a.text
  anchor = existing
  @files.url?(file) or
    anchor = Metanorma::Utils::to_ncname("#{anchor}_#{suffix}")
  @updated_anchors[existing] or a.children = anchor
  @updated_anchors[anchor] = true
end

#update_indirect_refs_to_docs_docid(bib, file) ⇒ Object 



201
202
203
204
205
206
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 201

def update_indirect_refs_to_docs_docid(bib, file)
  docid = bib&.at(ns("./docidentifier[@type = 'repository']")) or return
  docid.children = "current-metanorma-collection/#{file}"
  docid.previous =
    "<docidentifier type='metanorma-collection'>#{file}</docidentifier>"
end

#update_indirect_refs_to_docs_prep(docxml) ⇒ Object 



166
167
168
169
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 166

def update_indirect_refs_to_docs_prep(docxml)
  @updated_anchors = {}
  [Util::gather_bibitems(docxml), Util::gather_bibitemids(docxml)]
end

#update_sectionsplit_eref_to_doc(eref, internal_refs, doclist, opts) ⇒ Object 



52
53
54
55
56
57
58
59
60
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 52

def update_sectionsplit_eref_to_doc(eref, internal_refs, doclist, opts)
  a = eref.at(ns("./localityStack/locality[@type = 'anchor']/" \
                 "referenceFrom")) or return
  doc = internal_refs[opts[:key]]["#{a.text}_#{opts[:target_suffix]}"]
  bibitemid = Metanorma::Utils::to_ncname("#{doc}_#{opts[:source_suffix]}")
  eref["bibitemid"] = bibitemid
  doclist[bibitemid] ||= doc
  doclist
end

#update_sectionsplit_refs_to_docs(docxml, internal_refs) ⇒ Object 



39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 39

def update_sectionsplit_refs_to_docs(docxml, internal_refs)
  Util::gather_citeases(docxml).each do |k, v|
    (@files.get(k) && @files.get(k, :sectionsplit)) or next
    opts = { key: @files.get(k, :indirect_key),
             source_suffix: docxml.root["document_suffix"],
             target_suffix: @files.get(k, :document_suffix) }
    refs = v.each_with_object({}) do |eref, m|
      update_sectionsplit_eref_to_doc(eref, internal_refs, m, opts)
    end
    add_hidden_bibliography(docxml, refs)
  end
end

#update_xrefs(file, docid, internal_refs) ⇒ String

Resolves references to other files in the collection. Three routines:

  1. Eref to a document that has been split into multiple documents

(sectionsplit) are resolved to direct eref to the split document

  1. Indirect erefs to a file anchor in an unknwon file in the collection

(bibitem[@type = ‘internal’] ) are resolved to direct eref to the containing document

  1. Direct erefs to other files in collection

(repo(current-metanorma-collection/x) are resolved to hyperlinks

Parameters:

  • file (String) —

    XML content

  • identifier (String) —

    docid

  • internal_refs (Hash{String=>Hash{String=>String}] schema name to anchor to filename) —

    nternal_refs [HashString=>Hash{String=>String] schema name to anchor to filename

Returns:

  • (String) —

    XML content



17
18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 17

def update_xrefs(file, docid, internal_refs)
  xml, sso = update_xrefs_prep(file, docid)
  @nested || sso or
    Metanorma::Collection::XrefProcess::xref_process(xml, xml, nil, docid,
                                                     @isodoc)
  @nested or update_indirect_refs_to_docs(xml, docid, internal_refs)
  @files.add_document_suffix(docid, xml)
  @nested or update_sectionsplit_refs_to_docs(xml, internal_refs)
  update_direct_refs_to_docs(xml, docid)
  hide_refs(xml)
  sso and eref2link(xml)
  @nested or svgmap_resolve(xml, docid)
  xml.to_xml
end

#update_xrefs_prep(file, docid) ⇒ Object 



32
33
34
35
36
37
 
# File 'lib/metanorma/collection/renderer/fileparse.rb', line 32

def update_xrefs_prep(file, docid)
  docxml = file.is_a?(String) ? Nokogiri::XML(file, &:huge) : file
  supply_repo_ids(docxml)
  sso = @files.get(docid, :sectionsplit_output)
  [docxml, sso]
end

#wrapping_doc(doc, xml) ⇒ Object 



21
22
23
24
25
26
 
# File 'lib/metanorma/collection/renderer/render_word.rb', line 21

def wrapping_doc(doc, xml)
  doc.at(ns("//bibdata")).replace(xml.at(ns("//bibdata")).to_xml)
  sections = wrapping_doc_body(doc)
  wrapping_doc_intro_outro(xml, sections)
  set_displayorder_wrapping_doc(doc)
end

#wrapping_doc_body(doc) ⇒ Object 



35
36
37
38
39
40
41
42
43
 
# File 'lib/metanorma/collection/renderer/render_word.rb', line 35

def wrapping_doc_body(doc)
  doc.xpath(ns("//annex | //preface | //bibliography")).each(&:remove)
  s = doc.at(ns("//sections"))
  repl = <<~BODY
    <sections><clause id='_collection_placeholder'><p>PLACEHOLDER</p></clause></sections>
  BODY
  s.replace(repl)
  doc.at(ns("//sections"))
end

#wrapping_doc_intro_outro(xml, sections) ⇒ Object 



28
29
30
31
32
33
 
# File 'lib/metanorma/collection/renderer/render_word.rb', line 28

def wrapping_doc_intro_outro(xml, sections)
  p = xml.at(ns("//prefatory-content")) and
    sections.previous = "<preface>#{p.children.to_xml}</preface>"
  p = xml.at(ns("//final-content")) and
    sections.next = "<annex>#{p.children.to_xml}</annex>"
end