relaton-itu 1.16.1 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba25af96c755b3ba32e9318e989f3a7396538c23667112dcde1282fd22b64c4b
-  data.tar.gz: 1757b9672eeeae25548c7cf2ea3c6f2fb7beb9dbdc5740b452177e20540fc4dc
+  metadata.gz: 3fe7b62f593b31cdf9a2441ecafb931c0e53d3aff3bc0abc089f4b8227dc00bc
+  data.tar.gz: e727a837e88114c9d80d4d606551721f45dcb0de32df74826fd765b2616c3802
 SHA512:
-  metadata.gz: adc9864ea7e48260cb0aa5550b0fbaa2a4943359537acaf75a974514f9a034dd34a01842da5abd2b5b65cffb796f022dbb5f8527fc1addcd915e4646340eb502
-  data.tar.gz: 24b824c4af92c5aa195abd7681f9e24f370450555cef3018e67280257eccc0b6e4290a70c2270406f70e0714cbc5c651b2d1fdf94d4babff2ca37209a0455918
+  metadata.gz: 5f92d14d1e7b0e019360a1c988abcbaedaf24dc4186e48f6b7308dd605777581ec16c5a5188b0e24ffd1a18f48341b7bfe70440a08b0d01ab0dde245c8a18d32
+  data.tar.gz: 4d075c9d458e88e02741fc017d99e930d516ee5810aa374c08519e2a1964d3c1b20b9156bf11a643318408efe20f080daea7976317467ab809bd2f1de0e58031

data/README.adoc

@@ -29,13 +29,24 @@ Or install it yourself as:
 
 == Usage
 
-=== Search for a standard using keywords
+=== 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.
 
 [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>
 
@@ -73,8 +84,8 @@ item.to_xml bibdata: true
 [source,ruby]
 ----
 RelatonItu::ItuBibliography.get("ITU-T L.163", "2018", {})
-[relaton-itu] ("ITU-T L.163") fetching...
-[relaton-itu] ("ITU-T L.163") found ITU-T L.163
+[relaton-itu] (ITU-T L.163) Fetching from www.itu.int ...
+[relaton-itu] (ITU-T L.163) Found: `ITU-T L.163`
 => #<RelatonItu::ItuBibliographicItem:0x007fbf5f94b9b8
 ...
 ----
@@ -83,8 +94,8 @@ RelatonItu::ItuBibliography.get("ITU-T L.163", "2018", {})
 [source,ruby]
 ----
 RelatonItu::ItuBibliography.get "ITU-T G.989.2/Amd 1"
-[relaton-itu] ("ITU-T G.989.2/Amd 1") fetching...
-[relaton-itu] ("ITU-T G.989.2/Amd 1") found ITU-T G.989.2/Amd 1
+[relaton-itu] (ITU-T G.989.2/Amd 1) Fetching from www.itu.int ...
+[relaton-itu] (ITU-T G.989.2/Amd 1) Found: `ITU-T G.989.2/Amd 1`
 => #<RelatonItu::ItuBibliographicItem:0x007fe5409e5840
 ...
 ----
@@ -94,8 +105,8 @@ RelatonItu::ItuBibliography.get "ITU-T G.989.2/Amd 1"
 [source,ruby]
 ----
 RelatonItu::ItuBibliography.get "ITU-R BO.600-1"
-[relaton-itu] ("ITU-R BO.600-1") fetching...
-[relaton-itu] ("ITU-R BO.600-1") found ITU-R BO.600-1
+[relaton-itu] (ITU-R BO.600-1) Fetching from www.itu.int ...
+[relaton-itu] (ITU-R BO.600-1) Found: `ITU-R BO.600-1`
 => #<RelatonItu::ItuBibliographicItem:0x00007fb0cf8a1308
 ...
 ----
@@ -105,9 +116,9 @@ RelatonItu::ItuBibliography.get "ITU-R BO.600-1"
 [source,ruby]
 ----
 RelatonItu::ItuBibliography.get 'ITU-R RR (2020)'
-[relaton-itu] ("ITU-R RR") fetching...
-[relaton-itu] WARNING: invalid doctype: publication
-[relaton-itu] ("ITU-R RR") found ITU-R RR
+[relaton-itu] (ITU-R RR) Fetching from www.itu.int ...
+[relaton-itu] WARNING: Invalid doctype: `publication`
+[relaton-itu] (ITU-R RR) Found: ITU-R RR
 => #<RelatonItu::ItuBibliographicItem:0x007fb4b55eb660
 ...
 ----

data/grammars/basicdoc.rng

@@ -346,6 +346,8 @@
           <ref name="keyword"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </oneOrMore>
     </element>
@@ -623,6 +625,8 @@
           <ref name="eref"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -636,6 +640,8 @@
           <ref name="eref"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -648,6 +654,8 @@
           <ref name="eref"/>
           <ref name="xref"/>
           <ref name="hyperlink"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
         </choice>
       </zeroOrMore>
     </element>
@@ -655,7 +663,11 @@
   <define name="keyword">
     <element name="keyword">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>
@@ -676,7 +688,11 @@
   <define name="strike">
     <element name="strike">
       <zeroOrMore>
-        <ref name="PureTextElement"/>
+        <choice>
+          <ref name="PureTextElement"/>
+          <ref name="index"/>
+          <ref name="index-xref"/>
+        </choice>
       </zeroOrMore>
     </element>
   </define>

data/grammars/biblio.rng

@@ -942,6 +942,7 @@
       <value>obsoleted</value>
       <value>confirmed</value>
       <value>updated</value>
+      <value>corrected</value>
       <value>issued</value>
       <value>transmitted</value>
       <value>copied</value>

data/lib/relaton_itu/data_parser_r.rb

@@ -16,7 +16,7 @@ module RelatonItu
         docid: fetch_docid(doc), title: fetch_title(doc),
         abstract: fetch_abstract(doc), date: fetch_date(doc), language: ["en"],
         link: fetch_link(url), script: ["Latn"], docstatus: fetch_status(doc),
-        type: "standard", doctype: type
+        type: "standard", doctype: fetch_doctype(type)
       )
     end
 
