relaton-ietf 1.18.0 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7ccd4ea0f415da49834c5f36c55fab2221cc55513a2c3bcf2c84c3d2b3a286f4
-  data.tar.gz: ab1c7c6723f9b539169008884cf9046b2bf468b9e998177d8b559ffbb5f83680
+  metadata.gz: 5b14e8a50bb7cffacc0240b4c6dc5ecba37030f732865d55feebc6da373e62de
+  data.tar.gz: fdd4c0909501f41468c107d4a878b0eb773387e15122cf7a50400de9c503e2be
 SHA512:
-  metadata.gz: c5dff62f7628ed91866d1c7e40e1b713c83902baecd9766db1dd2774c0aaed1de4a2b47af2747c8fd0bc60c65e3ff41b3c6b7e81343016aa8188abe4cb471f9b
-  data.tar.gz: 63cf7decbfcd31a77138ed61d82563bff5896eb6e83a8ac278529983bdc1b59de88928e11306bbff7ffa86cde7c1002342c034730741393f83a4b587cf49c961
+  metadata.gz: 4002fdfb039cde01925f7b68fd3e12d4859c181140065d7478b49c41c8d4dce7dfee23b6969e9a87a3ac66f362352623f9f3fe389b85cad036f565070919eec3
+  data.tar.gz: c3b027ee8e2c6101dde78d99173fd19c5838128ccdce2fb126721f86a42cb701bf8142c17e82a4306b3ce852d09b2d5438321cde72d67412386619bc3ec2e059

data/README.adoc

@@ -33,24 +33,13 @@ Or install it yourself as:
 
 == Usage
 
-=== Configuration
-
-Configuration is optional. The available option is `logger` which is a `Logger` instance. By default, the logger is `Logger.new($stderr)` with `Logger::WARN` level. To change the logger level, use `RelatonIetf.configure` block.
+=== Fetching documents
 
 [source,ruby]
 ----
 require 'relaton_ietf'
 => true
 
-RelatonIetf.configure do |config|
-  config.logger.level = Logger::DEBUG
-end
-----
-
-=== Fetching documents
-
-[source,ruby]
-----
 # Fetch RFC document
 item = RelatonIetf::IetfBibliography.get 'IETF RFC 8341'
 [relaton-ietf] (IETF RFC 8341) Fetching from Relaton repository ...
@@ -115,7 +104,7 @@ IETF documents may have `src`, `xml`, and `doi` link types.
 [source,ruby]
 ----
 item.link
