metanorma-iso 1.8.0 → 1.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e2e7e19a42e3aeb8a036946cd7a312df8887f9a68a9f0b159399c4a2285f636
-  data.tar.gz: 229cbacc6397cdf692b6294d4f46b88a22ad39a18b80e29be3d85f37c1eeb203
+  metadata.gz: 03102677d8945780e2f740623d37d330fe17e21da1a09c22366c363280494f3d
+  data.tar.gz: 02ea370f541458d81368951748aa0b1c23c8512a455d4b43f454a86f1e1c2e24
 SHA512:
-  metadata.gz: bcfbfd49e84b5127ccb0f4cca2777803ea5a560e60267ccd8e077c7a8b68052f38499a2662f3dfea06641f2a8f278525ebc0118ccef63715bf6e4e1f90badbde
-  data.tar.gz: 003f5ae00770eeb488ca7adf2c13a611bb8a79425f223f07ed765fc5b2333e2700c7e27fa720ce8cfbcfd55750dd633f1f035f46026e792cab5d0fa0c83e7c72
+  metadata.gz: d8d33cbd55be69bcb3e5538213c228fb41ca608239621a6e3e4323cfdb38f7a4cfd020afb29c9b704d0e450ee6a6dec8db6fd1c67a7c606b1698190d7263e250
+  data.tar.gz: ee9de2ba543b4527ed413cc673f3451ae2e521c356bd0c704808c2bb193fd6f5ade5f081ff148be9ec5a543fba65efe67371796c48e40b4a8f1a0617c5a46704

data/.github/workflows/rake.yml

@@ -4,7 +4,7 @@ name: rake
 
 on:
   push:
-    branches: [ master, main  ]
+    branches: [ master, main ]
     tags: [ v* ]
   pull_request:
 
