relaton-gb 1.16.0 → 1.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af59eecad25f703949530ba1d289daac5eafea562bf4453b56e92e5951747ffa
-  data.tar.gz: 7c6dcf93299919fe1869fb91c93f556382d129d1cfdc69c69c4d09027cfdb1ee
+  metadata.gz: 77a65c710fb3f90a55360e83741f5fabe4e19cd5e7af7c7f3c9fe9407b0da29e
+  data.tar.gz: 81b88ce4507b1d6b91ea4dcee2179369b9139a1cc6799ec52d179bbc8c15db16
 SHA512:
-  metadata.gz: c45e0158f52768fa4e1468794c9ec78a207db0105f8dc285368c6cde561c1f5695b85dd1699bf2b48a84ac703a6e74f363962536fc8df50c0389bf3055e6a0c8
-  data.tar.gz: 8fd2778d0a2a78f5301666bc5615d7ddf73f2ec627d80ea254cd669915dbad1fcf33aa72ab2db24e50cd702faf85077403909e3d0b717d2e3a0474bd88ca6c20
+  metadata.gz: 8bf26e37145d5c50a3f55e90d6d330adb9f76b1e9faa9670eda7629174355c793c5b3182e791d42ac346c17275d5d393b776ed31ebf920fca6408e72a6172295
+  data.tar.gz: 7bbdae2269caf3045f7af542700d0366a46733561135c5704c52fef0be2d0e8ca79bc19a59e9bb28396267fa2aa9bd8fbd68ac9522eda80f685bc3fd537168a9

data/README.adoc

@@ -39,14 +39,26 @@ Or install it yourself as:
 
 == Usage
 
