metanorma-standoc 2.8.3 → 2.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76c0e218fd82abc53141b42753ee4cbc14956ee9ccc75f1e8115bf91ac6a0eb6
-  data.tar.gz: 532c96be450bb8f4a234ec5f6cd6c032d71fe89e20ad46e1f48195137b108c94
+  metadata.gz: c543029f3b14b657d9688b9fd220df2a476c0d34a50eafd89bc7a94342a59fe0
+  data.tar.gz: 6c84b411e9fd00947893827f821a63f6877b3fab227873611fe76e6793776bf5
 SHA512:
-  metadata.gz: bab6d097fc885f64299d90ceed88dc475c951ff7c916f176e504aaca63336b69e62bb12c48059004fe757200a448a15fd4c798ffcd2e7f9b7c04444259431799
-  data.tar.gz: 6acb021a5f5348caa7c625db4d54a9a2af9e26e1720318cdd77a54c77bc0c734109c600d96a95d2a5a161bc5eb28f6db2336f06dee75bd896733fef8a600f1bf
+  metadata.gz: eb65532e33f4114c5a268094f26053338b5dc56911f1801d3a78b4f61b6f1e9ed5d5689d2a6cf22a02d2c06266fb1758a809edf078c353933222c4fd64eba552
+  data.tar.gz: 9b2b1c7bd047da5dc81128e00f04da4b4f9e735699e542568665577167889ad9b671bad82fa72b4147f85a3263aa7a6e2923b1b444fe33f97e48f62c0bd9e0d8

data/lib/metanorma/standoc/base.rb

@@ -8,6 +8,7 @@ require "fileutils"
 require "metanorma-utils"
 require_relative "render"
 require_relative "localbib"
+require_relative "init"
 require "mn-requirements"
 
 module Metanorma
@@ -27,116 +28,6 @@ module Metanorma
         self.class::XML_NAMESPACE
       end
 
-      def init(node)
-        init_vars
-        init_misc(node)
-        init_processing(node)
-        init_reqt(node)
-        init_toc(node)
-        init_output(node) # feeds init_biblio
-        init_i18n(node)
-        init_biblio(node)
-        @metadata_attrs = metadata_attrs(node)
-      end
-
-      def init_vars
-        @log = Metanorma::Utils::Log.new # for error reporting downstream
-        @fn_number ||= 0
-        @refids = Set.new
-        @anchor_alias = {}
-        @anchors = {}
-        @internal_eref_namespaces = []
-        @seen_headers = []
-        @seen_headers_canonical = []
-        @embed_hdr = []
-        @reqt_model = nil
-        @preface = true
-      end
-
-      def init_misc(node)
-        @doctype = doctype(node)
-        @draft = node.attributes.has_key?("draft")
-        @index_terms = node.attr("index-terms")
-        @boilerplateauthority = node.attr("boilerplate-authority")
-        @embed_hdr = node.attr("embed_hdr")
-        @embed_id = node.attr("embed_id")
-        @document_scheme = node.attr("document-scheme")
-        @xrefstyle = node.attr("xrefstyle")
-        @source_linenums = node.attr("source-linenums-option") == "true"
-      end
-
-      def init_processing(node)
-        @novalid = node.attr("novalid")
-        @smartquotes = node.attr("smartquotes") != "false"
-        @keepasciimath = node.attr("mn-keep-asciimath") &&
-          node.attr("mn-keep-asciimath") != "false"
-        @sourcecode_markup_start = node.attr("sourcecode-markup-start") || "{{{"
-        @sourcecode_markup_end = node.attr("sourcecode-markup-end") || "}}}"
-        @datauriimage = node.attr("data-uri-image") != "false"
-        @blockunnumbered = (node.attr("block-unnumbered") || "").split(",")
-          .map(&:strip)
-      end
-
-      def init_reqt(node)
-        @default_requirement_model = node.attr("requirements-model") ||
-          default_requirement_model
-        @reqt_models = requirements_processor
-          .new({ default: @default_requirement_model })
-      end
-
-      def init_toc(node)
-        @htmltoclevels = node.attr("toclevels-html") ||
-          node.attr("htmltoclevels") ||
-          node.attr("toclevels") || toc_default[:html_levels]
-        @doctoclevels = node.attr("toclevels-doc") ||
-          node.attr("doctoclevels") || node.attr("toclevels") ||
-          toc_default[:word_levels]
-        @pdftoclevels = node.attr("toclevels-pdf") ||
-          node.attr("toclevels") || toc_default[:pdf_levels]
-        @toclevels = node.attr("toclevels") || toc_default[:html_levels]
-        @tocfigures = node.attr("toc-figures")
-        @toctables = node.attr("toc-tables")
-        @tocrecommendations = node.attr("toc-recommendations")
-      end
-
-      def toc_default
-        { word_levels: 2, html_levels: 2, pdf_levels: 2 }
-      end
-
-      def init_output(node)
-        @fontheader = default_fonts(node)
-        @files_to_delete = []
-        @filename = if node.attr("docfile")
-                      File.basename(node.attr("docfile"))&.gsub(/\.adoc$/, "")
-                    else ""
-                    end
-        @localdir = Metanorma::Utils::localdir(node)
-        @output_dir = outputdir node
-      end
-
-      def init_i18n(node)
-        @lang = node.attr("language") || "en"
-        @script = node.attr("script") ||
-          Metanorma::Utils.default_script(node.attr("language"))
-        @locale = node.attr("locale")
-        @isodoc = isodoc(@lang, @script, @locale, node.attr("i18nyaml"))
-        @i18n = @isodoc.i18n
-      end
-
-      def init_biblio(node)
-        @no_isobib_cache = node.attr("no-isobib-cache")
-        @no_isobib = node.attr("no-isobib")
-        @bibdb = nil
-        init_bib_caches(node)
-        init_iev_caches(node)
-        @local_bibdb =
-          ::Metanorma::Standoc::LocalBiblio.new(node, @localdir, self)
-      end
-
-      def requirements_processor
-        Metanorma::Requirements
-      end
-
       def document(node)
         ret = document1(node)
         clean_exit
