metanorma 1.2.0 → 1.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 189106fda9c97a62268cdf23a26f7b10f9784cff4d9cdf590563c0f9e71aaea5
-  data.tar.gz: feec6fdbfbcdb931b3ca3ce782d9ba35248481902e66ca515b94f60346217dfe
+  metadata.gz: 66652dc0d52d85abe7e08d5804364bcc320760e292e91594ea135051d02ee92a
+  data.tar.gz: ab9bd75163ac8b107d2833bd5719d8742ad5b2d73c438361d40da77871efb36f
 SHA512:
-  metadata.gz: e6843c3813d6d378a320ccdec21e85174889a0634396a0e1e15eeaf82192bf80414a8e698a7818cfebc575a3925e46007c6a006964179979682e51ea49a173b5
-  data.tar.gz: 972d7e156885833eab9f91e142dd427dea72093d0a7eee665b5229e6e1dbd41bed117c8e72a09d6be9b6f2360c11eec3fa70eb0eb84807f5656bc08b496f56fc
+  metadata.gz: '038472b6e12dbcd3caca90a5538489e531d208a7168630f987fd3a12f7590ef5e4a2bb63cbcaabd5555dcbfa9ebaccf4894fd344df4e185a2a9954049166142c'
+  data.tar.gz: 135896ec6863c3a75cd0779957e439ebf964358bf0415ad44e74af3d0f8f729a777793d84bf23149a0309e4e70d15e5c1587eaae27f0b3744ab8c26344488a83

data/.github/workflows/notify.yml

@@ -3,16 +3,16 @@
 name: notify
 
 on:
-  push:
-    branches: [ master ]
-    tags:
-      - '*'
+  repository_dispatch:
+    types: [ notify ]
 
 jobs:
   notify:
     name: Notify dependent repos
     runs-on: ubuntu-latest
     steps:
+      - uses: actions/checkout@v2
+
       - name: Trigger repositories
         env:
           GH_USERNAME: metanorma-ci
@@ -21,7 +21,7 @@ jobs:
           curl -LO --retry 3 https://raw.githubusercontent.com/metanorma/metanorma-build-scripts/master/trigger-gh-actions.sh
           [[ -f ".github/workflows/dependent_repos.env" ]] && source .github/workflows/dependent_repos.env
           CLIENT_PAYLOAD=$(cat <<EOF
-          "{ "ref": "${GITHUB_REF}", "repo": "${GITHUB_REPOSITORY}" }"
+          "{ "ref": "${{ github.event.client_payload.ref }}", "repo": "${GITHUB_REPOSITORY}" }"
           EOF
           )
           for repo in $TEMPLATE_REPOS" $SAMPLES_REPOS"
@@ -30,7 +30,7 @@ jobs:
           done
 
       - name: Trigger release repositories
-        if: github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/tags/v')
+        if: github.event.client_payload.ref == 'refs/heads/master' || startsWith(github.event.client_payload.ref, 'refs/tags/v')
         env:
           GH_USERNAME: metanorma-ci
           GH_ACCESS_TOKEN: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
@@ -38,7 +38,7 @@ jobs:
           curl -LO --retry 3 https://raw.githubusercontent.com/metanorma/metanorma-build-scripts/master/trigger-gh-actions.sh
           [[ -f ".github/workflows/dependent_repos.env" ]] && source .github/workflows/dependent_repos.env
           CLIENT_PAYLOAD=$(cat <<EOF
-          "{ "ref": "${GITHUB_REF}", "repo": "${GITHUB_REPOSITORY}" }"
+          "{ "ref": "${{ github.event.client_payload.ref }}", "repo": "${GITHUB_REPOSITORY}" }"
           EOF
           )
           for repo in $DEPENDENT_REPOS

data/.github/workflows/rake.yml

@@ -4,7 +4,8 @@ name: rake
 
 on:
   push:
-    branches: [ master ]
+    branches: [ master, main ]
+    tags: [ v* ]
   pull_request:
 
 jobs:
@@ -31,14 +32,29 @@ jobs:
     steps:
       - uses: actions/checkout@master
 
-      - name: Use Ruby
-        uses: ruby/setup-ruby@v1
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
 
