glossarist 2.3.12 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e764b9c8ec92fdd762fdda65ea36270f6798ffd417547e40bd48c8b88e50521
-  data.tar.gz: 2ad3ea02fcdc6d374b7e674796ef124473dc02fbfeff8e4d8053a38fe543e5c6
+  metadata.gz: 2a0f63a8b75f3e01fdceeaadbadac4359e59721396224ba34932f17b49f631b6
+  data.tar.gz: d674b921051ca918c0d08ae57953ae8f7c92c66e57d2ad55ad128a93f8bbcfa0
 SHA512:
-  metadata.gz: ee2ea9ab8d52588d84b19aecd860359438e8b929717726bb4f323e2ba37213bb2d39402cd950d0be896f4c4e63a6147a127fd21088cd42f52d99c0c623ccb945
-  data.tar.gz: 10a6f8eb05fac3d6f87d1092b934793f01ae7ce0a000efc7314d865b4790bf3e14189fa90ef55b58020c40ae882bf1210b02c0ea5626171f7ccc0ef9f207135d
+  metadata.gz: abf0fdfa59b35dd22c412e21ba4b84bde7e24aa7e36ddba608deef1d5ead0f6c5f1ae462be05a1c30cfa38ca824471b77ed9b89ef5bfdcacd692e9dc6122cd5b
+  data.tar.gz: 937ad7ae0b777b9b882f0806292c2b5578d0c91e1e4b1cc1127c40e4caa51ef662539570f235224e4ebcc61fa9a749bc7a272a88bbf29aece1ba28a4c404220b

data/CLAUDE.md

