relaton-ietf 1.14.2 → 1.14.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aeb4af4144610491bf2bea9e39dc33eb0df67f8a64c67302b2a503a07d3e8fc8
-  data.tar.gz: 9e3ec1c20c3c987449cc438c88045b445c1a4196a53aee5a0e5b00b6a038aef4
+  metadata.gz: 6dd0e3485bf64d666190d66b48f5ade9d4e23ede1537ccf01f388b09fbec2a42
+  data.tar.gz: 01c1334f4730bbb0d636b15ebead6e28d54b524cb834c1d12d6d1453c66e7e3e
 SHA512:
-  metadata.gz: d24d58dae25d535ce8fde08676e244e8435ab9d20fbbd5d9eb6b6f6c620e377686cf3436f49df145d7016a16a3713a6bc65955f1e8d8062ac84953d6cc67796e
-  data.tar.gz: 056caff1d268d56dc15049714784edb13ff25339fded08b8b2833ec95d843ccfe82855ebeece50f1f126c30c6bc9461af9d937451f9856bd53547b486434ae21
+  metadata.gz: 933282984bd0231477efa96ec6711bcd732b8978942f441239ec005e202c9e0aeb85cfc26da480cda68796ae42b31d8e7aba2899f0583a448dfb0833f02cc1d3
+  data.tar.gz: 75475472dcd00bf9821daadd236313648f6a38573d6fed82afd1bd39c4dcaac70439f978f0f864b924a9a0226ab71ed26da09e419c16b60a65709707b7e5e2c1

data/.github/workflows/rake.yml

@@ -5,6 +5,7 @@ name: rake
 on:
   push:
     branches: [ master, main ]
+    tags: [ v* ]
   pull_request:
 
 jobs:

data/.github/workflows/release.yml

@@ -10,8 +10,9 @@ on:
           Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
         required: true
         default: 'skip'
-  push:
-    tags: [ v* ]
+  repository_dispatch:
+    types: [ do-release ]
+
 
 jobs:
   release:

data/.gitignore

@@ -8,6 +8,7 @@
 /tmp/
 /bibxml-ids/
 .vscode/
+/vendor/
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -7,6 +7,6 @@ require: rubocop-rails
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
 Rails:
   Enabled: false

data/Gemfile

@@ -1,6 +1,12 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in relaton_ietf.gemspec
 gemspec
+
+gem "pry-byebug"
+gem "ruby-jing"
+gem "simplecov"
+gem "vcr"
+gem "webmock"

data/grammars/basicdoc.rng

@@ -522,7 +522,6 @@
       <value>tip</value>
       <value>important</value>
       <value>caution</value>
-      <value>statement</value>
     </choice>
   </define>
   <define name="figure">

data/grammars/biblio.rng

@@ -216,6 +216,9 @@
       <optional>
         <ref name="fullname"/>
       </optional>
+      <zeroOrMore>
+        <ref name="credential"/>
+      </zeroOrMore>
       <zeroOrMore>
         <ref name="affiliation"/>
       </zeroOrMore>
@@ -232,6 +235,11 @@
       <ref name="FullNameType"/>
     </element>
   </define>
+  <define name="credential">
+    <element name="credential">
+      <text/>
+    </element>
+  </define>
   <define name="FullNameType">
     <choice>
       <group>
@@ -305,7 +313,9 @@
       <zeroOrMore>
         <ref name="affiliationdescription"/>
       </zeroOrMore>
-      <ref name="organization"/>
+      <optional>
+        <ref name="organization"/>
+      </optional>
     </element>
   </define>
   <define name="affiliationname">
@@ -1316,7 +1326,7 @@
       <value>commentaryOf</value>
       <value>hasCommentary</value>
       <value>related</value>
-      <value>complements</value>
+      <value>hasComplement</value>
       <value>complementOf</value>
       <value>obsoletes</value>
       <value>obsoletedBy</value>