@@ -90,5 +90,9 @@ module RelatonItu
 
       RelatonBib::DocumentStatus.new stage: s.text
     end
+
+    def fetch_doctype(type)
+      DocumentType.new(type: type)
+    end
   end
 end

data/lib/relaton_itu/document_type.rb

@@ -0,0 +1,21 @@
+module RelatonItu
+  class DocumentType < RelatonBib::DocumentType
+    TYPES = %w[
+      recommendation recommendation-supplement recommendation-amendment
+      recommendation-corrigendum recommendation-errata recommendation-annex
+      focus-group implementers-guide technical-paper technical-report
+      joint-itu-iso-iec resolution service-publication handbook question
+    ].freeze
+
+    def initialize(type:, abbreviation: nil)
+      check_type type
+      super
+    end
+
+    def check_type(type)
+      unless TYPES.include? type
+        Util.warn "WARNING: Invalid doctype: `#{type}`"
+      end
+    end
+  end
+end

data/lib/relaton_itu/editorial_group.rb

@@ -17,8 +17,8 @@ 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 "WARNING: Invalid bureau: `#{bureau}`"
+        Util.warn "WARNING: Valid bureaus are: `#{BUREAUS.join('`, `')}`"
       end
       @bureau = bureau
       @group = group.is_a?(Hash) ? ItuGroup.new(**group) : group

data/lib/relaton_itu/hash_converter.rb

@@ -1,32 +1,37 @@
 module RelatonItu
-  class HashConverter < RelatonBib::HashConverter
-    class << self
-      private
+  module HashConverter
+    include RelatonBib::HashConverter
+    extend self
 
-      #
-      # Ovverides superclass's method
-      #
-      # @param item [Hash]
-      # @retirn [RelatonItu::ItuBibliographicItem]
-      def bib_item(item)
-        ItuBibliographicItem.new(**item)
-      end
+    private
 
-      def editorialgroup_hash_to_bib(ret)
-        eg = ret[:editorialgroup]
-        return unless eg
+    #
+    # Ovverides superclass's method
+    #
+    # @param item [Hash]
+    # @retirn [RelatonItu::ItuBibliographicItem]
+    def bib_item(item)
+      ItuBibliographicItem.new(**item)
+    end
+
+    def editorialgroup_hash_to_bib(ret)
+      eg = ret[:editorialgroup]
+      return unless eg
 
-        ret[:editorialgroup] = EditorialGroup.new **eg
-      end
+      ret[:editorialgroup] = EditorialGroup.new(**eg)
+    end
 
-      # @param ret [Hash]
-      def structuredidentifier_hash_to_bib(ret)
-        return unless ret[:structuredidentifier]
+    # @param ret [Hash]
+    def structuredidentifier_hash_to_bib(ret)
+      return unless ret[:structuredidentifier]
+
+      ret[:structuredidentifier] = StructuredIdentifier.new(
+        **ret[:structuredidentifier]
+      )
+    end
 
-        ret[:structuredidentifier] = StructuredIdentifier.new(
-          **ret[:structuredidentifier]
-        )
-      end
+    def create_doctype(**args)
+      DocumentType.new(**args)
     end
   end
 end

