metanorma-ietf 2.2.6 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8247cbf94f350b91d6489fb85f79488a4cdad584badf37d6c82ffa0593aef09c
-  data.tar.gz: ba450b02e8e6209f00bdbc1fbe38c507ed50b03caf0acd1cec0d5de9a15965a1
+  metadata.gz: 762b7326f710d4729e85538a72dcb11fe7f960d995303ef0999c5ff8a665e8d6
+  data.tar.gz: f22daa0309aa18c071492e8b4f74a0d087835a966581af394cc6eba4be933e79
 SHA512:
-  metadata.gz: 994cab64f80f8e1f238c1be2a560cdd576cc76b1fff424af31d0ad5883fa6eecdddde74d54a17bddd8eaeea297d0d601d07654bb2c499bc325f93dcb04b71427
-  data.tar.gz: d691df321718fa175898cf5ce872b5db913b6d256abe8b72af350653f55c632ef6eff2bb0760f5e73af19b11446cb3709ced34e83d9cbf9a500eb25a1afb5cee
+  metadata.gz: 85bff031c15ec990050395691adbdd51ebd67c0cac1dfdc6746e1a21bf7f4547678d268caceb536b69e9013b681d3082a9dc798107396ce1f1cae4329953502b
+  data.tar.gz: f0b5cbde4df5519fcbad880e6b2e441523bf6e53bab819f292f6a588b92baff94fd097734f1398920d4fd4a6709f034433e8053f445d1147459744c8f6bca1d9

data/.github/workflows/rake.yml

@@ -16,17 +16,17 @@ 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
 
@@ -36,21 +36,11 @@ jobs:
       - 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
+          bundler-cache: true
 
       - uses: actions/setup-python@v1
         with:
           python-version: '3.6'
-          architecture: 'x64'
 
       - name: set PIP_DOWNLOAD_CACHE
         shell: python
@@ -89,3 +79,14 @@ jobs:
       - run: pip install xml2rfc
 
       - run: bundle exec rake
+
+  tests-passed:
+    needs: rake
+    runs-on: ubuntu-latest
+    steps:
+      - uses: peter-evans/repository-dispatch@v1
+        with:
+          token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
+          repository: ${{ github.repository }}
+          event-type: notify
+          client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

data/.gitignore

@@ -16,3 +16,5 @@
 .ruby-gemset
 
 **/.byebug_history
+
+.rubocop-https--*

data/.rubocop.yml

@@ -1,15 +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:
-  # Thoughtbot's style guide from: https://github.com/thoughtbot/guides
-  - ".rubocop.tb.yml"
-  # Overrides from Ribose
-  - ".rubocop.ribose.yml"
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+
+# local repo-specific modifications
+
 AllCops:
   DisplayCopNames: false
   StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 Rails:
   Enabled: true

data/lib/asciidoctor/ietf/basicdoc.rng

@@ -729,9 +729,11 @@
   </define>
   <define name="index">
     <element name="index">
-      <attribute name="to">
-        <data type="IDREF"/>
-      </attribute>
+      <optional>
+        <attribute name="to">
+          <data type="IDREF"/>
+        </attribute>
+      </optional>
       <element name="primary">
         <oneOrMore>
           <ref name="PureTextElement"/>

data/lib/asciidoctor/ietf/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/ietf/blocks.rb

@@ -6,17 +6,17 @@ module Asciidoctor
                   node.attr("keep-with-next"),
                   "keep-with-previous": node.attr("keepWithPrevious") ||
                   node.attr("keep-with-previous"),
-                  id: ::Asciidoctor::Standoc::Utils::anchor_or_uuid(node))
+                  id: ::Metanorma::Utils::anchor_or_uuid(node))
       end
 
       def ul_attrs(node)
