metanorma-itu 1.0.12 → 1.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37546876b8125697954fc7ff980c07cf756aae329566249a31c9ea51fa48ec6a
-  data.tar.gz: 5ce41dcc79d10901912a44bbaa7bdb0ed8da9cd1f1bf7a23d5e8d336fbe0f183
+  metadata.gz: b41712042e0f88c1a324ba578c37b2a0f53dc0b4864d33bf659d64c608374526
+  data.tar.gz: 1b3c37954a1e5da6b8bf4f4175befa1c3aeb08e3a27a7934086e0d088b5e131c
 SHA512:
-  metadata.gz: dadba1953785697e5f6f49ec05696b86c3ceeaca9c437dcd6804f8270d6ebc37cab2926ec9a961232ed727af30cca7691a1799c8c8389f4245611684b6fd5d41
-  data.tar.gz: 7b7bd5a5024cbd4b81a4dd52556bd50a0c4583394b97e3b01b159e98338a3c85748e9d238278b9b38a7501b2fff1a64fe7653ead1ff1755f86b11e3625d1b2b8
+  metadata.gz: 932e2f9474e91292595ea30ad42766d1b863829855fb3c66ed0d420784c184a35395258f9549a397a43d05966ad554bae21c241ad9b2f59ef7a3309fe9da6a48
+  data.tar.gz: 7bef0da0c481ee46241f0f5341c05b1028ec715cea0eb716594260ab04eeabd7fa1fbb8962a53c4ef38a383c958043646804deb44e0a779dafb8ccad13ed082e

data/.github/workflows/macos.yml

@@ -6,15 +6,23 @@ on:
   push:
     branches: [ master ]
   pull_request:
+    paths-ignore:
+      - .github/workflows/ubuntu.yml
+      - .github/workflows/windows.yml
 
 jobs:
   test-macos:
     name: Test on Ruby ${{ matrix.ruby }} macOS
     runs-on: macos-latest
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby
@@ -26,13 +34,6 @@ jobs:
         run: |
           sudo gem install bundler --force
           bundle install --jobs 4 --retry 3
-      - name: Use Node
-        uses: actions/setup-node@v1
-        with:
-          node-version: '8'
-      - name: Install Puppeteer
-        run: |
-          npm install -g puppeteer
       - name: Run specs
         run: |
           bundle exec rake

data/.github/workflows/ubuntu.yml

@@ -5,16 +5,26 @@ name: ubuntu
 on:
   push:
     branches: [ master ]
+    tags:
+      - '*'
   pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/windows.yml
 
 jobs:
   test-linux:
     name: Test on Ruby ${{ matrix.ruby }} Ubuntu
     runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby
@@ -26,18 +36,11 @@ jobs:
         run: |
           gem install bundler
           bundle install --jobs 4 --retry 3
-      - name: Use Node
-        uses: actions/setup-node@v1
-        with:
-          node-version: '8'
-      - name: Install Puppeteer
-        run: |
-          npm install -g puppeteer
       - name: Run specs
         run: |
           bundle exec rake
       - name: Trigger dependent repositories
-        if: github.ref == 'refs/heads/master'
+        if: github.ref == 'refs/heads/master' && matrix.ruby == '2.6'
         env:
           GH_USERNAME: ${{ secrets.PAT_USERNAME }}
           GH_ACCESS_TOKEN: ${{ secrets.PAT_TOKEN }}
@@ -46,5 +49,5 @@ jobs:
           [[ -f ".github/workflows/dependent_repos.env" ]] && source .github/workflows/dependent_repos.env
           for repo in $DEPENDENT_REPOS
           do
-            sh trigger-gh-actions.sh $ORGANISATION $repo $GH_USERNAME $GH_ACCESS_TOKEN $GITHUB_REPOSITORY
+            sh trigger-gh-actions.sh $ORGANISATION $repo $GH_USERNAME $GH_ACCESS_TOKEN $GITHUB_REPOSITORY "{ \"ref\": \"${GITHUB_REF}\" }"
           done

data/.github/workflows/windows.yml

@@ -6,15 +6,23 @@ on:
   push:
     branches: [ master ]
   pull_request:
+    paths-ignore:
+      - .github/workflows/macos.yml
+      - .github/workflows/ubuntu.yml
 
 jobs:
   test-windows:
     name: Test on Ruby ${{ matrix.ruby }} Windows
     runs-on: windows-latest