-      - name: Update gems
-        run: bundle install --jobs 4 --retry 3
+      - uses: actions/cache@v2
+        with:
+          path: vendor/bundle
+          key: bundle-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
+          restore-keys: bundle-${{ matrix.os }}-${{ matrix.ruby }}
+
+      - run: bundle config set path 'vendor/bundle'
+
+      - run: bundle install --jobs 4 --retry 3
 
-      - name: Run specs
-        run: bundle exec rake
+      - run: bundle exec rake
+
+  tests-passed:
+    needs: rake
+    runs-on: ubuntu-latest
+    steps:
+      - uses: peter-evans/repository-dispatch@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          repository: ${{ github.repository }}
+          event-type: notify
+          client-payload: '{"ref": "${{ github.ref }}"}'

data/README.adoc

@@ -1,9 +1,7 @@
 = Metanorma: the standard for standards
 
 image:https://img.shields.io/gem/v/metanorma.svg["Gem Version", link="https://rubygems.org/gems/metanorma"]
-image:https://github.com/metanorma/metanorma/workflows/ubuntu/badge.svg["Ubuntu Build Status", link="https://github.com/metanorma/metanorma/actions?query=workflow%3Aubuntu"]
-image:https://github.com/metanorma/metanorma/workflows/macos/badge.svg["OSX Build Status", link="https://github.com/metanorma/metanorma/actions?query=workflow%3Amacos"]
-image:https://github.com/metanorma/metanorma/workflows/windows/badge.svg["Windows Build Status", link="https://github.com/metanorma/metanorma/actions?query=workflow%3Awindows"]
+image:https://github.com/metanorma/metanorma/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma/actions?workflow=rake"]
 image:https://codeclimate.com/github/metanorma/metanorma/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma"]
 image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma.svg["Pull Requests", link="https://github.com/metanorma/metanorma/pulls"]
 image:https://img.shields.io/github/commits-since/metanorma/metanorma/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma/releases"]

data/lib/metanorma/collection.rb

@@ -3,6 +3,7 @@
 require "relaton"
 require "relaton/cli"
 require "metanorma/collection_manifest"
+require "metanorma-utils"
 
 module Metanorma
   # Metanorma collection of documents
@@ -39,8 +40,13 @@ module Metanorma
       @documents.merge! @manifest.documents(File.dirname(@file))
       @prefatory = args[:prefatory]
       @final = args[:final]
+      @log = Metanorma::Utils::Log.new
     end
+
     # rubocop:enable Metrics/AbcSize,Metrics/MethodLength
+     def clean_exit
+       @log.write(File.join(File.dirname(@file), File.basename(@file, ".*") + ".err"))
+     end
 
     # @return [String] XML
     def to_xml
@@ -57,7 +63,8 @@ module Metanorma
     end
 
     def render(opts)
-      CollectionRenderer.render self, opts
+      CollectionRenderer.render self, opts.merge(log: @log)
+      clean_exit
     end
 
     class << self

data/lib/metanorma/collection_fileprocess.rb

