metanorma-standoc 1.3.29 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e964fb25b29d5ecbe775bf397a17f9cf264fa3709e8756be7a9025bcf043250f
-  data.tar.gz: d6085180737f332f6aa657eb129bf72f02ca0466b60e22276ddda03cd2cbd788
+  metadata.gz: 1e86d9135fffb1f112db82f9d052632aa36f134a76b03ff48e65dcb841c7cbb4
+  data.tar.gz: ea05dff988ebaf6b51c029d99cbadd195300c3c524acd301157a335257436c01
 SHA512:
-  metadata.gz: baccf6cbbb3c32defcac92b95911e83f10f44338a2bb631a8c6ee86a7b00833583d27161b18ad45b2d80aeec8dcbe3dd349a39b4cfa08670f6cdbe1c8492323c
-  data.tar.gz: 347739395332e6d3ac88ea0ec5bec557fa0d06dee7f7f2bbafa198e245131dd313c3f229f63bb3afc92c99eb4cd0cec8fc2a9f969e0cbf42a76271e45955e8eb
+  metadata.gz: beead161e217dba5841732200aa8cb897900ea90b1a449f092fe63ffe40ca59a6b904b098affd1a475723ac4663ba5dadd09fdab48b661376c4fe659360c79a4
+  data.tar.gz: 43b697f04165938864eab22a1d4d49613adef7ae1703995a5541018fe438f09ff21dd43e37e25ebeab9a0d514b50f64b64d2a8a47c8836b924d4578b9f076d19

data/.gitignore

@@ -9,3 +9,4 @@ spec/examples/rice.doc
 spec/examples/rice.html
 spec/examples/rice.xml
 spec/examples/rice_files/
+Gemfile.lock

data/lib/asciidoctor/standoc/base.rb

@@ -15,6 +15,8 @@ module Asciidoctor
       XML_NAMESPACE = "https://www.metanorma.org/ns/standoc".freeze
 
       Asciidoctor::Extensions.register do
+        preprocessor Asciidoctor::Standoc::Datamodel::AttributesTablePreprocessor
+        preprocessor Asciidoctor::Standoc::Datamodel::DiagramPreprocessor
         preprocessor Asciidoctor::Standoc::Yaml2TextPreprocessor
         inline_macro Asciidoctor::Standoc::AltTermInlineMacro
         inline_macro Asciidoctor::Standoc::DeprecatedTermInlineMacro
@@ -125,31 +127,6 @@ module Asciidoctor
         i18n_init(lang, script)
       end
 
-      def init_bib_caches(node)
-        return if @no_isobib
-        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
-        @bibdb = Relaton::DbCache.init_bib_caches(
-          local_cache: local,
-          flush_caches: node.attr("flush-caches"),
-          global_cache: global)
-      end
-
-      def init_iev_caches(node)
-        unless (@no_isobib_cache || @no_isobib)
-          node.attr("local-cache-only") or
-            @iev_globalname = global_ievcache_name
-          @iev_localname = local_ievcache_name(node.attr("local-cache") ||
-                                               node.attr("local-cache-only"))
-          if node.attr("flush-caches")
-            FileUtils.rm_f @iev_globalname unless @iev_globalname.nil?
-            FileUtils.rm_f @iev_localname unless @iev_localname.nil?
-          end
-        end
-        #@iev = Iev::Db.new(globalname, localname) unless @no_isobib
-      end
-
       def default_fonts(node)
         b = node.attr("body-font") ||
           (node.attr("script") == "Hans" ? '"SimSun",serif' :

data/lib/asciidoctor/standoc/biblio.rng

@@ -661,9 +661,9 @@
     <optional>
       <ref name="status"/>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="copyright"/>
-    </optional>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="docrelation"/>
     </zeroOrMore>
@@ -1021,7 +1021,17 @@
       <optional>
         <ref name="to"/>
       </optional>
-      <ref name="owner"/>
+      <oneOrMore>
+        <ref name="owner"/>
+      </oneOrMore>
+      <optional>
+        <ref name="copyright_scope"/>
+      </optional>
+    </element>
+  </define>
+  <define name="copyright_scope">
+    <element name="scope">
+      <text/>
     </element>
   </define>
   <define name="from">

data/lib/asciidoctor/standoc/blocks.rb

@@ -21,15 +21,21 @@ module Asciidoctor
                   subsequence: node.attr("subsequence") )
       end
 
+      def termnote_attr(node)
+        attr_code(id_attr(node).merge(
+          "keep-separate": node.attr("keep-separate")))
+      end
+
       def note_attr(node)
-        attr_code(id_attr(node).merge("keep-separate": node.attr("keep-separate")))
+        attr_code(id_attr(node).merge(
+          "keep-separate": node.attr("keep-separate"),
+          beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil))
       end
 
       # We append each contained block to its parent
       def open(node)
         role = node.role || node.attr("style")
