relaton-ietf 1.10.3 → 1.10.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39327270eb3e1efbd565881ac04a81623a6a1b9b0c03bfe5bec0403c47c6ffc6
-  data.tar.gz: 93d3e101fd02e503d7e3ba64b5c3e6e15c63071c769b4242094611bc40ed1685
+  metadata.gz: e52b5d3e6287636c00d9a09d115773d39156bf81f59d9db8d5168a8b4476f44b
+  data.tar.gz: fce58a6de2d758419f999861353b1dad1e19deb03ee52f30e901a4563a6e0750
 SHA512:
-  metadata.gz: 05ab0ccbc44d9c51ca1565e74dcaacfba1977d1bea2b28684132a249959c427ae83a81c9fde16b87418c82c16dfe5433959e8bce2ec01cf821eb1ae069de7c4a
-  data.tar.gz: 5d3ffb6cb20c518447106b78df29e1db9489ad291e31ba1542162e69e6f283809490805a28cc9bf382cfced8d845594dcc1174851be1b8d165c07016d8db4022
+  metadata.gz: f7ce9a5b44b815388c76c231038759227937b50e4d352f5e8d1a218fdef73419c6740e7714e810d76c8dbab778c9b8d0003681e05f7ef7195e6f80cbfd58f634
+  data.tar.gz: 57d38a23804da9618620725efd21a232b3992a3e3a3f0d067eec9e1f4d29a5eb248c9e1cf3ad8cdbb37d6af62bf4c2d1c61afc99ec45b062ce8d9c56b12f0225

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/lib/relaton_ietf/bibxml_parser.rb

@@ -24,6 +24,7 @@ module RelatonIetf
       type = super
       case type
       when "BCP", "FYI", "STD", "RFC" then "RFC"
+      when "Internet-Draft" then type
       else "IETF"
       end
     end

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.3".freeze
+  VERSION = "1.10.6".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ietf
 version: !ruby/object:Gem::Version
-  version: 1.10.3
+  version: 1.10.6
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-18 00:00:00.000000000 Z
+date: 2022-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equivalent-xml