metanorma-standoc 1.4.4 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 841be88451455a61d53e89d5c557c57f1769372d878c5200826136dae8d62cfd
-  data.tar.gz: b922c30fbd44544dda7ee63a4090d672030f2af570861b500dcd3e8f205497d3
+  metadata.gz: 76c3b117ea592275339f9ee8103f17645d9675f45635abfbc8e5333fc512af1c
+  data.tar.gz: a345b19a2657f356225f2087e17a7dba7bd4720389cf44487892d3f1e1bc5345
 SHA512:
-  metadata.gz: cd2d8b314061fb9c108b6e7568ee9dc65ce81180e955961d593bcaf17081b0e8e7c3e22c8d132ce57c0f5c698869347ff35fd7b56b62d0d1ee34b6c8877a462c
-  data.tar.gz: 7e501083f23311f0b8a8b22eeaf8ec2990d39bc442fe76882b9172bb9bfafc44d273f1485ae0a9117006ba508beff735857194fdf0a49d8eb80deaf902b3a433
+  metadata.gz: 630d1159cc78920d3bab3e73a2577b54d00bb966b0faa15166ff1af832656ab985e55f8fa830d40a2fbec96a8cf8555880f89f0e73d749dc73540e6cd8303469
+  data.tar.gz: f3c46604bb69f1e34eb8b2af182e198e99a6f2cae3bce808a9547e096b1852b4868c00a8522370a52c92ad5f263ab2f7e5ee348196fffbe1084ef1c666900080

data/.rubocop.yml

@@ -5,6 +5,6 @@
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.6
 Rails:
   Enabled: true

data/lib/asciidoctor/standoc/base.rb

@@ -111,9 +111,10 @@ module Asciidoctor
         @log = Asciidoctor::Standoc::Log.new
         init_bib_caches(node)
         init_iev_caches(node)
-        lang = (node.attr("language") || "en")
-        script = (node.attr("script") || "en")
-        i18n_init(lang, script)
+        @lang = (node.attr("language") || "en")
+        @script = (node.attr("script") || "Latn")
+        @isodoc = isodoc(@lang, @script, node.attr("i18nyaml"))
+        @i18n = @isodoc.i18n
       end
 
       def default_fonts(node)

data/lib/asciidoctor/standoc/cleanup_boilerplate.rb

@@ -2,25 +2,25 @@ module Asciidoctor
   module Standoc
     module Cleanup
       def external_terms_boilerplate(sources)
