relaton-ietf 1.10.4 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aea00f6f466ab9780b8fbb93cd69ea04e7bd099ab8793be0edd6be843143a3f6
-  data.tar.gz: a9259ce6290b92dc98679aded761e2563d4771118f4a44434142cd26b3248c4e
+  metadata.gz: 487865677406ccb87b65d3f4064c60bef7d26b7955817dd7030c4272eabf3e3f
+  data.tar.gz: 818d190f6bcb3d91a9b5a0bf7ebe8e5acd20e3f1e46de30c1b7e6e9b4435116b
 SHA512:
-  metadata.gz: 7d4cf8fc6b8ce6483732b0c8f350596a41cd76ac35001e0257f683ebf854646cb473f08d293e40b8fc84cee61527ab421bd6178ba5a2f14ec32a29c4c2ac97c0
-  data.tar.gz: c8016eb29a720c92dc25c4e364a5877d31fa1aa0cffa6bb5acae164ec9a169c0022e4c6eb6cc5b3b05963ae74b5a922cb036e0c196d205fe85907cd9d22cd79c
+  metadata.gz: 1f2553900686f5c7a1a3653b0e9546510448e79dde9965d8c1aa604377bde3489d805bdd13ae68128bfa7f49fd4037d588584c3dcc3ca594579f5410c6cb0b6e
+  data.tar.gz: 1a0599db3efa91cfd7360f53cc77bffdb1fcf7b445f2fc56e9d2957634826adf71be8c54a75e71e2b5e4619e91c00d7b351b01eb01c16535be2c3602281ba45d

data/README.adoc

@@ -135,7 +135,7 @@ RelatonIetf::IetfBibliographicItem.from_hash hash
 
 === Fetch data
 
-There is a IETF datasets what can be converted into RelatonXML/BibXML/BibYAML formats:
+There are IETF datasets what can be converted into RelatonXML/BibXML/BibYAML formats:
 
 - `ietf-rfcsubseries` - https://www.rfc-editor.org/rfc-index.xml (`<bcp-entry>`, `<fyi-entry>`, `<std-entry>`)
 - `ietf-internet-drafts` - converts files from local directory `./bibxml-ids`. Use `rsync -avcizxL rsync.ietf.org::bibxml-ids ./bibxml-ids` command to fetch the files.

data/grammars/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"/>
@@ -624,6 +626,9 @@
         <choice>
           <ref name="PureTextElement"/>
           <ref name="stem"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -634,6 +639,9 @@
         <choice>
           <ref name="PureTextElement"/>
           <ref name="stem"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -641,7 +649,12 @@
   <define name="tt">
     <element name="tt">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="eref"/>
+          <ref name="xref"/>
+          <ref name="hyperlink"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>
@@ -822,7 +835,9 @@
       <attribute name="alt"/>
     </optional>
     <ref name="CitationType"/>
-    <text/>
+    <oneOrMore>
+      <ref name="PureTextElement"/>
+    </oneOrMore>
   </define>
   <define name="hyperlink">
     <element name="link">
@@ -835,7 +850,9 @@
       <optional>
         <attribute name="alt"/>
       </optional>
-      <text/>
+      <oneOrMore>
+        <ref name="PureTextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="xref">
@@ -849,7 +866,9 @@
       <optional>
         <attribute name="alt"/>
       </optional>
-      <text/>
+      <oneOrMore>
+        <ref name="PureTextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="fn">

data/grammars/biblio.rng

@@ -677,6 +677,9 @@
     <zeroOrMore>
       <ref name="extent"/>
     </zeroOrMore>
+    <optional>
+      <ref name="bibliographic_size"/>
+    </optional>
     <zeroOrMore>
       <ref name="accesslocation"/>
     </zeroOrMore>
@@ -922,9 +925,29 @@
       <text/>
     </element>
   </define>
+  <define name="sizevalue">
+    <element name="value">
+      <attribute name="type"/>
+      <text/>
+    </element>
+  </define>
+  <define name="bibliographic_size">
+    <element name="size">
+      <oneOrMore>
+        <ref name="sizevalue"/>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="extent">
     <element name="extent">
-      <ref name="BibItemLocality"/>
+      <choice>
+        <zeroOrMore>
+          <ref name="locality"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="localityStack"/>
+        </zeroOrMore>
+      </choice>
     </element>
   </define>
   <define name="series">

data/grammars/ietf.rng

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

data/grammars/isodoc.rng

@@ -152,9 +152,7 @@
             <data type="boolean"/>
           </attribute>
         </optional>
-        <oneOrMore>
-          <ref name="PureTextElement"/>
-        </oneOrMore>
+        <ref name="XrefBody"/>
       </element>
     </define>
     <define name="erefType">
@@ -188,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">
@@ -1098,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>
@@ -2631,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/grammars/reqt.rng

@@ -58,6 +58,14 @@
     <optional>
       <attribute name="type"/>
     </optional>
