metanorma-ietf 2.0.13 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 618fe15c1205c409e7f57dc672f45545a408bf20dd7fdeb68577e295232bf226
-  data.tar.gz: 42104d4c8b90df8481c5bf25d598a68e7c447d71bfa53349b4bef8194dd0e3b0
+  metadata.gz: 64b7510c103e030759b4c5430edf1165dd55859f28a6914f091a8f028400ef95
+  data.tar.gz: '088ba7ce77c62226026e0fab41af28429a16623bc6379cc95d99f4bfa1a8fbe9'
 SHA512:
-  metadata.gz: 18a552d7d528ae211fcbad094c876c6fac60b0503687725edc13d809a3a9f2fd93aafa7a14ede31f47b7b5e9c1d6b5fa092c261f4fd6d63ca9e7eb391fcc6dea
-  data.tar.gz: 9c58535cb308711ef79df7a58d261887cbbadbedb3fb1a0edcd0247f782b5caa9c58df24ff371ffacd4fe1381f4f4840e61a267903a33fb40ccbd633a7f249c5
+  metadata.gz: c12d417a764debe8f8c4003e88730df92e34168c6fa85ecb322f94f63c7775c5c3d425faf2096b561edc7bd1598e95157a07bca6833acb26e2b7e5903b768ceb
+  data.tar.gz: 7117f344165e8150e0acd0fbc397cb73a2ec12e22763c4069d8d05e6f283df5622b998f7ed83eb067730f51e596ed8d9874ced2389e5a8f0d05da286f0bf82d4

data/.github/workflows/macos.yml

@@ -36,7 +36,6 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
       - name: Update gems
         run: |
           sudo gem install bundler --force

data/.github/workflows/ubuntu.yml

@@ -35,7 +35,6 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
       - name: Update gems
         run: |
           gem install bundler

data/.github/workflows/windows.yml

@@ -36,7 +36,6 @@ jobs:
         uses: actions/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}
-          architecture: 'x64'
       - name: Update gems
         shell: pwsh
         run: |

data/lib/asciidoctor/ietf/converter.rb

@@ -26,19 +26,9 @@ module Asciidoctor
         super
       end
 
-      def document(node)
-        init(node)
-        ret1 = makexml(node)
-        ret = ret1.to_xml(indent: 2)
-        unless node.attr("nodoc") || !node.attr("docfile")
-          filename = node.attr("docfile").gsub(/\.adoc/, ".xml").
-            gsub(%r{^.*/}, "")
-          File.open(filename, "w") { |f| f.write(ret) }
-          rfc_converter(node).convert filename unless node.attr("nodoc")
-        end
-        @log.write(@localdir + @filename + ".err") unless @novalid
-        @files_to_delete.each { |f| FileUtils.rm f }
-        ret
+      def outputs(node, ret)
+        File.open(@filename + ".xml", "w:UTF-8") { |f| f.write(ret) }
+        rfc_converter(node).convert(@filename + ".xml")
       end
 
       def doctype(node)

data/lib/asciidoctor/ietf/isodoc.rng

@@ -922,6 +922,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +964,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +992,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1014,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,6 +1042,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1180,6 +1183,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>

data/lib/isodoc/ietf/blocks.rb

@@ -72,7 +72,9 @@ module IsoDoc::Ietf
     end
 
     def note_label(node)
-      l10n("#{super}: ")
+      n = @xrefs.get[node["id"]]
+      return l10n("#{@i18n.note}: ") if n.nil? || n[:label].nil? || n[:label].empty?
+      l10n("#{@i18n.note} #{n[:label]}: ")
     end
 
     def note_parse(node, out)
@@ -94,10 +96,10 @@ module IsoDoc::Ietf
     end
 
     def example_label(node, div, name)
-      n = get_anchors[node["id"]]
+      n = @xrefs.get[node["id"]]
       div.t **attr_code(anchor: node["id"], keepWithNext: "true") do |p|
-        lbl = (n.nil? || n[:label].nil? || n[:label].empty?) ? @example_lbl :
-          l10n("#{@example_lbl} #{n[:label]}")
+        lbl = (n.nil? || n[:label].nil? || n[:label].empty?) ? @i18n.example :
+          l10n("#{@i18n.example} #{n[:label]}")
         p << lbl
         name and !lbl.nil? and p << ": "
         name and name.children.each { |n| parse(n, p) }
@@ -137,14 +139,14 @@ module IsoDoc::Ietf
 
     def formula_where(dl, out)
       return unless dl
-      out.t { |p| p << @where_lbl }
+      out.t { |p| p << @i18n.where }
       parse(dl, out)
     end
 
     def formula_parse1(node, out)
       out.t **attr_code(anchor: node["id"]) do |p|
         parse(node.at(ns("./stem")), p)
