metanorma-itu 1.2.5 → 1.2.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f1f27889137eea1b004bc4eee71e47ddbead47e0fbc4674f539189644763b66
-  data.tar.gz: 88e33a92e6d6b0d0c3742a0a52df0129e0a45282af82ce97c92155a0394b50f0
+  metadata.gz: 7a5e5576a553c84c8a975e21c6f7187fb3d959486fb82da54caa4bae59bc70e4
+  data.tar.gz: 06e43014128a730fe43d6e602a6a1c83280d09043c458620ecf7c3488e8d29c6
 SHA512:
-  metadata.gz: 77ba3c458e943abb302d525427785149c4b782d4e76fab935366a0ce02f643c98f9332c8273bb29018d68b9817d569d2e036ee6040421c1325939e187d934e34
-  data.tar.gz: 03f051e1d762172800e50bd22cfece8feb04717bfd77a918411b1c22217ebbe3c7522709f923efacc5b8c4ceb922a4378ecb4db7af98a583526db07368c844f4
+  metadata.gz: ec9c3c73670e489535e88bb5abed0956a53dcc692d6fbb95b11507b085f3e8e01342be19fd4ee7ab3d55a11d08fe8566cb643670af29e1ef72979f3653f5b5f0
+  data.tar.gz: b2996860abd9e0354985b288a2c562b19d8456c0b7b6d4afcdb208f4c29d9efbabc559eb266dcc879fd23569a0fa3542335384d9f7d91567d7de830a6f0ad54a

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">
@@ -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,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/front.rb

@@ -116,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)
@@ -125,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|
@@ -178,12 +204,41 @@ module Asciidoctor
         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
+
       def metadata_ext(node, xml)
         metadata_doctype(node, xml)
         metadata_committee(node, xml)
         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">
@@ -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,9 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <ref name="colgroup"/>
+        </optional>
         <optional>
           <ref name="tname"/>
         </optional>
@@ -751,6 +774,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>
@@ -1164,49 +1199,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">

data/lib/asciidoctor/itu/validate.rb

@@ -11,7 +11,7 @@ module Asciidoctor
         %w(recommendation recommendation-supplement recommendation-amendment 
         recommendation-corrigendum recommendation-errata recommendation-annex 
         focus-group implementers-guide technical-paper technical-report 
-        joint-itu-iso-iec).include? doctype or
+        joint-itu-iso-iec service-publication).include? doctype or
         @log.add("Document Attributes", nil, 
                  "#{doctype} is not a recognised document type")
       end
@@ -67,15 +67,8 @@ module Asciidoctor
       end
 
       # Editing Guidelines 9.4.3
+      # Supplanted by rendering
       def numbers_validate(xmldoc)
-        xmldoc.xpath("//clause | //preface/* | //annex").each do |x|
-          xx = x.dup
-          xx.xpath("./clause").each { |c| c.remove }
-          style_two_regex_not_prev(x, extract_text(xx),
-                                   /^(?<num>-?[0-9][0-9,. ]{3,})$/,
-                                   %r{(\bISO|\bIEC|\bIEEE/)$},
-                                   "number not broken up in threes by apostrophe")
-        end
       end
 
       def style_two_regex_not_prev(n, text, re, re_prev, warning)

data/lib/isodoc/itu/base_convert.rb

@@ -23,12 +23,6 @@ module IsoDoc
         end
       end
 
-      def bracket_opt(b)
-        return b if b.nil?
-        return b if /^\[.+\]$/.match(b)
-        "[#{b}]"
-      end
-
       def clausedelim
         ""
       end
@@ -133,6 +127,7 @@ module IsoDoc
 
       def info(isoxml, out)
         @meta.ip_notice_received isoxml, out
+        @meta.techreport isoxml, out
         super
       end