metanorma-standoc 1.3.13 → 1.3.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b16743c6cababdcfb502e0ccef65e77072b276867638514b9ff988cc9584793a
-  data.tar.gz: ffd9dfdcbf85f8972eb9f298b2b23ed2be6a3d4c8c87ca0f1ccd49b5408ba664
+  metadata.gz: 5f57016af79feef706f7aa6f7ed25429151d28a991a1256d18a7c7f360398a57
+  data.tar.gz: deb09cc891267c6e447284b92cb4a62681ec2663c80be7ff6e1e6c9c6b0e58ef
 SHA512:
-  metadata.gz: 42f8d5d52e2b19588ea8bbea704ca28a8d5ab70640655adea14d5883547e18a0ccc32863af8ccb31b1fd23b3702406fcd529136f62921e459178cbdbfe5d28a5
-  data.tar.gz: e3d81d777d2dc81cb911f1131c725e3e4d34609e902a253d8ad8a8266a0a3885142ca2b3aff275cc739b5d4114b2ee8cc172289d44c143bd4ad17fd7d3214444
+  metadata.gz: 6f28f65b3aa564d8fba875a77237fe4841920cf05823cfc849a65c24b582ced8037ff719e6463526e673ee151f3f00898884141f395ac3ad996ef3e225e081b4
+  data.tar.gz: 44124272721075937694660b04f7bb1ad3b3348069aa2f56a4353befdd8311f49575686db43a27006b84a5e95173c8a9a4eaf763475baf803f7ffb663f393b4c

data/.github/workflows/macos.yml

@@ -2,7 +2,11 @@
 # use ci-master https://github.com/metanorma/metanorma-build-scripts
 name: macos
 
-on: [push, pull_request]
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ '**' ]
 
 jobs:
   test-macos:

data/.github/workflows/ubuntu.yml

@@ -2,7 +2,11 @@
 # use ci-master https://github.com/metanorma/metanorma-build-scripts
 name: ubuntu
 
-on: [push, pull_request]
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ '**' ]
 
 jobs:
   test-linux:

data/.github/workflows/windows.yml

@@ -2,7 +2,11 @@
 # use ci-master https://github.com/metanorma/metanorma-build-scripts
 name: windows
 
-on: [push, pull_request]
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ '**' ]
 
 jobs:
   test-windows:

data/lib/asciidoctor/standoc/base.rb

@@ -17,6 +17,7 @@ module Asciidoctor
         inline_macro Asciidoctor::Standoc::DeprecatedTermInlineMacro
         inline_macro Asciidoctor::Standoc::DomainTermInlineMacro
         inline_macro Asciidoctor::Standoc::HTML5RubyMacro
+        inline_macro Asciidoctor::Standoc::ConceptInlineMacro
         block Asciidoctor::Standoc::ToDoAdmonitionBlock
         treeprocessor Asciidoctor::Standoc::ToDoInlineAdmonitionBlock
         block Asciidoctor::Standoc::PlantUMLBlockMacro

data/lib/asciidoctor/standoc/basicdoc.rng

@@ -55,9 +55,6 @@
     <zeroOrMore>
       <ref name="BasicBlock"/>
     </zeroOrMore>
-    <zeroOrMore>
-      <ref name="note"/>
-    </zeroOrMore>
   </define>
   <define name="references">
     <element name="references">
@@ -99,6 +96,10 @@
       <ref name="example"/>
       <ref name="review"/>
       <ref name="pre"/>
+      <ref name="note"/>
+      <ref name="pagebreak"/>
+      <ref name="hr"/>
+      <ref name="bookmark"/>
     </choice>
   </define>
   <define name="paragraph">
@@ -341,7 +342,14 @@
   <define name="tname">
     <element name="name">
       <oneOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="eref"/>
+          <ref name="stem"/>
+          <ref name="keyword"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
+        </choice>
       </oneOrMore>
     </element>
   </define>
@@ -592,14 +600,20 @@
   <define name="em">
     <element name="em">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="stem"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>
   <define name="strong">
     <element name="strong">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="stem"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>

