relaton-oasis 1.20.0 → 2.0.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e74c293597d3b10f3434807b8a150846ef37de5946df81bf0cd4fd4505876925
-  data.tar.gz: 780ac30d91ca5a34b40ec91da8c92f0f65b93a593c4737fa85f5a94a4c80f7b3
+  metadata.gz: 9617d28b6700da9cc85d247956e91ee888bf37609b6de1ca796f54fdf41b78a4
+  data.tar.gz: b1eb7089e7a5843b7a17a166936812c4ba5c2fc258d1191522ffbcfbab2d43ce
 SHA512:
-  metadata.gz: 8864c2d988ab8236cd948816a1048bcb50b325b75551b25719c233621e0fa5aa472b18f726b0865fd8645d9d19ee4d9aa76a1c660c810daaed9b32c3ba11e012
-  data.tar.gz: e56f5948245ad158f6b39e8bcd99a84171ca3b4f60fc98b2fabaf8c318c30bbfbdfdf2b9967bfaedfc93276c9bdf597838b5753e8baae8d4296b0e350ded5392
+  metadata.gz: 10a9463219ef29826ca68b2df9a080c2bd83cd9fc65757e427ccd490069e799d3543e390cebba00fa6a0b67db95224870fd4ef0f63035969b1a54abaa9a077b5
+  data.tar.gz: 7dc39c8a6aff319a422c84b2ba4b5ec2c37044dfd27807fc1d97e3b2627822f8364be5e1c75728ce3e50465a893740d6bc90b449e1b8dad095e377e5fb3e75fb

data/.gitignore

@@ -13,3 +13,4 @@
 .rubocop-https---raw-githubusercontent-com-riboseinc-oss-guides-master-ci-rubocop-yml
 Gemfile.lock
 .vscode/
+.claude/

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.7
+  TargetRubyVersion: 3.2
 Rails:
   Enabled: false

data/CLAUDE.md

@@ -0,0 +1,55 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+relaton-oasis is a Ruby gem for retrieving and serializing OASIS Standards bibliographic metadata. It is part of the Relaton family of gems and implements the IsoBibliographicItem model for OASIS standards. Uses the lutaml-model pattern on the `lutaml-integration` branch.
+
+## Commands
+
+```bash
+bundle exec rake spec       # Run all tests (default rake task)
+bundle exec rake rubocop    # Run linter
+bundle exec rspec           # Run tests directly
+bundle exec rspec spec/relaton/oasis/bibitem_spec.rb  # Run a single test file
+bin/console                 # Interactive IRB with gem loaded
+```
+
+## Architecture
+
+### Class Hierarchy (under `Relaton::Oasis`)
+
+All model classes use the lutaml-model pattern from `relaton-bib`:
+
+- **ItemData** (`lib/relaton/oasis/item_data.rb`) — Data model class extending `Bib::ItemData`
+- **Item** (`lib/relaton/oasis/item.rb`) — Base class extending `Bib::Item`, uses `ItemData` model, adds `ext` attribute of type `Ext`
+- **Bibitem** (`lib/relaton/oasis/bibitem.rb`) — Extends `Item`, includes `Bib::BibitemShared` for individual bibliography entries
+- **Bibdata** (`lib/relaton/oasis/bibdata.rb`) — Extends `Item`, includes `Bib::BibdataShared` for complete bibliography records
+- **Ext** (`lib/relaton/oasis/ext.rb`) — Extends `Bib::Ext`, OASIS-specific metadata: `doctype`, `technology_area`, `schema_version`
+- **Doctype** (`lib/relaton/oasis/doctype.rb`) — Extends `Bib::Doctype`, valid values: `specification`, `memorandum`, `resolution`, `standard`
+
+### Bibliography (under `Relaton::Oasis`)
+
+- **Bibliography** (`lib/relaton/oasis/bibliography.rb`) — Module with `search`/`get` class methods for fetching OASIS standards from the relaton-data-oasis GitHub repository. Delegates to private methods: `find_index_entry`, `fetch_yaml`, `parse_item`
+
+### Data Fetching (under `Relaton::Oasis`)
+
+These classes scrape https://www.oasis-open.org/standards/ to produce YAML/XML data files. Loaded separately via `require "relaton/oasis/data_fetcher"`.
+
+- **DataFetcher** (`lib/relaton/oasis/data_fetcher.rb`) — Extends `Core::DataFetcher`, orchestrates fetching all OASIS standards
+- **DataParser** (`lib/relaton/oasis/data_parser.rb`) — Parses individual OASIS document nodes into `ItemData`
+- **DataPartParser** (`lib/relaton/oasis/data_part_parser.rb`) — Parses multi-part OASIS document nodes into `ItemData`
+- **DataParserUtils** (`lib/relaton/oasis/data_parser_utils.rb`) — Shared module included by both parsers; provides contributor parsing, docid construction, retry logic, and doctype detection
+
+### Serialization
+
+Supports XML (with RELAX NG schema validation via `grammars/`) and YAML round-trip serialization. Classes use `from_xml`/`to_xml` and `from_yaml`/`to_yaml` class methods inherited from the lutaml-model base.
+
+### Test Conventions
+
+Tests are round-trip based: parse a fixture file, serialize back, and compare output to input. XML tests also validate against the RELAX NG schema (`grammars/relaton-oasis-compile.rng`) using the `ruby-jing` gem. Fixtures live in `spec/fixtures/`. VCR cassettes record HTTP interactions in `spec/vcr_cassettes/`. Private methods are tested via `send(:method_name, ...)`.
+
+## Style
+
+RuboCop config inherits from the Ribose OSS style guide. Target Ruby version: 3.4. Rails cops are required but disabled.

