relaton-etsi 1.18.0 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd8b1afecd70ee7ac07ba4b734af8b0b9ade5998348866f82876b06bfd7be068
-  data.tar.gz: cd83c99606d209824fffaa12ea2133eccf6c0b73a92d010d30e9353307d63303
+  metadata.gz: 81c7a95a6b38369cc2700680b2c39f3d8d75fff3761123e4fb87565a2f04dc2d
+  data.tar.gz: 29d1ac8bd79de191815a29a055189d05de180f964f095f3f6bdd5f77721ed892
 SHA512:
-  metadata.gz: 5ca5594263e19b6fa91fb59d5f1c5a55cbd24c59bc45de30761e644c26859cce4da0bdebf3e5d5330fa6d83696b5a3843aca401b4c46ea3618892c81576a5eee
-  data.tar.gz: 8f5633242ded91de51eb65c456e7ddd9286159cef042043d29dd1abc1452ccab42736911cf6fc52f00cdfb5a969a9e1b426922f41486eb2112d344816966ed39
+  metadata.gz: d4d477ef680da1638a383cf1fcf4b04ef2fd9afc0e5687846868376063e194d45be309cea28ceccaee49714dded0f1eb46e52eae7c0b6cf41fd6e00e716e18f0
+  data.tar.gz: deebba6853e866f7ea6814aeabe5c07285fcc7c02fe69d2b47a6436acda8958fdd42a03e08e2b18703791cc344fe1843b45bdd44e3fc4169dc67f997c05c6438

data/README.adoc

@@ -23,24 +23,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 `RelatonEtsi.configure` block.
+=== Search for a standard using keywords
 
 [source,ruby]
 ----
 require 'relaton_etsi'
 => true
 
-RelatonEtsi.configure do |config|
-  config.logger.level = Logger::DEBUG
-end
-----
-
-=== Search for a standard using keywords
-
-[source,ruby]
-----
 item = RelatonEtsi::Bibliography.get("ETSI GS ZSM 012 V1.1.1")
 [relaton-etsi] (ETSI GS ZSM 012 V1.1.1) Fetching from Relaton repository ...
 [relaton-etsi] (ETSI GS ZSM 012 V1.1.1) Found: `ETSI GS ZSM 012 V1.1.1 (2022-12)`
@@ -156,6 +145,10 @@ Done in: 204 sec.
 => nil
 ----
 
+=== Logging
+
+RelatonEtsi 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_etsi/bibliographic_item.rb

@@ -55,13 +55,17 @@ module RelatonEtsi
 
     def to_hash # rubocop:disable Metrics/AbcSize
       hash = super
-      hash["marker"] = marker if marker
-      hash["frequency"] = frequency if frequency.any?
-      hash["mandate"] = mandate if mandate.any?
-      hash["custom_collection"] = custom_collection if custom_collection
+      hash["ext"]["marker"] = marker if marker
+      hash["ext"]["frequency"] = frequency if frequency.any?
+      hash["ext"]["mandate"] = mandate if mandate.any?
+      hash["ext"]["custom_collection"] = custom_collection if custom_collection
       hash
     end
 
+    def has_ext?
+      super || marker || frequency.any? || mandate.any? || custom_collection
+    end
+
     def to_asciibib(prefix = "") # rubocop:disable Metrics/AbcSize
       out = super
       pref = prefix.empty? ? prefix : "#{prefix}."

data/lib/relaton_etsi/bibliography.rb

@@ -32,14 +32,14 @@ module RelatonEtsi
     # @param opts [Hash] options
     # @return [RelatonEtsi::BibliographicItem]
     def get(ref, _year = nil, _opts = {})
-      Util.warn "(#{ref}) Fetching from Relaton repository ..."
+      Util.info "Fetching from Relaton repository ...", key: ref
       result = search(ref)
       unless result
-        Util.warn "(#{ref}) Not found."
+        Util.info "Not found.", key: ref
         return
       end
 
