relaton-ogc 1.20.1 → 2.0.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c5ff2e52f74939f5dd715e54318cc0f7beab1880965868c23b5e43514b62fd4
-  data.tar.gz: 5a190d493b779ae6d0e7fc1ff2e8529ed210901b5006d90db9470f6d26e87626
+  metadata.gz: 63e344f79293ac705bbb72bf724eda7a55394b4f805808dcd897cf4dea55c97d
+  data.tar.gz: ca67124e73e4958c7739cee3f007e2ab3c8a85ac87dfb217879995dbabc641e3
 SHA512:
-  metadata.gz: '069d2ea46db6d46a067f7949078b7bc1b670f1ab7de046e3ef862c3f17ba60a004a0d60f18266d05ca635f5a34954e415bfa1206e44d7a900d9720279e819580'
-  data.tar.gz: 74726f295ce90b5590f1fb79173d79aa4ff245fb60e39b61e1582bc2aaf50984e95ea58edcd0424dc09fcb5da7e84272a3c77256094b34778067eadce5077513
+  metadata.gz: efc3d0ec325d196285c6b781985b299b049d3a7f47316df903316a4bbf54d6e2423ae43d114c001c985e119cf1df2fe6def0394a4f1de7f37b6aa8c1901074f5
+  data.tar.gz: e3621f69f96df3638a4d1f0b924e9c690e3ebd2526b090f9d169d028678fe23ee3ed01e7db0b478609d91b72c8efbe24d1f7b04a9d295c8c8a5e3d633492bdab

data/.gitignore

@@ -13,3 +13,4 @@
 .rspec_status
 .rubocop-https---raw-githubusercontent-com-riboseinc-oss-guides-master-ci-rubocop-yml
 Gemfile.lock
