metanorma 1.5.5 → 1.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b89c521393022873c1869075ea123a814f157c5bf37cbd4f8b9f34076396a0e
-  data.tar.gz: b289b1718e6b24dd672ec758210ac483370b5fd56d583d8e6c7d06d3bfceca9d
+  metadata.gz: 8def7cdd4a8b5e3605736563382599b2d820b2c18e7305d6567c89b667c89d90
+  data.tar.gz: 75b2d6a77b20a782ace64f18f112cae4bb5b5643172c4df31e05e3a4eb817f20
 SHA512:
-  metadata.gz: e914e35240ed44db0d6b822d83e9bfca1fb0573c37b054ba0f343df5378364a41c3f1f7f37634b5cc592111eea696128909c2c2f78667ba96da8ea86fea3f1d4
-  data.tar.gz: a74dedfd28fb9281a729a26de8c020d560cbc298ec23172db5d6425298094f085a79ee08c76d67da7af3f1b524eb20001f9e5b9e16b63e2c286fb041e0124edd
+  metadata.gz: 5a95ed1b168dc0a1ce689a2d169f8664fdb087b35332f645836072ee3e13b8be63513ba585210c2f8f5e69d70161b3b1036dc34cc77a0659f14340caaf22d2e4
+  data.tar.gz: 2cab73d708c92443edb99dcb7d761169de3fda2dca2fb40e364f374d085e34c1c7cc317ba3f192bbb98309c699719f97fc10552143c235642a610941189580a5

data/lib/metanorma/collection.rb

@@ -17,9 +17,9 @@ module Metanorma
     attr_accessor :directives
 
     # @return [Hash<String, Metanorma::Document>]
-    attr_accessor :documents
+    attr_accessor :documents, :bibdatas
 
-    attr_accessor :disambig
+    attr_accessor :disambig, :manifest
 
     # @param file [String] path to source file
     # @param directives [Array<String>] documents-inline to inject the XML into
@@ -37,10 +37,12 @@ module Metanorma
       @manifest = args[:manifest]
       @manifest.collection = self
       @documents = args[:documents] || {}
+      @bibdatas = args[:documents] || {}
       if @documents.any? && !@directives.include?("documents-inline")
         @directives << "documents-inline"
       end
       @documents.merge! @manifest.documents(File.dirname(@file))
+      @bibdatas.merge! @manifest.documents(File.dirname(@file))
       @prefatory = args[:prefatory]
       @final = args[:final]
       @log = Metanorma::Utils::Log.new
@@ -99,7 +101,9 @@ module Metanorma
         pref = pref_final_content xml.at("//xmlns:prefatory-content")
         fnl = pref_final_content xml.at("//xmlns:final-content")
         new(file: file, bibdata: bd, manifest: mnf,
-            documents: docs_from_xml(xml, mnf), prefatory: pref, final: fnl)
+            documents: docs_from_xml(xml, mnf),
+            bibdatas: docs_from_xml(xml, mnf),
+            prefatory: pref, final: fnl)
       end
 
       def parse_yaml(file)
@@ -135,8 +139,8 @@ module Metanorma
 
         <<~CONT
 
-          == #{xml.at('title')&.text}
-        #{xml.at('p')&.text}
+            == #{xml.at('title')&.text}
+          #{xml.at('p')&.text}
         CONT
       end
     end

data/lib/metanorma/collection_fileparse.rb

@@ -64,9 +64,9 @@ module Metanorma
     end
 
     def fail_update_bibitem(docid, identifier)
-      error = "[metanorma] Cannot find crossreference to document #{docid} "\
+      error = "[metanorma] Cannot find crossreference to document #{docid} " \
               "in document #{identifier}."
-      @log.add("Cross-References", nil, error)
+      @log&.add("Cross-References", nil, error)
       Util.log(error, :warning)
     end
 
@@ -101,7 +101,7 @@ module Metanorma
     end
 
     def hide_refs(docxml)