@@ -16,19 +16,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
+        ruby: [ '3.0', '2.7', '2.6', '2.5', '2.4' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
-        include:
-          - ruby: '3.0'
-            os: 'ubuntu-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'windows-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'macos-latest'
-            experimental: true
     steps:
       - uses: actions/checkout@master
 
@@ -49,5 +39,5 @@ jobs:
         with:
           token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
           repository: ${{ github.repository }}
-          event-type: notify
+          event-type: tests-passed
           client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

data/.hound.yml

@@ -1,3 +1,5 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 ruby:
-  Enabled: true
+  enabled: true
   config_file: .rubocop.yml

data/.rubocop.yml

@@ -1,14 +1,10 @@
-# This project follows the Ribose OSS style guide.
-# https://github.com/riboseinc/oss-guides
-# All project-specific additions and overrides should be specified in this file.
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 
 # local repo-specific modifications
+# ...
 
 AllCops:
-  DisplayCopNames: false
-  StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.4
-Rails:
-  Enabled: true
+  TargetRubyVersion: 2.5

data/lib/asciidoctor/iso/base.rb

@@ -17,8 +17,8 @@ module Asciidoctor
       end
 
       def html_converter_alt(node)
-        IsoDoc::Iso::HtmlConvert.new(html_extract_attributes(node).
-                                     merge(alt: true))
+        IsoDoc::Iso::HtmlConvert.new(html_extract_attributes(node)
+                                     .merge(alt: true))
       end
 
       def doc_converter(node)
@@ -27,11 +27,13 @@ module Asciidoctor
 
       def pdf_converter(node)
         return nil if node.attr("no-pdf")
+
         IsoDoc::Iso::PdfConvert.new(doc_extract_attributes(node))
       end
 
       def sts_converter(node)
         return nil if node.attr("no-pdf")
+
         IsoDoc::Iso::StsConvert.new(html_extract_attributes(node))
       end
 
@@ -42,25 +44,26 @@ module Asciidoctor
       def init(node)
         super
         @amd = %w(amendment technical-corrigendum).include? doctype(node)
+        @vocab = node.attr("docsubtype") == "vocabulary"
       end
 
       def ol_attrs(node)
-        attr_code(keep_attrs(node).
-                  merge(id: ::Metanorma::Utils::anchor_or_uuid(node)))
+        attr_code(keep_attrs(node)
+                  .merge(id: ::Metanorma::Utils::anchor_or_uuid(node)))
       end
 
       def outputs(node, ret)
-        File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
-        presentation_xml_converter(node).convert(@filename + ".xml")
-        html_converter_alt(node).convert(@filename + ".presentation.xml", 
+        File.open("#{@filename}.xml", "w:UTF-8") { |f| f.write(ret) }
+        presentation_xml_converter(node).convert("#{@filename}.xml")
+        html_converter_alt(node).convert("#{@filename}.presentation.xml",
                                          nil, false, "#{@filename}_alt.html")
-        html_converter(node).convert(@filename + ".presentation.xml", 
+        html_converter(node).convert("#{@filename}.presentation.xml",
                                      nil, false, "#{@filename}.html")
-        doc_converter(node).convert(@filename + ".presentation.xml", 
+        doc_converter(node).convert("#{@filename}.presentation.xml",
                                     nil, false, "#{@filename}.doc")
-        pdf_converter(node)&.convert(@filename + ".presentation.xml", 
+        pdf_converter(node)&.convert("#{@filename}.presentation.xml",
                                      nil, false, "#{@filename}.pdf")
-        #sts_converter(node)&.convert(@filename + ".xml")
+        # sts_converter(node)&.convert(@filename + ".xml")
       end
     end
   end

data/lib/asciidoctor/iso/biblio.rng

@@ -787,6 +787,7 @@
       <value>adapted</value>
       <value>vote-started</value>
       <value>vote-ended</value>
+      <value>announced</value>
     </choice>
   </define>
   <define name="bdate">

data/lib/asciidoctor/iso/cleanup.rb

@@ -22,20 +22,19 @@ module Asciidoctor
       def other_footnote_renumber(xmldoc)
         seen = {}
         i = 0
-        xmldoc.xpath(PRE_NORMREF_FOOTNOTES).each do |fn|
-          i, seen = other_footnote_renumber1(fn, i, seen)
-        end
-        xmldoc.xpath(NORMREF_FOOTNOTES).each do |fn|
-          i, seen = other_footnote_renumber1(fn, i, seen)
-        end
-        xmldoc.xpath(POST_NORMREF_FOOTNOTES).each do |fn|
-          i, seen = other_footnote_renumber1(fn, i, seen)
+        [PRE_NORMREF_FOOTNOTES, NORMREF_FOOTNOTES,
+         POST_NORMREF_FOOTNOTES].each do |xpath|
+          xmldoc.xpath(xpath).each do |fn|
+            i, seen = other_footnote_renumber1(fn, i, seen)
+          end
         end
       end
 
       def id_prefix(prefix, id)
-        return id.text if @amd # we're just inheriting the prefixes from parent doc
-        prefix.join("/") + ( id.text.match(%{^/}) ? "" :  " " ) + id.text
+        # we're just inheriting the prefixes from parent doc
+        return id.text if @amd
+
+        prefix.join("/") + (id.text.match?(%{^/}) ? "" : " ") + id.text
       end
 
       def get_id_prefix(xmldoc)
@@ -66,8 +65,12 @@ module Asciidoctor
         super
       end
 
-      TERM_CLAUSE = "//sections//terms".freeze
+      TERM_CLAUSE = "//sections//terms | "\
+        "//sections//clause[descendant::terms][not(descendant::definitions)]"
+        .freeze
+
       PUBLISHER = "./contributor[role/@type = 'publisher']/organization".freeze
+
       OTHERIDS = "@type = 'DOI' or @type = 'metanorma' or @type = 'ISSN' or "\
         "@type = 'ISBN'".freeze
 
@@ -79,6 +82,7 @@ module Asciidoctor
         return 2 if bib.at("#{PUBLISHER}[name = 'International "\
                            "Electrotechnical Commission']")
         return 3 if bib.at("./docidentifier[@type][not(#{OTHERIDS})]")
+
         4
       end
 
@@ -101,25 +105,26 @@ module Asciidoctor
         num = bib&.at("./docnumber")&.text
         id = bib&.at("./docidentifier[not(#{OTHERIDS})]")
         metaid = bib&.at("./docidentifier[@type = 'metanorma']")&.text
-        abbrid = metaid unless /^\[\d+\]$/.match(metaid)
+        abbrid = metaid unless /^\[\d+\]$/.match?(metaid)
         /\d-(?<partid>\d+)/ =~ id&.text
-        type = id['type'] if id
+        type = id["type"] if id
         title = bib&.at("./title[@type = 'main']")&.text ||
           bib&.at("./title")&.text || bib&.at("./formattedref")&.text
         "#{pubclass} :: #{type} :: "\
-          "#{num.nil? ? abbrid : sprintf("%09d", num.to_i)} :: "\
+          "#{num.nil? ? abbrid : sprintf('%09d', num.to_i)} :: "\
           "#{partid} :: #{id&.text} :: #{title}"
       end
 
-      def sections_cleanup(x)
+      def sections_cleanup(xml)
         super
         return unless @amd
-        x.xpath("//*[@inline-header]").each do |h|
-          h.delete('inline-header')
+
+        xml.xpath("//*[@inline-header]").each do |h|
+          h.delete("inline-header")
         end
       end
 
-      def boilerplate_file(xmldoc)
+      def boilerplate_file(_xmldoc)
         file = @lang == "fr" ? "boilerplate-fr.xml" : "boilerplate.xml"
         File.join(@libdir, file)
       end
@@ -146,16 +151,27 @@ module Asciidoctor
       end
 
       def unpublished_note(xmldoc)
-        xmldoc.xpath("//bibitem[not(note[@type = 'Unpublished-Status'])]").each do |b|
+        xmldoc.xpath("//bibitem[not(note[@type = 'Unpublished-Status'])]")
+          .each do |b|
           next if pub_class(b) > 2
-          next unless s = b.at("./status/stage") and s.text.to_i < 60
+          next unless (s = b.at("./status/stage")) && (s.text.to_i < 60)
+
           id = b.at("docidentifier").text
-          b.at("./language | ./script | ./abstract | ./status").previous = <<~NOTE
-          <note type="Unpublished-Status">
-            <p>#{@i18n.under_preparation.sub(/%/, id)}</p></note>
-          NOTE
+          b.at("./language | ./script | ./abstract | ./status")
+            .previous = %(<note type="Unpublished-Status">
+                          <p>#{@i18n.under_preparation.sub(/%/, id)}</p></note>)
         end
       end
+
+      def termdef_boilerplate_insert(xmldoc, isodoc, once = false)
+        once = true
+        super
+      end
+
+      def term_defs_boilerplate_cont(src, term, isodoc)
+        @vocab and src.empty? and return
+        super
+      end
     end
   end
 end

data/lib/asciidoctor/iso/front.rb

@@ -33,7 +33,9 @@ module Asciidoctor
         csv_split(publishers).each do |p|
           xml.contributor do |c|
             c.role **{ type: "author" }
-            c.organization { |a| organization(a, p, node, !node.attr("publisher")) }
+            c.organization do |a|
+              organization(a, p, false, node, !node.attr("publisher"))
+            end
           end
         end
       end
@@ -43,20 +45,25 @@ module Asciidoctor
         csv_split(publishers).each do |p|
           xml.contributor do |c|
             c.role **{ type: "publisher" }
-            c.organization { |a| organization(a, p, node, !node.attr("publisher")) }
+            c.organization do |a|
+              organization(a, p, true, node, !node.attr("publisher"))
+            end
           end
         end
       end
 
       def metadata_copyright(node, xml)
-        publishers = node.attr("copyright-holder") || node.attr("publisher") || "ISO"
+        publishers = node.attr("copyright-holder") || node.attr("publisher") ||
+          "ISO"
         csv_split(publishers).each do |p|
           xml.copyright do |c|
             c.from (node.attr("copyright-year") || Date.today.year)
             c.owner do |owner|
               owner.organization do |o|
-                organization(o, p, node,
-                             !(node.attr("copyright-holder") || node.attr("publisher")))
+                organization(
+                  o, p, true, node,
+                  !(node.attr("copyright-holder") || node.attr("publisher"))
+                )
               end
             end
           end
@@ -82,34 +89,39 @@ module Asciidoctor
         end
       end
 
-      def title_intro(node, t, lang, at)
+      def title_intro(node, xml, lang, at)
         return unless node.attr("title-intro-#{lang}")
-        t.title(**attr_code(at.merge(type: "title-intro"))) do |t1|
+
+        xml.title(**attr_code(at.merge(type: "title-intro"))) do |t1|
           t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-intro-#{lang}"))
         end
       end
 
-      def title_main(node, t, lang, at)
-        t.title **attr_code(at.merge(type: "title-main")) do |t1|
+      def title_main(node, xml, lang, at)
+        xml.title **attr_code(at.merge(type: "title-main")) do |t1|
           t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-main-#{lang}"))
         end
       end
 
-      def title_part(node, t, lang, at)
+      def title_part(node, xml, lang, at)
         return unless node.attr("title-part-#{lang}")
-        t.title(**attr_code(at.merge(type: "title-part"))) do |t1|
+
+        xml.title(**attr_code(at.merge(type: "title-part"))) do |t1|
           t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-part-#{lang}"))
         end
       end
 
-      def title_amd(node, t, lang, at)
+      def title_amd(node, xml, lang, at)
         return unless node.attr("title-amendment-#{lang}")
-        t.title(**attr_code(at.merge(type: "title-amd"))) do |t1|
-          t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-amendment-#{lang}"))
+
+        xml.title(**attr_code(at.merge(type: "title-amd"))) do |t1|
+          t1 << Metanorma::Utils::asciidoc_sub(
+            node.attr("title-amendment-#{lang}")
+          )
         end
       end
 
-      def title_full(node, t, lang, at)
+      def title_full(node, xml, lang, at)
         title = node.attr("title-main-#{lang}")
         intro = node.attr("title-intro-#{lang}")
         part = node.attr("title-part-#{lang}")
@@ -117,7 +129,7 @@ module Asciidoctor
         title = "#{intro} -- #{title}" if intro
         title = "#{title} -- #{part}" if part
         title = "#{title} -- #{amd}" if amd && @amd
-        t.title **attr_code(at.merge(type: "main")) do |t1|
+        xml.title **attr_code(at.merge(type: "main")) do |t1|
           t1 << Metanorma::Utils::asciidoc_sub(title)
         end
       end

data/lib/asciidoctor/iso/front_id.rb

@@ -35,22 +35,26 @@ module Asciidoctor
 
       def stage_abbr(stage, substage, doctype)
         return nil if stage.to_i > 60
+
         ret = STAGE_ABBRS[stage.to_sym]
         ret = "PRF" if stage == "60" && substage == "00"
         ret = "AWI" if stage == "10" && substage == "99"
-        if %w(amendment technical-corrigendum technical-report 
-          technical-specification).include?(doctype)
+        if %w(amendment technical-corrigendum technical-report
+              technical-specification).include?(doctype)
           ret = "D" if stage == "40" && doctype == "amendment"
-          ret = "FD" if stage == "50" && %w(amendment technical-corrigendum).include?(doctype)
+          ret = "FD" if stage == "50" && %w(amendment technical-corrigendum)
+            .include?(doctype)
         end
         ret
       end
 
       def stage_name(stage, substage, doctype, iteration = nil)
         return "Proof" if stage == "60" && substage == "00"
+
         ret = STAGE_NAMES[stage.to_sym]
         if iteration && %w(20 30).include?(stage)
-          prefix = iteration.to_i.localize(@lang.to_sym).to_rbnf_s("SpelloutRules", "spellout-ordinal")
+          prefix = iteration.to_i.localize(@lang.to_sym)
+            .to_rbnf_s("SpelloutRules", "spellout-ordinal")
           ret = "#{prefix.capitalize} #{ret.downcase}"
         end
         ret
@@ -65,37 +69,39 @@ module Asciidoctor
       end
 
       def iso_id(node, xml)
-        return unless !@amd && node.attr("docnumber") || @amd && node.attr("updates")
+        !@amd && node.attr("docnumber") || @amd && node.attr("updates") or
+          return
+
         dn = iso_id1(node)
         dn1 = id_stage_prefix(dn, node, false)
         dn2 = id_stage_prefix(dn, node, true)
         xml.docidentifier dn1, **attr_code(type: "ISO")
-        xml.docidentifier id_langsuffix(dn1, node), **attr_code(type: "iso-with-lang")
-        xml.docidentifier id_langsuffix(dn2, node), **attr_code(type: "iso-reference")
+        xml.docidentifier(id_langsuffix(dn1, node),
+                          **attr_code(type: "iso-with-lang"))
+        xml.docidentifier(id_langsuffix(dn2, node),
+                          **attr_code(type: "iso-reference"))
       end
 
       def iso_id1(node)
         if @amd
           dn = node.attr("updates")
-          return add_amd_parts(dn, node)
+          add_amd_parts(dn, node)
         else
           part, subpart = node&.attr("partnumber")&.split(/-/)
-          return add_id_parts(node.attr("docnumber"), part, subpart)
+          add_id_parts(node.attr("docnumber"), part, subpart)
         end
       end
 
-      def add_amd_parts(dn, node)
-        a = node.attr("amendment-number")
-        c = node.attr("corrigendum-number")
+      def add_amd_parts(docnum, node)
         case doctype(node)
         when "amendment"
-          "#{dn}/Amd #{node.attr('amendment-number')}"
+          "#{docnum}/Amd #{node.attr('amendment-number')}"
         when "technical-corrigendum"
-          "#{dn}/Cor.#{node.attr('corrigendum-number')}"
+          "#{docnum}/Cor.#{node.attr('corrigendum-number')}"
         end
       end
 
-      def id_langsuffix(dn, node)
+      def id_langsuffix(docnum, node)
         lang = node.attr("language") || "en"
         suffix = case lang
                  when "en" then "(E)"
@@ -103,38 +109,43 @@ module Asciidoctor
                  else
                    "(X)"
                  end
-        "#{dn}#{suffix}"
+        "#{docnum}#{suffix}"
       end
 
       def structured_id(node, xml)
         return unless node.attr("docnumber")
+
         part, subpart = node&.attr("partnumber")&.split(/-/)
         xml.structuredidentifier do |i|
-          i.project_number node.attr("docnumber"),
-            **attr_code(part: part, subpart: subpart,
-                        amendment: node.attr("amendment-number"),
-                        corrigendum: node.attr("corrigendum-number"),
-                        origyr: node.attr("created-date"))
+          i.project_number(node.attr("docnumber"), **attr_code(
+            part: part, subpart: subpart,
+            amendment: node.attr("amendment-number"),
+            corrigendum: node.attr("corrigendum-number"),
+            origyr: node.attr("created-date")
+          ))
         end
       end
 
-      def add_id_parts(dn, part, subpart)
-        dn += "-#{part}" if part
-        dn += "-#{subpart}" if subpart
-        dn
+      def add_id_parts(docnum, part, subpart)
+        docnum += "-#{part}" if part
+        docnum += "-#{subpart}" if subpart
+        docnum
       end
 
       def id_stage_abbr(stage, substage, node, bare = false)
-        ret = bare ? 
-          IsoDoc::Iso::Metadata.new("en", "Latn", @i18n)
-          .status_abbrev(stage_abbr(stage, substage, doctype(node)),
-        substage, nil, nil, doctype(node)) :
-        IsoDoc::Iso::Metadata.new("en", "Latn", @i18n)
-          .status_abbrev(stage_abbr(stage, substage, doctype(node)),
-        substage, node.attr("iteration"),
-        node.attr("draft"), doctype(node))
-        if %w(amendment technical-corrigendum technical-report technical-specification).include?(doctype(node))
-          ret = ret + " " unless %w(D FD).include?(ret)
+        ret = if bare
+                IsoDoc::Iso::Metadata.new("en", "Latn", @i18n)
+                  .status_abbrev(stage_abbr(stage, substage, doctype(node)),
+                substage, nil, nil, doctype(node))
+              else
+                IsoDoc::Iso::Metadata.new("en", "Latn", @i18n)
+                  .status_abbrev(stage_abbr(stage, substage, doctype(node)),
+                substage, node.attr("iteration"),
+                node.attr("draft"), doctype(node))
+              end
+        if %w(amendment technical-corrigendum technical-report
+              technical-specification).include?(doctype(node))
+          ret = "#{ret} " unless %w(D FD).include?(ret)
         end
         ret
       end
@@ -143,51 +154,56 @@ module Asciidoctor
         stage = get_stage(node)
         abbr = id_stage_abbr(get_stage(node), get_substage(node), node, true)
         typeabbr = get_typeabbr(node, true)
-        typeabbr = "" if stage.to_i > 50 || stage.to_i == 60 && get_substage(node).to_i < 60
+        if stage.to_i > 50 || stage.to_i == 60 && get_substage(node).to_i < 60
+          typeabbr = ""
+        end
         "#{abbr}#{typeabbr}".strip
       end
 
-      def id_stage_prefix(dn, node, force_year)
+      def id_stage_prefix(docnum, node, force_year)
         stage = get_stage(node)
         typeabbr = get_typeabbr(node)
         if stage && (stage.to_i < 60)
-          dn = unpub_stage_prefix(dn, stage, typeabbr, node)
-        elsif typeabbr && !@amd then dn = "/#{typeabbr}#{dn}"
+          docnum = unpub_stage_prefix(docnum, stage, typeabbr, node)
+        elsif typeabbr == "DIR " then docnum = "#{typeabbr}#{docnum}"
+        elsif typeabbr && !@amd then docnum = "/#{typeabbr}#{docnum}"
         end
         (force_year || !(stage && (stage.to_i < 60))) and
-          dn = id_add_year(dn, node)
-        dn
+          docnum = id_add_year(docnum, node)
+        docnum
       end
 
-      def unpub_stage_prefix(dn, stage, typeabbr, node)
+      def unpub_stage_prefix(docnum, stage, typeabbr, node)
         abbr = id_stage_abbr(stage, get_substage(node), node)
         %w(40 50).include?(stage) && i = node.attr("iteration") and
           itersuffix = ".#{i}"
-        return dn if abbr.nil? || abbr.empty? # prefixes added in cleanup
-        return "/#{abbr}#{typeabbr} #{dn}#{itersuffix}" unless @amd
-        a = dn.split(%r{/})
+        return docnum if abbr.nil? || abbr.empty? # prefixes added in cleanup
+        return "/#{abbr}#{typeabbr} #{docnum}#{itersuffix}" unless @amd
+
+        a = docnum.split(%r{/})
         a[-1] = "#{abbr}#{a[-1]}#{itersuffix}"
         a.join("/")
       end
 
-      def id_add_year(dn, node)
+      def id_add_year(docnum, node)
         year = node.attr("copyright-year")
         @amd and year ||= node.attr("updated-date")&.sub(/-.*$/, "")
-        dn += ":#{year}" if year
-        dn
+        docnum += ":#{year}" if year
+        docnum
       end
 
       def get_stage(node)
-        stage = node.attr("status") || node.attr("docstage") || "60"
+        node.attr("status") || node.attr("docstage") || "60"
       end
 
       def get_substage(node)
         stage = get_stage(node)
-        node.attr("docsubstage") || ( stage == "60" ? "60" : "00" )
+        node.attr("docsubstage") || (stage == "60" ? "60" : "00")
       end
 
       def get_typeabbr(node, amd = false)
         case doctype(node)
+        when "directive" then "DIR "
         when "technical-report" then "TR "
         when "technical-specification" then "TS "
         when "amendment" then (amd ? "Amd " : "")