relaton-iana 1.14.1 → 1.14.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b32501a7b2b388b0d50c63b33cfd73b070c0e505b123a99d5370be888958224e
-  data.tar.gz: 4b82cbd93a58fe7450a53d09a2d991998c7e2496126c84e722070e5eb5658679
+  metadata.gz: dbfa9e6bb7c8bdc2772554010aaedc00425f0f43d757ac6d0a4b22688a9e52d7
+  data.tar.gz: 67b12ec014b790910297134c3a8b5fccc6ad14c9f0f085038942a26afd8b3bbb
 SHA512:
-  metadata.gz: ac39b40b363f111b1fc2d6f44f7251e6ac8e7acbdd6e7c5fe19c1eb50a489630ac78450e953dfea1f2aebac4bb688a16fe8f3a2231ea164339d7cf5bcc3c6cf6
-  data.tar.gz: 067114fa401cb20cf9f7abe59537723d30c597fd680d616fb22341b65596ad2cf31a526768f0ac8a1bc4955837b28ce4484d5c76f391fefdbfb6e5506270bfc9
+  metadata.gz: 5c5d6e87589523a0eda7d29f9cc99f70fb541f62b2be4e60ab286356fda69eaa1f7a3afc9de8359fbef33618a3d1573204632a845c305c802223cd6a6789733a
+  data.tar.gz: a0dab69a5515878c328fd837e048c6b9e47f44803d33ed3cf0e07bfea53f55223d7b8693bf1775b8f9fec7aa3651b13350fcdcf9dc2a07e4ed5a83f42f878c26

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

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/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

@@ -10,3 +10,9 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.7"
+gem "rubocop-performance"
+gem "rubocop-rails"
+gem "ruby-jing"
+gem "simplecov"
+gem "vcr"
+gem "webmock"

data/README.adoc

@@ -111,7 +111,7 @@ Done in: 155 sec.
 
 This method uses GitHub search API to fetch the documents. The search API has a https://docs.github.com/en/rest/reference/search#rate-limit[rate limitaion] of 30 requests per minute for authenticated users and 10 requests per minute for unauthenticated users. Usually, the rate limit is not reached because the search API is used only for the file list fetching. But if you run the method multiple times in a short period, the rate limit may be reached. In this case, the method will wait until the rate limit is reset.
 
-You can use a personal access token to increase the rate limit. To do this, add your personal access token to the `GITHUB_TOKEN` environment variable.
+You can use a personal access token (PTA) to increase the rate limit. To do this, add your PTA to the `GITHUB_TOKEN` environment variable.
 
 == Development
 

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_iana/data_fetcher.rb

@@ -1,7 +1,5 @@
 module RelatonIana
   class DataFetcher
-    SOURCE = "https://raw.githubusercontent.com/ietf-ribose/iana-registries/main/".freeze
-
     #
     # Data fetcher initializer
     #
@@ -13,6 +11,7 @@ module RelatonIana
       @format = format
       @ext = format.sub(/^bib/, "")
       @files = []
+      @index = Relaton::Index.find_or_create :IANA, file: "index-v1.yaml"
     end
 
     #
@@ -34,60 +33,22 @@ module RelatonIana
     #
     # Parse documents
     #
-    # @param [Integer] page page number
-    #
-    def fetch(page = 1) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
-      params = {
-        q: "repo:ietf-tools/iana-registries extension:xml",
-        page: page, per_page: 100
-      }
-      if ENV["GITHUB_TOKEN"]
-        headers = { "Authorization" => "token #{ENV['GITHUB_TOKEN']}" }
-      end
-      attempt = 0
-      json = {}
-      resp = nil
-      until attempt > 3 || json["items"]
-        if attempt.positive?
-          t = resp.headers["x-ratelimit-reset"].to_i - Time.now.to_i
-          if t.positive?
-            t += 30
-            warn "Rate limit is reached. Retrying in #{t} sec."
-            sleep t
-          end
-        end
-        attempt += 1
-        resp = Faraday.get "https://api.github.com/search/code", params, headers
-        json = JSON.parse resp.body
-      end
-      raise StandardError, json["message"] if json["message"]
-
-      json["items"].each do |item|
-        fetch_doc URI.join(SOURCE, item["path"]).to_s
+    def fetch
+      Dir["iana-registries/**/*.xml"].each do |file|
+        content = File.read file, encoding: "UTF-8"
+        parse(content) if content.include? "<registry"
+      rescue StandardError => e
+        warn "Error: #{e.message}. File: #{file}"
       end
-      fetch(page + 1) if (json["total_count"] - (page * 100)).positive?
+      @index.save
     end
 
