metanorma-itu 1.2.13 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 340bcccdb9ded5f73eebc8659e51d1dd84c7fb90b9fb8e46982b6f1e6d20e550
-  data.tar.gz: 918ca96ab247a0a7438851f23a4f7a9b0fb39df132387ef3dcb81ee5c14c2beb
+  metadata.gz: ec972a8e77e6d6289ea5deeab70878100d83a19a1a6a50964641f7c5609a4c9e
+  data.tar.gz: 226acd90020445ce770d718c91139664f000d314e1109886e591fcb31852fdfa
 SHA512:
-  metadata.gz: 3ace4c85c4d8b054bb6f071e4244a036dbc3329b951d32c35bec361c352de8c2f9d4fb5120fb36f30567e3e2556002622628d12cc508692072fc762363e8923d
-  data.tar.gz: e721fe79126d50a40035b32c0a9c6250316ae0be45d42381bf61482904c2eac840beca6499695f3604140d5a6243ba04334bf0c8ce9adec2cb7343c8c2f2a17c
+  metadata.gz: 4a2e037212cad45cb12f5f2ced99ddd6b6ef3f552c80c0159a2a3704d8055373033c17fc3146e677b569dd93964b45f1cd7aaf40b7e1bb8c99751c2abdacb36d
+  data.tar.gz: 3c922fc248475914a45d560d1d2dfca5557bbdd2789d4a72fccd41601ba5305ac9dfd3f667ad66b890ad3e5448a21940f1548b0557b6182af9c0071ce892fed1

data/.github/workflows/rake.yml

@@ -4,7 +4,7 @@ name: rake
 
 on:
   push:
-    branches: [ master, main  ]
+    branches: [ master, main ]
     tags: [ v* ]
   pull_request:
 
@@ -16,50 +16,27 @@ 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:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
 
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-
-      - 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
+          bundler-cache: true
 
       - 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/.gitignore

@@ -2,3 +2,5 @@
 .byebug_history
 .rspec_status
 coverage/
+
+.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/itu/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/itu/cleanup.rb

@@ -24,12 +24,12 @@ module Asciidoctor
         end
       end
 
-      def insert_missing_sections(x)
-        insert_scope(x)
-        insert_norm_ref(x)
-        insert_terms(x)
-        insert_symbols(x)
-        insert_conventions(x)
+      def insert_missing_sections(xml)
+        insert_scope(xml)
+        insert_norm_ref(xml)
+        insert_terms(xml)
+        insert_symbols(xml)
+        insert_conventions(xml)
       end
 
       def add_id
@@ -109,8 +109,10 @@ module Asciidoctor
 
       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))
@@ -175,6 +177,7 @@ module Asciidoctor
         return 4 if bib.at("./docidentifier[@type][not(@type = 'DOI' or "\
                            "@type = 'metanorma' or @type = 'ISSN' or @type = "\
                            "'ISBN')]")
+
         5
       end
 

data/lib/asciidoctor/itu/converter.rb

@@ -1,10 +1,9 @@
 require "asciidoctor"
 require "asciidoctor/standoc/converter"
 require "fileutils"
-require_relative "./front.rb"
-require_relative "./validate.rb"
-require_relative "./cleanup.rb"
-require_relative "./macros.rb"
+require_relative "./front"
+require_relative "./validate"
+require_relative "./cleanup"
 
 module Asciidoctor
   module ITU
@@ -17,12 +16,7 @@ module Asciidoctor
 
       register_for "itu"
 
-      Asciidoctor::Extensions.register do
-        inline_macro AddMacro
-        inline_macro DelMacro
-      end
-
-      def title_validate(root)
+      def title_validate(_root)
         nil
       end
 
@@ -94,6 +88,7 @@ module Asciidoctor
           hdr != "terms and definitions" && node.level > 1
         return nil if ret == "symbols and abbreviated terms" && 
           hdr != "symbols and abbreviated terms" && node.level > 1
+
         ret
       end
 
@@ -110,6 +105,7 @@ module Asciidoctor
 
       def metadata_keywords(node, xml)
         return unless node.attr("keywords")
+
         node.attr("keywords").split(/,[ ]*/).sort.each_with_index do |kw, i|
           xml.keyword (i == 0 ? kw.capitalize : kw)
         end
@@ -117,22 +113,24 @@ module Asciidoctor
 
       def clause_parse(attrs, xml, node)
         node.option?("unnumbered") and attrs[:unnumbered] = true
-        case clausetype = sectiontype1(node)
+        case sectiontype1(node)
         when "conventions" then attrs = attrs.merge(type: "conventions")
