relaton-oasis 1.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f220db8967faa301b9e1923d3238403ee10a3cef551a548dbd8c90edc2427db8
+  data.tar.gz: e662fc24b2f0df44491df9a4b1c13e7b323edfc8278f4e60f802ff12232f780e
+SHA512:
+  metadata.gz: 93e431a62f1a75cd2ff19aaded3532dad653ab76c6c34da318a43c24b19482f59e1f68753809134ab332c99dfbf07eb0e7873cbe52df03aefeb30108578f713c
+  data.tar.gz: d92892eacf60da34285bbd988c98a070b961a6f7e77905e536c84e00622e0042f474ed77c1dd98a72d38eafa3d3302fc03cb11bf1cc814720d71044bd6b99240

data/.github/workflows/rake.yml

@@ -0,0 +1,36 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    name: Test on Ruby ${{ matrix.ruby }} ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    continue-on-error: ${{ matrix.experimental }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '3.0', '2.7', '2.6', '2.5' ]
+        os: [ ubuntu-latest, windows-latest, macos-latest ]
+        experimental: [ false ]
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          submodules: true
+
+      # https://github.com/ruby-debug/debase/issues/89#issuecomment-686827382
+      - if: matrix.os == 'macos-latest' && matrix.ruby == '2.5'
+        run: echo BUNDLE_BUILD__DEBASE="--with-cflags=\"-Wno-error=implicit-function-declaration\"" >> $GITHUB_ENV
+
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - run: bundle exec rake

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.rubocop-https---raw-githubusercontent-com-riboseinc-oss-guides-master-ci-rubocop-yml
+Gemfile.lock
+.vscode/

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,12 @@
+# This project follows the Ribose OSS style guide.
+# https://github.com/riboseinc/oss-guides
+# All project-specific additions and overrides should be specified in this file.
+
+require: rubocop-rails
+
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+AllCops:
+  TargetRubyVersion: 2.5
+Rails:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in relaton_oasis.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Andrei Kislichenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.adoc

