metanorma-standoc 1.9.0 → 1.10.0

data/lib/asciidoctor/standoc/front.rb

@@ -3,7 +3,7 @@ require "nokogiri"
 require "htmlentities"
 require "pathname"
 require "open-uri"
-require_relative "./front_contributor.rb"
+require_relative "./front_contributor"
 
 module Asciidoctor
   module Standoc
@@ -40,6 +40,7 @@ module Asciidoctor
 
       def metadata_committee(node, xml)
         return unless node.attr("technical-committee")
+
         xml.editorialgroup do |a|
           committee_component("technical-committee", node, a)
         end
@@ -47,8 +48,8 @@ module Asciidoctor
 
       def metadata_ics(node, xml)
         ics = node.attr("library-ics")
-        ics && ics.split(/,\s*/).each do |i|
-          xml.ics { |ics| ics.code i }
+        ics&.split(/,\s*/)&.each do |i|
+          xml.ics { |elem| elem.code i }
         end
       end
 
@@ -71,15 +72,15 @@ module Asciidoctor
 
       def datetypes
         %w{ published accessed created implemented obsoleted
-            confirmed updated issued circulated unchanged received 
-            vote-started vote-ended
-        }
+            confirmed updated issued circulated unchanged received
+            vote-started vote-ended announced }
       end
 
       def metadata_date(node, xml)
         datetypes.each { |t| metadata_date1(node, xml, t) }
-        node.attributes.keys.each do |a|
+        node.attributes.each_key do |a|
           next unless a == "date" || /^date_\d+$/.match(a)
+
           type, date = node.attr(a).split(/ /, 2)
           type or next
           xml.date **{ type: type } do |d|
@@ -93,7 +94,8 @@ module Asciidoctor
       end
 
       def metadata_script(node, xml)
-        xml.script (node.attr("script") || default_script(node.attr("language")))
+        xml.script (node.attr("script") ||
+                    default_script(node.attr("language")))
       end
 
       def relaton_relations
@@ -114,8 +116,8 @@ module Asciidoctor
       end
 
       def relation_normalise(type)
-        type.sub(/-by$/, "By").sub(/-of$/, "Of").sub(/-from$/, "From").
-          sub(/-in$/, "In")
+        type.sub(/-by$/, "By").sub(/-of$/, "Of").sub(/-from$/, "From")
+          .sub(/-in$/, "In")
       end
 
       def metadata_getrelation(node, xml, type, desc = nil)
@@ -124,8 +126,8 @@ module Asciidoctor
           id = d.split(/,\s*/)
           xml.relation **{ type: relation_normalise(type) } do |r|
             desc.nil? or r.description relation_normalise(desc)
-            fetch_ref(r, d, nil, {}) or r.bibitem do |b|
-              b.title id[1] ? id[1] : "--"
+            fetch_ref(r, d, nil, **{}) or r.bibitem do |b|
+              b.title id[1] || "--"
               b.docidentifier id[0]
             end
           end
@@ -134,11 +136,20 @@ module Asciidoctor
 
       def metadata_keywords(node, xml)
         return unless node.attr("keywords")
-        node.attr("keywords").split(/,[ ]*/).each do |kw|
+
+        node.attr("keywords").split(/,\s*/).each do |kw|
           xml.keyword kw
         end
       end
 
+      def metadata_classifications(node, xml)
+        csv_split(node.attr("classification"), ",")&.each do |c|
+          vals = c.split(/:/, 2)
+          vals.size == 1 and vals = ["default", vals[0]]
+          xml.classification vals[1], type: vals[0]
+        end
+      end
+
       def metadata(node, xml)
         title node, xml
         metadata_source(node, xml)
@@ -155,14 +166,16 @@ module Asciidoctor
         metadata_copyright(node, xml)
         metadata_relations(node, xml)
         metadata_series(node, xml)
+        metadata_classifications(node, xml)
         metadata_keywords(node, xml)
-        xml.ext do |ext|
+        xml.ext do
           metadata_ext(node, xml)
         end
       end
 
       def metadata_ext(node, ext)
         metadata_doctype(node, ext)
+        metadata_subdoctype(node, ext)
         metadata_committee(node, ext)
         metadata_ics(node, ext)
       end
@@ -171,11 +184,13 @@ module Asciidoctor
         xml.doctype doctype(node)
       end
 
