metanorma-standoc 1.9.3 → 1.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb0657fc8f9c086fa560b509e2e7e5829b9ab5d902e727ce221c040f2aad3ec4
-  data.tar.gz: eac14431d7f0317023a49993dee40a440fbc47d32136091cd4adfea5a5d36823
+  metadata.gz: d42939fe573eddd8bd58ff20a2e3eaacd3eb9de328afccabba60453a8b94cd43
+  data.tar.gz: e2d2e0f516b11587c5dcc6e8f87d39e4d63095b8e96014e7d1bfa610ceb6bae8
 SHA512:
-  metadata.gz: 72d1aece1ed13421fa2fdcd87f8d4468cae148cc415b3a982fc9fea236cbf5f01113e87b11fc88b0aa68ce52f057d5dcdc1441b37c028798cd66458146d0b540
-  data.tar.gz: b736bd6de43ace4da0c31f14b1f7f28349eb7272baf073e5b68558f68cd88e68b84fb72c76d578f0a69c8b56ae8021b5dfe75792dde64fae1a121eeaa156cfc6
+  metadata.gz: 653295f7c1dbdb48a201f0784e6d123058a2ccd0abc018fe9ae68049b9c01f29d0120c3a3ec5a25b968e18fbbf4ca3c85c0da294985f2dcee42ea2d049cdb526
+  data.tar.gz: d36fd8fa5b679f71c780bab99fe4c5a18d58c40e8995065975d87cbc0ce51f6459748c1c5310f3c4419d3058087a78d5e9d481839e4579c2d872d0359852ee28

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,12 +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

data/lib/asciidoctor/standoc/base.rb

@@ -48,11 +48,13 @@ module Asciidoctor
           htmlcoverpage: node.attr("htmlcoverpage"),
           htmlintropage: node.attr("htmlintropage"),
           scripts: node.attr("scripts"),
+          scripts_override: node.attr("scripts-override"),
           scripts_pdf: node.attr("scripts-pdf"),
           datauriimage: node.attr("data-uri-image"),
           htmltoclevels: node.attr("htmltoclevels") || node.attr("toclevels"),
           doctoclevels: node.attr("doctoclevels") || node.attr("toclevels"),
           break_up_urls_in_tables: node.attr("break-up-urls-in-tables"),
+          bare: node.attr("bare"),
           sectionsplit: node.attr("sectionsplit"),
         }
       end
@@ -80,6 +82,7 @@ module Asciidoctor
           htmltoclevels: node.attr("htmltoclevels") || node.attr("toclevels"),
           doctoclevels: node.attr("doctoclevels") || node.attr("toclevels"),
           break_up_urls_in_tables: node.attr("break-up-urls-in-tables"),
+          bare: node.attr("bare"),
         }
 
         if font_manifest_file = node.attr("mn2pdf-font-manifest-file")

data/lib/asciidoctor/standoc/cleanup_section.rb

@@ -3,20 +3,21 @@ require "htmlentities"
 require "json"
 require "open-uri"
 require "mathml2asciimath"
+require_relative "cleanup_section_names"
 
 module Asciidoctor
   module Standoc
     module Cleanup
-      def make_preface(xml, s)
+      def make_preface(xml, sect)
         if xml.at("//foreword | //introduction | //acknowledgements | "\
             "//*[@preface]")
-          preface = s.add_previous_sibling("<preface/>").first
+          preface = sect.add_previous_sibling("<preface/>").first
           f = xml.at("//foreword") and preface.add_child f.remove
           f = xml.at("//introduction") and preface.add_child f.remove
           move_clauses_into_preface(xml, preface)
           f = xml.at("//acknowledgements") and preface.add_child f.remove
         end
-        make_abstract(xml, s)
+        make_abstract(xml, sect)
       end
 
       def move_clauses_into_preface(xml, preface)
@@ -26,10 +27,10 @@ module Asciidoctor
         end
       end
 
-      def make_abstract(xml, s)
+      def make_abstract(xml, sect)
         if xml.at("//abstract[not(ancestor::bibitem)]")
-          preface = s.at("//preface") ||
-            s.add_previous_sibling("<preface/>").first
+          preface = sect.at("//preface") ||
+            sect.add_previous_sibling("<preface/>").first
           abstract = xml.at("//abstract[not(ancestor::bibitem)]").remove
           preface.prepend_child abstract.remove
           bibabstract = bibabstract_location(xml)
@@ -53,17 +54,19 @@ module Asciidoctor
           xml.at("//bibdata/title[not(following-sibling::title)]")
       end
 
-      def make_bibliography(xml, s)
+      def make_bibliography(xml, sect)
         if xml.at("//sections/references")
-          biblio = s.add_next_sibling("<bibliography/>").first
+          biblio = sect.add_next_sibling("<bibliography/>").first
           xml.xpath("//sections/references").each do |r|
             biblio.add_child r.remove
           end
         end
       end
 
-      def make_indexsect(xml, s)
-        xml.xpath("//sections/indexsect").reverse_each { |r| s.next = r.remove }
+      def make_indexsect(xml, sect)
+        xml.xpath("//sections/indexsect").reverse_each do |r|
+          sect.next = r.remove
+        end
       end
 
       def sections_order_cleanup(xml)
@@ -177,76 +180,6 @@ 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(&:remove)
-          title.content = text
-          fn.each { |n| title << n }
-        end
-      end
-
-      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(xml)
-        replace_title(xml, "//references[@normative = 'true']",
-                      @i18n&.normref, true)
-        replace_title(xml, "//references[@normative = 'false']",
-                      @i18n&.bibliography, true)
-      end
-
-      NO_SYMABBR = "[.//definitions[not(@type)]]".freeze
-      SYMABBR = "[.//definitions[@type = 'symbols']]"\
-        "[.//definitions[@type = 'abbreviated_terms']]".freeze
-      SYMnoABBR = "[.//definitions[@type = 'symbols']]"\
-        "[not(.//definitions[@type = 'abbreviated_terms'])]".freeze
-      ABBRnoSYM = "[.//definitions[@type = 'abbreviated_terms']]"\
-        "[not(.//definitions[@type = 'symbols'])]".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_section_names.rb

@@ -0,0 +1,75 @@
+module Asciidoctor
+  module Standoc
+    module Cleanup
+      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(&:remove)
+          title.content = text
+          fn.each { |n| title << n }
+        end
+      end
+
+      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(xml)
+        replace_title(xml, "//references[@normative = 'true']",
+                      @i18n&.normref, true)
+        replace_title(xml, "//references[@normative = 'false']",
+                      @i18n&.bibliography, true)
+      end
+
+      NO_SYMABBR = "[.//definitions[not(@type)]]".freeze
+      SYMABBR = "[.//definitions[@type = 'symbols']]"\
+        "[.//definitions[@type = 'abbreviated_terms']]".freeze
+      SYMnoABBR = "[.//definitions[@type = 'symbols']]"\
+        "[not(.//definitions[@type = 'abbreviated_terms'])]".freeze
+      ABBRnoSYM = "[.//definitions[@type = 'abbreviated_terms']]"\
+        "[not(.//definitions[@type = 'symbols'])]".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/front_contributor.rb

@@ -10,13 +10,13 @@ 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
@@ -32,34 +32,36 @@ module Asciidoctor
         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, false, 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)