relaton-un 1.16.1 → 1.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f1fa9196d2c00a4740b08e4ed793b3f0073defdfe9efde37f609aa3ae8755e8
-  data.tar.gz: 97752fd7f24738baa8fe97de080c141dba11eab434697cbd04eca1dd158af5f6
+  metadata.gz: ce8d84211462e89a7e3fa8209cc642b62bc91ce3d59a137eb038c9e974b3e5c6
+  data.tar.gz: d1f53b8c63ffd65e91b85b26967b709b962cf5f1e69ac5e94143e3ac1029b9e1
 SHA512:
-  metadata.gz: 5af293100d6b96a28da1b8c56e5f404f282bfcf06ea77408f3297b7a65d5a24375a2da5350f5e2fad4a75262d491e51eb334223f0ca5a90ecca2851d3bd1634b
-  data.tar.gz: 2eb898c7ec22ee17ba302a7bdfb2d167466b1e0500b04048ab0be68f8ec118006f8d18a7af2596c5bf65573674b525516319f1a5bc1bd9a34b89e5b490b40a5a
+  metadata.gz: 8ffd4b9333da7e1ea09bb218fd20258126a77f571c48a800700cd72dd05d5b305dd36a676fefa927f175214b76e48e8ba45e2a87851d5e47a2202d9fad4450a3
+  data.tar.gz: 97053ef71c9b3b2a6728dec4402cb8ef181c9095687c3bf57676c8fc3f4e0d50b73956d5ad6606a0f511c8c3d4d183f50677ffe87a09a87d6354dd513f33594d

data/README.adoc

@@ -23,13 +23,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 `RelatonUn.configure` block.
 
 [source,ruby]
 ----
 require 'relaton_un'
 => true
 
+RelatonUn.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
+=== Search for a standard using keywords
+
+[source,ruby]
+----
 hits = RelatonUn::UnBibliography.search("TRADE/CEFACT/2004/32")
 => <RelatonUn::HitCollection:0x007fc4e6ec2018 @ref=TRADE/CEFACT/2004/32 @fetched=false>
 
@@ -69,8 +80,8 @@ item.to_xml bibdata: true
 [source,ruby]
 ----
 RelatonUn::UnBibliography.get "UN TRADE/CEFACT/2004/32"
-[relaton-un] ("UN TRADE/CEFACT/2004/32") fetching...
-[relaton-un] ("UN TRADE/CEFACT/2004/32") found TRADE/CEFACT/2004/32
+[relaton-un] (UN TRADE/CEFACT/2004/32) Fetching from documents.un.org ...
+[relaton-un] (UN TRADE/CEFACT/2004/32) Found: `TRADE/CEFACT/2004/32`
 => #<RelatonUn::UnBibliographicItem:0x007fdc5f1c3a20
 ...
 ----

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_un/document_type.rb

@@ -0,0 +1,19 @@
+module RelatonUn
+  class DocumentType < RelatonBib::DocumentType
+    DOCTYPES = %w[
+      recommendation plenary addendum communication corrigendum reissue agenda
+      budgetary sec-gen-notes expert-report resolution
+    ].freeze
+
+    def initialize(type:, abbreviation: nil)
+      check_type type
+      super
+    end
+
+    def check_type(type)
+      unless DOCTYPES.include? type
+        Util.warn "WARNING: invalid doctype: `#{type}`"
+      end
+    end
+  end
+end

data/lib/relaton_un/hash_converter.rb

@@ -1,34 +1,38 @@
 module RelatonUn
-  class HashConverter < RelatonBib::HashConverter
-    class << self
-      # @override RelatonIsoBib::HashConverter.hash_to_bib
-      # @param args [Hash]
-      # @param nested [TrueClass, FalseClass]
-      # @return [Hash]
-      def hash_to_bib(args)
-        ret = super
-        return if ret.nil?
+  module HashConverter
+    include RelatonBib::HashConverter
+    extend self
+    # @override RelatonIsoBib::HashConverter.hash_to_bib
+    # @param args [Hash]
+    # @param nested [TrueClass, FalseClass]
+    # @return [Hash]
+    def hash_to_bib(args)
+      ret = super
+      return if ret.nil?
 
-        ret[:submissionlanguage] = RelatonBib.array ret[:submissionlanguage]
-        session_hash_to_bib ret
-        ret
-      end
+      ret[:submissionlanguage] = RelatonBib.array ret[:submissionlanguage]
+      session_hash_to_bib ret
+      ret
+    end
+
+    private
 
-      private
+    # @param ret [Hash]
+    def session_hash_to_bib(ret)
+      ret[:session] = Session.new(**ret[:session]) if ret[:session]
+    end
 
-      # @param ret [Hash]
-      def session_hash_to_bib(ret)
-        ret[:session] = Session.new(**ret[:session]) if ret[:session]
-      end
+    # @param ret [Hash]
+    def editorialgroup_hash_to_bib(ret)
+      eg = ret[:editorialgroup]
+      return unless eg
 
