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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b14e8a50bb7cffacc0240b4c6dc5ecba37030f732865d55feebc6da373e62de
-  data.tar.gz: fdd4c0909501f41468c107d4a878b0eb773387e15122cf7a50400de9c503e2be
+  metadata.gz: 8ef4c54fb9becdcf1b67361d4f61831c38828175aa67db7446e83de513a55ca1
+  data.tar.gz: 11f36dd307d779827b6091a89e5a2e8803b1e5075f52db6b621c777cb0f762e4
 SHA512:
-  metadata.gz: 4002fdfb039cde01925f7b68fd3e12d4859c181140065d7478b49c41c8d4dce7dfee23b6969e9a87a3ac66f362352623f9f3fe389b85cad036f565070919eec3
-  data.tar.gz: c3b027ee8e2c6101dde78d99173fd19c5838128ccdce2fb126721f86a42cb701bf8142c17e82a4306b3ce852d09b2d5438321cde72d67412386619bc3ec2e059
+  metadata.gz: cee5e1b632af9b8eb2107a8782f89f37e620ed86559b2e26c18fc31e67af3d8e1344828975e2586d321c04e3a4c0e7a6dccb785299403e5d9efe3d324bddc00f
+  data.tar.gz: be174b8c2475cb2ac450f9d8a56efdfa2c2481427fb8bd7142de6003bf144989600b5cb814032072874c923d0929d9df31baa5e09d807f13abddc31f947d7da3

data/.gitignore

@@ -14,3 +14,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,72 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## What This Gem Does
+
+`relaton-ietf` fetches and parses IETF bibliographic data (RFCs, Internet-Drafts, BCPs, FYIs, STDs) into the Relaton data model. Part of the [Relaton](https://github.com/relaton) ecosystem. Currently undergoing a major refactor on `lutaml-integration` branch: namespace changed from `RelatonIetf` to `Relaton::Ietf`, models migrated to `lutaml-model`.
+
+## Commands
+
+```bash
+bundle exec rspec                                          # run all tests
+bundle exec rspec spec/relaton/ietf/bibxml_parser_spec.rb  # run single file
+bundle exec rspec spec/relaton/ietf/rfc/entry_spec.rb:19   # run single example
+bundle exec rspec -e "creates primary docid"               # run by description
+bundle exec rubocop                                        # lint
+bundle exec rake build                                     # build gem
+```
+
+## Architecture
+
+### Data Model (Lutaml::Model)
+
+All models use `Lutaml::Model::Serializable` with `attribute` declarations and `xml do ... end` blocks for serialization. The IETF classes extend base `Relaton::Bib` classes:
+
+- `Relaton::Ietf::ItemData < Bib::ItemData` — core bibliographic data
+- `Relaton::Ietf::Item < Bib::Item` — adds `ext: Ext` attribute
+- `Relaton::Ietf::Bibdata < Item` / `Bibitem < Item` — include shared serialization concerns
+- `Relaton::Ietf::Ext` — IETF extensions: `doctype`, `flavor`, `stream`, `area`, `ipr`, `pi`
+- `Relaton::Ietf::Doctype` — types: `"rfc"`, `"internet-draft"`
+
+### Namespace Resolution
+
+Converter classes use `Bib::NamespaceHelper` which resolves `namespace` by taking the first two segments of the class name. For `Relaton::Ietf::BibXMLParser::FromRfcxml`, `namespace` returns `Relaton::Ietf`, so `namespace::ItemData` → `Relaton::Ietf::ItemData`, `namespace::Ext` → `Relaton::Ietf::Ext`, etc.
+
+### Key Flows
+
+1. **Single document lookup**: `Processor#get` → `Bibliography.get(code)` → `Scraper.scrape_page` → fetches YAML from GitHub data repos (`relaton-data-rfcs`, `relaton-data-ids`, `relaton-data-rfcsubseries`) via `relaton-index`
+
+2. **Bulk data fetching**: `DataFetcher` extends `Relaton::Core::DataFetcher` with three datasets:
+   - `ietf-rfcsubseries` / `ietf-rfc-entries`: parse `rfc-index.xml` via `Rfc::Index` / `Rfc::Entry#to_item`
+   - `ietf-internet-drafts`: parse local BibXML files via `BibXMLParser.parse`
+
+3. **BibXML parsing** (`BibXMLParser` module):
+   - `parse(xml)` — parses `<reference>` elements via `FromRfcxml` converter
+   - `parse_rfc(xml)` — parses `<rfc>` root documents via `FromRfc` converter
+   - Converters inherit from `Bib::Converter::BibXml::FromRfcxml` with IETF overrides for contributor/person/org handling
+
+4. **RFC Index parsing** (`Rfc::Entry#to_item`): converts RFC editor index entries (BCP/FYI/STD/RFC) into `ItemData`, handling subseries vs full RFC entries differently
+
+### Converter Inheritance Chain
+
+```
+Bib::Converter::BibXml::FromRfcxml    # base: handles <reference> generically
+  └── Ietf::BibXMLParser::FromRfcxml  # IETF overrides: publisher, org recognition, person names
+        └── Ietf::BibXMLParser::FromRfc  # <rfc> root: uses doc_name instead of anchor, no ref-level series_info
+```
+
+`FromRfc` must override all methods that access `@reference.anchor`, `@reference.target`, `@reference.format`, or `@reference.series_info` since `Rfcxml::V3::Rfc` lacks these attributes (unlike `Rfcxml::V3::Reference`).
+
+## Testing Patterns
+
+- **VCR cassettes** in `spec/vcr_cassettes/` record HTTP interactions; tests use `vcr: "cassette_name"` metadata
+- **WebMock** disables net connections by default
+- **Fixtures** in `spec/fixtures/` — XML/YAML expected outputs; many tests auto-generate fixtures on first run (`File.write file, xml unless File.exist? file`)
+- **Schema validation** via `ruby-jing` against RNG grammars in `grammars/`
+- **Shared examples** for org/person parsing in `bibxml_parser_spec.rb` (`parse_org`, `parse_person`)
+- **`equivalent-xml`** gem used for XML comparison (`be_equivalent_to` matcher)
+
+## RuboCop
+
+Inherits from `rubose/rubocop-rubose` (Ribose OSS config). Target Ruby 3.1. Rails cops disabled.

data/README.adoc

@@ -1,4 +1,4 @@
-= RelatonIetf
+= Relaton::Ietf
 
 image:https://img.shields.io/gem/v/relaton-ietf.svg["Gem Version", link="https://rubygems.org/gems/relaton-ietf"]
 image:https://github.com/relaton/relaton-ietf/workflows/macos/badge.svg["Build Status (macOS)", link="https://github.com/relaton/relaton-ietf/actions?workflow=macos"]
@@ -10,7 +10,7 @@ image:https://img.shields.io/github/commits-since/relaton/relaton-ietf/latest.sv
 
 _Formerly known as_ `rfcbib`.
 
-RelatonIetf is a Ruby gem that searches and fetches standards from the https://www.ietf.org[Internet Engineering Task Force (IETF)], including RFCs.
+Relaton::Ietf is a Ruby gem that searches and fetches standards from the https://www.ietf.org[Internet Engineering Task Force (IETF)], including RFCs.
 
 The standards scrape form https://www.rfc-editor.org/search/rfc_search.php
 
@@ -37,27 +37,27 @@ Or install it yourself as:
 
 [source,ruby]
 ----
-require 'relaton_ietf'
+require 'relaton/ietf'
 => true
 
 # Fetch RFC document
-item = RelatonIetf::IetfBibliography.get 'IETF RFC 8341'
-[relaton-ietf] (IETF RFC 8341) Fetching from Relaton repository ...
-[relaton-ietf] (IETF RFC 8341) Found: `RFC 8341`
-=> #<RelatonIetf::IetfBibliographicItem:0x007fd1875e7f58
+item = Relaton::Ietf::Bibliography.get 'IETF RFC 8341'
+relaton-ietf] INFO: (IETF RFC 8341) Fetching from Relaton repository ...
+[relaton-ietf] INFO: (IETF RFC 8341) Found: `RFC 8341`
+=> #<Relaton::Ietf::ItemData:0x0000000125608cb0
 ...
 
 # Fetch Internet-Draft document
