metanorma-standoc 1.3.20 → 1.3.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b599dbb549f1bb38b237e1bb8463162420d93939f424f10937ee589a7ae12218
-  data.tar.gz: 3ad036f4058f7aed94269495553e1ea5be516a10f59af7f8f669e42d117709f1
+  metadata.gz: c62f787dbc1d97b2175f66f6130d2b365af18bedffa9de98a236f39f756c3ae8
+  data.tar.gz: 9d5225d78dc9168036d78f8a4765010efe5017deeaa9ba14b38073ab5c35f26b
 SHA512:
-  metadata.gz: 1d542f2813cc0f5fd7280d4d9f642ef4f63bc45e6003e93819a3826f4a9d1b303d5dbd7f28ba07088191bd1ec098d7c037dced992ee3a8086c1d11853d6c2afc
-  data.tar.gz: 46a117312369b8738f561401ad03fc71f68ec5f7dee6f5f2370dd7a53be95a5f0abf704da62d8bcb56e7a6026af8bfc0ddf5843707b643bdf5b37f949bd7311a
+  metadata.gz: e35a45da117851d8eb4802262438c056d9813c840ecbc7bd0775f81d1b2effe03e7e9697ebfe92db2962b05ff20d62f708c274786491fcafb6fba14c92480967
+  data.tar.gz: d8e98169fb0e2696063c28feb8e52c2b0305c83755cfe415f0c29de468465b2ed0d36c06f4502f0a9a0b924d083f64ed1675808b563c9c6f6f004e40530c3fd6

data/lib/asciidoctor/standoc/base.rb

@@ -18,6 +18,7 @@ module Asciidoctor
         inline_macro Asciidoctor::Standoc::AltTermInlineMacro
         inline_macro Asciidoctor::Standoc::DeprecatedTermInlineMacro
         inline_macro Asciidoctor::Standoc::DomainTermInlineMacro
+        inline_macro Asciidoctor::Standoc::InheritInlineMacro
         inline_macro Asciidoctor::Standoc::HTML5RubyMacro
         inline_macro Asciidoctor::Standoc::ConceptInlineMacro
         block Asciidoctor::Standoc::ToDoAdmonitionBlock
@@ -32,8 +33,9 @@ module Asciidoctor
 
       def skip(node, name = nil)
         name = name || node.node_name
-        w = "converter missing for #{name} node in ISO backend"
-        Utils::warning(node, w, nil)
+        w = "converter missing for #{name} node in Metanorma backend"
+        @log.add("Asciidoctor Input", node, w)
+        #Utils::warning(node, w, nil)
         nil
       end
 
@@ -105,6 +107,7 @@ module Asciidoctor
         @seen_headers = []
         @datauriimage = node.attr("data-uri-image")
         @boilerplateauthority = node.attr("boilerplate-authority")
+        @log = Asciidoctor::Standoc::Log.new
         init_bib_caches(node)
         init_iev_caches(node)
         lang = (node.attr("language") || "en")
@@ -156,6 +159,7 @@ module Asciidoctor
           html_converter(node).convert(@filename + ".xml")
           doc_converter(node).convert(@filename + ".xml")
         end
+        @log.write(@filename + ".err") unless @novalid
         @files_to_delete.each { |f| FileUtils.rm f }
         ret
       end
@@ -223,7 +227,8 @@ module Asciidoctor
       def extract_termsource_refs(text, node)
         matched = TERM_REFERENCE_RE.match text
         matched.nil? and
-          Utils::warning(node, "term reference not in expected format", text)
+          #Utils::warning(node, "term reference not in expected format", text)
+        @log.add("Asciidoctor Input", node, "term reference not in expected format: #{text}")
         matched
       end
 

data/lib/asciidoctor/standoc/cleanup_block.rb

@@ -138,6 +138,21 @@ module Asciidoctor
       end
 
       def requirement_cleanup(x)
