metanorma-ietf 3.3.0 → 3.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 109aa7a03b031de0e72dabfabbe34735c822ebf0156ce74f1f2803b2f808d358
-  data.tar.gz: 3cf266330db5a81e0ef4e2efd5aae8ffb68261fe47d3780396102c740cf28c66
+  metadata.gz: 14265a284f4144c71da7f1e427b520cc6d0e34fe888cb368d0f05423fbbf7958
+  data.tar.gz: b4a6341006304c7bc49b73f12486dc54bf4e7bddee10a87ec16eff99832db7eb
 SHA512:
-  metadata.gz: a0b0e91046d7f9019bbfe911a3e21afbb2f5c26789e1d4de286a8898125fc607e4cdaa4d563806db6bbcaae3b4438f506d6ef46fe8272a52aba0edaf7e78e951
-  data.tar.gz: cd39365adb5279a71cdcddb42ba33e9a68cc54d5d1ca346128694adb58fb013da87b6b9ddaab7312ebd74eeec2b6c7e0ca72f1fc2246c99c17a39713c9ab5bac
+  metadata.gz: 4f980c68587bf34737ffe6c3117ed76ba6fc4a0b0db662dd75bf93d36ab19b82d0b1599f0179970da8e20d55afc72ad793d3f0c768a90610a90c40682f4508af
+  data.tar.gz: 88b4193027bbba65871acc89ea0bff8fbf06271fc6dc0888ce5f218fbebed3c74797a7edc8f65aa2c8b3d7ae63c40b3639dc17556b22ccbd486fa7dac969734c

data/lib/isodoc/ietf/blocks.rb

@@ -4,6 +4,7 @@ module IsoDoc
       def para_attrs(node)
         { keepWithNext: node["keep-with-next"],
           keepWithPrevious: node["keep-with-previous"],
+          indent: node["indent"],
           anchor: node["id"] }
       end
 
@@ -18,10 +19,9 @@ module IsoDoc
         node.xpath(ns("./note")).each { |n| parse(n, out) }
       end
 
-      # NOTE ignoring "bare" attribute, which is tantamount to "empty"
       def ul_attrs(node)
-        { anchor: node["id"],
-          empty: node["nobullet"],
+        { anchor: node["id"], empty: node["nobullet"],
+          indent: node["indent"], bare: node["bare"], 
           spacing: node["spacing"] }
       end
 
@@ -45,10 +45,9 @@ module IsoDoc
 
       def ol_attrs(node)
         { anchor: node["id"],
-          spacing: node["spacing"],
+          spacing: node["spacing"], indent: node["indent"],
           type: ol_style(node["type"]),
-          group: node["group"],
-          start: node["start"] }
+          group: node["group"], start: node["start"] }
       end
 
       def ol_parse(node, out)
@@ -58,25 +57,20 @@ module IsoDoc
       end
 
       def dl_attrs(node)
-        attr_code(anchor: node["id"],
-                  newline: node["newline"],
-                  indent: node["indent"],
-                  spacing: node["spacing"])
+        attr_code(anchor: node["id"], newline: node["newline"],
+                  indent: node["indent"], spacing: node["spacing"])
       end
 
       def dt_parse(dterm, term)
-        if dterm.elements.empty?
-          term << dterm.text
-        else
-          dterm.children.each { |n| parse(n, term) }
+        if dterm.elements.empty? then term << dterm.text
+        else dterm.children.each { |n| parse(n, term) }
         end
       end
 
       def note_label(node)
         n = @xrefs.get[node["id"]]
-        return l10n("#{@i18n.note}: ") if n.nil? || n[:label].nil? ||
-          n[:label].empty?
-
+        n.nil? || n[:label].nil? || n[:label].empty? and
+          return l10n("#{@i18n.note}: ")
         l10n("#{@i18n.note} #{n[:label]}: ")
       end
 
@@ -103,8 +97,7 @@ module IsoDoc
         div.t **attr_code(anchor: node["id"], keepWithNext: "true") do |p|
           lbl = if n.nil? || n[:label].nil? || n[:label].empty?
                   @i18n.example
-                else
-                  l10n("#{@i18n.example} #{n[:label]}")
+                else l10n("#{@i18n.example} #{n[:label]}")
                 end
           p << lbl
           name and !lbl.nil? and p << ": "
@@ -155,8 +148,7 @@ module IsoDoc
       end
 
       def formula_where(dlist, out)
-        return unless dlist
-
+        dlist or return
         out.t { |p| p << @i18n.where }
         parse(dlist, out)
       end
