relaton 2.2.0.pre.alpha.1 → 3.0.0.pre.alpha.1

data/.github/workflows/rake.yml

@@ -1,14 +0,0 @@
-# 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:
-  workflow_dispatch:
-
-jobs:
-  rake:
-    uses: relaton/support/.github/workflows/rake.yml@main

data/.github/workflows/release.yml

@@ -1,24 +0,0 @@
-# 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/.github/workflows/rubocop.yml

@@ -1,48 +0,0 @@
-name: Rubocop
-
-on: pull_request
-
-permissions:
-  contents: read
-  pull-requests: write
-
-jobs:
-  rubocop:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 1
-      - name: Determine Ruby version for ruby/setup-ruby
-        shell: bash
-        run: |
-          RUBY_VERSION=${{ vars.RUBY_VERSION }}
-
-          if [[ -r .rubocop.yml ]]
-          then
-            RUBY_VERSION=$( \
-              command grep \
-              -E '^\s*TargetRubyVersion:\s*[0-9]+(\.[0-9]+)*' \
-              .rubocop.yml \
-              | command awk '{print $2}' \
-            )
-          fi
-
-          if [[ -z $RUBY_VERSION ]]
-          then
-            # Let setup-ruby determine the Ruby version if no .ruby-version,
-            # .tool-versions or mise.toml file exists
-            RUBY_VERSION=default
-          fi
-
-          echo "RUBY_VERSION=$RUBY_VERSION" >> $GITHUB_ENV
-      - uses: ruby/setup-ruby@v1
-        with:
-          # input ruby-version needs to be specified if no .ruby-version,
-          # .tool-versions or mise.toml file exists
-          #
-          # Use the version that matches the one in gemspec & .rubocop.yml
-          ruby-version: ${{ env.RUBY_VERSION }}
-      - uses: reclaim-the-stack/rubocop-action@v1.1.0
-        with:
-          gem_versions: rubocop:1.84.2 rubocop-performance:1.26.1 rubocop-rails:2.34.3

data/.gitignore

@@ -1,12 +0,0 @@
-coverage/
-.byebug_history
-.rspec_status
-
-testcache
-testcache2
-.rubocop-https---raw-githubusercontent-com-riboseinc-oss-guides-master-ci-rubocop-yml
-.vscode/
-pkg/
-Gemfile.lock
-.rubocop-remote-87c7cdd254a8d09d005ee06efac7acc0.yml
-.claude/

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/CLAUDE.md