@@ -0,0 +1,270 @@
+# frozen_string_literal: true
+
+require "isodoc"
+
+module Metanorma
+  # XML collection renderer
+  class CollectionRenderer
+    # 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
+    # @param path [String] path to collection
+    # @return [Hash{String=>Hash}]
+    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
+
+    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
+
+    def add_document_suffix(identifier, doc)
+      document_suffix = Metanorma::Utils::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
+
+    # map locality type and label (e.g. "clause" "1") to id = anchor for
+    # a document
+    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
+
+    # return file contents + output filename for each file in the collection,
+    # given a docref entry
+    # @param data [Hash]
+    # @param read [Boolean]
+    # @return [Array<String, nil>]
+    def targetfile(data, read = false)
+      if data[:type] == "fileref" then ref_file data[:ref], read
+      else xml_file data[:id], read
+      end
+    end
+
+    # @param ref [String]
+    # @param read [Boolean]
+    # @return [Array<String, nil>]
+    def ref_file(ref, read)
+      file = File.read(ref, encoding: "utf-8") if read
+      filename = ref.sub(/\.xml$/, ".html")
+      [file, filename]
+    end
+
+    # @param id [String]
+    # @param read [Boolean]
+    # @return [Array<String, nil>]
+    def xml_file(id, read)
+      file = @xml.at(ns("//doc-container[@id = '#{id}']")).to_xml if read
+      filename = id + ".html"
+      [file, filename]
+    end
+
+    # @param bib [Nokogiri::XML::Element]
+    # @param identifier [String]
+    def update_bibitem(bib, identifier) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      docid = bib&.at(ns("./docidentifier"))&.text
+      unless @files[docid]
+        error = "[metanorma] Cannot find crossreference to document #{docid} in document #{identifier}."
+        @log.add("Cross-References", nil, error)
+        Util.log(error, :warning)
+        return
+      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
+
+    # Resolves direct links to other files in collection (repo(current-metanorma-collection/x),
+    # and indirect links to other files in collection (bibitem[@type = 'internal'] pointing to a file anchor
+    # in another file in the collection)
+    # @param file [String] XML content
+    # @param identifier [String] docid
+    # @param internal_refs [Hash{String=>Hash{String=>String}] schema name to anchor to filename
+    # @return [String] XML content
+    def update_xrefs(file, identifier, internal_refs)
+      docxml = Nokogiri::XML(file)
+      update_indirect_refs_to_docs(docxml, internal_refs)
+      add_document_suffix(identifier, docxml)
+      update_direct_refs_to_docs(docxml, identifier)
+      docxml.xpath(ns("//references[not(./bibitem[not(@hidden) or @hidden = 'false'])]")).each do |f|
+        f["hidden"] = "true"
+      end
+      docxml.to_xml
+    end
+
+    # 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.
+    def update_direct_refs_to_docs(docxml, identifier)
+      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
+    end
+
+    # Resolve erefs to a container of ids in another doc, to an anchor eref (direct link)
+    def update_indirect_refs_to_docs(docxml, internal_refs)
+      internal_refs.each do |schema, ids|
+        ids.each do |id, file|
+          update_indirect_refs_to_docs1(docxml, schema, id, file)
+        end
+      end
+    end
+
+    def update_indirect_refs_to_docs1(docxml, schema, id, file)
+      docxml.xpath(ns("//eref[@bibitemid = '#{schema}_#{id}']")).each do |e|
+        e["citeas"] = file
+      end
+      docid = docxml.at(ns("//bibitem[@id = '#{schema}_#{id}']/docidentifier[@type = 'repository']")) or return
+      docid.children = "current-metanorma-collection/#{file}"
+      docid.previous = "<docidentifier type='X'>#{file}</docidentifier>"
+    end
+
+    # update crossrefences to other documents, to include disambiguating document suffix on id
+    def update_anchors(bib, docxml, _id) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+      docid = bib&.at(ns("./docidentifier"))&.text
+      docxml.xpath("//xmlns:eref[@citeas = '#{docid}']").each do |e|
+        if @files[docid]
+          update_anchor_loc(bib, e, docid)
+        else
+          e << "<strong>** Unresolved reference to document #{docid}, id #{e['bibitemid']}</strong>"
+        end
+      end
+    end
+
+    def update_anchor_loc(bib, e, docid)
+      loc = e.at(ns(".//locality[@type = 'anchor']")) or return update_anchor_create_loc(bib, e, docid)
+      document_suffix = Metanorma::Utils::to_ncname(docid)
+      ref = loc.at(ns("./referenceFrom")) || return
+      anchor = "#{ref.text}_#{document_suffix}"
+      return unless @files[docid][:anchors].inject([]) { |m, (_, x)| m+= x.values }.include?(anchor)
+      ref.content = anchor
+    end
+
+    # if there is a crossref to another document, with no anchor, retrieve the
+    # anchor given the locality, and insert it into the crossref
+    def update_anchor_create_loc(bib, e, docid)
+      ins = e.at(ns("./localityStack")) || return
+      type = ins&.at(ns("./locality/@type"))&.text
+      ref = ins&.at(ns("./locality/referenceFrom"))&.text
+      (anchor = @files[docid][:anchors][type][ref]) || return
+      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
+
+    # compile and output individual file in collection
+    def file_compile(f, filename, identifier)
+      # warn "metanorma compile -x html #{f.path}"
+      c = Compile.new
+      c.compile f.path, { format: :asciidoc, extension_keys: @format }.merge(@compile_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
+
+    # gather internal bibitem references
+    def gather_internal_refs
+      @files.each_with_object({}) do |(identifier, x), refs|
+        file, _ = targetfile(x, true)
+        Nokogiri::XML(file).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]] = true
+        end
+      end
+    end
+
+    # resolve file location for the target of each internal reference
+    def locate_internal_refs
+      refs = gather_internal_refs
+      @files.each do |identifier, x|
+        file, filename = targetfile(x, true)
+        docxml = Nokogiri::XML(file)
+        refs.each do |schema, ids|
+          ids.keys.each do |id|
+            docxml.at(ns("//*[@id = '#{id}'][@type = '#{schema}']")) and
+              refs[schema][id] = identifier
+          end
+        end
+      end
+      refs.each do |schema, ids|
+        ids.each do |id, key|
+          key == true and refs[schema][id] = "Missing:#{schema}:#{id}"
+        end
+      end
+      refs
+    end
+
+    # process each file in the collection
+    # files are held in memory, and altered as postprocessing
+    def files # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      internal_refs = locate_internal_refs
+      @files.each do |identifier, x|
+        file, filename = targetfile(x, true)
+        file = update_xrefs(file, identifier, internal_refs)
+        Tempfile.open(["collection", ".xml"], encoding: "utf-8") do |f|
+          f.write(file)
+          f.close
+          file_compile(f, filename, identifier)
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/collection_renderer.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "isodoc"
+require_relative "./collection_fileprocess"
 
 module Metanorma
   # XML collection renderer
