relaton-iec 1.16.0 → 1.16.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 407e0b683664d9b9e59bcbf2dadbbcc3b3289df9d16354cf7704b27529169020
-  data.tar.gz: dc55bf895de7f08f93f9430c348d562903567df12f5e93c1a7916082c4742ed5
+  metadata.gz: d3c632b6fb62b15fd360d801190ebac6742f05658b695e573304b5c4a7d38ed1
+  data.tar.gz: 271d54825baa3cc59e59bcc926da577aecb172bb81466cb7b1dd5c4248746357
 SHA512:
-  metadata.gz: f4d1c322f0fd0d0f4a5d21c6cebd43f1f8556d34cd096f547da2c16e8f4a437294be845812b35fa1880c0d790092ae13926bd65fbb9d6a24d6c53263417fb3b4
-  data.tar.gz: ff11597b0da5425a9c402d2da4926200703636b7d88a305299e6d59897e0835f1f68ca2b65f01f94e8f6ff4950e726957bd52ce5624ec712ab67c8f2a794e229
+  metadata.gz: 283f22a20fceef3a4dbb3430f8bbdb69930b8286f5af0e00bc8c1648242c6024603b2a284efa7ae7fcdcf908db0f326f48533ba5fbad8389f3e534428a9059b6
+  data.tar.gz: 8327e80d5c36f179d692966ebb280fc00c66e89145d1da741e3198b1219655df2a33ca45735870466c3b045ae7b3f8bce7ba663396af76e29b0bdbcf06b8359b

data/README.adoc

@@ -31,6 +31,20 @@ 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 `RelatonIec.configure` block.
+
+[source,ruby]
+----
+require 'relaton_iec'
+=> true
+
+RelatonIec.configure do |config|
+  config.logger.level = Logger::DEBUG
+end
+----
+
 === Search for a standard using keywords
 
 `RelatonIec::IecBibliography.search(ref, year)` method returns hits collection. Each hit can be used to fetch a document.
@@ -40,9 +54,6 @@ Or install it yourself as:
 
 [source,ruby]
 ----
-require 'relaton_iec'
-=> true
-
 hit_collection = RelatonIec::IecBibliography.search("60050")
 => <RelatonIec::HitCollection:0x007fe0d7126f28 @ref=60050 @fetched=false>
 
@@ -78,14 +89,14 @@ item.docidentifier.detect { |di| di.type == "URN" }.id
 [source,ruby]
 ----
 item = RelatonIec::IecBibliography.get("IEC 60050-112:2010")
-[relaton-iec] ("IEC 60050-112:2010") fetching...
-[relaton-iec] ("IEC 60050-112:2010") found IEC 60050-112:2010
+[relaton-iec] (IEC 60050-112:2010) Fetching from Relaton repository ...
+[relaton-iec] (IEC 60050-112:2010) Found: `IEC 60050-112:2010`
 => #<RelatonIec::IecBibliographicItem:0x00007f876525e8d0
 ...
 
 item = RelatonIec::IecBibliography.get("IEC 60050-112", "2010", all_parts: true)
-[relaton-iec] ("IEC 60050-112") fetching...
-[relaton-iec] ("IEC 60050-112") found IEC 60050 (all parts)
+[relaton-iec] (IEC 60050-112) Fetching from Relaton repository ...
+[relaton-iec] (IEC 60050-112) Found: `IEC 60050 (all parts)`
 => #<RelatonIec::IecBibliographicItem:0x00007f87851888f0
 ...
 
@@ -93,8 +104,8 @@ item.docidentifier.first
 => #<RelatonBib::DocumentIdentifier:0x00007f878518eea8 @id="IEC 60050 (all parts)", @language=nil, @primary=true, @scope=nil, @script=nil, @type="IEC">
 
 item = RelatonIec::IecBibliography.get("IEC 60050-112", "2010")
-[relaton-iec] ("IEC 60050-112") fetching...
-[relaton-iec] ("IEC 60050-112") found IEC 60050-112:2010
+[relaton-iec] (IEC 60050-112) Fetching from Relaton repository ...
+[relaton-iec] (IEC 60050-112) Found: `IEC 60050-112:2010`
 => #<RelatonIec::IecBibliographicItem:0x007fa69f296da8
 
 item.docidentifier.first

data/lib/relaton_iec/basic_block/image.rb

@@ -13,12 +13,12 @@ module BasicBlock
       @mimetype = mimetype
       @filename = args[:filename]
       if args[:width] && !args[:width].is_a?(Integer) && args[:width] != "auto"
