relaton-ietf 1.14.3 → 1.14.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d095dbbd95a78f345ce51149c8fcea964014f3e7aeef7b96ee4021df52900e60
-  data.tar.gz: f240f8d05275819b620455f743bf4d31d096ca1f0bd4de9c594cd2d163b6fc0e
+  metadata.gz: aa4b15e1b13a21f94aa87731fe6d49a83422a426b299ef3fa4378d65dbdf79a2
+  data.tar.gz: 6c3e630920810ca3bc881e794e36cd3e9898174eab83ed420fe18d36c8f641ab
 SHA512:
-  metadata.gz: fc7e74b30da9eb8c26d1b45e11511b0e2f17ff08eb0354b15e2445515c98d28d985e5582f09cbb2ab966916e872fdafe56b00b0e9a2148c80a1aa9fdc6b8b37e
-  data.tar.gz: e89482fa9042118c3cdece897e1c976d889986d374a89105aebe41c414cf57d6ad41f7ffb5e4b92bcb9d0f87e3f9ee79cf64b64dcde0ebe50127aa9ad16ad091
+  metadata.gz: 0e6cb43373347a061abf880ee44691c7f0f324823290ae5dcb3deb93d5f8754034d34ccf1a2a1c27b2a176c6f7f3d6f6d160c22c53b91a87e939bea653af900a
+  data.tar.gz: fd4edf41ff906d5c5fdf3aea055a103e197deaf21d80af892428664abe078196ad49ca5c3521ae741d305c6e1f1eba7b6fd61e15d8aa55ae06d9adb020f926a2

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,16 @@
 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 "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+
+gem "equivalent-xml"
+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/grammars/relaton-ietf.rng

@@ -26,6 +26,9 @@
       <zeroOrMore>
         <ref name="area"/>
       </zeroOrMore>
+      <optional>
+        <ref name="stream"/>
+      </optional>
       <optional>
         <ref name="ipr"/>
       </optional>
@@ -315,4 +318,16 @@
       </optional>
     </element>
   </define>
+  <define name="stream">
+    <element name="stream">
+      <choice>
+        <value>IAB</value>
+        <value>IETF</value>
+        <value>Independent</value>
+        <value>IRTF</value>
+        <value>Legacy</value>
+        <value>Editorial</value>
+      </choice>
+    </element>
+  </define>
 </grammar>

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/hash_converter.rb

@@ -1,6 +1,14 @@
 module RelatonIetf
   class HashConverter < RelatonBib::HashConverter
     class << self
+      def hash_to_bib(hash)
+        ret = super
+        return unless ret
+
+        stream_hash_to_bib ret
+        ret
+      end
+
       #
       # Ovverides superclass's method
       #
@@ -19,6 +27,10 @@ module RelatonIetf
         end
         ret[:editorialgroup] = RelatonBib::EditorialGroup.new technical_committee
       end
+
+      def stream_hash_to_bib(ret)
+        ret[:stream] = ret[:ext][:stream] if ret[:ext]&.key? :stream
+      end
     end
   end
 end

data/lib/relaton_ietf/ietf_bibliographic_item.rb

@@ -2,18 +2,20 @@ module RelatonIetf
   class IetfBibliographicItem < RelatonBib::BibliographicItem
     DOCTYPES = %w[rfc internet-draft].freeze
 
-    # @return [String, NilClass]
-    attr_reader :doctype
+    # @return [String, nil]
+    attr_reader :doctype, :stream
 
     # @return [Array<String>]
     attr_reader :keyword
 
     # @param doctype [String]
     # @param keyword [Array<String>]
+    # @param stream [String, nil]
     def initialize(**args)
       if args[:doctype] && !DOCTYPES.include?(args[:doctype])
         warn "[relaton-ietf] WARNING: invalid doctype #{args[:doctype]}"
       end
+      @stream = args.delete(:stream)
       super
     end
 
@@ -36,12 +38,39 @@ module RelatonIetf
     # @param opts [Hash]
     # @option opts [Nokogiri::XML::Builder] :builder XML builder
     # @option opts [Boolean] :bibdata
-    # @option opts [Symbol, NilClass] :date_format (:short), :full
+    # @option opts [Symbol, nil] :date_format (:short), :full
     # @option opts [String, Symbol] :lang language
     # @return [String] XML
