metanorma-ietf 1.0.10 → 2.0.0

data/lib/isodoc/ietf/section.rb

@@ -0,0 +1,162 @@
+module IsoDoc::Ietf
+  class RfcConvert < ::IsoDoc::Convert
+    def common_rfc_pis(node)
+      rfc_pis = {
+         artworkdelimiter: node&.at(ns("//pi/artworkdelimiter"))&.text,
+        artworklines: node&.at(ns("//pi/artworklines"))&.text,
+        authorship: node&.at(ns("//pi/authorship"))&.text,
+        autobreaks: node&.at(ns("//pi/autobreaks"))&.text,
+        background: node&.at(ns("//pi/background"))&.text,
+        colonspace: node&.at(ns("//pi/colonspace"))&.text,
+        comments: node&.at(ns("//pi/comments"))&.text,
+        docmapping: node&.at(ns("//pi/docmapping"))&.text,
+        editing: node&.at(ns("//pi/editing"))&.text,
+        emoticonic: node&.at(ns("//pi/emoticonic"))&.text,
+        footer: node&.at(ns("//pi/footer"))&.text,
+        header: node&.at(ns("//pi/header"))&.text,
+        inline: node&.at(ns("//pi/inline"))&.text,
+        iprnotified: node&.at(ns("//pi/iprnotified"))&.text,
+        linkmailto: node&.at(ns("//pi/linkmailto"))&.text,
+        linefile: node&.at(ns("//pi/linefile"))&.text,
+        notedraftinprogress: node&.at(ns("//pi/notedraftinprogress"))&.text,
+        private: node&.at(ns("//pi/private"))&.text,
+        refparent: node&.at(ns("//pi/refparent"))&.text,
+        rfcedstyle: node&.at(ns("//pi/rfcedstyle"))&.text,
+        slides: node&.at(ns("//pi/slides"))&.text,
+        "text-list-symbols": node&.at(ns("//pi/text-list-symbols"))&.text,
+        tocappendix: node&.at(ns("//pi/tocappendix"))&.text,
+        tocindent: node&.at(ns("//pi/tocindent"))&.text,
+        tocnarrow: node&.at(ns("//pi/tocnarrow"))&.text,
+        tocompact: node&.at(ns("//pi/tocompact"))&.text,
+        topblock: node&.at(ns("//pi/topblock"))&.text,
+        useobject: node&.at(ns("//pi/useobject"))&.text,
+        strict: node&.at(ns("//pi/strict"))&.text || "yes",
+        compact: node&.at(ns("//pi/compact"))&.text || "yes",
+        subcompact: node&.at(ns("//pi/subcompact"))&.text || "no",
+        toc: node&.at(ns("//pi/toc-include"))&.text,
+        tocdepth: node&.at(ns("//pi/toc-depth"))&.text || "4",
+        symrefs: node&.at(ns("//pi/sym-refs"))&.text || "yes",
+        sortrefs: node&.at(ns("//pi/sort-refs"))&.text || "yes",
+      }
+      attr_code(rfc_pis)
+    end
+
+    def set_pis(node, doc)
+      rfc_pis = common_rfc_pis(node)
+      rfc_pis.each_pair do |k, v|
+        pi = Nokogiri::XML::ProcessingInstruction.new(doc, "rfc",
+                                                      "#{k}=\"#{v}\"")
+        doc.root.add_previous_sibling(pi)
+      end
+      doc.to_xml
+    end
+
+    def rfc_attributes(docxml)
+      t = Time.now.getutc
+      obs = xpath_comma(docxml.xpath(ns(
+        "//bibdata/relation[@type = 'obsoletes']/bibitem/docidentifier")))
+      upd = xpath_comma(docxml.xpath(ns(
+        "//bibdata/relation[@type = 'updates']/bibitem/docidentifier")))
+      {
+        docName:        @meta.get[:doctype] == "Internet Draft" ? @meta.get[:docnumber] : nil,
+        number:         @meta.get[:doctype].casecmp?("rfc") ? @meta.get[:docnumber] : nil,
+        category:       docxml&.at(ns("//bibdata/series[@type = 'intended']/title"))&.text || "std",
+        ipr:            docxml&.at(ns("//bibdata/ext/ipr"))&.text,
+        obsoletes:      obs,
+        updates:        upd,
+        indexInclude:   docxml&.at(ns("//bibdata/ext/indexInclude"))&.text,
+        iprExtract:     docxml&.at(ns("//bibdata/ext/iprExtract"))&.text,
+        sortRefs:       docxml&.at(ns("//bibdata/ext/sortRefs"))&.text,
+        symRefs:        docxml&.at(ns("//bibdata/ext/symRefs"))&.text,
+        tocInclude:     docxml&.at(ns("//bibdata/ext/tocInclude"))&.text,
+        tocDepth:       docxml&.at(ns("//bibdata/ext/tocDepth"))&.text,
+        submissionType: docxml&.at(ns(
+          "//bibdata/series[@type = 'stream']/title"))&.text || "IETF",
+        'xml:lang':     docxml&.at(ns("//bibdata/language"))&.text,
+        version:        "3",
+        'xmlns:xi':        "http://www.w3.org/2001/XInclude",
+        prepTime:       sprintf("%04d-%02d-%02dT%02d:%02d:%02dZ",
+                                t.year, t.month, t.day, t.hour, t.min, t.sec),
+      }
+    end
+
+    def xpath_comma(xpath)
+      return nil if xpath.empty?
+      xpath.map { |x| x.text }.join(", ")
+    end
+
+    def make_link(out, isoxml)
+      links = isoxml.xpath(ns(
+        "//bibdata/relation[@type = 'includedIn' or @type = 'describedBy' or "\
+        "@type = 'derivedFrom' or @type = 'equivalent']")) || return
+        links.each do |l|
+          out.link **{ href: l&.at(ns("./bibitem/docidentifier"))&.text,
+                       rel: rel2iana(l["type"]) }
+        end
+    end
+
+    def rel2iana(type)
+      case type
+      when "includedIn" then "item"
+      when "describedBy" then "describedby"
+      when "derivedFrom" then "convertedfrom"
+      when "equivalent" then "alternate"
+      else 
+        "alternate"
+      end
+    end
+
+    def make_middle(out, isoxml)
+      out.middle do |middle|
+        clause isoxml, middle
+      end
+    end
+
+    def make_back(out, isoxml)
+      out.back do |back|
+        annex isoxml, back
+        bibliography isoxml, back
+      end
+    end
+
+    def clause_parse_title(node, div, c1, out)
+      return unless c1
+      div.name do |n|
+        c1&.children&.each { |c2| parse(c2, n) }
+      end
+    end
+
+    def clause_parse(node, out)
+      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)
+        node.children.reject { |c1| c1.name == "title" }.each do |c1|
+          parse(c1, div)
+        end
+      end
+    end
+
+    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
+      end
+    end
+
+    def annex(isoxml, out)
+      isoxml.xpath(ns("//annex")).each do |c|
+        clause1(c, out)
+      end
+    end
+  end
+end