-      docxml.xpath(ns("//references[bibitem][not(./bibitem[not(@hidden) or "\
+      docxml.xpath(ns("//references[bibitem][not(./bibitem[not(@hidden) or " \
                       "@hidden = 'false'])]")).each do |f|
         f["hidden"] = "true"
       end
@@ -114,7 +114,7 @@ module Metanorma
         b.xpath(ns("./docidentifier")).each do |d|
           next unless @files[d.text]
 
-          d.next = "<docidentifier type='repository'>"\
+          d.next = "<docidentifier type='repository'>" \
                    "current-metanorma-collection/#{d.text}"
         end
       end
@@ -189,7 +189,7 @@ module Metanorma
           a.children = "#{a.text}_#{Metanorma::Utils::to_ncname(file)}"
         end
       end
-      docid = docxml.at(ns("//bibitem[@id = '#{schema}_#{id}']/"\
+      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>"
@@ -201,7 +201,7 @@ module Metanorma
       docxml.xpath("//xmlns:eref[@citeas = '#{docid}']").each do |e|
         if @files[docid] then update_anchor_loc(bib, e, docid)
         else
-          e << "<strong>** Unresolved reference to document #{docid} "\
+          e << "<strong>** Unresolved reference to document #{docid} " \
                "from eref</strong>"
         end
       end
@@ -228,7 +228,7 @@ module Metanorma
       type = "clause" if type == "annex"
       ref = ins.at(ns("./locality/referenceFrom"))&.text
       anchor = @files[docid][:anchors].dig(type, ref) or return
-      ins << "<locality type='anchor'><referenceFrom>#{anchor.sub(/^_/, '')}"\
+      ins << "<locality type='anchor'><referenceFrom>#{anchor.sub(/^_/, '')}" \
              "</referenceFrom></locality>"
     end
 
@@ -239,7 +239,7 @@ module Metanorma
 
         file, = targetfile(x, read: true)
         Nokogiri::XML(file)
-          .xpath(ns("//bibitem[@type = 'internal']/"\
+          .xpath(ns("//bibitem[@type = 'internal']/" \
                     "docidentifier[@type = 'repository']")).each do |d|
           a = d.text.split(%r{/}, 2)
           a.size > 1 or next

data/lib/metanorma/collection_manifest.rb

@@ -111,6 +111,9 @@ module Metanorma
           b.identifier do |i|
             i << dr["identifier"]
           end
+          !dr["attachment"] && !dr["sectionsplit"] &&
+            d = @collection.bibdatas[dr["identifier"]] and
+            b.parent.add_child(d.bibitem.to_xml(bibdata: true))
         end
         docref_to_xml_attrs(drf, dr)
       end

data/lib/metanorma/collection_renderer.rb

@@ -10,6 +10,8 @@ module Metanorma
   class CollectionRenderer
     FORMATS = %i[html xml doc pdf].freeze
 
+    attr_accessor :isodoc
+
     # This is only going to render the HTML collection
     # @param xml [Metanorma::Collection] input XML collection
     # @param folder [String] input folder
@@ -31,9 +33,7 @@ module Metanorma
       @doctype = doctype
       require "metanorma-#{@doctype}"
 
-      # output processor for flavour
-      @isodoc = isodoc
-
+      @isodoc = isodoc_create # output processor for flavour
       @outdir = dir_name_cleanse(options[:output_folder])
       @coverpage = options[:coverpage]
       @format = Util.sort_extensions_execution(options[:format])
@@ -41,13 +41,14 @@ module Metanorma
       @compile_options[:no_install_fonts] = true if options[:no_install_fonts]
       @log = options[:log]
       @documents = collection.documents
+      @bibdata = collection.documents
       @directives = collection.directives
       @disambig = Util::DisambigFiles.new
       @compile = Compile.new
 
       # list of files in the collection
       @files = read_files folder
-      isodoc_populate(@isodoc)
+      @isodoc = isodoc_populate # output processor for flavour
       create_non_existing_directory(@outdir)
     end
 
@@ -77,6 +78,7 @@ module Metanorma
       warn "\n\n\n\n\nCoverpage: #{DateTime.now.strftime('%H:%M:%S')}"
       cr.coverpage if options[:format]&.include?(:html)
       warn "\n\n\n\n\nDone: #{DateTime.now.strftime('%H:%M:%S')}"
+      cr
     end
 
     def concatenate(col, options)
@@ -95,7 +97,7 @@ module Metanorma
 
     def concatenate1(out, ext)
       out.directives << "documents-inline"
-      out.documents.each_key do |id|
+      out.bibdatas.each_key do |id|
         @files[id][:attachment] || @files[id][:outputs].nil? and next
 
         out.documents[id] =
@@ -125,34 +127,42 @@ module Metanorma
       end
     end
 
-    # Dummy class
     class Dummy
       def attr(_key); end
     end
 
-    # The isodoc class for the metanorma flavour we are using
-    def isodoc
+    def isodoc_create
       x = Asciidoctor.load nil, backend: @doctype.to_sym
-      isodoc = x.converter.html_converter(Dummy.new)
+      isodoc = x.converter.html_converter(Dummy.new) # to obtain Isodoc class
       isodoc.i18n_init(@lang, @script, @locale) # read in internationalisation
       isodoc.metadata_init(@lang, @script, @locale, isodoc.i18n)
       isodoc.info(@xml, nil)
       isodoc
     end
 
-    def isodoc_populate(isodoc)
-      # create the @meta class of isodoc, with "navigation" set to the index bar
+    def isodoc_populate
+      # create the @meta class of isodoc, for populating Liquid,
+      # 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, @locale, i18n)
-      # populate the @meta class of isodoc with the various metadata fields
-      # native to the flavour; used to populate Liquid
+      isodoc = isodoc_create
+      isodoc.meta.set(:navigation, indexfile(@xml.at(ns("//manifest"))))
+      isodoc.meta.set(:docrefs, liquid_docrefs)
+      isodoc.meta.set(:"prefatory-content",
+                      isodoc_builder(isodoc, @xml.at(ns("//prefatory-content"))))
+      isodoc.meta.set(:"final-content",
+                      isodoc_builder(isodoc, @xml.at(ns("//final-content"))))
       isodoc.info(@xml, nil)
       isodoc
     end
 
+    def isodoc_builder(isodoc, node)
+      Nokogiri::HTML::Builder.new do |b|
+        b.div do |div|
+          node&.children&.each { |n| isodoc.parse(n, div) }
+        end
+      end.doc.root.to_html
+    end
+
     # infer the flavour from the first document identifier; relaton does that
     def doctype
       if (docid = @xml.at(ns("//bibdata/docidentifier/@type"))&.text)
@@ -172,8 +182,7 @@ module Metanorma
     # populate liquid template of ARGV[1] with metadata extracted from
     # collection manifest
     def coverpage
-      return unless @coverpage
-
+      @coverpage or return
       File.open(File.join(@outdir, "index.html"), "w:UTF-8") do |f|
         f.write @isodoc.populate_template(File.read(@coverpage))
       end
@@ -204,7 +213,7 @@ module Metanorma
       elm.xpath(ns("./docref[@index = 'true']")).each do |d|
         ident = d.at(ns("./identifier")).children.to_xml
         builder.li do |li|
-          li.a **{ href: index_link(d, ident) } do |a|
+          li.a href: index_link(d, ident) do |a|
             a << ident
           end
         end
@@ -238,12 +247,22 @@ module Metanorma
       end.doc.root.to_html
     end
 
+    def liquid_docrefs
+      @xml.xpath(ns("//docref[@index = 'true']")).each_with_object([]) do |d, m|
+        ident = d.at(ns("./identifier")).children.to_xml
+        title = d.at(ns("./bibdata/title[@type = 'main']")) ||
+          d.at(ns("./bibdata/title")) || d.at(ns("./title"))
+        m << { "identifier" => ident, "file" => index_link(d, ident),
+               "title" => title&.children&.to_xml,
+               "level" => d.at(ns("./level"))&.text }
+      end
+    end
+
     private
 
     def create_non_existing_directory(output_directory)
-      if !File.exist?(output_directory)
+      !File.exist?(output_directory) and
         FileUtils.mkdir_p(output_directory)
-      end
     end
 
     def format_sort(formats)
@@ -257,9 +276,8 @@ module Metanorma
     # @param options [Hash]
     # @raise [ArgumentError]
     def check_options(options)
-      unless options[:format].is_a?(Array) && (FORMATS & options[:format]).any?
+      (options[:format].is_a?(Array) && (FORMATS & options[:format]).any?) or
         raise ArgumentError, "Need to specify formats (xml,html,pdf,doc)"
-      end
     end
   end
 end

data/lib/metanorma/compile.rb

@@ -55,7 +55,8 @@ module Metanorma
         file.sub!(/^(=[^\n]+\n)/, "\\1:mn-keep-asciimath:\n")
       dir = File.dirname(filename)
       dir != "." and
-        file.gsub!(/^include::/, "include::#{dir}/")
+        file = file.gsub(/^include::/, "include::#{dir}/")
+          .gsub(/^embed::/, "embed::#{dir}/")
       [file, @processor.input_to_isodoc(file, filename, options)]
     end
 

data/lib/metanorma/document.rb

@@ -104,7 +104,8 @@ module Metanorma
 
     def render_xml(builder)
       if @raw
-        builder << @bibitem.root.to_xml
+        #builder << @bibitem.root.to_xml
+        builder.parent.add_child(@bibitem.root)
       else
         builder.send("#{type}-standard") do |b|
           b << @bibitem.to_xml(bibdata: true)

data/lib/metanorma/input/asciidoc.rb

@@ -36,18 +36,18 @@ module Metanorma
 
       def extract_metanorma_options(file)
         headerextract = file.sub(/\n\n.*$/m, "\n")
-        /\n:mn-document-class: (?<type>[^\n]+)\n/ =~ headerextract
-        /\n:mn-output-extensions: (?<extensions>[^\n]+)\n/ =~ headerextract
-        /\n:mn-relaton-output-file: (?<relaton>[^\n]+)\n/ =~ headerextract
+        /\n:mn-document-class:\s+(?<type>[^\n]+)\n/ =~ headerextract
+        /\n:mn-output-extensions:\s+(?<extensions>[^\n]+)\n/ =~ headerextract
+        /\n:mn-relaton-output-file:\s+(?<relaton>[^\n]+)\n/ =~ headerextract
         /\n(?<asciimath>:mn-keep-asciimath:[^\n]*)\n/ =~ headerextract
         asciimath = if defined?(asciimath)
                       (!asciimath.nil? && asciimath != ":mn-keep-asciimath: false")
                     end
         asciimath = nil if asciimath == false
         {
-          type: defined?(type) ? type : nil,
-          extensions: defined?(extensions) ? extensions : nil,
-          relaton: defined?(relaton) ? relaton : nil,
+          type: defined?(type) ? type&.strip : nil,
+          extensions: defined?(extensions) ? extensions&.strip : nil,
+          relaton: defined?(relaton) ? relaton&.strip : nil,
           asciimath: asciimath,
         }.compact
       end
@@ -70,11 +70,11 @@ module Metanorma
            pdf-allow-print pdf-allow-print-hq pdf-allow-fill-in-forms
            fonts font-license-agreement pdf-allow-access-content
            pdf-encrypt-metadata iso-word-template document-scheme
-           localize-number iso-word-bg-strip-color modspec-identifier-base
-           ).freeze
+           localize-number iso-word-bg-strip-color modspec-identifier-base).freeze
 
       EMPTY_ADOC_OPTIONS_DEFAULT_TRUE =
-        %w(data-uri-image suppress-asciimath-dup use-xinclude source-highlighter).freeze
+        %w(data-uri-image suppress-asciimath-dup use-xinclude
+           source-highlighter).freeze
 
       EMPTY_ADOC_OPTIONS_DEFAULT_FALSE =
         %w(hierarchical-assets break-up-urls-in-tables toc-figures
@@ -88,8 +88,8 @@ module Metanorma
       def extract_options(file)
         header = file.sub(/\n\n.*$/m, "\n")
         ret = ADOC_OPTIONS.each_with_object({}) do |w, acc|
-          m = /\n:#{w}: ([^\n]+)\n/.match(header) or next
-          acc[attr_name_normalise(w)] = m[1]
+          m = /\n:#{w}:\s+([^\n]+)\n/.match(header) or next
+          acc[attr_name_normalise(w)] = m[1]&.strip
         end
         ret2 = EMPTY_ADOC_OPTIONS_DEFAULT_TRUE.each_with_object({}) do |w, acc|
           m = /\n:#{w}:([^\n]*)\n/.match(header) || [nil, "true"]

data/lib/metanorma/version.rb

@@ -1,3 +1,3 @@
 module Metanorma
-  VERSION = "1.5.5".freeze
+  VERSION = "1.5.6".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma
 version: !ruby/object:Gem::Version
-  version: 1.5.5
+  version: 1.5.6
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-24 00:00:00.000000000 Z
+date: 2023-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor