relaton-iec 1.18.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23222264df3598c17dc2543b6eb287da61a7f5ae9ea955862335b979324169db
-  data.tar.gz: fe8d5457ec3c28ff51393f774f293abd0a85cec632fcde1bd0327738d5f82e05
+  metadata.gz: c60902215d917d1699b588d576e9b0b775bb266617eb2f75f4fb8c1282d335c9
+  data.tar.gz: acc1c1bd4ad7fadacd3585eadef5b23bee9004568489164e2eb2638dde6aca2c
 SHA512:
-  metadata.gz: 9de3730c3c5e0df7fb03c945555cb0485c3036c6d1ee8b794fc78e8d992e7b486ea4d6a55088b784605a183f74a3980bdd2afbc4bd3a5ecf2320a019b1650578
-  data.tar.gz: 7bcf16a3f7789a8a4d1e4ea9c3fe83b64aff8135858c23623c9013abe7e1e34b3e640e9911088f44a8fea036abce435817bf498ab0059e499a2129c30bed83f6
+  metadata.gz: 5d84bf94de3ee0ab5d8572817422a934a06324babbe382442ed43a445ea52085ef884e586eb5f0cab43a5c0a86062f6501c3945a400244cf89ed089651d8c585
+  data.tar.gz: 54a7652ce95dc6cfe26a722af5f0e5ba7f4f45968e71e0abf1db1e3f00a5f9018d8981e5a2219e972d6192defebfd760770e5832322c960db7c1293473e776be

data/README.adoc

@@ -31,20 +31,6 @@ 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.
@@ -54,6 +40,9 @@ end
 
 [source,ruby]
 ----
+require 'relaton_iec'
+=> true
+
 hit_collection = RelatonIec::IecBibliography.search("60050")
 => <RelatonIec::HitCollection:0x007fe0d7126f28 @ref=60050 @fetched=false>
 
@@ -271,6 +260,10 @@ Done in: 752 sec.
 => nil
 ----
 
+=== Logging
+
+RelatonIec 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_iec/basic_block/alignment.rb

@@ -7,8 +7,7 @@ module BasicBlock
     #
     def initialize(content)
       unless ALIGNS.include?(content)
-        warn "[basic-block] WARNING: invalid alignment \"#{content}\""
-        warn "[basic-block] alloved aligments are: #{ALIGNS.join ', '}"
+        Util.warn "invalid alignment `#{content}`\nalloved aligments are: `#{ALIGNS.join '`, `'}`"
       end
       @content = content
     end

data/lib/relaton_iec/basic_block/image.rb

@@ -13,12 +13,11 @@ 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\""
+        Util.warn "Invalid image width attribute: `#{args[:width]}`\nImage 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\""
+        Util.warn "Invalid image height attribute: `#{args[:height]}`\n" \
+          "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 ', '}"
+        Util.warn "Invalid reference format: `#{format}`\n" \
+          "Alloved reference formats are: `#{FORMATS.join '`, `'}`"
       end
       @format = format
     end

data/lib/relaton_iec/basic_block/stem.rb

@@ -11,8 +11,7 @@ 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 ', '}"
+        Util.warn "Invalud type: `#{type}`\nAllowed types are: `#{TYPES.join '`, `'}`"
       end
       @type = type
       @content = content

data/lib/relaton_iec/basic_block/table.rb

@@ -74,12 +74,12 @@ module BasicBlock
       # @option args [String, nil] :valign
       def initialize(content, **args) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
         if args[:align] && !ALIGNS.include?(args[:align])
-          warn "[basic-block] WARNING: invalid table/tr/td align \"#{args[:align]}\""
-          warn "[basic-block] alloved aligns are: #{ALIGNS.join ', '}"
+          Util.warn "invalid table/tr/td align `#{args[:align]}`\n" \
+            "alloved aligns are: `#{ALIGNS.join '`, `'}`"
         end
         if args[:valign] && !VALIGNS.include?(args[:valign])
-          warn "[basic-block] WARNING: invalid table/tr/td valign \"#{args[:valign]}\""
-          warn "[basic-block] alloved valigns are: #{VALIGNS.join ', '}"
+          Util.warn "invalid table/tr/td valign `#{args[:valign]}`\n" \
+            "alloved valigns are: `#{VALIGNS.join '`, `'}`"
         end
         @content = content
         @colspan = args[:colspan]

data/lib/relaton_iec/basic_block/text_element.rb

@@ -10,8 +10,7 @@ module BasicBlock
     #
     def initialize(tag:, content:)
       unless TAGS.include? tag
-        warn "[basic-block] WARNING: invalid tag \"#{tag}\""
-        warn "[basic-block] allowed tags are: #{TAGS.join ', '}"
+        Util.warn "invalid tag `#{tag}`\nallowed tags are: `#{TAGS.join '`, `'}`"
       end
       @tag = tag
       @content = content

data/lib/relaton_iec/data_fetcher.rb

@@ -51,8 +51,9 @@ module RelatonIec
       puts "Stopped at: #{t2}"
       puts "Done in: #{(t2 - t1).round} sec."
     rescue StandardError => e
-      warn e.message
-      warn e.backtrace.join("\n")
+      Util.error do
+        "#{e.message}\n#{e.backtrace.join("\n")}"
+      end
     end
 
     def create_index
@@ -90,7 +91,7 @@ module RelatonIec
       while next_page
         res = fetch_page_token page
         unless res.code == "200"
-          warn "[relaton-iec] #{res.body}"
+          Util.warn "#{res.body}"
           break
         end
         json = JSON.parse res.body
@@ -162,7 +163,7 @@ module RelatonIec
       bib = DataParser.new(pub).parse
       did = bib.docidentifier.detect &:primary
       file = File.join(@output, "#{did.id.downcase.gsub(/[:\s\/]/, '_')}.#{@ext}")
-      if @files.include? file then warn "File #{file} exists."
+      if @files.include? file then Util.warn "File #{file} exists."
       else
         @files << file
         # @index.add index_id(pub), file, pub["lastChangeTimestamp"]

data/lib/relaton_iec/document_type.rb

@@ -13,7 +13,7 @@ module RelatonIec
 
     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_iec/hash_converter.rb

@@ -11,5 +11,9 @@ module RelatonIec
     def bib_item(item)
       IecBibliographicItem.new(**item)
     end
+
+    def create_doctype(**args)
+      DocumentType.new(**args)
+    end
   end
 end

data/lib/relaton_iec/iec_bibliographic_item.rb

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

data/lib/relaton_iec/iec_bibliography.rb

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

data/lib/relaton_iec/util.rb

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

data/lib/relaton_iec/version.rb

@@ -1,3 +1,3 @@
 module RelatonIec
-  VERSION = "1.18.0".freeze
+  VERSION = "1.19.0".freeze
 end

data/lib/relaton_iec/xml_parser.rb

@@ -29,6 +29,10 @@ module RelatonIec
       def bib_item(item_hash)
         IecBibliographicItem.new(**item_hash)
       end
+
+      def create_doctype(type)
+        DocumentType.new type: type.text, abbreviation: type[:abbreviation]
+      end
     end
   end
 end

data/lib/relaton_iec.rb

@@ -7,7 +7,6 @@ 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/document_type"
 require "relaton_iec/iec_bibliography"

data/relaton_iec.gemspec

@@ -24,7 +24,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.add_dependency "addressable"
+  spec.add_dependency "base64"
   spec.add_dependency "relaton-index", "~> 0.2.0"
-  spec.add_dependency "relaton-iso-bib", "~> 1.18.0"
+  spec.add_dependency "relaton-iso-bib", "~> 1.19.0"
   spec.add_dependency "rubyzip"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-iec
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-07 00:00:00.000000000 Z
+date: 2024-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: relaton-index
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: 1.19.0
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +123,6 @@ 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/document_type.rb
@@ -145,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: 'RelatonIec: retrieve IEC Standards for bibliographic use using the IecBibliographicItem

data/lib/relaton_iec/config.rb

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