data/lib/isodoc/ietf/table.rb

@@ -0,0 +1,43 @@
+module IsoDoc::Ietf
+  class RfcConvert < ::IsoDoc::Convert
+    def make_table_attr(node)
+      attr_code(anchor: node["id"], align: node["align"])
+    end
+
+    def table_parse(node, out)
+      @in_table = true
+      out.table **make_table_attr(node) do |t|
+        table_title_parse(node, out)
+        thead_parse(node, t)
+        tbody_parse(node, t)
+        tfoot_parse(node, t)
+      end
+      (dl = node.at(ns("./dl"))) && parse(dl, out)
+      node.xpath(ns("./note")).each { |n| parse(n, out) }
+      @in_table = false
+    end
+
+    def table_title_parse(node, out)
+      name = node.at(ns("./name")) || return
+      out.name do |p|
+        name.children.each { |n| parse(n, p) }
+      end
+    end
+
+    def tr_parse(node, out, ord, totalrows, header)
+      out.tr do |r|
+        node.elements.each do |td|
+          attrs = make_tr_attr(td, ord, totalrows - 1, header)
+          r.send td.name, **attrs do |entry|
+            td.children.each { |n| parse(n, entry) }
+          end
+        end
+      end
+    end
+
+    def make_tr_attr(td, row, totalrows, header)
+      attr_code(rowspan: td["rowspan"], colspan: td["colspan"],
+                align: td["align"] )
+    end
+  end
+end

data/lib/isodoc/ietf/terms.rb