+.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,108 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+relaton-ogc is a Ruby gem for retrieving and managing OGC (Open Geospatial Consortium) Standards metadata. It is part of the Relaton ecosystem for bibliographic data management. The gem implements the OGC flavor on top of `relaton-iso`, which itself builds on `relaton-bib`.
+
+## Commands
+
+```bash
+# Install dependencies
+bundle install
+
+# Run all tests
+bundle exec rspec
+
+# Run a single test file
+bundle exec rspec spec/relaton/ogc/item_spec.rb
+
+# Run a single test by line number
+bundle exec rspec spec/relaton/ogc/item_spec.rb:7
+
+# Lint
+bundle exec rubocop
+
+# Lint with auto-correct
+bundle exec rubocop -A
+
+# Interactive console
+bin/console
+
+# Build and install gem locally
+bundle exec rake install
+```
+
+## Architecture
+
+### Class Hierarchy
+
+All model classes use `Lutaml::Model::Serializable` for XML/YAML serialization with declarative attribute and mapping definitions.
+
+```
+Iso::Item (from relaton-iso)
+└── Relaton::Ogc::Item          # serializer, extends Iso::Item with `ext` and `docidentifier`
+    ├── Relaton::Ogc::Bibitem   # includes Bib::BibitemShared
+    └── Relaton::Ogc::Bibdata   # includes Bib::BibdataShared
+
+Bib::ItemData (from relaton-bib)
+└── Relaton::Ogc::ItemData      # data model returned by Item.from_xml / Item.from_yaml
+```
+
+- **Item** (`lib/relaton/ogc/item.rb`) — serializer; extends `Iso::Item`, declares `model ItemData`, adds `ext` (Ext) and `docidentifier` (Docidentifier) attributes
+- **ItemData** (`lib/relaton/ogc/item_data.rb`) — plain data model extending `Bib::ItemData`
+- **Ext** (`lib/relaton/ogc/ext.rb`) — OGC extension data: doctype, subdoctype (with constrained values)
+- **Doctype** (`lib/relaton/ogc/doctype.rb`) — enumerated OGC document types (standard, engineering-report, best-practice, etc.)
+- **Docidentifier** (`lib/relaton/ogc/docidentifier.rb`) — extends `Bib::Docidentifier`
+- **Bibitem** / **Bibdata** — thin wrappers mixing in shared serialization behavior from `relaton-bib`
+
+### Search & Fetch Pipeline
+
+- **Bibliography** (`lib/relaton/ogc/bibliography.rb`) — entry point: `search(text)` and `get(code, year, opts)`
+- **HitCollection** (`lib/relaton/ogc/hit_collection.rb`) — fetches from `relaton-data-ogc` GitHub repo (data-v2 branch), uses `relaton-index` for lookup
+- **Hit** (`lib/relaton/ogc/hit.rb`) — wraps a single search result; lazy-fetches `ItemData` on `#item`
+- **Processor** (`lib/relaton/ogc/processor.rb`) — `Core::Processor` implementation for Relaton registry integration
+
+### Data Fetching
+
+- **DataFetcher** (`lib/relaton/ogc/data_fetcher.rb`) — bulk-fetches OGC documents from the NamingAuthority JSON endpoint
+- **Scraper** (`lib/relaton/ogc/scraper.rb`) — parses individual OGC document JSON into `ItemData`
+
+### Key Dependencies
+
+- `relaton-iso` — provides `Iso::Item` base class and ISO bibliographic structures
+- `relaton-bib` (transitive via relaton-iso) — core types: `Bib::ItemData`, `Bib::Doctype`, `Bib::Ext`, etc.
+- `lutaml-model` (transitive) — serialization framework for XML/YAML mapping
+- `faraday` — HTTP client for fetching remote data
+- `relaton-index` — index-based document lookup from GitHub-hosted data repos
+
+### Serialization Pattern
+
+Models declare attributes and XML mappings in the same class. `Item` is the serializer (handles `from_xml`, `from_yaml`, `to_xml`), `ItemData` is the plain data object returned. Round-trip fidelity (parse → serialize → parse) is the primary correctness criterion tested in specs.
+
+### Test Setup
+
+- **RSpec** with `--format documentation`
+- **VCR** + **WebMock** for HTTP interaction recording (`spec/vcr_cassettes/`)
+- **Jing** for RelaxNG schema validation against `grammars/relaton-ogc-compile.rng`
+- **equivalent-xml** for XML comparison in tests
+- Fixtures live in `spec/fixtures/` (YAML, XML)
+- Integration tests in `spec/relaton/ogc/integration_spec.rb` exercise the full search → fetch → serialize pipeline
+
+### Grammars
+
+RelaxNG schemas in `grammars/` define the valid XML structure. `relaton-ogc-compile.rng` is the combined schema used for test validation.
+
+### API Notes
+
+- `Bib::Docidentifier` uses `.content` (not `.id`) for the identifier string
+- `Bib::Date` uses `.at` returning a `StringDate::Value`; parse with `::Date.parse(d.at.to_s)` to extract year
+
+## Linting
+
+RuboCop inherits from the [Ribose OSS style guide](https://github.com/riboseinc/oss-guides). Target Ruby version is 3.1. Rails cops are loaded but disabled.
+
+## CI
+
+GitHub Actions workflows in `.github/workflows/` are auto-generated by Cimas — avoid manual edits. `rake.yml` runs tests on push/PR; `release.yml` handles gem publishing.

data/README.adoc

@@ -1,4 +1,4 @@
-= RelatonOgc
+= Relaton::Ogc
 
 image:https://img.shields.io/gem/v/relaton-ogc.svg["Gem Version", link="https://rubygems.org/gems/relaton-ogc"]
 image:https://github.com/relaton/relaton-ogc/workflows/macos/badge.svg["Build Status (macOS)", link="https://github.com/relaton/relaton-ogc/actions?workflow=macos"]
@@ -8,9 +8,9 @@ image:https://codeclimate.com/github/relaton/relaton-ogc/badges/gpa.svg["Code Cl
 image:https://img.shields.io/github/issues-pr-raw/relaton/relaton-ogc.svg["Pull Requests", link="https://github.com/relaton/relaton-ogc/pulls"]
 image:https://img.shields.io/github/commits-since/relaton/relaton-ogc/latest.svg["Commits since latest",link="https://github.com/relaton/relaton-ogc/releases"]
 
-RelatonOgc is a Ruby gem that implements the https://github.com/metanorma/metanorma-model-iso#iso-bibliographic-item[IsoBibliographicItem model].
+Relaton::Ogc 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 OGC Standards from https://raw.githubusercontent.com/opengeospatial/NamingAuthority/master/incubation/bibliography/bibliography.json, and access such metadata through the `OgcBibliographicItem` object.
+You can use it to retrieve metadata of OGC Standards from the https://github.com/relaton/relaton-data-ogc[relaton-data-ogc] dataset, and access such metadata through the `Relaton::Ogc::ItemData` object.
 
 == Installation
 
@@ -35,14 +35,14 @@ Or install it yourself as:
 
 [source,ruby]
 ----
-require 'relaton_ogc'
+require 'relaton/ogc'
 => true
 
-hits = RelatonOgc::OgcBibliography.search("OGC 19-025r1")
-=> <RelatonOgc::HitCollection:0x007fcc8e085ba8 @ref=OGC 19-025r1 @fetched=true>
+hits = Relaton::Ogc::Bibliography.search("OGC 19-025r1")
+=> <Relaton::Ogc::HitCollection:0x00000000001230 @ref=19-025r1 @fetched=false>
 
-item = hits[0].fetch
-=> #<RelatonOgc::OgcBibliographicItem:0x007fcab3cb4758
+item = hits[0].item
+=> #<Relaton::Ogc::ItemData:0x0000000127b1d870
 ...
 ----
 
@@ -50,11 +50,12 @@ item = hits[0].fetch
 [source,ruby]
 ----
 item.to_xml
-=> "<bibitem id="19-025r1" type="standard" schema-version="v1.2.1">
-      <fetched>2022-12-04</fetched>
-      <title type="title-main" format="text/plain" language="en" script="Latn">Development of Spatial Data Infrastructures for Marine Data Management</title>
-      <title type="main" format="text/plain" language="en" script="Latn">Development of Spatial Data Infrastructures for Marine Data Management</title>
-      <uri type="obp">https://portal.ogc.org/files/?artifact_id=88037</uri>
+=> "<bibitem id="19025r1" type="standard" schema-version="v1.4.1">
+      <fetched>2026-02-27</fetched>
+      <title language="en" script="Latn" type="title-main">Development of Spatial Data Infrastructures for Marine Data Management</title>
+      <title language="en" script="Latn" type="main">Development of Spatial Data Infrastructures for Marine Data Management</title>
+      <uri type="src">http://www.opengis.net/doc/per/marine-sdi</uri>
+      <uri type="pdf">https://portal.ogc.org/files/?artifact_id=88037</uri>
       <docidentifier type="OGC" primary="true">19-025r1</docidentifier>
       ...
     </bibitem>"
@@ -63,18 +64,17 @@ With argument `bibdata: true` it outputs XML wrapped by `bibdata` element and ad
 [source,ruby]
 ----
 item.to_xml bibdata: true
-=> "<bibdata type="standard" schema-version="v1.2.1">
-      <fetched>2022-12-04</fetched>
-      <title type="title-main" format="text/plain" language="en" script="Latn">Development of Spatial Data Infrastructures for Marine Data Management</title>
-      <title type="main" format="text/plain" language="en" script="Latn">Development of Spatial Data Infrastructures for Marine Data Management</title>
-      <uri type="obp">https://portal.ogc.org/files/?artifact_id=88037</uri>
+=> "<bibdata type="standard" schema-version="v1.4.1">
+      <fetched>2026-02-27</fetched>
+      <title language="en" script="Latn" type="title-main">Development of Spatial Data Infrastructures for Marine Data Management</title>
+      <title language="en" script="Latn" type="main">Development of Spatial Data Infrastructures for Marine Data Management</title>
+      <uri type="src">http://www.opengis.net/doc/per/marine-sdi</uri>
+      <uri type="pdf">https://portal.ogc.org/files/?artifact_id=88037</uri>
       <docidentifier type="OGC" primary="true">19-025r1</docidentifier>
       ...
       <ext schema-version="v1.0.1">
         <doctype>engineering-report</doctype>
-        <editorialgroup>
-          <committee>technical</committee>
-        </editorialgroup>
+        <flavor>ogc</flavor>
       </ext>
     </bibdata>"
 ----
@@ -82,76 +82,76 @@ item.to_xml bibdata: true
 === Get code, and year
 [source,ruby]
 ----
-RelatonOgc::OgcBibliography.get "OGC 19-025r1", "2019", {}
-[relaton-ogc] (OGC 19-025r1) Fetching from Relaton repository ...
-[relaton-ogc] (OGC 19-025r1) Found: `19-025r1`
-=> #<RelatonOgc::OgcBibliographicItem:0x007fc322e9aba0
+Relaton::Ogc::Bibliography.get "OGC 19-025r1", "2019"
+[relaton-ogc] INFO: (OGC 19-025r1) Fetching from Relaton repository ...
+[relaton-ogc] INFO: (OGC 19-025r1) Found: `19-025r1`
+=> #<Relaton::Ogc::ItemData:0x00000001283d6f48
 ...
 ----
 
 === Create bibliographic item from XML
 [source,ruby]
 ----
-RelatonOgc::XMLParser.from_xml File.read('spec/fixtures/12_128r14.xml')
-=> #<RelatonOgc::OgcBibliographicItem:0x00007fd2b1078718
+Relaton::Ogc::Item.from_xml File.read('spec/fixtures/12_128r14.xml')
+=> #<Relaton::Ogc::ItemData:0x000000012835e610
 ...
 ----
 
 === Typed links
 
-Each OGC document has `obp` type link.
+Each OGC document has `scr` type source link.
 
 [source,ruby]
 ----
-item.link
-=> [#<RelatonBib::TypedUri:0x00007fc848994568 @content=#<Addressable::URI:0x8e8 URI:https://portal.ogc.org/files/?artifact_id=88037>, @type="obp">]
+item.source[0].type
+=> "obp"
+
+item.source[0].content
+=> "http://www.opengis.net/doc/per/marine-sdi"
 ----
 
 === Create bibliographic item from YAML
 [source,ruby]
 ----
-hash = YAML.load_file 'spec/fixtures/ogc_bib_item.yml'
-=> {"id"=>"19-025r1",
-...
-
-RelatonOgc::OgcBibliographicItem.from_hash hash
-=> #<RelatonOgc::OgcBibliographicItem:0x007fc322ef8548
+Relaton::Ogc::Item.from_yaml File.read('spec/fixtures/item.yaml')
+=> #<Relaton::Ogc::ItemData:0x0000000124b19d90
 ...
 ----
 
 === Fetch data
 
-This gem uses the https://raw.githubusercontent.com/opengeospatial/NamingAuthority/master/incubation/bibliography/bibliography.json dataset as a data source.
+This gem uses the https://raw.githubusercontent.com/opengeospatial/NamingAuthority/master/definitions/docs/docs.json[OGC NamingAuthority] dataset as a data source.
 
-The method `RelatonOgc::DataFetcher.fetch(output: "data", format: "yaml")` fetches all the documents from the dataset and saves them to the `./data` folder in YAML format.
+The method `Relaton::Ogc::DataFetcher.fetch(output: "data", format: "yaml")` fetches all the documents from the dataset and saves them to the `./data` folder in YAML format.
 Arguments:
 
 - `output` - folder to save documents (default './data').
-- `format` - the format in which the documents are saved. Possible formats are: `yaml`, `xml` (default `yaml`).
+- `format` - the format in which the documents are saved. Possible formats are: `yaml`, `xml`, `bibxml` (default `yaml`).
 
 [source,ruby]
 ----
-RelatonOgc::DataFetcher.fetch
-Started at: 2021-09-14 11:21:46 +0200
-[relaton-ogc] WARNING Duplicated documents: 15-113r5, 08-094r1, 10-025r1, 12-128r14, 16-079, 16-007r3, 13-026r8, 12-128r12, 15-078r6, 12-176r7, 09-102r3, 14-095, 14-115, 07-147r2, 12-000, 12-006, 09-025r1, 07-036, 07-110r4, 03-105r1, 06-042, 07-165r1, 12-066, 06-104r4, 11-122r1, 09-000, 04-094, 07-006r1, 06-035r1, 03-006r3, 05-134, 04-021r3, 02-058, 01-009
-Stopped at: 2021-09-14 11:21:48 +0200
+require "relaton/ogc/data_fetcher"
+
+Relaton::Ogc::DataFetcher.fetch
+Started at: 2026-02-27 11:21:46 +0200
+Stopped at: 2026-02-27 11:21:48 +0200
 => nil
 ----
 
 === Logging
 
-RelatonOgc 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.
+Relaton::Ogc 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec` 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 tags, 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/calconnenct/relaton_ogc.
+Bug reports and pull requests are welcome on GitHub at https://github.com/relaton/relaton-ogc.
 
 == License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the https://opensource.org/licenses/MIT[MIT License].