data/lib/relaton_ietf/bibxml_parser.rb

@@ -16,6 +16,16 @@ module RelatonIetf
       RelatonIetf::IetfBibliographicItem.new(**attrs)
     end
 
+    # def docids(reference, ver)
+    #   ids = super
+    #   si = reference.at("./seriesInfo[@name='Internet-Draft']",
+    #     "./front/seriesInfo[@name='Internet-Draft']")
+    #   if si
+    #     id = si[:value]
+    #   end
+    #   ids
+    # end
+
     #
     # Extract document identifier type form identifier
     #
@@ -27,7 +37,6 @@ module RelatonIetf
       type = super
       case type
       when "BCP", "FYI", "STD", "RFC" then "RFC"
-      # when "Internet-Draft" then type
       when "I-D" then "Internet-Draft"
       else "IETF"
       end

data/lib/relaton_ietf/data_fetcher.rb

@@ -6,6 +6,7 @@ require "relaton_ietf/rfc_entry"
 
 module RelatonIetf
   class DataFetcher
+    INDEX1 = "index-v1".freeze
     #
     # Data fetcher initializer
     #
@@ -20,6 +21,7 @@ module RelatonIetf
       @format = format
       @ext = @format.sub(/^bib|^rfc/, "")
       @files = []
+      @index = Relaton::Index.find_or_create :IETF, file: "#{INDEX1}.yaml"
     end
 
     #
@@ -49,6 +51,7 @@ module RelatonIetf
       when "ietf-internet-drafts" then fetch_ieft_internet_drafts
       when "ietf-rfc-entries" then fetch_ieft_rfcs
       end
+      @index.save
     end
 
     #
@@ -201,6 +204,13 @@ module RelatonIetf
         @files << file
       end
       File.write file, c, encoding: "UTF-8"
+      add_to_index entry, file
+    end
+
+    def add_to_index(entry, file)
+      docid = entry.docidentifier.detect(&:primary)
+      docid ||= entry.docidentifier.first
+      @index.add_or_update docid.id, file
     end
 
     #

data/lib/relaton_ietf/ietf_bibliographic_item.rb

@@ -45,33 +45,15 @@ module RelatonIetf
     end
 
     #
-    # Render date as BibXML. Override to skip IANA docidentifiers
+    # Render BibXML (RFC)
     #
-    # @param [Nokogiri::XML::Builder] builder xml builder
+    # @param [Nokogiri::XML::Builder, nil] builder
+    # @param [Boolean] include_keywords (false)
     #
-    def render_date(builder)
-      return if docidentifier.detect { |i| i.type == "IANA" }
-
-      super
-    end
-
+    # @return [String, Nokogiri::XML::Builder::NodeBuilder] XML
     #
-    # Render authors as BibXML. Override to skip "RFC Publisher" organization
-    #
-    # @param [Nokogiri::XML::Builder] builder xml builder
-    #
-    def render_authors(builder) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-      contributor.each do |c|
-        next if c.entity.is_a?(Organization) && c.entity.name.map(&:content).include?("RFC Publisher")
-
-        builder.author do |xml|
-          xml.parent[:role] = "editor" if c.role.detect { |r| r.type == "editor" }
-          if c.entity.is_a?(Person) then render_person xml, c.entity
-          else render_organization xml, c.entity, c.role
-          end
-          render_address xml, c
-        end
-      end
+    def to_bibxml(builder = nil, include_keywords: false)
+      Renderer::BibXML.new(self).render builder: builder, include_keywords: include_keywords
     end
   end
 end

data/lib/relaton_ietf/processor.rb

@@ -48,5 +48,14 @@ module RelatonIetf
     def grammar_hash
       @grammar_hash ||= ::RelatonIetf.grammar_hash
     end
