metanorma-ietf 2.2.4 → 2.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f06324c3b9c916155d7de089ca675e524498efdcd6c07ff824f94b57ab6964c6
-  data.tar.gz: 51bfdd81d038f103e94bc9d5be4f6954d6bc6fbc691972f4b7f3001cd7ca9a2d
+  metadata.gz: 3753bf3629ba6b3dbe10ef6f2dd1086eaff21428be99dcfd4d790cf300812b74
+  data.tar.gz: b6ea9b53ecf08906ae978fdad57e1cdc21c0f34c4e6891203fd7ac406cf83bcb
 SHA512:
-  metadata.gz: 45fc197eeaeb201677a069bd7ce3037a8d0bb28aacb49678a723bf7628cde25792aca668ddcff291f5932194f906e4bcbe12af342891da9ec5e36963c0cde2e6
-  data.tar.gz: a1752e87e7185ef20c56f58b1d1f568617bfecab5c7295a48e67b22d27afd5eb9b9de470edb0b712423991803887a714a834111af0ba03f1fabc62a6219e8c7c
+  metadata.gz: 842e23d7fc1f0f5bc2ad809b70b527531ef05ae17fbdacb20d43dae5e98bcb14b983c3120177b36d0c5709e04ee104cafc85b2eb350f93bc6a7d73ea6a243ab9
+  data.tar.gz: 03efa75db6f4e55dd3417d8cd651b9d52508dbc760314b763fc3f71d4acddb5a731ddc9097661ff94cdbd46b2fd8bc4ac4f52f9af6c69da7e2893df18cd63c5b

data/.github/workflows/rake.yml

@@ -4,7 +4,8 @@ name: rake
 
 on:
   push:
-    branches: [ master ]
+    branches: [ master, main ]
+    tags: [ v* ]
   pull_request:
 
 jobs:
@@ -31,26 +32,22 @@ jobs:
 
     steps:
       - uses: actions/checkout@master
-      - name: Cache xml2rfc
-        id: cache-xml2rfc
-        uses: actions/cache@v1
-        with:
-          path: ~/.cache/xml2rfc
-          key: xml2rfc
-          restore-key: xml2rfc
 
-      - 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
+      - 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'
 
-      - name: Use Python
-        uses: actions/setup-python@v1
+      - run: bundle install --jobs 4 --retry 3
+
+      - uses: actions/setup-python@v1
         with:
           python-version: '3.6'
           architecture: 'x64'
@@ -58,6 +55,7 @@ jobs:
       - name: set PIP_DOWNLOAD_CACHE
         shell: python
         run: |
+          import os
           import platform
           from os.path import expanduser
 
@@ -65,10 +63,10 @@ jobs:
           cache_path = {
             "Linux": f"{home}/.cache/pip",
             "Darwin": f"{home}Library/Caches/pip",
-            "Windows": f"{home}/AppData/Local/pip/Cache"
-          }
+            "Windows": f"{home}\\AppData\\Local\\pip\\Cache"
+          }[platform.system()]
 
-          print(f"::set-env name=PIP_DOWNLOAD_CACHE::{cache_path[platform.system()]}")
+          os.system(f"echo PIP_DOWNLOAD_CACHE={cache_path} >> {os.environ['GITHUB_ENV']}")
 
       - uses: actions/cache@v2
         with:
@@ -76,17 +74,18 @@ jobs:
           key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
           restore-keys: ${{ runner.os }}-pip-
 
-      - name: Install xml2rfc's deps macOS
-        if: matrix.os == 'macos-latest'
+      - uses: actions/cache@v2
+        with:
+          path: ~/.cache/xml2rfc
+          key: xml2rfc
+          restore-key: xml2rfc
+
+      - if: matrix.os == 'macos-latest'
         run: brew install libmagic
 
-      - name: Install xml2rfc's deps Windows
-        if: matrix.os == 'windows-latest'
+      - if: matrix.os == 'windows-latest'
         run: pip install python-magic-bin
 
-      - name: Install xml2rfc
-        run: pip install xml2rfc
+      - run: pip install xml2rfc
 
-      - name: Run specs
-        run: |
-          bundle exec rake
+      - run: bundle exec rake

data/README.adoc

@@ -2,26 +2,21 @@
 :source-highlighter: coderay
 :icons: font
 
-`metanorma-ietf` lets you write Internet-Drafts and RFCs in AsciiDoc, the
-"`http://asciidoctor.org/[asciidoctor]-way`".
+`metanorma-ietf` lets you write IETF Internet-Drafts and RFCs via Metanorma.
 
 image:https://img.shields.io/gem/v/metanorma-ietf.svg["Gem Version", link="https://rubygems.org/gems/metanorma-ietf"]
-image:https://github.com/metanorma/metanorma-ietf/workflows/macos/badge.svg["Build Status (macOS)", link="https://github.com/metanorma/metanorma-ietf/actions?workflow=macos"]
-image:https://github.com/metanorma/metanorma-ietf/workflows/ubuntu/badge.svg["Build Status (ubuntu)", link="https://github.com/metanorma/metanorma-ietf/actions?workflow=ubuntu"]
-image:https://github.com/metanorma/metanorma-ietf/workflows/windows/badge.svg["Build Status (Windows)", link="https://github.com/metanorma/metanorma-ietf/actions?workflow=windows"]
+image:https://github.com/metanorma/metanorma-ietf/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-ietf/actions?workflow=rake"]
 image:https://codeclimate.com/github/metanorma/metanorma-ietf/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/metanorma-ietf"]
 image:https://img.shields.io/github/issues-pr-raw/metanorma/metanorma-ietf.svg["Pull Requests", link="https://github.com/metanorma/metanorma-ietf/pulls"]
 image:https://img.shields.io/github/commits-since/metanorma/metanorma-ietf/latest.svg["Commits since latest",link="https://github.com/metanorma/metanorma-ietf/releases"]
 