-        attr_code(id: ::Asciidoctor::Standoc::Utils::anchor_or_uuid(node),
+        attr_code(id: ::Metanorma::Utils::anchor_or_uuid(node),
                   nobullet: node.attr("nobullet"),
                   spacing: node.attr("spacing"))
       end
 
       def ol_attrs(node)
-        attr_code(id: ::Asciidoctor::Standoc::Utils::anchor_or_uuid(node),
+        attr_code(id: ::Metanorma::Utils::anchor_or_uuid(node),
                   type: node.attr("format") || olist_style(node.style),
                   group: node.attr("group"),
                   spacing: node.attr("spacing"),
@@ -24,7 +24,7 @@ module Asciidoctor
       end
 
       def dl_attrs(node)
-        attr_code(id: ::Asciidoctor::Standoc::Utils::anchor_or_uuid(node),
+        attr_code(id: ::Metanorma::Utils::anchor_or_uuid(node),
                   newline: node.attr("newline"),
                   indent: node.attr("indent"),
                   spacing: node.attr("spacing"))
@@ -46,7 +46,7 @@ module Asciidoctor
 
       def note(n)
         noko do |xml|
-          xml.note **attr_code(id: ::Asciidoctor::Standoc::Utils::anchor_or_uuid(n),
+          xml.note **attr_code(id: ::Metanorma::Utils::anchor_or_uuid(n),
                                removeInRFC: n.attr("remove-in-rfc")) do |c|
             n.title.nil? or c.name { |name| name << n.title }
             wrap_in_para(n, c)
@@ -60,7 +60,7 @@ module Asciidoctor
             figure_title(node, f)
             f.pre node.lines.join("\n"),
               **attr_code(align: node.attr("align"),
-                          id: ::Asciidoctor::Standoc::Utils::anchor_or_uuid(nil),
+                          id: ::Metanorma::Utils::anchor_or_uuid(nil),
                           alt: node.attr("alt"))
           end
         end

data/lib/asciidoctor/ietf/converter.rb

@@ -140,6 +140,7 @@ module Asciidoctor
       def rfc_anchor_cleanup(xmldoc)
         map = {}
         xmldoc.xpath("//bibitem[docidentifier/@type = 'rfc-anchor']").each do |b|
+          next if b.at("./ancestor::bibdata")
           map[b["id"]] = b.at("./docidentifier[@type = 'rfc-anchor']").text
           b["id"] = b.at("./docidentifier[@type = 'rfc-anchor']").text
         end
@@ -204,6 +205,25 @@ module Asciidoctor
         end
       end
 
+      def inline_indexterm(node)
+        noko do |xml|
+          node.type == :visible and xml << node.text.sub(/^primary:(?=\S)/, "")
+          terms = (node.attr("terms") || [node.text]).map { |x| xml_encode(x) }
+          if /^primary:\S/.match(terms[0])
+            terms[0].sub!(/^primary:/, "")
+            has_primary = true
+          end
+          xml.index **attr_code(primary: has_primary) do |i|
+            i.primary { |x| x << terms[0] }
+            a = terms.dig(1) and i.secondary { |x| x << a }
+            a = terms.dig(2) and i.tertiary { |x| x << a }
+          end
+        end.join
+      end
+
+      def section_names_refs_cleanup(x)
+      end
+
       def html_extract_attributes(node)
         super.merge(use_xinclude: node.attr("use-xinclude"))
       end

data/lib/asciidoctor/ietf/front.rb

@@ -51,8 +51,8 @@ module Asciidoctor
         ["en"].each do |lang|
           at = { language: lang, format: "text/plain" }
           xml.title **attr_code(at.merge(type: "main")) do |t|
-            t << (::Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title")) ||
-              ::Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-en")) ||
+            t << (::Metanorma::Utils::asciidoc_sub(node.attr("title")) ||
+              ::Metanorma::Utils::asciidoc_sub(node.attr("title-en")) ||
               node.title)
           end
           a = node.attr("abbrev") and

data/lib/asciidoctor/ietf/ietf.rng

@@ -564,6 +564,39 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="index">
+      <element name="index">
+        <optional>
+          <attribute name="to">
+            <data type="IDREF"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="primary">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <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>
+    </define>
   </include>
   <define name="TextElement" combine="choice">
     <ref name="bcp14"/>
@@ -879,6 +912,9 @@
       <zeroOrMore>
         <ref name="termdocsource"/>
       </zeroOrMore>
+      <optional>
+        <ref name="misccontainer"/>
+      </optional>
       <optional>
         <ref name="boilerplate"/>
       </optional>
@@ -890,6 +926,9 @@
         <ref name="annex"/>
       </zeroOrMore>
       <ref name="bibliography"/>
+      <zeroOrMore>
+        <ref name="indexsect"/>
+      </zeroOrMore>
     </element>
   </define>
 </grammar>

data/lib/asciidoctor/ietf/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"/>
@@ -253,6 +282,9 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="width"/>
+        </optional>
         <optional>
           <ref name="colgroup"/>
         </optional>
@@ -772,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">
@@ -786,8 +890,39 @@
       <attribute name="width"/>
     </element>
   </define>
+  <define name="BibItemType" combine="choice">
+    <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">
@@ -806,6 +941,8 @@
       <ref name="requirement"/>
       <ref name="recommendation"/>
       <ref name="permission"/>
+      <ref name="imagemap"/>
+      <ref name="svgmap"/>
     </choice>
   </define>
   <define name="bibliography">
@@ -836,6 +973,9 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -891,9 +1031,11 @@
       <element name="code">
         <text/>
       </element>
-      <element name="text">
-        <text/>
-      </element>
+      <optional>
+        <element name="text">
+          <text/>
+        </element>
+      </optional>
     </element>
   </define>
   <define name="standard-document">
@@ -906,6 +1048,9 @@
         </choice>
       </attribute>
       <ref name="bibdata"/>
+      <optional>
+        <ref name="misccontainer"/>
+      </optional>
       <optional>
         <ref name="boilerplate"/>
       </optional>
@@ -916,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>
@@ -944,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>
@@ -1063,6 +1223,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <attribute name="type"/>
     </optional>
@@ -1116,6 +1279,9 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="number"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1218,6 +1384,9 @@
       <optional>
         <attribute name="type"/>
       </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1546,6 +1715,7 @@
           <value>add</value>
           <value>modify</value>
           <value>delete</value>
+          <value>replace</value>
         </choice>
       </attribute>
       <optional>
@@ -1576,6 +1746,11 @@
       </optional>
       <optional>
         <element name="newcontent">
+          <optional>
+            <attribute name="id">
+              <data type="ID"/>
+            </attribute>
+          </optional>
           <zeroOrMore>
             <ref name="BasicBlock"/>
           </zeroOrMore>
@@ -1609,4 +1784,87 @@
       <text/>
     </element>
   </define>
+  <define name="imagemap">
+    <element name="imagemap">
+      <ref name="figure"/>
+      <zeroOrMore>
+        <element name="area">
+          <attribute name="type">
+            <choice>
+              <value>rect</value>
+              <value>circle</value>
+              <value>ellipse</value>
+              <value>poly</value>
+            </choice>
+          </attribute>
+          <choice>
+            <ref name="xref"/>
+            <ref name="hyperlink"/>
+            <ref name="eref"/>
+          </choice>
+          <oneOrMore>
+            <element name="coords">
+              <attribute name="x">
+                <data type="float"/>
+              </attribute>
+              <attribute name="y">
+                <data type="float"/>
+              </attribute>
+            </element>
+          </oneOrMore>
+          <optional>
+            <element name="radius">
+              <attribute name="x">
+                <data type="float"/>
+              </attribute>
+              <optional>
+                <attribute name="y">
+                  <data type="float"/>
+                </attribute>
+              </optional>
+            </element>
+          </optional>
+        </element>
+      </zeroOrMore>
+    </element>
+  </define>
+  <define name="svgmap">
+    <element name="svgmap">
+      <ref name="figure"/>
+      <zeroOrMore>
+        <element name="target">
+          <attribute name="href">
+            <data type="anyURI"/>
+          </attribute>
+          <choice>
+            <ref name="xref"/>
+            <ref name="hyperlink"/>
+            <ref name="eref"/>
+          </choice>
+        </element>
+      </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>