relaton-cli 1.20.5 → 2.0.0.pre.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9532812554990a4cc11d27d32a940db3ae908343c7154de1268deec1cefa55fb
-  data.tar.gz: 4bcfe71b907f013cee3e4f07751083016b23321cad540b1340f323051927946c
+  metadata.gz: 78896ea0b02f8711ab4eea67a5d74909137f45a42a7d0785c68ae8db0756dcbb
+  data.tar.gz: e8db97ab8e36651275173de95ce88d59979931b8fc44d6d563a23736201c86c6
 SHA512:
-  metadata.gz: f1679a4108b0bdb582b3ce78dd5eb8b13ee5e08194d9906e529e15ed394cc6d0d8a0f82ca53c6700d7cbe2e5137a6d86bb9c0356ee5b5ed004acd04c2f751d32
-  data.tar.gz: 6e5051f654b4c48a8c9d08ca5a4e95e0960bfb893711dae1d124463f1dd5da251d7ffe70acf51bd9895cd5c986a74e6d122d4fb518670c47ad57a84f8ea40e6f
+  metadata.gz: f4c4f1ea97e4ce93484b2923529645c828cc9d5c0b9bf0e4563b554a962bb7e11e58491ed589155366257410f33868df6e56db83bebb5d4ebef082e35c78c895
+  data.tar.gz: b89d0b397640e7fe3bd7a4866559723ee1aebf85390be44ad09b756e2f51722972b29b8c0382a74e605d464afe15daa7c8e9f016063cc16a9e8e95f5babe0b0b

data/.gitignore

@@ -15,3 +15,4 @@
 .byebug_history
 Gemfile.lock
 .DS_Store
+.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: 3.0
+  TargetRubyVersion: 3.2
 Rails:
   Enabled: true

data/CLAUDE.md

@@ -0,0 +1,96 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+relaton-cli is a Ruby CLI tool for managing bibliographic references to standards (ISO, IEC, IETF, NIST, etc.). It provides commands to fetch, convert, and organize standards metadata in XML, YAML, BibTeX, and HTML formats. Part of the broader Relaton/Metanorma ecosystem.
+
+## Common Commands
+
+```bash
+# Install dependencies
+bundle install
+
+# Run all tests
+bundle exec rspec
+
+# Run a single test file
+bundle exec rspec spec/relaton/cli/command_spec.rb
+
+# Run a specific test by line number
+bundle exec rspec spec/relaton/cli/command_spec.rb:42
+
+# Build the gem
+bundle exec rake build
+
+# Lint (RuboCop, inherits from Ribose OSS guide)
+bundle exec rubocop
+bundle exec rubocop -a  # auto-fix
+```
+
+## Architecture
+
+### Entry Point & CLI Framework
+
+The executable `exe/relaton` calls `Relaton::Cli.start(ARGV)` which routes to `Relaton::Cli::Command`, a Thor-based command class. Thor handles argument parsing, option definitions, and subcommand routing.
+
+### Command Structure
+
+- `lib/relaton/cli/command.rb` — Main Thor command class with top-level commands (fetch, extract, concatenate, split, yaml2xml, xml2yaml, xml2html, yaml2html, convert, fetch-data)
+- `lib/relaton/cli/subcommand_collection.rb` — `relaton collection` subcommands (create, info, list, get, find, fetch, import, export)
+- `lib/relaton/cli/subcommand_db.rb` — `relaton db` subcommands (create, mv, clear, fetch, fetch_all, doctype)
+
+### Option Forwarding Pattern
+
+`Command#fetch` and `SubcommandDb#fetch` use the shared `fetch_document` helper (in `Relaton::Cli` private methods at the bottom of `command.rb`). This helper transforms Thor's kebab-case option keys to snake_case symbols via `gsub("-", "_").to_sym` and splats them as `**dup_opts` to `Relaton.db.fetch` / `Relaton.db.fetch_std`. Adding a new Thor option to these commands automatically forwards it to the underlying library with no method changes needed.
+
+`SubcommandCollection#fetch` calls `Relaton.db.fetch` directly (not through `fetch_document`), so new options must be explicitly forwarded there.
+
+Current fetch options that use this pattern: `--no-cache`, `--all-parts`, `--keep-year`, `--publication-date-before`, `--publication-date-after`.
+
+### Core Data Classes
+
+- `lib/relaton/bibdata.rb` — `Relaton::Bibdata` wraps `RelatonBib::BibliographicItem`, adding URL type handling and serialization to XML/YAML/Hash. Uses `method_missing` to delegate to the underlying bibitem.
+- `lib/relaton/bibcollection.rb` — `Relaton::Bibcollection` represents a collection of bibliographic items with title/author/doctype metadata. Handles XML/YAML round-tripping.
+- `lib/relaton/element_finder.rb` — Mixin providing XPath utilities with namespace handling.
+
+### Converters (Template Method Pattern)
+
+- `lib/relaton/cli/base_convertor.rb` — Abstract base defining the conversion flow (convert_and_write, write_to_file_collection)
+- `lib/relaton/cli/xml_convertor.rb` — XML → YAML conversion
+- `lib/relaton/cli/yaml_convertor.rb` — YAML → XML conversion (includes processor detection via doctype)
+- `lib/relaton/cli/xml_to_html_renderer.rb` — Renders XML/YAML to HTML using Liquid templates from `templates/`
+
+### File Operations
+
+`lib/relaton/cli/relaton_file.rb` — Static methods for extract (pull bibdata from Metanorma XML), concatenate (combine files into a collection), and split (break a collection into individual files).
+
+### Database (Singleton)
+
+`Relaton::Cli::RelatonDb` (in `lib/relaton/cli.rb`) is a Singleton managing a `Relaton::Db` instance. DB path is persisted in `~/.relaton/dbpath`. The `relaton` gem's registry auto-discovers 30+ standard-body processors.
+
+### Processor Detection
+
+`Relaton::Cli.processor(doc)` and `.parse_xml(doc)` detect the correct processor (ISO, IEC, IETF, etc.) from a document's `docidentifier` element type attribute, falling back to prefix matching.
+
+## Test Structure
+
+- `spec/acceptance/` — End-to-end CLI integration tests using `rspec-command`
+- `spec/relaton/cli/` — Unit tests for command, converters, subcommands, DB
+- `spec/relaton/` — Unit tests for Bibcollection and Bibdata
+- `spec/support/` — Test setup: SimpleCov, WebMock, VCR, equivalent-xml matchers
+- `spec/fixtures/` and `spec/vcr_cassettes/` — Test data and recorded HTTP responses
+
+Tests use VCR cassettes to replay HTTP interactions with standards registries. WebMock blocks real HTTP requests in tests.
+
+## Key Dependencies
+
+- `relaton ~> 1.20.0` — Core library providing DB, registry, and all standard-body processors
+- `thor` / `thor-hollaback` — CLI framework
+- `liquid ~> 5` — HTML template rendering
+- `nokogiri` (transitive via relaton) — XML parsing
+
+## Ruby Version
+
+Requires Ruby >= 3.0.0 (set in gemspec and `.rubocop.yml`).

data/Gemfile

@@ -15,3 +15,4 @@ gem "simplecov"
 gem "vcr"
 gem "webmock"
 gem "debug"
+gem "fiddle"