-=> [#<RelatonBib::TypedUri:0x00007fe8b287a120 @content=#<Addressable::URI:0x7e4 URI:https://raw.githubusercontent.com/relaton/relaton-data-ietf/master/data/reference.RFC.8341.xml>, @type="xml">,
+=> [#<RelatonBib::TypedUri:0x00007fe8b287a120 @content=#<Addressable::URI:0x7e4 URI:https://raw.githubusercontent.com/relaton/relaton-data-rfcs/main/data/reference.RFC.8341.xml>, @type="xml">,
  #<RelatonBib::TypedUri:0x00007fe8b2237ec0 @content=#<Addressable::URI:0x7f8 URI:https://www.rfc-editor.org/info/rfc8341>, @type="src">]
 ----
 
@@ -165,6 +154,10 @@ Done in: 360 sec.
 => nil
 ----
 
+=== Logging
+
+RelatonIetf uses the relaton-logger gem for logging. By default, it logs to STDOUT. To change the log levels and add other loggers, read the https://github.com/relaton/relaton-logger#usage[relaton-logger] documentation.
+
 == Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/metanorma/relaton-ietf.

data/grammars/basicdoc.rng

@@ -244,6 +244,9 @@
         <data type="ID"/>
       </attribute>
       <attribute name="reviewer"/>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="date">
           <data type="dateTime"/>

data/lib/relaton_ietf/data_fetcher.rb

@@ -168,8 +168,8 @@ module RelatonIetf
       rfc_index.xpath("xmlns:rfc-entry").each do |doc|
         save_doc RfcEntry.parse(doc)
       rescue StandardError => e
-        warn "Error parsing #{doc.at('./xmlns:doc-id').text}: #{e.message}"
-        warn e.backtrace[0..5].join("\n")
+        Util.error "Error parsing #{doc.at('./xmlns:doc-id').text}: #{e.message}\n" \
+          "#{e.backtrace[0..5].join("\n")}"
       end
     end
 
@@ -199,7 +199,7 @@ module RelatonIetf
           end
       file = file_name entry
       if check_duplicate && @files.include?(file)
-        warn "File #{file} already exists. Document: #{entry.docnumber}"
+        Util.warn "File #{file} already exists. Document: #{entry.docnumber}"
       elsif check_duplicate
         @files << file
       end

data/lib/relaton_ietf/document_type.rb

@@ -9,7 +9,7 @@ module RelatonIetf
 
     def check_type(type)
       unless DOCTYPES.include? type
-        Util.warn "WARNING: Invalid doctype: `#{type}`"
+        Util.warn "Invalid doctype: `#{type}`"
       end
     end
   end

data/lib/relaton_ietf/ietf_bibliographic_item.rb

@@ -67,6 +67,10 @@ module RelatonIetf
       hash
     end
 
+    def has_ext?
+      super || stream
+    end
+
     #
     # Render BibXML (RFC)
     #

data/lib/relaton_ietf/ietf_bibliography.rb

@@ -18,13 +18,13 @@ module RelatonIetf
       #   reference is required
       # @return [RelatonIetf::IetfBibliographicItem] Relaton of reference
       def get(code, _year = nil, _opts = {})
-        Util.warn "(#{code}) Fetching from Relaton repository ..."
+        Util.info "Fetching from Relaton repository ...", key: code
         result = search code
         if result
           docid = result.docidentifier.detect(&:primary) || result.docidentifier.first
-          Util.warn "(#{code}) Found: `#{docid.id}`"
+          Util.info "Found: `#{docid.id}`", key: code
         else
-          Util.warn "(#{code}) Not found."
+          Util.info "Not found.", key: code
         end
         result
       end

data/lib/relaton_ietf/rfc_index_entry.rb

@@ -123,10 +123,12 @@ module RelatonIetf
     #
     def parse_relation
       @is_also.map do |ref|
-        fref = RelatonBib::FormattedRef.new content: ref
-        id = ref.sub(/^([A-Z]+)0*(\d+)$/, '\1 \2')
-        docid = RelatonBib::DocumentIdentifier.new(type: "IETF", id: id, primary: true)
-        bib = IetfBibliographicItem.new formattedref: fref, docid: [docid]
+        entry = @doc.at("/xmlns:rfc-index/xmlns:rfc-entry[xmlns:doc-id = '#{ref}']")
+        bib = RfcEntry.parse entry
+        # fref = RelatonBib::FormattedRef.new content: ref
+        # id = ref.sub(/^([A-Z]+)0*(\d+)$/, '\1 \2')
+        # docid = RelatonBib::DocumentIdentifier.new(type: "IETF", id: id, primary: true)
+        # bib = IetfBibliographicItem.new formattedref: fref, docid: [docid]
         { type: "includes", bibitem: bib }
       end
     end

data/lib/relaton_ietf/util.rb

@@ -1,9 +1,6 @@
 module RelatonIetf
   module Util
     extend RelatonBib::Util
-
-    def self.logger
-      RelatonIetf.configuration.logger
-    end
+    PROGNAME = "relaton-ietf".freeze
   end
 end

data/lib/relaton_ietf/version.rb

@@ -1,3 +1,3 @@
 module RelatonIetf
-  VERSION = "1.18.0".freeze
+  VERSION = "1.20.0".freeze
 end

data/lib/relaton_ietf/xml_parser.rb

@@ -32,6 +32,10 @@ module RelatonIetf
         end
         RelatonBib::EditorialGroup.new eg if eg.any?
       end
+
+      def create_doctype(type)
+        DocumentType.new type: type.text, abbreviation: type[:abbreviation]
+      end
     end
   end
 end

data/lib/relaton_ietf.rb

@@ -4,7 +4,6 @@ require "net/http"
 require "relaton/index"
 require "relaton_bib"
 require "relaton_ietf/version"
-require "relaton_ietf/config"
 require "relaton_ietf/util"
 require "relaton_ietf/document_type"
 require "relaton_ietf/bibxml_parser"

data/relaton_ietf.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
-  spec.add_dependency "relaton-bib", "~> 1.18.0"
+  spec.add_dependency "base64"
+  spec.add_dependency "relaton-bib", "~> 1.20.0"
   spec.add_dependency "relaton-index", "~> 0.2.3"
 end

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ietf
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.20.0
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-07 00:00:00.000000000 Z
+date: 2024-12-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: relaton-bib
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.20.0
 - !ruby/object:Gem::Dependency
   name: relaton-index
   requirement: !ruby/object:Gem::Requirement
@@ -71,7 +85,6 @@ files:
 - lib/relaton_ietf.rb
 - lib/relaton_ietf/bibxml_parser.rb
 - lib/relaton_ietf/committee.rb
-- lib/relaton_ietf/config.rb
 - lib/relaton_ietf/data_fetcher.rb
 - lib/relaton_ietf/document_type.rb
 - lib/relaton_ietf/hash_converter.rb
@@ -90,7 +103,7 @@ homepage: https://github.com/metanorma/relaton-ietf
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -105,8 +118,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: 'RelatonIetf: retrieve IETF Standards for bibliographic use using the BibliographicItem
   model'

data/lib/relaton_ietf/config.rb

@@ -1,10 +0,0 @@
-module RelatonIetf
-  module Config
-    include RelatonBib::Config
-  end
-  extend Config
-
-  class Configuration < RelatonBib::Configuration
-    PROGNAME = "relaton-ietf".freeze
-  end
-end