metanorma-ietf 3.5.0 → 3.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 390603e9e2284f8f9d4a296e2b2477145d68db6860bf89518bf12a38eaec4de6
-  data.tar.gz: ecb70e48ac54f68e4b486aafdc0af99792834dcedc781e94da78b88a75ddb0cd
+  metadata.gz: da1665019f44fcc0eb18a283049b279819b7e185818f1f0722c7933c92a226aa
+  data.tar.gz: 4b4defd2a8b051c5174f3f45c93035b7eee50b812448863f42f8eb435f126b0f
 SHA512:
-  metadata.gz: 90f627b63a727c2a022db91718237058c8309b892bd39cbc5991685a8daa6362639503caf8cc06fd60eabcb0bb3b36a671fbd9d018e00e7fe41f11261b4f4fea
-  data.tar.gz: e6178e44010dbbddf74aa1b4120a3be44e1c24dc076577a70751a58e88cb7ebfa0b0cc9bf3a1b666776c7afb2b883516e00edc93099a14f7ac966039cfc0698e
+  metadata.gz: f80bd6987bc38d3dedd539c2573bfd458cdbb9911a03370f0e7a5bc40804076c6bb28e15fa970fe90473c7827aa8f29b77aec5d66ee6533da7a1d284cda4987e
+  data.tar.gz: 4caff92a476ea68f7a99112c808c6f09344a3f2f2e38f9dd56dfc462ae23f948cbedce37532f2f82e02b2fbf8c2e950b7bec2882ab5c09b903f4d201fb2a0183

data/lib/isodoc/ietf/blocks.rb

@@ -19,86 +19,6 @@ module IsoDoc
         node.xpath(ns("./note")).each { |n| parse(n, out) }
       end
 
-      def ul_attrs(node)
-        { anchor: node["id"], empty: node["nobullet"],
-          indent: node["indent"], bare: node["bare"],
-          spacing: node["spacing"] }
-      end
-
-      def ul_parse(node, out)
-        out.ul **attr_code(ul_attrs(node)) do |ul|
-          node.children.each { |n| parse(n, ul) }
-        end
-      end
-
-      OL_STYLE = {
-        arabic: "1",
-        roman: "i",
-        alphabet: "a",
-        roman_upper: "I",
-        alphabet_upper: "A",
-      }.freeze
-
-      def ol_style(type)
-        OL_STYLE[type&.to_sym] || type
-      end
-
-      def ol_attrs(node)
-        { anchor: node["id"],
-          spacing: node["spacing"], indent: node["indent"],
-          type: ol_style(node["type"]),
-          group: node["group"], start: node["start"] }
-      end
-
-      def ol_parse(node, out)
-        out.ol **attr_code(ol_attrs(node)) do |ol|
-          node.children.each { |n| parse(n, ol) }
-        end
-      end
-
-      def dl_attrs(node)
-        attr_code(anchor: node["id"], newline: node["newline"],
-                  indent: node["indent"], spacing: node["spacing"])
-      end
-
-      def dl_parse(node, out)
-        list_title_parse(node, out)
-        out.dl **dl_attrs(node) do |v|
-          node.elements.select { |n| dt_dd? n }.each_slice(2) do |dt, dd|
-            dl_parse1(v, dt, dd)
-          end
-        end
-        dl_parse_notes(node, out)
-      end
-
-      def dt_parse(dterm, term)
-        if dterm.elements.empty? then term << dterm.text
-        else dterm.children.each { |n| parse(n, term) }
-        end
-      end
-
-      def dl_parse1(dlist, dterm, ddef)
-        dlist.dt **attr_code(anchor: dterm["id"]) do |term|
-          dt_parse(dterm, term)
-        end
-        dlist.dd **attr_code(anchor: ddef["id"]) do |listitem|
-          ddef.children.each { |n| parse(n, listitem) }
-        end
-      end
-
-      def li_parse(node, out)
-        out.li **attr_code(anchor: node["id"]) do |li|
-          if node["uncheckedcheckbox"] == "true"
-            li << '<span class="zzMoveToFollowing">' \
-                  '<input type="checkbox" checked="checked"/></span>'
-          elsif node["checkedcheckbox"] == "true"
-            li << '<span class="zzMoveToFollowing">' \
-                  '<input type="checkbox"/></span>'
-          end
-          node.children.each { |n| parse(n, li) }
-        end
-      end
-
       def note_label(node)
         n = @xrefs.get[node["id"]]
         n.nil? || n[:label].nil? || n[:label].empty? and