-_Formerly known as_ `asciidoctor-rfc`.
-
-
 == Functionality
 
-This gem processes http://asciidoctor.org/[Asciidoctor] documents following
-a template for generating IETF International Standards.
+This gem processes https://www.metanorma.com[Metanorma documents] following
+a template for generating IETF deliverables.
 
-This AsciiDoc syntax for writing IETF standards is called "`AsciiRFC`".
+Metanorma-IETF adheres to AsciiRFC syntax, an AsciiDoc syntax for writing IETF documents
+developed by the Metanorma team.
 
 The gem currently inherits from the https://github.com/metanorma/metanorma-standoc
 gem, and aligns closely to it.
@@ -221,3 +216,6 @@ This gem is developed, maintained and funded by https://www.ribose.com[Ribose In
 
 * Document templates are available at the https://github.com/metanorma/mn-templates-ietf[mn-templates-ietf] repository.
 
+== Notes
+
+Metanorma-IETF was formerly published as the `asciidoctor-rfc` gem.

data/lib/asciidoctor/ietf/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">
@@ -141,6 +149,11 @@
             <data type="boolean"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="key">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <ref name="dt"/>
           <ref name="dd"/>

data/lib/isodoc/ietf/front.rb

@@ -135,12 +135,12 @@ module IsoDoc::Ietf
     end
 
     def postal(addr, out)
-      if line = addr.at(ns("./formattedAddress"))
-        line.text.split(/\n/).each do |l|
-          out.postalLine l, **attr_code(ascii: l.transliterate)
-        end
-      else
-        out.postal do |p|
+      out.postal do |p|
+        if line = addr.at(ns("./formattedAddress"))
+          line.text.split(/\n/).each do |l|
+            p.postalLine l, **attr_code(ascii: l.transliterate)
+          end
+        else
           postal_detailed(addr, p)
         end
       end

data/lib/isodoc/ietf/references.rb

@@ -3,16 +3,27 @@ module IsoDoc::Ietf
     # TODO displayreference will be implemented as combination of autofetch and user-provided citations
 
     def bibliography(isoxml, out)
-      isoxml.xpath(ns("//references")).each do |f|
-        out.references **attr_code(anchor: f["id"]) do |div|
-          title = f.at(ns("./title")) and div.name do |name|
-            title.children.each { |n| parse(n, name) }
-          end
-          f.elements.reject do |e|
-            %w(reference title bibitem note).include? e.name
-          end.each { |e| parse(e, div) }
-          biblio_list(f, div, true)
+      isoxml.xpath(ns("//bibliography/references | "\
+                      "//bibliography/clause[.//references] | "\
+                      "//annex/clause[.//references] | "\
+                      "//annex/references | "\
+                      "//sections/clause[.//references]")).each do |f|
+        bibliography1(f, out)
+      end
+    end
+
+    def bibliography1(f, out)
+      out.references **attr_code(anchor: f["id"]) do |div|
+        title = f.at(ns("./title")) and div.name do |name|
+          title.children.each { |n| parse(n, name) }
         end
+        f.elements.select do |e|
+          %w(references clause).include? e.name
+        end.each { |e| bibliography1(e, out) }
+        f.elements.reject do |e|
+          %w(references title bibitem note).include? e.name
+        end.each { |e| parse(e, div) }
+        biblio_list(f, div, true)
       end
     end
 

data/lib/isodoc/ietf/section.rb

@@ -141,6 +141,7 @@ module IsoDoc::Ietf
     end
 
     def clause_parse(node, out)
+      return if node.at(ns(".//references"))
       out.section **attr_code( anchor: node["id"], numbered: node["numbered"],
                               removeInRFC: node["removeInRFC"], toc: node["toc"]) do |div|
         clause_parse_title(node, div, node.at(ns("./title")), out)
@@ -153,23 +154,16 @@ module IsoDoc::Ietf
     def clause(isoxml, out)
       isoxml.xpath("//xmlns:preface/child::*[not(name() = 'abstract' or name() = 'foreword')] "\
                    "| //xmlns:sections/child::*").each do |c|
-        clause1(c, out)
-      end
-    end
-
-    def clause1(c, out)
-      out.section **attr_code( anchor: c["id"], numbered: c["numbered"],
-                              removeInRFC: c["removeInRFC"], toc: c["toc"]) do |div|
-        clause_parse_title(c, div, c.at(ns("./title")), out)
-        c.elements.reject { |c1| c1.name == "title" }.each do |c1|
-          parse(c1, div)
-        end
+        #cdup = c.dup
+        #cdup.xpath(ns(".//references")).each { |r| r.remove }
+        #cdup.at("./*[local-name() != 'title'][normalize-space(text()) != '']") or next
+        clause_parse(c, out)
       end
     end
 
     def annex(isoxml, out)
       isoxml.xpath(ns("//annex")).each do |c|
-        clause1(c, out)
+        clause_parse(c, out)
       end
     end
   end

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-   VERSION = "2.2.4".freeze
+   VERSION = "2.2.5".freeze
   end
 end

data/metanorma-ietf.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
   spec.add_dependency "metanorma-standoc", "~> 1.6.0"
-  spec.add_dependency "isodoc", "~> 1.2.0"
+  spec.add_dependency "isodoc", "~> 1.3.0"
   spec.add_dependency "mathml2asciimath"
 
   spec.add_development_dependency "byebug"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ietf
 version: !ruby/object:Gem::Version
-  version: 2.2.4
+  version: 2.2.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-25 00:00:00.000000000 Z
+date: 2020-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: mathml2asciimath
   requirement: !ruby/object:Gem::Requirement