relaton-oasis 1.18.0 → 1.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7af584f19a16f6f912b1242faab1684145903c6692e296dcfb22a8d447ec4111
-  data.tar.gz: 9cbcfa115749c4b3437d8779b1e629d9091626c63bb0acee052e477eb90bc8bb
+  metadata.gz: 17e6c9703f4210dd9ce8674da36d2f55d3333adeae4327cead1916500568f379
+  data.tar.gz: b1949a584249b5b509e1b8178de12b9abd8c1c8cb8ca03da620ce7c2a8cb9d2e
 SHA512:
-  metadata.gz: 1e16bd7e46e2b93ae7302d8a05e440dd16aa546eca389424f14f316bea536ac4ce99fdb73bac4d3ddf0ec1041f84cedd0e17eec26216157d4b0619dfee6ee86f
-  data.tar.gz: e7d0d75e90aea7b43ad3c16f02ac2656cdcca891ad935629ed1a3c68b88fc3b3a864426c744185c15ab9999ae55397d13af1b363485a4fd587aa98b04cf9a0ee
+  metadata.gz: fba601c6195bb9bacc28fa4ed4e58f6ed0d1fdcaa944f313c1019b96e5b371e0c606214fe1ccc116bbf0e0e4195480fdf04ad40951a41819a8e3652a537dde8e
+  data.tar.gz: f2e4fc968c99c09d0704692221fbd16a1427e26001d22c1fff5c39816c5a39501a0c4ddf05ed21ea55163e8e61ebff3b6f673850190368c8b6f6b212fc8a30ee

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/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_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.rb

@@ -165,14 +165,17 @@ module RelatonOasis
 
     #
     # Parse document number.
+    # If the docuemnt has no parts, the document number is constructed from the title.
+    # If the document had one part, the document number is constructed from the part.
+    # If the document has parts, the document number is constructed from the parts.
     #
     # @return [String] document number
     #
     def parse_docnumber
       parts = document_part_refs
       case parts.size
-      when 0 then title_to_docid @node.at("./summary/div/h2").text
-      when 1 then parse_spec(parts[0])
+      when 0 then parse_spec title_to_docid(@node.at("./summary/div/h2").text)
+      when 1 then parse_part parse_spec(parts[0])
       else parts_to_docid parts
       end
     end
@@ -194,7 +197,7 @@ module RelatonOasis
           end
         end
       end.join("-")
-      parse_spec(id)
+      parse_part parse_spec(id)
     end
 
     #

data/lib/relaton_oasis/data_parser_utils.rb

@@ -34,12 +34,29 @@ module RelatonOasis
       if link_node && link_node[:href].match?(/\.html$/)
         agent = Mechanize.new
         agent.agent.allowed_error_codes = [404]
-        sleep 1 # to avoid 429 error
-        resp = agent.get link_node[:href]
-        @page = resp if resp.code == "200"
+        resp = retry_page(link_node[:href], agent)
+        @page = resp if resp && resp.code == "200"
       end
     end
 
+    #
+    # Retry to get page.
+    #
+    # @param [String] url page URL
+    # @param [Mechanize] agent HTTP client
+    # @param [Integer] retries number of retries
+    #
+    # @return [Mechanize::Page, nil] page or nil
+    #
+    def retry_page(url, agent, retries = 3)
+      sleep 1 # to avoid 429 error
+      agent.get url
+    rescue Errno::ETIMEDOUT, Net::OpenTimeout => e
+      retry if (retries -= 1).positive?
+      Util.error "Failed to get page `#{url}`\n#{e.message}"
+      nil
+    end
+
     def parse_chairs
       return [] unless page
 
@@ -96,12 +113,11 @@ module RelatonOasis
     # @return [String] document identifier with specification if needed
     #
     def parse_spec(num)
-      id = case text
-           when /OASIS Project Specification (\d+)/ then "#{num}-PS#{$1}"
-           when /Committee Specification (\d+)/ then "#{num}-CS#{$1}"
-           else num
-           end
-      parse_part(id)
+      case text
+      when /OASIS Project Specification (\d+)/ then "#{num}-PS#{$1}"
+      when /Committee Specification (\d+)/ then "#{num}-CS#{$1}"
+      else num
+      end
     end
 
     #
@@ -169,9 +185,9 @@ module RelatonOasis
     # @return [Array<String>] technology areas
     #
     def parse_technology_area(node)
-      node.xpath(
-        "./summary/div/div/ul[@class='technology-areas__list']/li/a",
-      ).map { |ta| ta.text.strip.gsub(/\s/, "-") }
+      node.xpath("./summary/div/div/ul[@class='technology-areas__list']/li/a").map do |ta|
+        ta.text.strip.gsub(/\s/, "-").sub("development", "Development")
+      end
     end
   end
 end

data/lib/relaton_oasis/data_part_parser.rb

@@ -13,9 +13,15 @@ module RelatonOasis
     end
 
     def text
-      @text ||= @node.xpath(
-        "./strong/following-sibling::text()|./span/strong/../following-sibling::text()",
-      ).text.strip
+      return @text if @text
+
+      if @node.at("./strong/following-sibling::text()|./span[strong]/following-sibling::text()")
+        @text = @node.xpath(
+          "./strong/following-sibling::node()|./span[strong]/following-sibling::node()",
+        ).text.strip
+      else
+        @text = @node.xpath("./following-sibling::p[1][em]").text.strip
+      end
     end
 
     def title
@@ -72,7 +78,7 @@ module RelatonOasis
       id = parse_errata(num)
       # some part references need to be added by "Pt" to be distinguishable from root doc
       id += "-Pt" if %w[CMIS-v1.1 DocBook-5.0 XACML-V3.0 mqtt-v3.1.1 OData-JSON-Format-v4.0].include?(id)
-      parse_spec id
+      parse_part parse_spec id
     end
 
     #
@@ -81,8 +87,7 @@ module RelatonOasis
     # @return [Array<RelatonBib::TypedTitleString>] link
     #
     def parse_link
-      l = @node.at("./a")
-      [RelatonBib::TypedUri.new(type: "src", content: l[:href])]
+      [RelatonBib::TypedUri.new(type: "src", content: link_node[:href])]
     end
 
     #
@@ -139,7 +144,7 @@ module RelatonOasis
     end
 
     def link_node
-      @link_node = @node.at("./a")
+      @link_node = @node.at("./a|./following-sibling::p[1]/a")
     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/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

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.0"
+  VERSION = "1.19.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

@@ -31,9 +31,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "mechanize", "~> 2.8.0"
+  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.19.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.0
+  version: 1.19.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2024-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mechanize
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '2.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: '2.10'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,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: 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
@@ -128,7 +127,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: 'RelatonOasis: retrieve OASIS Standards for bibliographic use using the BibliographicItem

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