relaton-itu 1.18.1 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4feed9e3d20fa1ff371c313f632f82a18285cd21a1437ddc1d0e1f0840e77b52
-  data.tar.gz: 4d8e6ab3951378ef210e7759702baacff44af33b401fbdc9fee9ec20fe961c47
+  metadata.gz: 219f17d8c2ce91f1cda9b3d9a62dcff98acfda8509da719e2d85c5b7f889bdbb
+  data.tar.gz: 7e3571c36ed301ffe9e1810cab3a877c9657a54c16981905f4ff38c9028182a2
 SHA512:
-  metadata.gz: ba1d009a5e8ef6744ebc47b58fe581573f4db7ca2d91ff67fba3b0207160d5e82ca422fdb36712fd145d1e2e5c742b2d09d2071a596c7148c229bc9eeb742b92
-  data.tar.gz: 659b0cbc5e52f96ebee57eba1090b5010539e9edfc81f0dd25435e153eb1b7e9aec6579edde895e144a57fe7ca5664067607c9783d9b3874cab20627951a83e9
+  metadata.gz: 7bd181e792b81c2edf7a8e21133e8241ac3e918f930911631ab1adf9a1e1207281c0845b858d024bf39f025bb7ef212cba834c3efe1e8ac7afcae19a262f3451
+  data.tar.gz: 61b8a6c59a46a2197bd3cc0af81397407f5f617ef9819b66b2a2d97619bffdbfa24a4fba6b3fe8d5dc0d264c23a4bb0441608da4802dc3b097c361fed655edfc

data/README.adoc

@@ -29,24 +29,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 `RelatonItu.configure` block.
+=== Search for a standard using keywords
 
 [source,ruby]
 ----
 require 'relaton_itu'
 => true
 
-RelatonItu.configure do |config|
-  config.logger.level = Logger::DEBUG
-end
-----
-
-=== Search for a standard using keywords
-
-[source,ruby]
-----
 hit_collection = RelatonItu::ItuBibliography.search("ITU-T L.163")
 => <RelatonItu::HitCollection:0x007fbf5fb4ab60 @ref=ITU-T L.163 @fetched=false>
 
@@ -165,6 +154,10 @@ Done in: 390 sec.
 => nil
 ----
 
+=== Logging
+
+RelatonItu 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_itu/data_fetcher.rb

@@ -36,8 +36,7 @@ module RelatonItu
       bib = DataParserR.parse doc, url, type
       write_file bib
     rescue => e # rubocop:disable Style/RescueStandardError
-      warn e.message
-      warn e.backtrace
+      Util.error "#{e.message}\n#{e.backtrace}"
     end
 
     def self.fetch(output: "data", format: "yaml")
@@ -128,7 +127,7 @@ module RelatonItu
       id = bib.docidentifier[0].id.gsub(/[\s.]/, "_")
       file = "#{@output}/#{id}.#{@ext}"
       if files.include? file
-        warn "File #{file} exists."
+        Util.warn "File #{file} exists."
       else
         files << file
       end

data/lib/relaton_itu/document_type.rb

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

data/lib/relaton_itu/editorial_group.rb

@@ -17,8 +17,7 @@ module RelatonItu
     # @param workgroup [Hash, RelatonItu::ItuGroup, NilClass]
     def initialize(bureau:, group:, subgroup: nil, workgroup: nil)
       unless BUREAUS.include? bureau
-        Util.warn "WARNING: Invalid bureau: `#{bureau}`"
-        Util.warn "WARNING: Valid bureaus are: `#{BUREAUS.join('`, `')}`"
+        Util.warn "Invalid bureau: `#{bureau}`\nValid bureaus are: `#{BUREAUS.join('`, `')}`"
       end
       @bureau = bureau
       @group = group.is_a?(Hash) ? ItuGroup.new(**group) : group

data/lib/relaton_itu/hit_collection.rb

@@ -40,7 +40,7 @@ module RelatonItu
     private
 
     def request_search
-      Util.warn "(#{@refid}) Fetching from www.itu.int ..."
+      Util.info "Fetching from www.itu.int ...", key: @refid.to_s
       url = "#{DOMAIN}/net4/ITU-T/search/GlobalSearch/RunSearch"
       data = { json: params.to_json }
       resp = agent.post url, data
@@ -48,7 +48,7 @@ module RelatonItu
     end
 
     def request_document # rubocop:todo Metrics/MethodLength, Metrics/AbcSize
-      Util.warn "(#{@refid}) Fetching from Relaton repository ..."
+      Util.info "Fetching from Relaton repository ...", key: @refid.to_s
       index = Relaton::Index.find_or_create :itu, url: "#{GH_ITU_R}index-v1.zip", file: INDEX_FILE
       row = index.search(@refid.to_ref).min_by { |i| i[:id] }
       return unless row

data/lib/relaton_itu/itu_bibliography.rb

@@ -23,8 +23,7 @@ module RelatonItu
       refid = RelatonItu::Pubid.parse refid if refid.is_a? String
       if refid.to_ref =~ /(ITU[\s-]T\s\w)\.(Suppl\.|Annex)\s?(\w?\d+)/
         correct_ref = "#{$~[1]} #{$~[2]} #{$~[3]}"