data/lib/relaton_itu/hit_collection.rb

@@ -21,6 +21,7 @@ module RelatonItu
     # @param refid [RelatonItu::Pubid] reference
     #
     def initialize(refid) # rubocop:todo Metrics/MethodLength
+      @refid = refid
       text = refid.to_ref.sub(/(?<=\.)Imp\s?(?=\d)/, "")
       super text, refid.year
       @agent = Mechanize.new
@@ -32,25 +33,24 @@ module RelatonItu
       when /^(ITU-T|ITU-R\sRR)/
         request_search
       when /^ITU-R\s/
-        request_document(refid)
+        request_document
       end
     end
 
     private
 
     def request_search
+      Util.warn "(#{@refid}) Fetching from www.itu.int ..."
       url = "#{DOMAIN}/net4/ITU-T/search/GlobalSearch/RunSearch"
       data = { json: params.to_json }
       resp = agent.post url, data
       @array = hits JSON.parse(resp.body)
     end
 
-    #
-    # @param refid [RelatonItu::Pubid] a document reference
-    #
-    def request_document(refid) # rubocop:todo Metrics/MethodLength, Metrics/AbcSize
+    def request_document # rubocop:todo Metrics/MethodLength, Metrics/AbcSize
+      Util.warn "(#{@refid}) Fetching from Relaton repository ..."
       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] }
+      row = index.search(@refid.to_ref).min_by { |i| i[:id] }
       return unless row
 
       uri = URI("#{GH_ITU_R}#{row[:file]}")
@@ -77,8 +77,10 @@ module RelatonItu
 
     # @return [Hash]
     def params # rubocop:disable Metrics/MethodLength
+      input = @refid.dup
+      input.year = nil
       {
-        "Input" => text,
+        "Input" => input.to_s,
         "Start" => 0,
         "Rows" => 10,
         "SortBy" => "RELEVANCE",

data/lib/relaton_itu/itu_bibliographic_item.rb

@@ -1,19 +1,9 @@
 module RelatonItu
   class ItuBibliographicItem < RelatonBib::BibliographicItem
-    TYPES = %w[
-      recommendation recommendation-supplement recommendation-amendment
-      recommendation-corrigendum recommendation-errata recommendation-annex
-      focus-group implementers-guide technical-paper technical-report
-      joint-itu-iso-iec resolution service-publication handbook question
-    ].freeze
-
     # @params structuredidentifier [RelatonItu::StructuredIdentifier]
-    def initialize(**args)
-      if args[:doctype] && !TYPES.include?(args[:doctype])
-        Util.warn "WARNING: invalid doctype: `#{args[:doctype]}`"
-      end
-      super
-    end
+    # def initialize(**args)
+    #   super
+    # end
 
     #
     # Fetch flavor schema version

data/lib/relaton_itu/itu_bibliography.rb

@@ -22,9 +22,9 @@ module RelatonItu
     def search(refid)
       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}"
+        correct_ref = "#{$~[1]} #{$~[2]} #{$~[3]}"
+        Util.warn "WARNING: Incorrect reference: `#{refid}`"
+        Util.warn "the reference should be: `#{correct_ref}`"
       end
       HitCollection.new refid
     rescue SocketError, Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, Net::HTTPBadResponse,
@@ -63,19 +63,21 @@ module RelatonItu
     private
 
     def fetch_ref_err(refid, missed_years) # rubocop:disable Metrics/MethodLength
-      Util.warn "WARNING: no match found online for `#{refid}`. " \
-                "The code must be exactly like it is on the standards website."
-      unless missed_years.empty?
-        Util.warn "(There was no match for `#{refid.year}`, though there " \
-                  "were matches found for `#{missed_years.join('`, `')}`.)"
+      # Util.warn "WARNING: no match found online for `#{refid}`. " \
+      #           "The code must be exactly like it is on the standards website."
+      Util.warn "(#{refid}) Not found."
+      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}."
       end
       # if /\d-\d/.match? refid.code
       #   warn "[relaton-itu] The provided document part may not exist, or " \
       #        "the document may no longer be published in parts."
       # else
-      Util.warn "If you wanted to cite all document parts for the reference, " \
-                "use `#{refid} (all parts)`.\nIf the document is not a standard, " \
-                "use its document type abbreviation `S`, `TR`, `PAS`, `Guide`)."
+      # Util.warn "If you wanted to cite all document parts for the reference, " \
+      #           "use `#{refid} (all parts)`.\nIf the document is not a standard, " \
+      #           "use its document type abbreviation `S`, `TR`, `PAS`, `Guide`)."
       # end
       nil
     end