-        when "history" 
+        when "history"
           attrs[:preface] and attrs = attrs.merge(type: "history")
-        when "source" 
+        when "source"
           attrs[:preface] and attrs = attrs.merge(type: "source")
         end
         super
       end
 
       def html_extract_attributes(node)
-        super.merge(hierarchical_assets: node.attr("hierarchical-object-numbering"))
+        super.merge(hierarchical_assets:
+                    node.attr("hierarchical-object-numbering"))
       end
 
       def doc_extract_attributes(node)
-        super.merge(hierarchical_assets: node.attr("hierarchical-object-numbering"))
+        super.merge(hierarchical_assets:
+                    node.attr("hierarchical-object-numbering"))
       end
 
       def presentation_xml_converter(node)

data/lib/asciidoctor/itu/front.rb

@@ -6,21 +6,24 @@ module Asciidoctor
   module ITU
     class Converter < Standoc::Converter
       def metadata_status(node, xml)
+        stage = (node.attr("status") || node.attr("docstage") || "published")
+        stage = "draft" if node.attributes.has_key?("draft")
         xml.status do |s|
-          s.stage (node.attributes.has_key?("draft") ? "draft" :
-                   (node.attr("status") || node.attr("docstage") || "published" ))
+          s.stage stage
         end
       end
 
+      def title_attr(type, lang = "en")
+        { language: lang, format: "text/plain", type: type }
+      end
+
       def title_english(node, xml)
-        at = { language: "en", format: "text/plain", type: "main" }
         a = node.attr("title") || node.attr("title-en")
-        xml.title **attr_code(at) do |t|
+        xml.title **attr_code(title_attr("main")) do |t|
           t << (Metanorma::Utils::asciidoc_sub(a) || node.title)
         end
         if a = node.attr("annextitle") || node.attr("annextitle-en")
-          at[:type] = "annex"
-          xml.title **attr_code(at) do |t|
+          xml.title **attr_code(title_attr("annex")) do |t|
             t << Metanorma::Utils::asciidoc_sub(a)
           end
         end
@@ -30,8 +33,9 @@ module Asciidoctor
         node.attributes.each do |k, v|
           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|
+
+          type = /^annex/.match?(k) ? "annex" : "main"
+          xml.title **attr_code(title_attr(type, lang)) do |t|
             t << Metanorma::Utils::asciidoc_sub(v)
           end
         end
@@ -40,15 +44,14 @@ module Asciidoctor
       def title(node, xml)
         super
         %w(subtitle amendment-title corrigendum-title).each do |t|
-        other_title_english(node, xml, t)
-        other_title_otherlangs(node, xml, t)
+          other_title_english(node, xml, t)
+          other_title_otherlangs(node, xml, t)
         end
       end
 
       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|
+        xml.title **attr_code(title_attr(type.sub(/-title/, ""))) do |t|
           t << Metanorma::Utils::asciidoc_sub(a)
         end
       end
@@ -57,8 +60,9 @@ module Asciidoctor
         node.attributes.each do |k, 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|
+
+          xml.title **attr_code(title_attr(type.sub(/-title/, ""),
+                                           m[:lang])) do |t|
             t << Metanorma::Utils::asciidoc_sub(v)
           end
         end
@@ -79,7 +83,7 @@ module Asciidoctor
 
       def metadata_committee1(node, xml, suffix)
         xml.editorialgroup do |a|
-          a.bureau ( node.attr("bureau#{suffix}") || "T" )
+          a.bureau ( node.attr("bureau#{suffix}") || "T")
           if node.attr("group#{suffix}")
             a.group **attr_code(type: node.attr("grouptype#{suffix}")) do |g|
               metadata_committee2(node, g, suffix, "")
@@ -119,27 +123,30 @@ module Asciidoctor
 
       def provisional_id(node, xml)
         return unless node.attr("provisional-name")
-        xml.docidentifier **{type: "ITU-provisional"} do |i|
+
+        xml.docidentifier **{ type: "ITU-provisional" } do |i|
           i << node.attr("provisional-name")
         end
       end
 
-      ITULANG = { "en" => "E", "fr" => "F", "ar" => "A", "es" => "S", "zh" => "C", "ru" => "R" }.freeze
+      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")}"
+          "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|
+
+        xml.docidentifier **{ type: "ITU" } do |i|
           i << itu_id1(node, false)
         end
-        xml.docidentifier **{type: "ITU-lang"} do |i|
+        xml.docidentifier **{ type: "ITU-lang" } do |i|
           i << itu_id1(node, true)
         end
         xml.docnumber { |i| i << node.attr("docnumber") }