-        IsoDoc::Function::I18n::l10n(
-          @external_terms_boilerplate.gsub(/%/, sources || "???"),
+        @i18n.l10n(
+          @i18n.external_terms_boilerplate.gsub(/%/, sources || "???"),
           @lang, @script)
       end
 
       def internal_external_terms_boilerplate(sources)
-        IsoDoc::Function::I18n::l10n(
-          @internal_external_terms_boilerplate.gsub(/%/, sources || "??"),
+        @i18n.l10n(
+          @i18n.internal_external_terms_boilerplate.gsub(/%/, sources || "??"),
           @lang, @script)
       end
 
       def term_defs_boilerplate(div, source, term, preface, isodoc)
-        div.next = @term_def_boilerplate
+        a = @i18n.term_def_boilerplate and div.next = a
         source.each do |s|
           @anchors[s["bibitemid"]] or
             @log.add("Crossreferences", nil, "term source #{s['bibitemid']} not referenced")
         end
         if source.empty? && term.nil?
-          div.next = @no_terms_boilerplate
+          div.next = @i18n.no_terms_boilerplate
         else
           div.next = term_defs_boilerplate_cont(source, term, isodoc)
         end
@@ -30,7 +30,7 @@ module Asciidoctor
         sources = isodoc.sentence_join(src.map do |s|
           %{<eref bibitemid="#{s['bibitemid']}"/>}
         end)
-        if src.empty? then @internal_terms_boilerplate
+        if src.empty? then @i18n.internal_terms_boilerplate
         elsif term.nil? then external_terms_boilerplate(sources)
         else
           internal_external_terms_boilerplate(sources)
@@ -42,7 +42,7 @@ module Asciidoctor
         ["reference", "bibitem"].include? e.name
       end
       f.at("./title").next =
-        "<p>#{(refs.empty? ? @norm_empty_pref : @norm_with_refs_pref)}</p>"
+        "<p>#{(refs.empty? ? @i18n.norm_empty_pref : @i18n.norm_with_refs_pref)}</p>"
     end
 
       TERM_CLAUSE = "//sections/terms | "\
@@ -54,13 +54,9 @@ module Asciidoctor
         x = xmldoc.dup
         x.root.add_namespace(nil, self.class::XML_NAMESPACE)
         xml = Nokogiri::XML(x.to_xml)
-        conv = html_converter(EmptyAttr.new)
-        @lang = xmldoc&.at("//bibdata/language")&.text
-        @script = xmldoc&.at("//bibdata/script")&.text
-        conv.i18n_init(@lang, @script)
-        conv.metadata_init(@lang, @script, conv.labels)
-        conv.info(xml, nil)
-        conv
+        @isodoc ||= isodoc(@lang, @script)
+        @isodoc.info(xml, nil)
+        @isodoc
       end
 
       def boilerplate_cleanup(xmldoc)
@@ -83,15 +79,6 @@ module Asciidoctor
         preface.previous = b
       end
 
-      class EmptyAttr
-        def attr(_x)
-          nil
-        end
-        def attributes
-          {}
-        end
-      end
-
       def boilerplate_file(xmldoc)
         File.join(@libdir, "boilerplate.xml")
       end

data/lib/asciidoctor/standoc/cleanup_section.rb

@@ -39,6 +39,7 @@ module Asciidoctor
           dupabstract.traverse { |n| n.remove_attribute("id") }
           dupabstract.remove_attribute("language")
           dupabstract.remove_attribute("script")
+          dupabstract&.at("./title")&.remove
           bibabstract.next = dupabstract
         end
       end
@@ -105,6 +106,7 @@ module Asciidoctor
       def sections_cleanup(x)
         sections_order_cleanup(x)
         sections_level_cleanup(x)
+        sections_names_cleanup(x)
       end
 
       def obligations_cleanup(x)
@@ -118,15 +120,15 @@ module Asciidoctor
         (s = x.at("//introduction")) && s["obligation"] = "informative"
         (s = x.at("//acknowledgements")) && s["obligation"] = "informative"
         x.xpath("//references").each { |r| r["obligation"] = "informative" }
-        x.xpath("//preface//clause").each { |r| r["obligation"] = "informative" }
+        x.xpath("//preface//clause").each do |r|
+          r["obligation"] = "informative"
+        end
       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"
+        (s = x.at("//clause[@type = 'scope']")) && s["obligation"] = "normative"
         x.xpath("//terms").each { |r| r["obligation"] = "normative" }
-        x.xpath("//symbols-abbrevs").each { |r| r["obligation"] = "normative" }
+        x.xpath("//definitions").each { |r| r["obligation"] = "normative" }
       end
 
       def obligations_cleanup_inherit(x)
@@ -149,6 +151,71 @@ module Asciidoctor
           ins.previous = x.remove
         end
       end
+
+      def get_or_make_title(node)
+          unless node.at("./title")
+            if node.children.empty?
+              node << "<title/>"
+            else
+              node.children.first.previous = "<title/>"
+            end
+          end
+          node.at("./title")
+      end
+
+      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 }
+          title.content = text
+          fn.each { |n| title << n }
+        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)
+      end
+
+      def section_names_refs_cleanup(x)
+        replace_title(x, "//references[@normative = 'true']",
+                      @i18n&.normref, true)
+        replace_title(x, "//references[@normative = 'false']",
+                      @i18n&.bibliography, true)
+      end
+
+      NO_SYMABBR = "[.//definitions[not(@type)]]"
+      SYMABBR = "[.//definitions[@type = 'symbols']"\
+        "[@type = 'abbreviated_terms']]".freeze
+      SYMnoABBR = "[.//definitions[@type = 'symbols']"\
+        "[not(@type = 'abbreviated_terms')]]".freeze
+      ABBRnoSYM = "[.//definitions[not(@type = 'symbols')]"\
+        "[@type = 'abbreviated_terms']]".freeze
+
+      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[not(@type)]", @i18n&.symbolsabbrev)
+        replace_title(x, "//terms#{SYMnoABBR} | //clause[.//terms]#{SYMnoABBR}",
+                      @i18n&.termsdefsymbols, true)
+        replace_title(x, "//terms#{ABBRnoSYM} | //clause[.//terms]#{ABBRnoSYM}",
+                      @i18n&.termsdefabbrev, true)
+        replace_title(x, "//terms#{SYMABBR} | //clause[.//terms]#{SYMABBR}",
+                      @i18n&.termsdefsymbolsabbrev, true)
+        replace_title(x, "//terms#{NO_SYMABBR} | //clause[.//terms]#{NO_SYMABBR}",
+                      @i18n&.termsdefsymbolsabbrev, true)
+        replace_title(
+          x, "//terms[not(.//definitions)] | //clause[.//terms][not(.//definitions)]",
+          @i18n&.termsdef, true)
+      end
     end
   end
 end