-RelatonIetf::IetfBibliography.get 'IETF I-D.draft-abarth-cake-01'
-[relaton-ietf] (IETF I-D.draft-abarth-cake-01) Fetching from Relaton repository ...
-[relaton-ietf] (IETF I-D.draft-abarth-cake-01) Found: `draft-abarth-cake-01`
-=> #<RelatonIetf::IetfBibliographicItem:0x00007fdd129bbeb8
+Relaton::Ietf::Bibliography.get 'IETF I-D.draft-abarth-cake-01'
+[relaton-ietf] INFO: (IETF I-D.draft-abarth-cake-01) Fetching from Relaton repository ...
+[relaton-ietf] INFO: (IETF I-D.draft-abarth-cake-01) Found: `draft-abarth-cake-01`
+=> #<Relaton::Ietf::ItemData:0x000000012141fdd0
 ...
 
 # Return nil if a document doesn't exist.
-RelatonIetf::IetfBibliography.get 'IETF 1111'
-[relaton-ietf] (IETF 1111) Fetching from Relaton repository ...
-[relaton-ietf] (IETF 1111) Not found.
+Relaton::Ietf::Bibliography.get 'IETF 1111'
+[relaton-ietf] INFO: (IETF 1111) Fetching from Relaton repository ...
+[relaton-ietf] INFO: (IETF 1111) Not found.
 => nil
 ----
 
@@ -66,9 +66,9 @@ RelatonIetf::IetfBibliography.get 'IETF 1111'
 [source,ruby]
 ----
 item.to_xml
-=> "<bibitem id="RFC8341" type="standard" schema-version="v1.2.1">
-      <fetched>2022-12-03</fetched>
-      <title type="main" format="text/plain">Network Configuration Access Control Model</title>
+=> "<bibitem id="RFC8341" type="standard" schema-version="v1.4.1">
+      <fetched>2026-02-18</fetched>
+      <title type="main">Network Configuration Access Control Model</title>
       <uri type="src">https://www.rfc-editor.org/info/rfc8341</uri>
       <docidentifier type="IETF" primary="true">RFC 8341</docidentifier>
       ....
@@ -78,24 +78,23 @@ With `bibdata: true` option XML output is wrapped with `bibdata` element and `ex
 [source,ruby]
 ----
 item.to_xml bibdata: true
-=> "<bibdata type="standard" schema-version="v1.2.1">
-      <fetched>2022-12-03</fetched>
-      <title type="main" format="text/plain">Network Configuration Access Control Model</title>
+=> "<bibdata type="standard" schema-version="v1.4.1">
+      <fetched>2026-02-18</fetched>
+      <title type="main">Network Configuration Access Control Model</title>
       <uri type="src">https://www.rfc-editor.org/info/rfc8341</uri>
       <docidentifier type="IETF" primary="true">RFC 8341</docidentifier>
-      <docidentifier type="DOI">10.17487/RFC8341</docidentifier>
       ...
       <ext schema-version="v1.0.1">
-        <editorialgroup>
-          <committee>netconf</committee>
-        </editorialgroup>
+        <doctype>rfc</doctype>
+        <flavor>ietf</flavor>
+        <stream>IETF</stream>
       </ext>
     </bibdata>"
 ----
 
-=== Typed links
+=== Typed source links
 
-IETF documents may have `src`, `xml`, and `doi` link types.
+IETF documents may have `src`, `xml`, and `doi` source link types.
 
 * `src` - web publication
 * `xml` - BibXML publication
@@ -103,29 +102,26 @@ IETF documents may have `src`, `xml`, and `doi` link types.
 
 [source,ruby]
 ----
-item.link
-=> [#<RelatonBib::TypedUri:0x00007fe8b287a120 @content=#<Addressable::URI:0x7e4 URI:https://raw.githubusercontent.com/relaton/relaton-data-rfcs/main/data/reference.RFC.8341.xml>, @type="xml">,
- #<RelatonBib::TypedUri:0x00007fe8b2237ec0 @content=#<Addressable::URI:0x7f8 URI:https://www.rfc-editor.org/info/rfc8341>, @type="src">]
+item.source.first.type
+=> "src"
+item.source.first.content
+=> "https://www.rfc-editor.org/info/rfc8341"
 ----
 
 === Parse a file locally
 
 [source,ruby]
 ----
-item = Relaton::Provider::Ietf.from_rfcxml File.read("spec/examples/rfc.xml")
-=> #<RelatonIetf::IetfBibliographicItem:0x007fa8cda79ab8
+item = Relaton::Ietf::BibXMLParser.parse_rfc File.read("spec/fixtures/rfc.xml")
+=> #<Relaton::Ietf::ItemData:0x000000012913e4d8
 ...
 ----
 
 === Create bibliographic item from YAML
 [source,ruby]
 ----
-hash = YAML.load_file 'spec/examples/ietf_bib_item.yml'
-=> {"id"=>"RFC 8341",
-...
-
-RelatonIetf::IetfBibliographicItem.from_hash hash
-=> #<RelatonIetf::IetfBibliographicItem:0x007f9a929dde40
+Relaton::Ietf::Item.from_yaml File.read('spec/fixtures/item.yaml')
+=> #<Relaton::Ietf::ItemData:0x0000000127edf508
 ...
 ----
 
@@ -137,7 +133,7 @@ There are IETF datasets that can be converted into RelatonXML/BibXML/BibYAML for
 - `ietf-internet-drafts` - convert files from local directory `./bibxml-ids`. Use `rsync -avcizxL rsync.ietf.org::bibxml-ids ./bibxml-ids` command to fetch the files.
 - `ietf-rfc-entries` - https://www.rfc-editor.org/rfc-index.xml (`<rfc-entry>`)
 
-The method `RelatonIetf::DataFetcher.fetch(source, output: "data", format: "yaml")` converts all the documents from the dataset and saves them to the `./data` folder in YAML format.
+The method `Relaton::Ietf::DataFetcher.fetch(source, output: "data", format: "yaml")` converts all the documents from the dataset and saves them to the `./data` folder in YAML format.
 
 Arguments:
 
@@ -147,16 +143,16 @@ Arguments:
 
 [source,ruby]
 ----
-RelatonIetf::DataFetcher.fetch "ietf-internet-drafts"
+Relaton::Ietf::DataFetcher.fetch "ietf-internet-drafts"
 Started at: 2021-12-17 10:23:20 +0100
 Stopped at: 2021-12-17 10:29:19 +0100
-Done in: 360 sec.
+Done in: 1360 sec.
 => nil
 ----
 
 === Logging
 
-RelatonIetf 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::Ietf 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.
 
 == Contributing