@@ -0,0 +1,225 @@
+= RelatonBipm: 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"]
+image:https://github.com/relaton/relaton-oasis/workflows/windows/badge.svg["Build Status (Windows)", link="https://github.com/relaton/relaton-oasis/actions?workflow=windows"]
+image:https://github.com/relaton/relaton-oasis/workflows/ubuntu/badge.svg["Build Status (Ubuntu)", link="https://github.com/relaton/relaton-oasis/actions?workflow=ubuntu"]
+image:https://codeclimate.com/github/relaton/relaton-oasis/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/relaton/relaton-oasis"]
+image:https://img.shields.io/github/issues-pr-raw/relaton/relaton-oasis.svg["Pull Requests", link="https://github.com/relaton/relaton-oasis/pulls"]
+image:https://img.shields.io/github/commits-since/relaton/relaton-oasis/latest.svg["Commits since latest",link="https://github.com/relaton/relaton-oasis/releases"]
+
+RelatonOasis is a Ruby gem that implements the https://github.com/metanorma/metanorma-model-iso#iso-bibliographic-item[IsoBibliographicItem model].
+
+You can use it to retrieve metadata of OASIS Standards from https://www.oasis-open.org/standards/ and access such metadata through the `OasisBibliographicItem` object.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'relaton-oasis'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install relaton-oasis
+
+== Usage
+
+=== Get standard using reference.
+
+All the OASIS documents are parsed from https://www.oasis-open.org/standards/ and stored into a GitHub repository https://github.com/relaton/relaton-data-oasis. You can find all possible refereces in the repository.
+
+[source,ruby]
+----
+require 'relaton-oasis'
+=> true
+
+item = RelatonOasis::OasisBibliography.get "OASIS amqp-core"
+[relaton-oasis] (OASIS amqp-core fetching...
+[relaton-oasis] (OASIS amqp-core) found OASIS amqp-core
+=> #<RelatonOasis::OasisBibliographicItem:0x00007fceea1aecb0
+...
+----
+
+=== XML serialization
+
+[source,ruby]
+----
+item.to_xml
+=> "<bibitem id="OASISamqp-core" type="standard">
+      <fetched>2022-03-17</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>
+      <docnumber>amqp-core</docnumber>
+      <date type="issued">
+        <on>2012-10-30</on>
+      </date>
+      <language>en</language>
+      <script>Latn</script>
+      <abstract format="text/plain" language="en" script="Latn">An open internet protocol for business messaging.</abstract>
+      <relation type="hasPart">
+        <bibitem>
+          <formattedref format="text/plain">OASIS amqp-core-overview-v1.0-Pt0</formattedref>
+        </bibitem>
+      </relation>
+      <relation type="hasPart">
+        <bibitem>
+          <formattedref format="text/plain">OASIS amqp-core-types-v1.0-Pt1</formattedref>
+        </bibitem>
+      </relation>
+      <relation type="hasPart">
+        <bibitem>
+          <formattedref format="text/plain">OASIS amqp-core-transport-v1.0-Pt2</formattedref>
+        </bibitem>
+      </relation>
+      <relation type="hasPart">
+        <bibitem>
+          <formattedref format="text/plain">OASIS amqp-core-messaging-v1.0-Pt3</formattedref>
+        </bibitem>
+      </relation>
+      <relation type="hasPart">
+        <bibitem>
+          <formattedref format="text/plain">OASIS amqp-core-transactions-v1.0-Pt4</formattedref>
+        </bibitem>
+      </relation>
+      <relation type="hasPart">
+        <bibitem>
+          <formattedref format="text/plain">OASIS amqp-core-security-v1.0-Pt5</formattedref>
+        </bibitem>
+      </relation>
+    </bibitem>"
+----
+
+With argument `bibdata: true` it ouputs XML wrapped by `bibdata` element and adds flavour `ext` element.
+
+[source,ruby]
+----
+item.to_xml bibdata: true
+=> "<bibdata type="standard">
+      <fetched>2022-03-17</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>
+      <docnumber>amqp-core</docnumber>
+      <date type="issued">
+        <on>2012-10-30</on>
+      </date>
+      <language>en</language>
+      <script>Latn</script>
+      <abstract format="text/plain" language="en" script="Latn">An open internet protocol for business messaging.</abstract>
+      <relation type="hasPart">
+        <bibitem>
+          <formattedref format="text/plain">OASIS amqp-core-overview-v1.0-Pt0</formattedref>
+        </bibitem>
+      </relation>
+      <relation type="hasPart">
+        <bibitem>
+          <formattedref format="text/plain">OASIS amqp-core-types-v1.0-Pt1</formattedref>
+        </bibitem>
+      </relation>
+      <relation type="hasPart">
+        <bibitem>
+          <formattedref format="text/plain">OASIS amqp-core-transport-v1.0-Pt2</formattedref>
+        </bibitem>
+      </relation>
+      <relation type="hasPart">
+        <bibitem>
+          <formattedref format="text/plain">OASIS amqp-core-messaging-v1.0-Pt3</formattedref>
+        </bibitem>
+      </relation>
+      <relation type="hasPart">
+        <bibitem>
+          <formattedref format="text/plain">OASIS amqp-core-transactions-v1.0-Pt4</formattedref>
+        </bibitem>
+      </relation>
+      <relation type="hasPart">
+        <bibitem>
+          <formattedref format="text/plain">OASIS amqp-core-security-v1.0-Pt5</formattedref>
+        </bibitem>
+      </relation>
+      <ext>
+        <doctype>standard</doctype>
+        <editorialgroup>
+          <technical-committee>OASIS Advanced Message Queuing Protocol (AMQP) TC</technical-committee>
+        </editorialgroup>
+        <technology-area>Messaging</technology-area>
+      </ext>
+    </bibdata>"
+----
+
+=== Typed links
+
+Some OASIS documents have `src` type link.
+
+[source,ruby]
+----
+item = RelatonOasis::OasisBibliography.get "OASIS amqp-core-types-v1.0-Pt1"
+[relaton-oasis] (OASIS amqp-core-types-v1.0-Pt1 fetching...
+[relaton-oasis] (OASIS amqp-core-types-v1.0-Pt1) found OASIS amqp-core-types-v1.0-Pt1
+=> #<RelatonOasis::OasisBibliographicItem:0x00007fceda0c5e08
+...
+
+item.link
+=> [#<RelatonBib::TypedUri:0x00007fceda0bf990
+  @content=#<Addressable::URI:0xbe00 URI:http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-types-v1.0-os.html>,
+  @type="src">]
+----
+
+=== Create bibliographic item from XML
+
+[source,ruby]
+----
+RelatonOasis::XMLParser.from_xml File.read("spec/fixtures/oasis_bibdata.xml")
+=> #<RelatonOasis::OasisBibliographicItem:0x00007f88ab9d1d78
+...
+----
+
+=== Create bibliographic item from YAML
+[source,ruby]
+----
+hash = YAML.load_file "spec/fixtures/oasis_bibdata.yaml"
+=> {"id"=>"OASISamqp-core",
+...
+
+RelatonOasis::OasisBibliographicItem.from_hash hash
+=> #<RelatonOasis::OasisBibliographicItem:0x00007fceea0b6628
+...
+----
+
+=== Fetch data
+
+The OASIS documents can be fetched from https://www.oasis-open.org/standards/ and converted into RelatonXML/BibXML/BibYAML formats:
+
+The method `RelatonOasis::DataFetcher.fetch(output: "data", format: "yaml")` fethces and converts all the documents from the https://www.oasis-open.org/standards/ and save them to the `./data` folder in YAML format.
+
+Arguments:
+
+- `output` - folder to save documents (default './data').
+- `format` - format in which the documents are saved. Possimle formats are: `yaml`, `xml`, `bibxml` (default `yaml`).
+
+[source,ruby]
+----
+RelatonOasis::DataFetcher.fetch
+Started at: 2022-03-18 18:34:06 +0100
+Stopped at: 2022-03-18 18:34:12 +0100
+Done in: 5 sec.
+=> nil
+----
+
+== 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/relaton/relaton-oasis.
+
+== License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "relaton_oasis"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rspec

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here