@@ -174,15 +166,14 @@ module IsoDoc
         formula_parse1(node, out)
         formula_where(node.at(ns("./dl")), out)
         node.children.each do |n|
-          next if %w(stem dl).include? n.name
-
+          %w(stem dl).include? n.name and next
           parse(n, out)
         end
       end
 
       def quote_attribution(node)
-        author = node&.at(ns("./author"))&.text
-        source = node&.at(ns("./source/@uri"))&.text
+        author = node.at(ns("./author"))&.text
+        source = node.at(ns("./source/@uri"))&.text
         attr_code(quotedFrom: author, cite: source)
       end
 
@@ -197,8 +188,7 @@ module IsoDoc
       def admonition_name(node, type)
         name = node&.at(ns("./name")) and return name
         name = Nokogiri::XML::Node.new("name", node.document)
-        return unless type && @i18n.admonition[type]
-
+        type && @i18n.admonition[type] or return
         name << @i18n.admonition[type]&.upcase
         name
       end
@@ -230,8 +220,7 @@ module IsoDoc
       end
 
       def figure_name_parse(_node, div, name)
-        return if name.nil?
-
+        name.nil? and return
         div.name do |_n|
           name.children.each { |n| parse(n, div) }
         end
@@ -242,9 +231,8 @@ module IsoDoc
       end
 
       def figure_parse(node, out)
-        return pseudocode_parse(node, out) if node["class"] == "pseudocode" ||
-          node["type"] == "pseudocode"
-
+        node["class"] == "pseudocode" || node["type"] == "pseudocode" and
+            return pseudocode_parse(node, out)
         @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

@@ -1,4 +1,5 @@
 require_relative "cleanup_inline"
+require_relative "cleanup_blocks"
 
 module IsoDoc
   module Ietf
@@ -21,20 +22,32 @@ module IsoDoc
       end
 
       def biblio_cleanup(xmldoc)
+        biblio_referencegroup_cleanup(xmldoc)
         biblio_abstract_cleanup(xmldoc)
         biblio_date_cleanup(xmldoc)
         biblio_refcontent_cleanup(xmldoc)
         annotation_cleanup(xmldoc)
       end
 
+      def biblio_referencegroup_cleanup(xmldoc)
+        xmldoc.xpath("//reference[ref-included]").each do |r|
+          r.name = "referencegroup"
+          r.elements.each do |e|
+            if e.name == "ref-included"
+              e.name = "reference"
+              e["anchor"] ||= "_#{UUIDTools::UUID.random_create}"
+            else e.remove
+            end
+          end
+        end
+      end
+
       def biblio_date_cleanup(xmldoc)
         xmldoc.xpath("//date[@cleanme]").each do |a|
           a.delete("cleanme")
           d = @c.decode(a.text).gsub(/–/, "-").sub(/-\d\d\d\d.*$/, "")
           if attrs = date_attr(d)
-            attrs.each do |k, v|
-              a[k] = v
-            end
+            attrs.each { |k, v| a[k] = v }
             a.children.remove
           else a.remove end
         end
@@ -67,14 +80,6 @@ module IsoDoc
         end.join
       end
 
-      def li_cleanup(xmldoc)
-        xmldoc.xpath("//li[t]").each do |li|
-          next unless li.elements.size == 1
-
-          li.children = li.elements[0].children
-        end
-      end
-
       def front_cleanup(xmldoc)
         xmldoc.xpath("//title").each { |s| s.children = s.text }
         xmldoc.xpath("//reference/front[not(author)]").each do |f|
@@ -82,170 +87,6 @@ module IsoDoc
           insert.next = "<author surname='Unknown'/>"
         end
       end