data/lib/asciidoctor/standoc/cleanup.rb

@@ -6,6 +6,8 @@ require_relative "./cleanup_block.rb"
 require_relative "./cleanup_footnotes.rb"
 require_relative "./cleanup_ref.rb"
 require_relative "./cleanup_boilerplate.rb"
+require_relative "./cleanup_section.rb"
+require_relative "./cleanup_inline.rb"
 require "relaton_iev"
 
 module Asciidoctor
@@ -43,11 +45,11 @@ module Asciidoctor
         reference_names(xmldoc)
         xref_cleanup(xmldoc)
         origin_cleanup(xmldoc)
+        concept_cleanup(xmldoc)
         RelatonIev::iev_cleanup(xmldoc, @bibdb)
         element_name_cleanup(xmldoc)
         bpart_cleanup(xmldoc)
         quotesource_cleanup(xmldoc)
-        para_cleanup(xmldoc)
         callout_cleanup(xmldoc)
         footnote_cleanup(xmldoc)
         empty_element_cleanup(xmldoc)
@@ -59,6 +61,7 @@ module Asciidoctor
         requirement_cleanup(xmldoc)
         bibdata_cleanup(xmldoc)
         boilerplate_cleanup(xmldoc)
+        para_cleanup(xmldoc)
         xmldoc
       end
 
@@ -132,115 +135,6 @@ module Asciidoctor
         align_callouts_to_annotations(xmldoc)
       end
 
-      def termdef_stem_cleanup(xmldoc)
-        xmldoc.xpath("//term/p/stem").each do |a|
-          if a.parent.elements.size == 1 # para contains just a stem expression
-            t = Nokogiri::XML::Element.new("admitted", xmldoc)
-            parent = a.parent
-            t.children = a.remove
-            parent.replace(t)
-          end
-        end
-      end
-
-      def termdomain_cleanup(xmldoc)
-        xmldoc.xpath("//p/domain").each do |a|
-          prev = a.parent.previous
-          prev.next = a.remove
-        end
-      end
-
-      def termdomain1_cleanup(xmldoc)
-        xmldoc.xpath("//domain").each do |d|
-          defn = d.at("../definition") and
-            defn.previous = d.remove
-        end
-      end
-
-      def termdefinition_cleanup(xmldoc)
-        xmldoc.xpath("//term").each do |d|
-          first_child = d.at("./p | ./figure | ./formula") || return
-          t = Nokogiri::XML::Element.new("definition", xmldoc)
-          first_child.replace(t)
-          t << first_child.remove
-          d.xpath("./p | ./figure | ./formula").each { |n| t << n.remove }
-        end
-      end
-
-      def termdef_unnest_cleanup(xmldoc)
-        # release termdef tags from surrounding paras
-        nodes = xmldoc.xpath("//p/admitted | //p/deprecates")
-        while !nodes.empty?
-          nodes[0].parent.replace(nodes[0].parent.children)
-          nodes = xmldoc.xpath("//p/admitted | //p/deprecates")
-        end
-      end
-
-      def termdef_boilerplate_cleanup(xmldoc)
-        xmldoc.xpath("//terms/p | //terms/ul").each(&:remove)
-      end
-
-      def termdef_subclause_cleanup(xmldoc)
-        xmldoc.xpath("//terms[terms]").each { |t| t.name = "clause" }
-      end
-
-      def termdocsource_cleanup(xmldoc)
-        f = xmldoc.at("//preface | //sections")
-        xmldoc.xpath("//termdocsource").each do |s|
-          f.previous = s.remove
-        end
-      end
-
-      def term_children_cleanup(xmldoc)
-        xmldoc.xpath("//term").each do |t|
-          t.xpath("./termnote").each { |n| t << n.remove }
-          t.xpath("./termexample").each { |n| t << n.remove }
-          t.xpath("./termsource").each { |n| t << n.remove }
-        end
-      end
-
-      def termdef_cleanup(xmldoc)
-        termdef_unnest_cleanup(xmldoc)
-        termdef_stem_cleanup(xmldoc)
-        termdomain_cleanup(xmldoc)
-        termdefinition_cleanup(xmldoc)
-        termdomain1_cleanup(xmldoc)
-        termdef_boilerplate_cleanup(xmldoc)
-        termdef_subclause_cleanup(xmldoc)
-        term_children_cleanup(xmldoc)
-        termdocsource_cleanup(xmldoc)
-      end
-
-      def empty_text_before_first_element(x)
-        x.children.each do |c|
-          return false if c.text? and /\S/.match(c.text)
-          return true if c.element?
-        end
-        true
-      end
-
-      def strip_initial_space(x)
-        if x.children[0].text?
-          if !/\S/.match(x.children[0].text)
-            x.children[0].remove
-          else
-            x.children[0].content = x.children[0].text.gsub(/^ /, "")
-          end
-        end
-      end
-
-      def bookmark_cleanup(xmldoc)
-        xmldoc.xpath("//li[descendant::bookmark]").each do |x|
-          if x&.elements&.first&.name == "p" &&
-              x&.elements&.first&.elements&.first&.name == "bookmark"
-            if empty_text_before_first_element(x.elements[0])
-              x["id"] = x.elements[0].elements[0].remove["id"]
-              strip_initial_space(x.elements[0])
-            end
-          end
-        end
-      end
-
       def mathml_cleanup(xmldoc)
         xmldoc.xpath("//stem[@type = 'MathML']").each do |x|
           next if x.children.any? { |y| y.element? }
