relaton-gb 1.18.4 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a01690064106c099fc8b4cf2531876232bc3d2a4fd4b41622d4337a0707ce080
-  data.tar.gz: 972a0679b5e1474d3ef0d9c8afefb49157dc0da042c89f736693e4ddb9b9531f
+  metadata.gz: 1a6f089b0e88176b0a975002a00cc353ecddc6f611721b89886f5578b047a893
+  data.tar.gz: c962a506d4d9b6359c9ae7e041ae78a6dd61d3b096bfa12833e19cdb8404556c
 SHA512:
-  metadata.gz: 6b8a4c456f5984105065c294a7566a9f679e16e534d36eda56c0024f5504fd378ba364d6b299039a47a9edb1a8d4d2c3f69193df0b9c683f76cbb11ec7c02031
-  data.tar.gz: cd21352325f87070a8f0ab29a28a3bb31c2c53efca18c59d7bd642dec02cec896ed4eefdcc5e972e4e8ee546687fdced7aecb6932bd96e0b904a2244f9195ff9
+  metadata.gz: 03e7d65e846285ae4c246b6b0d5c17cda499391413ff49254a535aa0a7413699c740fa736a620291963dacd0d02d16af23b58f2825426a0c45a9c6d1437017a7
+  data.tar.gz: 19ee5ac1b544b344bd051515d14b3558dd6b71eeed66228a8178b5ab6c4c54f322b3ff12a585569e2866334641553a36fcc63bd95da7618f8d3dd6a49c48266c

data/README.adoc

@@ -39,24 +39,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 `RelatonGb.configure` block.
+=== Search document
 
 [source,ruby]
 ----
 require 'relaton_gb'
 => true
 
-RelatonGb.configure do |config|
-  config.logger.level = Logger::DEBUG
-end
-----
-
-=== Search document
-
-[source,ruby]
-----
 hit_collection = RelatonGb::GbBibliography.search "GB/T 20223-2006"
 [relaton-gb] (GB/T 20223-2006) Fetching from openstd.samr.gov.cn ...
 => <RelatonGb::HitCollection:0x007fc8d8a26d10 @ref= @fetched=false>