+    continue-on-error: ${{ matrix.experimental }}
     strategy:
       fail-fast: false
       matrix:
         ruby: [ '2.6', '2.5', '2.4' ]
+        experimental: [false]
+        include:
+          - ruby: '2.7'
+            experimental: true
     steps:
       - uses: actions/checkout@master
       - name: Use Ruby
@@ -27,15 +35,7 @@ jobs:
         run: |
           gem install bundler
           bundle config --local path vendor/bundle
-          bundle update
           bundle install --jobs 4 --retry 3
-      - name: Use Node
-        uses: actions/setup-node@v1
-        with:
-          node-version: '8'
-      - name: Install Puppeteer
-        run: |
-          npm install -g puppeteer
       - name: Run specs
         run: |
           bundle exec rake

data/lib/asciidoctor/itu/biblio.rng

@@ -49,11 +49,17 @@
   </define>
   <define name="stage">
     <element name="stage">
+      <optional>
+        <attribute name="abbreviation"/>
+      </optional>
       <text/>
     </element>
   </define>
   <define name="substage">
     <element name="substage">
+      <optional>
+        <attribute name="abbreviation"/>
+      </optional>
       <text/>
     </element>
   </define>
@@ -82,7 +88,7 @@
       <text/>
     </element>
   </define>
-  <define name="LocalizedString">
+  <define name="LocalizedString1">
     <optional>
       <!-- multiple languages and scripts possible: comma delimit them if so -->
       <attribute name="language"/>
@@ -92,6 +98,16 @@
     </optional>
     <text/>
   </define>
+  <define name="LocalizedString">
+    <choice>
+      <ref name="LocalizedString1"/>
+      <oneOrMore>
+        <element name="variant">
+          <ref name="LocalizedString1"/>
+        </element>
+      </oneOrMore>
+    </choice>
+  </define>
   <!--
     Unlike UML, change type to format: type is overloaded
     Would be need if plain were default value and could omit the attribute
@@ -115,7 +131,7 @@
     </optional>
     <ref name="LocalizedStringOrXsAny"/>
   </define>
-  <define name="LocalizedStringOrXsAny">
+  <define name="LocalizedStringOrXsAny1">
     <optional>
       <!-- multiple languages and scripts possible: comma delimit them if so -->
       <attribute name="language"/>
@@ -130,6 +146,16 @@
       </choice>
     </oneOrMore>
   </define>
+  <define name="LocalizedStringOrXsAny">
+    <choice>
+      <ref name="LocalizedStringOrXsAny1"/>
+      <oneOrMore>
+        <element name="variant">
+          <ref name="LocalizedStringOrXsAny1"/>
+        </element>
+      </oneOrMore>
+    </choice>
+  </define>
   <define name="contributor">
     <element name="contributor">
       <zeroOrMore>
@@ -452,9 +478,14 @@
     <attribute name="bibitemid">
       <data type="IDREF"/>
     </attribute>
-    <zeroOrMore>
-      <ref name="locality"/>
-    </zeroOrMore>
+    <choice>
+      <zeroOrMore>
+        <ref name="locality"/>
+      </zeroOrMore>
+      <zeroOrMore>
+        <ref name="localityStack"/>
+      </zeroOrMore>
+    </choice>
     <optional>
       <ref name="date"/>
     </optional>
@@ -469,6 +500,25 @@
       <ref name="BibItemLocality"/>
     </element>
   </define>
+  <define name="localityStack">
+    <element name="localityStack">
+      <zeroOrMore>
+        <ref name="locality"/>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="sourceLocality">
+    <element name="sourceLocality">
+      <ref name="BibItemLocality"/>
+    </element>
+  </define>
+  <define name="sourceLocalityStack">
+    <element name="sourceLocalityStack">
+      <zeroOrMore>
+        <ref name="sourceLocality"/>
+      </zeroOrMore>
+    </element>
+  </define>
   <define name="BibItemLocality">
     <attribute name="type">
       <ref name="LocalityType"/>
@@ -611,9 +661,9 @@
     <optional>
       <ref name="status"/>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="copyright"/>
-    </optional>
+    </zeroOrMore>
     <zeroOrMore>
       <ref name="docrelation"/>
     </zeroOrMore>
@@ -737,6 +787,8 @@
       <value>unchanged</value>
       <value>circulated</value>
       <value>adapted</value>