@@ -253,6 +147,15 @@ module Asciidoctor
           x.children = math
         end
       end
+
+      # allows us to deal with doc relation localities,
+      # temporarily stashed to "bpart"
+      def bpart_cleanup(xmldoc)
+        xmldoc.xpath("//relation/bpart").each do |x|
+          extract_localities(x)
+          x.replace(x.children)
+        end
+      end
     end
   end
 end

data/lib/asciidoctor/standoc/cleanup_block.rb

@@ -4,14 +4,15 @@ require "htmlentities"
 require "json"
 require "pathname"
 require "open-uri"
-require "pp"
 
 module Asciidoctor
   module Standoc
     module Cleanup
       def para_cleanup(xmldoc)
-        inject_id(xmldoc, "//p | //ol | //ul")
-        inject_id(xmldoc, "//note[not(ancestor::bibitem)][not(ancestor::table)]")
+        ["//p[not(ancestor::bibdata)]", "//ol[not(ancestor::bibdata)]",
+         "//ul[not(ancestor::bibdata)]",
+         "//note[not(ancestor::bibitem or ancestor::table or ancestor::bibdata)]"
+        ].each { |w| inject_id(xmldoc, w) }
       end
 
       def inject_id(xmldoc, path)
@@ -119,50 +120,6 @@ module Asciidoctor
         subfigure_cleanup(xmldoc)
       end
 
-      def make_preface(x, s)
-        if x.at("//foreword | //introduction")
-          preface = s.add_previous_sibling("<preface/>").first
-          foreword = x.at("//foreword")
-          preface.add_child foreword.remove if foreword
-          introduction = x.at("//introduction")
-          preface.add_child introduction.remove if introduction
-        end
-        make_abstract(x, s)
-      end
-
-      def make_abstract(x, s)
-        if x.at("//abstract[not(ancestor::bibitem)]")
-          preface = s.at("//preface") || s.add_previous_sibling("<preface/>").first
-          abstract = x.at("//abstract[not(ancestor::bibitem)]").remove
-          preface.prepend_child abstract.remove
-          bibabstract = bibabstract_location(x)
-          dupabstract = abstract.dup
-          dupabstract.traverse { |n| n.remove_attribute("id") }
-          dupabstract.remove_attribute("language")
-          dupabstract.remove_attribute("script")
-          bibabstract.next = dupabstract
-        end
-      end
-
-      def bibabstract_location(x)
-        bibabstract = x.at("//bibdata/script") || x.at("//bibdata/language") ||
-          x.at("//bibdata/contributor[not(following-sibling::contributor)]") ||
-          x.at("//bibdata/date[not(following-sibling::date)]") ||
-          x.at("//docnumber") ||
-          x.at("//bibdata/docidentifier[not(following-sibling::docidentifier)]") ||
-          x.at("//bibdata/uri[not(following-sibling::uri)]") ||
-          x.at("//bibdata/title[not(following-sibling::title)]")
-      end
-
-      def make_bibliography(x, s)
-        if x.at("//sections/references")
-          biblio = s.add_next_sibling("<bibliography/>").first
-          x.xpath("//sections/references").each do |r|
-            biblio.add_child r.remove
-          end
-        end
-      end
-
       ELEMS_ALLOW_NOTES =
         %w[p formula ul ol dl figure].freeze
 