@@ -0,0 +1,65 @@
+module IsoDoc::Ietf
+  class RfcConvert < ::IsoDoc::Convert
+
+    def definition_parse(node, out)
+      node.children.each { |n| parse(n, out) }
+    end
+
+    def modification_parse(node, out)
+      para = node.at(ns("./p"))
+      out << " -- "
+      para.children.each { |n| parse(n, out) }
+    end
+
+    def deprecated_term_parse(node, out)
+      out.t do |p|
+        p << l10n("#{@deprecated_lbl}: ")
+        node.children.each { |c| parse(c, p) }
+      end
+    end
+
+    def admitted_term_parse(node, out)
+      out.t do |p|
+        node.children.each { |c| parse(c, p) }
+      end
+    end
+
+    def term_parse(node, out)
+      out.name do |p|
+        node.children.each { |n| parse(n, p) }
+      end
+    end
+
+    def termnote_parse(node, out)
+      note_parse(node, out)
+    end
+
+    def termref_parse(node, out)
+      out.t do |p|
+        p << "SOURCE: "
+        node.children.each { |n| parse(n, p) }
+      end
+    end
+
+    def termdef_parse(node, out)
+      set_termdomain("")
+      clause_parse(node, out)
+    end
+
+    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/metanorma-ietf.rb

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

data/lib/metanorma/ietf/processor.rb

@@ -8,13 +8,13 @@ module Metanorma
       def initialize
         @short = :ietf
         @input_format = :asciidoc
-        @asciidoctor_backend = :rfc2
+        @asciidoctor_backend = :ietf
       end
 
       def output_formats
         {
-          xmlrfc2: "xml",
-          xmlrfc3: "v3.xml",
+          xml: "xml",
+          rfc: "rfc.xml",
           html: "html",
           txt: "txt"
         }
@@ -25,15 +25,10 @@ module Metanorma
       end
 
       def input_to_isodoc(file, filename)
-        # TODO: storing these two variables for xmlrfc2. Remove when we have IsoDoc
-        @file = file
-        @filename = filename
-
         # This is XML RFC v3 output in text
         Metanorma::Input::Asciidoc.new.process(file, filename, @asciidoctor_backend)
       end
 
-      # TODO: we're not yet using IsoDoc here
       def extract_options(isodocxml)
         {}
       end
@@ -43,48 +38,32 @@ module Metanorma
       def which(cmd)
         exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
         ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
-          exts.each { |ext|
+          exts.each do |ext|
             exe = File.join(path, "#{cmd}#{ext}")
             return exe if File.executable?(exe) && !File.directory?(exe)
-          }
+          end
         end
         nil
       end
 
       def output(isodoc_node, outname, format, options={})
         case format
-        when :xmlrfc2
-          # TODO: we're using XML RFC v2 as the central format because our processor
-          # is not updated to the new schema
-
-          # xmlrfcdoc = Metanorma::Input::Asciidoc.new.process(@file, @filename, :rfc2)
-          # File.open(outname, 'w') { |f| f << xmlrfcdoc }
-
-          # TODO: When we have IsoDoc, we just translate IsoDoc to XML RFC v2
-          File.open(outname, 'w') { |f| f << isodoc_node }
-        when :xmlrfc3
-          # TODO: When we have IsoDoc, we just translate IsoDoc to XML RFC v3
-          xmlrfcdoc = Metanorma::Input::Asciidoc.new.process(@file, @filename, :rfc3)
-          File.open(outname, 'w') { |f| f << xmlrfcdoc }
+        when :rfc
+          IsoDoc::Ietf::RfcConvert.new(options).convert(outname, isodoc_node)
+          @done_rfc = true
 
         when :txt, :html
-          warn outname
-          Tempfile.open(File.basename(outname)) do |f|
-            f << isodoc_node
-
-            unless which("xml2rfc")
-              warn "[metanorma-ietf] Error: unable to generate #{format}, the command `xml2rfc` is not found in path."
-              return
-            end
-
-            # In xml2rfc, --text and --html are used
-            format = :text if format == :txt
-            # puts "xml2rfc --#{format} #{f.path} -o #{outname}"
-            system("xml2rfc --#{format} #{f.path} -o #{outname}")
+          rfcname = outname.sub(/\.(html|txt)$/, ".rfc.xml")
+          output(isodoc_node, outname, :rfc, options) unless @done_rfc
+          unless which("xml2rfc")
+            warn "[metanorma-ietf] Error: unable to generate #{format}, the command `xml2rfc` is not found in path."
+            return
           end
+          # In xml2rfc, --text and --html are used
+          format = :text if format == :txt
+          system("xml2rfc --#{format} #{rfcname} -o #{outname}")
         end
       end
-
     end
   end
 end

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-   VERSION = "1.0.10".freeze
+   VERSION = "2.0.0".freeze
   end
 end

data/metanorma-ietf.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
     metanorma-ietf lets you write IETF documents, such as Internet-Drafts and RFCs,
     in native AsciiDoc syntax. This is part of the Metanorma publishing framework.
 