+        requirement_descriptions(x)
+        requirement_inherit(x)
+      end
+
+      def requirement_inherit(x)
+        x.xpath("//requirement | //recommendation | //permission").each do |r|
+          ins = r.at("./classification") || 
+            r.at("./description | ./measurementtarget | ./specification | "\
+                 "./verification | ./import | ./description | ./requirement | "\
+                 "./recommendation | ./permission")
+          r.xpath("./*//inherit").each { |i| ins.previous = i }
+        end
+      end
+
+      def requirement_descriptions(x)
         x.xpath("//requirement | //recommendation | //permission").each do |r|
           r.children.each do |e|
             unless e.element? && (Utils::reqt_subpart(e.name) || 

data/lib/asciidoctor/standoc/cleanup_boilerplate.rb

@@ -15,8 +15,11 @@ module Asciidoctor
 
       def term_defs_boilerplate(div, source, term, preface, isodoc)
         div.next = @term_def_boilerplate
-        source.each { |s| @anchors[s["bibitemid"]] or
-                      warn "term source #{s['bibitemid']} not referenced" }
+        source.each do |s|
+          @anchors[s["bibitemid"]] or
+            @log.add("Crossreferences", nil, "term source #{s['bibitemid']} not referenced")
+                      #warn "term source #{s['bibitemid']} not referenced" 
+        end
         if source.empty? && term.nil?
           div.next = @no_terms_boilerplate
         else

data/lib/asciidoctor/standoc/cleanup_footnotes.rb

@@ -47,7 +47,7 @@ module Asciidoctor
         xmldoc.xpath("//table | //figure").each do |t|
           seen = {}
           i = 0
-          t.xpath(".//fn").each do |fn|
+          t.xpath(".//fn[not(ancestor::name)]").each do |fn|
             i, seen = table_footnote_renumber1(fn, i, seen)
           end
         end

data/lib/asciidoctor/standoc/cleanup_inline.rb

@@ -63,7 +63,8 @@ module Asciidoctor
       def xref_to_eref(x)
         x["bibitemid"] = x["target"]
         x["citeas"] = @anchors&.dig(x["target"], :xref) ||
-          warn("#{x['target']} is not a real reference!")
+          #warn("#{x['target']} is not a real reference!")
+        @log.add("Crossreferences", nil, "#{x['target']} is not a real reference!")
         x.delete("target")
         extract_localities(x) unless x.children.empty?
       end
@@ -88,7 +89,8 @@ module Asciidoctor
       def origin_cleanup(xmldoc)
         xmldoc.xpath("//origin").each do |x|
           x["citeas"] = @anchors&.dig(x["bibitemid"], :xref) ||
-            warn("#{x['bibitemid']} is not a real reference!")
+        #    warn("#{x['bibitemid']} is not a real reference!")
+        @log.add("Crossreferences", nil, "#{x['bibitemid']} is not a real reference!")
           extract_localities(x) unless x.children.empty?
         end
       end

data/lib/asciidoctor/standoc/cleanup_ref.rb

@@ -11,15 +11,36 @@ module Asciidoctor
       end
 
       def biblio_reorder1(refs)
+        fold_notes_into_biblio(refs)
         bib = sort_biblio(refs.xpath("./bibitem"))
+        insert = refs&.at("./bibitem")&.previous_element
         refs.xpath("./bibitem").each { |b| b.remove }
         bib.reverse.each do |b|
-          insert = refs.at("./title") and insert.next = b.to_xml or
+          insert and insert.next = b.to_xml or
             refs.children.first.add_previous_sibling b.to_xml
         end
+        extract_notes_from_biblio(refs)
         refs.xpath("./references").each { |r| biblio_reorder1(r) }
       end
 
+      def fold_notes_into_biblio(refs)
+        refs.xpath("./bibitem").each do |r|
+          while r&.next_element&.name == "note" do
+            r.next_element["appended"] = true
+            r << r.next_element.remove
+          end
+        end
+      end
+
+      def extract_notes_from_biblio(refs)
+        refs.xpath("./bibitem").each do |r|
+          r.xpath("./note[@appended]").reverse.each do |n|
+            n.delete("appended")
+            r.next = n
+          end
+        end
+      end
+
       def sort_biblio(bib)
         bib
       end
@@ -47,9 +68,10 @@ module Asciidoctor
 
       def normref_cleanup(xmldoc)
         r = xmldoc.at(NORM_REF) || return
-        r.elements.each do |n|
-          n.remove unless ["title", "bibitem"].include? n.name
-        end
+        #return if r.at("./bibitem[1]/preceding-sibling::*[1][local-name()='title']")
+        preface = r.xpath("./title/following-sibling::*") &
+          r.xpath("./bibitem[1]/preceding-sibling::*")
+        preface.each { |n| n.remove }
       end
 
       def biblio_cleanup(xmldoc)

data/lib/asciidoctor/standoc/converter.rb

@@ -14,6 +14,7 @@ require "asciidoctor/standoc/cleanup"
 require "asciidoctor/standoc/i18n"
 require "asciidoctor/standoc/reqt"
 require_relative "./macros.rb"
+require_relative "./log.rb"
 
 module Asciidoctor
   module Standoc
@@ -43,7 +44,6 @@ module Asciidoctor
         super
         basebackend "html"
         outfilesuffix ".xml"
-        #@libdir = File.dirname(__FILE__)
         @libdir = File.dirname(self.class::_file || __FILE__)
       end
 

data/lib/asciidoctor/standoc/isodoc.rng

@@ -645,6 +645,11 @@
     <optional>
       <attribute name="script"/>
     </optional>
+    <optional>
+      <attribute name="inline-header">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
     <optional>
       <attribute name="obligation">
         <choice>

data/lib/asciidoctor/standoc/lists.rb

@@ -12,16 +12,34 @@ module Asciidoctor
         end
       end
 
+      def ul_li(xml_ul, item)
+        xml_ul.li **ul_li_attr(item) do |xml_li|
+          if item.blocks?
+            xml_li.p(**id_attr(item)) { |t| t << item.text }
+            xml_li << item.content
+          else
+            xml_li.p(**id_attr(item)) { |p| p << item.text }
+          end
+        end
+      end
+
       def ul_attr(node)
         attr_code(id_attr(node))
       end
 
+      def ul_li_attr(node)
+        attr_code(
+          uncheckedcheckbox: node.attr?("checkbox") ? !node.attr?("checked") : nil,
+          checkedcheckbox: node.attr?("checkbox") ? node.attr?("checked") : nil,
+        )
+      end
+
       def ulist(node)
         return reference(node) if in_norm_ref? || in_biblio?
         noko do |xml|
           xml.ul **ul_attr(node) do |xml_ul|
             node.items.each do |item|
-              li(xml_ul, item)
+              ul_li(xml_ul, item)
             end
           end
         end.join("\n")
@@ -37,7 +55,7 @@ module Asciidoctor
 
       def ol_attr(node)
         attr_code(id: Utils::anchor_or_uuid(node),
-                             type: olist_style(node.style))
+                  type: olist_style(node.style))
       end
 
       def olist(node)