@@ -179,66 +136,6 @@ module Asciidoctor
         end
       end
 
-      def sections_order_cleanup(x)
-        s = x.at("//sections")
-        make_preface(x, s)
-        make_bibliography(x, s)
-        x.xpath("//sections/annex").reverse_each { |r| s.next = r.remove }
-      end
-
-      def maxlevel(x)
-        max = 5
-        x.xpath("//clause[@level]").each do |c|
-          max = c["level"].to_i if max < c["level"].to_i
-        end
-        max
-      end
-
-      def sections_level_cleanup(x)
-        m = maxlevel(x)
-        return if m < 6
-        m.downto(6).each do |l|
-          x.xpath("//clause[@level = '#{l}']").each do |c|
-            c.delete("level")
-            c.previous_element << c.remove
-          end
-        end
-      end
-
-      def sections_cleanup(x)
-        sections_order_cleanup(x)
-        sections_level_cleanup(x)
-      end
-
-      def obligations_cleanup(x)
-        obligations_cleanup_info(x)
-        obligations_cleanup_norm(x)
-        obligations_cleanup_inherit(x)
-      end
-
-      def obligations_cleanup_info(x)
-        (s = x.at("//foreword")) && s["obligation"] = "informative"
-        (s = x.at("//introduction")) && s["obligation"] = "informative"
-        x.xpath("//references").each { |r| r["obligation"] = "informative" }
-      end
-
-      def obligations_cleanup_norm(x)
-        (s = x.at("//clause[title = 'Scope']")) && s["obligation"] = "normative"
-        (s = x.at("//clause[title = 'Symbols and Abbreviated Terms']")) &&
-          s["obligation"] = "normative"
-        x.xpath("//terms").each { |r| r["obligation"] = "normative" }
-        x.xpath("//symbols-abbrevs").each { |r| r["obligation"] = "normative" }
-      end
-
-      def obligations_cleanup_inherit(x)
-        x.xpath("//annex | //clause").each do |r|
-          r["obligation"] = "normative" unless r["obligation"]
-        end
-        x.xpath(Utils::SUBCLAUSE_XPATH).each do |r|
-          r["obligation"] = r.at("./ancestor::*/@obligation").text
-        end
-      end
-
       def requirement_cleanup(x)
         x.xpath("//requirement | //recommendation | //permission").each do |r|
           r.children.each do |e|
@@ -258,7 +155,7 @@ module Asciidoctor
           n = d.next.remove
           d << n.children
         end
-        r.xpath("./description[not(./*) and normalize-space(.)='']").each do |d|
+        r.xpath("./description[normalize-space(.)='']").each do |d|
           d.replace("\n")
         end
       end

data/lib/asciidoctor/standoc/cleanup_boilerplate.rb

@@ -63,7 +63,7 @@ module Asciidoctor
       end
 
       def bibdata_cleanup(xmldoc)
-        xmldoc.xpath("//bibdata//bibitem").each do |b|
+        xmldoc.xpath("//bibdata//bibitem | //bibdata//note").each do |b|
           b.delete("id")
         end
       end

data/lib/asciidoctor/standoc/cleanup_inline.rb