-=== Search document
+=== 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.
 
 [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>
 
 hit_collection.first
@@ -64,7 +76,7 @@ hit_collection.first.fetch.committee
 => #<RelatonGb::GbTechnicalCommittee:0x007f975713c450 @name="中国纤维检验局", @type="technical">
 
 hit_collection.first.fetch.gbtype
-=> #<RelatonGb::GbStandardType:0x007f9758087018 @mandate="recommended", @prefix="GB_national", @scope="national">
+=> #<RelatonGb::GbStandardType:0x0000000112957dc0 @mandate="recommended", @prefix="GB_national", @scope="national", @topic="other">
 
 hit_collection.first.fetch.ccs
 => [#<Cnccs::Ccs:0x007f975713c090
@@ -77,21 +89,43 @@ hit_collection.first.fetch.ccs
   @subgroupcode="32">]
 
 hit_collection.first.fetch.title
-=> [#<RelatonIsoBib::TypedTitleString:0x007f975714cfa8
-  @title=#<RelatonBib::FormattedString:0x007f975714cb20 @content="棉短绒", @format="text/plain", @language=["zh"], @script=["Hans"]>,
-  @type="title-main">,
- #<RelatonIsoBib::TypedTitleString:0x007f975714c580
-  @title=#<RelatonBib::FormattedString:0x007f9757147f08 @content="棉短绒", @format="text/plain", @language=["zh"], @script=["Hans"]>,
-  @type="main">,
- #<RelatonIsoBib::TypedTitleString:0x007f97571477d8
-  @title=#<RelatonBib::FormattedString:0x007f9757146ec8 @content="Cotton linter", @format="text/plain", @language=["en"], @script=["Latn"]>,
-  @type="title-main">,
- #<RelatonIsoBib::TypedTitleString:0x007f97571465e0
-  @title=#<RelatonBib::FormattedString:0x007f9757146158 @content="Cotton linter", @format="text/plain", @language=["en"], @script=["Latn"]>,
-  @type="main">]
+=> #<RelatonBib::TypedTitleStringCollection:0x0000000112a1ac08
+ @array=
+  [#<RelatonBib::TypedTitleString:0x0000000112a1f438
+    @title=#<RelatonBib::FormattedString:0x0000000112cd6050 @content="棉短绒", @format="text/plain", @language=["zh"], @script=["Hans"]>,
+    @type="title-main">,
+   #<RelatonBib::TypedTitleString:0x0000000112a1eb78
+    @title=#<RelatonBib::FormattedString:0x0000000112cd6000 @content="棉短绒", @format="text/plain", @language=["zh"], @script=["Hans"]>,
+    @type="main">,
+   #<RelatonBib::TypedTitleString:0x0000000112a1c198
+    @title=#<RelatonBib::FormattedString:0x0000000112cd5ce0 @content="Cotton linter", @format="text/plain", @language=["en"], @script=["Latn"]>,
+    @type="title-main">,
+   #<RelatonBib::TypedTitleString:0x0000000112a1bba8
+    @title=#<RelatonBib::FormattedString:0x0000000112cd5c40 @content="Cotton linter", @format="text/plain", @language=["en"], @script=["Latn"]>,
+    @type="main">]>
 
 hit_collection.first.fetch.date
-=> [#<RelatonBib::BibliographicDate:0x007f975a0207d0 @from=nil, @on=2006-03-10 00:00:00 +0100, @to=nil, @type="published">]
+=> [#<RelatonBib::BibliographicDate:0x000000011307f468 @from=nil, @on="2006-03-10", @to=nil, @type="published">]
+----
+
+=== Get document by identifier
+
+[source,ruby]
+----
+RelatonGb::GbBibliography.get "GB/T 20223-2006"
+[relaton-gb] (GB/T 20223-2006) Fetching from openstd.samr.gov.cn ...
+[relaton-gb] (GB/T 20223-2006) Found: `GB/T 20223-2006`
+=> <RelatonGb::GbBibliographicItem:0x000000000011f8>
+----
+
+=== Get document by identifier and year
+
+[source,ruby]
+----
+RelatonGb::GbBibliography.get "GB/T 20223", "2006"
+[relaton-gb] (GB/T 20223-2006) Fetching from openstd.samr.gov.cn ...
+[relaton-gb] (GB/T 20223-2006) Found: `GB/T 20223-2006`
+=> <RelatonGb::GbBibliographicItem:0x00000000001248>
 ----
 
 === Create bibliographic item from YAML

data/lib/relaton_gb/config.rb

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

data/lib/relaton_gb/gb_bibliographic_item.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "relaton_iso_bib"
-require "cnccs"
 require "relaton_gb/gb_technical_committee"
 require "relaton_gb/gb_standard_type"
 require "relaton_gb/xml_parser"
@@ -11,6 +9,8 @@ require "relaton_gb/ccs"
 module RelatonGb
   # GB bibliographic item class.
   class GbBibliographicItem < RelatonIsoBib::IsoBibliographicItem
+    DOCTYPES = %w[standard reccomendation].freeze
+
     # @return [RelatonGb::GbTechnicalCommittee]
     attr_reader :committee
 

data/lib/relaton_gb/gb_bibliography.rb

@@ -15,10 +15,11 @@ module RelatonGb
       # @return [RelatonGb::HitCollection]
       def search(text)
         case text
-        # when /^(GB|GJ|GS)/
+        when /^(GB|GJ|GS)/
           # Scrape national standards.
-          # require "relaton_gb/gb_scrapper"
-          # GbScrapper.scrape_page text
+          Util.warn "(#{text}) Fetching from openstd.samr.gov.cn ..."
+          require "relaton_gb/gb_scrapper"
+          GbScrapper.scrape_page text
         # when /^ZB/
           # Scrape proffesional.
         # when /^DB/
@@ -27,6 +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 ..."
           require "relaton_gb/t_scrapper"
           TScrapper.scrape_page text
         else
@@ -42,7 +44,7 @@ module RelatonGb
       # @param year [String] the year the standard was published (optional)
       # @param opts [Hash] options; restricted to :all_parts if all-parts reference is required
       # @return [String] Relaton XML serialisation of reference
-      def get(code, year = nil, opts = {})
+      def get(code, year = nil, opts = {}) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
         if year.nil?
           /^(?<code1>[^-]+)-(?<year1>[^-]+)$/ =~ code
           unless code1.nil?
@@ -52,7 +54,7 @@ module RelatonGb
         end
 
         code += ".1" if opts[:all_parts]
-        code, year = code.split(/-/, 2) if /-/ =~ code
+        code, year = code.split("-", 2) if code.include?("-")
         ret = get1(code, year, opts)
         return nil if ret.nil?
 
@@ -63,22 +65,22 @@ module RelatonGb
 
       private
 
-      def fetch_ref_err(code, year, missed_years)
-        id = year ? "#{code}:#{year}" : code
-        warn "[relaton-gb] WARNING: no match found on the GB website "\
-          "for #{id}. The code must be exactly like it is on the website."
+      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}`. " \
+        #           "The code must be exactly like it is on the website."
         unless missed_years.empty?
-          warn "[relaton-gb] (There was no match for #{year}, though there "\
-            "were matches found for #{missed_years.join(', ')}.)"
+          Util.warn "(There was no match for `#{year}`, though there " \
+                    "were matches found for `#{missed_years.join('`, `')}`.)"
         end
         if /\d-\d/.match? code
-          warn "[relaton-gb] The provided document part may not exist, or the "\
-            "document may no longer be published in parts."
+          Util.warn "The provided document part may not exist, or " \
+                    "the document may no longer be published in parts."
         else
-          warn "[relaton-gb] 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)."
+          Util.warn "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)."
         end
         nil
       end
@@ -89,9 +91,10 @@ module RelatonGb
         result = search_filter(searchcode) || return
         ret = results_filter(result, year)
         if ret[:ret]
-          warn "[relaton-gb] (\"#{code}\") found #{ret[:ret].docidentifier.first.id}"
+          Util.warn "(#{searchcode}) Found: `#{ret[:ret].docidentifier.first.id}`"
           ret[:ret]
         else
+          Util.warn "(#{searchcode}) Not found."
           fetch_ref_err(code, year, ret[:years])
         end
       end
@@ -99,7 +102,6 @@ module RelatonGb
       def search_filter(code)
         # search filter needs to incorporate year
         docidrx = %r{^[^\s]+\s[\d.-]+}
-        warn "[relaton-gb] (\"#{code}\") fetching..."
         result = search(code)
         result.select do |hit|
           hit.docref && hit.docref.match(docidrx).to_s.include?(code)

data/lib/relaton_gb/util.rb

@@ -0,0 +1,9 @@
+module RelatonGb
+  module Util
+    extend RelatonBib::Util
+
+    def self.logger
+      RelatonGb.configuration.logger
+    end
+  end
+end

data/lib/relaton_gb/version.rb

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

data/lib/relaton_gb.rb

@@ -1,6 +1,10 @@
+require "digest/md5"
+require "relaton_iso_bib"
+require "cnccs"
 require "relaton_gb/version"
+require "relaton_gb/config"
+require "relaton_gb/util"
 require "relaton_gb/gb_bibliography"
-require "digest/md5"
 
 # if defined? Relaton
 #   require "relaton_gb/processor"
@@ -14,9 +18,9 @@ module RelatonGb
   # Returns hash of XML reammar
   # @return [String]
   def self.grammar_hash
-    gem_path = File.expand_path "..", __dir__
-    grammars_path = File.join gem_path, "grammars", "*"
-    grammars = Dir[grammars_path].sort.map { |gp| File.read gp }.join
-    Digest::MD5.hexdigest grammars
+    # gem_path = File.expand_path "..", __dir__
+    # grammars_path = File.join gem_path, "grammars", "*"
+    # grammars = Dir[grammars_path].sort.map { |gp| File.read gp }.join
+    Digest::MD5.hexdigest RelatonGb::VERSION + RelatonIsoBib::VERSION + RelatonBib::VERSION # grammars
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-gb
 version: !ruby/object:Gem::Version
-  version: 1.16.0
+  version: 1.16.2
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-03 00:00:00.000000000 Z
+date: 2023-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cnccs
@@ -80,6 +80,7 @@ files:
 - grammars/relaton-gb.rng
 - lib/relaton_gb.rb
 - lib/relaton_gb/ccs.rb
+- lib/relaton_gb/config.rb
 - lib/relaton_gb/gb_bibliographic_item.rb
 - lib/relaton_gb/gb_bibliography.rb
 - lib/relaton_gb/gb_scrapper.rb
@@ -92,6 +93,7 @@ files:
 - lib/relaton_gb/scrapper.rb
 - lib/relaton_gb/sec_scrapper.rb
 - lib/relaton_gb/t_scrapper.rb
+- lib/relaton_gb/util.rb
 - lib/relaton_gb/version.rb
 - lib/relaton_gb/xml_parser.rb
 - lib/relaton_gb/yaml/prefixes.yaml