+
+    #
+    # Remove index file
+    #
+    def remove_index_file
+      Relaton::Index.find_or_create(:RFC, url: true, file: Scrapper::INDEX_FILE).remove_file
+      Relaton::Index.find_or_create(:RSS, url: true, file: Scrapper::INDEX_FILE).remove_file
+      Relaton::Index.find_or_create(:IDS, url: true, file: Scrapper::INDEX_FILE).remove_file
+    end
   end
 end

data/lib/relaton_ietf/renderer/bibxml.rb

@@ -0,0 +1,33 @@
+module RelatonIetf
+  module Renderer
+    class BibXML < RelatonBib::Renderer::BibXML
+      #
+      # Render dates as BibXML. Override to skip IANA date rendering.
+      #
+      # @param [Nokogiri::XML::Builder] builder xml builder
+      #
+      def render_date(builder)
+        super unless @bib.docidentifier.detect { |i| i.type == "IANA" }
+      end
+
+      #
+      # Render authors as BibXML. Override to skip "RFC Publisher" organization.
+      #
+      # @param [Nokogiri::XML::Builder] builder xml builder
+      #
+      def render_authors(builder) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+        @bib.contributor.each do |c|
+          next if c.entity.is_a?(RelatonBib::Organization) && c.entity.name.map(&:content).include?("RFC Publisher")
+
+          builder.author do |xml|
+            xml.parent[:role] = "editor" if c.role.detect { |r| r.type == "editor" }
+            if c.entity.is_a?(RelatonBib::Person) then render_person xml, c.entity
+            else render_organization xml, c.entity, c.role
+            end
+            render_address xml, c
+          end
+        end
+      end
+    end
+  end
+end

data/lib/relaton_ietf/rfc_entry.rb

@@ -52,11 +52,22 @@ module RelatonIetf
     #
     def parse_series
       title = RelatonBib::TypedTitleString.new(content: "RFC")
+      series_is_also + seires_stream + [RelatonBib::Series.new(title: title, number: docnum)]
+    end
+
+    def series_is_also
       @doc.xpath("./xmlns:is-also/xmlns:doc-id").map do |s|
         /^(?<name>\D+)(?<num>\d+)/ =~ s.text
         t = RelatonBib::TypedTitleString.new(content: name)
         RelatonBib::Series.new title: t, number: num.gsub(/^0+/, "")
-      end + [RelatonBib::Series.new(title: title, number: docnum)]
+      end
+    end
+
+    def seires_stream
+      @doc.xpath("./xmlns:stream").map do |s|
+        t = RelatonBib::TypedTitleString.new content: s.text
+        RelatonBib::Series.new type: "stream", title: t
+      end
     end
 
     #
@@ -116,9 +127,9 @@ module RelatonIetf
     #
     # @return [String] anchor
     #
-    def anchor
-      "RFC#{docnum}"
-    end
+    # def anchor
+    #   "RFC#{docnum}"
+    # end
 
     #
     # Create link

data/lib/relaton_ietf/rfc_index_entry.rb

@@ -46,6 +46,7 @@ module RelatonIetf
         link: parse_link,
         formattedref: formattedref,
         relation: parse_relation,
+        series: parse_series,
       )
     end
 
@@ -73,10 +74,7 @@ module RelatonIetf
     # @return [Array<RelatonBib::DocumentIdentifier>] docidentifiers
     #
     def parse_docid
-      [
-        RelatonBib::DocumentIdentifier.new(type: "IETF", id: pub_id, primary: true),
-        # RelatonBib::DocumentIdentifier.new(type: "IETF", scope: "anchor", id: anchor),
-      ]
+      [RelatonBib::DocumentIdentifier.new(type: "IETF", id: pub_id, primary: true)]
     end
 
     #
@@ -100,7 +98,7 @@ module RelatonIetf
     #
     # Create link
     #
-    # @return [Array<RelatonBib::TypedUri>] 
+    # @return [Array<RelatonBib::TypedUri>]
     #
     def parse_link
       [RelatonBib::TypedUri.new(type: "src", content: "https://www.rfc-editor.org/info/#{@name}#{@shortnum}")]