-        lbl = anchor(node['id'], :label, false)
+        lbl = @xrefs.anchor(node['id'], :label, false)
         lbl.nil? or
           p << "    (#{lbl})"
       end

data/lib/isodoc/ietf/cleanup.rb

@@ -157,7 +157,8 @@ module IsoDoc::Ietf
         s.children = s.children.to_xml.gsub(%r{<br/>\n}, "\n").
           gsub(%r{\s+(<t[ >])}, "\\1").gsub(%r{</t>\s+}, "</t>")
         sourcecode_remove_markup(s)
-        s.children = "<![CDATA[#{s.children.to_xml.sub(/\A\n+/, "")}]]>"
+        text = HTMLEntities.new.decode(s.children.to_xml.sub(/\A\n+/, ""))
+        s.children = "<![CDATA[#{text}]]>"
       end
     end
 

data/lib/isodoc/ietf/front.rb

@@ -23,11 +23,16 @@ module IsoDoc::Ietf
       super
     end
 
+    def output_if_translit(text)
+      return nil if text.nil?
+      text.transliterate != text ? text.transliterate : nil
+    end
+
     def title(isoxml, front)
       title = @meta.get[:doctitle] or return
       front.title title, **attr_code(abbrev: @meta.get[:docabbrev],
-                                     ascii: @meta.get[:docascii] ||
-                                     title.transliterate)
+                                     ascii: (@meta.get[:docascii] ||
+                                     output_if_translit(title)))
     end
 
     def seriesinfo(isoxml, front)
@@ -37,7 +42,7 @@ module IsoDoc::Ietf
 
     def seriesinfo_attr(isoxml)
       attr_code(value: @meta.get[:docnumber] || "",
-                asciiValue: @meta.get[:docnumber]&.transliterate,
+                asciiValue: output_if_translit(@meta.get[:docnumber]),
                 status: @meta.get[:stage],
                 stream: isoxml&.at(ns("//bibdata/series[@type = 'stream']/"\
                                       "title"))&.text)
@@ -82,9 +87,9 @@ module IsoDoc::Ietf
 
     def pers_author_attrs1(ret, full, init, c)
       full and ret.merge!(attr_code(
-        asciiFullname: full&.transliterate,
-        asciiInitials: init&.transliterate,
-        asciiSurname: c&.at(ns("./surname"))&.text&.transliterate))
+        asciiFullname: output_if_translit(full),
+        asciiInitials: output_if_translit(init),
+        asciiSurname: output_if_translit(c&.at(ns("./surname")))))
       ret
     end
 
@@ -113,8 +118,8 @@ module IsoDoc::Ietf
     def organization(org, out, show)
       name = org.at(ns("./name"))&.text
       out.organization name, **attr_code(
-        showOnFrontPage: show&.text, ascii: name&.transliterate,
-        asciiAbbrev: org&.at(ns("./abbreviation"))&.transliterate,
+        showOnFrontPage: show&.text, ascii: output_if_translit(name),
+        asciiAbbrev: output_if_translit(org.at(ns("./abbreviation"))),
         abbrev: org.at(ns("./abbreviation")))
     end
 
@@ -163,7 +168,7 @@ module IsoDoc::Ietf
 
     def date(isoxml, front)
       date = @meta.get[:publisheddate] || @meta.get[:circulateddate] || return
-      date.gsub!(/T.*$/, "")
+      date = date.gsub(/T.*$/, "")
       attr = date_attr(date) || return
       front.date **attr_code(attr)
     end

data/lib/isodoc/ietf/reqt.rb

@@ -1,5 +1,10 @@
 module IsoDoc::Ietf
   class RfcConvert < ::IsoDoc::Convert
+    def recommendation_labels(node)
+      [node.at(ns("./label")), node.at(ns("./title")), 
+       @xrefs.anchor(node['id'], :label, false)]
+    end
+
     def recommendation_name(node, out, type)
       label, title, lbl = recommendation_labels(node)
       out.t **{ keepWithNext: "true" }  do |b|
@@ -27,7 +32,7 @@ module IsoDoc::Ietf
     end
 
     def recommendation_parse(node, out)
-      recommendation_name(node, out, @recommendation_lbl)
+      recommendation_name(node, out, @i18n.recommendation)
       recommendation_attributes(node, out)
       node.children.each do |n|
         parse(n, out) unless %w(label title).include? n.name
@@ -35,7 +40,7 @@ module IsoDoc::Ietf
     end
 
     def requirement_parse(node, out)