@@ -182,6 +171,10 @@ hit_collection.first.fetch.link
 => [#<RelatonBib::TypedUri:0x00007fee2c0257e8 @content=#<Addressable::URI:0x67c URI:http://openstd.samr.gov.cn/bzgk/gb/newGbInfo?hcno=083B48FA72DBD3B9BDE74507BC31736A>, @type="src">]
 ----
 
+=== Logging
+
+RelatonGb 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_gb/document_type.rb

@@ -9,7 +9,7 @@ module RelatonGb
 
     def check_type(type)
       unless DOCTYPES.include? type
-        Util.warn "WARNING: invalid doctype: `#{type}`"
+        Util.warn "invalid doctype: `#{type}`"
       end
     end
   end

data/lib/relaton_gb/gb_bibliographic_item.rb

@@ -57,7 +57,7 @@ module RelatonGb
     # @return [String] XML
     def to_xml(**opts) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       super(**opts) do |b|
-        if opts[:bibdata] && has_ext_attrs?
+        if opts[:bibdata] && has_ext?
           ext = b.ext do
             doctype&.to_xml b
             b.horizontal horizontal unless horizontal.nil?
@@ -76,13 +76,17 @@ module RelatonGb
     # @return [Hash]
     def to_hash # rubocop:disable Metrics/AbcSize
       hash = super
-      hash["ccs"] = single_element_array(ccs) if ccs&.any?
-      hash["committee"] = committee.to_hash if committee
-      hash["plannumber"] = gbplannumber if gbplannumber
-      hash["gbtype"] = gbtype.to_hash
+      hash["ext"]["ccs"] = single_element_array(ccs) if ccs&.any?
+      hash["ext"]["committee"] = committee.to_hash if committee
+      hash["ext"]["plannumber"] = gbplannumber if gbplannumber
+      hash["ext"]["gbtype"] = gbtype.to_hash if gbtype
       hash
     end
 
+    def has_ext?
+      super || ccs&.any? || committee || gbplannumber || gbtype
+    end
+
     # @param prefix [String]
     # @return [String]
     def to_asciibib(prefix = "")
@@ -128,8 +132,8 @@ module RelatonGb
     #
     # @return [Boolean]
     #
-    def has_ext_attrs?
-      super || committee || docsubtype
-    end
+    # def has_ext_attrs?
+    #   super || committee || docsubtype
+    # end
   end
 end

data/lib/relaton_gb/gb_bibliography.rb

@@ -17,7 +17,7 @@ module RelatonGb
         case text
         when /^(GB|GJ|GS)/
           # Scrape national standards.
-          Util.warn "(#{text}) Fetching from openstd.samr.gov.cn ..."
+          Util.info "Fetching from openstd.samr.gov.cn ...", key: text
           require "relaton_gb/gb_scrapper"
           GbScrapper.scrape_page text
         # when /^ZB/
@@ -28,7 +28,7 @@ module RelatonGb
           # Enterprise standard
         when %r{^T/[^\s]{2,6}\s}
           # Scrape social standard.
-          Util.warn "(#{text}) Fetching from www.ttbz.org.cn ..."
+          Util.info "Fetching from www.ttbz.org.cn ...", key: text
           require "relaton_gb/t_scrapper"
           TScrapper.scrape_page text
         else
@@ -67,17 +67,17 @@ module RelatonGb
 
       def fetch_ref_err(code, year, missed_years) # rubocop:disable Metrics/MethodLength
         # id = year ? "#{code}:#{year}" : code
-        # Util.warn "WARNING: No match found on the GB website for `#{id}`. " \
+        # Util.info "WARNING: No match found on the GB website for `#{id}`. " \
         #           "The code must be exactly like it is on the website."
         unless missed_years.empty?
-          Util.warn "(There was no match for `#{year}`, though there " \
+          Util.info "(There was no match for `#{year}`, though there " \
                     "were matches found for `#{missed_years.join('`, `')}`.)"
         end
         if /\d-\d/.match? code
-          Util.warn "The provided document part may not exist, or " \
+          Util.info "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 " \
+          Util.info "If you wanted to cite all document parts for the " \
                     "reference, use `#{code} (all parts)`.\nIf the document " \
                     "is not a standard, use its document type abbreviation " \
                     "(TS, TR, PAS, Guide)."
@@ -91,10 +91,10 @@ module RelatonGb
         result = search_filter(searchcode) || return
         ret = results_filter(result, year)
         if ret[:ret]
-          Util.warn "(#{searchcode}) Found: `#{ret[:ret].docidentifier.first.id}`"
+          Util.info "Found: `#{ret[:ret].docidentifier.first.id}`", key: searchcode
           ret[:ret]
         else
-          Util.warn "(#{searchcode}) Not found."
+          Util.info "Not found.", key: searchcode
           fetch_ref_err(code, year, ret[:years])
         end
       end

data/lib/relaton_gb/hash_converter.rb

@@ -11,6 +11,9 @@ module RelatonGb
       ret = super
       return if ret.nil?
 
+      ret[:committee] = ret[:ext][:committee] if ret.dig(:ext, :committee)
+      ret[:plannumber] = ret[:ext][:plannumber] if ret.dig(:ext, :plannumber)
+      ret[:gbtype] = ret[:ext][:gbtype] if ret.dig(:ext, :gbtype)
       ccs_hash_to_bib(ret)
       ret
     end
@@ -27,8 +30,11 @@ module RelatonGb
     end
 
     def ccs_hash_to_bib(ret)
-      ret[:ccs] = RelatonBib.array(ret[:ccs]).map do |ccs|
-        (ccs[:code] && Cnccs.fetch(ccs[:code])) || Cnccs.fetch(ccs)
+      ccs = ret.dig(:ext, :ccs) || ret[:ccs] # @TODO: remove ret[:ccs] after all specs are updated
+      return unless ccs
+
+      ret[:ccs] = RelatonBib.array(ccs).map do |item|
+        (item[:code] && Cnccs.fetch(item[:code])) || Cnccs.fetch(item)
       end
     end
 

data/lib/relaton_gb/util.rb

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

data/lib/relaton_gb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RelatonGb
-  VERSION = "1.18.4"
+  VERSION = "1.20.0"
 end

data/lib/relaton_gb/xml_parser.rb

@@ -41,6 +41,10 @@ module RelatonGb
           topic: gbtype&.at("gbtopic")&.text,
         }
       end
+
+      def create_doctype(type)
+        DocumentType.new type: type.text, abbreviation: type[:abbreviation]
+      end
     end
   end
 end

data/lib/relaton_gb.rb

@@ -3,7 +3,6 @@ require "mechanize"
 require "relaton_iso_bib"
 require "cnccs"
 require "relaton_gb/version"
-require "relaton_gb/config"
 require "relaton_gb/util"
 require "relaton_gb/document_type"
 require "relaton_gb/gb_bibliography"

data/relaton_gb.gemspec

@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "cnccs", "~> 0.1.1"
   spec.add_dependency "gb-agencies", "~> 0.0.1"
   spec.add_dependency "mechanize", "~> 2.10"
-  spec.add_dependency "relaton-iso-bib", "~> 1.18.0"
+  spec.add_dependency "relaton-iso-bib", "~> 1.20.0"
   spec.add_dependency "csv", "~> 3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-gb
 version: !ruby/object:Gem::Version
-  version: 1.18.4
+  version: 1.20.0
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-19 00:00:00.000000000 Z
+date: 2024-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cnccs
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.20.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.20.0
 - !ruby/object:Gem::Dependency
   name: csv
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +108,6 @@ files:
 - grammars/relaton-gb.rng
 - lib/relaton_gb.rb
 - lib/relaton_gb/ccs.rb
-- lib/relaton_gb/config.rb
 - lib/relaton_gb/document_type.rb
 - lib/relaton_gb/gb_bibliographic_item.rb
 - lib/relaton_gb/gb_bibliography.rb
@@ -131,7 +130,7 @@ homepage: https://github.com/metanorma/relaton_gb
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -147,7 +146,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.27
-signing_key: 
+signing_key:
 specification_version: 4
 summary: 'RelatonGb: retrieve Chinese GB Standards for bibliographic use using the
   BibliographicItem model.'

data/lib/relaton_gb/config.rb

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