-        Utils::reqt_subpart(role) and
-          return requirement_subpart(node)
+        Utils::reqt_subpart(role) and return requirement_subpart(node)
         result = []
         node.blocks.each do |b|
           result << send(b.context, b)
@@ -53,18 +59,16 @@ module Asciidoctor
 
       # NOTE: html escaping is performed by Nokogiri
       def stem(node)
-        stem_content = node.lines.join("\n")
         noko do |xml|
           xml.formula **formula_attr(node) do |s|
-            stem_parse(stem_content, s, node.style.to_sym)
+            stem_parse(node.lines.join("\n"), s, node.style.to_sym)
           end
         end
       end
 
       def sidebar_attrs(node)
         todo_attrs(node).merge(attr_code(
-          from: node.attr("from"),
-          to: node.attr("to") || node.attr("from") ))
+          from: node.attr("from"), to: node.attr("to") || node.attr("from") ))
       end
 
       def sidebar(node)
@@ -95,7 +99,7 @@ module Asciidoctor
 
       def termnote(n)
         noko do |xml|
-          xml.termnote **note_attr(n) do |ex|
+          xml.termnote **termnote_attr(n) do |ex|
             wrap_in_para(n, ex)
           end
         end.join("\n")
@@ -111,12 +115,11 @@ module Asciidoctor
 
       def admonition_attrs(node)
         name = node.attr("name")
-        if type = node.attr("type")
-          ["danger", "safety precautions"].each do |t|
-            name = t if type.casecmp(t).zero?
-          end
+        a = node.attr("type") and ["danger", "safety precautions"].each do |t|
+          name = t if a.casecmp(t).zero?
         end
-        attr_code(id: Utils::anchor_or_uuid(node), type: name)
+        attr_code(id: Utils::anchor_or_uuid(node), type: name,
+                  beforeclauses: node.attr("beforeclauses") == "true" ? "true" : nil)
       end
 
       def admonition(node)
@@ -149,6 +152,8 @@ module Asciidoctor
       end
 
       def pseudocode_example(node)
+        # prevent A's and other subs inappropriate for pseudocode
+        node.blocks.each { |b| b.remove_sub(:replacements) }
         noko do |xml|
           xml.figure **id_unnum_attr(node).merge(class: "pseudocode") do |ex|
             figure_title(node, ex)
@@ -189,8 +194,7 @@ module Asciidoctor
       end
 
       def para_attrs(node)
-        attr_code(align: node.attr("align"),
-                  id: Utils::anchor_or_uuid(node))
+        attr_code(align: node.attr("align"), id: Utils::anchor_or_uuid(node))
       end
 
       def paragraph(node)
@@ -213,9 +217,8 @@ module Asciidoctor
             s <<  m[:text]
           end
         end
-        if node.attr("attribution")
+        node.attr("attribution") and
           out.author { |a| a << node.attr("attribution") }
-        end
       end
 
       def quote(node)

data/lib/asciidoctor/standoc/cleanup.rb

@@ -7,6 +7,7 @@ require_relative "./cleanup_footnotes.rb"
 require_relative "./cleanup_ref.rb"
 require_relative "./cleanup_boilerplate.rb"
 require_relative "./cleanup_section.rb"
+require_relative "./cleanup_terms.rb"
 require_relative "./cleanup_inline.rb"
 require "relaton_iev"
 
@@ -39,6 +40,7 @@ module Asciidoctor
         figure_cleanup(xmldoc)
         ref_cleanup(xmldoc)
         note_cleanup(xmldoc)
+        clausebefore_cleanup(xmldoc)
         ref_dl_cleanup(xmldoc)
         normref_cleanup(xmldoc)
         biblio_cleanup(xmldoc)

data/lib/asciidoctor/standoc/cleanup_block.rb

@@ -147,7 +147,7 @@ module Asciidoctor
 
       def requirement_inherit(x)
         x.xpath("//requirement | //recommendation | //permission").each do |r|
-          ins = r.at("./classification") || 
+          ins = r.at("./classification") ||
             r.at("./description | ./measurementtarget | ./specification | "\
                  "./verification | ./import | ./description | ./requirement | "\
                  "./recommendation | ./permission")
@@ -158,7 +158,7 @@ module Asciidoctor
       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) || 
+            unless e.element? && (Utils::reqt_subpart(e.name) ||
                 %w(requirement recommendation permission).include?(e.name))
               t = Nokogiri::XML::Element.new("description", x)
               e.before(t)

data/lib/asciidoctor/standoc/cleanup_section.rb

@@ -138,133 +138,16 @@ module Asciidoctor
         end
       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") || next
-          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
+      def clausebefore_cleanup(xmldoc)
+        return unless xmldoc.at("//sections")
+        unless ins = xmldoc.at("//sections").children.first
+          xmldoc.at("//sections") << " "
+          ins = xmldoc.at("//sections").children.first
         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_from_termbase(xmldoc)