-        warn "[basic-block] WARNING: invalid image width attribute \"#{args[:width]}"
-        warn "[basic-block] image width should be integer or \"auto\""
+        warn "[basic-block] WARNING: Invalid image width attribute: \"#{args[:width]}"
+        warn "[basic-block] Image width should be integer or \"auto\""
       end
       if args[:height] && !args[:height].is_a?(Integer) && args[:height] != "auto"
-        warn "[basic-block] WARNING: invalid image height attribute \"#{args[:height]}"
-        warn "[basic-block] image height should be integer or \"auto\""
+        warn "[basic-block] WARNING: Invalid image height attribute: \"#{args[:height]}"
+        warn "[basic-block] Image height should be integer or \"auto\""
       end
       @width = args[:width]
       @height = args[:height]

data/lib/relaton_iec/basic_block/reference_format.rb

@@ -15,8 +15,8 @@ module RelatonIec
     #
     def initialize(format)
       unless FORMATS.include? format
-        warn "[relaton-iec] WARNING: invalid reference format \"#{format}\""
-        warn "[relaton-iec] alloved reference formats are: #{FORMATS.join ', '}"
+        warn "[relaton-iec] WARNING: Invalid reference format: \"#{format}\""
+        warn "[relaton-iec] Alloved reference formats are: #{FORMATS.join ', '}"
       end
       @format = format
     end

data/lib/relaton_iec/basic_block/stem.rb

@@ -11,8 +11,8 @@ module BasicBlock
     #
     def initialize(type:, content: [])
       unless TYPES.include? type
-        warn "[relaton-iec] WARNING: invalud type \"#{type}\""
-        warn "[relaton-iec] allowed types are: #{TYPES.join ', '}"
+        warn "[relaton-iec] WARNING: Invalud type: \"#{type}\""
+        warn "[relaton-iec] Allowed types are: #{TYPES.join ', '}"
       end
       @type = type
       @content = content

data/lib/relaton_iec/config.rb

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

data/lib/relaton_iec/iec_bibliographic_item.rb

@@ -34,15 +34,13 @@ module RelatonIec
     #
     def initialize(**args) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       if args[:function] && !FUNCTION.include?(args[:function])
-        warn "[relaton-iec] WARNING: invalid function \"#{args[:function]}\""
-        warn "[relaton-iec] allowed function values are: #{FUNCTION.join(', ')}"
+        Util.warn "WARNING: Invalid function: `#{args[:function]}`"
+        Util.warn "Allowed function values are: `#{FUNCTION.join('`, `')}`"
       end
       if args[:updates_document_type] &&
           !DOCTYPES.include?(args[:updates_document_type])
-        warn "[relaton-iec] WARNING: invalid updates_document_type " \
-             "\"#{args[:updates_document_type]}\""
-        warn "[relaton-iec] allowed updates_document_type values are: " \
-             "#{DOCTYPES.join(', ')}"
+        Util.warn "WARNING: Invalid updates_document_type: `#{args[:updates_document_type]}`"
+        Util.warn "Allowed updates_document_type values are: `#{DOCTYPES.join('`, `')}`"
       end
       @function = args.delete :function
       @updates_document_type = args.delete :updates_document_type

data/lib/relaton_iec/iec_bibliography.rb

@@ -46,9 +46,8 @@ module RelatonIec
       # @param missed_years [Array<String>]
       def warn_missing_years(pubid, year, missed_years)
         id = ref_with_year(pubid, year)
-        warn "[relaton-iec] (\"#{id}\") TIP: " \
-          "No match for edition year #{year}, " \
-          "but matches exist for #{missed_years.uniq.join(', ')}."
+        Util.warn "(#{id}) TIP: No match for edition year `#{year}`, " \
+                  "but matches exist for `#{missed_years.uniq.join('`, `')}`."
       end
 
       # @param code [String]
@@ -57,9 +56,7 @@ module RelatonIec
       def fetch_ref_err(code, year, missed_years) # rubocop:disable Metrics/MethodLength
         id = ref_with_year(code, year)
 
-        warn "[relaton-iec] (\"#{id}\") " \
-             "Not found. "\
-             "The identifier must be exactly as shown on the IEC Webstore."
+        Util.warn "(#{id}) Not found."
 
         if year && missed_years.any?
           warn_missing_years(code, year, missed_years)
@@ -68,13 +65,11 @@ module RelatonIec
         # TODO: change this to pubid-iec
         has_part = /\d-\d/.match?(code)
         if has_part
