metanorma-iso 1.7.1 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9af9da09f9e17f25423843c284ed66d9f2206535631b334263bea9f80211acf6
-  data.tar.gz: 9987c2fcb45025dee73bc95fd21939104495dbf3e07e79afac877b7b9fcf81f4
+  metadata.gz: 9d170797212efc1050755714c1c875246a5b1b07ca8c4c1b6562b51ab2ee44a9
+  data.tar.gz: a6deb053bf737183c275a1f93a110d89f8fa42a093bafd514c7d672b5e16f427
 SHA512:
-  metadata.gz: f947d939ce553a170f712c09c903bf5d8c1192c7de45063d9407b4a7c300d31ee325cb269db9046d917a0184a18c78f654377922e23b2eca33add015139e5af9
-  data.tar.gz: c5d5d07e2c558293c926c3f4a4be46ff96659670082f2c09951f58dada582f6d93a3d8ccaeba15016bc0548dceda5c5f32d664a8cb05110d69e25179c67f1c4d
+  metadata.gz: 63752e6b4a75cba612fca7cacf5c0ccd7a4553f51b9743e667d7a2891737dff68deace61efcab395be2f22e8b4d6559ee8eee6c50ad84e3f13e627af1ca98a68
+  data.tar.gz: 401f42f155a7424266d3bf62cb6fca9a67ad1adeddf01145c55de95397a91de22847b56fa92563d64045eb6dc2682511eab3925d60f74b1ca737f8ecefacee63

data/.github/workflows/rake.yml

@@ -16,17 +16,17 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.6', '2.5', '2.4' ]
+        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
         include:
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'ubuntu-latest'
             experimental: true
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'windows-latest'
             experimental: true
-          - ruby: '2.7'
+          - ruby: '3.0'
             os: 'macos-latest'
             experimental: true
     steps:
@@ -35,49 +35,19 @@ jobs:
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
 
