Update logger (#121)

* Switch to using relaton-logger to log messages * fix base64 issue with Ruby 3.4
relaton · Jul 3, 2024 · b6dc86d · b6dc86d
1 parent 50d146b
commit b6dc86d
Show file tree

Hide file tree

Showing 32 changed files with 31,920 additions and 30,793 deletions.
diff --git a/README.adoc b/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 ...
@@ -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.

diff --git a/grammars/basicdoc.rng b/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"/>

diff --git a/lib/relaton_ietf.rb b/lib/relaton_ietf.rb
@@ -4,7 +4,6 @@
 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"

diff --git a/lib/relaton_ietf/config.rb b/lib/relaton_ietf/config.rb
diff --git a/lib/relaton_ietf/data_fetcher.rb b/lib/relaton_ietf/data_fetcher.rb
@@ -168,8 +168,8 @@ def fetch_ieft_rfcs
       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 @@ def save_doc(entry, check_duplicate: true) # rubocop:disable Metrics/MethodLengt
           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

diff --git a/lib/relaton_ietf/document_type.rb b/lib/relaton_ietf/document_type.rb
@@ -9,7 +9,7 @@ def initialize(type:, abbreviation: nil)
 
     def check_type(type)
       unless DOCTYPES.include? type
-        Util.warn "WARNING: Invalid doctype: `#{type}`"
+        Util.warn "Invalid doctype: `#{type}`"
       end
     end
   end

diff --git a/lib/relaton_ietf/ietf_bibliography.rb b/lib/relaton_ietf/ietf_bibliography.rb
@@ -18,13 +18,13 @@ def search(text)
       #   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

diff --git a/lib/relaton_ietf/util.rb b/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
diff --git a/lib/relaton_ietf/version.rb b/lib/relaton_ietf/version.rb
@@ -1,3 +1,3 @@
 module RelatonIetf
-  VERSION = "1.18.0".freeze
+  VERSION = "1.19.0".freeze
 end
diff --git a/lib/relaton_ietf/xml_parser.rb b/lib/relaton_ietf/xml_parser.rb
@@ -32,6 +32,10 @@ def fetch_editorialgroup(ext)
         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
diff --git a/relaton_ietf.gemspec b/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.19.0"
   spec.add_dependency "relaton-index", "~> 0.2.3"
 end
diff --git a/spec/examples/bcp_47.xml b/spec/examples/bcp_47.xml
@@ -1,21 +1,124 @@
-<bibdata type="standard" schema-version="v1.2.8">
-  <fetched>2022-11-26</fetched>
+<bibdata type="standard" schema-version="v1.2.9">
+  <fetched>2024-03-07</fetched>
   <title format="text/plain" language="en" script="Latn">Best Current Practice 47</title>
   <uri type="src">https://www.rfc-editor.org/info/bcp47</uri>
   <docidentifier type="IETF" primary="true">BCP 47</docidentifier>
   <docnumber>BCP0047</docnumber>
   <language>en</language>
   <script>Latn</script>
   <relation type="includes">
-    <bibitem>
-      <formattedref format="text/plain">RFC4647</formattedref>
+    <bibitem type="standard">
+      <title type="main" format="text/plain">Matching of Language Tags</title>
+      <uri type="src">https://www.rfc-editor.org/info/rfc4647</uri>
       <docidentifier type="IETF" primary="true">RFC 4647</docidentifier>
+      <docidentifier type="DOI">10.17487/RFC4647</docidentifier>
+      <docnumber>RFC4647</docnumber>
+      <date type="published">
+        <on>2006-09</on>
+      </date>
+      <contributor>
+        <role type="editor"/>
+        <person>
+          <name>
+            <completename language="en" script="Latn">A. Phillips</completename>
+          </name>
+        </person>
+      </contributor>
+      <contributor>
+        <role type="editor"/>
+        <person>
+          <name>
+            <completename language="en" script="Latn">M. Davis</completename>
+          </name>
+        </person>
+      </contributor>
+      <contributor>
+        <role type="publisher"/>
+        <organization>
+          <name>RFC Publisher</name>
+        </organization>
+      </contributor>
+      <contributor>
+        <role type="authorizer"/>
+        <organization>
+          <name>RFC Series</name>
+        </organization>
+      </contributor>
+      <language>en</language>
+      <script>Latn</script>
+      <abstract format="text/html" language="en" script="Latn">
+        <p>This document describes a syntax, called a "language-range", for specifying items in a user's list of language preferences. It also describes different mechanisms for comparing and matching these to language tags. Two kinds of matching mechanisms, filtering and lookup, are defined. Filtering produces a (potentially empty) set of language tags, whereas lookup produces a single language tag. Possible applications include language negotiation or content selection. This document, in combination with RFC 4646, replaces RFC 3066, which replaced RFC 1766. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.</p>
+      </abstract>
+      <series>
+        <title format="text/plain">BCP</title>
+        <number>47</number>
+      </series>
+      <series>
+        <title format="text/plain">RFC</title>
+        <number>4647</number>
+      </series>
+      <series type="stream">
+        <title format="text/plain">IETF</title>
+      </series>
+      <keyword>Lang-Tag</keyword>
     </bibitem>
   </relation>
   <relation type="includes">
-    <bibitem>
-      <formattedref format="text/plain">RFC5646</formattedref>
+    <bibitem type="standard">
+      <title type="main" format="text/plain">Tags for Identifying Languages</title>
+      <uri type="src">https://www.rfc-editor.org/info/rfc5646</uri>
       <docidentifier type="IETF" primary="true">RFC 5646</docidentifier>
+      <docidentifier type="DOI">10.17487/RFC5646</docidentifier>
+      <docnumber>RFC5646</docnumber>
+      <date type="published">
+        <on>2009-09</on>
+      </date>
+      <contributor>
+        <role type="editor"/>
+        <person>
+          <name>
+            <completename language="en" script="Latn">A. Phillips</completename>
+          </name>
+        </person>
+      </contributor>
+      <contributor>
+        <role type="editor"/>
+        <person>
+          <name>
+            <completename language="en" script="Latn">M. Davis</completename>
+          </name>
+        </person>
+      </contributor>
+      <contributor>
+        <role type="publisher"/>
+        <organization>
+          <name>RFC Publisher</name>
+        </organization>
+      </contributor>
+      <contributor>
+        <role type="authorizer"/>
+        <organization>
+          <name>RFC Series</name>
+        </organization>
+      </contributor>
+      <language>en</language>
+      <script>Latn</script>
+      <abstract format="text/html" language="en" script="Latn">
+        <p>This document describes the structure, content, construction, and semantics of language tags for use in cases where it is desirable to indicate the language used in an information object. It also describes how to register values for use in language tags and the creation of user-defined extensions for private interchange. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.</p>
+      </abstract>
+      <series>
+        <title format="text/plain">BCP</title>
+        <number>47</number>
+      </series>
+      <series>
+        <title format="text/plain">RFC</title>
+        <number>5646</number>
+      </series>
+      <series type="stream">
+        <title format="text/plain">IETF</title>
+      </series>
+      <keyword>language tags</keyword>
+      <keyword>private interchange</keyword>
     </bibitem>
   </relation>
 </bibdata>
diff --git a/spec/examples/bib_item.xml b/spec/examples/bib_item.xml
@@ -1,4 +1,4 @@
-<bibdata type="standard" schema-version="v1.2.8">
+<bibdata type="standard" schema-version="v1.2.9">
   <fetched>2023-07-02</fetched>
   <title type="main" format="text/plain">Network Configuration Access Control Model</title>
   <uri type="src">https://www.rfc-editor.org/info/rfc8341</uri>

diff --git a/spec/examples/from-bibxm-ids.xml b/spec/examples/from-bibxm-ids.xml
@@ -1,4 +1,4 @@
-<bibdata type="standard" schema-version="v1.2.8">
+<bibdata type="standard" schema-version="v1.2.9">
   <title format="text/plain" language="en" script="Latn">Forming Intuitive Email Addresses</title>
   <uri type="src">https://datatracker.ietf.org/doc/html/draft--pale-email-00</uri>
   <docidentifier type="Internet-Draft" primary="true">draft--pale-email-00</docidentifier>

diff --git a/spec/examples/from_yaml.xml b/spec/examples/from_yaml.xml
@@ -1,4 +1,4 @@
-<bibdata type="standard" schema-version="v1.2.8">
+<bibdata type="standard" schema-version="v1.2.9">
   <fetched>2022-06-22</fetched>
   <title format="text/plain" language="en" script="Latn">Network Configuration Access Control Model</title>
   <uri type="src">https://www.rfc-editor.org/info/rfc8341</uri>

diff --git a/spec/examples/i_d_bib_item.xml b/spec/examples/i_d_bib_item.xml
@@ -1,4 +1,4 @@
-<bibdata type="standard" schema-version="v1.2.8">
+<bibdata type="standard" schema-version="v1.2.9">
   <fetched>2023-03-08</fetched>
   <title format="text/plain" language="en" script="Latn">Centralized Conferencing (XCON) Media Models</title>
   <uri type="src">https://datatracker.ietf.org/doc/html/draft-burger-xcon-mmodels-00</uri>

diff --git a/spec/examples/rfc_xml.xml b/spec/examples/rfc_xml.xml
@@ -1,4 +1,4 @@
-<bibdata type="standard" schema-version="v1.2.8">
+<bibdata type="standard" schema-version="v1.2.9">
   <title format="text/plain" language="en" script="Latn">ACVP Secure Hash Algorithm (SHA) JSON Specification</title>
   <docidentifier type="Internet-Draft" primary="true">draft-ietf-acvp-subsha-1.0</docidentifier>
   <docidentifier type="IETF" scope="docName">draft-ietf-acvp-subsha-1.0</docidentifier>

diff --git a/spec/relaton_ietf/config_spec.rb b/spec/relaton_ietf/config_spec.rb
diff --git a/spec/relaton_ietf/data_fetcher_spec.rb b/spec/relaton_ietf/data_fetcher_spec.rb
@@ -223,7 +223,7 @@
       expect(File).to receive(:write)
         .with("dir/RFC0001.xml", "<xml/>", encoding: "UTF-8")
       expect { subject.save_doc entry }
-        .to output(/File dir\/RFC0001.xml already exists/).to_stderr
+        .to output(/File dir\/RFC0001.xml already exists/).to_stderr_from_any_process
     end
 
     it "downcase file name for ID" do

diff --git a/spec/relaton_ietf/document_type_spec.rb b/spec/relaton_ietf/document_type_spec.rb
@@ -2,6 +2,6 @@
   it "warn if doctype is invalid" do
     expect do
       described_class.new type: "type"
-    end.to output(/\[relaton-ietf\] WARNING: Invalid doctype: `type`/).to_stderr_from_any_process
+    end.to output(/\[relaton-ietf\] WARN: Invalid doctype: `type`/).to_stderr_from_any_process
   end
 end
diff --git a/spec/relaton_ietf/ietf_bibliographic_item_spec.rb b/spec/relaton_ietf/ietf_bibliographic_item_spec.rb
@@ -48,13 +48,13 @@
       expect(subject.to_hash).to eq(
         "docid" => [{ "id" => "RFC 123", "type" => "IETF" }], "doctype" => { "type" => "RFC" },
         "ext" => { "schema-version" => "v1.0.1", "stream" => "IETF" },
-        "id" => "RFC123", "schema-version" => "v1.2.8"
+        "id" => "RFC123", "schema-version" => "v1.2.9"
       )
     end
 
     it "to_xml" do
       expect(subject.to_xml(bibdata: true)).to be_equivalent_to <<~XML
-        <bibdata schema-version="v1.2.8">
+        <bibdata schema-version="v1.2.9">
           <docidentifier type="IETF">RFC 123</docidentifier>
           <ext schema-version="v1.0.1">
             <doctype>RFC</doctype>

diff --git a/spec/relaton_ietf/util_spec.rb b/spec/relaton_ietf/util_spec.rb
diff --git a/spec/relaton_ietf/xml_parser_spec.rb b/spec/relaton_ietf/xml_parser_spec.rb
@@ -16,4 +16,13 @@
     expect(bib.docidentifier.first.id).to eq "RFC0001"
     expect(bib.stream).to eq "IETF"
   end
+
+  it "create_doctype" do
+    node = double(text: "rfc")
+    expect(node).to receive(:[]).with(:abbreviation).and_return("RFC")
+    dt = described_class.send(:create_doctype, node)
+    expect(dt).to be_instance_of RelatonIetf::DocumentType
+    expect(dt.type).to eq "rfc"
+    expect(dt.abbreviation).to eq "RFC"
+  end
 end