-      recommendation_name(node, out, @requirement_lbl)
+      recommendation_name(node, out, @i18n.requirement)
       recommendation_attributes(node, out)
       node.children.each do |n|
         parse(n, out) unless %w(label title).include? n.name
@@ -43,7 +48,7 @@ module IsoDoc::Ietf
     end
 
     def permission_parse(node, out)
-      recommendation_name(node, out, @permission_lbl)
+      recommendation_name(node, out, @i18n.permission)
       recommendation_attributes(node, out)
       node.children.each do |n|
         parse(n, out) unless %w(label title).include? n.name

data/lib/isodoc/ietf/rfc_convert.rb

@@ -9,11 +9,12 @@ require_relative "./cleanup"
 require_relative "./footnotes"
 require_relative "./references"
 require_relative "./section"
+require_relative "./xref"
 
 module IsoDoc::Ietf
   class RfcConvert < ::IsoDoc::Convert
     def convert1(docxml, filename, dir)
-      anchor_names docxml
+      @xrefs.parse docxml
       info docxml, nil
       xml = noko do |xml|
         xml.rfc **attr_code(rfc_attributes(docxml)) do |html|
@@ -26,10 +27,14 @@ module IsoDoc::Ietf
           set_pis(docxml, Nokogiri::XML(xml))
     end
 
-    def metadata_init(lang, script, labels)
-      @meta = Metadata.new(lang, script, labels)
+    def metadata_init(lang, script, i18n)
+      @meta = Metadata.new(lang, script, i18n)
     end
 
+    def xref_init(lang, script, klass, i18n, options)
+        @xrefs = Xref.new(lang, script, klass, i18n, options)
+      end
+
     def extract_delims(text)
       @openmathdelim = "$$"
       @closemathdelim = "$$"
@@ -58,7 +63,7 @@ module IsoDoc::Ietf
       result = from_xhtml(cleanup(to_xhtml(textcleanup(result)))).
         sub(/<!DOCTYPE[^>]+>\n/, "").
         sub(/(<rfc[^<]+? )lang="[^"]+"/, "\\1")
-      File.open("#{filename}.rfc.xml", "w:UTF-8") { |f| f.write(result) }
+      File.open(filename, "w:UTF-8") { |f| f.write(result) }
       @files_to_delete.each { |f| FileUtils.rm_rf f }
     end
 
@@ -71,6 +76,7 @@ module IsoDoc::Ietf
       super
       @xinclude = options[:use_xinclude] == "true"
       @format = :rfc
+      @suffix = "rfc.xml"
     end
   end
 end

data/lib/isodoc/ietf/section.rb

@@ -81,11 +81,11 @@ module IsoDoc::Ietf
 
     def series2category(series)
       case series&.downcase
-      when "standard" then "std"
-      when "informational" then "info"
-      when "experimental" then "exp"
+      when "standard", "std" then "std"
+      when "informational", "info" then "info"
+      when "experimental", "exp" then "exp"
       when "bcp" then "bcp"
-      when "fyi" then "info"
+      when "fyi", "info" then "info"
       when "full-standard" then "std"
       when "historic" then "historic"
       else
@@ -132,7 +132,7 @@ module IsoDoc::Ietf
       end
     end
 
-    def clause_parse_title(node, div, c1, out)
+    def clause_parse_title(node, div, c1, out, _heading_attrs = {})
       return unless c1
       div.name do |n|
         c1&.children&.each { |c2| parse(c2, n) }

data/lib/isodoc/ietf/terms.rb

@@ -13,7 +13,7 @@ module IsoDoc::Ietf
 
     def deprecated_term_parse(node, out)
       out.t do |p|
-        p << l10n("#{@deprecated_lbl}: ")
+        p << l10n("#{@i18n.deprecated}: ")
         node.children.each { |c| parse(c, p) }
       end
     end
@@ -48,18 +48,5 @@ module IsoDoc::Ietf
 
     def termdocsource_parse(_node, _out)
     end
-
-    def termnote_anchor_names(docxml)
-      docxml.xpath(ns("//term[descendant::termnote]")).each do |t|
-        c = Counter.new
-        notes = t.xpath(ns(".//termnote"))
-        notes.each do |n|
-          next if n["id"].nil? || n["id"].empty?
-          idx = notes.size == 1 ? "" : " #{c.increment(n).print}"
-          @anchors[n["id"]] =
-            anchor_struct(idx, n, @note_xref_lbl, "note", false)
-        end
-      end
-    end
   end
 end

data/lib/isodoc/ietf/xref.rb