@@ -33,6 +34,8 @@ module Metanorma
       @outdir = options[:output_folder]
       @coverpage = options[:coverpage]
       @format = options[:format]
+      @compile_options = options[:compile] || {}
+      @log = options[:log]
 
       # list of files in the collection
       @files = read_files folder
@@ -113,42 +116,6 @@ module Metanorma
       IsoDoc::Convert.new({}).ns(xpath)
     end
 
-    # 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
-    # @param path [String] path to collection
-    # @return [Hash{String=>Hash}]
-    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)
-        files[identifier][:anchors] = read_anchors(xml)
-        files[identifier][:bibdata] = xml.at(ns("//bibdata"))
-      end
-      files
-    end
-
-    # map locality type and label (e.g. "clause" "1") to id = anchor for
-    # a document
-    def read_anchors(xml)
-      ret = {}
-      xrefs = @isodoc.xref_init(@lang, @script, @isodoc, @isodoc.i18n, {})
-      xrefs.parse xml
-      xrefs.get.each do |k, v|
-        v[:label] && v[:type] || next
-        ret[v[:type]] ||= {}
-        ret[v[:type]][v[:label]] = k
-      end
-      ret
-    end
-
     # populate liquid template of ARGV[1] with metadata extracted from
     # collection manifest
     def coverpage
@@ -208,120 +175,6 @@ module Metanorma
       end.doc.root.to_html
     end
 
-    # return file contents + output filename for each file in the collection,
-    # given a docref entry
-    # @param data [Hash]
-    # @param read [Boolean]
-    # @return [Array<String, nil>]
-    def targetfile(data, read = false)
-      if data[:type] == "fileref" then ref_file data[:ref], read
-      else xml_file data[:id], read
-      end
-    end
-
-    # @param ref [String]
-    # @param read [Boolean]
-    # @return [Array<String, nil>]
-    def ref_file(ref, read)
-      file = File.read(ref, encoding: "utf-8") if read
-      filename = ref.sub(/\.xml$/, ".html")
-      [file, filename]
-    end
-
-    # @param id [String]
-    # @param read [Boolean]
-    # @return [Array<String, nil>]
-    def xml_file(id, read)
-      file = @xml.at(ns("//doc-container[@id = '#{id}']")).to_xml if read
-      filename = id + ".html"
-      [file, filename]
-    end
-
-    # @param bib [Nokogiri::XML::Element]
-    # @param identifier [String]
-    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&.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
-
-    # 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
-    # @param file [String] XML content
-    # @param identifier [String] docid
-    # @return [String] XML content
-    def update_xrefs(file, identifier)
-      docxml = Nokogiri::XML(file)
-      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.to_xml
-    end
-
-    # if there is a crossref to another document, with no anchor, retrieve the
-    # anchor given the locality, and insert it into the crossref
-    def update_anchors(bib, docxml, _id) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-      docid = bib&.at(ns("./docidentifier"))&.text
-      docxml.xpath("//xmlns:eref[@citeas = '#{docid}']").each do |e|
-        e.at(ns(".//locality[@type = 'anchor']")).nil? || next
-        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
-
-    # process each file in the collection
-    # files are held in memory, and altered as postprocessing
-    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
-          c.compile f.path, format: :asciidoc, extension_keys: @format
-          @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
-
     private
 
     # @param options [Hash]