-    def to_xml(**opts)
+    def to_xml(**opts) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
       opts[:date_format] ||= :short
-      super(**opts)
+      super(**opts) do |builder|
+        if opts[:bibdata] && (doctype || editorialgroup || ics&.any? ||
+          structuredidentifier&.presence? || stream)
+          ext = builder.ext do |b|
+            b.doctype doctype if doctype
+            b.subdoctype subdoctype if subdoctype
+            editorialgroup&.to_xml b
+            ics.each { |i| i.to_xml b }
+            b.stream stream if stream
+            structuredidentifier&.to_xml b
+          end
+          ext["schema-version"] = ext_schema if !opts[:embedded] && respond_to?(:ext_schema)
+        end
+      end
+    end
+
+    #
+    # Render hash
+    #
+    # @return [Hash] docunent hash representation
+    #
+    def to_hash(embedded: false)
+      hash = super
+      return hash unless stream
+
+      hash["ext"] ||= {}
+      hash["ext"]["stream"] = stream
+      hash
     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/rfc_entry.rb

@@ -41,6 +41,7 @@ module RelatonIetf
         relation: parse_relation,
         status: parse_status,
         series: parse_series,
+        stream: @doc.at("./xmlns:stream")&.text,
         editorialgroup: parse_editorialgroup,
       )
     end
@@ -52,7 +53,7 @@ module RelatonIetf
     #
     def parse_series
       title = RelatonBib::TypedTitleString.new(content: "RFC")
-      series_is_also + seires_stream + [RelatonBib::Series.new(title: title, number: docnum)]
+      series_is_also + [RelatonBib::Series.new(title: title, number: docnum)] + seires_stream
     end
 
     def series_is_also
@@ -127,14 +128,14 @@ module RelatonIetf
     #
     # @return [String] anchor
     #
-    def anchor
-      "RFC#{docnum}"
-    end
+    # def anchor
+    #   "RFC#{docnum}"
+    # end
 
     #
     # Create link
     #
-    # @return [Array<RelatonBib::TypedUri>] 
+    # @return [Array<RelatonBib::TypedUri>]
     #
     def parse_link
       url = "https://www.rfc-editor.org/info/rfc#{docnum}"

data/lib/relaton_ietf/rfc_index_entry.rb

@@ -10,7 +10,7 @@ module RelatonIetf
     def initialize(doc, doc_id, is_also)
       @doc = doc
       @name = doc.name.split("-").first
-      @shortnum = doc_id[-4..-1].sub(/^0+/, "")
+      @shortnum = doc_id[-4..].sub(/^0+/, "")
       @doc_id = doc_id
       @is_also = is_also
     end
@@ -47,6 +47,7 @@ module RelatonIetf
         formattedref: formattedref,
         relation: parse_relation,
         series: parse_series,
+        stream: @doc.at("./xmlns:stream")&.text,
       )
     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.3".freeze
+  VERSION = "1.14.5".freeze
 end

data/lib/relaton_ietf/xml_parser.rb

@@ -5,6 +5,12 @@ module RelatonIetf
     class << self
       private
 
+      def item_data(doc)
+        data = super
+        data[:stream] = doc.at("ext/stream")&.text
+        data
+      end
+
       # override RelatonBib::BibliographicItem.bib_item method
       # @param item_hash [Hash]
       # @return [RelatonIetf::IetfBibliographicItem]

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"

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,8 @@ 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.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.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.add_dependency "relaton-bib", "~> 1.14.0"
+  spec.add_dependency "relaton-index", "~> 0.2.3"
 end

metadata

@@ -1,143 +1,48 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ietf
 version: !ruby/object:Gem::Version
-  version: 1.14.3
+  version: 1.14.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-03-09 00:00:00.000000000 Z
+date: 2023-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: equivalent-xml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !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
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
+  name: relaton-bib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
+        version: 1.14.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !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
-  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'
+        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.3
   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.3
+description: |
+  RelatonIetf: retrieve IETF Standards for bibliographic use
+  using the BibliographicItem model.
+
+  Formerly known as rfcbib.
 email:
 - open.source@ribose.com
 executables: []
@@ -190,14 +95,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