-          warn "[relaton-iec] (\"#{id}\") TIP: " \
-               "If it cannot be found, the document may no longer be published in parts."
+          Util.warn "(#{id}) TIP: If it cannot be found, the document may no longer be published in parts."
 
         else
-          warn "[relaton-iec] (\"#{id}\") TIP: " \
-               "If you wish to cite all document parts for the reference, " \
-               "use (\"#{code} (all parts)\")."
+          Util.warn "(#{id}) TIP: If you wish to cite all document parts for " \
+                    "the reference, use `#{code} (all parts)`."
         end
 
         # TODO: streamline after integration with pubid-iec
@@ -83,9 +78,8 @@ module RelatonIec
           code.include?("#{t} ")
         end
         unless selected_doctype
-          warn "[relaton-iec] (\"#{id}\") TIP: " \
-              "If the document is not an International Standard, use its " \
-              "deliverable type abbreviation (#{doctypes.join(", ")})."
+          Util.warn "(#{id}) TIP: If the document is not an International Standard, use its " \
+                    "deliverable type abbreviation `#{doctypes.join('`, `')}`."
         end
 
         nil
@@ -95,7 +89,7 @@ module RelatonIec
       # @param year [String]
       # @return [String]
       def ref_with_year(ref, year)
-        year ? [ref, year].join(":") : ref
+        year && !ref.match?(/:\d{4}/) ? [ref, year].join(":") : ref
       end
 
       # @param ref [String]
@@ -131,7 +125,7 @@ module RelatonIec
       # @return [RelatonIec::HitCollection]
       def search_filter(ref, year)
         code = ref.split(":").first
-        warn "[relaton-iec] (\"#{ref_with_year(ref, year)}\") Fetching from IEC..."
+        Util.warn "(#{ref_with_year(ref, year)}) Fetching from Relaton repsitory ..."
         search(code)
       end
 
@@ -256,17 +250,14 @@ module RelatonIec
         id = ref_with_year(code, year)
         docid = ret[:ret].docidentifier.first.id
 
-        if id == docid
-          warn "[relaton-iec] (\"#{id}\") Found exact match."
-        else
-          warn "[relaton-iec] (\"#{id}\") Found (\"#{docid}\")."
-        end
+        # if id == docid then Util.warn "(#{id}) Found exact match."
+        # else
+        Util.warn "(#{id}) Found: `#{docid}`"
+        # end
 
         if ret[:missed_parts]
-          warn "[relaton-iec] (\"#{id}\") TIP: " \
-          "\"#{code}\" also contains other parts, " \
-          "if you want to cite all parts, use "\
-          "(\"#{code} (all parts)\")."
+          Util.warn "(#{id}) TIP: `#{code}` also contains other parts, " \
+                    "if you want to cite all parts, use `#{code} (all parts)`."
         end
 
         ret[:ret]

data/lib/relaton_iec/util.rb

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

data/lib/relaton_iec/version.rb

@@ -1,3 +1,3 @@
 module RelatonIec
-  VERSION = "1.16.0".freeze
+  VERSION = "1.16.2".freeze
 end

data/lib/relaton_iec.rb

@@ -7,6 +7,8 @@ require "relaton/index"
 require "relaton_iso_bib"
 require "relaton_iec/hit"
 require "relaton_iec/version"
+require "relaton_iec/config"
+require "relaton_iec/util"
 require "relaton_iec/iec_bibliography"
 require "relaton_iec/iec_bibliographic_item"
 require "relaton_iec/xml_parser"
@@ -20,10 +22,10 @@ module RelatonIec
     # Returns hash of XML reammar
     # @return [String]
     def 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 RelatonIec::VERSION + RelatonIsoBib::VERSION + RelatonBib::VERSION # grammars
     end
 
     # @param code [String]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-iec
 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-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -109,6 +109,7 @@ files:
 - lib/relaton_iec/basic_block/stem.rb
 - lib/relaton_iec/basic_block/table.rb
 - lib/relaton_iec/basic_block/text_element.rb
+- lib/relaton_iec/config.rb
 - lib/relaton_iec/data_fetcher.rb
 - lib/relaton_iec/data_parser.rb
 - lib/relaton_iec/hash_converter.rb
@@ -120,6 +121,7 @@ files:
 - lib/relaton_iec/processor.rb
 - lib/relaton_iec/statuses.yml
 - lib/relaton_iec/tc_sc_officers_note.rb
+- lib/relaton_iec/util.rb
 - lib/relaton_iec/version.rb
 - lib/relaton_iec/xml_parser.rb
 - relaton_iec.gemspec