@@ -142,12 +62,12 @@ module IsoDoc
       end
 
       def sourcecode_parse(node, out)
+        b = node.at(ns("./body"))
         out.sourcecode **attr_code(
           anchor: node["id"], type: node["lang"], name: node["filename"],
           markers: node["markers"], src: node["src"]
         ) do |s|
-          node.children.each do |x|
-            %w(name dl).include?(x.name) and next
+          b&.children&.each do |x|
             parse(x, s)
           end
         end
@@ -261,7 +181,15 @@ module IsoDoc
       end
 
       def pseudocode_parse(node, out)
-        sourcecode_parse(node, out)
+        out.sourcecode **attr_code(
+          anchor: node["id"], type: node["lang"], name: node["filename"],
+          markers: node["markers"], src: node["src"]
+        ) do |s|
+          node.children.each do |x|
+            %w(name dl).include?(x.name) and next
+            parse(x, s)
+          end
+        end
       end
 
       def figure_parse(node, out)

data/lib/isodoc/ietf/lists.rb

@@ -0,0 +1,85 @@
+module IsoDoc
+  module Ietf
+    class RfcConvert < ::IsoDoc::Convert
+      def ul_attrs(node)
+        { anchor: node["id"], empty: node["nobullet"],
+          indent: node["indent"], bare: node["bare"],
+          spacing: node["spacing"] }
+      end
+
+      def ul_parse(node, out)
+        out.ul **attr_code(ul_attrs(node)) do |ul|
+          node.children.each { |n| parse(n, ul) }
+        end
+      end
+
+      OL_STYLE = {
+        arabic: "1",
+        roman: "i",
+        alphabet: "a",
+        roman_upper: "I",
+        alphabet_upper: "A",
+      }.freeze
+
+      def ol_style(type)
+        OL_STYLE[type&.to_sym] || type
+      end
+
+      def ol_attrs(node)
+        { anchor: node["id"],
+          spacing: node["spacing"], indent: node["indent"],
+          type: ol_style(node["type"]),
+          group: node["group"], start: node["start"] }
+      end
+
+      def ol_parse(node, out)
+        out.ol **attr_code(ol_attrs(node)) do |ol|
+          node.children.each { |n| parse(n, ol) }
+        end
+      end
+
+      def dl_attrs(node)
+        attr_code(anchor: node["id"], newline: node["newline"],
+                  indent: node["indent"], spacing: node["spacing"])
+      end
+
+      def dl_parse(node, out)
+        list_title_parse(node, out)
+        out.dl **dl_attrs(node) do |v|
+          node.elements.select { |n| dt_dd? n }.each_slice(2) do |dt, dd|
+            dl_parse1(v, dt, dd)
+          end
+        end
+        dl_parse_notes(node, out)
+      end
+
+      def dt_parse(dterm, term)
+        if dterm.elements.empty? then term << dterm.text
+        else dterm.children.each { |n| parse(n, term) }
+        end
+      end
+
+      def dl_parse1(dlist, dterm, ddef)
+        dlist.dt **attr_code(anchor: dterm["id"]) do |term|
+          dt_parse(dterm, term)
+        end
+        dlist.dd **attr_code(anchor: ddef["id"]) do |listitem|
+          ddef.children.each { |n| parse(n, listitem) }
+        end
+      end
+
+      def li_parse(node, out)
+        out.li **attr_code(anchor: node["id"]) do |li|
+          if node["uncheckedcheckbox"] == "true"
+            li << '<span class="zzMoveToFollowing">' \
+                  '<input type="checkbox" checked="checked"/></span>'
+          elsif node["checkedcheckbox"] == "true"
+            li << '<span class="zzMoveToFollowing">' \
+                  '<input type="checkbox"/></span>'
+          end
+          node.children.each { |n| parse(n, li) }
+        end
+      end
+    end
+  end
+end

