relaton-ieee 1.18.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf78a4fc108fabc66a60e78c2d778815e73b80b2123f0e5899cb9d566da600d0
-  data.tar.gz: 52979885f297a4f1682ba8b56f5a966f6cd73d11253ddef6769c3cd8c692ad48
+  metadata.gz: 4e671fb3b9fe9adc6d69c46f8d5757dd73e35dd324df9516eda63452ca5c3e8d
+  data.tar.gz: aa265d86a448bfdd00b893f93b8008f3fb22794419f6ecf63bcf0932bb4af46e
 SHA512:
-  metadata.gz: bab3ad84a8178bc8a5e357d263eecfe473d12f17b626a5c7ccfb923571264559f4e792baf1821bbc63dd022ffd320cd81774a383cb384c89d9c2a88f6d89e8e6
-  data.tar.gz: c37818c7d5c83941740ad6ace8844b17facdec4c65c198de601d7a59a6b018af7f0929a924cda66ad5b0c5c3894e4a34e11d510f52e3d667a05d55bbeb824b2b
+  metadata.gz: 5f690ba8cc419d3065b62bc2a5cc3dfd195a3d892219a05bf644e5a5e6f7ad081ce4d5486e5e65ee872a3640e709c1c0f639d7abd604139af5f18fd715591e0f
+  data.tar.gz: 5774082f3f48195883cdba7fa4d5cb9e092049405513f69c790db981ff159234827d16d698e4c57cc953eec0d4c15fe96359880e350eff21872f48af69768590

data/README.adoc

@@ -23,24 +23,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 `RelatonIeee.configure` block.
+=== Search for a standard using keywords
 
 [source,ruby]
 ----
 require 'relaton_ieee'
 => true
 
-RelatonIeee.configure do |config|
-  config.logger.level = Logger::DEBUG
-end
-----
-
-=== Search for a standard using keywords
-
-[source,ruby]
-----
 item = RelatonIeee::IeeeBibliography.search("IEEE 528-2019")
 => #<RelatonIeee::IeeeBibliographicItem:0x00007fe12ebc8cb8
 ...
@@ -139,6 +128,10 @@ Done in: 143 sec.
 => nil
 ----
 
+=== Logging
+
+RelatonIeee 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.
+
 == Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

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_ieee/balloting_group.rb

@@ -13,7 +13,7 @@ module RelatonIeee
     #
     def initialize(type:, content:)
       unless TYPES.include?(type)
-        Util.warn "WARNING: type of Balloting group must be one of `#{TYPES.join('`, `')}`"
+        Util.warn "type of Balloting group must be one of `#{TYPES.join('`, `')}`"
       end
 
       @type = type

data/lib/relaton_ieee/data_fetcher.rb

@@ -61,9 +61,7 @@ module RelatonIeee
               end
         fetch_doc xml, f
       rescue StandardError => e
-        warn "File: #{f}"
-        warn e.message
-        warn e.backtrace
+        Util.error "File: #{f}\n#{e.message}\n#{e.backtrace}"
       end
       # File.write "normtitles.txt", @normtitles.join("\n")
       update_relations
@@ -92,7 +90,7 @@ module RelatonIeee
     def fetch_doc(xml, filename) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       doc = Nokogiri::XML(xml).at("/publication")
       unless doc
-        warn "Empty file: #{filename}"
+        Util.warn "Empty file: `#{filename}`"
         return
       end
       stdid = doc.at("./publicationinfo/standard_id")&.text
@@ -102,14 +100,14 @@ module RelatonIeee
       bib = fetcher.parse
       if bib.docnumber.nil?
         nt = doc&.at("./normtitle")&.text
-        warn "PubID parse error. Normtitle: #{nt}, file: #{filename}"
+        Util.warn "PubID parse error. Normtitle: `#{nt}`, file: `#{filename}`"
         return
       end
       amsid = doc.at("./publicationinfo/amsid").text
       if backrefs.value?(bib.docidentifier[0].id) && /updates\.\d+/ !~ filename
         oamsid = backrefs.key bib.docidentifier[0].id