@@ -147,8 +154,9 @@ module Asciidoctor
 
       def recommendation_id(node, xml)
         return unless node.attr("recommendationnumber")
+
         node.attr("recommendationnumber").split("/").each do |s|
-          xml.docidentifier **{type: "ITU-Recommendation"} do |i|
+          xml.docidentifier **{ type: "ITU-Recommendation" } do |i|
             i << s
           end
         end
@@ -171,11 +179,12 @@ module Asciidoctor
 
       def metadata_recommendationstatus(node, xml)
         return unless node.attr("recommendation-from")
+
         xml.recommendationstatus do |s|
           s.from node.attr("recommendation-from")
           s.to node.attr("recommendation-to") if node.attr("recommendation-to")
           if node.attr("approval-process")
-            s.approvalstage **{process: node.attr("approval-process")} do |a|
+            s.approvalstage **{ process: node.attr("approval-process") } do |a|
               a << node.attr("approval-status")
             end
           end
@@ -188,6 +197,7 @@ module Asciidoctor
 
       def structured_id(node, xml)
         return unless node.attr("docnumber")
+
         xml.structuredidentifier do |i|
           i.bureau node.attr("bureau") || "T"
           i.docnumber node.attr("docnumber")
@@ -198,7 +208,8 @@ module Asciidoctor
       end
 
       def metadata_techreport(node, xml)
-        a = node.attr("meeting") and metadata_meeting(a, node.attr("meeting-acronym"), xml)
+        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
@@ -233,6 +244,7 @@ module Asciidoctor
 
       def metadata_ext(node, xml)
         metadata_doctype(node, xml)
+        metadata_subdoctype(node, xml)
         metadata_committee(node, xml)
         metadata_ics(node, xml)
         metadata_recommendationstatus(node, xml)

data/lib/asciidoctor/itu/isodoc.rng

@@ -86,6 +86,35 @@
         <text/>
       </element>
     </define>
+    <define name="erefType">
+      <optional>
+        <attribute name="normative">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <attribute name="citeas"/>
+      <attribute name="type">
+        <ref name="ReferenceFormat"/>
+      </attribute>
+      <optional>
+        <attribute name="alt"/>
+      </optional>
+      <optional>
+        <attribute name="case">
+          <choice>
+            <value>capital</value>
+            <value>lowercase</value>
+          </choice>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="droploc">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <ref name="CitationType"/>
+      <text/>
+    </define>
     <define name="ul">
       <element name="ul">
         <attribute name="id">
@@ -102,7 +131,7 @@
           </attribute>
         </optional>
         <oneOrMore>
-          <ref name="li"/>
+          <ref name="ul_li"/>
         </oneOrMore>
         <zeroOrMore>
           <ref name="note"/>
@@ -775,6 +804,78 @@
         <ref name="paragraph"/>
       </element>
     </define>
+    <define name="em">
+      <element name="em">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="strong">
+      <element name="strong">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="tt">
+      <element name="tt">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="keyword">
+      <element name="keyword">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="strike">
+      <element name="strike">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="underline">
+      <element name="underline">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="smallcap">
+      <element name="smallcap">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="index"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
   </include>
   <!-- end overrides -->
   <define name="colgroup">
@@ -793,7 +894,35 @@
     <value>internal</value>
   </define>
   <define name="TextElement" combine="choice">
-    <ref name="concept"/>
+    <choice>
+      <ref name="concept"/>
+      <ref name="add"/>
+      <ref name="del"/>
+    </choice>
+  </define>
+  <define name="add">
+    <element name="add">
+      <choice>
+        <ref name="PureTextElement"/>
+        <ref name="eref"/>
+        <ref name="stem"/>
+        <ref name="keyword"/>
+        <ref name="xref"/>
+        <ref name="hyperlink"/>
+      </choice>
+    </element>
+  </define>
+  <define name="del">
+    <element name="del">
+      <choice>
+        <ref name="PureTextElement"/>
+        <ref name="eref"/>
+        <ref name="stem"/>
+        <ref name="keyword"/>
+        <ref name="xref"/>
+        <ref name="hyperlink"/>
+      </choice>
+    </element>
   </define>
   <define name="concept">
     <element name="concept">
@@ -919,6 +1048,9 @@
         </choice>
       </attribute>
       <ref name="bibdata"/>
+      <optional>
+        <ref name="misccontainer"/>
+      </optional>
       <optional>
         <ref name="boilerplate"/>
       </optional>
@@ -929,11 +1061,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>
@@ -957,6 +1099,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>
@@ -1698,4 +1845,26 @@
       </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>