-      def metadata_note(node, xml)
+      def metadata_subdoctype(node, xml)
+        s = node.attr("docsubtype") and xml.subdoctype s
       end
 
-      def metadata_series(node, xml)
-      end
+      def metadata_note(node, xml); end
+
+      def metadata_series(node, xml); end
 
       def title(node, xml)
         title_english(node, xml)
@@ -187,7 +202,8 @@ module Asciidoctor
           at = { language: lang, format: "text/plain" }
           xml.title **attr_code(at) do |t|
             t << (Metanorma::Utils::asciidoc_sub(node.attr("title") ||
-                                      node.attr("title-en")) || node.title)
+                                                 node.attr("title-en")) ||
+            node.title)
           end
         end
       end
@@ -196,6 +212,7 @@ module Asciidoctor
         node.attributes.each do |k, v|
           next unless /^title-(?<titlelang>.+)$/ =~ k
           next if titlelang == "en"
+
           xml.title v, { language: titlelang, format: "text/plain" }
         end
       end

data/lib/asciidoctor/standoc/front_contributor.rb

@@ -10,18 +10,18 @@ module Asciidoctor
     module Front
       def committee_component(compname, node, out)
         out.send compname.gsub(/-/, "_"), node.attr(compname),
-          **attr_code(number: node.attr("#{compname}-number"),
-                      type: node.attr("#{compname}-type"))
+                 **attr_code(number: node.attr("#{compname}-number"),
+                             type: node.attr("#{compname}-type"))
         i = 2
-        while node.attr(compname+"_#{i}") do
-          out.send compname.gsub(/-/, "_"), node.attr(compname+"_#{i}"),
-            **attr_code(number: node.attr("#{compname}-number_#{i}"),
-                        type: node.attr("#{compname}-type_#{i}"))
+        while node.attr(compname + "_#{i}")
+          out.send compname.gsub(/-/, "_"), node.attr(compname + "_#{i}"),
+                   **attr_code(number: node.attr("#{compname}-number_#{i}"),
+                               type: node.attr("#{compname}-type_#{i}"))
           i += 1
         end
       end
 
-      def organization(org, orgname, node = nil, default_org = nil)
+      def organization(org, orgname, is_pub, node = nil, default_org = nil)
         abbrevs = org_abbrev
         n = abbrevs.invert[orgname] and orgname = n
         org.name orgname
@@ -29,37 +29,39 @@ module Asciidoctor
         abbr = org_abbrev[orgname]
         default_org && b = node.attr("subdivision-abbr") and abbr = b
         abbr and org.abbreviation abbr
-        default_org and org_address(node, org)
+        is_pub && node and org_address(node, org)
       end
 
-      def org_address(node, p)
-        node.attr("pub-address") and p.address do |ad|
+      def org_address(node, person)
+        node.attr("pub-address") and person.address do |ad|
           ad.formattedAddress do |f|
             f << node.attr("pub-address").gsub(/ \+\n/, "<br/>")
           end
         end
-        node.attr("pub-phone") and p.phone node.attr("pub-phone")
-        node.attr("pub-fax") and p.phone node.attr("pub-fax"), **{type: "fax"}
-        node.attr("pub-email") and p.email node.attr("pub-email")
-        node.attr("pub-uri") and p.uri node.attr("pub-uri")
+        node.attr("pub-phone") and person.phone node.attr("pub-phone")
+        node.attr("pub-fax") and
+          person.phone node.attr("pub-fax"), **{ type: "fax" }
+        node.attr("pub-email") and person.email node.attr("pub-email")
+        node.attr("pub-uri") and person.uri node.attr("pub-uri")
       end
 
       # , " => ," : CSV definition does not deal with space followed by quote
       # at start of field