-    #
-    # Fetch document
-    #
-    # @param [String] url url of document
-    #
-    def fetch_doc(url) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
-      resp = Net::HTTP.get_response URI(url)
-      if resp.code == "200"
-        return unless resp.body.include? "<registry"
-
-        xml = Nokogiri::XML(resp.body)
-        registry = xml.at("/xmlns:registry")
-        doc = Parser.parse registry
-        save_doc doc
-        registry.xpath("./xmlns:registry").each do |r|
-          save_doc Parser.parse(r, doc)
-        end
-      end
-    rescue StandardError => e
-      warn "Error: #{e.message}. URL: #{url}"
+    def parse(content)
+      xml = Nokogiri::XML(content)
+      registry = xml.at("/xmlns:registry")
+      doc = Parser.parse registry
+      save_doc doc
+      registry.xpath("./xmlns:registry").each { |r| save_doc Parser.parse(r, doc) }
     end
 
     #
@@ -109,6 +70,7 @@ module RelatonIana
       else
         @files << file
       end
+      @index.add_or_update bib.docnumber, file
       File.write file, c, encoding: "UTF-8"
     end
 

data/lib/relaton_iana/iana_bibliography.rb

@@ -3,13 +3,20 @@
 module RelatonIana
   # Methods for search IANA standards.
   module IanaBibliography
-    SOURCE = "https://raw.githubusercontent.com/relaton/relaton-data-iana/main/data/"
+    SOURCE = "https://raw.githubusercontent.com/relaton/relaton-data-iana/main/"
+    INDEX_FILE = "index-v1.yaml"
 
     # @param text [String]
     # @return [RelatonIana::IanaBibliographicItem]
     def search(text) # rubocop:disable Metrics/MethodLength
-      file = text.sub(/^IANA\s/, "").gsub(/[\s,:\/]/, "_").downcase
-      url = "#{SOURCE}#{file}.yaml"
+      # file = text.sub(/^IANA\s/, "").gsub(/[\s,:\/]/, "_").downcase
+      # url = "#{SOURCE}#{file}.yaml"
+      index = Relaton::Index.find_or_create :IANA, url: "#{SOURCE}index-v1.zip", file: INDEX_FILE
+      id = text.sub(/^IANA\s/, "")
+      row = index.search(id).min_by { |i| i[:id] }
+      return unless row
+
+      url = "#{SOURCE}#{row[:file]}"
       resp = Net::HTTP.get_response URI(url)
       return unless resp.code == "200"
 

data/lib/relaton_iana/processor.rb

@@ -50,5 +50,12 @@ module RelatonIana
     def grammar_hash
       @grammar_hash ||= ::RelatonIana.grammar_hash
     end
+
+    #
+    # Remove index file
+    #
+    def remove_index_file
+      Relaton::Index.find_or_create(:IANA, url: true, file: IanaBibliography::INDEX_FILE).remove_file
+    end
   end
 end

data/lib/relaton_iana/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RelatonIana
-  VERSION = "1.14.1"
+  VERSION = "1.14.3"
 end

data/lib/relaton_iana.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "faraday"
-require "jing"
+require "relaton/index"
 require "relaton_bib"
 require_relative "relaton_iana/version"
 require_relative "relaton_iana/iana_bibliographic_item"

data/relaton_iana.gemspec

@@ -12,13 +12,14 @@ Gem::Specification.new do |spec|
   spec.description   = "RelatonIana: Ruby XMLDOC impementation."
   spec.homepage      = "https://github.com/relaton/relaton-iana"
   spec.license       = "BSD-2-Clause"
-  spec.required_ruby_version = ">= 2.5.0"
+  spec.required_ruby_version = ">= 2.7.0"
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'https://mygemserver.com'"
 
   spec.metadata["homepage_uri"] = spec.homepage
   # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
   # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # spec.metadata["rubygems_mfa_required"] = "true"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -30,17 +31,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "rubocop-performance"
-  spec.add_development_dependency "rubocop-rails"
-  spec.add_development_dependency "ruby-jing"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "vcr"
-  spec.add_development_dependency "webmock"
-
-  spec.add_dependency "faraday", "~> 1.0"
+
+  spec.add_dependency "faraday", "~> 2.7.0"
   spec.add_dependency "relaton-bib", "~> 1.14.0"
-  spec.add_dependency "ruby-jing"
+  spec.add_dependency "relaton-index", "~> 0.2.0"
 
   # Uncomment to register a new dependency of your gem
   # spec.add_dependency "example-gem", "~> 1.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-iana
 version: !ruby/object:Gem::Version
-  version: 1.14.1
+  version: 1.14.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-05 00:00:00.000000000 Z
+date: 2023-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: equivalent-xml
@@ -24,118 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  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: rubocop-performance
-  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: rubocop-rails
-  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: 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'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 2.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 2.7.0
 - !ruby/object:Gem::Dependency
   name: relaton-bib
   requirement: !ruby/object:Gem::Requirement
@@ -151,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.14.0
 - !ruby/object:Gem::Dependency
-  name: ruby-jing
+  name: relaton-index
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.2.0
 description: 'RelatonIana: Ruby XMLDOC impementation.'
 email:
 - open.source@ribose.com
@@ -211,14 +113,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: 'RelatonIana: Ruby XMLDOC impementation.'