metanorma-itu 1.2.6 → 1.2.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb287ff921a50fb1e0bc7f1c6e6508d96ed8850e973d0dc1da25720fa0e3856f
-  data.tar.gz: 55782324626afcec59caf220ae8129d0b9bf3acc66197b95146b909cba834590
+  metadata.gz: ebf36f8725648a2e24bf148c5b6eca7227892eb9f91a18cc7f274a62981db6e2
+  data.tar.gz: c4e7229799f091ce3cf6ac21e2fbb202d39e7bf57d1f72e0e74c726f7fb0441e
 SHA512:
-  metadata.gz: 1ffb8747c3b8c3574393a27a1186842a0528840c2d02dc77a1154296db777d98ffbe31072833f08aa8802c39b0e2731cdbd10459ec68ddb0ca4467a341f3303b
-  data.tar.gz: 5c9519836a9c530132183ff18870764ffa97a6f88c36691cf554d423b1bd23f65ff4bc506fb4dcbe9a90198104b87b7e9ba70e25aae4759ecee9a4510748efb2
+  metadata.gz: 924c0c3a471675ad01f3b52dd1e28192cff5a5124b1808f867417a96d28ee6357268820ab00301f6710752afec711d256909b5bac24a714d77ff951129b6ca62
+  data.tar.gz: 6da337d4917c9f6d537636540ba5ea8569a3d410100261ca79beb3f1082438db50af7cd33a1065b08fb8a0226b2d4fb814c4fc94bc615721b68c0e2826f7c19c

data/.github/workflows/rake.yml

@@ -4,7 +4,8 @@ name: rake
 
 on:
   push:
-    branches: [ master ]
+    branches: [ master, main  ]
+    tags: [ v* ]
   pull_request:
 
 jobs:
@@ -31,14 +32,34 @@ jobs:
     steps:
       - uses: actions/checkout@master
 
-      - name: Use Ruby
-        uses: ruby/setup-ruby@v1
+      - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
 
-      - name: Update gems
-        run: bundle install --jobs 4 --retry 3
+      - if: matrix.os == 'macos-latest'
+        run: brew install autoconf automake libtool
 
-      - name: Run specs
-        run: bundle exec rake
+      - 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">
@@ -728,15 +729,61 @@
   </define>
   <define name="index">
     <element name="index">
-      <attribute name="primary"/>
+      <attribute name="to">
+        <data type="IDREF"/>
+      </attribute>
+      <element name="primary">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
       <optional>
-        <attribute name="secondary"/>
+        <element name="secondary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
       </optional>
       <optional>
-        <attribute name="tertiary"/>
+        <element name="tertiary">
+          <oneOrMore>
+            <ref name="PureTextElement"/>
+          </oneOrMore>
+        </element>
       </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,10 +1,13 @@
 <boilerplate>
+  {% if doctype == "Service Publication" %}
+  {% else %}
   <copyright-statement>
     <clause>
-      <p>&copy; ITU {{ docyear }}</p>
+      <p>&#xa9; ITU {{ docyear }}</p>
 <p>All rights reserved. No part of this publication may be reproduced, by any means whatsoever, without the prior written permission of ITU.</p>
     </clause>
   </copyright-statement>
+  {% if doctype == "Recommendation" %}
   <license-statement>
     <clause>
       <title>INTELLECTUAL PROPERTY RIGHTS</title>
@@ -13,6 +16,7 @@
 </p>
 </clause>
 </license-statement>
+{% endif %}
   <legal-statement>
     <clause>
       <title>FOREWORD</title>
@@ -21,12 +25,13 @@
 <p>The approval of ITU-T Recommendations is covered by the procedure laid down in WTSA Resolution 1 .</p>
 <p>In some areas of information technology which fall within ITU-T's purview, the necessary standards are prepared on a collaborative basis with ISO and IEC.</p>
 
-
+{% if doctype == "Recommendation" %}
 <clause>
 <title>NOTE</title>
 <p>In this Recommendation, the expression "Administration" is used for conciseness to indicate both a telecommunication administration and a recognized operating agency .</p>
 <p>Compliance with this Recommendation is voluntary. However, the Recommendation may contain certain mandatory provisions (to ensure, e.g., interoperability or applicability) and compliance with the Recommendation is achieved when all of these mandatory provisions are met. The words "shall" or some other obligatory language such as "must" and the negative equivalents are used to express requirements. The use of such words does not suggest that compliance with the Recommendation is required of any party .</p>
 </clause>
+{% endif %}
     </clause>
 
     {% if unpublished %}
@@ -40,6 +45,7 @@
     </clause>
     {% endif %}
   </legal-statement>
+  {% endif %}
 </boilerplate>
 
 

data/lib/asciidoctor/itu/cleanup.rb

@@ -5,6 +5,15 @@ module Asciidoctor
         super
         insert_missing_sections(x) unless @no_insert_missing_sections
         insert_empty_clauses(x)