-
-      def table_footnote_cleanup(docxml)
-        docxml.xpath("//table[descendant::fn]").each do |t|
-          t.xpath(".//fn").each do |a|
-            t << "<aside>#{a.remove.children}</aside>"
-          end
-        end
-      end
-
-      def figure_footnote_cleanup(docxml)
-        docxml.xpath("//figure[descendant::fn]").each do |t|
-          t.xpath(".//fn").each do |a|
-            t << "<aside>#{a.remove.children}</aside>"
-          end
-        end
-      end
-
-      def table_cleanup(docxml)
-        table_footnote_cleanup(docxml)
-      end
-
-      def figure_cleanup(docxml)
-        figure_postamble(docxml)
-        figure_unnest(docxml)
-        figure_footnote_cleanup(docxml)
-        figure_data_uri(docxml)
-      end
-
-      def figure_data_uri(docxml)
-        docxml.xpath("//artwork").each do |a|
-          %r{^data:image/svg\+xml;base64}.match?(a["src"]) or next
-          f = Vectory::Utils::save_dataimage(a["src"])
-          a.delete("src")
-          a.children = File.read(f).sub(%r{<\?.+\?>}, "")
-        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
-
-      def figure_postamble(docxml)
-        make_postamble(docxml)
-        move_postamble(docxml)
-        move_preamble(docxml)
-      end
-
-      def make_postamble(docxml)
-        docxml.xpath("//figure").each do |f|
-          a = f.at("./artwork | ./sourcecode") || next
-          name = f.at("./name")&.remove
-          b = a.xpath("./preceding-sibling::*")&.remove
-          c = a.xpath("./following-sibling::*")&.remove
-          a = a.remove
-          name and f << name
-          b.empty? or f << "<preamble>#{to_xml(b)}</preamble>"
-          a and f << a
-          c.empty? or f << "<postamble>#{to_xml(c)}</postamble>"
-        end
-      end
-
-      def move_postamble(docxml)
-        docxml.xpath("//postamble").each do |p|
-          insert = p.parent
-          p.remove.elements.each do |e|
-            insert.next = e
-            insert = insert.next_element
-          end
-        end
-      end
-
-      def move_preamble(docxml)
-        docxml.xpath("//preamble").each do |p|
-          insert = p.parent
-          p.remove.elements.each do |e|
-            insert.previous = e
-          end
-        end
-      end
-
-      # for markup in pseudocode
-      def sourcecode_cleanup(docxml)
-        docxml.xpath("//sourcecode").each do |s|
-          s.children = to_xml(s.children).gsub(%r{<br/>\n}, "\n")
-            .gsub(%r{\s+(<t[ >])}, "\\1").gsub(%r{</t>\s+}, "</t>")
-          sourcecode_remove_markup(s)
-          s.children = "<![CDATA[#{HTMLEntities.new.decode(to_xml(s
-        .children).sub(/\A\n+/, ''))}]]>"
-        end
-      end
-
-      def sourcecode_remove_markup(node)
-        node.traverse do |n|
-          next if n.text?
-          next if %w(name callout annotation note sourcecode).include? n.name
-
-          case n.name
-          when "br" then n.replace("\n")
-          when "t" then n.replace("\n\n#{n.children}")
-          else
-            n.replace(n.children)
-          end
-        end
-      end
-
-      def annotation_cleanup(docxml)
-        docxml.xpath("//reference").each do |r|
-          while r.next_element&.name == "aside"
-            annotation_cleanup1(r)
-          end
-        end
-        docxml.xpath("//references/aside").each(&:remove)
-      end
-
-      def annotation_cleanup1(ref)
-        aside = ref.next_element
-        aside.name = "annotation"
-        aside.traverse do |n|
-          n.name == "t" and n.replace(n.children)
-        end
-        ref << aside
-      end
-
-      def deflist_cleanup(docxml)
-        dt_cleanup(docxml)
-        dd_cleanup(docxml)
-      end
-
-      def dt_cleanup(docxml)
-        docxml.xpath("//dt").each do |d|
-          d.first_element_child&.name == "bookmark" and
-            d["anchor"] ||= d.first_element_child["anchor"]
-          d.xpath(".//t").each do |t|
-            d["anchor"] ||= t["anchor"]
-            t.replace(t.children)
-          end
-        end
-      end
-
-      def dd_cleanup(docxml)
-        docxml.xpath("//dd").each do |d|
-          d&.first_element_child&.name == "bookmark" and
-            d["anchor"] ||= d.first_element_child["anchor"]
-        end
-      end
-
-      def aside_cleanup(docxml)
-        docxml.xpath("//*[aside]").each do |p|
-          %w(section).include?(p.name) and next
-          insert = p
-          p.xpath("./aside").each do |a|
-            insert.next = a.remove
-            insert = insert.next_element
-          end
-        end
-      end
     end
   end
 end

data/lib/isodoc/ietf/cleanup_blocks.rb