-      # @param ret [Hash]
-      def editorialgroup_hash_to_bib(ret)
-        eg = ret[:editorialgroup]
-        return unless eg
+      committee = eg.map { |e| e[:committee] }
+      ret[:editorialgroup] = EditorialGroup.new RelatonBib.array(committee)
+    end
 
-        committee = eg.map { |e| e[:committee] }
-        ret[:editorialgroup] = EditorialGroup.new RelatonBib.array(committee)
-      end
+    def create_doctype(**args)
+      DocumentType.new(**args)
     end
   end
 end

data/lib/relaton_un/hit_collection.rb

@@ -6,13 +6,13 @@ require "http-cookie"
 module RelatonUn
   # Page of hit collection.
   class HitCollection < RelatonBib::HitCollection
-    AGENT = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) "\
-    "AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.102 Safari/537.36"
+    AGENT = "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_5) AppleWebKit/537.36 " \
+            "(KHTML, like Gecko) Chrome/85.0.4183.102 Safari/537.36"
     DOMAIN = "https://documents.un.org"
     BOUNDARY = "----WebKitFormBoundaryVarT9Z7AFUzw2lma"
 
     # @param text [String] reference to search
-    def initialize(text) # rubocop:disable Metrics/AbcSize
+    def initialize(text) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       super
       @uri = URI.parse DOMAIN
       @jar = HTTP::CookieJar.new

data/lib/relaton_un/un_bibliographic_item.rb

@@ -2,11 +2,6 @@ module RelatonUn
   class UnBibliographicItem < RelatonBib::BibliographicItem
     include RelatonBib
 
-    TYPES = %w[
-      recommendation plenary addendum communication corrigendum reissue agenda
-      budgetary sec-gen-notes expert-report resolution
-    ].freeze
-
     DISTRIBUTIONS = { "GEN" => "general", "LTD" => "limited",
                       "DER" => "restricted", "PRO" => "provisional" }.freeze
 
@@ -24,7 +19,7 @@ module RelatonUn
     # @param job_number [String, nil]
     def initialize(**args)
       if args[:distribution] && !DISTRIBUTIONS.has_value?(args[:distribution])
-        Util.warn "WARNING: invalid distribution: `#{args[:distribution]}`"
+        Util.warn "WARNING: Invalid distribution: `#{args[:distribution]}`"
       end
       @submissionlanguage = args.delete :submissionlanguage
       @distribution = args.delete :distribution
@@ -50,7 +45,7 @@ module RelatonUn
     def to_xml(**opts) # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
       super(**opts) do |b|
         ext = b.ext do
-          b.doctype doctype if doctype
+          doctype&.to_xml b
           submissionlanguage&.each { |sl| b.submissionlanguage sl }
           editorialgroup&.to_xml b
           ics&.each { |i| i.to_xml b }

data/lib/relaton_un/un_bibliography.rb

@@ -21,14 +21,14 @@ module RelatonUn
       # @param opts [Hash] options
       # @return [RelatonUn::UnBibliographicItem]
       def get(ref, _year = nil, _opts = {})
-        Util.warn "(#{ref}) fetching..."
+        Util.warn "(#{ref}) Fetching from documents.un.org ..."
         /^(?:UN\s)?(?<code>.*)/ =~ ref
         result = isobib_search_filter(code)
         if result
-          Util.warn "(#{ref}) found `#{result.fetch.docidentifier[0].id}`"
+          Util.warn "(#{ref}) Found: `#{result.fetch.docidentifier[0].id}`"
           result.fetch
         else
-          Util.warn "(#{ref}) nothing found"
+          Util.warn "(#{ref}) Not found."
           nil
         end
       end

data/lib/relaton_un/version.rb

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

data/lib/relaton_un.rb

@@ -3,6 +3,7 @@ require "relaton_bib"
 require "relaton_un/version"
 require "relaton_un/config"
 require "relaton_un/util"
+require "relaton_un/document_type"
 require "relaton_un/un_bibliographic_item"
 require "relaton_un/un_bibliography"
 require "relaton_un/hit_collection"

data/relaton_un.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "addressable", "~> 2.8.0"
   spec.add_dependency "faraday", "~> 2.7.0"
   spec.add_dependency "http-cookie", "~> 1.0.5"
-  spec.add_dependency "relaton-bib", "~> 1.16.0"
+  spec.add_dependency "relaton-bib", "~> 1.17.0"
   spec.add_dependency "unf_ext", ">= 0.0.7.7"
 end
 # rubocop:enable Metrics/BlockLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-un
 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-22 00:00:00.000000000 Z
+date: 2023-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -58,14 +58,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: unf_ext
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +107,7 @@ files:
 - grammars/relaton-un.rng
 - lib/relaton_un.rb
 - lib/relaton_un/config.rb
+- lib/relaton_un/document_type.rb
 - lib/relaton_un/editorialgroup.rb
 - lib/relaton_un/hash_converter.rb
 - lib/relaton_un/hit.rb