+        resolution_inline_header(x)
+      end
+
+      def resolution_inline_header(x)
+        return unless x&.at("//bibdata/ext/doctype")&.text == "resolution"
+        x.xpath("//clause//clause").each do |c|
+          next if title = c.at("./title") and !title&.text&.empty?
+          c["inline-header"] = true
+        end
       end
 
       def table_cleanup(xmldoc)

data/lib/asciidoctor/itu/converter.rb

@@ -116,6 +116,7 @@ module Asciidoctor
       end
 
       def clause_parse(attrs, xml, node)
+        node.option?("unnumbered") and attrs[:unnumbered] = true
         case clausetype = sectiontype1(node)
         when "conventions" then attrs = attrs.merge(type: "conventions")
         when "history" 

data/lib/asciidoctor/itu/front.rb

@@ -8,8 +8,7 @@ module Asciidoctor
       def metadata_status(node, xml)
         xml.status do |s|
           s.stage (node.attributes.has_key?("draft") ? "draft" :
-                   (node.attr("status") || node.attr("docstage") ||
-                    "published" ))
+                   (node.attr("status") || node.attr("docstage") || "published" ))
         end
       end
 
@@ -32,8 +31,7 @@ module Asciidoctor
           next unless /^(annex)?title-(?<lang>.+)$/ =~ k
           next if lang == "en"
           type = /^annex/.match(k) ? "annex" : "main"
-          xml.title **attr_code(language: lang, format: "text/plain",
-                                type: type) do |t|
+          xml.title **attr_code(language: lang, format: "text/plain", type: type) do |t|
             t << Asciidoctor::Standoc::Utils::asciidoc_sub(v)
           end
         end
@@ -116,6 +114,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)
@@ -125,16 +124,36 @@ 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 = doctype(node) == "service-publication" ?
+          @i18n.annex_to_itu_ob_abbrev.sub(/%/, node.attr("docnumber")) :
+          "ITU-#{bureau} #{node.attr("docnumber")}"
+        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|
@@ -179,12 +198,19 @@ module Asciidoctor
       end
 
       def metadata_techreport(node, xml)
-        a = node.attr("meeting") and xml.meeting a
+        a = node.attr("meeting") and metadata_meeting(a, node.attr("meeting-acronym"), xml)
+        a = node.attr("meeting-place") and xml.meeting_place 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(mtg, acronym, xml)
+        xml.meeting **attr_code(acronym: acronym) do |m|
+          m << mtg
+        end
+      end
+
       def metadata_meeting_date(a, xml)
         xml.meeting_date do |m|
           d = a.split("/")
@@ -197,6 +223,14 @@ module Asciidoctor
         end
       end
 
+      def personal_role(node, c, suffix)
+        if node.attr("role#{suffix}")&.downcase == "rapporteur"
+          c.role "raporteur", **{ type: "editor" }
+        else
+          super
+        end
+      end
+
       def metadata_ext(node, xml)
         metadata_doctype(node, xml)
         metadata_committee(node, xml)

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">
@@ -47,6 +55,13 @@
             <param name="pattern">\i\c*|\c+#\c+</param>
           </data>
         </attribute>
+        <optional>
+          <attribute name="to">
+            <data type="string">
+              <param name="pattern">\i\c*|\c+#\c+</param>
+            </data>
+          </attribute>
+        </optional>
         <optional>
           <attribute name="type">
             <ref name="ReferenceFormat"/>
@@ -141,6 +156,11 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="key">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <ref name="dt"/>
           <ref name="dd"/>
@@ -233,6 +253,12 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="width"/>
+        </optional>
+        <optional>
+          <ref name="colgroup"/>
+        </optional>
         <optional>
           <ref name="tname"/>
         </optional>
@@ -751,6 +777,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>
@@ -801,6 +839,9 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -856,9 +897,11 @@
       <element name="code">
         <text/>
       </element>
-      <element name="text">
-        <text/>
-      </element>
+      <optional>
+        <element name="text">
+          <text/>
+        </element>
+      </optional>
     </element>
   </define>
   <define name="standard-document">
@@ -1028,6 +1071,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <attribute name="type"/>
     </optional>
@@ -1081,6 +1127,9 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1183,6 +1232,9 @@
       <optional>
         <attribute name="type"/>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1511,6 +1563,7 @@
           <value>add</value>
           <value>modify</value>
           <value>delete</value>
+          <value>replace</value>
         </choice>
       </attribute>
       <optional>
@@ -1541,6 +1594,11 @@
       </optional>
       <optional>
         <element name="newcontent">
+          <optional>
+            <attribute name="id">
+              <data type="ID"/>
+            </attribute>
+          </optional>
           <zeroOrMore>
             <ref name="BasicBlock"/>
           </zeroOrMore>