@@ -109,7 +107,7 @@ module RelatonIetf
     #
     # Create formatted reference
     #
-    # @return [RelatonBib::FormattedRef] 
+    # @return [RelatonBib::FormattedRef]
     #
     def formattedref
       RelatonBib::FormattedRef.new(
@@ -131,5 +129,12 @@ module RelatonIetf
         { type: "includes", bibitem: bib }
       end
     end
+
+    def parse_series
+      @doc.xpath("./xmlns:stream").map do |s|
+        title = RelatonBib::TypedTitleString.new content: s.text
+        RelatonBib::Series.new type: "stream", title: title
+      end
+    end
   end
 end

data/lib/relaton_ietf/scrapper.rb

@@ -5,16 +5,17 @@ module RelatonIetf
   module Scrapper
     extend Scrapper
 
-    IDS = "https://raw.githubusercontent.com/relaton/relaton-data-ids/main/data/"
-    RFC = "https://raw.githubusercontent.com/relaton/relaton-data-rfcs/main/data/"
-    RSS = "https://raw.githubusercontent.com/relaton/relaton-data-rfcsubseries/main/data/"
+    IDS = "https://raw.githubusercontent.com/relaton/relaton-data-ids/main/"
+    RFC = "https://raw.githubusercontent.com/relaton/relaton-data-rfcs/main/"
+    RSS = "https://raw.githubusercontent.com/relaton/relaton-data-rfcsubseries/main/"
+    INDEX_FILE = "index-v1.yaml"
 
     # @param text [String]
     # @return [RelatonIetf::IetfBibliographicItem]
     def scrape_page(text)
       # Remove initial "IETF " string if specified
       ref = text.gsub(/^IETF /, "")
-      ref.sub!(/(?<=^(?:RFC|BCP|FYI|STD))\s(\d+)/) { $1.rjust 4, "0" }
+      # ref.sub!(/(?<=^(?:RFC|BCP|FYI|STD))\s(\d+)/) { $1.rjust 4, "0" }
       rfc_item ref
     rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
            Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError,
@@ -27,32 +28,42 @@ module RelatonIetf
     # @param ref [String]
     # @return [RelatonIetf::IetfBibliographicItem]
     def rfc_item(ref) # rubocop:disable Metrics/MethodLength
-      ghurl = case ref
-              when /^RFC/ then RFC
-              when /^(?:BCP|FYI|STD)/ then RSS
-              when /^I-D/
-                ref.sub!(/^I-D[.\s]/, "")
-                IDS
-              else return
-              end
-
-      uri = "#{ghurl}#{ref.sub(/\s|\u00a0/, '.')}.yaml"
-      # BibXMLParser.parse get_page(uri), is_relation: is_relation, ver: ver
-      resp = get_page uri
-      return unless resp
-
-      hash = YAML.safe_load resp
-      hash["fetched"] = Date.today.to_s
-      IetfBibliographicItem.from_hash hash
+      case ref
+      when /^RFC/ then get_rfcs ref
+      when /^(?:BCP|FYI|STD)/ then get_rfcsubseries ref
+      when /^I-D/
+        ref.sub!(/^I-D[.\s]/, "")
+        get_ids ref
+      end
+    end
+
+    def get_rfcs(ref)
+      index = Relaton::Index.find_or_create :RFC, url: "#{RFC}index-v1.zip", file: INDEX_FILE
+      row = index.search(ref).first
+      get_page "#{RFC}#{row[:file]}" if row
+    end
+
+    def get_rfcsubseries(ref)
+      index = Relaton::Index.find_or_create :RSS, url: "#{RSS}index-v1.zip", file: INDEX_FILE
+      row = index.search(ref).first
+      get_page "#{RSS}#{row[:file]}" if row
+    end
+
+    def get_ids(ref)
+      index = Relaton::Index.find_or_create :IDS, url: "#{IDS}index-v1.zip", file: INDEX_FILE
+      row = index.search(ref).first
+      get_page "#{IDS}#{row[:file]}" if row
     end
 
     # @param uri [String]
-    # @return [String] HTTP response body
+    # @return [RelatonIetf::IetfBibliographicItem, nil] HTTP response body
     def get_page(uri)
       res = Net::HTTP.get_response(URI(uri))
       return unless res.code == "200"
 
-      res.body
+      hash = YAML.safe_load res.body
+      hash["fetched"] = Date.today.to_s
+      IetfBibliographicItem.from_hash hash
     end
   end
 end

data/lib/relaton_ietf/version.rb

@@ -1,3 +1,3 @@
 module RelatonIetf
-  VERSION = "1.14.2".freeze
+  VERSION = "1.14.4".freeze
 end

data/lib/relaton_ietf.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "net/http"
+require "relaton/index"
 require "relaton_bib"
 require "relaton_ietf/version"
 require "relaton_ietf/bibxml_parser"
@@ -8,6 +9,7 @@ require "relaton_ietf/ietf_bibliography"
 require "relaton_ietf/xml_parser"
 require "relaton_ietf/hash_converter"
 require "relaton_ietf/data_fetcher"
+require "relaton_ietf/renderer/bibxml"
 require "relaton/provider_ietf"
 
 module RelatonIetf

data/relaton_ietf.gemspec

@@ -10,10 +10,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ribose Inc."]
   spec.email         = ["open.source@ribose.com"]
 
-  spec.summary       = "RelatonIetf: retrieve IETF Standards for bibliographic use "\
-                       "using the BibliographicItem model"
+  spec.summary       = "RelatonIetf: retrieve IETF Standards for " \
+                       "bibliographic use using the BibliographicItem model"
   spec.description   = <<~DESCRIPTION
-    RelatonIetf: retrieve IETF Standards for bibliographic use 
+    RelatonIetf: retrieve IETF Standards for bibliographic use
     using the BibliographicItem model.
 
     Formerly known as rfcbib.
@@ -27,16 +27,12 @@ Gem::Specification.new do |spec|
   spec.bindir        = "exe"
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
-  spec.add_development_dependency "pry-byebug"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "ruby-jing"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "webmock"
 
   spec.add_dependency "relaton-bib", "~> 1.14.0"
+  spec.add_dependency "relaton-index", "~> 0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ietf
 version: !ruby/object:Gem::Version
-  version: 1.14.2
+  version: 1.14.4
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-24 00:00:00.000000000 Z
+date: 2023-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,77 +53,38 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: ruby-jing
-  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
-    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: vcr
-  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: webmock
+  name: relaton-bib
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 1.14.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.14.0
 - !ruby/object:Gem::Dependency
-  name: relaton-bib
+  name: relaton-index
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.14.0
-description: "RelatonIetf: retrieve IETF Standards for bibliographic use \nusing the
-  BibliographicItem model.\n\nFormerly known as rfcbib.\n"
+        version: 0.2.0
+description: |
+  RelatonIetf: retrieve IETF Standards for bibliographic use
+  using the BibliographicItem model.
+
+  Formerly known as rfcbib.
 email:
 - open.source@ribose.com
 executables: []
@@ -171,6 +118,7 @@ files:
 - lib/relaton_ietf/ietf_bibliographic_item.rb
 - lib/relaton_ietf/ietf_bibliography.rb
 - lib/relaton_ietf/processor.rb
+- lib/relaton_ietf/renderer/bibxml.rb
 - lib/relaton_ietf/rfc_entry.rb
 - lib/relaton_ietf/rfc_index_entry.rb
 - lib/relaton_ietf/scrapper.rb
@@ -189,14 +137,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: 'RelatonIetf: retrieve IETF Standards for bibliographic use using the BibliographicItem