relaton-bib 1.4.0 → 2.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd9ee52233758a976f5f9d4e549c61c899a643afddf3486215b219b868041d76
-  data.tar.gz: dc9878b905a4412fe8237f71a422f23252a7f9933e882e1d502333890e00ba1d
+  metadata.gz: 15d36c3ed1e4ae0042f96a06a6320dccbe089a87a691b77b8ad14e276217bd22
+  data.tar.gz: d6db31f185b72668da0c289bc462a62d1cfd1b9dda542f37b9dee7257d5282b4
 SHA512:
-  metadata.gz: 07d38211e4b0e19152e0c92341902f3a93482795c4cd1b019e67b33dd95edfba630cd9c474f8b3c930bf36dee99f346f8142f49252e296a2867580ffb53082ba
-  data.tar.gz: 3a070a16d70d30bc72750325d314ab548938d224e58aa584748572be85b4e5e66d94b8ca204583faa40231adacd86a0eec1ea4d40c4d4261ab2dbc484492d7db
+  metadata.gz: 304fcb5b02e2c019d532164228acede4ed81c210eafededbbdd9446ac94fcd32d142be5be7689db09bc17b7aa3e6cfb333b892220ba36e64fcccc2bdda2df29c
+  data.tar.gz: 390cf8b808ab85b099d573b4bea833d265a2326d81c00936e5cebe6ae79c9243991843d44a46d3d24e403137f1ec27b433acc532c51f99a0d5e91d0ed66d6744

data/.github/workflows/integration-tests.yml

@@ -0,0 +1,54 @@
+name: integration-tests
+
+on:
+  push:
+    branches: [ master, main ]
+  pull_request:
+
+jobs:
+  tests:
+    name: Integration test ${{ matrix.repo }}
+    runs-on: ubuntu-latest
+
+    concurrency:
+      group: '${{ github.workflow }}-${{ github.job }}-${{ matrix.repo }}-${{ github.head_ref || github.ref_name }}'
+      cancel-in-progress: true
+
+    continue-on-error: true
+    strategy:
+      matrix:
+        repo: [ relaton-render ]
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: true
+
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.3'
+        bundler-cache: true
+
+    - uses: actions/checkout@v3
+      with:
+        submodules: recursive
+        repository: relaton/${{ matrix.repo }}
+        path: ${{ matrix.repo }}
+        fetch-depth: 0
+
+    - if: github.event_name == 'pull_request'
+      run: |
+        if [ `git rev-parse --verify "${GITHUB_HEAD_REF}" 2>/dev/null` ]
+        then
+          git checkout "${GITHUB_HEAD_REF}"
+        fi
+      working-directory: ${{ matrix.repo }}
+
+    - run: |
+        gem_name=$(echo ${GITHUB_REPOSITORY} | cut -d "/" -f 2)
+        bundle remove ${gem_name} || true
+        bundle add ${gem_name} --path ..
+      working-directory: ${{ matrix.repo }}
+
+    - run: bundle exec rake
+      working-directory: ${{ matrix.repo }}

data/.github/workflows/rake.yml

@@ -0,0 +1,15 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main, lutaml-integration ]
+    tags: [ v* ]
+  pull_request:
+
+jobs:
+  rake:
+    uses: relaton/support/.github/workflows/rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.RELATON_CI_PAT_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,24 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: release
+
+on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch (or pre|rc|etc).
+          Also, you can pass 'skip' to skip 'git tag' and do 'gem push' for the current version
+        required: true
+        default: 'skip'
+  repository_dispatch:
+    types: [ do-release ]
+
+
+jobs:
+  release:
+    uses: relaton/support/.github/workflows/release.yml@main
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+    secrets:
+      rubygems-api-key: ${{ secrets.RELATON_CI_RUBYGEMS_API_KEY }}

data/.gitignore

@@ -7,8 +7,11 @@
 /spec/reports/
 /tmp/
 .vscode/
+/vendor/
 
 # rspec failure tracking
 .rspec_status
-.rubocop-https---raw-githubusercontent-com-riboseinc-oss-guides-master-ci-rubocop-yml
 Gemfile.lock
+.claude/
+.rubocop-remote-87c7cdd254a8d09d005ee06efac7acc0.yml
+rubocop-87c7cdd254a8d09d005ee06efac7acc0.yml

data/.rubocop.yml

@@ -2,9 +2,11 @@
 # https://github.com/riboseinc/oss-guides
 # All project-specific additions and overrides should be specified in this file.
 