data/lib/asciidoctor/standoc/cleanup_terms.rb

@@ -76,6 +76,15 @@ module Asciidoctor
         end
       end
 
+      def termnote_example_cleanup(xmldoc)
+        xmldoc.xpath("//termnote[not(ancestor::term)]").each do |x|
+          x.name = "note"
+        end
+        xmldoc.xpath("//termexample[not(ancestor::term)]").each do |x|
+          x.name = "note"
+        end
+      end
+
       def termdef_cleanup(xmldoc)
         termdef_from_termbase(xmldoc)
         termdef_unnest_cleanup(xmldoc)
@@ -83,6 +92,7 @@ module Asciidoctor
         termdomain_cleanup(xmldoc)
         termdefinition_cleanup(xmldoc)
         termdomain1_cleanup(xmldoc)
+        termnote_example_cleanup(xmldoc)
         termdef_boilerplate_cleanup(xmldoc)
         termdef_subclause_cleanup(xmldoc)
         term_children_cleanup(xmldoc) 

data/lib/asciidoctor/standoc/converter.rb

@@ -11,7 +11,6 @@ require "asciidoctor/standoc/table"
 require "asciidoctor/standoc/validate"
 require "asciidoctor/standoc/utils"
 require "asciidoctor/standoc/cleanup"
-require "asciidoctor/standoc/i18n"
 require "asciidoctor/standoc/reqt"
 require_relative "./macros.rb"
 require_relative "./log.rb"
@@ -48,7 +47,6 @@ module Asciidoctor
       include ::Asciidoctor::Standoc::Section
       include ::Asciidoctor::Standoc::Table
       include ::Asciidoctor::Standoc::Utils
-      include ::Asciidoctor::Standoc::I18n
       include ::Asciidoctor::Standoc::Cleanup
       include ::Asciidoctor::Standoc::Validate
 

data/lib/asciidoctor/standoc/isodoc.rng

@@ -922,6 +922,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +964,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +992,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1014,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,6 +1042,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1180,6 +1183,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>

data/lib/asciidoctor/standoc/ref.rb

@@ -61,10 +61,10 @@ module Asciidoctor
       end
 
       def isorefrender1(t, m, yr, allp = "")
-          t.title(**plaintxt) { |i| i << ref_normalise(m[:text]) }
-          docid(t, m[:usrlbl]) if m[:usrlbl]
-          docid(t, id_and_year(m[:code], yr) + allp)
-          docnumber(t, m[:code])
+        t.title(**plaintxt) { |i| i << ref_normalise(m[:text]) }
+        docid(t, m[:usrlbl]) if m[:usrlbl]
+        docid(t, id_and_year(m[:code], yr) + allp)
+        docnumber(t, m[:code])
       end
 
       def isorefmatches(xml, m)
@@ -106,15 +106,16 @@ module Asciidoctor
 
       def isorefmatches3(xml, m)
         yr = norm_year(m[:year])