data/README.adoc

@@ -1,4 +1,4 @@
-= RelatonOasis: retrieve OASIS Standards for bibliographic use using the BibliographicItem model
+= Relaton::Oasis: 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"]
@@ -10,7 +10,7 @@ image:https://img.shields.io/github/commits-since/relaton/relaton-oasis/latest.s
 
 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.
+You can use it to retrieve metadata of OASIS Standards from https://www.oasis-open.org/standards/ and access such metadata through the `Relaton::Oasis::ItemData` object.
 
 == Installation
 
@@ -36,13 +36,13 @@ All the OASIS documents are parsed from https://www.oasis-open.org/standards/ an
 
 [source,ruby]
 ----
-require 'relaton_oasis'
+require 'relaton/oasis'
 => true
 
-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`
-=> #<RelatonOasis::OasisBibliographicItem:0x00007fceea1aecb0
+item = Relaton::Oasis::Bibliography.get "OASIS amqp-core"
+[relaton-oasis] INFO: (OASIS amqp-core) Fetching from Relaton repository ...
+[relaton-oasis] INFO: (OASIS amqp-core) Found: `OASIS amqp-core`
+=> #<Relaton::Oasis::ItemData:0x0000000120db0fa8
 ...
 ----
 
@@ -51,29 +51,27 @@ item = RelatonOasis::OasisBibliography.get "OASIS amqp-core"
 [source,ruby]
 ----
 item.to_xml
-=> "<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>
+=> "<bibitem id="OASISamqpcore" type="standard" schema-version="v1.4.1">
+      <fetched>2026-02-27</fetched>
+      <title language="en" script="Latn" type="main">Advanced Message Queueing Protocol (AMQP) v1.0</title>
       <docidentifier type="OASIS" primary="true">OASIS amqp-core</docidentifier>
       ...
     </bibitem>"
 ----
 
-With argument `bibdata: true` it ouputs XML wrapped by `bibdata` element and adds flavour `ext` element.
+With argument `bibdata: true` it outputs XML wrapped by `bibdata` element and adds flavour `ext` element.
 
 [source,ruby]
 ----
 item.to_xml bibdata: true
-=> "<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>
+=> "<bibdata type="standard" schema-version="v1.4.1">
+      <fetched>2026-02-27</fetched>
+      <title language="en" script="Latn" type="main">Advanced Message Queueing Protocol (AMQP) v1.0</title>
       <docidentifier type="OASIS" primary="true">OASIS amqp-core</docidentifier>
       ...
       <ext schema-version="v1.0.1">
         <doctype>standard</doctype>
-        <editorialgroup>
-          <technical-committee>OASIS Advanced Message Queuing Protocol (AMQP) TC</technical-committee>
-        </editorialgroup>
+        <flavor>oasis</flavor>
         <technology-area>Messaging</technology-area>
       </ext>
     </bibdata>"
@@ -81,41 +79,37 @@ item.to_xml bibdata: true
 
 === Typed links
 
-Some OASIS documents have `src` type link.
+Some OASIS documents have `src` type source link.
 
 [source,ruby]
 ----
-item = RelatonOasis::OasisBibliography.get "OASIS amqp-core-types-v1.0-Pt1"
-[relaton-oasis] (OASIS amqp-core-types-v1.0-Pt1) Fetching from Relaton repository ...
-[relaton-oasis] (OASIS amqp-core-types-v1.0-Pt1) Found: `OASIS amqp-core-types-v1.0-Pt1`
-=> #<RelatonOasis::OasisBibliographicItem:0x00007fceda0c5e08
+item = Relaton::Oasis::Bibliography.get "OASIS amqp-core-types-v1.0-Pt1"
+[relaton-oasis] INFO: (OASIS amqp-core-types-v1.0-Pt1) Fetching from Relaton repository ...
+[relaton-oasis] INFO: (OASIS amqp-core-types-v1.0-Pt1) Found: `OASIS amqp-core-types-v1.0-Pt1`
+=> #<Relaton::Oasis::ItemData:0x0000000123ff12d8
 ...
 
-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">]
+item.source[0].type
+=> "src"
+
+item.source[0].content
+=> "http://docs.oasis-open.org/amqp/core/v1.0/os/amqp-core-types-v1.0-os.html"
 ----
 
 === Create bibliographic item from XML
 
 [source,ruby]
 ----
-RelatonOasis::XMLParser.from_xml File.read("spec/fixtures/oasis_bibdata.xml")
-=> #<RelatonOasis::OasisBibliographicItem:0x00007f88ab9d1d78
+Relaton::Oasis::Item.from_xml File.read("spec/fixtures/oasis_bibdata.xml")
+=> #<Relaton::Oasis::ItemData:0x0000000123ffeb18
 ...
 ----
 
 === Create bibliographic item from YAML
 [source,ruby]
 ----
-hash = YAML.load_file "spec/fixtures/oasis_bibdata.yaml"
-=> {"schema-version"=>"v1.2.9",
- "id"=>"OASISamqp-core",
-...
-
-RelatonOasis::OasisBibliographicItem.from_hash hash
-=> #<RelatonOasis::OasisBibliographicItem:0x00007fceea0b6628
+Relaton::Oasis::Item.from_yaml File.read("spec/fixtures/item.yaml")
+=> #<Relaton::Oasis::ItemData:0x000000012119a290
 ...
 ----
 
@@ -123,7 +117,7 @@ RelatonOasis::OasisBibliographicItem.from_hash hash
 
 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")` fetches and converts all the documents from the https://www.oasis-open.org/standards/ and save them to the `./data` folder in YAML format.
+The method `Relaton::Oasis::DataFetcher.fetch(output: "data", format: "yaml")` fetches and converts all the documents from the https://www.oasis-open.org/standards/ and saves them to the `./data` folder in YAML format.
 
 Arguments:
 
@@ -132,7 +126,9 @@ Arguments:
 
 [source,ruby]
 ----
-RelatonOasis::DataFetcher.fetch
+require "relaton/oasis/data_fetcher"
+
+Relaton::Oasis::DataFetcher.fetch
 Started at: 2022-03-18 18:34:06 +0100
 Stopped at: 2022-03-18 18:34:12 +0100
 Done in: 5 sec.