@@ -331,7 +184,6 @@ module Metanorma
         raise ArgumentError, "Need to specify formats (xml,html,pdf,doc)"
       end
       return if !options[:format].include?(:html) || options[:coverpage]
-
       raise ArgumentError, "Need to specify a coverpage to render HTML"
     end
   end

data/lib/metanorma/compile.rb

@@ -2,6 +2,9 @@ require "fileutils"
 require "nokogiri"
 require "htmlentities"
 
+require "fontist"
+require "fontist/manifest/install"
+
 module Metanorma
   class Compile
     # @return [Array<String>]
@@ -21,6 +24,7 @@ module Metanorma
       (file, isodoc = process_input(filename, options)) or return nil
       relaton_export(isodoc, options)
       extract(isodoc, options[:extract], options[:extract_type])
+      install_fonts(options)
       process_extensions(extensions, file, isodoc, options)
     end
 
@@ -63,21 +67,32 @@ module Metanorma
         Util.log("[metanorma] Error: Please specify a standard type: #{@registry.supported_backends}.", :error)
         return nil
       end
+
       stdtype = options[:type].to_sym
+      metanorma_flavor = "metanorma-#{stdtype}"
+
       unless @registry.supported_backends.include? stdtype
-        Util.log("[metanorma] Info: Loading `metanorma-#{stdtype}` gem for standard type `#{stdtype}`.", :info)
+        Util.log("[metanorma] Info: Loading `#{metanorma_flavor}` gem for standard type `#{stdtype}`.", :info)
       end
+
       begin
         require "metanorma-#{stdtype}"
-        Util.log("[metanorma] Info: gem `metanorma-#{stdtype}` loaded.", :info)
+        Util.log("[metanorma] Info: gem `#{metanorma_flavor}` loaded.", :info)
+
+      rescue Gem::ConflictError
+        Util.log("[metanorma] Error: Couldn't resolve dependencies for `metanorma-#{stdtype}`, Please add it to your Gemfile and run bundle install first", :error)
+        return false
+
       rescue LoadError
-        Util.log("[metanorma] Error: loading gem `metanorma-#{stdtype}` failed. Exiting.", :error)
+        Util.log("[metanorma] Error: loading gem `#{metanorma_flavor}` failed. Exiting.", :error)
         return false
       end
+
       unless @registry.supported_backends.include? stdtype
-        Util.log("[metanorma] Error: The `metanorma-#{stdtype}` gem still doesn't support `#{stdtype}`. Exiting.", :error)
+        Util.log("[metanorma] Error: The `#{metanorma_flavor}` gem still doesn't support `#{stdtype}`. Exiting.", :error)
         return false
       end
+
       true
     end
 
@@ -246,19 +261,70 @@ module Metanorma
               @processor.output(isodoc, xml_name, outfilename, ext, isodoc_options)
           rescue StandardError => e
             puts e.message
+            puts e.backtrace.join("\n")
           end
         end
         wrap_html(options, file_extension, outfilename)
       end
     end
 
+    def install_fonts(options)
+      if options[:no_install_fonts]
+        Util.log("[fontist] Skip font installation because" \
+          " --no-install-fonts argument passed", :debug)
+        return
+      end
+
+      if !@processor.respond_to?(:fonts_manifest) || @processor.fonts_manifest.nil?
+        Util.log("[fontist] Skip font installation because font_manifest is missing", :debug)
+        return
+      end
+
+      @updated_formulas_repo = false
+
+      manifest = @processor.fonts_manifest
+      agree_to_terms = options[:agree_to_terms] || false
+      continue_without_fonts = options[:continue_without_fonts] || false
+
+      install_fonts_safe(manifest, agree_to_terms, continue_without_fonts)
+    end
+
     private
 
