metanorma-ietf 2.5.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2d4894fa5f829d7b49228514a64317990ec1747c1f3f327545a919b714aa054
-  data.tar.gz: 7058f5103647d0917da435023afef57236c803413e59b6dab3382e5ab8a84d0f
+  metadata.gz: 6252e62c4528b954e8b212f8f4ecbd2743cf92ce0826851141e9bb5625a33b65
+  data.tar.gz: 54297c4b4d966720210747f55c42f67dbaf8154cb6c4638c7c8714aebf43d032
 SHA512:
-  metadata.gz: cd64d4822df68c4df3338ac56abe2159991ed4065c8eacfb5eb1474a1900410ab732a186883486492538538b8344d60fb2b9090008c673fcae1ac1120c1c3e18
-  data.tar.gz: 73051c3782f02ae2d4ad8f2592f534eb3d2f1abd34620c1bc15c3d8034d51ad1aac2e3d552d11c489ea0f81b940844ea7198d0b598d9a9f1a4a30a4dd2b304b2
+  metadata.gz: 3ba0e479fa11a65a1be98cdf6b18546fc4e633411e94ad8f23fc02492eb027018648abdef26ac81c4f5faed351c70d5871d3446017811c8621c33ba75a5899d8
+  data.tar.gz: 5381ff67f5acd1050032ee09a128e1e466fcae7624d8e3be8d1508ba401a158df4caadea2859f0cbb99ac46d32a41430f1d9f3c9ee145c0e8706cea799f307eb

data/.github/workflows/rake.yml

@@ -8,75 +8,9 @@ on:
     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: [ '3.0', '2.7', '2.6', '2.5' ]
-        os: [ ubuntu-latest, windows-latest, macos-latest ]
-        experimental: [ false ]
-
-    steps:
-      - uses: actions/checkout@master
-
-      - uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-          bundler-cache: true
-
-      - uses: actions/setup-python@v1
-        with:
-          python-version: '3.6'
-
-      - name: set PIP_DOWNLOAD_CACHE
-        shell: python
-        run: |
-          import os
-          import platform
-          from os.path import expanduser
-
-          home = expanduser("~")
-          cache_path = {
-            "Linux": f"{home}/.cache/pip",
-            "Darwin": f"{home}Library/Caches/pip",
-            "Windows": f"{home}\\AppData\\Local\\pip\\Cache"
-          }[platform.system()]
-
-          os.system(f"echo PIP_DOWNLOAD_CACHE={cache_path} >> {os.environ['GITHUB_ENV']}")
-
-      - uses: actions/cache@v2
-        with:
-          path: ${{ env.PIP_DOWNLOAD_CACHE }}
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-          restore-keys: ${{ runner.os }}-pip-
-
-      - uses: actions/cache@v2
-        with:
-          path: ~/.cache/xml2rfc
-          key: xml2rfc
-          restore-keys: xml2rfc
-
-      - if: matrix.os == 'macos-latest'
-        run: brew install libmagic
-
-      - if: matrix.os == 'windows-latest'
-        run: pip install python-magic-bin
-
-      - 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: tests-passed
-          client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'
+    uses: metanorma/metanorma-build-scripts/.github/workflows/xml2rfc-rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.gitignore

@@ -18,3 +18,8 @@
 **/.byebug_history
 
 .rubocop-https--*
+
+/Gemfile.devel
+/Gemfile.lock
+/test.err
+/test.rfc.xml.err

data/lib/isodoc/ietf/references.rb

@@ -62,7 +62,7 @@ module IsoDoc
       def docidentifier_render(bib, out)
         docidentifiers = bib.xpath(ns("./docidentifier"))
         id = render_identifier(bibitem_ref_code(bib))
