relaton-oasis 1.18.1 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dac6ccdcd3852748aecbcc84c9ed6e5228fe321ab6659de9d7bf2233f9850c5a
-  data.tar.gz: 285d6b583d9ba375a41be2c82dc1c025353cb39e160c76652eef266170fbbf69
+  metadata.gz: e74c293597d3b10f3434807b8a150846ef37de5946df81bf0cd4fd4505876925
+  data.tar.gz: 780ac30d91ca5a34b40ec91da8c92f0f65b93a593c4737fa85f5a94a4c80f7b3
 SHA512:
-  metadata.gz: a9ff1cebaef0e7b8ea8e995aa47b9686042ff3e7ceb764dd6abbb4b60f3f16eee529514bd3a029d818ed55c1e1d05f214c578a4430592dc2f8231d356a94db66
-  data.tar.gz: d814e66a65fb439b70ba32ce02942d26c20ea83c741f0ebb14b9299eb38ada6ae90367db992554c168f7f4d04f556501ca9e6eaedf8d2e043473faad1a7dae4a
+  metadata.gz: 8864c2d988ab8236cd948816a1048bcb50b325b75551b25719c233621e0fa5aa472b18f726b0865fd8645d9d19ee4d9aa76a1c660c810daaed9b32c3ba11e012
+  data.tar.gz: e56f5948245ad158f6b39e8bcd99a84171ca3b4f60fc98b2fabaf8c318c30bbfbdfdf2b9967bfaedfc93276c9bdf597838b5753e8baae8d4296b0e350ded5392

data/README.adoc

@@ -1,4 +1,4 @@
-= RelatonBipm: retrieve OASIS Standards for bibliographic use using the BibliographicItem model
+= RelatonOasis: retrieve OASIS Standards for bibliographic use using the BibliographicItem model
 
 image:https://img.shields.io/gem/v/relaton-oasis.svg["Gem Version", link="https://rubygems.org/gems/relaton-oasis"]
 image:https://github.com/relaton/relaton-oasis/workflows/macos/badge.svg["Build Status (macOS)", link="https://github.com/relaton/relaton-oasis/actions?workflow=macos"]
@@ -30,26 +30,15 @@ Or install it yourself as:
 
 == Usage
 
-=== Configuration
+=== Get standard using reference.
 
-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 `RelatonOasis.configure` block.
+All the OASIS documents are parsed from https://www.oasis-open.org/standards/ and stored in a GitHub repository https://github.com/relaton/relaton-data-oasis. You can find all possible references on the index page https://relaton.github.io/relaton-data-oasis/.
 
 [source,ruby]
 ----
 require 'relaton_oasis'
 => true
 
-RelatonOasis.configure do |config|
-  config.logger.level = Logger::DEBUG
-end
-----
-
-=== Get standard using reference.
-
-All the OASIS documents are parsed from https://www.oasis-open.org/standards/ and stored in a GitHub repository https://github.com/relaton/relaton-data-oasis. You can find all possible references on the index page https://relaton.github.io/relaton-data-oasis/.
-
-[source,ruby]
-----
 item = RelatonOasis::OasisBibliography.get "OASIS amqp-core"
 [relaton-oasis] (OASIS) amqp-core Fetching from Relaton repository ...
 [relaton-oasis] (OASIS amqp-core) Found: `OASIS amqp-core`
@@ -62,7 +51,7 @@ item = RelatonOasis::OasisBibliography.get "OASIS amqp-core"
 [source,ruby]
 ----
 item.to_xml
-=> "<bibitem id="OASISamqp-core" type="standard" schema-version="v1.2.8">
+=> "<bibitem id="OASISamqp-core" type="standard" schema-version="v1.2.9">
       <fetched>2022-12-05</fetched>
       <title type="main" format="text/plain" language="en" script="Latn">Advanced Message Queueing Protocol (AMQP) v1.0</title>
       <docidentifier type="OASIS" primary="true">OASIS amqp-core</docidentifier>
@@ -75,7 +64,7 @@ With argument `bibdata: true` it ouputs XML wrapped by `bibdata` element and add
 [source,ruby]
 ----
 item.to_xml bibdata: true
-=> "<bibdata type="standard" schema-version="v1.2.8">
+=> "<bibdata type="standard" schema-version="v1.2.9">
       <fetched>2022-12-05</fetched>
       <title type="main" format="text/plain" language="en" script="Latn">Advanced Message Queueing Protocol (AMQP) v1.0</title>
       <docidentifier type="OASIS" primary="true">OASIS amqp-core</docidentifier>
@@ -121,7 +110,7 @@ RelatonOasis::XMLParser.from_xml File.read("spec/fixtures/oasis_bibdata.xml")
 [source,ruby]
 ----
 hash = YAML.load_file "spec/fixtures/oasis_bibdata.yaml"
