metanorma-ietf 2.2.8 → 2.3.2

data/lib/isodoc/ietf/blocks.rb

@@ -43,7 +43,7 @@ module IsoDoc::Ietf
     end
 
     def ol_attrs(node)
-      { anchor: node["id"], 
+      { anchor: node["id"],
         spacing: node["spacing"],
         type: ol_style(node["type"]),
         group: node["group"],
@@ -73,7 +73,9 @@ module IsoDoc::Ietf
 
     def note_label(node)
       n = @xrefs.get[node["id"]]
-      return l10n("#{@i18n.note}: ") if n.nil? || n[:label].nil? || n[:label].empty?
+      return l10n("#{@i18n.note}: ") if n.nil? || n[:label].nil? ||
+        n[:label].empty?
+
       l10n("#{@i18n.note} #{n[:label]}: ")
     end
 
@@ -98,7 +100,7 @@ module IsoDoc::Ietf
     def example_label(node, div, name)
       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?) ? @i18n.example :
+        lbl = n.nil? || n[:label].nil? || n[:label].empty? ? @i18n.example :
           l10n("#{@i18n.example} #{n[:label]}")
         p << lbl
         name and !lbl.nil? and p << ": "
@@ -107,15 +109,11 @@ module IsoDoc::Ietf
     end
 
     def sourcecode_parse(node, out)
-      out.figure **attr_code(anchor: node["id"]) do |div|
-        name = node&.at(ns("./name"))&.remove and div.name do |n|
-          name.children.each { |nn| parse(nn, n) }
-        end
-        div.sourcecode **attr_code(type: node["lang"], name: node["filename"],
-                                   markers: node["markers"],
-                                   src: node["src"]) do |s|
-                                     node.children.each { |x| parse(x, s) unless x.name == "name" }
-                                   end
+      out.sourcecode **attr_code(
+        anchor: node["id"], type: node["lang"], name: node["filename"],
+        markers: node["markers"], src: node["src"]
+      ) do |s|
+        node.children.each { |x| parse(x, s) unless x.name == "name" }
       end
     end
 
@@ -139,6 +137,7 @@ module IsoDoc::Ietf
 
     def formula_where(dl, out)
       return unless dl
+
       out.t { |p| p << @i18n.where }
       parse(dl, out)
     end
@@ -146,7 +145,7 @@ module IsoDoc::Ietf
     def formula_parse1(node, out)
       out.t **attr_code(anchor: node["id"]) do |p|
         parse(node.at(ns("./stem")), p)
-        lbl = @xrefs.anchor(node['id'], :label, false)
+        lbl = @xrefs.anchor(node["id"], :label, false)
         lbl.nil? or
           p << "    (#{lbl})"
       end
@@ -157,6 +156,7 @@ module IsoDoc::Ietf
       formula_where(node.at(ns("./dl")), out)
       node.children.each do |n|
         next if %w(stem dl).include? n.name
+
         parse(n, out)
       end
     end
@@ -176,7 +176,7 @@ module IsoDoc::Ietf
     end
 
     def admonition_name_parse(_node, div, name)
-      div.t **{keepWithNext: "true" } do |p|
+      div.t **{ keepWithNext: "true" } do |p|
         name.children.each { |n| parse(n, p) }
       end
     end
@@ -200,8 +200,9 @@ module IsoDoc::Ietf
       end
     end
 
-    def figure_name_parse(node, div, name)
+    def figure_name_parse(_node, div, name)
       return if name.nil?
+
       div.name do |n|
         name.children.each { |n| parse(n, div) }
       end
@@ -214,6 +215,7 @@ module IsoDoc::Ietf
     def figure_parse(node, out)
       return pseudocode_parse(node, out) if node["class"] == "pseudocode" ||
         node["type"] == "pseudocode"
+
       @in_figure = true
       out.figure **attr_code(anchor: node["id"]) do |div|
         figure_name_parse(node, div, node.at(ns("./name")))

data/lib/isodoc/ietf/cleanup.rb

@@ -15,14 +15,14 @@ module IsoDoc::Ietf
     end
 
     # TODO: insert <u>
-    
+
     def front_cleanup(xmldoc)
-        xmldoc.xpath("//title").each { |s| s.children = s.text }
-        xmldoc.xpath("//reference/front[not(author)]").each do |f|
-          insert = f.at("./seriesInfo[last()]") || f.at("./title")
-          insert.next = "<author surname='Unknown'/>"
-        end
+      xmldoc.xpath("//title").each { |s| s.children = s.text }
+      xmldoc.xpath("//reference/front[not(author)]").each do |f|
+        insert = f.at("./seriesInfo[last()]") || f.at("./title")
+        insert.next = "<author surname='Unknown'/>"
       end
+    end
 
     def table_footnote_cleanup(docxml)
       docxml.xpath("//table[descendant::fn]").each do |t|
@@ -46,25 +46,19 @@ module IsoDoc::Ietf
 
     def figure_cleanup(docxml)
       figure_postamble(docxml)
-      figure_wrap_artwork(docxml)
       figure_unnest(docxml)
       figure_footnote_cleanup(docxml)
     end
 
-    def figure_wrap_artwork(docxml)
-      docxml.xpath("//artwork[not(parent::figure)] | "\
-                   "//sourcecode[not(parent::figure)]").each do |a|
-        a.wrap("<figure></figure>")
-      end
-    end
-
     def figure_unnest(docxml)
       docxml.xpath("//figure[descendant::figure]").each do |f|
         insert = f
         f.xpath(".//figure").each do |a|
+          title = f.at("./name") and a.children.first.previous = title.remove
           insert.next = a.remove
           insert = insert.next_element
         end
+        f.remove
       end
     end
 
@@ -134,8 +128,10 @@ module IsoDoc::Ietf
 
     def make_endnotes(docxml)
       return unless docxml.at("//fn")
-      endnotes = docxml.at("//back") or
-      docxml << "<back/>" and endnotes = docxml.at("//back")
+
+      unless endnotes = docxml.at("//back")
+        docxml << "<back/>" and endnotes = docxml.at("//back")
+      end
       endnotes << "<section><name>Endnotes</name></section>"
       endnotes = docxml.at("//back/section[last()]")
     end
@@ -146,7 +142,7 @@ module IsoDoc::Ietf
         t.xpath(".//artwork").each_with_index do |a, i|
           insert.next = a.dup
           insert = insert.next
-          a.replace("[IMAGE #{i+1}]")
+          a.replace("[IMAGE #{i + 1}]")
         end
       end
     end
@@ -154,8 +150,8 @@ module IsoDoc::Ietf
     # for markup in pseudocode
     def sourcecode_cleanup(docxml)
       docxml.xpath("//sourcecode").each do |s|
-        s.children = s.children.to_xml.gsub(%r{<br/>\n}, "\n").
-          gsub(%r{\s+(<t[ >])}, "\\1").gsub(%r{</t>\s+}, "</t>")
+        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)
         text = HTMLEntities.new.decode(s.children.to_xml.sub(/\A\n+/, ""))
         s.children = "<![CDATA[#{text}]]>"
