metanorma-standoc 1.8.5 → 1.9.1

data/lib/asciidoctor/standoc/cleanup_ref.rb

@@ -14,9 +14,10 @@ module Asciidoctor
         fold_notes_into_biblio(refs)
         bib = sort_biblio(refs.xpath("./bibitem"))
         insert = refs&.at("./bibitem")&.previous_element
-        refs.xpath("./bibitem").each { |b| b.remove }
+        refs.xpath("./bibitem").each(&:remove)
         bib.reverse.each do |b|
-          insert and insert.next = b.to_xml or refs.children.first.add_previous_sibling b.to_xml
+          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) }
@@ -24,7 +25,7 @@ module Asciidoctor
 
       def fold_notes_into_biblio(refs)
         refs.xpath("./bibitem").each do |r|
-          while r&.next_element&.name == "note" do
+          while r&.next_element&.name == "note"
             r.next_element["appended"] = true
             r << r.next_element.remove
           end
@@ -49,12 +50,15 @@ module Asciidoctor
       # only numeric references are renumbered
       def biblio_renumber(xmldoc)
         i = 0
-        xmldoc.xpath("//bibliography//references | //clause//references | //annex//references").each do |r|
+        xmldoc.xpath("//bibliography//references | //clause//references | "\
+                     "//annex//references").each do |r|
           next if r["normative"] == "true"
+
           r.xpath("./bibitem").each do |b|
             i += 1
             next unless docid = b.at("./docidentifier[@type = 'metanorma']")
-            next unless  /^\[\d+\]$/.match(docid.text)
+            next unless /^\[\d+\]$/.match?(docid.text)
+
             docid.children = "[#{i}]"
           end
         end
@@ -72,7 +76,7 @@ module Asciidoctor
         r = xmldoc.at(self.class::NORM_REF) || return
         preface = r.xpath("./title/following-sibling::*") & # intersection
           r.xpath("./bibitem[1]/preceding-sibling::*")
-        preface.each { |n| n.remove }
+        preface.each(&:remove)
       end
 
       def biblio_cleanup(xmldoc)
@@ -92,6 +96,7 @@ module Asciidoctor
       def format_ref(ref, type)
         return @isodoc.docid_prefix(type, ref) if type != "metanorma"
         return "[#{ref}]" if /^\d+$/.match(ref) && !/^\[.*\]$/.match(ref)
+
         ref
       end
 
@@ -103,7 +108,7 @@ module Asciidoctor
 
       def reference_names(xmldoc)
         xmldoc.xpath("//bibitem[not(ancestor::bibitem)]").each do |ref|
-          isopub = ref.at(ISO_PUBLISHER_XPATH)
+          # isopub = ref.at(ISO_PUBLISHER_XPATH)
           docid = ref.at("./docidentifier[@type = 'metanorma']") ||
             ref.at("./docidentifier[not(@type = 'DOI')]") or next
           reference = format_ref(docid.text, docid["type"])
@@ -111,18 +116,20 @@ module Asciidoctor
         end
       end
 
-      def fetch_termbase(termbase, id)
+      def fetch_termbase(_termbase, _id)
         ""
       end
 
       def read_local_bibitem(uri)