data/lib/asciidoctor/standoc/log.rb

@@ -0,0 +1,50 @@
+module Asciidoctor
+  module Standoc
+    class Log
+      def initialize
+        @log = {}
+      end
+
+      def add(category, loc, msg)
+        return if @novalid
+        @log[category] = [] unless @log[category]
+        @log[category] << { location: current_location(loc), message: msg }
+        loc = loc.nil? ? "" : "(#{current_location(loc)}): "
+        warn "#{category}: #{loc}#{msg}" 
+      end
+
+      def current_location(n)
+        return "" if n.nil?
+        return n if n.is_a? String
+        return "Asciidoctor Line #{"%06d" % n.lineno}" if n.respond_to?(:lineno) &&
+          !n.lineno.nil? && !n.lineno.empty?
+        return "XML Line #{"%06d" % n.line}" if n.respond_to?(:line) &&
+          !n.line.nil?
+        return "ID #{n.id}" if n.respond_to?(:id) && !n.id.nil?
+        while !n.nil? &&
+            (!n.respond_to?(:level) || n.level.positive?) &&
+            (!n.respond_to?(:context) || n.context != :section)
+          n = n.parent
+          return "Section: #{n.title}" if n&.respond_to?(:context) &&
+            n&.context == :section
+        end
+        "??"
+      end
+
+      def write(file)
+        File.open(file, "w:UTF-8") do |f|
+          f.puts "#{file} errors"
+          @log.keys.each do |key|
+            f.puts "\n\n== #{key}\n\n"
+            @log[key].sort do |a, b|
+              a[:location] <=> b[:location]
+            end.each do |n|
+              loc = n[:location] ? "(#{n[:location]}): " : ""
+              f.puts "#{loc}#{n[:message]}" 
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/standoc/macros.rb

