metanorma-ietf 3.0.0 → 3.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6252e62c4528b954e8b212f8f4ecbd2743cf92ce0826851141e9bb5625a33b65
-  data.tar.gz: 54297c4b4d966720210747f55c42f67dbaf8154cb6c4638c7c8714aebf43d032
+  metadata.gz: 99a9015764516ae9e7eaac9862c48e49facb45c08e3b68744d11cb0b698a0921
+  data.tar.gz: 5c445117afb3a242d18973a99ec0eabeb4c0cfe582bf19da1e38a35657dfa366
 SHA512:
-  metadata.gz: 3ba0e479fa11a65a1be98cdf6b18546fc4e633411e94ad8f23fc02492eb027018648abdef26ac81c4f5faed351c70d5871d3446017811c8621c33ba75a5899d8
-  data.tar.gz: 5381ff67f5acd1050032ee09a128e1e466fcae7624d8e3be8d1508ba401a158df4caadea2859f0cbb99ac46d32a41430f1d9f3c9ee145c0e8706cea799f307eb
+  metadata.gz: '0316278f956b44dbe26db8bdb236c5e42b30228c06552de7b78c61530800d46f1d00918d7f4c7bf13b76a518d8960fd204375ec2a5f6aa271f5ea3ce10f06b26'
+  data.tar.gz: bd4b8b4489cac7307aeee01b002a6a6db32f567489da41d6385522ab21ec6081c1c9f29f3110b3f3ed29a03e7c93be5fb603d3bb228d7aef23cfd75447c7a45b

data/lib/isodoc/ietf/inline.rb

@@ -107,10 +107,10 @@ module IsoDoc
       end
 
       def get_linkend(node)
-        contents = node.children.reject do |c|
-                     %w{locality localityStack}.include? c.name
-                   end
-          .select { |c| !c.text? || /\S/.match(c) }
+        no_loc_contents = node.children.reject do |c|
+          %w{locality localityStack location}.include? c.name
+        end
+        contents = no_loc_contents.select { |c| !c.text? || /\S/.match(c) }
         !contents.empty? and
           return Nokogiri::XML::NodeSet.new(node.document, contents).to_xml
         ""
@@ -122,9 +122,10 @@ module IsoDoc
         end
         relative = node["relative"] ||
           node.at(ns(".//locality[@type = 'anchor']/referenceFrom"))&.text || ""
-        section = eref_clause(node.xpath(ns("./locality | ./localityStack")),
-                              nil) || ""
-        #section = "" unless relative.empty?
+        section = @isodoc.eref_localities(
+          node.xpath(ns("./locality | ./localityStack")), nil, node
+        )&.sub(/^,/, "")&.sub(/^\s*(Section|Clause)/, "")&.strip&.sub(/,$/, "") || ""
+        # section = "" unless relative.empty?
         out.relref **attr_code(target: node["bibitemid"], section: section,
                                relative: relative,
                                displayFormat: node["displayFormat"]) do |l|
@@ -132,30 +133,6 @@ module IsoDoc
                                end
       end
 
