metanorma-itu 1.2.4 → 1.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ba47f749671a89645723abe98c885b11763bc82af7f2ae51dd61bf258c6c020
-  data.tar.gz: d7d9ca77cb3378430bb1c9d93c3027609c2f4154e4387178f394536f505742f0
+  metadata.gz: 4a55d05a3d934a812b372c286512e5fb68669e934fdf564af21ec47695680374
+  data.tar.gz: c4a84f598551512a1dcd029c5af2b765a8ffa133f2d8f88df6e4b2fe04ff6bce
 SHA512:
-  metadata.gz: 1587f02fd05eade3ee88febabfb053f0a295e982bf1285b067d99d81eba1a34c593ee4971ad6e3c909424193a8852ba0f4061ecf4c5c5622416289006f7d1a53
-  data.tar.gz: 85573c130621858588e1f0910a10d99ff874c930acf191b793abaea98c63d17492de7ab95bc402f2dab2ff22844e0763d7d3f69f568e19d173109fde53a71ae2
+  metadata.gz: f5b9e4c6265927997e40bb3178040efde32681cf159a1a33e560b02c0e982b8de2efa5851f161425860e487bb455eeac848c76b14d5823100bd2c5ffd7f8a310
+  data.tar.gz: 2e2b8bab79a9085704a8fab36944fe0670ca37758e156e4fac20e67cb713f7337b0cc13a23042296e28ac313c1152cc6ca48212be033ccfffdfb074fbe30f074

data/.github/workflows/rake.yml

@@ -0,0 +1,62 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main  ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        experimental: [ false ]
+        include:
+          - ruby: '2.7'
+            os: 'ubuntu-latest'
+            experimental: true
+          - ruby: '2.7'
+            os: 'windows-latest'
+            experimental: true
+          - ruby: '2.7'
+            os: 'macos-latest'
+            experimental: true
+    steps:
+      - uses: actions/checkout@master
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - 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
+
+      - run: bundle exec rake
+
+  tests-passed:
+    needs: rake
+    runs-on: ubuntu-latest
+    steps:
+      - name: Trigger tests passed event
+        uses: Sibz/github-status-action@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 }}

data/README.adoc

@@ -1,16 +1,15 @@
 = metanorma-itu: Metanorma for ITU
 
 image:https://img.shields.io/gem/v/metanorma-itu.svg["Gem Version", link="https://rubygems.org/gems/metanorma-itu"]
-image:https://github.com/metanorma/metanorma-itu/workflows/macos/badge.svg["Build Status (macOS)", link="https://github.com/metanorma/metanorma-itu/actions?workflow=macos"]
-image:https://github.com/metanorma/metanorma-itu/workflows/ubuntu/badge.svg["Build Status (ubuntu)", link="https://github.com/metanorma/metanorma-itu/actions?workflow=ubuntu"]
-image:https://github.com/metanorma/metanorma-itu/workflows/windows/badge.svg["Build Status (Windows)", link="https://github.com/metanorma/metanorma-itu/actions?workflow=windows"]
+image:https://github.com/metanorma/metanorma-itu/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-itu/actions?workflow=rake"]
 image:https://codeclimate.com/github/metanorma/metanorma-itu/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-itu"]
 image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-itu.svg["Pull Requests", link="https://github.com/metanorma/metanorma-itu/pulls"]
 image:https://img.shields.io/github/commits-since/metanorma/metanorma-itu/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-itu/releases"]
 
 == Functionality
 
-This gem processes Metanorma input for generating ITU (ITU-T, ITU-D) documents.
+This gem processes https://www.metanorma.com[Metanorma documents] following a template for generating ITU
+standards and documents.
 
 The implementation inherits from https://github.com/metanorma/metanorma-standoc.
 

data/lib/asciidoctor/itu/basicdoc.rng

@@ -596,6 +596,7 @@
       <ref name="bookmark"/>
       <ref name="image"/>
       <ref name="index"/>
+      <ref name="index-xref"/>
     </choice>
   </define>
   <define name="PureTextElement">
@@ -737,6 +738,37 @@
       </optional>
     </element>
   </define>
+  <define name="index-xref">
+    <element name="index-xref">
+      <attribute name="also">
+        <data type="boolean"/>
+      </attribute>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+      <optional>
+        <element name="secondary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="tertiary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
+      </optional>
+      <element name="target">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+    </element>
+  </define>
   <!-- bare ID element, used for referencing arbitrary spans of text -->
   <define name="bookmark">
     <element name="bookmark">

data/lib/asciidoctor/itu/boilerplate.xml

@@ -1,4 +1,6 @@
 <boilerplate>
+  {% if doctype == "Service Publication" %}
+  {% else %}
   <copyright-statement>
     <clause>
       <p>&copy; ITU {{ docyear }}</p>
@@ -40,6 +42,7 @@
     </clause>
     {% endif %}
   </legal-statement>
+  {% endif %}
 </boilerplate>
 
 

data/lib/asciidoctor/itu/converter.rb