+    def install_fonts_safe(manifest, agree, continue)
+      fontist_install(manifest, agree)
+    rescue Fontist::Errors::LicensingError
+      if continue
+        Util.log("[fontist] Processing will continue without fonts installed", :debug)
+      else
+        Util.log("[fontist] Aborting without proper fonts installed," \
+          " make sure that you have set option --agree-to-terms", :fatal)
+      end
+    rescue Fontist::Errors::FontError => e
+      log_level = continue ? :warning : :fatal
+      Util.log("[fontist] '#{e.font}' font is not supported. " \
+        "Please report this issue at github.com/metanorma/metanorma-#{@processor.short}/issues" \
+        " to report this issue.", log_level)
+    rescue Fontist::Errors::FormulaIndexNotFoundError
+      Util.log("[fontist] Bug: formula index not found after 'fontist update'", :fatal) if @updated_formulas_repo
+      Util.log("[fontist] Missing formula index. Fetching it...", :debug)
+      Fontist::Formula.update_formulas_repo
+      @updated_formulas_repo = true
+      install_fonts_safe(manifest, agree, continue)
+    end
+
+    def fontist_install(manifest, agree)
+      Fontist::Manifest::Install.from_hash(
+        manifest,
+        confirmation: agree ? "yes" : "no"
+      )
+    end
+
     # @param options [Hash]
     # @return [String]
     def change_output_dir(options)
-      if options[:"output-dir"]
-        File.join options[:"output-dir"], File.basename(options[:filename])
+      if options[:output_dir]
+        File.join options[:output_dir], File.basename(options[:filename])
       else options[:filename]
       end
     end

data/lib/metanorma/config.rb

@@ -15,7 +15,7 @@ module Metanorma
     attr_accessor :logs
 
     def initialize
-      @logs ||= [:warning, :error]
+      @logs ||= [:warning, :error, :fatal]
     end
   end
 

data/lib/metanorma/input/asciidoc.rb

@@ -14,7 +14,7 @@ module Metanorma
           header_footer: true,
           attributes: [
             "nodoc", "stem", "xrefstyle=short", "docfile=#{filename}",
-            "output_dir=#{options[:"output-dir"]}"
+            "output_dir=#{options[:output_dir]}"
           ]
         }
         unless asciidoctor_validate(file, filename, out_opts)

data/lib/metanorma/util.rb

@@ -6,6 +6,10 @@ module Metanorma
       if log_types.include?(type.to_s)
         puts(message)
       end
+
+      if type == :fatal
+        exit(1)
+      end
     end
   end
 end

data/lib/metanorma/version.rb

@@ -1,3 +1,3 @@
 module Metanorma
-  VERSION = "1.2.0"
+  VERSION = "1.2.5"
 end

data/metanorma.gemspec

@@ -27,16 +27,19 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'htmlentities'
   spec.add_runtime_dependency 'nokogiri'
   spec.add_runtime_dependency 'mn2pdf', "~> 1"
-# get relaton-cli to avoic circular reference with metanorma-standoc
+  spec.add_runtime_dependency 'metanorma-utils', "~> 1"
+  spec.add_runtime_dependency 'pry'
+  spec.add_runtime_dependency 'fontist', '~> 1.8'
+
+# get relaton-cli to avoid circular reference with metanorma-standoc
   #spec.add_dependency "relaton-cli"
-  #spec.add_dependency "metanorma-standoc", "~> 1.5.3"
+  #spec.add_dependency "metanorma-standoc"
 
   spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "byebug", "~> 10.0"
   spec.add_development_dependency "rspec-command", "~> 1.0"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
-  spec.add_development_dependency "metanorma-iso", "~> 1.5.8"
+  spec.add_development_dependency "metanorma-iso", "~> 1.7.0"
   spec.add_development_dependency "sassc", "~> 2.4.0"
-  #spec.add_development_dependency "isodoc", "~> 1.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-25 00:00:00.000000000 Z
+date: 2021-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -66,6 +66,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: metanorma-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fontist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.8
+        version: 1.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.8
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: sassc
   requirement: !ruby/object:Gem::Requirement
@@ -196,6 +238,7 @@ files:
 - lib/metanorma/asciidoctor_extensions.rb
 - lib/metanorma/asciidoctor_extensions/glob_include_processor.rb
 - lib/metanorma/collection.rb
+- lib/metanorma/collection_fileprocess.rb
 - lib/metanorma/collection_manifest.rb
 - lib/metanorma/collection_renderer.rb
 - lib/metanorma/compile.rb