-=> {"schema-version"=>"v1.2.8",
+=> {"schema-version"=>"v1.2.9",
  "id"=>"OASISamqp-core",
 ...
 
@@ -150,6 +139,10 @@ Done in: 5 sec.
 => nil
 ----
 
+=== Logging
+
+RelatonOasis 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/lib/relaton_oasis/data_fetcher.rb

@@ -73,7 +73,7 @@ module RelatonOasis
           end
       file = file_name doc
       if @files.include? file
-        warn "File #{file} already exists. Document: #{doc.docnumber}"
+        Util.warn "File #{file} already exists. Document: #{doc.docnumber}"
       else
         @files << file
         @index[doc] = file

data/lib/relaton_oasis/data_parser_utils.rb

@@ -53,8 +53,7 @@ module RelatonOasis
       agent.get url
     rescue Errno::ETIMEDOUT, Net::OpenTimeout => e
       retry if (retries -= 1).positive?
-      Util.error "Failed to get page `#{url}`"
-      Util.error e.message
+      Util.error "Failed to get page `#{url}`\n#{e.message}"
       nil
     end
 

data/lib/relaton_oasis/document_type.rb

@@ -1,6 +1,6 @@
 module RelatonOasis
   class DocumentType < RelatonBib::DocumentType
-    DCTYPES = %w[specification memorandum resolution standard].freeze
+    DOCTYPES = %w[specification memorandum resolution standard].freeze
 
     def initialize(type:, abbreviation: nil)
       chceck_type type
@@ -8,8 +8,8 @@ module RelatonOasis
     end
 
     def chceck_type(type)
-      unless DCTYPES.include? type
-        Util.warn "WARNING: invalid doctype: `#{type}`"
+      unless DOCTYPES.include? type
+        Util.warn "invalid doctype: `#{type}`"
       end
     end
   end

data/lib/relaton_oasis/hash_converter.rb

@@ -5,6 +5,12 @@ module RelatonOasis
 
     @@acronyms = nil
 
+    def hash_to_bib(hash)
+      ret = super
+      ret[:technology_area] = ret[:ext][:technology_area] if ret.dig(:ext, :technology_area)
+      ret
+    end
+
     private
 
     # @param item_hash [Hash]

data/lib/relaton_oasis/index.rb

@@ -23,7 +23,7 @@ module RelatonOasis
       end
       new file
     rescue StandardError => e
-      warn "Failed to fetch index: #{e.message}"
+      Util.error "Failed to fetch index: #{e.message}"
     end
 
     #

data/lib/relaton_oasis/oasis_bibliographic_item.rb

@@ -17,8 +17,8 @@ module RelatonOasis
       uta = @technology_area.reject { |a| AREAS.include? a }
       if uta.any?
         area = uta.size > 1 ? "areas" : "area"
-        Util.warn "WARNING Unknown technology #{area}: `#{uta.join('`, `')}`"
-        Util.warn "Valid values are: `#{AREAS.join('`, `')}`"
+        Util.warn "Unknown technology #{area}: `#{uta.join('`, `')}`\n" \
+          "Valid values are: `#{AREAS.join('`, `')}`"
       end
       super
     end
@@ -74,10 +74,14 @@ module RelatonOasis
     #
     def to_hash(embedded: false)
       hash = super
-      hash["technology_area"] = technology_area if technology_area.any?
+      hash["ext"]["technology_area"] = technology_area if technology_area.any?
       hash
     end
 
+    def has_ext?
+      super || technology_area.any?
+    end
+
     #
     # Render bibliographic item as AsciiBib.
     #

data/lib/relaton_oasis/oasis_bibliography.rb

@@ -36,13 +36,13 @@ module RelatonOasis
       #   reference is required
       # @return [RelatonOasis::OasisBibliographicItem, nil]
       def get(code, year = nil, _opts = {}) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/MethodLength,Metrics/PerceivedComplexity
-        Util.warn "(#{code}) Fetching from Relaton repository ..."
+        Util.info "Fetching from Relaton repository ...", key: code
         bibitem = search code, year
         if bibitem
           docid = bibitem.docidentifier.detect(&:primary).id
-          Util.warn "(#{code}) Found: `#{docid}`"
+          Util.info "Found: `#{docid}`", key: code
         else
-          Util.warn "(#{code}) Not found."
+          Util.info "Not found.", key: code
         end
         bibitem
       end

data/lib/relaton_oasis/util.rb

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

data/lib/relaton_oasis/version.rb

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

data/lib/relaton_oasis/xml_parser.rb

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

data/lib/relaton_oasis.rb

@@ -4,7 +4,6 @@ require "mechanize"
 require "relaton/index"
 require "relaton_bib"
 require_relative "relaton_oasis/version"
-require_relative "relaton_oasis/config"
 require_relative "relaton_oasis/util"
 require_relative "relaton_oasis/document_type"
 require_relative "relaton_oasis/oasis_bibliographic_item"

data/relaton_oasis.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "mechanize", "~> 2.10"
   spec.add_dependency "multi_json", "~> 1.15.0"
-  spec.add_dependency "relaton-bib", "~> 1.18.0"
+  spec.add_dependency "relaton-bib", "~> 1.20.0"
   spec.add_dependency "relaton-index", "~> 0.2.0"
 
   # For more information and examples about making a new gem, checkout our

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-oasis
 version: !ruby/object:Gem::Version
-  version: 1.18.1
+  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-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -44,14 +44,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: relaton-index
   requirement: !ruby/object:Gem::Requirement
@@ -92,7 +92,6 @@ files:
 - grammars/relaton-oasis-compile.rng
 - grammars/relaton-oasis.rng
 - lib/relaton_oasis.rb
-- lib/relaton_oasis/config.rb
 - lib/relaton_oasis/data_fetcher.rb
 - lib/relaton_oasis/data_parser.rb
 - lib/relaton_oasis/data_parser_utils.rb
@@ -113,7 +112,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/metanorma/relaton-oasis
   source_code_uri: https://github.com/metanorma/relaton-oasis
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -129,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.3.27
-signing_key: 
+signing_key:
 specification_version: 4
 summary: 'RelatonOasis: retrieve OASIS Standards for bibliographic use using the BibliographicItem
   model'

data/lib/relaton_oasis/config.rb

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