-    RFC XML ("xml2rfc" Vocabulary XML, RFC7322) is the XML-based language used for
+    RFC XML ("xml2rfc" Vocabulary XML, RFC 7991) is the XML-based language used for
     writing Internet-Drafts and RFCs, but not everyone likes hand-crafting XML,
     especially when the focus should be on the content.
 
@@ -37,9 +37,9 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "metanorma-standoc", "~> 1.3.0"
   spec.add_dependency "isodoc", "~> 1.0.0"
+  spec.add_dependency "mathml2asciimath"
 
-  spec.add_development_dependency "bundler", "~> 2.0.1"
-  spec.add_development_dependency "byebug", "~> 9.1"
+  spec.add_development_dependency "byebug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-rspec", "~> 4.7"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ietf
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 2.0.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-13 00:00:00.000000000 Z
+date: 2020-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
@@ -39,33 +39,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: mathml2asciimath
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '9.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '9.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
   requirement: !ruby/object:Gem::Requirement
@@ -224,7 +224,7 @@ description: |
   metanorma-ietf lets you write IETF documents, such as Internet-Drafts and RFCs,
   in native AsciiDoc syntax. This is part of the Metanorma publishing framework.
 
-  RFC XML ("xml2rfc" Vocabulary XML, RFC7322) is the XML-based language used for
+  RFC XML ("xml2rfc" Vocabulary XML, RFC 7991) is the XML-based language used for
   writing Internet-Drafts and RFCs, but not everyone likes hand-crafting XML,
   especially when the focus should be on the content.
 
@@ -249,7 +249,6 @@ files:
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - Guardfile
 - LICENSE
 - README.adoc
@@ -263,27 +262,28 @@ files:
 - docs/installation.md
 - docs/navigation.md
 - docs/overview.md
-- lib/asciidoctor/rfc.rb
-- lib/asciidoctor/rfc/common/base.rb
-- lib/asciidoctor/rfc/common/front.rb
-- lib/asciidoctor/rfc/common/validate.rb
-- lib/asciidoctor/rfc/v2/base.rb
-- lib/asciidoctor/rfc/v2/blocks.rb
-- lib/asciidoctor/rfc/v2/converter.rb
-- lib/asciidoctor/rfc/v2/front.rb
-- lib/asciidoctor/rfc/v2/inline_anchor.rb
-- lib/asciidoctor/rfc/v2/lists.rb
-- lib/asciidoctor/rfc/v2/table.rb
-- lib/asciidoctor/rfc/v2/validate.rng
-- lib/asciidoctor/rfc/v3/base.rb
-- lib/asciidoctor/rfc/v3/blocks.rb
-- lib/asciidoctor/rfc/v3/converter.rb
-- lib/asciidoctor/rfc/v3/front.rb
-- lib/asciidoctor/rfc/v3/inline_anchor.rb
-- lib/asciidoctor/rfc/v3/lists.rb
-- lib/asciidoctor/rfc/v3/svg.rng
-- lib/asciidoctor/rfc/v3/table.rb
-- lib/asciidoctor/rfc/v3/validate.rng
+- lib/asciidoctor/ietf/basicdoc.rng
+- lib/asciidoctor/ietf/biblio.rng
+- lib/asciidoctor/ietf/blocks.rb
+- lib/asciidoctor/ietf/converter.rb
+- lib/asciidoctor/ietf/front.rb
+- lib/asciidoctor/ietf/ietf.rng
+- lib/asciidoctor/ietf/isodoc.rng
+- lib/asciidoctor/ietf/isostandard.rng
+- lib/asciidoctor/ietf/reqt.rng
+- lib/asciidoctor/ietf/validate.rb
+- lib/isodoc/ietf/blocks.rb
+- lib/isodoc/ietf/cleanup.rb
+- lib/isodoc/ietf/footnotes.rb
+- lib/isodoc/ietf/front.rb
+- lib/isodoc/ietf/inline.rb
+- lib/isodoc/ietf/metadata.rb
+- lib/isodoc/ietf/references.rb
+- lib/isodoc/ietf/reqt.rb
+- lib/isodoc/ietf/rfc_convert.rb
+- lib/isodoc/ietf/section.rb
+- lib/isodoc/ietf/table.rb
+- lib/isodoc/ietf/terms.rb
 - lib/metanorma-ietf.rb
 - lib/metanorma/ietf.rb
 - lib/metanorma/ietf/processor.rb
@@ -312,7 +312,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: metanorma-ietf lets you write IETF documents, such as Internet-Drafts and