-        xmldoc.xpath("//term").each do |x|
-          if c = x.at("./origin/termref") and !x.at("./definition")
-            x.at("./origin").previous = fetch_termbase(c["base"], c.text)
-          end
-        end
-      end
-
-      def termdef_cleanup(xmldoc)
-        termdef_from_termbase(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
-
-      # Indices sort after letter but before any following
-      # letter (x, x_m, x_1, xa); we use colon to force that sort order.
-      # Numbers sort *after* letters; we use thorn to force that sort order.
-      def symbol_key(x)
-        key = x.dup
-        key.traverse do |n|
-          next unless n.name == "math"
-          n.replace(grkletters(MathML2AsciiMath.m2a(n.to_xml)))
-        end
-        ret = Nokogiri::XML(key.to_xml)
-        HTMLEntities.new.decode(ret.text).
-          gsub(/[\[\]\{\}<>\(\)]/, "").strip.
-          gsub(/[[:punct]]|[_^]/, ":\\0").gsub(/`/, "").
-          gsub(/[0-9]+/, "þ\\0")
-      end
-
-      def grkletters(x)
-        x.gsub(/\b(alpha|beta|gamma|delta|epsilon|zeta|eta|theta|iota|kappa|lambda|mu|nu|xi|omicron|pi|rho|sigma|tau|upsilon|phi|chi|psi|omega)\b/i, "&\\1;")
-      end
-
-      def extract_symbols_list(dl)
-        dl_out = []
-        dl.xpath("./dt | ./dd").each do |dtd|
-          if dtd.name == "dt"
-            dl_out << { dt: dtd.remove, key: symbol_key(dtd) }
-          else
-            dl_out.last[:dd] = dtd.remove
-          end
-        end
-        dl_out
-      end
-
-      def symbols_cleanup(docxml)
-        docxml.xpath("//definitions/dl").each do |dl|
-          dl_out = extract_symbols_list(dl)
-          dl_out.sort! { |a, b| a[:key] <=> b[:key] || a[:dt] <=> b[:dt] }
-          dl.children = dl_out.map { |d| d[:dt].to_s + d[:dd].to_s }.join("\n")
+        xmldoc.xpath("//*[@beforeclauses = 'true']").each do |x|
+          x.delete("beforeclauses")
+          ins.previous = x.remove
         end
-        docxml
       end
     end
   end

data/lib/asciidoctor/standoc/cleanup_terms.rb

@@ -0,0 +1,134 @@
+module Asciidoctor
+  module Standoc
+    module Cleanup
+      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") || next
+          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_from_termbase(xmldoc)
+        xmldoc.xpath("//term").each do |x|
+          if c = x.at("./origin/termref") and !x.at("./definition")
+            x.at("./origin").previous = fetch_termbase(c["base"], c.text)
+          end
+        end
+      end
+
+      def termdef_cleanup(xmldoc)
+        termdef_from_termbase(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   
+
+            # Indices sort after letter but before any following
+      # letter (x, x_m, x_1, xa); we use colon to force that sort order.
+      # Numbers sort *after* letters; we use thorn to force that sort order.
+      def symbol_key(x)
+        key = x.dup
+        key.traverse do |n|
+          next unless n.name == "math"
+          n.replace(grkletters(MathML2AsciiMath.m2a(n.to_xml)))
+        end
+        ret = Nokogiri::XML(key.to_xml)
+        HTMLEntities.new.decode(ret.text).
+          gsub(/[\[\]\{\}<>\(\)]/, "").strip.
+          gsub(/[[:punct]]|[_^]/, ":\\0").gsub(/`/, "").
+          gsub(/[0-9]+/, "þ\\0")
+      end
+        
+      def grkletters(x)
+        x.gsub(/\b(alpha|beta|gamma|delta|epsilon|zeta|eta|theta|iota|kappa|lambda|mu|nu|xi|omicron|pi|rho|sigma|tau|upsilon|phi|chi|psi|omega)\b/i, "&\\1;")
+      end
+
+      def extract_symbols_list(dl)
+        dl_out = []
+        dl.xpath("./dt | ./dd").each do |dtd|
+          if dtd.name == "dt"
+            dl_out << { dt: dtd.remove, key: symbol_key(dtd) }
+          else
+            dl_out.last[:dd] = dtd.remove
+          end
+        end
+        dl_out
+      end
+          
+      def symbols_cleanup(docxml)
+        docxml.xpath("//definitions/dl").each do |dl|
+          dl_out = extract_symbols_list(dl)
+          dl_out.sort! { |a, b| a[:key] <=> b[:key] || a[:dt] <=> b[:dt] }
+          dl.children = dl_out.map { |d| d[:dt].to_s + d[:dd].to_s }.join("\n")
+        end
+        docxml
+      end 
+    end
+  end
+end