+      <value>vote-started</value>
+      <value>vote-ended</value>
     </choice>
   </define>
   <define name="bdate">
@@ -969,7 +1021,17 @@
       <optional>
         <ref name="to"/>
       </optional>
-      <ref name="owner"/>
+      <oneOrMore>
+        <ref name="owner"/>
+      </oneOrMore>
+      <optional>
+        <ref name="copyright_scope"/>
+      </optional>
+    </element>
+  </define>
+  <define name="copyright_scope">
+    <element name="scope">
+      <text/>
     </element>
   </define>
   <define name="from">
@@ -989,38 +1051,63 @@
   </define>
   <define name="DocRelationType">
     <choice>
-      <value>obsoletes</value>
-      <value>obsoletedBy</value>
-      <value>supersedes</value>
-      <value>supersededBy</value>
-      <value>updates</value>
-      <value>updatedBy</value>
-      <value>complements</value>
-      <value>derivedFrom</value>
-      <value>translatedFrom</value>
-      <value>hasTranslation</value>
-      <value>adoptedFrom</value>
-      <value>equivalent</value>
-      <value>identical</value>
-      <value>nonequivalent</value>
-      <value>includedIn</value>
       <value>includes</value>
-      <value>instance</value>
-      <value>instanceOf</value>
-      <value>partOf</value>
+      <value>includedIn</value>
       <value>hasPart</value>
-      <value>hasDraft</value>
-      <value>draftOf</value>
+      <value>partOf</value>
       <value>merges</value>
+      <value>mergedInto</value>
       <value>splits</value>
-      <value>amends</value>
-      <value>amendedBy</value>
-      <value>corrects</value>
-      <value>correctedBy</value>
-      <value>revises</value>
-      <value>revisedBy</value>
+      <value>splitInto</value>
+      <value>instance</value>
+      <value>hasInstance</value>
+      <value>exemplarOf</value>
+      <value>hasExemplar</value>
+      <value>manifestationOf</value>
+      <value>hasManifestation</value>
+      <value>reproductionOf</value>
+      <value>hasReproduction</value>
+      <value>reprintOf</value>
+      <value>hasReprint</value>
+      <value>expressionOf</value>
+      <value>hasExpression</value>
+      <value>translatedFrom</value>
+      <value>hasTranslation</value>
+      <value>arrangementOf</value>
+      <value>hasArrangement</value>
+      <value>abridgementOf</value>
+      <value>hasAbridgement</value>
+      <value>annotationOf</value>
+      <value>hasAnnotation</value>
+      <value>draftOf</value>
+      <value>hasDraft</value>
+      <value>editionOf</value>
+      <value>hasEdition</value>
+      <value>updates</value>
+      <value>updatedBy</value>
+      <value>derivedFrom</value>
+      <value>derives</value>
       <value>describes</value>
       <value>describedBy</value>
+      <value>catalogues</value>
+      <value>cataloguedBy</value>
+      <value>hasSuccessor</value>
+      <value>successorOf</value>
+      <value>adaptedFrom</value>
+      <value>hasAdaptation</value>
+      <value>adoptedFrom</value>
+      <value>adoptedAs</value>
+      <value>reviewOf</value>
+      <value>hasReview</value>
+      <value>commentaryOf</value>
+      <value>hasCommentary</value>
+      <value>related</value>
+      <value>complements</value>
+      <value>complementOf</value>
+      <value>obsoletes</value>
+      <value>obsoletedBy</value>
+      <value>cited</value>
+      <value>isCitedIn</value>
     </choice>
   </define>
   <define name="docrelation">
@@ -1028,12 +1115,30 @@
       <attribute name="type">
         <ref name="DocRelationType"/>
       </attribute>
+      <optional>
+        <element name="description">
+          <ref name="FormattedString"/>
+        </element>
+      </optional>
       <element name="bibitem">
         <ref name="BibliographicItem"/>
       </element>
-      <zeroOrMore>
-        <ref name="locality"/>
-      </zeroOrMore>
+      <choice>
+        <zeroOrMore>
+          <ref name="locality"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="localityStack"/>
+        </zeroOrMore>
+      </choice>
+      <choice>
+        <zeroOrMore>
+          <ref name="sourceLocality"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="sourceLocalityStack"/>
+        </zeroOrMore>
+      </choice>
     </element>
   </define>
   <define name="version">