data/lib/isodoc/ietf/rfc_convert.rb

@@ -1,5 +1,6 @@
 require_relative "./terms"
 require_relative "./blocks"
+require_relative "./lists"
 require_relative "./metadata"
 require_relative "./front"
 require_relative "./table"
@@ -67,7 +68,8 @@ module IsoDoc
         when "bcp14" then bcp14_parse(node, out)
         when "concept" then concept_parse(node, out)
         when "display-text" then display_text_parse(node, out)
-        when "verbal-definition", "non-verbal-representation", "fmt-provision"
+        when "verbal-definition", "non-verbal-representation",
+          "fmt-provision"
           node.elements.each { |n| parse(n, out) }
         else
           text = node.to_xml.gsub(/</, "&lt;").gsub(/>/, "&gt;")

data/lib/metanorma/ietf/basicdoc.rng

@@ -599,17 +599,9 @@ It is included for convenience, in case processing the citation to extract the a
         <a:documentation>The caption of the block</a:documentation>
       </ref>
     </optional>
-    <oneOrMore>
-      <choice>
-        <text>
-          <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
-(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
-        </text>
-        <ref name="callout">
-          <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
-        </ref>
-      </choice>
-    </oneOrMore>
+    <ref name="sourcecodebody">
+      <a:documentation>The sourcecode content</a:documentation>
+    </ref>
     <zeroOrMore>
       <ref name="annotation">
         <a:documentation>Annotations to the source code; each annotation consists of zero or more paragraphs,
@@ -628,17 +620,9 @@ and is intended to be referenced by a callout within the source code</a:document
         <a:documentation>The caption of the block</a:documentation>
       </ref>
     </optional>
-    <oneOrMore>
-      <choice>
-        <text>
-          <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
-(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
-        </text>
-        <ref name="callout">
-          <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
-        </ref>
-      </choice>
-    </oneOrMore>
+    <ref name="sourcecodebody">
+      <a:documentation>The sourcecode content</a:documentation>
+    </ref>
     <zeroOrMore>
       <ref name="annotation">
         <a:documentation>Annotations to the source code; each annotation consists of zero or more paragraphs,
@@ -651,6 +635,20 @@ and is intended to be referenced by a callout within the source code</a:document
       </ref>
     </zeroOrMore>
   </define>
+  <define name="sourcecodebody">
+    <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
+(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
+    <element name="body">
+      <oneOrMore>
+        <choice>
+          <text/>
+          <ref name="callout">
+            <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
+          </ref>
+        </choice>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="pre">
     <a:documentation>Pre-formatted block. Wrapper for text to be rendered with fixed-width typeface, and preserving spaces including line breaks. 
 They are intended for a restricted number of functions, most typically ASCII Art (which is still in prominent use in some 
@@ -1672,18 +1670,25 @@ which can be bookmarks as well as block or section references</a:documentation>
     </optional>
   </define>
   <define name="XrefBody">
-    <oneOrMore>
-      <ref name="PureTextElement">
-        <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
-      </ref>
-    </oneOrMore>
+    <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
+    <optional>
+      <element name="display-text">
+        <oneOrMore>
+          <ref name="PureTextElement"/>
+        </oneOrMore>
+      </element>
+    </optional>
   </define>
   <define name="ErefBody">
-    <oneOrMore>
-      <ref name="PureTextElement">
-        <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
-      </ref>
-    </oneOrMore>
+    <optional>
+      <element name="display-text">
+        <oneOrMore>
+          <ref name="PureTextElement">
+            <a:documentation>The textual content of the element. The `text` is what we wish to show the link as (e.g., the "content" of `&lt;xx&gt;my link text&lt;/xx&gt;`)</a:documentation>
+          </ref>
+        </oneOrMore>
+      </element>
+    </optional>
   </define>
   <define name="fn">
     <a:documentation>Inline reference to a paragraph or paragraphs, appearing as a footnote.

data/lib/metanorma/ietf/front.rb

@@ -35,7 +35,7 @@ module Metanorma
           xml.title **attr_code(at.merge(type: "main")) do |t|
             t << (::Metanorma::Utils::asciidoc_sub(node.attr("title")) ||
               ::Metanorma::Utils::asciidoc_sub(node.attr("title-en")) ||
-              node.title)
+              ::Metanorma::Utils::asciidoc_sub(node.attr("doctitle")))
           end
           a = node.attr("abbrev") and
             xml.title a, **attr_code(at.merge(type: "abbrev"))

data/lib/metanorma/ietf/isodoc.rng

@@ -245,23 +245,9 @@
           <a:documentation>The caption of the block</a:documentation>
         </ref>
       </optional>
-      <oneOrMore>
-        <choice>
-          <text>
-            <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
-(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
-          </text>
-          <ref name="callout">
-            <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
-          </ref>
-          <ref name="xref">
-            <a:documentation>Hyperlink of code segment to another part of the document</a:documentation>
-          </ref>
-          <ref name="eref">
-            <a:documentation>Hyperlink of code segment to external bibliographic resource</a:documentation>
-          </ref>
-        </choice>
-      </oneOrMore>
+      <ref name="sourcecodebody">
+        <a:documentation>The sourcecode content</a:documentation>
+      </ref>
       <zeroOrMore>
         <ref name="annotation">
           <a:documentation>Annotations to the source code; each annotation consists of zero or more paragraphs,
@@ -277,6 +263,26 @@ and is intended to be referenced by a callout within the source code</a:document
         <a:documentation>A source for the block</a:documentation>
       </ref>
     </define>
+    <define name="sourcecodebody">
+      <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
+(The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
+      <element name="body">
+        <oneOrMore>
+          <choice>
+            <text/>
+            <ref name="callout">
+              <a:documentation>Zero or more cross-references; these are intended to be embedded within the content string, and link to annotations</a:documentation>
+            </ref>
+            <ref name="xref">
+              <a:documentation>Hyperlink of code segment to another part of the document</a:documentation>
+            </ref>
+            <ref name="eref">
+              <a:documentation>Hyperlink of code segment to external bibliographic resource</a:documentation>
+            </ref>
+          </choice>
+        </oneOrMore>
+      </element>
+    </define>
     <define name="sections">
       <element name="sections">
         <oneOrMore>

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-    VERSION = "3.5.0".freeze
+    VERSION = "3.5.1".freeze
   end
 end

data/lib/relaton/render/parse.rb

@@ -115,6 +115,7 @@ module Relaton
 
         def stream(doc)
           a = doc.series.detect { |s| s.type == "stream" } or return nil
+          a.title&.title&.content == "Legacy" and return nil
           series_title(a, doc)
         end
 

data/metanorma-ietf.gemspec

@@ -46,7 +46,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard-rspec", "~> 4.7"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.6"
-  spec.add_development_dependency "rubocop", "~> 1.5.2"
+  spec.add_development_dependency "rubocop", "~> 1"
+spec.add_development_dependency "rubocop-performance"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
   spec.add_development_dependency "vcr", "~> 6.1.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ietf
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.5.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-17 00:00:00.000000000 Z
+date: 2025-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-ietf-data
@@ -142,14 +142,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.2
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -258,6 +272,7 @@ files:
 - lib/isodoc/ietf/i18n.rb
 - lib/isodoc/ietf/init.rb
 - lib/isodoc/ietf/inline.rb
+- lib/isodoc/ietf/lists.rb
 - lib/isodoc/ietf/metadata.rb
 - lib/isodoc/ietf/references.rb
 - lib/isodoc/ietf/reqt.rb
@@ -313,7 +328,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.27
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: metanorma-ietf lets you write IETF documents, such as Internet-Drafts and