+require: rubocop-rails
+
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 AllCops:
-  TargetRubyVersion: 2.4
+  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
+
+RelatonBib is a Ruby gem that implements the [BibliographicItem model](https://github.com/metanorma/relaton-models#bibliography-uml-models) for bibliographic reference management. It's part of the Relaton ecosystem and serves as the base library for other Relaton gems.
+
+## Common Commands
+
+```bash
+# Install dependencies
+bundle install
+
+# Run all tests
+bundle exec rake spec
+
+# Run a single test file
+bundle exec rspec spec/relaton_bib/bibliographic_item_spec.rb
+
+# Run a specific test by line number
+bundle exec rspec spec/relaton_bib/bibliographic_item_spec.rb:42
+
+# Run linting
+bundle exec rubocop
+
+# Auto-fix linting issues
+bundle exec rubocop -a
+
+# Interactive console
+bin/console
+```
+
+## Architecture
+
+### Serialization Layer (lutaml-model)
+
+The codebase uses [lutaml-model](https://github.com/lutaml/lutaml-model) for serialization. Each model class in `lib/relaton/bib/model/` inherits from `Lutaml::Model::Serializable` and declares attributes with XML/YAML/JSON mappings.
+
+### Constant loading (autoload)
+
+Model and converter constants are wired via Ruby `autoload` from a central manifest,
+[lib/relaton/bib/model_autoload.rb](lib/relaton/bib/model_autoload.rb). This makes load order
+irrelevant and avoids circular requires between mutually-referencing classes (e.g. `OrganizationType`
+↔ `Subdivision`). **When adding a new model class, add an `autoload` entry to the manifest** rather
+than a `require_relative` in a sibling file. The manifest also eagerly loads `lutaml/model`/`lutaml/xml`
+and runs the `Lutaml::Model::Config.configure` block so the XML adapter is set regardless of which
+class is referenced first. Exceptions that keep `require_relative`: files that only *reopen* an
+already-defined module to add methods (the converter method-partials under
+`lib/relaton/bib/converter/*/`), which `autoload` cannot express.
+
+### Core Classes
+
+**`Relaton::Bib::Item`** ([lib/relaton/bib/model/item.rb](lib/relaton/bib/model/item.rb)) - The main serialization class defining all bibliographic attributes and their XML mappings. Uses `ItemData` as its underlying model.
+
+**`Relaton::Bib::ItemData`** ([lib/relaton/bib/item_data.rb](lib/relaton/bib/item_data.rb)) - The data container class that holds bibliographic data and provides conversion methods (`to_xml`, `to_yaml`, `to_bibtex`, `to_rfcxml`). This separation allows the same data to be serialized differently (bibitem vs bibdata).
+
+**`Relaton::Bib::Bibitem`** and **`Relaton::Bib::Bibdata`** - Variants of `Item` with different XML root elements and attributes (bibitem excludes `ext`, bibdata excludes `id`).
+
+### Component Models
+
+Each bibliographic attribute has its own class in `lib/relaton/bib/model/`:
+
+- `Title`, `LocalizedString`, `LocalizedMarkedUpString` - text with language/script
+- `Contributor`, `Person`, `Organization` - contributors and affiliations
+- `Docidentifier` - document IDs (DOI, ISBN, etc.)
+- `Date` - publication dates with custom `StringDate` type
+- `Relation` - related documents (circular reference with Item)
+- `Ext` - extension data (doctype, ICS codes, structured identifiers)
+
+### Parsing
+
+- **`HashParserV1`** ([lib/relaton/bib/hash_parser_v1.rb](lib/relaton/bib/hash_parser_v1.rb)) - Converts legacy Hash/YAML format to `ItemData`
+- **`Converter::BibXml`** ([lib/relaton/bib/converter/bibxml.rb](lib/relaton/bib/converter/bibxml.rb)) - Parses RFC BibXML format via `Relaton::Bib::Converter::BibXml.to_item`
+- **lutaml-model native** - `Item.from_xml`, `Item.from_yaml`, `Item.from_json` handle current format
+
+### Rendering
+
+- **`Renderer::BibtexBuilder`** - Converts `ItemData` to BibTeX format
+- **`Converter::BibXml`** - Converts `ItemData` to RFC XML format via `Relaton::Bib::Converter::BibXml.to_xml`
+- **lutaml-model native** - `to_xml`, `to_yaml`, `to_json` via the serialization classes
+
+### Usage Pattern
+
+```ruby
+# Parse from YAML
+item = Relaton::Bib::Item.from_yaml(yaml_string)
+
+# Parse from XML
+item = Relaton::Bib::Bibitem.from_xml(xml_string)
+item = Relaton::Bib::Bibdata.from_xml(xml_string)
+
+# Parse from RFC XML
+item = Relaton::Bib::Converter::BibXml.to_item(xml_string)
+
+# Convert to different formats (returns string)
+item.to_xml                    # as <bibitem>
+item.to_xml(bibdata: true)     # as <bibdata>
+item.to_yaml
+item.to_bibtex
+item.to_rfcxml
+```
+
+## Code Style
+
+- Follows Ribose OSS Ruby style guide (inherited via `.rubocop.yml`)
+- Target Ruby version: 3.1+
+- Uses YARD documentation comments

data/Gemfile

@@ -2,3 +2,14 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in relaton-bib.gemspec
 gemspec
+
+gem "byebug"
+gem "equivalent-xml", "~> 0.6"
+gem "openssl", "~> 3.3.2" # 3.3.0 raises error when rubocop fetches https resources
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop"
+gem "rubocop-performance"
+gem "rubocop-rails"
+gem "ruby-jing"
+gem "simplecov"