@@ -41,6 +41,18 @@ module Asciidoctor
       end
     end
 
+    class InheritInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+      use_dsl
+      named :inherit
+      parse_content_as :text
+      using_format :short
+
+      def process(parent, _target, attrs)
+        out = Asciidoctor::Inline.new(parent, :quoted, attrs["text"]).convert
+        %{<inherit>#{out}</inherit>}
+      end
+    end
+
     class ConceptInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl
       named :concept

data/lib/asciidoctor/standoc/ref.rb

@@ -43,7 +43,7 @@ module Asciidoctor
 
       def docid(t, code)
         type, code1 = /^\[\d+\]$|^\([^)]+\).*$/.match(code) ?
-          ["metanorma", Utils::mn_code(code)] :
+          ["metanorma", mn_code(code)] :
           @bibdb&.docid_type(code) || [nil, code]
         code1.sub!(/^nofetch\((.+)\)$/, "\\1")
         t.docidentifier code1, **attr_code(type: type)
@@ -123,10 +123,12 @@ module Asciidoctor
         code = code.sub(/^\([^)]+\)/, "")
         hit = @bibdb&.fetch(code, year, opts)
         return nil if hit.nil?
-        xml.parent.add_child(Utils::smart_render_xml(hit, code, opts[:title], opts[:usrlbl]))
+        xml.parent.add_child(smart_render_xml(hit, code, opts[:title],
+                                              opts[:usrlbl]))
         xml
       rescue RelatonBib::RequestError
-        warn "Could not retrieve #{code}: no access to online site"
+        @log.add("Bibliography", nil, "Could not retrieve #{code}: "\
+                 "no access to online site")
         nil
       end
 
@@ -140,34 +142,31 @@ module Asciidoctor
         end
       end
 
-      MALFORMED_REF = 
-        "no anchor on reference, markup may be malformed: "\
-        "see https://www.metanorma.com/author/topics/document-format/bibliography/ , "\
+      MALFORMED_REF = "no anchor on reference, markup may be malformed: see "\
+        "https://www.metanorma.com/author/topics/document-format/bibliography/ , "\
         "https://www.metanorma.com/author/iso/topics/markup/#bibliographies".freeze
 
       # TODO: alternative where only title is available
       def refitem(xml, item, node)
         unless m = NON_ISO_REF.match(item)
-          Utils::warning(node, MALFORMED_REF, item)
+          @log.add("Asciidoctor Input", node, "#{MALFORMED_REF}: #{item}")
           return
         end
         unless m[:code] && /^\d+$/.match(m[:code])
           ref = fetch_ref xml, m[:code],