-      def eref_clause(refs, target)
-        ret = []
-        ret1 = ""
-        refs.each do |l|
-          if l.name == "localityStack"
-            ret << ret1
-            ret1 = ""
-            ret << eref_clause1(l.elements, target)
-          else ret1 += eref_clause1([l], target)
-          end
-        end
-        ret << ret1
-        ret.reject { |c| c.nil? || c.empty? }.join("; ")
-      end
-
-      def eref_clause1(refs, _target)
-        refs.each do |l|
-          next unless %w(clause section).include? l["type"]
-
-          return l&.at(ns("./referenceFrom"))&.text
-        end
-        ""
-      end
-
       def index_parse(node, out)
         out.iref nil, **attr_code(item: node.at(ns("./primary")).text,
                                   primary: node["primary"],

data/lib/isodoc/ietf/references.rb

@@ -67,7 +67,7 @@ module IsoDoc
           u["type"] == "DOI" and
             out.seriesInfo nil, **attr_code(value: u.text.sub(/^DOI /, ""),
                                             name: "DOI")
-          u["type"] == "IETF" and docidentifier_ietf(u, out)
+          %w(IETF RFC).include?(u["type"]) and docidentifier_ietf(u, out)
         end
       end
 

data/lib/isodoc/ietf/rfc_convert.rb

@@ -13,85 +13,89 @@ require_relative "./validation"
 require_relative "./xref"
 require_relative "./init"
 
-module IsoDoc::Ietf
-  class RfcConvert < ::IsoDoc::Convert
-    def convert1(docxml, _filename, _dir)
-      @xrefs.parse docxml
-      info docxml, nil
-      xml = noko do |xml|
-        xml.rfc **attr_code(rfc_attributes(docxml)) do |html|
-          make_link(html, docxml)
-          make_front(html, docxml)
-          make_middle(html, docxml)
-          make_back(html, docxml)
-        end
-      end.join("\n").sub(/<!DOCTYPE[^>]+>\n/, "")
-      set_pis(docxml, Nokogiri::XML(xml))
-    end
+module IsoDoc
+  module Ietf
+    class RfcConvert < ::IsoDoc::Convert
+      def convert1(docxml, _filename, _dir)
+        @xrefs.parse docxml
+        info docxml, nil
+        ret = noko do |xml|
+          xml.rfc **attr_code(rfc_attributes(docxml)) do |html|
+            make_link(html, docxml)
+            make_front(html, docxml)
+            make_middle(html, docxml)
+            make_back(html, docxml)
+          end
+        end.join("\n").sub(/<!DOCTYPE[^>]+>\n/, "")
+        set_pis(docxml, Nokogiri::XML(ret))
+      end
 
-    def metadata_init(lang, script, i18n)
-      @meta = Metadata.new(lang, script, i18n)
-    end
+      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 xref_init(lang, script, klass, i18n, options)
+        @xrefs = Xref.new(lang, script, klass, i18n, options)
+      end
 
-    def extract_delims(text)
-      @openmathdelim = "$$"
-      @closemathdelim = "$$"
-      while %r{#{Regexp.escape(@openmathdelim)}}m.match(text) ||
-          %r{#{Regexp.escape(@closemathdelim)}}m.match(text)
-        @openmathdelim += "$"
-        @closemathdelim += "$"
+      def extract_delims(text)
+        @openmathdelim = "$$"
+        @closemathdelim = "$$"
+        while %r{#{Regexp.escape(@openmathdelim)}}m.match(text) ||
+            %r{#{Regexp.escape(@closemathdelim)}}m.match(text)
+          @openmathdelim += "$"
+          @closemathdelim += "$"
+        end
+        [@openmathdelim, @closemathdelim]
       end
-      [@openmathdelim, @closemathdelim]
-    end
 
-    def error_parse(node, out)
-      case node.name
-      when "bcp14" then bcp14_parse(node, out)
-      when "concept" then concept_parse(node, out)
-      when "verbal-definition", "non-verbal-representation"
-        node.elements.each { |n| parse(n, out) }
-      else
-        text = node.to_xml.gsub(/</, "&lt;").gsub(/>/, "&gt;")
-        out.t { |p| p << text }
+      def error_parse(node, out)
+        case node.name
+        when "bcp14" then bcp14_parse(node, out)
+        when "concept" then concept_parse(node, out)
+        when "verbal-definition", "non-verbal-representation"
+          node.elements.each { |n| parse(n, out) }
+        else
+          text = node.to_xml.gsub(/</, "&lt;").gsub(/>/, "&gt;")
+          out.t { |p| p << text }
+        end
       end
-    end
 
-    def omit_docid_prefix(prefix)
-      return true if prefix == "IETF"
+      def omit_docid_prefix(prefix)
+        return true if %w(IETF RFC).include?(prefix)
 
-      super
-    end
+        super
+      end
 
-    def textcleanup(docxml)
-      passthrough_cleanup(docxml)
-    end
+      def textcleanup(docxml)
+        passthrough_cleanup(docxml)
+      end
 
-    def postprocess(result, filename, _dir)
-      result = from_xhtml(cleanup(to_xhtml(textcleanup(result))))
-        .sub(/<!DOCTYPE[^>]+>\n/, "")
-        .sub(/(<rfc[^<]+? )lang="[^"]+"/, "\\1")
-      File.open(filename, "w:UTF-8") { |f| f.write(result) }
-      schema_validate(filename)
-      @files_to_delete.each { |f| FileUtils.rm_rf f }
-      content_validate(to_xhtml(result), filename)
-    end
+      def postprocess(result, filename, _dir)
+        result = from_xhtml(cleanup(to_xhtml(textcleanup(result))))
+          .sub(/<!DOCTYPE[^>]+>\n/, "")
+          .sub(/(<rfc[^<]+? )lang="[^"]+"/, "\\1")
+        File.open(filename, "w:UTF-8") { |f| f.write(result) }
+        schema_validate(filename)
+        @files_to_delete.each { |f| FileUtils.rm_rf f }
+        content_validate(to_xhtml(result), filename)
+      end
 
-    def init_file(filename, debug)
-      filename = filename.sub(/\.rfc\.xml$/, ".rfc")
-      super
-    end
+      def init_file(filename, debug)
+        filename = filename.sub(/\.rfc\.xml$/, ".rfc")
+        super
+      end
 
-    def initialize(options)
-      super
-      @xinclude = options[:use_xinclude] == "true"
-      @format = :rfc
-      @suffix = "rfc.xml"
-    end
+      def initialize(options)
+        super
+        @xinclude = options[:use_xinclude] == "true"
+        @format = :rfc
+        @suffix = "rfc.xml"
+        @isodoc = IsoDoc::PresentationXMLConvert.new({})
+        @isodoc.i18n_init("en", "Latn")
+      end
 
-    include ::IsoDoc::Ietf::Init
+      include ::IsoDoc::Ietf::Init
+    end
   end
 end

data/lib/isodoc/ietf/terms.rb

@@ -47,7 +47,7 @@ module IsoDoc
       def termdef_parse(node, out)
         set_termdomain("")
         node.xpath(ns("./definition")).size > 1 and
-          IsoDoc::PresentationXMLConvert.new({}).multidef(node)
+          @isodoc.multidef(node)
         clause_parse(node, out)
       end
 

data/lib/isodoc/ietf/xref.rb

@@ -6,9 +6,10 @@ module IsoDoc
       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 = 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)

data/lib/metanorma/ietf/basicdoc.rng

@@ -173,9 +173,11 @@
           <data type="dateTime"/>
         </attribute>
       </optional>
-      <attribute name="from">
-        <data type="IDREF"/>
-      </attribute>
+      <optional>
+        <attribute name="from">
+          <data type="IDREF"/>
+        </attribute>
+      </optional>
       <optional>
         <attribute name="to">
           <data type="IDREF"/>

data/lib/metanorma/ietf/biblio.rng

@@ -209,9 +209,6 @@
       <zeroOrMore>
         <ref name="contact"/>
       </zeroOrMore>
-      <zeroOrMore>
-        <ref name="uri"/>
-      </zeroOrMore>
     </element>
   </define>
   <define name="fullname">
@@ -401,9 +398,9 @@
       <choice>
         <!-- iso191606 TODO -->
         <group>
-          <oneOrMore>
+          <zeroOrMore>
             <ref name="street"/>
-          </oneOrMore>
+          </zeroOrMore>
           <ref name="city"/>
           <optional>
             <ref name="state"/>
@@ -828,6 +825,11 @@
       <optional>
         <attribute name="scope"/>
       </optional>
+      <optional>
+        <attribute name="primary">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
       <text/>
     </element>
   </define>

data/lib/metanorma/ietf/cleanup.rb

@@ -43,11 +43,11 @@ module Metanorma
       end
 
       def rfc_anchor_cleanup(xml)
-        map = xml.xpath("//bibitem[docidentifier[@type = 'IETF']"\
+        map = xml.xpath("//bibitem[docidentifier[@type = 'IETF' or @type = 'RFC']"\
                         "[@scope = 'anchor']]").each_with_object({}) do |b, m|
           next if b.at("./ancestor::bibdata | ./ancestor::bibitem")
 
-          id = b.at("./docidentifier[@type = 'IETF'][@scope = 'anchor']").text
+          id = b.at("./docidentifier[@type = 'IETF' or @type = 'RFC'][@scope = 'anchor']").text
           m[b["id"]] = id
           b["id"] = id
         end

data/lib/metanorma/ietf/ietf.rng

@@ -345,7 +345,7 @@
         <optional>
           <attribute name="format"/>
         </optional>
-        <text/>
+        <ref name="XrefBody"/>
       </element>
     </define>
     <define name="erefType">

data/lib/metanorma/ietf/isodoc.rng

@@ -32,6 +32,43 @@
         <ref name="DocumentType"/>
       </element>
     </define>
+    <define name="index">
+      <element name="index">
+        <optional>
+          <attribute name="to">
+            <data type="IDREF"/>
+          </attribute>
+        </optional>
+        <element name="primary">
+          <oneOrMore>
+            <choice>
+              <ref name="PureTextElement"/>
+              <ref name="stem"/>
+            </choice>
+          </oneOrMore>
+        </element>
+        <optional>
+          <element name="secondary">
+            <oneOrMore>
+              <choice>
+                <ref name="PureTextElement"/>
+                <ref name="stem"/>
+              </choice>
+            </oneOrMore>
+          </element>
+        </optional>
+        <optional>
+          <element name="tertiary">
+            <oneOrMore>
+              <choice>
+                <ref name="PureTextElement"/>
+                <ref name="stem"/>
+              </choice>
+            </oneOrMore>
+          </element>
+        </optional>
+      </element>
+    </define>
     <define name="bibitem">
       <element name="bibitem">
         <attribute name="id">
@@ -115,9 +152,7 @@
             <data type="boolean"/>
           </attribute>
         </optional>
-        <oneOrMore>
-          <ref name="PureTextElement"/>
-        </oneOrMore>
+        <ref name="XrefBody"/>
       </element>
     </define>
     <define name="erefType">
@@ -151,6 +186,42 @@
         <ref name="PureTextElement"/>
       </oneOrMore>
     </define>
+    <define name="localityStack">
+      <element name="localityStack">
+        <optional>
+          <attribute name="connective">
+            <choice>
+              <value>and</value>
+              <value>or</value>
+              <value>from</value>
+              <value>to</value>
+              <value/>
+            </choice>
+          </attribute>
+        </optional>
+        <zeroOrMore>
+          <ref name="locality"/>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="sourceLocalityStack">
+      <element name="sourceLocalityStack">
+        <optional>
+          <attribute name="connective">
+            <choice>
+              <value>and</value>
+              <value>or</value>
+              <value>from</value>
+              <value>to</value>
+              <value/>
+            </choice>
+          </attribute>
+        </optional>
+        <zeroOrMore>
+          <ref name="sourceLocality"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="ul">
       <element name="ul">
         <attribute name="id">
@@ -1027,6 +1098,26 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="sub">
+      <element name="sub">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="sup">
+      <element name="sup">
+        <zeroOrMore>
+          <choice>
+            <ref name="PureTextElement"/>
+            <ref name="stem"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="pagebreak">
       <element name="pagebreak">
         <optional>
@@ -1041,6 +1132,16 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="image" combine="choice">
+    <element name="svg">
+      <oneOrMore>
+        <choice>
+          <text/>
+          <ref name="AnyElement"/>
+        </choice>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="MultilingualRenderingType">
     <choice>
       <value>common</value>
@@ -2216,7 +2317,18 @@
           <ref name="MultilingualRenderingType"/>
         </attribute>
       </optional>
-      <ref name="paragraph"/>
+      <oneOrMore>
+        <choice>
+          <ref name="formula"/>
+          <ref name="ul"/>
+          <ref name="ol"/>
+          <ref name="dl"/>
+          <ref name="quote"/>
+          <ref name="sourcecode"/>
+          <ref name="paragraph"/>
+          <ref name="figure"/>
+        </choice>
+      </oneOrMore>
     </element>
   </define>
   <define name="termsource">
@@ -2563,4 +2675,30 @@
       </zeroOrMore>
     </element>
   </define>
+  <define name="XrefBody">
+    <zeroOrMore>
+      <ref name="XrefTarget"/>
+    </zeroOrMore>
+    <oneOrMore>
+      <ref name="PureTextElement"/>
+    </oneOrMore>
+  </define>
+  <define name="XrefTarget">
+    <element name="location">
+      <attribute name="target">
+        <data type="string">
+          <param name="pattern">\i\c*|\c+#\c+</param>
+        </data>
+      </attribute>
+      <attribute name="connective">
+        <choice>
+          <value>and</value>
+          <value>or</value>
+          <value>from</value>
+          <value>to</value>
+          <value/>
+        </choice>
+      </attribute>
+    </element>
+  </define>
 </grammar>

data/lib/metanorma/ietf/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Ietf
-    VERSION = "3.0.0".freeze
+    VERSION = "3.0.4".freeze
   end
 end

data/metanorma-ietf.gemspec

@@ -48,6 +48,6 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_development_dependency "vcr", "~> 6.1.0"
   spec.add_development_dependency "webmock"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-ietf
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.4
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-10 00:00:00.000000000 Z
+date: 2022-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mathml2asciimath
@@ -184,14 +184,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 6.1.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -296,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.9
 signing_key:
 specification_version: 4
 summary: metanorma-ietf lets you write IETF documents, such as Internet-Drafts and