@@ -166,8 +162,10 @@ module IsoDoc::Ietf
       s.traverse do |n|
         next if n.text?
         next if %w(name callout annotation note sourcecode).include? n.name
-        if n.name == "br" then n.replace("\n")
-        elsif n.name == "t" then n.replace("\n\n#{n.children}")
+
+        case n.name
+        when "br" then n.replace("\n")
+        when "t" then n.replace("\n\n#{n.children}")
         else
           n.replace(n.children)
         end
@@ -177,6 +175,7 @@ module IsoDoc::Ietf
     def annotation_cleanup(docxml)
       docxml.xpath("//reference").each do |r|
         next unless r&.next_element&.name == "aside"
+
         aside = r.next_element
         aside.name = "annotation"
         aside.traverse do |n|
@@ -184,7 +183,7 @@ module IsoDoc::Ietf
         end
         r << aside
       end
-      docxml.xpath("//references/aside").each { |r| r.remove }
+      docxml.xpath("//references/aside").each(&:remove)
     end
 
     def deflist_cleanup(docxml)
@@ -211,9 +210,7 @@ module IsoDoc::Ietf
     end
 
     def bookmark_cleanup(docxml)
-      docxml.xpath("//bookmark").each do |b|
-        b.remove
-      end
+      docxml.xpath("//bookmark").each(&:remove)
     end
 
     def aside_cleanup(docxml)