data/lib/asciidoctor/itu/cleanup.rb

@@ -3,9 +3,6 @@ module Asciidoctor
     class Converter < Standoc::Converter
       def sections_cleanup(x)
         super
-        x.xpath("//*[@inline-header]").each do |h|
-          h.delete("inline-header")
-        end
         insert_missing_sections(x) unless @no_insert_missing_sections
       end
 
@@ -43,9 +40,11 @@ module Asciidoctor
           x.at("./*/annex[last()] | ./*/sections").next =
           "<bibliography><sentinel/></bibliography>"
         ins = x.at("//bibliography").elements.first
-        unless x.at("//bibliography/references/title[text() = 'References']")
-          ins.previous = "<references><title>References</title><p>"\
-            "#{@labels['clause_empty']}</p></references>"
+        unless x.at("//bibliography/references[@normative = 'true']")
+          #ins.previous = "<references normative='true'><title>References</title><p>"\
+          #  "#{@labels['clause_empty']}</p></references>"
+          ins.previous = "<references normative='true'><title>References</title>"\
+            "</references>"
         end
         x&.at("//sentinel")&.remove
       end
@@ -62,7 +61,7 @@ module Asciidoctor
         ins =  x.at("//sections/terms") ||
           x.at("//sections/clause[descendant::terms]")
         unless x.at("//sections//definitions")
-          ins.next = "<definitions><title>Definitions</title><p>"\
+          ins.next = "<definitions><title>Abbreviations and acronyms</title><p>"\
             "#{@labels['clause_empty']}</p></definitions>"
         end
       end
@@ -71,44 +70,47 @@ module Asciidoctor
         ins =  x.at("//sections//definitions") ||
           x.at("//sections/clause[descendant::definitions]")
         unless x.at("//sections/clause/title[text() = 'Conventions']")
-          ins.next = "<clause><title>Conventions</title><p>"\
-            "#{@labels['clause_empty']}</p></clause>"
-        end
-      end
+          ins.next = "<clause id='_#{UUIDTools::UUID.random_create}'>"\
+          "<title>Conventions</title><p>"\
+          "#{@labels['clause_empty']}</p></clause>"
+          end
+          end
 
-      def cleanup(xmldoc)
-        symbols_cleanup(xmldoc)
-        super
-      end
+          def cleanup(xmldoc)
+          symbols_cleanup(xmldoc)
+          super
+          obligations_cleanup(xmldoc)
+          xmldoc
+          end
 
-      def smartquotes_cleanup(xmldoc)
-        return super if @smartquotes
-        xmldoc.traverse do |n|
+          def smartquotes_cleanup(xmldoc)
+          return super if @smartquotes
+          xmldoc.traverse do |n|
           next unless n.text?
           n.replace(HTMLEntities.new.encode(
             n.text.gsub(/\u2019|\u2018|\u201a|\u201b/, "'").
             gsub(/\u201c|\u201d|\u201e|\u201f/, '"'), :basic))
-        end
-        xmldoc
-      end
+          end
+          xmldoc
+          end
 
-      def termdef_cleanup(xmldoc)
-        xmldoc.xpath("//term/preferred").each do |p|
+          def termdef_cleanup(xmldoc)
+          xmldoc.xpath("//term/preferred").each do |p|
           if ["terms defined elsewhere",
-              "terms defined in this recommendation"].include? p.text.downcase
-            p.name = "title"
-            p.parent.name = "terms"
+          "terms defined in this recommendation"].include? p.text.downcase
+          p.name = "title"
+          p.parent.name = "terms"
+          end
+          end
+          super
           end
-        end
-        super
-      end
 
-      def termdef_boilerplate_cleanup(xmldoc)
-      end
+          def termdef_boilerplate_cleanup(xmldoc)
+          end
 
-      def symbols_cleanup(xmldoc)
-        sym = xmldoc.at("//definitions/title")
-        sym and sym&.next_element&.name == "dl" and
+          def symbols_cleanup(xmldoc)
+          sym = xmldoc.at("//definitions/title")
+          sym and sym&.next_element&.name == "dl" and
           sym.next = "<p>#{@symbols_boilerplate}</p>"
       end
 
@@ -116,48 +118,55 @@ module Asciidoctor
 
       def pub_class(bib)
         return 1 if bib.at("#{PUBLISHER}[abbreviation = 'ITU']")
