relaton-oasis 1.14.1 → 1.14.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 271398297c476606859e84b1d808cd07a9d6dc3a0297f212fcd91882be951e02
-  data.tar.gz: b14587e10808e34d12e16435a1c8a54952f5c10d03ce22c188154febc3418d95
+  metadata.gz: 7c6f3b9c0380f97640c3e5a56a3e67226681746241690e9426689ef65e0e9345
+  data.tar.gz: 2b7b26ada6346de6079bcab0ea94c74c2b77e9991f466df56f724a35638de4dc
 SHA512:
-  metadata.gz: 695e2ecd8942151fedcee25b1ed2c50fc22ee56e98c6e5189dbc35476faf9c48e378e3780840fe80d2f33cb64e05187a4153f0006d7832e117ab65222fe2dc47
-  data.tar.gz: fa428bedddf06c4415f189666196b7efdab60e9a49273a64ee4fcfaf52b1c2e4cc45b86f7508477a8e054230d8f5c8d69e2818d3888638f7e3adf7766342a8e9
+  metadata.gz: fc86a45ca8524a71b770c988dd36093c026e43c42bc0a79fa0a5398187a1313bf16a4b5e78f754b648361814157c9fa704eea9b272c547697ba2a7983fa109c5
+  data.tar.gz: c0a82b4f9484fee0dde9a48b7cf9ba8cb7b3a949d7f76df55451fef315e8bfa8c24b5cad6eed1f7d9e419b9182694c023d1f108169b4ac0d6fca36d3b04ce7f6

data/.github/workflows/rake.yml

@@ -5,6 +5,7 @@ name: rake
 on:
   push:
     branches: [ master, main ]
+    tags: [ v* ]
   pull_request:
 
 jobs:

data/.github/workflows/release.yml

@@ -10,8 +10,9 @@ on:
           Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
         required: true
         default: 'skip'
-  push:
-    tags: [ v* ]
+  repository_dispatch:
+    types: [ do-release ]
+
 
 jobs:
   release:

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/vendor/
 
 # rspec failure tracking
 .rspec_status

data/.rubocop.yml

@@ -7,6 +7,6 @@ require: rubocop-rails
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 2.7
 Rails:
   Enabled: false

data/Gemfile

@@ -6,7 +6,14 @@ source "https://rubygems.org"
 gemspec
 
 gem "rake", "~> 13.0"
-
 gem "rspec", "~> 3.0"
 
+gem "equivalent-xml", "~> 0.6"
+gem "pry-byebug"
 gem "rubocop", "~> 1.7"
+gem "rubocop-performance"
+gem "rubocop-rails"
+gem "ruby-jing"
+gem "simplecov"
+gem "vcr", "~> 5.0.0"
+gem "webmock"

data/README.adoc

@@ -32,7 +32,7 @@ Or install it yourself as:
 
 === 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 in the repository.
+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]
 ----

data/grammars/basicdoc.rng

@@ -522,7 +522,6 @@
       <value>tip</value>
       <value>important</value>
       <value>caution</value>
-      <value>statement</value>
     </choice>
   </define>
   <define name="figure">

data/grammars/biblio.rng

@@ -216,6 +216,9 @@
       <optional>
         <ref name="fullname"/>
       </optional>
+      <zeroOrMore>
+        <ref name="credential"/>
+      </zeroOrMore>
       <zeroOrMore>
         <ref name="affiliation"/>
       </zeroOrMore>
@@ -232,6 +235,11 @@
       <ref name="FullNameType"/>
     </element>
   </define>
+  <define name="credential">
+    <element name="credential">
+      <text/>
+    </element>
+  </define>
   <define name="FullNameType">
     <choice>
       <group>
@@ -305,7 +313,9 @@
       <zeroOrMore>
         <ref name="affiliationdescription"/>
       </zeroOrMore>
-      <ref name="organization"/>
+      <optional>
+        <ref name="organization"/>
+      </optional>
     </element>
   </define>
   <define name="affiliationname">
@@ -1316,7 +1326,7 @@
       <value>commentaryOf</value>
       <value>hasCommentary</value>
       <value>related</value>
-      <value>complements</value>
+      <value>hasComplement</value>
       <value>complementOf</value>
       <value>obsoletes</value>
       <value>obsoletedBy</value>

data/lib/relaton_oasis/data_fetcher.rb

@@ -11,6 +11,7 @@ module RelatonOasis
       @format = format
       @ext = @format.sub(/^bib|^rfc/, "")
       @files = []
+      @index = Index.new
     end
 
     #
@@ -22,7 +23,7 @@ module RelatonOasis
     def self.fetch(output: "data", format: "yaml")
       t1 = Time.now
       puts "Started at: #{t1}"
-      FileUtils.mkdir_p output unless Dir.exist? output
+      FileUtils.mkdir_p output
       new(output, format).fetch
       t2 = Time.now
       puts "Stopped at: #{t2}"
@@ -40,6 +41,7 @@ module RelatonOasis
         save_doc DataParser.new(item).parse
         fetch_parts item
       end
+      @index.save
     end
 
     #
@@ -72,6 +74,7 @@ module RelatonOasis
         warn "File #{file} already exists. Document: #{doc.docnumber}"
       else
         @files << file
+        @index[doc] = file
       end
       File.write file, c, encoding: "UTF-8"
     end

data/lib/relaton_oasis/data_parser.rb

@@ -1,4 +1,5 @@
 module RelatonOasis
+  # Parser for OASIS document.
   class DataParser
     include RelatonOasis::DataParserUtils
 