data/lib/isodoc/ietf/front.rb

@@ -137,6 +137,7 @@ module IsoDoc::Ietf
     def postal(addr, out)
       out.postal do |p|
         if line = addr.at(ns("./formattedAddress"))
+          line.xpath(ns(".//br")).each { |br| br.replace("\n") }
           line.text.split(/\n/).each do |l|
             p.postalLine l, **attr_code(ascii: l.transliterate)
           end

data/lib/isodoc/ietf/inline.rb

@@ -156,7 +156,7 @@ module IsoDoc::Ietf
     end
 
     def index_parse(node, out)
-      out.iref nil, **attr_code(item: node.at(ns("./primary")).text,
+      out.iref nil, **attr_code(item: node.at(ns("./primary")).text, primary: node["primary"],
                                 subitem: node&.at(ns("./secondary"))&.text)
     end
 

data/lib/isodoc/ietf/rfc_convert.rb

@@ -26,7 +26,7 @@ module IsoDoc::Ietf
           make_back(html, docxml)
         end
       end.join("\n").sub(/<!DOCTYPE[^>]+>\n/, "")
-          set_pis(docxml, Nokogiri::XML(xml))
+      set_pis(docxml, Nokogiri::XML(xml))
     end
 
     def metadata_init(lang, script, i18n)
@@ -34,8 +34,8 @@ module IsoDoc::Ietf
     end
 
     def xref_init(lang, script, klass, i18n, options)
-        @xrefs = Xref.new(lang, script, klass, i18n, options)
-      end
+      @xrefs = Xref.new(lang, script, klass, i18n, options)
+    end
 
     def extract_delims(text)
       @openmathdelim = "$$"
@@ -57,9 +57,14 @@ module IsoDoc::Ietf
       end
     end
 
-     def textcleanup(docxml)
+    def omit_docid_prefix(prefix)
+      return true if prefix == "IETF"
+      super
+    end
+
+    def textcleanup(docxml)
       passthrough_cleanup(docxml)
-     end
+    end
 
     def postprocess(result, filename, _dir)
       result = from_xhtml(cleanup(to_xhtml(textcleanup(result)))).

data/lib/metanorma/ietf/processor.rb

@@ -1,11 +1,14 @@
 require "metanorma/processor"
 require "tempfile"
 
+require "isodoc/ietf/rfc_convert"
+
 module Metanorma
   module Ietf
-    class Processor < Metanorma::Processor
+    RfcConvert = ::IsoDoc::Ietf::RfcConvert
 
-      def initialize
+    class Processor < Metanorma::Processor
+      def initialize # rubocop:disable Lint/MissingSuper
         @short = :ietf
         @input_format = :asciidoc
         @asciidoctor_backend = :ietf
@@ -18,7 +21,7 @@ module Metanorma
           rfc: "rfc.xml",
           html: "html",
           txt: "txt",
-          pdf: "pdf"
+          pdf: "pdf",
         }
       end
 
@@ -26,15 +29,15 @@ module Metanorma
         "Metanorma::Ietf #{::Metanorma::Ietf::VERSION}"
       end
 
-      def extract_options(isodocxml)
+      def extract_options(_isodocxml)
         {}
       end
 
       # From mislav: https://stackoverflow.com/questions/2108727
       #        /which-in-ruby-checking-if-program-exists-in-path-from-ruby
       def which(cmd)
-        exts = ENV['PATHEXT'] ? ENV['PATHEXT'].split(';') : ['']
-        ENV['PATH'].split(File::PATH_SEPARATOR).each do |path|
+        exts = ENV["PATHEXT"] ? ENV["PATHEXT"].split(";") : [""]
+        ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
           exts.each do |ext|
             exe = File.join(path, "#{cmd}#{ext}")
             return exe if File.executable?(exe) && !File.directory?(exe)
@@ -43,49 +46,43 @@ module Metanorma
         nil
       end
 