-      Util.warn "(#{ref}) Found: `#{result.docidentifier[0].id}`"
+      Util.info "Found: `#{result.docidentifier[0].id}`", key: ref
       result
     end
 

data/lib/relaton_etsi/document_type.rb

@@ -34,13 +34,13 @@ module RelatonEtsi
     def check_type(type)
       return if DOCTYPES.value? type
 
-      Util.warn "WARNING: invalid doctype: `#{type}`"
+      Util.warn "invalid doctype: `#{type}`"
     end
 
     def check_abbreviation(abbreviation)
       return if abbreviation.nil? || DOCTYPES.key?(abbreviation)
 
-      Util.warn "WARNING: invalid doctype abbreviation: `#{abbreviation}`"
+      Util.warn "invalid doctype abbreviation: `#{abbreviation}`"
     end
   end
 end

data/lib/relaton_etsi/hash_converter.rb

@@ -3,6 +3,15 @@ module RelatonEtsi
     include RelatonBib::HashConverter
     extend self
 
+    def hash_to_bib(hash) # rubocop:disable Metrics/AbcSize
+      ret = super
+      ret[:marker] = hash["ext"]["marker"] if hash.dig("ext", "marker")
+      ret[:frequency] = hash["ext"]["frequency"] if hash.dig("ext", "frequency")
+      ret[:mandate] = hash["ext"]["mandate"] if hash.dig("ext", "mandate")
+      ret[:custom_collection] = hash["ext"]["custom_collection"] if hash.dig("ext", "custom_collection")
+      ret
+    end
+
     private
 
     # @param item_hash [Hash]
@@ -10,5 +19,9 @@ module RelatonEtsi
     def bib_item(item_hash)
       BibliographicItem.new(**item_hash)
     end
+
+    def create_doctype(**args)
+      DocumentType.new(**args)
+    end
   end
 end

data/lib/relaton_etsi/util.rb

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

data/lib/relaton_etsi/version.rb

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

data/lib/relaton_etsi/xml_parser.rb

@@ -23,6 +23,10 @@ module RelatonEtsi
         BibliographicItem.new(**item_hash)
       end
 
+      def create_doctype(type)
+        DocumentType.new type: type.text, abbreviation: type[:abbreviation]
+      end
+
       # def fetch_status(item)
       #   status = item.at "./status"
       #   return unless status

data/lib/relaton_etsi.rb

@@ -6,7 +6,6 @@ require "csv"
 require "relaton/index"
 require "relaton_bib"
 require_relative "relaton_etsi/version"
-require_relative "relaton_etsi/config"
 require_relative "relaton_etsi/util"
 require_relative "relaton_etsi/pubid"
 require_relative "relaton_etsi/document_type"

metadata

@@ -1,29 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: relaton-etsi
 version: !ruby/object:Gem::Version
-  version: 1.18.0
+  version: 1.20.0
 platform: ruby
 authors:
 - Ribose Inc.
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-06 00:00:00.000000000 Z
+date: 2024-12-12 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: relaton-bib
   requirement: !ruby/object:Gem::Requirement
     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: relaton-index
   requirement: !ruby/object:Gem::Requirement
@@ -59,7 +73,6 @@ files:
 - lib/relaton_etsi.rb
 - lib/relaton_etsi/bibliographic_item.rb
 - lib/relaton_etsi/bibliography.rb
-- lib/relaton_etsi/config.rb
 - lib/relaton_etsi/data_fetcher.rb
 - lib/relaton_etsi/data_parser.rb
 - lib/relaton_etsi/document_type.rb
@@ -75,7 +88,7 @@ licenses:
 - BSD-2-Clause
 metadata:
   homepage_uri: https://github.com/relaton/relaton-etsi
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -90,8 +103,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
-signing_key: 
+rubygems_version: 3.3.27
+signing_key:
 specification_version: 4
 summary: 'RelatonEtsi: retrieve ETSI Standards for bibliographic using the BibliographicItem
   model'

data/lib/relaton_etsi/config.rb

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