@@ -90,7 +92,6 @@ module RelatonItu
       #   (?:\s\((?:(?<cormonth1>\d{2})/)?(?<coryear1>\d{4})\))?
       # }x =~ code
       # year ||= year1
-      Util.warn "(#{refid}) fetching..."
       result = search(refid)
       # refid.code.sub!(/(?<=\.)Imp(?=\d)/, "") if result.gi_imp
       # if corr1
@@ -101,7 +102,7 @@ module RelatonItu
         next true unless i.hit[:code]
 
         pubid = Pubid.parse i.hit[:code]
-        refid === pubid
+        refid.===(pubid, [:year])
         # %r{
         #   ^(?<pref2>ITU)?(?:-(?<type2>\w))?\s?(?<code2>\S+)
         #   (?:\s\(?(?<ver2>v\d+)\)?)?
@@ -143,7 +144,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.warn "(#{refid}) Found: `#{ret[:ret].docidentifier.first&.id}`"
         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
-      warn "[relaton-itu] WARNING: #{id} is invalid ITU publication identifier"
-      warn e.parse_failure_cause.ascii_tree
+      Util.warn "WARNING: `#{id}` is invalid ITU publication identifier \n" \
+                "#{e.parse_failure_cause.ascii_tree}"
       raise e
     end
 
@@ -96,11 +96,12 @@ module RelatonItu
       s
     end
 
-    def ===(other)
+    def ===(other, ignore_args = [])
       hash = to_h with_type: false
       other_hash = other.to_h with_type: false
       hash.delete(:month)
       other_hash.delete(:month)
+      hash.delete(:year) if ignore_args.include?(:year)
       other_hash.delete(:year) unless hash[:year]
       hash == other_hash
     end

data/lib/relaton_itu/scrapper.rb

@@ -49,7 +49,7 @@ module RelatonItu
           language: ["en"],
           script: ["Latn"],
           title: fetch_titles(doc),
-          doctype: hit.hit[:type],
+          doctype: DocumentType.new(type: hit.hit[:type]),
           docstatus: fetch_status(doc),
           ics: [], # fetch_ics(doc),
           date: fetch_dates(doc),
@@ -75,7 +75,7 @@ module RelatonItu
                     url = abstract_url[:onclick].match(/https?[^']+/).to_s
                     rsp = hit.hit_collection.agent.get url
                     d = Nokogiri::HTML rsp.body.encode(undef: :replace, replace: "")
-                    d.css("p.MsoNormal").text.gsub(/\r\n/, "").squeeze(" ").gsub(/\u00a0/, "")
+                    d.css("p.MsoNormal").text.gsub("\r\n", "").squeeze(" ").gsub("\u00a0", "")
                   elsif a = doc.at('//table/tr/td/span[contains(@class, "observation")]/text()')
                     a.text.strip
                   end
@@ -87,7 +87,7 @@ module RelatonItu
           script: "Latn",
         }]
       rescue Mechanize::ResponseCodeError => e
-        warn "HTTP Service Unavailable: #{e.message}"
+        Util.warn "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
-        warn "[relaton-itu] WARNING: invalid bureau: #{bureau}"
+        Util.warn "WARNING: Invalid bureau: `#{bureau}`"
       end
       @bureau = bureau
       @docnumber = docnumber

data/lib/relaton_itu/version.rb

@@ -1,3 +1,3 @@
 module RelatonItu
-  VERSION = "1.16.1".freeze
+  VERSION = "1.17.0".freeze
 end

data/lib/relaton_itu.rb

@@ -6,6 +6,7 @@ require "relaton_bib"
 require "relaton_itu/version"
 require "relaton_itu/config"
 require "relaton_itu/util"
+require "relaton_itu/document_type"
 require "relaton_itu/pubid"
 require "relaton_itu/itu_bibliography"
 require "relaton_itu/data_fetcher"

data/relaton-itu.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "mechanize", "~> 2.8.0"
   spec.add_dependency "parslet", "~> 2.0.0"
-  spec.add_dependency "relaton-bib", "~> 1.16.0"
+  spec.add_dependency "relaton-bib", "~> 1.17.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.16.1
+  version: 1.17.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-21 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.16.0
+        version: 1.17.0
 - !ruby/object:Gem::Dependency
   name: relaton-index
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +95,7 @@ files:
 - lib/relaton_itu/config.rb
 - lib/relaton_itu/data_fetcher.rb
 - lib/relaton_itu/data_parser_r.rb
+- lib/relaton_itu/document_type.rb
 - lib/relaton_itu/editorial_group.rb
 - lib/relaton_itu/hash_converter.rb
 - lib/relaton_itu/hit.rb