-      def csv_split(s, delim = ";")
-        return if s.nil?
-        CSV.parse_line(s&.gsub(/#{delim} "(?!")/, "#{delim}\""),
+      def csv_split(text, delim = ";")
+        return if text.nil?
+
+        CSV.parse_line(text&.gsub(/#{delim} "(?!")/, "#{delim}\""),
                        liberal_parsing: true,
-                       col_sep: delim)&.compact&.map { |x| x.strip }
+                       col_sep: delim)&.compact&.map(&:strip)
       end
 
       def metadata_author(node, xml)
-        csv_split(node.attr("publisher") || default_publisher || "")&.
-          each do |p|
+        csv_split(node.attr("publisher") || default_publisher || "")
+          &.each do |p|
           xml.contributor do |c|
             c.role **{ type: "author" }
             c.organization do |a|
-              organization(a, p, node, !node.attr("publisher"))  
+              organization(a, p, false, node, !node.attr("publisher"))
             end
           end
         end
@@ -76,17 +78,18 @@ module Asciidoctor
         end
       end
 
-      def personal_role(node, c, suffix)
-        c.role **{ type: node.attr("role#{suffix}")&.downcase || "author" }
+      def personal_role(node, contrib, suffix)
+        type = node.attr("role#{suffix}")&.downcase || "author"
+        contrib.role **{ type: type }
       end
 
-      def personal_contact(node, suffix, p)
-        node.attr("phone#{suffix}") and p.phone node.attr("phone#{suffix}")
+      def personal_contact(node, suffix, person)
+        node.attr("phone#{suffix}") and person.phone node.attr("phone#{suffix}")
         node.attr("fax#{suffix}") and
-          p.phone node.attr("fax#{suffix}"), **{type: "fax"}
-        node.attr("email#{suffix}") and p.email node.attr("email#{suffix}")
+          person.phone node.attr("fax#{suffix}"), **{ type: "fax" }
+        node.attr("email#{suffix}") and person.email node.attr("email#{suffix}")
         node.attr("contributor-uri#{suffix}") and
-          p.uri node.attr("contributor-uri#{suffix}")
+          person.uri node.attr("contributor-uri#{suffix}")
       end
 
       def personal_author1(node, xml, suffix)
@@ -100,8 +103,8 @@ module Asciidoctor
         end
       end
 
-      def person_name(node, xml, suffix, p)
-        p.name do |n|
+      def person_name(node, _xml, suffix, person)
+        person.name do |n|
           if node.attr("fullname#{suffix}")
             n.completename node.attr("fullname#{suffix}")
           else
@@ -112,21 +115,43 @@ module Asciidoctor
         end
       end
 
-      def person_affiliation(node, xml, suffix, p)
-        node.attr("affiliation#{suffix}") and p.affiliation do |a|
+      def person_affiliation(node, _xml, suffix, person)
+        node.attr("affiliation#{suffix}") and person.affiliation do |a|
           a.organization do |o|
-            o.name node.attr("affiliation#{suffix}")
-            a = node.attr("affiliation_subdiv#{suffix}")
-            abbr = node.attr("affiliation_abbrev#{suffix}") and o.abbreviation abbr
-            csv_split(node.attr("affiliation_subdiv#{suffix}"))&.each do |s|
-              o.subdivision s
-            end
-            node.attr("address#{suffix}") and o.address do |ad|
-              ad.formattedAddress do |f|
-                f << node.attr("address#{suffix}").gsub(/ \+\n/, "<br/>")
-              end
+            person_organization(node, suffix, o)
+          end
+        end
+      end
+
+      def person_organization(node, suffix, xml)
+        xml.name node.attr("affiliation#{suffix}")
+        abbr = node.attr("affiliation_abbrev#{suffix}") and
+          xml.abbreviation abbr
+        csv_split(node.attr("affiliation_subdiv#{suffix}"))&.each do |s|
+          xml.subdivision s
+        end
+        person_address(node, suffix, xml)
+      end
+
+      def person_address(node, suffix, xml)
+        if node.attr("address#{suffix}")
+          xml.address do |ad|
+            ad.formattedAddress do |f|
+              f << node.attr("address#{suffix}").gsub(/ \+\n/, "<br/>")
             end
           end
+        elsif node.attr("country#{suffix}") || node.attr("city#{suffix}")
+          person_address_components(node, suffix, xml)
+        end
+      end
+
+      def person_address_components(node, suffix, xml)
+        xml.address do |ad|
+          s = node.attr("street#{suffix}") and ad.street s
+          s = node.attr("city#{suffix}") and ad.city s
+          s = node.attr("state#{suffix}") and ad.state s
+          s = node.attr("country#{suffix}") and ad.country s
+          s = node.attr("postcode#{suffix}") and ad.postcode s
         end
       end
 
@@ -135,7 +160,7 @@ module Asciidoctor
       end
 
       def org_abbrev
-        { }
+        {}
       end
 
       def metadata_publisher(node, xml)
@@ -144,7 +169,7 @@ module Asciidoctor
           xml.contributor do |c|
             c.role **{ type: "publisher" }
             c.organization do |a|
-              organization(a, p, node, !node.attr("publisher"))
+              organization(a, p, true, node, !node.attr("publisher"))
             end
           end
         end
@@ -157,7 +182,7 @@ module Asciidoctor
             c.from (node.attr("copyright-year") || Date.today.year)
             p.match(/[A-Za-z]/).nil? or c.owner do |owner|
               owner.organization do |a|
-                organization(a, p, node, !pub)
+                organization(a, p, true, node, !pub)
               end
             end
           end

data/lib/asciidoctor/standoc/inline.rb

@@ -9,8 +9,8 @@ require "latexmath"
 module Asciidoctor
   module Standoc
     module Inline
-      def refid?(x)
-        @refids.include? x
+      def refid?(ref)
+        @refids.include? ref
       end
 
       def inline_anchor(node)
@@ -46,19 +46,20 @@ module Asciidoctor
       def inline_anchor_xref_attrs(node)
         m = /^(?<drop>droploc%)?(?<case>capital%|lowercase%)?(?<drop2>droploc%)?
           (?<fn>fn:?\s*)?(?<text>.*)$/x.match node.text
-        casing = m.nil? ? nil : m[:case]&.sub(/%$/, "")
-        droploc = m.nil? ? nil : ((m[:drop].nil? && m[:drop2].nil?) ? nil: true)
-        f = (m.nil? || m[:fn].nil?) ? "inline" : "footnote"
-        c = (!m.nil? && (%i[case fn drop drop2].any? { |x| !m[x].nil? })) ?
-          m[:text] : node.text
         t = node.target.gsub(/^#/, "").gsub(%r{(\.xml|\.adoc)(#.*$)}, "\\2")
-        { target: t, type: f, case: casing, droploc: droploc, text: c }
+        m.nil? and return { target: t, type: "inline", text: node.text }
+        droploc = m[:drop].nil? && m[:drop2].nil? ? nil : true
+        f = m[:fn].nil? ? "inline" : "footnote"
+        c = %i[case fn drop drop2].any? { |x| !m[x].nil? } ? m[:text] : node.text
+        { target: t, type: f, case: m[:case]&.sub(/%$/, ""), droploc: droploc,
+          text: c }
       end
 
       def inline_anchor_link(node)
         contents = node.text
         contents = "" if node.target.gsub(%r{^mailto:}, "") == node.text
-        attributes = { "target": node.target, "alt": node.attr("title") }
+        attributes = { "target": node.target, "alt": node.attr("title"),
+                       "updatetype": node.attr("updatetype") }
         noko do |xml|
           xml.link **attr_code(attributes) do |l|
             l << contents
@@ -67,8 +68,8 @@ module Asciidoctor
       end
 
       def inline_anchor_bibref(node)
-        eref_contents = (node.text || node.target || node.id)&.
-          sub(/^\[?([^\[\]]+?)\]?$/, "[\\1]")
+        eref_contents = (node.text || node.target || node.id)
+          &.sub(/^\[?([^\[\]]+?)\]?$/, "[\\1]")
         eref_attributes = { id: node.target || node.id }
         @refids << (node.target || node.id)
         noko do |xml|
@@ -105,7 +106,7 @@ module Asciidoctor
         attrs = {}
         node.option?("landscape") and attrs[:orientation] = "landscape"
         node.option?("portrait") and attrs[:orientation] = "portrait"
-        noko { |xml| xml.pagebreak **attr_code(attrs)}.join
+        noko { |xml| xml.pagebreak **attr_code(attrs) }.join
       end
 
       def thematic_break(_node)
@@ -113,41 +114,45 @@ module Asciidoctor
       end
 
       def xml_encode(text)
-        HTMLEntities.new.encode(text, :basic, :hexadecimal).
-          gsub(/&amp;gt;/, ">").gsub(/\&amp;lt;/, "<").gsub(/&amp;amp;/, "&").
-          gsub(/&gt;/, ">").gsub(/&lt;/, "<").gsub(/&amp;/, "&").
-          gsub(/&quot;/, '"').gsub(/&#xa;/, "\n").gsub(/&amp;#/, "&#")
+        HTMLEntities.new.encode(text, :basic, :hexadecimal)
+          .gsub(/&amp;gt;/, ">").gsub(/&amp;lt;/, "<").gsub(/&amp;amp;/, "&")
+          .gsub(/&gt;/, ">").gsub(/&lt;/, "<").gsub(/&amp;/, "&")
+          .gsub(/&quot;/, '"').gsub(/&#xa;/, "\n").gsub(/&amp;#/, "&#")
       end
 
-      def latex_parse(text)
+      def latex_parse1(text)
         lxm_input = Unicode2LaTeX.unicode2latex(HTMLEntities.new.decode(text))
         results = Latexmath.parse(lxm_input).to_mathml
         results.nil? and
-          @log.add('Math', nil,
+          @log.add("Math", nil,
                    "latexmlmath failed to process equation:\n#{lxm_input}")
         results&.sub(%r{<math ([^>]+ )?display="block"}, "<math \\1")
       end
 
       def stem_parse(text, xml, style)
         if /&lt;([^:>&]+:)?math(\s+[^>&]+)?&gt; |
-          <([^:>&]+:)?math(\s+[^>&]+)?>/x.match text
+          <([^:>&]+:)?math(\s+[^>&]+)?>/x.match? text
           math = xml_encode(text)
           xml.stem math, **{ type: "MathML" }
-        elsif style == :latexmath
-          latex = latex_parse(text) or return xml.stem **{ type: "MathML" }
-          xml.stem **{ type: "MathML" } do |s|
-            math = Nokogiri::XML.fragment(latex.sub(/<\?[^>]+>/, "")).elements[0]
-            math.delete("alttext")
-            s.parent.children = math
-          end
+        elsif style == :latexmath then latex_parse(text, xml)
         else
-          xml.stem text&.gsub(/\&amp;#/, "&#"), **{ type: "AsciiMath" }
+          xml.stem text&.gsub(/&amp;#/, "&#"), **{ type: "AsciiMath" }
         end
       end
 
-        def highlight_parse(text, xml)
-          xml << text
+      def latex_parse(text, xml)
+        latex = latex_parse1(text) or return xml.stem **{ type: "MathML" }
+        xml.stem **{ type: "MathML" } do |s|
+          math = Nokogiri::XML.fragment(latex.sub(/<\?[^>]+>/, ""))
+            .elements[0]
+          math.delete("alttext")
+          s.parent.children = math
         end
+      end
+
+      def highlight_parse(text, xml)
+        xml << text
+      end
 
       def inline_quoted(node)
         noko do |xml|
@@ -182,14 +187,20 @@ module Asciidoctor
 
       def image_attributes(node)
         uri = node.image_uri (node.attr("target") || node.target)
-        types = /^data:/.match(uri) ? Metanorma::Utils::datauri2mime(uri) : MIME::Types.type_for(uri)
+        types = if /^data:/.match?(uri) then Metanorma::Utils::datauri2mime(uri)
+                else MIME::Types.type_for(uri)
+                end
         type = types.first.to_s
         uri = uri.sub(%r{^data:image/\*;}, "data:#{type};")
-        attr_code(src: uri, 
+        image_attributes1(node, uri, type)
+      end
+
+      def image_attributes1(node, uri, type)
+        attr_code(src: uri,
                   id: Metanorma::Utils::anchor_or_uuid,
                   mimetype: type,
                   height: node.attr("height") || "auto",
-                  width: node.attr("width") || "auto" ,
+                  width: node.attr("width") || "auto",
                   filename: node.attr("filename"),
                   title: node.attr("titleattr"),
                   alt: node.alt == node.attr("default-alt") ? nil : node.alt)
@@ -197,14 +208,14 @@ module Asciidoctor
 
       def inline_image(node)
         noko do |xml|
-          xml.image **(image_attributes(node))
+          xml.image **image_attributes(node)
         end.join("")
       end
 
       def inline_indexterm(node)
         noko do |xml|
           node.type == :visible and xml << node.text
-            terms = (node.attr("terms") || [node.text]).map { |x| xml_encode(x) }
+          terms = (node.attr("terms") || [node.text]).map { |x| xml_encode(x) }
           xml.index do |i|
             i.primary { |x| x << terms[0] }
             a = terms.dig(1) and i.secondary { |x| x << a }