-        return 1 if bib.at("#{PUBLISHER}[name = 'International "\
-                           "Telecommunication Union']")
-        return 2 if bib.at("#{PUBLISHER}[abbreviation = 'ISO']")
-        return 2 if bib.at("#{PUBLISHER}[name = 'International Organization "\
-                           "for Standardization']")
-        return 3 if bib.at("#{PUBLISHER}[abbreviation = 'IEC']")
-        return 3 if bib.at("#{PUBLISHER}[name = 'International "\
-                           "Electrotechnical Commission']")
-        return 4 if bib.at("./docidentifier[@type][not(@type = 'DOI' or "\
-                           "@type = 'metanorma' or @type = 'ISSN' or @type = "\
-                           "'ISBN')]")
-        5
-      end
+          return 1 if bib.at("#{PUBLISHER}[name = 'International "\
+                             "Telecommunication Union']")
+          return 2 if bib.at("#{PUBLISHER}[abbreviation = 'ISO']")
+          return 2 if bib.at("#{PUBLISHER}[name = 'International Organization "\
+                             "for Standardization']")
+          return 3 if bib.at("#{PUBLISHER}[abbreviation = 'IEC']")
+          return 3 if bib.at("#{PUBLISHER}[name = 'International "\
+                             "Electrotechnical Commission']")
+          return 4 if bib.at("./docidentifier[@type][not(@type = 'DOI' or "\
+                             "@type = 'metanorma' or @type = 'ISSN' or @type = "\
+                             "'ISBN')]")
+          5
+        end
 
-      def sort_biblio(bib)
-        bib.sort do |a, b|
-          sort_biblio_key(a) <=> sort_biblio_key(b)
+        def sort_biblio(bib)
+          bib.sort do |a, b|
+            sort_biblio_key(a) <=> sort_biblio_key(b)
+          end
         end
-      end
 
-      # sort by: doc class (ITU, ISO, IEC, other standard (not DOI &c), other
-      # then standard class (docid class other than DOI &c)
-      # then alphanumeric doc id (not DOI &c)
-      # then title
-      def sort_biblio_key(bib)
-        pubclass = pub_class(bib)
-        num = bib&.at("./docnumber")&.text
-        id = bib&.at("./docidentifier[not(@type = 'DOI' or @type = "\
-                     "'metanorma' or @type = 'ISSN' or @type = 'ISBN')]")
-        metaid = bib&.at("./docidentifier[@type = 'metanorma']")&.text
-        abbrid = metaid unless /^\[\d+\]$/.match(metaid)
-        type = id['type'] if id
-        title = bib&.at("./title[@type = 'main']")&.text ||
-          bib&.at("./title")&.text || bib&.at("./formattedref")&.text
-        "#{pubclass} :: #{type} :: #{id&.text || metaid} :: #{title}"
-      end
+        # sort by: doc class (ITU, ISO, IEC, other standard (not DOI &c), other
+        # then standard class (docid class other than DOI &c)
+        # then alphanumeric doc id (not DOI &c)
+        # then title
+        def sort_biblio_key(bib)
+          pubclass = pub_class(bib)
+          num = bib&.at("./docnumber")&.text
+          id = bib&.at("./docidentifier[not(@type = 'DOI' or @type = "\
+                       "'metanorma' or @type = 'ISSN' or @type = 'ISBN')]")
+          metaid = bib&.at("./docidentifier[@type = 'metanorma']")&.text
+          abbrid = metaid unless /^\[\d+\]$/.match(metaid)
+          type = id['type'] if id
+          title = bib&.at("./title[@type = 'main']")&.text ||
+            bib&.at("./title")&.text || bib&.at("./formattedref")&.text
+          "#{pubclass} :: #{type} :: #{id&.text || metaid} :: #{title}"
+        end
+
+        def biblio_reorder(xmldoc)
+          xmldoc.xpath("//references").each do |r|
+            biblio_reorder1(r)
+          end
+        end
 
-      def biblio_reorder(xmldoc)
-        xmldoc.xpath("//references").each do |r|
-          biblio_reorder1(r)
+        def normref_cleanup(xmldoc)
+          super
+          r = xmldoc.at(NORM_REF) || return
+          title = r.at("./title") and
+            title.content = "References"
         end
       end
     end
   end
-end