-      - if: matrix.os == 'macos-latest'
-        run: brew install autoconf automake libtool
-
-      - uses: actions/cache@v2
-        with:
-          path: vendor/bundle
-          key: bundle-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/*.gemspec') }}
-          restore-keys: bundle-${{ matrix.os }}-${{ matrix.ruby }}
-
-      - run: bundle config set path 'vendor/bundle'
-
-      - run: bundle install --jobs 4 --retry 3
-
-      - name: install plantuml ubuntu
-        if: matrix.os == 'ubuntu-latest'
-        uses: nick-invision/retry@v1
-        with:
-          polling_interval_seconds: 5
-          timeout_minutes: 5
-          max_attempts: 3
-          command: >
-            sudo apt-get update -y && sudo bash -c 
-            "curl -L https://github.com/metanorma/plantuml-install/raw/master/ubuntu.sh | bash"
-
-      - if: matrix.os == 'macos-latest'
-        run: brew install plantuml
-
-      - if: matrix.os == 'windows-latest'
-        run: cinst -y plantuml
+      - uses: metanorma/metanorma-build-scripts/plantuml-setup-action@master
 
       - run: bundle exec rake
 
   tests-passed:
     needs: rake
     runs-on: ubuntu-latest
-    continue-on-error: true
     steps:
-      - name: Trigger tests passed event
-        uses: Sibz/github-status-action@v1
+      - uses: peter-evans/repository-dispatch@v1
         with:
-          authToken: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
-          context: 'tests-passed-successfully'
-          description: 'Tests passed successfully'
-          state: 'success'
-          sha: ${{ github.event.pull_request.head.sha || github.sha }}
+          token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
+          repository: ${{ github.repository }}
+          event-type: notify
+          client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

data/.gitignore

@@ -9,3 +9,5 @@ spec/examples/rice.doc
 spec/examples/rice.html
 spec/examples/rice.xml
 spec/examples/rice_files/
+
+.rubocop-https--*

data/.rubocop.yml

@@ -1,10 +1,14 @@
 # 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.
-
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# local repo-specific modifications
+
 AllCops:
-  TargetRubyVersion: 2.3
+  DisplayCopNames: false
+  StyleGuideCopsOnly: false
+  TargetRubyVersion: 2.4
 Rails:
   Enabled: true

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
 
@@ -44,23 +46,23 @@ module Asciidoctor
         @amd = %w(amendment technical-corrigendum).include? doctype(node)
       end
 
-       def ol_attrs(node)
-        attr_code(keep_attrs(node).
-                  merge(id: ::Metanorma::Utils::anchor_or_uuid(node)))
+      def ol_attrs(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", 
-                                           nil, false, "#{@filename}_alt.html")
-          html_converter(node).convert(@filename + ".presentation.xml", 
-                                       nil, false, "#{@filename}.html")
-          doc_converter(node).convert(@filename + ".presentation.xml", 
-                                      nil, false, "#{@filename}.doc")
-          pdf_converter(node)&.convert(@filename + ".presentation.xml", 
-                                       nil, false, "#{@filename}.pdf")
-          #sts_converter(node)&.convert(@filename + ".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",
+                                     nil, false, "#{@filename}.html")
+        doc_converter(node).convert("#{@filename}.presentation.xml",
+                                    nil, false, "#{@filename}.doc")
+        pdf_converter(node)&.convert("#{@filename}.presentation.xml",
+                                     nil, false, "#{@filename}.pdf")
+        # sts_converter(node)&.convert(@filename + ".xml")
       end
     end
   end

data/lib/asciidoctor/iso/biblio.rng

@@ -124,7 +124,7 @@
           <value>application/tei+xml</value>
           <value>text/x-asciidoc</value>
           <value>text/markdown</value>
-          <value>application/x-isodoc+xml</value>
+          <value>application/x-metanorma+xml</value>
           <text/>
         </choice>
       </attribute>
@@ -452,6 +452,7 @@
       <attribute name="type">
         <choice>
           <value>isni</value>
+          <value>orcid</value>
           <value>uri</value>
         </choice>
       </attribute>
@@ -461,10 +462,7 @@
   <define name="org-identifier">
     <element name="identifier">
       <attribute name="type">
-        <choice>
-          <value>orcid</value>
-          <value>uri</value>
-        </choice>
+        <data type="string" datatypeLibrary=""/>
       </attribute>
       <text/>
     </element>
@@ -1106,7 +1104,7 @@
       <value>complementOf</value>
       <value>obsoletes</value>
       <value>obsoletedBy</value>
-      <value>cited</value>
+      <value>cites</value>
       <value>isCitedIn</value>
     </choice>
   </define>

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)
@@ -61,7 +60,7 @@ module Asciidoctor
           id.content = id_prefix(prefix, id)
       end
 
-      def format_ref(ref, type, isopub)
+      def format_ref(ref, type)
         ref = ref.sub(/ \(All Parts\)/i, "")
         super
       end
@@ -79,6 +78,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 +101,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,14 +147,17 @@ 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
+              <note type="Unpublished-Status">
+              <p>#{@i18n.under_preparation.sub(/%/, id)}</p></note>
+            NOTE
         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
@@ -67,7 +74,7 @@ module Asciidoctor
         stage = get_stage(node)
         substage = get_substage(node)
         xml.status do |s|
-          s.stage stage, **attr_code(abbreviation: stage_abbr(stage, substage, doctype(node)))
+          s.stage stage, **attr_code(abbreviation: cover_stage_abbr(node))
           s.substage substage
           node.attr("iteration") && (s.iteration node.attr("iteration"))
         end
@@ -82,34 +89,37 @@ 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|
+
+        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 +127,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

@@ -11,7 +11,7 @@ module Asciidoctor
     class Converter < Standoc::Converter
       STAGE_ABBRS = {
         "00": "PWI",
-        "10": "NWIP",
+        "10": "NP",
         "20": "WD",
         "30": "CD",
         "40": "DIS",
@@ -37,15 +37,11 @@ module Asciidoctor
         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)
-          ret = "NP" if stage == "10"
-          ret = "AWI" if stage == "10" && substage == "99"
-          ret = "D" if stage == "40" and doctype == "amendment"
-          ret = "FD" if stage == "50" and
-            %w(amendment technical-corrigendum).include?(doctype)
-          ret = "D" if stage == "50" and
-            %w(technical-report technical-specification).include?(doctype)
+          ret = "D" if stage == "40" && doctype == "amendment"
+          ret = "FD" if stage == "50" && %w(amendment technical-corrigendum).include?(doctype)
         end
         ret
       end
@@ -54,8 +50,7 @@ module Asciidoctor
         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
@@ -70,16 +65,13 @@ module Asciidoctor
       end
 
       def iso_id(node, xml)
-        return unless !@amd && node.attr("docnumber") ||
-          @amd && node.attr("updates")
+        return unless !@amd && node.attr("docnumber") || @amd && node.attr("updates")
         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)
@@ -132,18 +124,29 @@ module Asciidoctor
         dn
       end
 
-      def id_stage_abbr(stage, substage, node)
-        ret = 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 amendment
-          technical-corrigendum).include?(doctype(node))
-          ret = ret + " " unless %w(40 50).include?(stage)
+      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)
         end
         ret
       end
 
+      def cover_stage_abbr(node)
+        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
+        "#{abbr}#{typeabbr}".strip
+      end
+
       def id_stage_prefix(dn, node, force_year)
         stage = get_stage(node)
         typeabbr = get_typeabbr(node)
@@ -183,10 +186,12 @@ module Asciidoctor
         node.attr("docsubstage") || ( stage == "60" ? "60" : "00" )
       end
 
-      def get_typeabbr(node)
+      def get_typeabbr(node, amd = false)
         case doctype(node)
         when "technical-report" then "TR "
         when "technical-specification" then "TS "
+        when "amendment" then (amd ? "Amd " : "")
+        when "technical-corrigendum" then (amd ? "Cor " : "")
         else
           nil
         end