@@ -0,0 +1,20 @@
+require "isodoc"
+
+module IsoDoc
+  module Ietf
+    class Xref < IsoDoc::Xref
+      def termnote_anchor_names(docxml)
+        docxml.xpath(ns("//term[descendant::termnote]")).each do |t|
+          c = IsoDoc::XrefGen::Counter.new
+          notes = t.xpath(ns(".//termnote"))
+          notes.each do |n|
+            next if n["id"].nil? || n["id"].empty?
+            idx = notes.size == 1 ? "" : " #{c.increment(n).print}"
+            @anchors[n["id"]] =
+              anchor_struct(idx, n, @labels["note_xref"], "note", false)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/ietf/processor.rb

@@ -26,11 +26,6 @@ module Metanorma
         "Metanorma::Ietf #{::Metanorma::Ietf::VERSION}"
       end
 
-      def input_to_isodoc(file, filename)
-        # This is XML RFC v3 output in text
-        Metanorma::Input::Asciidoc.new.process(file, filename, @asciidoctor_backend)
-      end
-
       def extract_options(isodocxml)
         {}
       end
@@ -48,14 +43,19 @@ module Metanorma
         nil
       end
 
+      def use_presentation_xml(ext)
+        false
+      end
+
       def xml2rfc_present?
         !which("xml2rfc").nil?
       end
 
-      def output(isodoc_node, outname, format, options={})
+      def output(isodoc_node, inname, outname, format, options={})
         case format
         when :rfc
-          IsoDoc::Ietf::RfcConvert.new(options).convert(outname, isodoc_node)
+          outname ||= inname.sub(/\.xml$/, ".rfc.xml")
+          IsoDoc::Ietf::RfcConvert.new(options).convert(inname, isodoc_node, nil, outname)
           @done_rfc = true
 
         when :txt
@@ -64,9 +64,10 @@ module Metanorma
             return
           end
 
-          rfcname = outname.sub(/\.txt$/, ".rfc.xml")
-          output(isodoc_node, outname, :rfc, options) unless @done_rfc
+          rfcname = inname.sub(/\.xml$/, ".rfc.xml")
+          output(isodoc_node, inname, rfcname, :rfc, options) unless @done_rfc
 
+          outname ||= inname.sub(/\.xml$/, ".txt")
           system("xml2rfc --text #{rfcname} -o #{outname}")
 
         when :pdf
@@ -75,9 +76,10 @@ module Metanorma
             return
           end
 
-          rfcname = outname.sub(/\.pdf$/, ".rfc.xml")
-          output(isodoc_node, outname, :rfc, options) unless @done_rfc
+          rfcname = inname.sub(/\.xml$/, ".rfc.xml")
+          output(isodoc_node, inname, rfcname, :rfc, options) unless @done_rfc
 
+          outname ||= inname.sub(/\.xml$/, ".pdf")
           system("xml2rfc --pdf #{rfcname} -o #{outname}")
 
         when :html
@@ -86,9 +88,10 @@ module Metanorma
             return
           end
 
-          rfcname = outname.sub(/\.html$/, ".rfc.xml")
-          output(isodoc_node, outname, :rfc, options) unless @done_rfc
+          rfcname = inname.sub(/\.xml$/, ".rfc.xml")
+          output(isodoc_node, inname, rfcname, :rfc, options) unless @done_rfc
 
+          outname ||= inname.sub(/\.xml$/, ".html")
           system("xml2rfc --html #{rfcname} -o #{outname}")
 
         else

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-   VERSION = "2.0.13".freeze
+   VERSION = "2.2.0".freeze
   end
 end

data/metanorma-ietf.gemspec

@@ -35,8 +35,8 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
-  spec.add_dependency "metanorma-standoc", "~> 1.4.0"
-  spec.add_dependency "isodoc", "~> 1.0.0"
+  spec.add_dependency "metanorma-standoc", "~> 1.5.0"
+  spec.add_dependency "isodoc", "~> 1.2.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.0.13
+  version: 2.2.0
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-06-19 00:00:00.000000000 Z
+date: 2020-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: isodoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: mathml2asciimath
   requirement: !ruby/object:Gem::Requirement
@@ -269,6 +269,7 @@ files:
 - lib/isodoc/ietf/section.rb
 - lib/isodoc/ietf/table.rb
 - lib/isodoc/ietf/terms.rb
+- lib/isodoc/ietf/xref.rb
 - lib/metanorma-ietf.rb
 - lib/metanorma/ietf.rb
 - lib/metanorma/ietf/processor.rb
@@ -281,7 +282,7 @@ homepage: https://github.com/metanorma/metanorma-ietf
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -296,9 +297,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: metanorma-ietf lets you write IETF documents, such as Internet-Drafts and
   RFCs, in AsciiDoc.