-        return nil if %r{^http[s]?://}.match(uri)
-        file = @localdir + uri + ".rxl"
-        File.file?(file) or file = @localdir + uri + ".xml"
+        return nil if %r{^https?://}.match?(uri)
+
+        file = "#{@localdir}#{uri}.rxl"
+        File.file?(file) or file = "#{@localdir}#{uri}.xml"
         File.file?(file) or return nil
         xml = Nokogiri::XML(File.read(file, encoding: "utf-8"))
         ret = xml.at("//*[local-name() = 'bibdata']") or return nil
-        ret = Nokogiri::XML(ret.to_xml.sub(%r{(<bibdata[^>]*?) xmlns=("[^"]+"|'[^']+')}, "\\1")).root
+        ret = Nokogiri::XML(ret.to_xml
+          .sub(%r{(<bibdata[^>]*?) xmlns=("[^"]+"|'[^']+')}, "\\1")).root
         ret.name = "bibitem"
         ins = ret.at("./*[local-name() = 'docidentifier']") or return nil
         ins.previous = %{<uri type="citation">#{uri}</uri>}
@@ -132,7 +139,8 @@ module Asciidoctor
 
       # if citation uri points to local file, get bibitem from it
       def fetch_local_bibitem(xmldoc)
-        xmldoc.xpath("//bibitem[formattedref][uri[@type = 'citation']]").each do |b|
+        xmldoc.xpath("//bibitem[formattedref][uri[@type = 'citation']]")
+          .each do |b|
           uri = b&.at("./uri[@type = 'citation']")&.text
           bibitem = read_local_bibitem(uri) or next
           bibitem["id"] = b["id"]

data/lib/asciidoctor/standoc/cleanup_ref_dl.rb

@@ -8,7 +8,7 @@ module Asciidoctor
         xmldoc.xpath("//clause[@bibitem = 'true']").each do |c|
           bib = dl_bib_extract(c) or next
           validate_ref_dl(bib, c)
-          bibitemxml = RelatonBib::BibliographicItem.new(RelatonBib::HashConverter::hash_to_bib(bib)).to_xml or next
+          bibitemxml = RelatonBib::BibliographicItem.from_hash(bib).to_xml or next
           bibitem = Nokogiri::XML(bibitemxml)
           bibitem.root["id"] = c["id"] if c["id"] && !/^_/.match(c["id"])
           c.replace(bibitem.root)

data/lib/asciidoctor/standoc/cleanup_reqt.rb

@@ -0,0 +1,47 @@
+module Asciidoctor
+  module Standoc
+    module Cleanup
+      def requirement_cleanup(reqt)
+        requirement_descriptions(reqt)
+        requirement_inherit(reqt)
+      end
+
+      def requirement_inherit(reqt)
+        reqt.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(reqt)
+        reqt.xpath("//requirement | //recommendation | //permission")
+          .each do |r|
+          r.children.each do |e|
+            unless e.element? && (reqt_subpart(e.name) ||
+                %w(requirement recommendation permission).include?(e.name))
+              t = Nokogiri::XML::Element.new("description", reqt)
+              e.before(t)
+              t.children = e.remove
+            end
+          end
+          requirement_cleanup1(r)
+        end
+      end
+
+      def requirement_cleanup1(reqt)
+        while d = reqt.at("./description[following-sibling::*[1]"\
+            "[self::description]]")
+          n = d.next.remove
+          d << n.children
+        end
+        reqt.xpath("./description[normalize-space(.)='']").each do |r|
+          r.replace("\n")
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/standoc/cleanup_section.rb

@@ -43,7 +43,7 @@ module Asciidoctor
       end
 
       def bibabstract_location(x)
-        bibabstract = x.at("//bibdata/script") || x.at("//bibdata/language") ||
+        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") ||
@@ -74,11 +74,11 @@ module Asciidoctor
         make_bibliography(x, s)
         x.xpath("//sections/annex").reverse_each { |r| s.next = r.remove }
       end
-      
       def make_annexes(x)
         x.xpath("//*[@annex]").each do |y|
           y.delete("annex")
           next if y.name == "annex" || !y.ancestors("annex").empty?
+
           y.wrap("<annex/>")
           y.parent["id"] = "_#{UUIDTools::UUID.random_create}"
           y.parent["obligation"] = y["obligation"]
@@ -98,6 +98,7 @@ module Asciidoctor
       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")
@@ -151,6 +152,7 @@ module Asciidoctor
 
        def preface_clausebefore_cleanup(xmldoc)
         return unless xmldoc.at("//preface")
+
         unless ins = xmldoc.at("//preface").children.first
           xmldoc.at("//preface") << " "
           ins = xmldoc.at("//preface").children.first
@@ -163,6 +165,7 @@ module Asciidoctor
 
       def sections_clausebefore_cleanup(xmldoc)
         return unless xmldoc.at("//sections")
+
         unless ins = xmldoc.at("//sections").children.first
           xmldoc.at("//sections") << " "
           ins = xmldoc.at("//sections").children.first
@@ -186,8 +189,10 @@ module Asciidoctor
 
       def replace_title(doc, xpath, text, first = false)
         return unless text
+
         doc.xpath(xpath).each_with_index do |node, i|
           next if first && !i.zero?
+
           title = get_or_make_title(node)
           fn = title.xpath("./fn")
           fn.each { |n| n.remove }
@@ -196,24 +201,24 @@ module Asciidoctor
         end
       end
 
-      def sections_names_cleanup(x)
-        replace_title(x, "//clause[@type = 'scope']", @i18n&.scope)
-        replace_title(x, "//preface//abstract", @i18n&.abstract)
-        replace_title(x, "//foreword", @i18n&.foreword)
-        replace_title(x, "//introduction", @i18n&.introduction)
-        replace_title(x, "//acknowledgements", @i18n&.acknowledgements)
-        section_names_refs_cleanup(x)
-        section_names_terms_cleanup(x)
+      def sections_names_cleanup(xml)
+        replace_title(xml, "//clause[@type = 'scope']", @i18n&.scope)
+        replace_title(xml, "//preface//abstract", @i18n&.abstract)
+        replace_title(xml, "//foreword", @i18n&.foreword)
+        replace_title(xml, "//introduction", @i18n&.introduction)
+        replace_title(xml, "//acknowledgements", @i18n&.acknowledgements)
+        section_names_refs_cleanup(xml)
+        section_names_terms_cleanup(xml)
       end
 
-      def section_names_refs_cleanup(x)
-        replace_title(x, "//references[@normative = 'true']",
+      def section_names_refs_cleanup(xml)
+        replace_title(xml, "//references[@normative = 'true']",
                       @i18n&.normref, true)
-        replace_title(x, "//references[@normative = 'false']",
+        replace_title(xml, "//references[@normative = 'false']",
                       @i18n&.bibliography, true)
       end
 
-      NO_SYMABBR = "[.//definitions[not(@type)]]"
+      NO_SYMABBR = "[.//definitions[not(@type)]]".freeze
       SYMABBR = "[.//definitions[@type = 'symbols']"\
         "[@type = 'abbreviated_terms']]".freeze
       SYMnoABBR = "[.//definitions[@type = 'symbols']"\
@@ -223,7 +228,8 @@ module Asciidoctor
 
       def section_names_terms_cleanup(x)
         replace_title(x, "//definitions[@type = 'symbols']", @i18n&.symbols)
-        replace_title(x, "//definitions[@type = 'abbreviated_terms']", @i18n&.abbrev)
+        replace_title(x, "//definitions[@type = 'abbreviated_terms']",
+                      @i18n&.abbrev)
         replace_title(x, "//definitions[not(@type)]", @i18n&.symbolsabbrev)
         replace_title(x, "//terms#{SYMnoABBR} | //clause[.//terms]#{SYMnoABBR}",
                       @i18n&.termsdefsymbols, true)

data/lib/asciidoctor/standoc/converter.rb

@@ -13,7 +13,7 @@ require "asciidoctor/standoc/validate"
 require "asciidoctor/standoc/utils"
 require "asciidoctor/standoc/cleanup"
 require "asciidoctor/standoc/reqt"
-require_relative "./macros.rb"
+require_relative "./macros"
 
 module Asciidoctor
   module Standoc
@@ -39,6 +39,8 @@ module Asciidoctor
         inline_macro Asciidoctor::Standoc::TermRefInlineMacro
         inline_macro Asciidoctor::Standoc::IndexXrefInlineMacro
         inline_macro Asciidoctor::Standoc::IndexRangeInlineMacro
+        inline_macro Asciidoctor::Standoc::AddMacro
+        inline_macro Asciidoctor::Standoc::DelMacro
         block Asciidoctor::Standoc::ToDoAdmonitionBlock
         treeprocessor Asciidoctor::Standoc::ToDoInlineAdmonitionBlock
         block Asciidoctor::Standoc::PlantUMLBlockMacro

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 }
       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

@@ -21,7 +21,7 @@ module Asciidoctor
         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,7 +29,7 @@ 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)
@@ -59,7 +59,7 @@ module Asciidoctor
           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
@@ -144,7 +144,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 +157,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