@@ -60,8 +60,9 @@ module Asciidoctor
                                      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")
+        node.attr("no-pdf") or
+          pdf_converter(node)&.convert(@filename + ".presentation.xml", 
+                                       nil, false, "#{@filename}.pdf")
       end
 
       def validate(doc)

data/lib/asciidoctor/itu/front.rb

@@ -34,32 +34,34 @@ module Asciidoctor
           type = /^annex/.match(k) ? "annex" : "main"
           xml.title **attr_code(language: lang, format: "text/plain",
                                 type: type) do |t|
-            t << v
+            t << Asciidoctor::Standoc::Utils::asciidoc_sub(v)
           end
         end
       end
 
       def title(node, xml)
         super
-        subtitle_english(node, xml)
-        subtitle_otherlangs(node, xml)
+        %w(subtitle amendment-title corrigendum-title).each do |t|
+        other_title_english(node, xml, t)
+        other_title_otherlangs(node, xml, t)
+        end
       end
 
-      def subtitle_english(node, xml)
-        at = { language: "en", format: "text/plain", type: "subtitle" }
-        a = node.attr("subtitle") || node.attr("subtitle-en")
+      def other_title_english(node, xml, type)
+        at = { language: "en", format: "text/plain", type: type.sub(/-title/, "") }
+        a = node.attr(type) || node.attr("#{type}-en")
         xml.title **attr_code(at) do |t|
           t << Asciidoctor::Standoc::Utils::asciidoc_sub(a)
         end
       end
 
-      def subtitle_otherlangs(node, xml)
+      def other_title_otherlangs(node, xml, type)
         node.attributes.each do |k, v|
-          next unless /^subtitle-(?<lang>.+)$/ =~ k
-          next if lang == "en"
-          xml.title **attr_code(language: lang, format: "text/plain",
-                                type: "subtitle") do |t|
-            t << v
+          next unless m = /^#{type}-(?<lang>.+)$/.match(k)
+          next if m[:lang] == "en"
+          xml.title **attr_code(language: m[:lang], format: "text/plain",
+                                type: type.sub(/-title/, "")) do |t|
+            t << Asciidoctor::Standoc::Utils::asciidoc_sub(v)
           end
         end
       end
@@ -114,6 +116,7 @@ module Asciidoctor
       def metadata_id(node, xml)
         provisional_id(node, xml)
         itu_id(node, xml)
+        recommendation_id(node, xml)
       end
 
       def provisional_id(node, xml)
@@ -123,16 +126,41 @@ module Asciidoctor
         end
       end
 
-      def itu_id(node, xml)
+      ITULANG = {
+        "en" => "E", "fr" => "F", "ar" => "A",
+        "es" => "S", "zh" => "C", "ru" => "R"
+      }.freeze
+
+      def itu_id1(node, lang)
         bureau = node.attr("bureau") || "T"
+        id = if doctype(node) == "service-publication"
+               @i18n.annex_to_itu_ob_abbrev.sub(/%/, node.attr("docnumber"))
+             else
+               "ITU-#{bureau} #{node.attr("docnumber")}"
+             end
+        id + (lang ? "-#{ITULANG[@lang]}" : "")
+      end
+
+      def itu_id(node, xml)
         return unless node.attr("docnumber")
         xml.docidentifier **{type: "ITU"} do |i|
-          i << "ITU-#{bureau} "\
-            "#{node.attr("docnumber")}"
+          i << itu_id1(node, false)
+        end
+        xml.docidentifier **{type: "ITU-lang"} do |i|
+          i << itu_id1(node, true)
         end
         xml.docnumber { |i| i << node.attr("docnumber") }
       end
 
+      def recommendation_id(node, xml)
+        return unless node.attr("recommendationnumber")
+        node.attr("recommendationnumber").split("/").each do |s|
+          xml.docidentifier **{type: "ITU-Recommendation"} do |i|
+            i << s
+          end
+        end
+      end
+
       def metadata_series(node, xml)
         node.attr("series") and
           xml.series **{ type: "main" } do |s|
@@ -171,6 +199,36 @@ module Asciidoctor
           i.bureau node.attr("bureau") || "T"
           i.docnumber node.attr("docnumber")
           a = node.attr("annexid") and i.annexid a
+          a = node.attr("amendment-number") and i.amendment a
+          a = node.attr("corrigendum-number") and i.corrigendum a
+        end
+      end
+
+      # also used in tech paper
+      def metadata_techreport(node, xml)
+        a = node.attr("meeting") and xml.meeting a
+        a = node.attr("meeting-date") and metadata_meeting_date(a, xml)
+        a = node.attr("intended-type") and xml.intended_type a
+        a = node.attr("source") and xml.source a
+      end
+
+      def metadata_meeting_date(a, xml)
+        xml.meeting_date do |m|
+          d = a.split("/")
+          if d.size > 1
+            m.from d[0]
+            m.to d[1]
+          else
+            m.on d[0]
+          end
+        end
+      end
+
+      def personal_role(node, c, suffix)
+        if node.attr("role#{suffix}")&.downcase == "rapporteur"
+          c.role "raporteur", **{ type: "editor" }
+        else
+          super
         end
       end
 