@@ -106,7 +107,7 @@ module RelatonOasis
     end
 
     #
-    # Parse document part references.
+    # Look for "Cite as" references.
     #
     # @return [Array<String>] document part references
     #

data/lib/relaton_oasis/data_parser_utils.rb

@@ -1,4 +1,5 @@
 module RelatonOasis
+  # Common methods for document and part parsers.
   module DataParserUtils
     #
     # Parse document identifier specification.

data/lib/relaton_oasis/data_part_parser.rb

@@ -1,4 +1,5 @@
 module RelatonOasis
+  # Parser for OASIS part document.
   class DataPartParser
     include RelatonOasis::DataParserUtils
 

data/lib/relaton_oasis/index.rb

@@ -0,0 +1,75 @@
+module RelatonOasis
+  # Index of OASIS documents.
+  class Index
+    #
+    # Initialize a new Index
+    #
+    def initialize(file = "index.yaml")
+      @file = file
+      read
+    end
+
+    #
+    # Read index from file or fetch from GitHub.
+    #
+    # @return [RelatonOasis::Index, nil] index
+    #
+    def self.create_or_fetch
+      file = File.join Dir.home, ".relaton", "oasis", "index.yaml"
+      unless File.exist?(file) && File.ctime(file) > Time.now - 86_400
+        url = "https://raw.githubusercontent.com/relaton/relaton-data-oasis/main/index.yaml"
+        idx = Net::HTTP.get URI url
+        File.write file, idx, encoding: "UTF-8"
+      end
+      new file
+    rescue StandardError => e
+      warn "Failed to fetch index: #{e.message}"
+    end
+
+    #
+    # Put document's record to index.
+    #
+    # @param [RelatonOasis::OasisBibliographicItem] doc document
+    # @param [String] file file name
+    #
+    def []=(doc, file) # rubocop:disable Metrics/AbcSize
+      rec = self[doc.docidentifier[0].id]
+      rec ||= begin
+        @index << { id: doc.docidentifier[0].id }
+        @index.last
+      end
+      rec[:title] = doc.title[0].title.content
+      rec[:file] = file
+    end
+
+    #
+    # Fetch document's record from index.
+    #
+    # @param [String] id document identifier
+    #
+    # @return [Hash] document's record
+    #
+    def [](id)
+      @index.detect { |i| i[:id] == id }
+    end
+
+    #
+    # Save index to file.
+    #
+    def save
+      File.open @file, "w:UTF-8" do |f|
+        f.puts "---\n"
+        @index.each do |i|
+          f.puts "- id: '#{i[:id]}'\n  title: '#{i[:title]}'\n  file: '#{i[:file]}'\n"
+        end
+      end
+    end
+
+    #
+    # Read from file or create empty index.
+    #
+    def read
+      @index = File.exist?(@file) ? YAML.load_file(@file, symbolize_names: true) : []
+    end
+  end
+end

data/lib/relaton_oasis/version.rb

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

data/lib/relaton_oasis.rb

@@ -11,6 +11,7 @@ require_relative "relaton_oasis/data_fetcher"
 require_relative "relaton_oasis/data_parser_utils"
 require_relative "relaton_oasis/data_parser"
 require_relative "relaton_oasis/data_part_parser"
+require_relative "relaton_oasis/index"
 
 module RelatonOasis
   class Error < StandardError; end

data/relaton_oasis.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
                        "using the BibliographicItem model"
   spec.homepage      = "https://github.com/metanorma/relaton-oasis"
   spec.license       = "BSD-2-Clause"
-  spec.required_ruby_version = ">= 2.5.0"
+  spec.required_ruby_version = ">= 2.7.0"
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
@@ -31,16 +31,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "equivalent-xml", "~> 0.6"
-  spec.add_development_dependency "pry-byebug"
-  spec.add_development_dependency "rubocop-performance"
-  spec.add_development_dependency "rubocop-rails"
-  spec.add_development_dependency "ruby-jing"
-  spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "vcr", "~> 5.0.0"
-  spec.add_development_dependency "webmock"
-
-  spec.add_dependency "mechanize"
+  spec.add_dependency "mechanize", "~> 2.8.0"
+  spec.add_dependency "multi_json", "~> 1.15.0"
   spec.add_dependency "relaton-bib", "~> 1.14.0"
 
   # For more information and examples about making a new gem, checkout our

metadata

@@ -1,141 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: relaton-oasis
 version: !ruby/object:Gem::Version
-  version: 1.14.1
+  version: 1.14.3
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-12-06 00:00:00.000000000 Z
+date: 2023-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: equivalent-xml
+  name: mechanize
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
+        version: 2.8.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.8.0
 - !ruby/object:Gem::Dependency
-  name: rubocop-performance
+  name: multi_json
   requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: ruby-jing
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 5.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mechanize
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: relaton-bib
   requirement: !ruby/object:Gem::Requirement
@@ -181,6 +83,7 @@ files:
 - lib/relaton_oasis/data_parser_utils.rb
 - lib/relaton_oasis/data_part_parser.rb
 - lib/relaton_oasis/hash_converter.rb
+- lib/relaton_oasis/index.rb
 - lib/relaton_oasis/oasis_bibliographic_item.rb
 - lib/relaton_oasis/oasis_bibliography.rb
 - lib/relaton_oasis/processor.rb
@@ -201,14 +104,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: 'RelatonOasis: retrieve OASIS Standards for bibliographic use using the BibliographicItem