-        !id[1].nil? && id[1] != "(NO ID)" and out.refcontent id[1]
+        !id[:sdo].nil? && id[:sdo] != "(NO ID)" and out.refcontent id[:sdo]
         docidentifiers&.each do |u|
           u["type"] == "DOI" and
             out.seriesInfo nil, **attr_code(value: u.text.sub(/^DOI /, ""),

data/lib/{asciidoctor → metanorma}/ietf/blocks.rb

@@ -1,6 +1,6 @@
-module Asciidoctor
+module Metanorma
   module Ietf
-    class Converter < ::Asciidoctor::Standoc::Converter
+    class Converter < ::Metanorma::Standoc::Converter
       def para_attrs(node)
         attr_code( "keep-with-next": node.attr("keepWithNext") ||
                   node.attr("keep-with-next"),

data/lib/{asciidoctor → metanorma}/ietf/cleanup.rb

@@ -1,6 +1,6 @@
-module Asciidoctor
+module Metanorma
   module Ietf
-    class Converter < ::Asciidoctor::Standoc::Converter
+    class Converter < ::Metanorma::Standoc::Converter
       def cleanup(xmldoc)
         bcp14_cleanup(xmldoc)
         abstract_cleanup(xmldoc)
@@ -42,19 +42,19 @@ module Asciidoctor
         end
       end
 
-      def rfc_anchor_cleanup(xmldoc)
-        map = xmldoc.xpath("//bibitem[docidentifier/@type = 'rfc-anchor']")
-          .each_with_object({}) do |b, m|
+      def rfc_anchor_cleanup(xml)
+        map = xml.xpath("//bibitem[docidentifier[@type = 'IETF']"\
+                        "[@scope = 'anchor']]").each_with_object({}) do |b, m|
           next if b.at("./ancestor::bibdata | ./ancestor::bibitem")
 
-          id = b.at("./docidentifier[@type = 'rfc-anchor']").text
+          id = b.at("./docidentifier[@type = 'IETF'][@scope = 'anchor']").text
           m[b["id"]] = id
           b["id"] = id
         end
-        xmldoc.xpath("//eref | //origin").each do |x|
+        xml.xpath("//eref | //origin").each do |x|
           map[x["bibitemid"]] and x["bibitemid"] = map[x["bibitemid"]]
         end
-        xmldoc
+        xml
       end
 
       def smartquotes_cleanup(xmldoc)

data/lib/{asciidoctor → metanorma}/ietf/converter.rb

@@ -1,5 +1,5 @@
 require "asciidoctor"
-require "asciidoctor/standoc/converter"
+require "metanorma/standoc/converter"
 require "isodoc/ietf/rfc_convert"
 require_relative "./front"
 require_relative "./blocks"
@@ -7,11 +7,11 @@ require_relative "./validate"
 require_relative "./cleanup"
 require_relative "./macros"
 
-module Asciidoctor
+module Metanorma
   module Ietf
-    class Converter < ::Asciidoctor::Standoc::Converter
+    class Converter < ::Metanorma::Standoc::Converter
       Asciidoctor::Extensions.register do
-        inline_macro Asciidoctor::Ietf::InlineCrefMacro
+        inline_macro Metanorma::Ietf::InlineCrefMacro
       end
 
       XML_ROOT_TAG = "ietf-standard".freeze

data/lib/{asciidoctor → metanorma}/ietf/front.rb

@@ -1,6 +1,6 @@
-module Asciidoctor
+module Metanorma
   module Ietf
-    class Converter < ::Asciidoctor::Standoc::Converter
+    class Converter < ::Metanorma::Standoc::Converter
       def relaton_relations
         %w(included-in described-by derived-from instance obsoletes updates)
       end

data/lib/{asciidoctor → metanorma}/ietf/isodoc.rng

@@ -32,6 +32,19 @@
         <ref name="DocumentType"/>
       </element>
     </define>
+    <define name="bibitem">
+      <element name="bibitem">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="hidden">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <ref name="BibliographicItem"/>
+      </element>
+    </define>
     <define name="section-title">
       <element name="title">
         <zeroOrMore>
@@ -690,6 +703,7 @@
             <ref name="terms"/>
             <ref name="term-clause"/>
             <ref name="definitions"/>
+            <ref name="floating-title"/>
           </choice>
         </oneOrMore>
       </element>
@@ -1680,6 +1694,7 @@
           <ref name="clause-subsection"/>
           <ref name="terms"/>
           <ref name="definitions"/>
+          <ref name="floating-title"/>
         </choice>
       </oneOrMore>
     </choice>
@@ -1722,6 +1737,7 @@
           <ref name="terms"/>
           <ref name="definitions"/>
           <ref name="references"/>
+          <ref name="floating-title"/>
         </choice>
       </zeroOrMore>
     </group>
@@ -1796,6 +1812,20 @@
           <data type="ID"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="language"/>
+      </optional>
+      <optional>
+        <attribute name="script"/>
+      </optional>
+      <optional>
+        <attribute name="tag"/>
+      </optional>
+      <optional>
+        <attribute name="multilingual-rendering">
+          <ref name="MultilingualRenderingType"/>
+        </attribute>
+      </optional>
       <oneOrMore>
         <ref name="preferred"/>
       </oneOrMore>
@@ -1959,7 +1989,11 @@
       </optional>
       <element name="name">
         <zeroOrMore>
-          <ref name="PureTextElement"/>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
+            <ref name="index"/>
+          </choice>
         </zeroOrMore>
       </element>
       <optional>
@@ -1973,7 +2007,7 @@
         </element>
       </optional>
       <optional>
-        <element name="grammar-info">
+        <element name="grammar">
           <ref name="Grammar"/>
         </element>
       </optional>
@@ -2516,4 +2550,17 @@
       </oneOrMore>
     </element>
   </define>
+  <define name="floating-title">
+    <element name="floating-title">
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+      <attribute name="depth">
+        <data type="int"/>
+      </attribute>
+      <zeroOrMore>
+        <ref name="TextElement"/>
+      </zeroOrMore>
+    </element>
+  </define>
 </grammar>

data/lib/{asciidoctor → metanorma}/ietf/macros.rb

@@ -1,6 +1,6 @@
 require "asciidoctor/extensions"
 
-module Asciidoctor
+module Metanorma
   module Ietf
     class InlineCrefMacro < Asciidoctor::Extensions::InlineMacroProcessor
       use_dsl

data/lib/{asciidoctor → metanorma}/ietf/validate.rb

@@ -1,8 +1,8 @@
 require "metanorma/ietf/data/workgroups"
 
-module Asciidoctor
+module Metanorma
   module Ietf
-    class Converter < ::Asciidoctor::Standoc::Converter
+    class Converter < ::Metanorma::Standoc::Converter
       def content_validate(doc)
         super
         image_validate(doc)

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-    VERSION = "2.5.1".freeze
+    VERSION = "3.0.0".freeze
   end
 end

data/lib/metanorma-ietf.rb

@@ -2,7 +2,7 @@ require "asciidoctor" unless defined? Asciidoctor::Converter
 require "metanorma"
 
 require_relative "metanorma/ietf"
-require_relative "asciidoctor/ietf/converter"
+require_relative "metanorma/ietf/converter"
 require_relative "isodoc/ietf/rfc_convert"
 
 Metanorma::Registry.instance.register(Metanorma::Ietf::Processor)

data/metanorma-ietf.gemspec

@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.license       = "BSD-2-Clause"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(bin|test|spec|features)/})
   end
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "mathml2asciimath"
   spec.add_dependency "metanorma-ietf-data"