-        hasyr =  m.names.include?("year") && yr != "--"
-        noyr =  m.names.include?("year") && yr == "--"
-        ref = fetch_ref xml, m[:code], hasyr ? yr : nil,
-          all_parts: true, no_year: noyr, text: m[:text], usrlbl: m[:usrlbl]
+        #hasyr =  m.names.include?("year") && yr != "--"
+        hasyr = !yr.nil? && yr != "--"
+        #noyr =  m.names.include?("year") && yr == "--"
+        ref = fetch_ref xml, m[:code], hasyr ? yr : nil, all_parts: true, 
+          no_year: yr == "--", text: m[:text], usrlbl: m[:usrlbl]
         return use_my_anchor(ref, m[:anchor]) if ref
 
         xml.bibitem(**attr_code(ref_attributes(m))) do |t|
           isorefrender1(t, m, yr, " (all parts)")
-          conditional_date(t, m, noyr)
+          conditional_date(t, m, yr == "--")
           iso_publisher(t, m[:code])
           m.names.include?("fn") && m[:fn] and
             t.note(**plaintxt.merge(type: "ISO DATE")) { |p| p << "#{m[:fn]}" }
@@ -150,32 +151,30 @@ module Asciidoctor
         "https://www.metanorma.com/author/iso/topics/markup/#bibliographies".freeze
 
       def analyse_ref_nofetch(ret)
-        if m = /^nofetch\((?<id>.+)\)$/.match(ret[:id])
-          ret[:id] = m[:id]
-          ret[:nofetch] = true
-        end
+        return ret unless m = /^nofetch\((?<id>.+)\)$/.match(ret[:id])
+        ret[:id] = m[:id]
+        ret[:nofetch] = true
         ret
       end
-     
+
       def analyse_ref_repo_path(ret)
-         if m = /^(?<type>repo|path):\((?<key>[^,]+),(?<id>.+)\)$/.match(ret[:id])
-          ret[:id] = m[:id]
-          ret[:type] = m[:type]
-          ret[:key] = m[:key]
-          ret[:nofetch] = true
-        end
-         ret
+        return ret unless m =
+          /^(?<type>repo|path):\((?<key>[^,]+),(?<id>.+)\)$/.match(ret[:id])
+        ret[:id] = m[:id]
+        ret[:type] = m[:type]
+        ret[:key] = m[:key]
+        ret[:nofetch] = true
+        ret
       end
 
       def analyse_ref_numeric(ret)
-        if /^\d+$/.match(ret[:id])
-          ret[:numeric] = true
-        end
+        return ret unless /^\d+$/.match(ret[:id])
+        ret[:numeric] = true
         ret
       end
 
       # ref id = (usrlbl)code[:-]year
-      # code = nofetch(code) | (repo|path):(key,code) | \[? number \]? | identifier
+      # code = nofetch(code) | (repo|path):(key,code) | \[? number \]? | ident
       def analyse_ref_code(code)
         ret = {id: code}
         return ret if code.nil? || code.empty?

data/lib/asciidoctor/standoc/section.rb

@@ -13,9 +13,13 @@ module Asciidoctor
         @term_def
       end
 
-      def sectiontype(node, level = true)
-        ret = node&.attr("heading")&.downcase ||
+      def sectiontype1(node)
+        node&.attr("heading")&.downcase ||
           node.title.gsub(/<[^>]+>/, "").downcase
+      end
+
+      def sectiontype(node, level = true)
+        ret = sectiontype1(node)
         ret1 = sectiontype_streamline(ret)
         return ret1 if "symbols and abbreviated terms" == ret1
         return nil unless !level || node.level == 1
@@ -61,16 +65,18 @@ module Asciidoctor
           case sectiontype(node)
           when "introduction" then introduction_parse(a, xml, node)
           when "foreword" then foreword_parse(a, xml, node)
+          when "scope" then scope_parse(a, xml, node)
           when "normative references" then norm_ref_parse(a, xml, node)
           when "terms and definitions"
             @term_def = true
             term_def_parse(a, xml, node, true)
             @term_def = false
           when "symbols and abbreviated terms"