@@ -0,0 +1,174 @@
+module IsoDoc
+  module Ietf
+    class RfcConvert < ::IsoDoc::Convert
+      def li_cleanup(xmldoc)
+        xmldoc.xpath("//li[t]").each do |li|
+          li.elements.size == 1 or next
+          li.children = li.elements[0].children
+        end
+      end
+
+      def table_footnote_cleanup(docxml)
+        docxml.xpath("//table[descendant::fn]").each do |t|
+          t.xpath(".//fn").each do |a|
+            t << "<aside>#{a.remove.children}</aside>"
+          end
+        end
+      end
+
+      def figure_footnote_cleanup(docxml)
+        docxml.xpath("//figure[descendant::fn]").each do |t|
+          t.xpath(".//fn").each do |a|
+            t << "<aside>#{a.remove.children}</aside>"
+          end
+        end
+      end
+
+      def table_cleanup(docxml)
+        table_footnote_cleanup(docxml)
+      end
+
+      def figure_cleanup(docxml)
+        figure_postamble(docxml)
+        figure_unnest(docxml)
+        figure_footnote_cleanup(docxml)
+        figure_data_uri(docxml)
+      end
+
+      def figure_data_uri(docxml)
+        docxml.xpath("//artwork").each do |a|
+          %r{^data:image/svg\+xml;base64}.match?(a["src"]) or next
+          f = Vectory::Utils::save_dataimage(a["src"])
+          a.delete("src")
+          a.children = File.read(f).sub(%r{<\?.+\?>}, "")
+        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
+
+      def figure_postamble(docxml)
+        make_postamble(docxml)
+        move_postamble(docxml)
+        move_preamble(docxml)
+      end
+
+      def make_postamble(docxml)
+        docxml.xpath("//figure").each do |f|
+          a = f.at("./artwork | ./sourcecode") || next
+          name = f.at("./name")&.remove
+          b = a.xpath("./preceding-sibling::*")&.remove
+          c = a.xpath("./following-sibling::*")&.remove
+          a = a.remove
+          name and f << name
+          b.empty? or f << "<preamble>#{to_xml(b)}</preamble>"
+          a and f << a
+          c.empty? or f << "<postamble>#{to_xml(c)}</postamble>"
+        end
+      end
+
+      def move_postamble(docxml)
+        docxml.xpath("//postamble").each do |p|
+          insert = p.parent
+          p.remove.elements.each do |e|
+            insert.next = e
+            insert = insert.next_element
+          end
+        end
+      end
+
+      def move_preamble(docxml)
+        docxml.xpath("//preamble").each do |p|
+          insert = p.parent
+          p.remove.elements.each do |e|
+            insert.previous = e
+          end
+        end
+      end
+
+      # for markup in pseudocode
+      def sourcecode_cleanup(docxml)
+        docxml.xpath("//sourcecode").each do |s|
+          s.children = to_xml(s.children).gsub(%r{<br/>\n}, "\n")
+            .gsub(%r{\s+(<t[ >])}, "\\1").gsub(%r{</t>\s+}, "</t>")
+          sourcecode_remove_markup(s)
+          s.children = "<![CDATA[#{@c.decode(to_xml(s.children)
+            .sub(/\A\n+/, ''))}]]>"
+        end
+      end
+
+      def sourcecode_remove_markup(node)
+        node.traverse do |n|
+          n.text? and next
+          %w(name callout annotation note sourcecode).include? n.name and next
+          case n.name
+          when "br" then n.replace("\n")
+          when "t" then n.replace("\n\n#{n.children}")
+          else n.replace(n.children)
+          end
+        end
+      end
+
+      def annotation_cleanup(docxml)
+        docxml.xpath("//reference").each do |r|
+          while r.next_element&.name == "aside"
+            annotation_cleanup1(r)
+          end
+        end
+        docxml.xpath("//references/aside").each(&:remove)
+      end
+
+      def annotation_cleanup1(ref)
+        aside = ref.next_element
+        aside.name = "annotation"
+        aside.traverse do |n|
+          n.name == "t" and n.replace(n.children)
+        end
+        ref << aside
+      end
+
+      def deflist_cleanup(docxml)
+        dt_cleanup(docxml)
+        dd_cleanup(docxml)
+      end
+
+      def dt_cleanup(docxml)
+        docxml.xpath("//dt").each do |d|
+          d.first_element_child&.name == "bookmark" and
+            d["anchor"] ||= d.first_element_child["anchor"]
+          d.xpath(".//t").each do |t|
+            d["anchor"] ||= t["anchor"]
+            t.replace(t.children)
+          end
+        end
+      end
+
+      def dd_cleanup(docxml)
+        docxml.xpath("//dd").each do |d|
+          d&.first_element_child&.name == "bookmark" and
+            d["anchor"] ||= d.first_element_child["anchor"]
+        end
+      end
+
+      def aside_cleanup(docxml)
+        docxml.xpath("//*[aside]").each do |p|
+          %w(section).include?(p.name) and next
+          insert = p
+          p.xpath("./aside").each do |a|
+            insert.next = a.remove
+            insert = insert.next_element
+          end
+        end
+      end
+    end
+  end
+end