-      def use_presentation_xml(ext)
+      def use_presentation_xml(_ext)
         false
       end
 
-      def xml2rfc_present?
-        !which("xml2rfc").nil?
+      def check_xml2rfc_present?(format)
+        if which("xml2rfc").nil?
+          raise "[metanorma-ietf] Fatal: unable to generate #{format}," \
+                " the command `xml2rfc` is not found in path."
+        end
       end
 
-      def output(isodoc_node, inname, outname, format, options={})
+      def output(isodoc_node, inname, outname, format, options = {})
         case format
         when :rfc
           outname ||= inname.sub(/\.xml$/, ".rfc.xml")
-          IsoDoc::Ietf::RfcConvert.new(options).convert(inname, isodoc_node, nil, outname)
+          RfcConvert.new(options).convert(inname, isodoc_node, nil, outname)
           @done_rfc = true
-
         when :txt, :pdf, :html
-          unless xml2rfc_present?
-            warn "[metanorma-ietf] Error: unable to generate #{format}, the command `xml2rfc` is not found in path."
-            return
-          end
+          xml2rfc(isodoc_node, inname, outname, format, options)
+        else
+          super
+        end
+      end
 
-          rfcname = inname.sub(/\.xml$/, ".rfc.xml")
-          unless @done_rfc && File.exist?(rfcname)
-            output(isodoc_node, inname, rfcname, :rfc, options)
-          end
+      def xml2rfc(isodoc_node, inname, outname, format, options)
+        check_xml2rfc_present?(format)
 
-          outext = case format
-            when :txt then ".txt"
-            when :pdf then ".pdf"
-            when :html then ".html"
-          end
+        rfcname = inname.sub(/\.xml$/, ".rfc.xml")
+        unless @done_rfc && File.exist?(rfcname)
+          output(isodoc_node, inname, rfcname, :rfc, options)
+        end
 
-          outflag = case format
-            when :txt then "--text"
-            when :pdf then "--pdf"
-            when :html then "--html"
-          end
+        outext = { txt: ".txt", pdf: ".pdf", html: ".html" }[format]
+        outflag = { txt: "--text", pdf: "--pdf", html: "--html" }[format]
 
-          outname ||= inname.sub(/\.xml$/, outext)
-          system("xml2rfc #{outflag} #{rfcname} -o #{outname}")
-        else
-          super
-        end
+        outname ||= inname.sub(/\.xml$/, outext)
+        system("xml2rfc #{outflag} #{rfcname} -o #{outname}")
       end
     end
   end

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-   VERSION = "2.2.8".freeze
+    VERSION = "2.3.2".freeze
   end
 end

data/metanorma-ietf.gemspec

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "metanorma/ietf/version"
 
@@ -35,17 +35,18 @@ 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.8.0"
-  spec.add_dependency "isodoc", "~> 1.5.0"
+  spec.add_dependency "isodoc", "~> 1.6.0"
   spec.add_dependency "mathml2asciimath"
+  spec.add_dependency "metanorma-standoc", "~> 1.9.0"
+  spec.add_dependency "nokogiri", "~> 1.10.4"
 
   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"
-  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.6"
-  spec.add_development_dependency "rubocop", "~> 0.50"
+  spec.add_development_dependency "rubocop", "~> 1.5.2"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
   spec.add_development_dependency "vcr", "~> 5.0.0"

metadata

@@ -1,57 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ietf
 version: !ruby/object:Gem::Version
-  version: 2.2.8
+  version: 2.3.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-25 00:00:00.000000000 Z
+date: 2021-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: metanorma-standoc
+  name: isodoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
-  name: isodoc
+  name: mathml2asciimath
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: metanorma-standoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 1.9.0
 - !ruby/object:Gem::Dependency
-  name: mathml2asciimath
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.10.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.10.4
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: 1.5.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: 1.5.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -228,8 +242,6 @@ files:
 - ".hound.yml"
 - ".oss-guides.rubocop.yml"
 - ".rspec"
-- ".rubocop.ribose.yml"
-- ".rubocop.tb.yml"
 - ".rubocop.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -301,7 +313,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: metanorma-ietf lets you write IETF documents, such as Internet-Drafts and