-            symbols_parse(a, xml, node)
+            symbols_parse(symbols_attrs(node, a), xml, node)
           when "acknowledgements"
             acknowledgements_parse(a, xml, node)
-          when "bibliography" then bibliography_parse(a, xml, node)
+          when "bibliography" 
+            bibliography_parse(a, xml, node)
           else
             if @term_def then term_def_subclause_parse(a, xml, node)
             elsif @definitions then symbols_parse(a, xml, node)
@@ -106,7 +112,7 @@ module Asciidoctor
       def preamble(node)
         noko do |xml|
           xml.foreword **attr_code(section_attributes(node)) do |xml_abstract|
-            xml_abstract.title { |t| t << (node.blocks[0].title || "Foreword") }
+            xml_abstract.title { |t| t << (node.blocks[0].title || @i18n.foreword) }
             content = node.content
             xml_abstract << content
           end
@@ -119,6 +125,10 @@ module Asciidoctor
         end
       end
 
+      def scope_parse(attrs, xml, node)
+        clause_parse(attrs.merge(type: "scope"), xml, node)
+      end
+
       def clause_parse(attrs, xml, node)
         attrs["inline-header".to_sym] = node.option? "inline-header"
         attrs[:bibitem] = true if node.option? "bibitem"
@@ -145,6 +155,15 @@ module Asciidoctor
         @definitions = true
       end
 
+      def symbols_attrs(node, a)
+        case sectiontype1(node)
+        when "symbols" then a.merge(type: "symbols")
+        when "abbreviated terms", "abbreviations" then a.merge(type: "abbreviated_terms")
+        else
+          a
+        end
+      end
+
       def symbols_parse(attr, xml, node)
         node.role == "nonterm" and return nonterm_symbols_parse(attr, xml, node)
         xml.definitions **attr_code(attr) do |xml_section|
@@ -159,9 +178,6 @@ module Asciidoctor
         end
       end
 
-      SYMBOLS_TITLES = ["symbols and abbreviated terms", "symbols",
-                        "abbreviated terms"].freeze
-
       def nonterm_term_def_subclause_parse(attrs, xml, node)
         @term_def = false
         clause_parse(attrs, xml, node)
@@ -190,23 +206,9 @@ module Asciidoctor
         end
       end
 
-      def term_def_title(toplevel, node)
-        return node.title unless toplevel
-        sub = node.find_by(context: :section) do |s|
-          SYMBOLS_TITLES.include? s.title.downcase
-        end
-        return "Terms and definitions" if sub.empty?
-        sym = /symbol/i.match(node.title)
-        abbrev = /abbreviat/i.match(node.title)
-        sym && abbrev and return "Terms, definitions, symbols and abbreviated terms"
-        sym and return "Terms, definitions and symbols"
-        abbrev and return "Terms, definitions and abbreviated terms"
-        "Terms, definitions, symbols and abbreviated terms"
-      end
-
       def term_def_parse(attrs, xml, node, toplevel)
         xml.terms **attr_code(attrs) do |section|
-          section.title { |t| t << term_def_title(toplevel, node) }
+          section.title { |t| t << node.title }
           (s = node.attr("source")) && s.split(/,/).each do |s1|
             section.termdocsource(nil, **attr_code(bibitemid: s1))
           end
@@ -216,7 +218,7 @@ module Asciidoctor
 
       def introduction_parse(attrs, xml, node)
         xml.introduction **attr_code(attrs) do |xml_section|
-          xml_section.title { |t| t << "Introduction" }
+          xml_section.title { |t| t << @i18n.introduction }
           content = node.content
           xml_section << content
         end
@@ -232,7 +234,7 @@ module Asciidoctor
 
       def acknowledgements_parse(attrs, xml, node)
         xml.acknowledgements **attr_code(attrs) do |xml_section|
-          xml_section.title { |t| t << node.title || "Acknowledgements" }
+          xml_section.title { |t| t << node.title || @i18n.acknowledgements }
           content = node.content
           xml_section << content
         end