-  spec.add_dependency "metanorma-standoc", "~> 1.11.0"
+  spec.add_dependency "metanorma-standoc", "~> 2.0.0"
 
   spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ietf
 version: !ruby/object:Gem::Version
-  version: 2.5.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-29 00:00:00.000000000 Z
+date: 2022-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mathml2asciimath
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.11.0
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -235,26 +235,9 @@ files:
 - LICENSE
 - README.adoc
 - Rakefile
-- bin/asciidoctor-rfc2
-- bin/asciidoctor-rfc2.bat
-- bin/asciidoctor-rfc3
-- bin/console
-- bin/rspec
-- bin/setup
 - docs/installation.md
 - docs/navigation.md
 - docs/overview.md
-- lib/asciidoctor/ietf/basicdoc.rng
-- lib/asciidoctor/ietf/biblio.rng
-- lib/asciidoctor/ietf/blocks.rb
-- lib/asciidoctor/ietf/cleanup.rb
-- lib/asciidoctor/ietf/converter.rb
-- lib/asciidoctor/ietf/front.rb
-- lib/asciidoctor/ietf/ietf.rng
-- lib/asciidoctor/ietf/isodoc.rng
-- lib/asciidoctor/ietf/macros.rb
-- lib/asciidoctor/ietf/reqt.rng
-- lib/asciidoctor/ietf/validate.rb
 - lib/isodoc/ietf/SVG-1.2-RFC.rng
 - lib/isodoc/ietf/blocks.rb
 - lib/isodoc/ietf/cleanup.rb
@@ -277,7 +260,18 @@ files:
 - lib/isodoc/ietf/xref.rb
 - lib/metanorma-ietf.rb
 - lib/metanorma/ietf.rb
+- lib/metanorma/ietf/basicdoc.rng
+- lib/metanorma/ietf/biblio.rng
+- lib/metanorma/ietf/blocks.rb
+- lib/metanorma/ietf/cleanup.rb
+- lib/metanorma/ietf/converter.rb
+- lib/metanorma/ietf/front.rb
+- lib/metanorma/ietf/ietf.rng
+- lib/metanorma/ietf/isodoc.rng
+- lib/metanorma/ietf/macros.rb
 - lib/metanorma/ietf/processor.rb
+- lib/metanorma/ietf/reqt.rng
+- lib/metanorma/ietf/validate.rb
 - lib/metanorma/ietf/version.rb
 - metanorma-ietf.gemspec
 - rfc2629-other.ent
@@ -302,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: metanorma-ietf lets you write IETF documents, such as Internet-Drafts and

data/bin/asciidoctor-rfc2

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "metanorma-ietf"
-require "asciidoctor/cli"
-
-options = Asciidoctor::Cli::Options.new backend: "rfc2", header_footer: true
-# FIXME This is a really bizarre API. Please make me simpler.
-
-exit 0 if options.parse!(ARGV) == 0
-
-invoker = Asciidoctor::Cli::Invoker.new options
-GC.start
-invoker.invoke!
-exit invoker.code

data/bin/asciidoctor-rfc2.bat

@@ -1,2 +0,0 @@
-@echo off
-ruby %~dp0\asciidoctor-rfc2 %*

data/bin/asciidoctor-rfc3

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "metanorma-ietf"
-require "asciidoctor/cli"
-
-options = Asciidoctor::Cli::Options.new backend: "rfc3", header_footer: true
-# FIXME This is a really bizarre API. Please make me simpler.
-
-exit 0 if options.parse!(ARGV) == 0
-
-invoker = Asciidoctor::Cli::Invoker.new options
-GC.start
-invoker.invoke!
-exit invoker.code

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "metanorma-ietf"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/rspec

@@ -1,17 +0,0 @@
-#!/usr/bin/env ruby
-
-# This file was generated by Bundler.
-#
-# The application 'rspec' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-require "pathname"
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path(
-  "../../Gemfile", Pathname.new(__FILE__).realpath
-)
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here