@@ -1,78 +0,0 @@
-# CLAUDE.md
-
-This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
-
-## Commands
-
-```bash
-# Run full test suite
-bundle exec rake        # or: bundle exec rspec
-
-# Run a single spec file
-bundle exec rspec spec/relaton/db_spec.rb
-
-# Run a specific test by line number
-bundle exec rspec spec/relaton/db_spec.rb:234
-
-# Lint
-bundle exec rubocop
-
-# Lint with auto-fix
-bundle exec rubocop -a
-```
-
-## Architecture
-
-Relaton is a Ruby gem that fetches, caches, and manages bibliographic references to technical standards from 25+ organizations (ISO, IEC, IETF, NIST, IEEE, etc.).
-
-### Plugin Registry Pattern
-
-**Relaton::Registry** (singleton) auto-discovers and manages backend processor gems (relaton-iso, relaton-iec, relaton-ietf, etc.). Each processor implements the **Relaton::Processor** interface (`get`, `from_xml`, `from_yaml`, `grammar_hash`, `prefix`, `defaultprefix`). The registry routes reference codes to the correct processor by matching prefixes (e.g., "ISO 19115" → `:relaton_iso`).
-
-### Db (lib/relaton/db.rb) — Main Public API
-
-`Relaton::Db#fetch(ref, year, opts)` is the primary entry point. It:
-1. Identifies the processor via Registry prefix matching
-2. Handles combined references (`+` for derivedFrom, `,` for amendments) in `combine_doc`
-3. Delegates to `check_bibliocache` which manages the dual-cache lookup and network fetch flow
-
-`Relaton::Db#fetch_all(text, edition, year)` searches cached entries, filtering by text content (via `match_xml_text?`), edition, and/or year. Returns an array of deserialized bibliographic items from both local and global caches.
-
-The dual-cache strategy uses a **global cache** (`~/.relaton/cache`) and an optional **local cache** (project-level). `check_bibliocache` checks local first, falls back to global, and syncs between them.
-
-### DbCache (lib/relaton/db_cache.rb) — File-based Storage
-
-Stores entries as files under `{dir}/{prefix}/{filename}.{ext}` (e.g., `testcache/iso/iso_19115-1.xml`). Key behaviors:
-- Cache keys are wrapped like `ISO(ISO 19115-1:2014)` and converted to filenames via regex
-- Entries can be XML, "not_found {date}", or "redirection {target_key}"
-- Undated references expire after 60 days; dated ones persist indefinitely
-- Version tracking per prefix directory invalidates cache when processor grammar changes
-- File locking (`LOCK_EX`) for thread-safe concurrent writes
-
-### WorkersPool (lib/relaton/workers_pool.rb)
-
-Thread pool for `fetch_async`. Default 10 threads per processor, overridable via `RELATON_FETCH_PARALLEL` env var.
-
-### Cache Key Format
-
-`std_id` builds keys like `ISO(ISO 19115-1:2014 (all parts) after-2020-01-01)`. The filename regex in `db_cache.rb` uses `[^)]+` — suffixes use `-` not parentheses to avoid breaking it.
-
-## Testing
-
-- RSpec with VCR cassettes in `spec/vcr_cassetes/` for recorded HTTP interactions
-- Tests create `testcache`/`testcache2` directories and clean them in `before(:each)`
-- Cache-related tests need `<fetched>` elements in XML for `valid_entry?` to return true
-- Integration tests in `spec/relaton_spec.rb`; unit tests mirror `lib/` structure under `spec/relaton/`
-- **ISO lookups are stubbed, not cassette-recorded.** Flavor gems (relaton-iso/iec/nist)
-  fetch a large live `index-v2` and deserialize every id through a pinned pubid build,
-  so a single drifted id in the live index makes the whole index unparseable and ISO
-  lookups return `nil`. Umbrella specs therefore stub `Relaton::Iso::Bibliography.get`
-  (and other flavors' `.get`) to return hand-built `ItemData` — the umbrella's job is to
-  test `Db` orchestration (`combine_doc`, caching, api fallback), not relaton-iso's index.
-  Build stub items with the `docidentifier:` key (not `docid:`) so the id survives the
-  cache XML round-trip. Don't reintroduce a live-index cassette for these.
-
-## Style
-
-- RuboCop config inherits from [Ribose OSS guides](https://github.com/riboseinc/oss-guides), target Ruby 3.2
-- Thread safety via `@semaphore` (Mutex) around cache reads/writes in Db

data/Gemfile

@@ -1,29 +0,0 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in gemspec
-gemspec
-
-# Use local monorepo sibling gems where available.
-Dir["../*/"].each do |dir|
-  name = File.basename(dir)
-  next if name == File.basename(__dir__)
-  next unless File.exist?(File.join(dir, "#{name}.gemspec"))
-  gem name, path: dir
-end
-
-
-
-gem "byebug"
-gem "equivalent-xml", "~> 0.6"
-gem "guard", "~> 2.14"
-gem "guard-rspec", "~> 4.7"
-gem "pry-byebug"
-gem "rake", "~> 13.0"
-gem "rspec", "~> 3.6"
-gem "rubocop"
-gem "rubocop-performance"
-gem "rubocop-rails"
-gem "simplecov", "~> 0.15"
-gem "timecop", "~> 0.9"
-gem "vcr", "~> 6"
-gem "webmock", "~> 3.18"

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec

data/docs/CHANGELOG.adoc

@@ -1,16 +0,0 @@
-= Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on https://keepachangelog.com/en/1.0.0/[Keep a Changelog], and this project adheres to https://semver.org/[Semantic Versioning].
-
-== [Unreleased]
-
-== [1.19.2] - 2024-06-29
-- Lazy load Relaton flavor gems dependencies.
-
-== [1.19.1] - 2024-06-24
-- Add `relaton-plateau` flavor gem.
-
-== [1.19.0] - 2024-06-29
-- Switch to using the `relaton-logger` gem for logging.

data/docs/VERSIONING_POLICY.adoc

@@ -1,38 +0,0 @@
-= Versioning Policy
-
-This document describes the versioning policy for the Relaton project. We follow the https://semver.org/[Semantic Versioning] scheme.
-
-== Versioning Scheme
-
-Version nubmers are in the form of `MAJOR.MINOR.PATCH`. The version number is incremented based on the following:
-
-- `MAJOR` version is incremented when incompatible changes are made to the API.
-- `MINOR` version is incremented when the Relaton data model is changed.
-- `PATCH` version is incremented when backward-compatible bug fixes are made.
-
-== Rules for incrementing version numbers
-
-1. **MAJOR** version is incremented when incompatible changes are made to the API. Icrement the MAJOR version when:
-   - Removing or renaming classes or methods.
-   - Changing the signature of a method.
-   - Changing the behavior of a method.
-
-2. **MINOR** version is incremented when the Relaton data model is changed. Increment the MINOR version when:
-   - Adding, remmoving or renaming attributes of data model classes.
-   - Adding new data model classes.
-
-3. **PATCH** version is incremented when backward-compatible bug fixes are made. Increment the PATCH version when:
-   - Fixing a bug that does not change the behavior of the API.
-   - Improving the performance of the API.
-
-== Additional Guidelines
-
-For convenience, we use the same major and minor vesions for all the Relaton flavor gems that uses the same version of the Relaton data model.
-
-== Exceptions
-
-In some cases, we may increment the `PATCH` version for backward-incompatible changes. In such cases, we will update dependent gems to use the new version or higher. For example `"~> 1.19.2"` doen't allow to use version less than `1.19.2`.
-
-== References
-
-- https://semver.org/[Semantic Versioning]

data/docs/navigation.adoc

@@ -1,6 +0,0 @@
----
-items:
-  - { title: README, path: README/ }
----
-
-= Navigation

data/lib/relaton/db/version.rb

@@ -1,5 +0,0 @@
-module Relaton
-  class Db
-    VERSION = "2.2.0.pre.alpha.1".freeze
-  end
-end

data/relaton.gemspec

@@ -1,72 +0,0 @@
-# coding: utf-8
-
-lib = File.expand_path("lib", __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "relaton/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "relaton"
-  spec.version       = Relaton::VERSION
-  spec.authors       = ["Ribose Inc."]
-  spec.email         = ["open.source@ribose.com"]
-
-  spec.summary       = "Relaton: bibliographic references to technical " \
-                       "standards — database, registry, cache, and all " \
-                       "flavor plugins bundled in one gem."
-  spec.description   = <<~DESCRIPTION
-    Relaton is the central database, registry, and cache for bibliographic
-    references to technical standards in the Relaton/XML bibliographic
-    model. It provides the Relaton::Db API, a plugin registry that lazily
-    loads flavor gems (relaton-iso, relaton-ietf, etc.) on demand, and a
-    file-based cache for fetched references.
-
-    Installing this gem also pulls in every Relaton flavor plugin so you
-    can fetch references from any supported standards body out of the
-    box. The CLI (relaton-cli) is intentionally NOT a dependency —
-    install it separately when you need command-line access.
-  DESCRIPTION
-
-  spec.homepage      = "https://github.com/relaton/relaton"
-  spec.license       = "BSD-2-Clause"
-
-  spec.bindir        = "bin"
-  spec.require_paths = ["lib"]
-  spec.files         = `git ls-files`.split("\n")
-  spec.required_ruby_version = Gem::Requirement.new(">= 3.3.0")
-
-  spec.add_dependency "relaton-bib", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-core", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-index", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-logger", "~> 2.2.0.pre.alpha.1"
-
-  spec.add_dependency "relaton-3gpp", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-bipm", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-bsi", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-calconnect", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-ccsds", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-cen", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-cie", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-doi", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-ecma", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-etsi", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-gb", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-iana", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-iec", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-ieee", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-ietf", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-iho", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-isbn", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-iso", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-itu", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-jis", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-nist", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-oasis", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-ogc", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-omg", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-plateau", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-un", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-w3c", "~> 2.2.0.pre.alpha.1"
-  spec.add_dependency "relaton-xsf", "~> 2.2.0.pre.alpha.1"
-
-  spec.metadata["rubygems_mfa_required"] = "true"
-end

data/spec/relaton/config_spec.rb

@@ -1,10 +0,0 @@
-describe Relaton::Db do
-  after { described_class.instance_variable_set :@configuration, nil }
-
-  it "configure" do
-    described_class.configure do |conf|
-      conf.use_api = true
-    end
-    expect(described_class.configuration.use_api).to be true
-  end
-end

data/spec/relaton/db_cache_spec.rb

@@ -1,51 +0,0 @@
-require "fileutils"
-require "timeout"
-
-RSpec.describe Relaton::Db::Cache do
-  it "creates default caches" do
-    cache_path = File.expand_path("~/.relaton/cache")
-    FileUtils.mv cache_path, "relaton1/cache", force: true
-    FileUtils.rm_rf %w(relaton)
-    Relaton::Db.init_bib_caches(
-      global_cache: true, local_cache: "", flush_caches: true,
-    )
-    expect(File.exist?(cache_path)).to be true
-    expect(File.exist?("relaton")).to be true
-    FileUtils.mv "relaton1/cache", cache_path if File.exist? "relaton1"
-  end
-
-  it "write same file by concurent processes" do
-    dir = "testcache/iso"
-    FileUtils.mkdir_p dir
-    file_name = File.join dir, "iso_123.xml"
-    file = File.open(file_name, File::RDWR | File::CREAT, encoding: "UTF-8") # rubocop:disable Style/FileOpen
-    file.flock File::LOCK_EX
-    command = <<~RBY
-      require "relaton/db"
-      cache = Relaton::Db::Cache.new "testcache"
-      cache["ISO(ISO 123)"] = "test 1"
-    RBY
-    pid = spawn RbConfig.ruby, "-e #{command}"
-    sleep 0.1
-    file.write "test 2"
-    file.flock File::LOCK_UN
-    file.close
-    Process.waitpid pid, 0
-    expect($?.exitstatus).to eq 0
-    expect(File.read(file_name)).to eq "test 1"
-    FileUtils.rm_rf "testcache"
-  end
-
-  context "delete file from cache" do
-    it "delete redirect file and its original" do
-      cache = Relaton::Db::Cache.new "testcache"
-      cache["ISO(ISO 123)"] = "test 1"
-      cache["ISO(123)"] = "redirection ISO(ISO 123)"
-      expect(File.exist?("testcache/iso/iso_123.xml")).to be true
-      expect(File.exist?("testcache/iso/123.redirect")).to be true
-      cache["ISO(123)"] = nil
-      expect(File.exist?("testcache/iso/iso_123.xml")).to be false
-      expect(File.exist?("testcache/iso/123.redirect")).to be false
-    end
-  end
-end