@@ -0,0 +1,125 @@
+module Asciidoctor
+  module Standoc
+    module Cleanup
+      def empty_text_before_first_element(x)
+        x.children.each do |c|
+          return false if c.text? and /\S/.match(c.text)
+          return true if c.element?
+        end
+        true
+      end
+
+      def strip_initial_space(x)
+        if x.children[0].text?
+          if !/\S/.match(x.children[0].text)
+            x.children[0].remove
+          else
+            x.children[0].content = x.children[0].text.gsub(/^ /, "")
+          end
+        end
+      end
+
+      def bookmark_cleanup(xmldoc)
+        xmldoc.xpath("//li[descendant::bookmark]").each do |x|
+          if x&.elements&.first&.name == "p" &&
+              x&.elements&.first&.elements&.first&.name == "bookmark"
+            if empty_text_before_first_element(x.elements[0])
+              x["id"] = x.elements[0].elements[0].remove["id"]
+              strip_initial_space(x.elements[0])
+            end
+          end
+        end
+      end
+
+      # extending localities to cover ISO referencing
+      LOCALITY_REGEX_STR = <<~REGEXP.freeze
+        ^((?<locality>section|clause|part|paragraph|chapter|page|
+                      table|annex|figure|example|note|formula|list|
+                      locality:[^ \\t\\n\\r:,]+)(\\s+|=)
+               (?<ref>[^"][^ \\t\\n,:-]*|"[^"]+")
+                 (-(?<to>[^"][^ \\t\\n,:-]*|"[^"]"))?|
+          (?<locality2>whole|locality:[^ \\t\\n\\r:,]+))[,:]?\\s*
+         (?<text>.*)$
+      REGEXP
+      LOCALITY_RE = Regexp.new(LOCALITY_REGEX_STR.gsub(/\s/, ""),
+                               Regexp::IGNORECASE | Regexp::MULTILINE)
+
+      def tq(x)
+        x.sub(/^"/, "").sub(/"$/, "")
+      end
+
+      def extract_localities(x)
+        text = x&.children&.first&.remove&.text
+        while (m = LOCALITY_RE.match text)
+          ref = m[:ref] ? "<referenceFrom>#{tq m[:ref]}</referenceFrom>" : ""
+          refto = m[:to] ? "<referenceTo>#{tq m[:to]}</referenceTo>" : ""
+          loc = m[:locality]&.downcase || m[:locality2]&.downcase
+          x.add_child("<locality type='#{loc}'>#{ref}#{refto}</locality>")
+          text = m[:text]
+        end
+        x.add_child(text) if text
+      end
+
+      def xref_to_eref(x)
+        x["bibitemid"] = x["target"]
+        x["citeas"] = @anchors&.dig(x["target"], :xref) ||
+          warn("#{x['target']} is not a real reference!")
+        x.delete("target")
+        extract_localities(x) unless x.children.empty?
+      end
+
+      def xref_cleanup(xmldoc)
+        xmldoc.xpath("//xref").each do |x|
+          if refid? x["target"]
+            x.name = "eref"
+            xref_to_eref(x)
+          else
+            x.delete("type")
+          end
+        end
+      end
+
+      def quotesource_cleanup(xmldoc)
+        xmldoc.xpath("//quote/source | //terms/source").each do |x|
+          xref_to_eref(x)
+        end
+      end
+
+      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!")
+          extract_localities(x) unless x.children.empty?
+        end
+      end
+
+      def concept_cleanup(xmldoc)
+        xmldoc.xpath("//concept").each do |x|
+          x.delete("term") if x["term"].empty?
+          if /:/.match(x["key"]) then concept_termbase_cleanup(x)
+          elsif refid? x["key"] then concept_eref_cleanup(x)
+          else
+            concept_xref_cleanup(x)
+          end
+          x.delete("key")
+        end
+      end
+
+      def concept_termbase_cleanup(x)
+        text = x&.children&.first&.remove&.text
+        termbase, key = x["key"].split(/:/, 2)
+        x.add_child(%(<termref base="#{termbase}" target="#{key}">#{text}</termref>))
+      end
+
+      def concept_xref_cleanup(x)
+        text = x&.children&.first&.remove&.text
+        x.add_child(%(<xref target="#{x['key']}">#{text}</xref>))
+      end
+
+      def concept_eref_cleanup(x)
+        x.children = "<eref>#{x.children.to_xml}</eref>"
+        extract_localities(x.first_element_child)
+      end
+    end
+  end
+end

data/lib/asciidoctor/standoc/cleanup_ref.rb

@@ -4,77 +4,6 @@ require "relaton_bib"
 module Asciidoctor
   module Standoc
     module Cleanup
-      # extending localities to cover ISO referencing
-      LOCALITY_REGEX_STR = <<~REGEXP.freeze
-        ^((?<locality>section|clause|part|paragraph|chapter|page|
-                      table|annex|figure|example|note|formula|list|
-                      locality:[^ \\t\\n\\r:,]+)(\\s+|=)
-               (?<ref>[^"][^ \\t\\n,:-]*|"[^"]+")
-                 (-(?<to>[^"][^ \\t\\n,:-]*|"[^"]"))?|
-          (?<locality2>whole|locality:[^ \\t\\n\\r:,]+))[,:]?\\s*
-         (?<text>.*)$
-      REGEXP
-      LOCALITY_RE = Regexp.new(LOCALITY_REGEX_STR.gsub(/\s/, ""),
-                               Regexp::IGNORECASE | Regexp::MULTILINE)
-
-      def tq(x)
-        x.sub(/^"/, "").sub(/"$/, "")
-      end
-
-      def extract_localities(x)
-        text = x.children.first.remove.text
-        while (m = LOCALITY_RE.match text)
-          ref = m[:ref] ? "<referenceFrom>#{tq m[:ref]}</referenceFrom>" : ""
-          refto = m[:to] ? "<referenceTo>#{tq m[:to]}</referenceTo>" : ""
-          loc = m[:locality]&.downcase || m[:locality2]&.downcase
-          x.add_child("<locality type='#{loc}'>#{ref}#{refto}</locality>")
-          text = m[:text]
-        end
-        x.add_child(text)
-      end
-
-      def xref_to_eref(x)
-        x["bibitemid"] = x["target"]
-        x["citeas"] = @anchors&.dig(x["target"], :xref) ||
-          warn("#{x['target']} is not a real reference!")
-        x.delete("target")
-        extract_localities(x) unless x.children.empty?
-      end
-
-      def xref_cleanup(xmldoc)
-        xmldoc.xpath("//xref").each do |x|
-          if refid? x["target"]
-            x.name = "eref"
-            xref_to_eref(x)
-          else
-            x.delete("type")
-          end
-        end
-      end
-
-      # allows us to deal with doc relation localities,
-      # temporarily stashed to "bpart"
-      def bpart_cleanup(xmldoc)
-        xmldoc.xpath("//relation/bpart").each do |x|
-          extract_localities(x)
-          x.replace(x.children)
-        end
-      end
-
-      def quotesource_cleanup(xmldoc)
-        xmldoc.xpath("//quote/source | //terms/source").each do |x|
-          xref_to_eref(x)
-        end
-      end
-
-      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!")
-          extract_localities(x) unless x.children.empty?
-        end
-      end
-
       def biblio_reorder(xmldoc)
         xmldoc.xpath("//references[title = 'Bibliography']").each do |r|
           biblio_reorder1(r)
@@ -85,8 +14,8 @@ module Asciidoctor
         bib = sort_biblio(refs.xpath("./bibitem"))
         refs.xpath("./bibitem").each { |b| b.remove }
         bib.reverse.each do |b|
-        insert = refs.at("./title") and insert.next = b.to_xml or
-          refs.children.first.add_previous_sibling b.to_xml
+          insert = refs.at("./title") and insert.next = b.to_xml or
+            refs.children.first.add_previous_sibling b.to_xml
         end
         refs.xpath("./references").each { |r| biblio_reorder1(r) }
       end