@@ -0,0 +1,59 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Build & Test Commands
+
+- `bundle install` — install dependencies
+- `bundle exec rspec` — run all tests
+- `bundle exec rspec spec/unit/citation_spec.rb` — run a single test file
+- `bundle exec rspec spec/unit/citation_spec.rb:12` — run a single test by line number
+- `bundle exec rake` — runs `bundle exec rspec` (default rake task)
+- `bundle exec rubocop` — lint
+
+## Architecture
+
+Glossarist is a Ruby gem implementing the [Glossarist concept model](https://github.com/glossarist/concept-model) (ISO 10241-1). It provides classes for managing terminology glossaries with multi-language support, serialization to/from YAML, and bibliography integration via Relaton.
+
+### Core Model Hierarchy
+
+All model classes use `Lutaml::Model::Serializable` for serialization. Key classes:
+
+- **`ManagedConceptCollection`** (`managed_concept_collection.rb`) — top-level enumerable collection of ManagedConcepts. Entry point for loading/saving glossaries via `ConceptManager`.
+- **`ManagedConcept`** (`managed_concept.rb`) — a managed concept with `ManagedConceptData` (groups, localized_concepts map, sources), related concepts, dates, and status. Delegates localization via `add_l10n`/`localization(lang)`.
+- **`Concept`** (`concept.rb`) — base concept with `ConceptData` (definition, terms/designations, notes, examples, sources, dates, language_code). Parent of `LocalizedConcept`.
+- **`LocalizedConcept`** (`localized_concept.rb`) — extends `Concept` with `classification`, `entry_status`, `review_type`.
+- **`ConceptData`** (`concept_data.rb`) — the data payload inside `Concept`: definition, terms, examples, notes, sources, language_code. Uses `DetailedDefinition` collections for definition/examples/notes.
+- **`ManagedConceptData`** (`managed_concept_data.rb`) — the data payload inside `ManagedConcept`: id, localized_concepts hash (lang_code => uuid), groups, sources.
+
+### Designation (STI-like pattern)
+
+`Designation::Base` (`designation/base.rb`) uses a self-referencing factory pattern (`of_yaml`) that dispatches to subclasses based on `type` field: `Expression`, `Symbol`, `Abbreviation`, `GraphicalSymbol`, `LetterSymbol`. The mapping is in `SERIALIZED_TYPES`.
+
+### YAML Serialization
+
+- **`ConceptManager`** (`concept_manager.rb`) — handles file I/O. Supports two storage formats:
+  1. Separate `concept/` and `localized_concept/` directories (or `localized-concept/` with dashes)
+  2. Grouped: concept + localized concepts in a single YAML stream file
+- Supports both camelCase and snake_case keys in YAML (e.g., `localizedConcepts` / `localized_concepts`) using `%i[key1 key2]` mapping syntax.
+- Also supports V1 format (`concept-*.yaml` files at root level).
+
+### Configuration & Extensibility
+
+- **`Config`** (`config.rb`) — singleton that holds registered classes for `:localized_concept` and `:managed_concept`. Allows swapping implementations via `register_class`.
+- **`GlossaryDefinition`** (`glossary_definition.rb`) — loads enum values (concept statuses, source types, etc.) from `config.yml`.
+- A `glossarist.yaml` file in the working directory can register extension attributes.
+
+### Collections
+
+`collections/` contains `BibliographyCollection` (extends `Relaton::Db` for bibliography caching), `AssetCollection`, `Collection` (base enumerable), and `DesignationCollection`.
+
+### Dependencies
+
+- `lutaml-model` (~> 0.8) — serialization framework (YAML/XML)
+- `relaton` (>= 2.0.0, < 3) — bibliography database integration
+- `thor` — CLI commands (e.g., `glossarist generate_latex`)
+
+## Branch Notes
+
+The `lutaml-model-0.8` branch upgrades from an earlier lutaml-model to 0.8, which requires explicit types on all attributes. Some upstream relaton-* gems (cen, ieee) haven't been updated yet; a compatibility patch is in `bibliography_collection.rb` that prepends `RelatonRegistryPatch` to gracefully skip incompatible backends.

data/Gemfile

@@ -2,12 +2,32 @@
 
 source "https://rubygems.org"
 
-gem "lutaml-model", github: "lutaml/lutaml-model", branch: "main"
-gem "pry"
-gem "rake"
-gem "rspec"
+gemspec
+
+gem "canon"
+gem "lutaml-model", github: "lutaml/lutaml-model", ref: "main"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop"
 gem "rubocop-performance"
 gem "rubocop-rake"
 gem "rubocop-rspec"
 
+# Use lutaml-model 0.8 compatible branches for all relaton gems.
+# These branches add explicit types to all lutaml-model attributes,
+# which is required by lutaml-model 0.8+.
+# TODO: Remove these once relaton gems release versions with lutaml-model 0.8 support.
+%w[
+  relaton relaton-bib relaton-iso
+  relaton-3gpp relaton-bipm relaton-bsi relaton-calconnect
+  relaton-ccsds relaton-cen relaton-cie relaton-doi relaton-ecma
+  relaton-etsi relaton-gb relaton-iana relaton-iec relaton-ieee
+  relaton-ietf relaton-iho relaton-isbn relaton-itu relaton-jis
+  relaton-nist relaton-oasis relaton-ogc relaton-omg relaton-plateau
+  relaton-un relaton-w3c relaton-xsf
+].each do |g|
+  ref = g == "relaton-bib" ? "upd-lutaml-model-to-0-8-0" : "upd-lutaml-model-to-0.8.0"
+  gem g, github: "relaton/#{g}", ref: ref
+end
+
 gemspec

data/glossarist.gemspec

@@ -31,7 +31,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "lutaml-model", "~> 0.7"
-  spec.add_dependency "relaton", "~> 1.19"
+  spec.add_dependency "lutaml-model", "~> 0.8"
+  spec.add_dependency "relaton", ">= 2.0.0", "< 3"
   spec.add_dependency "thor"
 end

data/lib/glossarist/collections/concept_source_collection.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module Collections
+    class ConceptSourceCollection < TypedCollection
+      instances :sources, ConceptSource
+    end
+  end
+end

data/lib/glossarist/collections/detailed_definition_collection.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module Collections
+    class DetailedDefinitionCollection < TypedCollection
+      instances :definitions, DetailedDefinition
+
+      private
+
+      def coerce_other(item)
+        case item
+        when String then DetailedDefinition.new(content: item)
+        else item
+        end
+      end
+    end
+  end
+end

data/lib/glossarist/collections/localization_collection.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module Collections
+    class LocalizationCollection < Lutaml::Model::Collection
+      instances :localized_concepts, LocalizedConcept
+
+      index_by :language_code
+
+      def [](lang_code)
+        find_by(:language_code, lang_code.to_s)
+      end
+
+      def store(lang_code, localized_concept)
+        localized_concept.language_code ||= lang_code.to_s
+        push(localized_concept)
+        localized_concept
+      end
+
+      def keys
+        map(&:language_code)
+      end
+
+      def values
+        to_a
+      end
+
+      def each_key(&block)
+        keys.each(&block)
+      end
+
+      def each_value(&block)
+        values.each(&block)
+      end
+    end
+  end
+end

data/lib/glossarist/collections/typed_collection.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Glossarist
+  module Collections
+    class TypedCollection < Lutaml::Model::Collection
+      def <<(item)
+        push(coerce(item))
+      end
+
+      private
+
+      def coerce(item)
+        return item if item.is_a?(self.class.instance_type)
+
+        case item
+        when Hash then self.class.instance_type.new(item)
+        else coerce_other(item)
+        end
+      end
+
+      def coerce_other(item)
+        item
+      end
+    end
+  end
+end

data/lib/glossarist/collections.rb

@@ -1,4 +1,14 @@
-require_relative "collections/asset_collection"
-require_relative "collections/bibliography_collection"
-require_relative "collections/collection"
-require_relative "collections/designation_collection"
+# frozen_string_literal: true
+
+module Glossarist
+  module Collections
+    autoload :AssetCollection,               "glossarist/collections/asset_collection"
+    autoload :BibliographyCollection,        "glossarist/collections/bibliography_collection"
+    autoload :Collection,                    "glossarist/collections/collection"
+    autoload :ConceptSourceCollection,       "glossarist/collections/concept_source_collection"
+    autoload :DesignationCollection,         "glossarist/collections/designation_collection"
+    autoload :DetailedDefinitionCollection,  "glossarist/collections/detailed_definition_collection"
+    autoload :LocalizationCollection,        "glossarist/collections/localization_collection"
+    autoload :TypedCollection,               "glossarist/collections/typed_collection"
+  end
+end

data/lib/glossarist/concept_data.rb

@@ -3,16 +3,21 @@ module Glossarist
     include Glossarist::Utilities::CommonFunctions
 
     attribute :dates, ConceptDate, collection: true
-    attribute :definition, DetailedDefinition, collection: true,
-                                               initialize_empty: true
-    attribute :examples, DetailedDefinition, collection: true,
-                                             initialize_empty: true
+    attribute :definition, DetailedDefinition,
+              collection: Collections::DetailedDefinitionCollection,
+              initialize_empty: true
+    attribute :examples, DetailedDefinition,
+              collection: Collections::DetailedDefinitionCollection,
+              initialize_empty: true
     attribute :id, :string
     attribute :lineage_source_similarity, :integer
-    attribute :notes, DetailedDefinition, collection: true,
-                                          initialize_empty: true
+    attribute :notes, DetailedDefinition,
+              collection: Collections::DetailedDefinitionCollection,
+              initialize_empty: true
     attribute :release, :string
-    attribute :sources, ConceptSource, collection: true
+    attribute :sources, ConceptSource,
+              collection: Collections::ConceptSourceCollection,
+              initialize_empty: true
     attribute :terms, Designation::Base, collection: true
     attribute :related, RelatedConcept, collection: true
     attribute :domain, :string

data/lib/glossarist/concept_manager.rb

@@ -48,7 +48,7 @@ module Glossarist
     end
 
     def load_concept_from_file(filename)
-      mixed_hashes = YAML.load_stream(File.read(filename))
+      mixed_hashes = YAML.load_stream(File.read(filename, encoding: "utf-8"))
       concepts = []
 
       concept_hashes, localized_concept_hashes =
@@ -78,7 +78,7 @@ module Glossarist
 
       concept_hash = if localized_concept_hashes.empty?
                        Psych.safe_load(
-                         File.read(localized_concept_path(id)),
+                         File.read(localized_concept_path(id), encoding: "utf-8"),
                          permitted_classes: [Date, Time],
                        )
                      else
@@ -103,11 +103,11 @@ module Glossarist
       FileUtils.mkdir_p(localized_concept_dir)
 
       filename = File.join(concept_dir, "#{concept.uuid}.yaml")
-      File.write(filename, concept.to_yaml)
+      File.write(filename, concept.to_yaml, encoding: "utf-8")
 
       concept.localized_concepts.each do |lang, uuid|
         filename = File.join(localized_concept_dir, "#{uuid}.yaml")
-        File.write(filename, concept.localization(lang).to_yaml)
+        File.write(filename, concept.localization(lang).to_yaml, encoding: "utf-8")
       end
     end
 
@@ -126,7 +126,7 @@ module Glossarist
         content << concept.localization(lang).to_yaml
       end
 
-      File.write(filename, content.join("\n"))
+      File.write(filename, content.join("\n"), encoding: "utf-8")
     end
 
     def concepts_glob

data/lib/glossarist/designation.rb

@@ -1,18 +1,15 @@
 # frozen_string_literal: true
 
-# (c) Copyright 2021 Ribose Inc.
-#
-
-require_relative "designation/base"
-require_relative "designation/expression"
-require_relative "designation/abbreviation"
-require_relative "designation/grammar_info"
-require_relative "designation/symbol"
-require_relative "designation/graphical_symbol"
-require_relative "designation/letter_symbol"
-
 module Glossarist
   module Designation
+    autoload :Base,              "glossarist/designation/base"
+    autoload :Expression,        "glossarist/designation/expression"
+    autoload :Abbreviation,      "glossarist/designation/abbreviation"
+    autoload :GrammarInfo,       "glossarist/designation/grammar_info"
+    autoload :Symbol,            "glossarist/designation/symbol"
+    autoload :GraphicalSymbol,   "glossarist/designation/graphical_symbol"
+    autoload :LetterSymbol,      "glossarist/designation/letter_symbol"
+
     # Bi-directional class-to-string mapping for STI-like serialization.
     SERIALIZED_TYPES = {
       Expression => "expression",

data/lib/glossarist/error.rb

@@ -1,9 +1,6 @@
+# frozen_string_literal: true
+
 module Glossarist
   class Error < StandardError
   end
 end
-
-require_relative "error/invalid_type_error"
-require_relative "error/invalid_language_code_error"
-require_relative "error/parse_error"
-require_relative "error/cache_version_mismatch_error"

data/lib/glossarist/managed_concept_data.rb

@@ -6,7 +6,9 @@ module Glossarist
     attribute :localized_concepts, :hash
     attribute :groups, :string, collection: true
     attribute :sources, ConceptSource, collection: true
-    attribute :localizations, :hash, collection: true, default: -> { {} }
+    attribute :localizations, LocalizedConcept,
+              collection: Collections::LocalizationCollection,
+              initialize_empty: true
 
     yaml do
       map %i[id identifier], to: :id,
@@ -28,11 +30,9 @@ module Glossarist
     end
 
     def localizations_from_yaml(model, value)
-      model.localizations ||= {}
-
       value.each do |localized_concept_hash|
         localized_concept = Glossarist::LocalizedConcept.of_yaml(localized_concept_hash)
-        model.localizations[localized_concept.language_code] = localized_concept
+        model.localizations.store(localized_concept.language_code, localized_concept)
       end
     end
 

data/lib/glossarist/utilities.rb

@@ -1,4 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "utilities/common_functions"
-require_relative "utilities/uuid"
+module Glossarist
+  module Utilities
+    autoload :CommonFunctions, "glossarist/utilities/common_functions"
+    autoload :UUID,            "glossarist/utilities/uuid"
+  end
+end

data/lib/glossarist/version.rb

@@ -4,5 +4,5 @@
 #
 
 module Glossarist
-  VERSION = "2.3.12"
+  VERSION = "2.5.0"
 end

data/lib/glossarist.rb

@@ -7,35 +7,40 @@ require "psych"
 require "thor"
 require "lutaml/model"
 
-require_relative "glossarist/utilities"
-require_relative "glossarist/version"
 require_relative "glossarist/glossary_definition"
 
-require_relative "glossarist/designation"
-require_relative "glossarist/asset"
-require_relative "glossarist/locality"
-require_relative "glossarist/custom_locality"
-require_relative "glossarist/citation"
-require_relative "glossarist/collection"
-require_relative "glossarist/concept_date"
-require_relative "glossarist/concept_manager"
-require_relative "glossarist/concept_set"
-require_relative "glossarist/concept_source"
-require_relative "glossarist/detailed_definition"
-require_relative "glossarist/related_concept"
-require_relative "glossarist/concept_data"
-require_relative "glossarist/concept"
-require_relative "glossarist/localized_concept"
-require_relative "glossarist/managed_concept_data"
-require_relative "glossarist/managed_concept"
-require_relative "glossarist/managed_concept_collection"
-require_relative "glossarist/non_verb_rep"
+module Glossarist
+  autoload :Asset,                    "glossarist/asset"
+  autoload :Citation,                 "glossarist/citation"
+  autoload :Collection,               "glossarist/collection"
+  autoload :Concept,                  "glossarist/concept"
+  autoload :ConceptData,              "glossarist/concept_data"
+  autoload :ConceptDate,              "glossarist/concept_date"
+  autoload :ConceptManager,           "glossarist/concept_manager"
+  autoload :ConceptSet,               "glossarist/concept_set"
+  autoload :ConceptSource,            "glossarist/concept_source"
+  autoload :Config,                   "glossarist/config"
+  autoload :CustomLocality,           "glossarist/custom_locality"
+  autoload :DetailedDefinition,       "glossarist/detailed_definition"
+  autoload :Designation,              "glossarist/designation"
+  autoload :Error,                    "glossarist/error"
+  autoload :InvalidTypeError,         "glossarist/error/invalid_type_error"
+  autoload :InvalidLanguageCodeError, "glossarist/error/invalid_language_code_error"
+  autoload :ParseError,               "glossarist/error/parse_error"
+  autoload :CacheVersionMismatchError, "glossarist/error/cache_version_mismatch_error"
+  autoload :Locality,                 "glossarist/locality"
+  autoload :LocalizedConcept,         "glossarist/localized_concept"
+  autoload :ManagedConcept,           "glossarist/managed_concept"
+  autoload :ManagedConceptCollection, "glossarist/managed_concept_collection"
+  autoload :ManagedConceptData,       "glossarist/managed_concept_data"
+  autoload :NonVerbRep,               "glossarist/non_verb_rep"
+  autoload :RelatedConcept,           "glossarist/related_concept"
+  autoload :Utilities,                "glossarist/utilities"
+end
 
+require_relative "glossarist/version"
 require_relative "glossarist/collections"
 
-require_relative "glossarist/config"
-require_relative "glossarist/error"
-
 module Glossarist
   def self.configure
     config = Glossarist::Config.instance

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glossarist
 version: !ruby/object:Gem::Version
-  version: 2.3.12
+  version: 2.5.0
 platform: ruby
 authors:
 - Ribose
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-04-06 00:00:00.000000000 Z
+date: 2026-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lutaml-model
@@ -16,28 +16,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: relaton
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.19'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -68,6 +74,7 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- CLAUDE.md
 - Gemfile
 - LICENSE.txt
 - README.adoc
@@ -83,7 +90,11 @@ files:
 - lib/glossarist/collections/asset_collection.rb
 - lib/glossarist/collections/bibliography_collection.rb
 - lib/glossarist/collections/collection.rb
+- lib/glossarist/collections/concept_source_collection.rb
 - lib/glossarist/collections/designation_collection.rb
+- lib/glossarist/collections/detailed_definition_collection.rb
+- lib/glossarist/collections/localization_collection.rb
+- lib/glossarist/collections/typed_collection.rb
 - lib/glossarist/concept.rb
 - lib/glossarist/concept_data.rb
 - lib/glossarist/concept_date.rb