+    <optional>
+      <attribute name="tag"/>
+    </optional>
+    <optional>
+      <attribute name="multilingual-rendering">
+        <ref name="MultilingualRenderingType"/>
+      </attribute>
+    </optional>
     <optional>
       <ref name="reqtitle"/>
     </optional>
@@ -101,7 +109,9 @@
   </define>
   <define name="label">
     <element name="label">
-      <text/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
     </element>
   </define>
   <define name="subject">
@@ -175,6 +185,14 @@
         <data type="boolean"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="tag"/>
+    </optional>
+    <optional>
+      <attribute name="multilingual-rendering">
+        <ref name="MultilingualRenderingType"/>
+      </attribute>
+    </optional>
     <oneOrMore>
       <ref name="BasicBlock"/>
     </oneOrMore>

data/lib/relaton_ietf/data_fetcher.rb

@@ -64,11 +64,93 @@ module RelatonIetf
     # Fetches ietf-internet-drafts documents
     #
     def fetch_ieft_internet_drafts # rubocop:disable Metrics/MethodLength
-      Dir["bibxml-ids/*.xml"].each do |file|
-        save_doc BibXMLParser.parse(File.read(file, encoding: "UTF-8"))
+      versions = Dir["bibxml-ids/*.xml"].each_with_object([]) do |path, vers|
+        file = File.basename path, ".xml"
+        if file.include?("D.draft-")
+          vers << file.sub(/^reference\.I-D\./, "")
+        end
+        save_doc BibXMLParser.parse(File.read(path, encoding: "UTF-8"))
       end
+      update_versions(versions) if versions.any? && @format != "bibxml"
     end
 
+    #
+    # Updates I-D's versions
+    #
+    # @param [Array<String>] versions list of versions
+    #
+    def update_versions(versions) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+      series = ""
+      bib_versions = []
+      Dir["#{@output}/*.#{@ext}"].each do |file|
+        match = /(?<series>draft-.+)-(?<ver>\d{2})\.#{@ext}$/.match file
+        if match
+          if series != match[:series]
+            bib_versions = versions.select { |ref| ref.include? match[:series] }
+            create_series match[:series], bib_versions
+          end
+          lv = bib_versions.select { |ref| ref.match(/\d+$/).to_s.to_i < match[:ver].to_i }
+          hv = bib_versions.select { |ref| ref.match(/\d+$/).to_s.to_i > match[:ver].to_i }
+          if lv.any? || hv.any?
+            bib = read_doc(file)
+            bib.relation << version_relation(lv.last, "updates") if lv.any?
+            bib.relation << version_relation(hv.first, "updatedBy") if hv.any?
+            save_doc bib, check_duplicate: false
+          end
+          series = match[:series]
+        end
+      end
+    end
+
+    #
+    # Create unversioned bibliographic item
+    #
+    # @param [String] ref reference
+    # @param [Array<String>] versions list of versions
+    #
+    def create_series(ref, versions)
+      return if versions.size < 2
+
+      fref = RelatonBib::FormattedRef.new content: ref
+      rel = versions.map do |v|
+        version_relation v, "includes"
+      end
+      save_doc IetfBibliographicItem.new(formattedref: fref, relation: rel)
+    end
+
+    #
+    # Create bibitem relation
+    #
+    # @param [String] ref reference
+    # @param [String] type relation type
+    #
+    # @return [RelatonBib::DocumentRelation] relation
+    #
+    def version_relation(ref, type)
+      fref = RelatonBib::FormattedRef.new content: ref
+      bibitem = IetfBibliographicItem.new formattedref: fref
+      RelatonBib::DocumentRelation.new(type: type, bibitem: bibitem)
+    end
+
+    #
+    # Redad saved documents
+    #
+    # @param [String] file path to file
+    #
+    # @return [RelatonIetf::IetfBibliographicItem] bibliographic item
+    #
+    def read_doc(file)
+      doc = File.read(file, encoding: "UTF-8")
+      case @format
+      when "xml" then XMLParser.from_xml(doc)
+      when "yaml" then IetfBibliographicItem.from_hash YAML.safe_load(doc)
+      else BibXMLParser.parse(doc)
+      end
+    end
+
+    #
+    # Fetches ietf-rfc-entries documents
+    #
     def fetch_ieft_rfcs
       rfc_index.xpath("xmlns:rfc-entry").each do |doc|
         save_doc RfcEntry.parse(doc)
@@ -78,6 +160,11 @@ module RelatonIetf
       end
     end
 
+    #
+    # Get RFC index
+    #
+    # @return [Nokogiri::XML::Document] RFC index
+    #
     def rfc_index
       uri = URI "https://www.rfc-editor.org/rfc-index.xml"
       Nokogiri::XML(Net::HTTP.get(uri)).at("/xmlns:rfc-index")