@@ -179,7 +70,8 @@ module Metanorma
       end
 
       def clean_exit
-        @novalid or @log.write("#{@output_dir}#{@filename}.err.html")
+        !@novalid && @local_log and
+          @log.write("#{@output_dir}#{@filename}.err.html")
         @files_to_delete.each { |f| FileUtils.rm f }
       end
 
@@ -233,7 +125,7 @@ module Metanorma
       end
 
       def metadata_attrs(node)
-        node.attributes.each_with_object([]) do |(k, v), ret|
+        out = node.attributes.each_with_object([]) do |(k, v), ret|
           %w(presentation semantic).each do |t|
             /^#{t}-metadata-/.match?(k) or next
             k = k.sub(/^#{t}-metadata-/, "")
@@ -242,6 +134,17 @@ module Metanorma
             end
           end
         end.join
+        out + document_scheme_metadata(node)
+      end
+
+      def document_scheme_metadata(node)
+        a = document_scheme(node) or return ""
+        "<presentation-metadata><name>document-scheme</name>" \
+          "<value>#{a}</value></presentation-metadata>"
+      end
+
+      def document_scheme(node)
+        node.attr("document-scheme")
       end
 
       private

data/lib/metanorma/standoc/cleanup_image.rb

@@ -4,7 +4,6 @@ module Metanorma
   module Standoc
     module Cleanup
       def svgmap_cleanup(xmldoc)
-        svg_uniqueids(xmldoc)
         svgmap_moveattrs(xmldoc)
         svgmap_populate(xmldoc)
         Vectory::SvgMapping.new(xmldoc, @localdir).call
@@ -82,7 +81,7 @@ module Metanorma
         types = MIME::Types.type_for(path) or return false
         types.first == "image/svg+xml" or return false
         svg = File.read(path, encoding: "utf-8") or return false
-        img.replace(Nokogiri::XML(svg).root)
+        img.children = (Nokogiri::XML(svg).root)
         true
       end
 

data/lib/metanorma/standoc/cleanup_xref.rb

@@ -76,9 +76,8 @@ module Metanorma
       def extract_localities_update_text(match)
         ret = match[:text]
         re = to_regex(LOCALITY_REGEX_VALUE_ONLY_STR)
-        if re.match?(ret) && match[:punct] == ";"
+        re.match?(ret) && match[:punct] == ";" and
           ret.sub!(%r{^(#{CONN_REGEX_STR})}o, "\\1#{match[:locality]}=")
-        end
         ret
       end
 
@@ -93,15 +92,13 @@ module Metanorma
       end
 
       def fill_in_eref_connectives(elem)
-        return if elem.xpath("./localityStack").size < 2
-
+        elem.xpath("./localityStack").size < 2 and return
         elem.xpath("./localityStack[not(@connective)]").each do |l|
           n = l.next_element
           l["connective"] = if n && n.name == "localityStack" &&
               n["connective"] == "to"
                               "from"
-                            else "and"
-                            end
+                            else "and" end
         end
       end
 
@@ -193,9 +190,8 @@ module Metanorma
       def xref_parse_compound_locations(locations)
         l = locations.map { |y| y.split("!", 2) }
         l.map.with_index do |y, i|
-          if y.size == 1
+          y.size == 1 and
             y.unshift(l.dig(i + 1, 0) == "to" ? "from" : "and")
-          end
           y
         end
       end
@@ -209,8 +205,7 @@ module Metanorma
       def xref_cleanup1(xmldoc)
         xmldoc.xpath("//xref").each do |x|
           %r{:(?!//)}.match?(x["target"]) and xref_to_internal_eref(x)
-          next unless x.name == "xref"
-
+          x.name == "xref" or next
           if refid? x["target"]
             xref_to_eref(x, "eref")
           elsif @anchor_alias[x["target"]] then xref_alias(x)

data/lib/metanorma/standoc/converter.rb

@@ -21,6 +21,7 @@ module Metanorma
     # schema encapsulation of the document for validation
     class Converter
       Asciidoctor::Extensions.register do
+        preprocessor Metanorma::Standoc::ResolveIncludePreprocessor
         preprocessor Metanorma::Plugin::Lutaml::LutamlPreprocessor
         preprocessor Metanorma::Plugin::Lutaml::LutamlUmlAttributesTablePreprocessor
         preprocessor Metanorma::Plugin::Lutaml::LutamlUmlDatamodelDescriptionPreprocessor
@@ -100,6 +101,10 @@ module Metanorma
         outfilesuffix ".xml"
         @libdir = File.dirname(self.class::_file || __FILE__)
         @c = HTMLEntities.new
+        unless opts && @log = opts[:document]&.options&.dig(:log)
+          @log = Metanorma::Utils::Log.new
+          @local_log = true
+        end
       end
 
       class << self

data/lib/metanorma/standoc/init.rb

@@ -0,0 +1,114 @@
+module Metanorma
+  module Standoc
+    module Base
+      def init(node)
+        init_vars
+        init_misc(node)
+        init_processing(node)
+        init_reqt(node)
+        init_toc(node)
+        init_output(node) # feeds init_biblio
+        init_i18n(node)
+        init_biblio(node)
+        @metadata_attrs = metadata_attrs(node)
+      end
+
+      def init_vars
+        @fn_number ||= 0
+        @refids = Set.new
+        @anchor_alias = {}
+        @anchors = {}
+        @internal_eref_namespaces = []
+        @seen_headers = []
+        @seen_headers_canonical = []
+        @embed_hdr = []
+        @reqt_model = nil
+        @preface = true
+      end
+
+      def init_misc(node)
+        @doctype = doctype(node)
+        @draft = node.attributes.has_key?("draft")
+        @index_terms = node.attr("index-terms")
+        @boilerplateauthority = node.attr("boilerplate-authority")
+        @embed_hdr = node.attr("embed_hdr")
+        @embed_id = node.attr("embed_id")
+        @document_scheme = node.attr("document-scheme")
+        @xrefstyle = node.attr("xrefstyle")
+        @source_linenums = node.attr("source-linenums-option") == "true"
+      end
+
+      def init_processing(node)
+        @novalid = node.attr("novalid")
+        @smartquotes = node.attr("smartquotes") != "false"
+        @keepasciimath = node.attr("mn-keep-asciimath") &&
+          node.attr("mn-keep-asciimath") != "false"
+        @sourcecode_markup_start = node.attr("sourcecode-markup-start") || "{{{"
+        @sourcecode_markup_end = node.attr("sourcecode-markup-end") || "}}}"
+        @datauriimage = node.attr("data-uri-image") != "false"
+        @blockunnumbered = (node.attr("block-unnumbered") || "").split(",")
+          .map(&:strip)
+      end
+
+      def init_reqt(node)
+        @default_requirement_model = node.attr("requirements-model") ||
+          default_requirement_model
+        @reqt_models = requirements_processor
+          .new({ default: @default_requirement_model })
+      end
+
+      def init_toc(node)
+        @htmltoclevels = node.attr("toclevels-html") ||
+          node.attr("htmltoclevels") ||
+          node.attr("toclevels") || toc_default[:html_levels]
+        @doctoclevels = node.attr("toclevels-doc") ||
+          node.attr("doctoclevels") || node.attr("toclevels") ||
+          toc_default[:word_levels]
+        @pdftoclevels = node.attr("toclevels-pdf") ||
+          node.attr("toclevels") || toc_default[:pdf_levels]
+        @toclevels = node.attr("toclevels") || toc_default[:html_levels]
+        @tocfigures = node.attr("toc-figures")
+        @toctables = node.attr("toc-tables")
+        @tocrecommendations = node.attr("toc-recommendations")
+      end
+
+      def toc_default
+        { word_levels: 2, html_levels: 2, pdf_levels: 2 }
+      end
+
+      def init_output(node)
+        @fontheader = default_fonts(node)
+        @files_to_delete = []
+        @filename = if node.attr("docfile")
+                      File.basename(node.attr("docfile"))&.gsub(/\.adoc$/, "")
+                    else ""
+                    end
+        @localdir = Metanorma::Utils::localdir(node)
+        @output_dir = outputdir node
+      end
+
+      def init_i18n(node)
+        @lang = node.attr("language") || "en"
+        @script = node.attr("script") ||
+          Metanorma::Utils.default_script(node.attr("language"))
+        @locale = node.attr("locale")
+        @isodoc = isodoc(@lang, @script, @locale, node.attr("i18nyaml"))
+        @i18n = @isodoc.i18n
+      end
+
+      def init_biblio(node)
+        @no_isobib_cache = node.attr("no-isobib-cache")
+        @no_isobib = node.attr("no-isobib")
+        @bibdb = nil
+        init_bib_caches(node)
+        init_iev_caches(node)
+        @local_bibdb =
+          ::Metanorma::Standoc::LocalBiblio.new(node, @localdir, self)
+      end
+
+      def requirements_processor
+        Metanorma::Requirements
+      end
+    end
+  end
+end

data/lib/metanorma/standoc/inline.rb

@@ -30,7 +30,7 @@ module Metanorma
         results = Plurimath::Math.parse(lxm_input, "latex")
           .to_mathml(display_style: block)
         if results.nil?
-          @log.add("Math", nil,
+          @log.add("Maths", nil,
                    "latexmlmath failed to process equation:\n#{lxm_input}",
                    severity: 1)
           return

data/lib/metanorma/standoc/macros_embed.rb

@@ -2,14 +2,37 @@ require "pathname"
 
 module Asciidoctor
   class PreprocessorNoIfdefsReader < PreprocessorReader
-    def preprocess_conditional_directive(keyword, target, delimiter, text)
+    private
+
+    def preprocess_conditional_directive(_keyword, _target, _delimiter, _text)
       false # decline to resolve idefs
     end
+
+    def resolve_include_path(expanded_target, attrlist, parsed_attrs)
+      inc_path, target_type, relpath = super
+      if inc_path && !%i(file uri).include?(target_type)
+        # include has been skipped because of error
+        n = peek_line(true)
+        /^Unresolved directive in/.match?(n) and
+          @document.converter.log
+            &.add("Include", nil,
+                  HTMLEntities.new.encode(n, :basic), severity: 0)
+      end
+      [inc_path, target_type, relpath]
+    end
   end
 end
 
 module Metanorma
   module Standoc
+    # resolve all includes before doing any further preprocessing
+    class ResolveIncludePreprocessor < Asciidoctor::Extensions::Preprocessor
+      def process(doc, reader)
+        r = ::Asciidoctor::PreprocessorNoIfdefsReader.new doc, reader.lines
+        ::Asciidoctor::PreprocessorNoIfdefsReader.new doc, r.readlines
+      end
+    end
+
     class EmbedIncludeProcessor < Asciidoctor::Extensions::Preprocessor
       def process(doc, reader)
         reader.eof? and return reader
@@ -44,12 +67,12 @@ module Metanorma
         reader = ::Asciidoctor::PreprocessorReader.new doc
         b = Pathname.new doc.base_dir
         ret.reverse.each do |l|
-          if l[:file]
-            new = Pathname.new(l[:path]).relative_path_from(b).to_s
-            #reader.push_include l[:lines], new, l[:path]
-            reader.unshift_lines l[:lines]
-          else reader.unshift_lines l[:lines]
-          end
+          # if l[:file]
+          # new = Pathname.new(l[:path]).relative_path_from(b).to_s
+          # reader.push_include l[:lines], new, l[:path]
+          reader.unshift_lines l[:lines]
+          # else reader.unshift_lines l[:lines]
+          # end
         end
         reader
       end

data/lib/metanorma/standoc/macros_inline.rb

@@ -27,7 +27,7 @@ module Metanorma
         attrs.size > 1 && attrs.size < 5 and return true
         e = "invalid index \"#{target}\" cross-reference: wrong number of " \
             "attributes in `index:#{target}[#{attrs.values.join(',')}]`"
-        parent.converter.log.add("Index", parent, e, severity: 0)
+        parent.converter.log.add("Crossreferences", parent, e, severity: 0)
         false
       end
 

data/lib/metanorma/standoc/ref_queue.rb

@@ -213,8 +213,7 @@ module Metanorma
       end
 
       def init_bib_caches(node)
-        return if @no_isobib
-
+        @no_isobib and return
         global = !@no_isobib_cache && !node.attr("local-cache-only")
         local = node.attr("local-cache") || node.attr("local-cache-only")
         local = nil if @no_isobib_cache

data/lib/metanorma/standoc/validate.rb

@@ -53,7 +53,7 @@ module Metanorma
         orig = ""
         a and orig += "\n\tAsciimath original: #{@c.decode(a.children.to_xml)}"
         l and orig += "\n\tLatexmath original: #{@c.decode(l.children.to_xml)}"
-        @log.add("Mathematics", elem,
+        @log.add("Maths", elem,
                  "Invalid MathML: #{math}\n #{error}#{orig}", severity: 0)
       end
 
@@ -83,7 +83,7 @@ module Metanorma
         outer.name == "figure" && inner.name == "figure" and return
         err =
           "There is an instance of #{inner.name} nested within #{outer.name}"
-        @log.add("Syntax", inner, err)
+        @log.add("Style", inner, err)
         nested_asset_xref_report(outer, inner, doc)
       end
 

data/lib/metanorma/standoc/validate_section.rb

@@ -21,14 +21,14 @@ module Metanorma
         if callouts.size != annotations.size && !annotations.empty?
           err = "mismatch of callouts (#{callouts.size}) and annotations " \
                 "(#{annotations.size})"
-          @log.add("AsciiDoc Input", elem, err, severity: 0)
+          @log.add("Crossreferences", elem, err, severity: 0)
         end
       end
 
       def style_warning(node, msg, text = nil)
         w = msg
         w += ": #{text}" if text
-        @log.add("Metanorma XML Style Warning", node, w)
+        @log.add("Style", node, w)
       end
 
       def asset_title_style(root)
@@ -61,7 +61,7 @@ module Metanorma
           docid = b.at("./docidentifier[@type = 'metanorma']") or next
           /^\[\d+\]$/.match?(docid.text) or next
           @log.add("Bibliography", b,
-                   "Numeric reference in normative references", severity: 0)
+                   "Numeric reference in normative references", severity: 1)
         end
       end
     end

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "2.8.3".freeze
+    VERSION = "2.8.5".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-standoc
 version: !ruby/object:Gem::Version
-  version: 2.8.3
+  version: 2.8.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-04 00:00:00.000000000 Z
+date: 2024-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -503,6 +503,7 @@ files:
 - lib/metanorma/standoc/front.rb
 - lib/metanorma/standoc/front_contributor.rb
 - lib/metanorma/standoc/front_organisation.rb
+- lib/metanorma/standoc/init.rb
 - lib/metanorma/standoc/inline.rb
 - lib/metanorma/standoc/isodoc-compile.rng
 - lib/metanorma/standoc/isodoc.rng