-            m.names.include?("year") ? m[:year] : nil, title: m[:text], usrlbl: m[:usrlbl]
+            m.names.include?("year") ? m[:year] : nil, title: m[:text],
+            usrlbl: m[:usrlbl]
           return use_my_anchor(ref, m[:anchor]) if ref
         end
         refitem_render(xml, m)
       end
 
       def ref_normalise(ref)
-        ref.
-          gsub(/&/, "&").
-          gsub(%r{^<em>(.*)</em>}, "\\1")
+        ref.gsub(/&amp;amp;/, "&amp;").gsub(%r{^<em>(.*)</em>}, "\\1")
       end
 
       def ref_normalise_no_format(ref)
-        ref.
-          gsub(/&amp;amp;/, "&amp;")
+        ref.gsub(/&amp;amp;/, "&amp;")
       end
 
       ISO_REF = %r{^<ref\sid="(?<anchor>[^"]+)">
@@ -188,8 +187,6 @@ module Asciidoctor
         \[(?<usrlbl>\([^)]+\))?(?<code>[^\]]+?)([:-](?<year>(19|20)[0-9][0-9]))?\]</ref>,?\s*
           (?<text>.*)$}xm
 
-          # @param item [String]
-          # @return [Array<MatchData>]
           def reference1_matches(item)
             matched = ISO_REF.match item
             matched2 = ISO_REF_NO_YEAR.match item
@@ -197,9 +194,6 @@ module Asciidoctor
             [matched, matched2, matched3]
         end
 
-        # @param node [Asciidoctor::List]
-        # @param item [String]
-        # @param xml [Nokogiri::XML::Builder]
         def reference1(node, item, xml)
           matched, matched2, matched3 = reference1_matches(item)
           if matched3.nil? && matched2.nil? && matched.nil?
@@ -228,6 +222,36 @@ module Asciidoctor
           cachename = "iev" if cachename.empty?
           "#{cachename}/cache"
         end
+
+        def mn_code(code)
+          code.sub(/^\(/, "[").sub(/\).*$/, "]").sub(/^nofetch\((.+)\)$/, "\\1")
+        end
+
+        def emend_biblio(xml, code, title, usrlbl)
+          unless xml.at("/bibitem/docidentifier[not(@type = 'DOI')][text()]")
+            @log.add("Bibliography", nil,
+                     "ERROR: No document identifier retrieved for #{code}")
+            xml.root << "<docidentifier>#{code}</docidentifier>"
+          end
+          unless xml.at("/bibitem/title[text()]")
+            @log.add("Bibliography", nil,
+                     "ERROR: No title retrieved for #{code}")
+            xml.root << "<title>#{title || "(MISSING TITLE)"}</title>"
+          end
+          usrlbl and xml.at("/bibitem/docidentifier").next =
+            "<docidentifier type='metanorma'>#{mn_code(usrlbl)}</docidentifier>"
+        end
+
+        def smart_render_xml(x, code, title, usrlbl)
+          xstr = x.to_xml if x.respond_to? :to_xml
+          xml = Nokogiri::XML(xstr)
+          emend_biblio(xml, code, title, usrlbl)
+          xml.xpath("//date").each { |d| Utils::endash_date(d) }
+          xml.traverse do |n|
+            n.text? and n.replace(Utils::smartformat(n.text))
+          end
+          xml.to_xml.sub(/<\?[^>]+>/, "")
+        end
     end
   end
 end

data/lib/asciidoctor/standoc/section.rb

@@ -138,7 +138,8 @@ module Asciidoctor
 
       def bibliography_parse(attrs, xml, node)
         node.attr("style") == "bibliography" or
-          warn "Section not marked up as [bibliography]!"
+          #warn "Section not marked up as [bibliography]!"
+          @log.add("Asciidoctor Input", node, "Section not marked up as [bibliography]!")
         @biblio = true
         xml.references **attr_code(attrs) do |xml_section|
           title = node.level == 1 ? "Bibliography" : node.title