@@ -87,8 +174,9 @@ module RelatonIetf
     # Save document to file
     #
     # @param [RelatonIetf::RfcIndexEntry, nil] rfc index entry
+    # @param [Boolean] check_duplicate check for duplicate
     #
-    def save_doc(entry) # rubocop:disable Metrics/MethodLength
+    def save_doc(entry, check_duplicate: true) # rubocop:disable Metrics/MethodLength, Metrics/CyclomaticComplexity
       return unless entry
 
       c = case @format
@@ -97,9 +185,9 @@ module RelatonIetf
           else entry.send("to_#{@format}")
           end
       file = file_name entry
-      if @files.include? file
+      if check_duplicate && @files.include?(file)
         warn "File #{file} already exists. Document: #{entry.docnumber}"
-      else
+      elsif check_duplicate
         @files << file
       end
       File.write file, c, encoding: "UTF-8"
@@ -112,11 +200,11 @@ module RelatonIetf
     #
     # @return [String] file name
     #
-    def file_name(entry)
+    def file_name(entry) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       id = if entry.respond_to? :docidentifier
              entry.docidentifier.detect { |i| i.type == "Internet-Draft" }&.id
            end
-      id ||= entry.docnumber
+      id ||= entry.docnumber || entry.formattedref.content
       if @source == "ietf-internet-drafts" then id.downcase!
       else id.upcase!
       end

data/lib/relaton_ietf/rfc_entry.rb

@@ -68,7 +68,7 @@ module RelatonIetf
     def parse_docid
       ids = [
         RelatonBib::DocumentIdentifier.new(id: pub_id, type: "IETF", primary: true),
-        RelatonBib::DocumentIdentifier.new(id: code, type: "IETF", scope: "anchor"),
+        RelatonBib::DocumentIdentifier.new(id: anchor, type: "IETF", scope: "anchor"),
       ]
       doi = @doc.at("./xmlns:doi").text
       ids << RelatonBib::DocumentIdentifier.new(id: doi, type: "DOI")
@@ -112,14 +112,22 @@ module RelatonIetf
       @doc.at("./xmlns:doc-id").text
     end
 
+    #
+    # Create acnhor
+    #
+    # @return [String] anchor
+    #
+    def anchor
+      "RFC#{docnum}"
+    end
+
     #
     # Create link
     #
     # @return [Array<RelatonBib::TypedUri>] 
     #
     def parse_link
-      num = code[-4..-1].sub(/^0+/, "")
-      url = "https://www.rfc-editor.org/info/rfc#{num}"
+      url = "https://www.rfc-editor.org/info/rfc#{docnum}"
       [RelatonBib::TypedUri.new(content: url, type: "src")]
     end
 

data/lib/relaton_ietf/rfc_index_entry.rb

@@ -19,7 +19,7 @@ module RelatonIetf
     #
     # @param [Nokogiri::XML::Element] doc document
     #
-    # @return [RelatonIetf:IetfBibliographicItem, nil]
+    # @return [RelatonIetf::IetfBibliographicItem, nil]
     #
     def self.parse(doc)
       doc_id = doc.at("./xmlns:doc-id")
@@ -55,7 +55,7 @@ module RelatonIetf
     def parse_docid
       [
         RelatonBib::DocumentIdentifier.new(type: "IETF", id: pub_id, primary: true),
-        RelatonBib::DocumentIdentifier.new(type: "IETF", scope: "anchor", id: @doc_id),
+        RelatonBib::DocumentIdentifier.new(type: "IETF", scope: "anchor", id: anchor),
       ]
     end
 
@@ -78,9 +78,9 @@ module RelatonIetf
     end
 
     def parse_relation
-      @is_also.map do |ref|
+      @is_also.each_with_object([]) do |ref, a|
         bib = IetfBibliography.get ref.sub(/^(RFC)(\d+)/, '\1 \2')
-        { type: "includes", bibitem: bib }
+        a << { type: "includes", bibitem: bib } if bib
       end
     end
   end

data/lib/relaton_ietf/version.rb

@@ -1,3 +1,3 @@
 module RelatonIetf
-  VERSION = "1.10.4".freeze
+  VERSION = "1.11.0".freeze
 end

data/relaton_ietf.gemspec

@@ -38,6 +38,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "vcr"
   spec.add_development_dependency "webmock"
 
-  spec.add_dependency "relaton-bib", "~> 1.10.1"
+  spec.add_dependency "relaton-bib", "~> 1.11.0"
   # spec.add_dependency "zlib", "~> 1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ietf
 version: !ruby/object:Gem::Version
-  version: 1.10.4
+  version: 1.11.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-01 00:00:00.000000000 Z
+date: 2022-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.1
+        version: 1.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.10.1
+        version: 1.11.0
 description: "RelatonIetf: retrieve IETF Standards for bibliographic use \nusing the
   BibliographicItem model.\n\nFormerly known as rfcbib.\n"
 email: