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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89b060e7e705053054c3f0e3ff3116e054b14137c71c6a42068e947f31f9ee79
-  data.tar.gz: 83395144a3d8f3c3a50968fe0e6eee48a22ee61d8f9d5bccdab13d9579b8eed1
+  metadata.gz: eb4b54d49f314da1369dec1e4446b108ddd68b92555c88c8951233fd7e6b31dc
+  data.tar.gz: 2660c24bf8a0916a28010eec9b434953233076bb69775c9852473780f2317373
 SHA512:
-  metadata.gz: 66ca9ef9f044226d3dac22455e15a90b96c75adac7a926a9a204ae7ecb261cfd2122910712cd62f1b83a7b13853092050f2cc36db4041664945ce7dcebfc3af5
-  data.tar.gz: 49262a08e8dbafc224d66634910134f2b604307819a8d1676885fa21dcaa17debab24464d367efee4a7bfeb6e085dcfdcdd23f1e30ef32b4511031f75c79656f
+  metadata.gz: aa98951e0c115564f41f81a2de3968617a2699559f4e8a38cc0eaebd6bfeb2feeee16222d01875db30dbcde676a2220671ccdd2709ab4043559874a11470ac9b
+  data.tar.gz: 19c4b2f8e43fb87d8f58ff759d3af106b8b8ca3f5730dbffcfd8a089b1f2d40690a22862df507401313a3e1bd4c3c46941e2aa37ff32005b398268a4f976d5ed

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,57 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+relaton-jis is a Ruby gem that retrieves Japanese Industrial Standards (JIS) metadata from webdesk.jsa.or.jp and models them as Relaton bibliographic items with XML/YAML serialization and RelaxNG schema validation.
+
+## Commands
+
+- `bundle exec rake spec` — run all tests
+- `bundle exec rspec spec/relaton/jis/item_spec.rb` — run a single test file
+- `bundle exec rspec spec/relaton/jis/item_spec.rb:15` — run a single test by line number
+- `bundle exec rake rubocop` — lint
+- `bundle exec rake` — default task (runs specs)
+
+## Architecture
+
+The gem is currently on the `lutaml-integration` branch, a major refactoring from the old `RelatonJis::` namespace to `Relaton::Jis::` using lutaml-model for data modeling.
+
+### Class Hierarchy
+
+All classes live under `lib/relaton/jis/`:
+
+- **`Item`** (extends `Iso::Item`) — core bibliographic item; defines the `Ext` attribute for JIS extensions; uses model `Bib::ItemData`
+- **`Bibitem`** (extends `Item`, includes `Bib::BibitemShared`) — XML bibitem serialization
+- **`Bibdata`** (extends `Item`, includes `Bib::BibdataShared`) — XML bibdata wrapper
+- **`Ext`** (extends `Iso::Ext`) — JIS-specific extension data (schema_version, doctype)
+- **`Doctype`** (extends `Bib::Doctype`) — allowed types: `japanese-industrial-standard`, `technical-report`, `technical-specification`, `amendment`
+- **`Scraper`** — scrapes individual JIS document pages from webdesk.jsa.or.jp; returns `Bib::ItemData`; editorial group is modeled as a contributor with `Bib::Subdivision` (not `EditorialGroup`)
+- **`DataFetcher`** (extends `Core::DataFetcher`) — bulk-fetches all JIS documents via threaded scraping; implements `to_yaml`/`to_xml`/`to_bibxml` for serialization dispatch; loaded on-demand via `require "relaton/jis/data_fetcher"`
+- **`Processor`** (extends `Core::Processor`) — Relaton processor registration; provides `get`, `fetch_data`, `from_xml`, `from_yaml`, `grammar_hash`; prefix `JIS`, defaultprefix `^(JIS|TR)\s`
+- **`Util`** (includes `Relaton::Bib::Util`) — logging with PROGNAME "relaton-jis"
+
+### Key Dependencies
+
+- **relaton-iso / relaton-bib** — parent bibliographic item models this gem extends
+- **lutaml-model** — DSL for `attribute` definitions and serialization
+- **mechanize** — web scraping from JSA website
+
+### Serialization & Validation
+
+- YAML and XML round-trip serialization via lutaml-model
+- RelaxNG grammars in `grammars/` validate XML output; `relaton-jis.rng` defines JIS-specific elements (DocumentType, structuredidentifier, stagename)
+- Tests validate XML against these grammars using ruby-jing
+
+### Test Patterns
+
+- **Round-trip tests**: YAML → Object → YAML and XML → Object → XML (fixtures in `spec/fixtures/`)
+- **Schema validation**: Jing validates generated XML against RelaxNG grammars
+- **HTTP mocking**: VCR cassettes (`spec/vcr_cassettes/`) record external HTTP interactions; WebMock disables real network calls in tests
+
+## Code Conventions
+
+- All files use `# frozen_string_literal: true`
+- Linting follows [Ribose OSS style](https://github.com/riboseinc/oss-guides); target Ruby 3.1
+- Ruby >= 3.1.0 required

data/README.adoc

@@ -1,4 +1,4 @@
-= RelatonJis: retrieve JIS Standards for bibliographic use using the BibliographicItem model
+= Relaton::Jis: retrieve JIS Standards for bibliographic use using the BibliographicItem model
 
 image:https://img.shields.io/gem/v/relaton-jis.svg["Gem Version", link="https://rubygems.org/gems/relaton-jis"]
 image:https://github.com/relaton/relaton-jis/workflows/macos/badge.svg["Build Status, link="https://github.com/relaton/relaton-jis/actions?workflow=rake"]
@@ -8,7 +8,7 @@ image:https://img.shields.io/github/commits-since/relaton/relaton-jis/latest.svg
 
 RelatonJis 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 JIS Standards from https://webdesk.jsa.or.jp, and access such metadata through the `RelatonJis::BibliographicItem` object.
+You can use it to retrieve metadata of JIS Standards from https://webdesk.jsa.or.jp, and access such metadata through the `Relaton::Jis::ItemData` object.
 
 == Installation
 
@@ -26,46 +26,43 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 [source,ruby]
 ----
-require 'relaton_jis'
+require 'relaton/jis'
 => true
 
-hit_collection = RelatonJis::Bibliography.search("JIS X 0208")
-=> <RelatonJis::HitCollection:0x00000000018858 @ref=JIS X 0208 @fetched=false>
+hit_collection = Relaton::Jis::Bibliography.search("JIS X 0208")
+=> <Relaton::Jis::HitCollection:0x000000000014a0 @ref=JIS X 0208 @fetched=false>
 
 hit_collection.first
-=> <RelatonJis::Hit:0x00000000018880 @text="JIS X 0208" @fetched="false" @fullIdentifier="" @title="">
+=> <Relaton::Jis::Hit:0x00000000001a20 @reference="JIS X 0208" @fetched="false" @docidentifier="">
 
-item = hit_collection[2].fetch
-=> #<RelatonJis::BibliographicItem:0x00007fe4564a7580
+item = hit_collection[1].item
+=> #<Relaton::Jis::ItemData:0x000000012a880790
 ...
 
-item.docidentifier
-=> [#<RelatonBib::DocumentIdentifier:0x00007fe46625c518
-  @id="JIS X 0208:1997/AMENDMENT 1:2012",
-  @language=nil,
-  @primary=true,
-  @scope=nil,
-  @script=nil,
-  @type="JIS">]
+item.docidentifier[0].type
+=> "JIS"
+
+item.docidentifier[0].content
+=> "JIS X 0208:1997/AMENDMENT 1:2012"
 ----
 
 === Fetch document by reference and year
 
 [source,ruby]
 ----
-item = RelatonJis::Bibliography.get "JIS X 0208:1997"
-[relaton-jis] (JIS X 0208:1997) Fetching from webdesk.jsa.or.jp ...
-[relaton-jis] (JIS X 0208:1997) Found: `JIS X 0208:1997`
-=> #<RelatonJis::BibliographicItem:0x00007fe4478ecc08
+item = Relaton::Jis::Bibliography.get "JIS X 0208:1997"
+[relaton-jis] INFO: (JIS X 0208:1997) Fetching from webdesk.jsa.or.jp ...
+[relaton-jis] INFO: (JIS X 0208:1997) Found: `JIS X 0208:1997`
+=> #<Relaton::Jis::ItemData:0x000000012c0f2440
 ...
 
-item = RelatonJis::Bibliography.get "JIS X 0208", "1997"
-[relaton-jis] (JIS X 0208) Fetching  from webdesk.jsa.or.jp ...
-[relaton-jis] (JIS X 0208) Found: `JIS X 0208:1997`
-=> #<RelatonJis::BibliographicItem:0x00007fe436b49d90
+item = Relaton::Jis::Bibliography.get "JIS X 0208", "1997"
+[relaton-jis] INFO: (JIS X 0208) Fetching from webdesk.jsa.or.jp ...
+[relaton-jis] INFO: (JIS X 0208) Found: `JIS X 0208:1997`
+=> #<Relaton::Jis::ItemData:0x000000012c1d7810
 ...
 
-item.docidentifier[0].id
+item.docidentifier[0].content
 => "JIS X 0208:1997"
 ----
 
@@ -73,23 +70,23 @@ item.docidentifier[0].id
 
 [source,ruby]
 ----
-item = RelatonJis::Bibliography.get "JIS B 0060 (all parts)"
-[relaton-jis] (JIS B 0060 (all parts)) Fetching from webdesk.jsa.or.jp ...
-[relaton-jis] (JIS B 0060 (all parts)) Found: `JIS B 0060 (all parts)`
-=> #<RelatonJis::BibliographicItem:0x000000010c3e2300
+item = Relaton::Jis::Bibliography.get "JIS B 0060 (all parts)"
+[relaton-jis] INFO: (JIS B 0060 (all parts)) Fetching from webdesk.jsa.or.jp ...
+[relaton-jis] INFO: (JIS B 0060 (all parts)) Found: `JIS B 0060 (all parts)`
+=> #<Relaton::Jis::ItemData:0x00000001273c8840
 ...
 
-item.docidentifier
-=> [#<RelatonBib::DocumentIdentifier:0x000000010c5905f8 @id="JIS B 0060 (all parts)", @language=nil, @primary=true, @scope=nil, @script=nil, @type="JIS">]
+item.docidentifier[0].content
+=> "JIS B 0060 (all parts)"
 
-item = RelatonJis::Bibliography.get "JIS B 0060 (規格群)"
-[relaton-jis] (JIS B 0060 (規格群)) Fetching from webdesk.jsa.or.jp ...
-[relaton-jis] (JIS B 0060 (規格群)) Found: `JIS B 0060 (all parts)`
-=> #<RelatonJis::BibliographicItem:0x000000010c3ceb20
+item = Relaton::Jis::Bibliography.get "JIS B 0060 (規格群)"
+[relaton-jis] INFO: (JIS B 0060 (規格群)) Fetching from webdesk.jsa.or.jp ...
+[relaton-jis] INFO: (JIS B 0060 (規格群)) Found: `JIS B 0060 (all parts)`
+=> #<Relaton::Jis::ItemData:0x000000012cb367d0
 ...
 
-item.docidentifier
-=> [#<RelatonBib::DocumentIdentifier:0x000000010c8d9b10 @id="JIS B 0060 (all parts)", @language=nil, @primary=true, @scope=nil, @script=nil, @type="JIS">]
+item.docidentifier[0].content
+=> "JIS B 0060 (all parts)"
 ----
 
 === XML serialization
@@ -101,59 +98,55 @@ Possible options:
 [source,ruby]
 ----
 item.to_xml
-=> "<bibitem id="JISX0208-1997" type="standard" schema-version="v1.2.9">
-      <fetched>2023-03-18</fetched>
-      <title format="text/plain" language="ja" script="Jpan">７ビット及び８ビットの２バイト情報交換用符号化漢字集合</title>
-      <title format="text/plain" language="en" script="Lant">7-bit and 8-bit double byte coded KANJI sets for information interchange</title>
+=> "<bibitem id="JISB006012015" type="standard" schema-version="v1.4.1">
+      <fetched>2026-02-25</fetched>
+      <title language="ja" script="Jpan">デジタル製品技術文書情報―第１部：総則</title>
+      <title language="en" script="Latn">Digital technical product documentation (DTPD) -- Part 1: General code of practices</title>
+      <uri type="src">https://webdesk.jsa.or.jp/books/W11M0090/index/?bunsyo_id=JIS+B+0060-1%3A2015</uri>
+      <docidentifier type="JIS" primary="true">JIS B 0060 (all parts)</docidentifier>
       ...
     </bibitem>"
 
 item.to_xml bibdata: true
-=> "<bibdata type="standard" schema-version="v1.2.9">
-      <fetched>2023-03-18</fetched>
-      <title format="text/plain" language="ja" script="Jpan">７ビット及び８ビットの２バイト情報交換用符号化漢字集合</title>
-      <title format="text/plain" language="en" script="Lant">7-bit and 8-bit double byte coded KANJI sets for information interchange</title>
+=> "<bibdata type="standard" schema-version="v1.4.1">
+      <fetched>2026-02-25</fetched>
+      <title language="ja" script="Jpan">デジタル製品技術文書情報―第１部：総則</title>
+      <title language="en" script="Latn">Digital technical product documentation (DTPD) -- Part 1: General code of practices</title>
+      <uri type="src">https://webdesk.jsa.or.jp/books/W11M0090/index/?bunsyo_id=JIS+B+0060-1%3A2015</uri>
+      <docidentifier type="JIS" primary="true">JIS B 0060 (all parts)</docidentifier>
       ...
       <ext schema-version="v0.0.1">
-        <doctype>standard</doctype>
-        <editorialgroup>
-          <technical-committee>一般財団法人　日本規格協会</technical-committee>
-        </editorialgroup>
+        <doctype>japanese-industrial-standard</doctype>
+        <flavor>jis</flavor>
         <ics>
-          <code>35.040</code>
-          <text>Information coding</text>
+          <code>01.110</code>
+          <text>Technical product documentation</text>
         </ics>
         <structuredidentifier type="JIS">
-          <project-number>X0208</project-number>
+          <project-number>B0060 (all parts)</project-number>
         </structuredidentifier>
       </ext>
     </bibdata>"
 ----
 
-=== Typed links
+=== Typed source links
 
-Each JIS document has `src` type link and optional `pdf`.
+Each JIS document has `src` type source link and optional `pdf`.
 
 [source,ruby]
 ----
-item.link
-=> [#<RelatonBib::TypedUri:0x00007fe436a626c0
-  @content=#<Addressable::URI:0xc620 URI:https://webdesk.jsa.or.jp/books/W11M0090/index/?bunsyo_id=JIS+X+0208%3A1997>,
-  @language=nil,
-  @script=nil,
-  @type="src">,
- #<RelatonBib::TypedUri:0x00007fe436a60ed8
-  @content=#<Addressable::URI:0xc634 URI:https://webdesk.jsa.or.jp/preview/pre_jis_x_00208_000_000_1997_j_pr11_i4.pdf>,
-  @language=nil,
-  @script=nil,
-  @type="pdf">]
+item.source[0].type
+=> "src"
+
+item.source[0].content
+=> "https://webdesk.jsa.or.jp/books/W11M0090/index/?bunsyo_id=JIS+B+0060-1%3A2015"
 ----
 
 === Fetch data
 
 This gem scrapes the https://webdesk.jsa.or.jp/books/W11M0270 pages to fetch the JIS Standards metadata. By default the data is saved in the `./data` folder in YAML format.
 
-The method `RelatonJis::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::Jis::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').
@@ -161,9 +154,11 @@ Arguments:
 
 [source,ruby]
 ----
-RelatonJis::DataFetcher.fetch
-Start fetching JIS data at 2024-09-27 17:49:40 -0400
-Fetching JIS data finished at 2024-09-27 18:40:11 -0400. It took 3031.0 seconds.
+require "relaton/jis/data_fetcher"
+
+Relaton::Jis::DataFetcher.fetch
+Started at: 2024-09-27 17:49:40 -0400
+Done in: 3031 sec.
 => nil
 ----