@@ -180,6 +238,7 @@ module Asciidoctor
         metadata_ics(node, xml)
         metadata_recommendationstatus(node, xml)
         metadata_ip_notice(node, xml)
+        metadata_techreport(node, xml)
         structured_id(node, xml)
       end
     end

data/lib/asciidoctor/itu/isodoc.rng

@@ -24,6 +24,14 @@
     <start>
       <ref name="standard-document"/>
     </start>
+    <define name="doctype">
+      <element name="doctype">
+        <optional>
+          <attribute name="abbreviation"/>
+        </optional>
+        <ref name="DocumentType"/>
+      </element>
+    </define>
     <define name="hyperlink">
       <element name="link">
         <attribute name="target">
@@ -42,7 +50,6 @@
     </define>
     <define name="xref">
       <element name="xref">
-        <!-- attribute target { xsd:IDREF }, -->
         <attribute name="target">
           <data type="string">
             <param name="pattern">\i\c*|\c+#\c+</param>
@@ -142,6 +149,11 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="key">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <ref name="dt"/>
           <ref name="dd"/>
@@ -234,6 +246,9 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <ref name="colgroup"/>
+        </optional>
         <optional>
           <ref name="tname"/>
         </optional>
@@ -752,6 +767,18 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="colgroup">
+    <element name="colgroup">
+      <oneOrMore>
+        <ref name="col"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="col">
+    <element name="col">
+      <attribute name="width"/>
+    </element>
+  </define>
   <define name="TextElement" combine="choice">
     <ref name="concept"/>
   </define>
@@ -1165,49 +1192,7 @@
   </define>
   <define name="annex">
     <element name="annex">
-      <optional>
-        <attribute name="id">
-          <data type="ID"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="language"/>
-      </optional>
-      <optional>
-        <attribute name="script"/>
-      </optional>
-      <optional>
-        <attribute name="inline-header">
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <attribute name="obligation">
-        <choice>
-          <value>normative</value>
-          <value>informative</value>
-        </choice>
-      </attribute>
-      <optional>
-        <ref name="section-title"/>
-      </optional>
-      <group>
-        <group>
-          <zeroOrMore>
-            <ref name="BasicBlock"/>
-          </zeroOrMore>
-          <zeroOrMore>
-            <ref name="note"/>
-          </zeroOrMore>
-        </group>
-        <zeroOrMore>
-          <choice>
-            <ref name="annex-subsection"/>
-            <ref name="terms"/>
-            <ref name="definitions"/>
-            <ref name="references"/>
-          </choice>
-        </zeroOrMore>
-      </group>
+      <ref name="Annex-Section"/>
     </element>
   </define>
   <define name="terms">

data/lib/asciidoctor/itu/itu.rng

@@ -41,6 +41,7 @@
         <value>technical-report</value>
         <value>joint-itu-iso-iec</value>
         <value>resolution</value>
+        <value>service-publication</value>
       </choice>
     </define>
     <define name="editorialgroup">
@@ -68,6 +69,16 @@
             <text/>
           </element>
         </optional>
+        <optional>
+          <element name="amendment">
+            <data type="int"/>
+          </element>
+        </optional>
+        <optional>
+          <element name="corrigendum">
+            <data type="int"/>
+          </element>
+        </optional>
       </element>
     </define>
     <define name="BibDataExtensionType">
@@ -84,6 +95,18 @@
       <optional>
         <ref name="ipnoticereceived"/>
       </optional>
+      <optional>
+        <ref name="meeting"/>
+      </optional>
+      <optional>
+        <ref name="meeting-date"/>
+      </optional>
+      <optional>
+        <ref name="intended-type"/>
+      </optional>
+      <optional>
+        <ref name="ext_source"/>
+      </optional>
       <optional>
         <ref name="structuredidentifier"/>
       </optional>
@@ -103,6 +126,44 @@
       </element>
     </define>
   </include>
+  <define name="meeting">
+    <element name="meeting">
+      <text/>
+    </element>
+  </define>
+  <define name="meeting-date">
+    <element name="meeting-date">
+      <choice>
+        <group>
+          <element name="from">
+            <ref name="ISO8601Date"/>
+          </element>
+          <optional>
+            <element name="to">
+              <ref name="ISO8601Date"/>
+            </element>
+          </optional>
+        </group>
+        <element name="on">
+          <ref name="ISO8601Date"/>
+        </element>
+      </choice>
+    </element>
+  </define>
+  <define name="intended-type">
+    <element name="intended-type">
+      <choice>
+        <value>R</value>
+        <value>C</value>
+        <value>TD</value>
+      </choice>
+    </element>
+  </define>
+  <define name="ext_source">
+    <element name="source">
+      <text/>
+    </element>
+  </define>
   <define name="TextElement" combine="choice">
     <choice>
       <ref name="add"/>