-        Util.warn "WARNING: Incorrect reference: `#{refid}`"
-        Util.warn "the reference should be: `#{correct_ref}`"
+        Util.info "Incorrect reference: `#{refid}`, the reference should be: `#{correct_ref}`"
       end
       HitCollection.new refid
     rescue SocketError, Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse,
@@ -63,13 +62,13 @@ module RelatonItu
     private
 
     def fetch_ref_err(refid, missed_years) # rubocop:disable Metrics/MethodLength
-      # Util.warn "WARNING: no match found online for `#{refid}`. " \
+      # Util.warn "no match found online for `#{refid}`. " \
       #           "The code must be exactly like it is on the standards website."
-      Util.warn "(#{refid}) Not found."
+      Util.info "Not found.", key: refid.to_s
       if missed_years.any?
         plural = missed_years.size > 1 ? "s" : ""
-        Util.warn "(#{refid}) There was no match for `#{refid.year}` year, though " \
-                  "there were matches found for `#{missed_years.join('`, `')}` year#{plural}."
+        Util.info "There was no match for `#{refid.year}` year, though there were matches " \
+                  "found for `#{missed_years.join('`, `')}` year#{plural}.", key: refid.to_s
       end
       # if /\d-\d/.match? refid.code
       #   warn "[relaton-itu] The provided document part may not exist, or " \
@@ -144,7 +143,7 @@ module RelatonItu
       result = search_filter(refid) || return
       ret = isobib_results_filter(result, refid)
       if ret[:ret]
-        Util.warn "(#{refid}) Found: `#{ret[:ret].docidentifier.first&.id}`"
+        Util.info "Found: `#{ret[:ret].docidentifier.first&.id}`", key: refid.to_s
         ret[:ret]
       else
         fetch_ref_err(refid, ret[:years])

data/lib/relaton_itu/pubid.rb

@@ -65,8 +65,8 @@ module RelatonItu
       id_parts = Parser.new.parse(id).to_h.transform_values(&:to_s)
       new(**id_parts)
     rescue Parslet::ParseFailed => e
-      Util.warn "WARNING: `#{id}` is invalid ITU publication identifier \n" \
-                "#{e.parse_failure_cause.ascii_tree}"
+      Util.error  "`#{id}` is invalid ITU publication identifier\n" \
+                  "#{e.parse_failure_cause.ascii_tree}"
       raise e
     end
 

data/lib/relaton_itu/scrapper.rb

@@ -87,7 +87,7 @@ module RelatonItu
           script: "Latn",
         }]
       rescue Mechanize::ResponseCodeError => e
-        Util.warn "HTTP Service Unavailable: #{e.message}"
+        Util.error "HTTP Service Unavailable: #{e.message}"
         []
       end
 

data/lib/relaton_itu/structured_identifier.rb

@@ -11,7 +11,7 @@ module RelatonItu
     # @param annexid [String, NilClass]
     def initialize(bureau:, docnumber:, annexid: nil)
       unless EditorialGroup::BUREAUS.include? bureau
-        Util.warn "WARNING: Invalid bureau: `#{bureau}`"
+        Util.warn "Invalid bureau: `#{bureau}`"
       end
       @bureau = bureau
       @docnumber = docnumber

data/lib/relaton_itu/util.rb

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

data/lib/relaton_itu/version.rb

@@ -1,3 +1,3 @@
 module RelatonItu
-  VERSION = "1.18.1".freeze
+  VERSION = "1.19.0".freeze
 end

data/lib/relaton_itu/xml_parser.rb

@@ -8,7 +8,7 @@ module RelatonItu
       # @param item_hash [Hash]
       # @return [RelatonItu::ItuBibliographicItem]
       def bib_item(item_hash)
-        ItuBibliographicItem.new **item_hash
+        ItuBibliographicItem.new(**item_hash)
       end
 
       # @param ext [Nokogiri::XML::Element]
@@ -59,6 +59,10 @@ module RelatonItu
         an = sid.at("annexid")&.text
         StructuredIdentifier.new(bureau: br, docnumber: dn, annexid: an)
       end
+
+      def create_doctype(type)
+        DocumentType.new type: type.text, abbreviation: type[:abbreviation]
+      end
     end
   end
 end

data/lib/relaton_itu.rb

@@ -4,7 +4,6 @@ require "digest/md5"
 require "relaton/index"
 require "relaton_bib"
 require "relaton_itu/version"
-require "relaton_itu/config"
 require "relaton_itu/util"
 require "relaton_itu/document_type"
 require "relaton_itu/pubid"

data/relaton-itu.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "mechanize", "~> 2.10"
   spec.add_dependency "parslet", "~> 2.0.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"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-itu
 version: !ruby/object:Gem::Version
-  version: 1.18.1
+  version: 1.19.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-19 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -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
@@ -92,7 +92,6 @@ files:
 - grammars/relaton-itu-compile.rng
 - grammars/relaton-itu.rng
 - lib/relaton_itu.rb
-- lib/relaton_itu/config.rb
 - lib/relaton_itu/data_fetcher.rb
 - lib/relaton_itu/data_parser_r.rb
 - lib/relaton_itu/document_type.rb

data/lib/relaton_itu/config.rb

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