-        warn "Document exists ID: \"#{bib.docidentifier[0].id}\" AMSID: " \
-             "\"#{amsid}\" source: \"#{filename}\". Other AMSID: \"#{oamsid}\""
+        Util.warn "Document exists ID: `#{bib.docidentifier[0].id}` AMSID: " \
+             "`#{amsid}` source: `#{filename}`. Other AMSID: `#{oamsid}`"
         if bib.docidentifier[0].id.include?(doc.at("./publicationinfo/stdnumber").text)
           save_doc bib # rewrite file if the PubID matches to the stdnumber
           backrefs[amsid] = bib.docidentifier[0].id
@@ -177,7 +175,7 @@ module RelatonIeee
               save_doc bib
             end
           else
-            warn "Unresolved relation: '#{rf[:amsid]}' type: '#{rf[:type]}' for '#{dnum}'"
+            Util.warn "Unresolved relation: '#{rf[:amsid]}' type: '#{rf[:type]}' for '#{dnum}'"
           end
         end
       end

data/lib/relaton_ieee/document_type.rb

@@ -9,8 +9,7 @@ module RelatonIeee
 
     def check_type(type)
       unless DOCTYPES.include? type
-        Util.warn "Invalid doctype: `#{type}`. " \
-                  "It should be one of: `#{DOCTYPES.join('`, `')}`."
+        Util.warn "Invalid doctype: `#{type}`. It should be one of: `#{DOCTYPES.join('`, `')}`."
       end
     end
   end

data/lib/relaton_ieee/ieee_bibliography.rb

@@ -38,13 +38,13 @@ module RelatonIeee
       #   if document is found else returns NilClass
       #
       def get(code, _year = nil, _opts = {}) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
-        Util.warn "(#{code}) Fetching from Relaton repository ..."
+        Util.info "Fetching from Relaton repository ...", key: code
         item = search(code)
         if item
-          Util.warn "(#{code}) Found: `#{item.docidentifier.first.id}`"
+          Util.info "Found: `#{item.docidentifier.first.id}`", key: code
           item
         else
-          Util.warn "(#{code}) Not found."
+          Util.info "Not found.", key: code
           nil
         end
       end

data/lib/relaton_ieee/util.rb

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

data/lib/relaton_ieee/version.rb

@@ -1,3 +1,3 @@
 module RelatonIeee
-  VERSION = "1.18.0".freeze
+  VERSION = "1.19.0".freeze
 end

data/lib/relaton_ieee/xml_parser.rb

@@ -57,6 +57,10 @@ module RelatonIeee
 
         BallotingGroup.new type: bg[:type], content: bg.text
       end
+
+      def create_doctype(type)
+        DocumentType.new type: type.text, abbreviation: type[:abbreviation]
+      end
     end
   end
 end

data/lib/relaton_ieee.rb

@@ -4,7 +4,6 @@ require "yaml"
 require "relaton/index"
 require "relaton_bib"
 require "relaton_ieee/version"
-require "relaton_ieee/config"
 require "relaton_ieee/util"
 require "relaton_ieee/document_type"
 require "relaton_ieee/document_status"

data/relaton_ieee.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "faraday", "~> 2.7.0"
   spec.add_dependency "mini_portile2", "~> 2.8.0"
-  spec.add_dependency "relaton-bib", "~> 1.18.0"
+  spec.add_dependency "relaton-bib", "~> 1.19.0"
   spec.add_dependency "relaton-index", "~> 0.2.0"
   spec.add_dependency "rubyzip", "~> 2.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-ieee
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-07 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.19.0
 - !ruby/object:Gem::Dependency
   name: relaton-index
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +109,6 @@ files:
 - lib/relaton_ieee.rb
 - lib/relaton_ieee/balloting_group.rb
 - lib/relaton_ieee/bibxml_parser.rb
-- lib/relaton_ieee/config.rb
 - lib/relaton_ieee/data_fetcher.rb
 - lib/relaton_ieee/data_parser.rb
 - lib/relaton_ieee/document_status.rb
@@ -146,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: 'RelatonIeee: retrieve IEEE Standards for bibliographic use using the IeeeBibliographicItem

data/lib/relaton_ieee/config.rb

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