metanorma-iso 1.6.1 → 1.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 769601244fc001de9523edde3e6b139a897df0c82a255b786659a83a2e32d8a5
-  data.tar.gz: 1ea613b3740ec30cc508fa5817bed662f3fe539b7bf03e2cf7e40e4ab1e1c8c4
+  metadata.gz: e78f6a52feda554f9e3578e30ffd3af32afe6c771d16414f584ceadd38589b13
+  data.tar.gz: 2da68557d15c9436c6dc310203895e5611c64331b0f038e66590ad4611bdb5db
 SHA512:
-  metadata.gz: 870aaeca24c5e5878441a8346c2dc0d8d8cdd19604c50399c38b8af18bd29a90ab3c0dd8c8d080b977c35efc794bbfbffa4ca233113c3c3a103d90542981ba90
-  data.tar.gz: a6bb8b2d6f598ddf12b8982fa1203165d07f94df83a0f2f7d96eba635834b69e0420e7e46e5cfe86b5ba0283a553106a7941cd06be868032dec6e0179dc1fbb4
+  metadata.gz: f1d80f1af14c5abfd4cc74a0e91dbcc0e4414fd46105ebbd80507871bba8ea788c1e8b09525b8672d85bd4f453d07b5a2b2621a96ebc63270999a2b9989ecbaa
+  data.tar.gz: '09b997180fa6f3c0a1ac2298efda92fc634f5ea1404115c1d65104da739ca278f6a134ee9114ba2b1d53fc4c9415ba6655a7612982479964b5b1bb2c5790a85a'

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

@@ -44,23 +44,23 @@ module Asciidoctor
         @amd = %w(amendment technical-corrigendum).include? doctype(node)
       end
 
-       def ol_attrs(node)
+      def ol_attrs(node)
         attr_code(keep_attrs(node).
-                  merge(id: ::Asciidoctor::Standoc::Utils::anchor_or_uuid(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/basicdoc.rng

@@ -729,9 +729,11 @@
   </define>
   <define name="index">
     <element name="index">
-      <attribute name="to">
-        <data type="IDREF"/>
-      </attribute>
+      <optional>
+        <attribute name="to">
+          <data type="IDREF"/>
+        </attribute>
+      </optional>
       <element name="primary">
         <oneOrMore>
           <ref name="PureTextElement"/>

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

@@ -61,7 +61,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

data/lib/asciidoctor/iso/front.rb

@@ -67,7 +67,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
@@ -85,27 +85,27 @@ module Asciidoctor
       def title_intro(node, t, lang, at)
         return unless node.attr("title-intro-#{lang}")
         t.title(**attr_code(at.merge(type: "title-intro"))) do |t1|
-          t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-intro-#{lang}"))
+          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|
-          t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-main-#{lang}"))
+          t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-main-#{lang}"))
         end
       end
 
       def title_part(node, t, lang, at)
         return unless node.attr("title-part-#{lang}")
         t.title(**attr_code(at.merge(type: "title-part"))) do |t1|
-          t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-part-#{lang}"))
+          t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-part-#{lang}"))
         end
       end
 
       def title_amd(node, t, lang, at)
         return unless node.attr("title-amendment-#{lang}")
         t.title(**attr_code(at.merge(type: "title-amd"))) do |t1|
-          t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-amendment-#{lang}"))
+          t1 << Metanorma::Utils::asciidoc_sub(node.attr("title-amendment-#{lang}"))
         end
       end
 
@@ -118,7 +118,7 @@ module Asciidoctor
         title = "#{title} -- #{part}" if part
         title = "#{title} -- #{amd}" if amd && @amd
         t.title **attr_code(at.merge(type: "main")) do |t1|
-          t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(title)
+          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

data/lib/asciidoctor/iso/isodoc.rng

@@ -102,7 +102,7 @@
           </attribute>
         </optional>
         <oneOrMore>
-          <ref name="li"/>
+          <ref name="ul_li"/>
         </oneOrMore>
         <zeroOrMore>
           <ref name="note"/>
@@ -789,6 +789,9 @@
       <attribute name="width"/>
     </element>
   </define>
+  <define name="BibItemType" combine="choice">
+    <value>internal</value>
+  </define>
   <define name="TextElement" combine="choice">
     <ref name="concept"/>
   </define>
@@ -809,6 +812,8 @@
       <ref name="requirement"/>
       <ref name="recommendation"/>
       <ref name="permission"/>
+      <ref name="imagemap"/>
+      <ref name="svgmap"/>
     </choice>
   </define>
   <define name="bibliography">
@@ -914,6 +919,9 @@
         </choice>
       </attribute>
       <ref name="bibdata"/>
+      <optional>
+        <ref name="misccontainer"/>
+      </optional>
       <optional>
         <ref name="boilerplate"/>
       </optional>
@@ -924,11 +932,21 @@
       <zeroOrMore>
         <ref name="annex"/>
       </zeroOrMore>
+      <optional>
+        <ref name="bibliography"/>
+      </optional>
       <zeroOrMore>
-        <ref name="references"/>
+        <ref name="indexsect"/>
       </zeroOrMore>
     </element>
   </define>
+  <define name="misccontainer">
+    <element name="misc-container">
+      <oneOrMore>
+        <ref name="AnyElement"/>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="preface">
     <element name="preface">
       <oneOrMore>
@@ -952,6 +970,11 @@
       <ref name="Content-Section"/>
     </element>
   </define>
+  <define name="indexsect">
+    <element name="indexsect">
+      <ref name="Content-Section"/>
+    </element>
+  </define>
   <define name="boilerplate">
     <element name="boilerplate">
       <optional>
@@ -1632,4 +1655,87 @@
       <text/>
     </element>
   </define>
+  <define name="imagemap">
+    <element name="imagemap">
+      <ref name="figure"/>
+      <zeroOrMore>
+        <element name="area">
+          <attribute name="type">
+            <choice>
+              <value>rect</value>
+              <value>circle</value>
+              <value>ellipse</value>
+              <value>poly</value>
+            </choice>
+          </attribute>
+          <choice>
+            <ref name="xref"/>
+            <ref name="hyperlink"/>
+            <ref name="eref"/>
+          </choice>
+          <oneOrMore>
+            <element name="coords">
+              <attribute name="x">
+                <data type="float"/>
+              </attribute>
+              <attribute name="y">
+                <data type="float"/>
+              </attribute>
+            </element>
+          </oneOrMore>
+          <optional>
+            <element name="radius">
+              <attribute name="x">
+                <data type="float"/>
+              </attribute>
+              <optional>
+                <attribute name="y">
+                  <data type="float"/>
+                </attribute>
+              </optional>
+            </element>
+          </optional>
+        </element>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="svgmap">
+    <element name="svgmap">
+      <ref name="figure"/>
+      <zeroOrMore>
+        <element name="target">
+          <attribute name="href">
+            <data type="anyURI"/>
+          </attribute>
+          <choice>
+            <ref name="xref"/>
+            <ref name="hyperlink"/>
+            <ref name="eref"/>
+          </choice>
+        </element>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="ul_li">
+    <element name="li">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="uncheckedcheckbox">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="checkedcheckbox">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <oneOrMore>
+        <ref name="BasicBlock"/>
+      </oneOrMore>
+    </element>
+  </define>
 </grammar>