relaton-bib 2.1.4 → 2.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5fed587d3ea43b2fdba3f26039e44b076eea06413c7d44c815c44054bc2006a
-  data.tar.gz: 1ce1ef4de4d2cc010e899971a247bba869ec67f588423dcd5e1e9d44beb36932
+  metadata.gz: 9c31cacb170e9441c45a4103838d25c58057e82a24e8b83c4f889f2999968fe3
+  data.tar.gz: 28856ec2709501d82efa918a127ec23a9742bdd9e610597707367983433df7d9
 SHA512:
-  metadata.gz: 10279cf57d50ddb7e0339815be6edbc74ebc8568ffae16e2ca75f802939d3027639615fe117f060dc5985d0e3b074d021a4aa8a2a73745c6dd8aac7f71928f6c
-  data.tar.gz: a53c8ca8225e43038fab4dc8c39dde6871e8fffdbe1bbc3816a47379dbf79f5033c4a8b5cb2eaefa5aba6529714f289507160c19e0fc70e54541ce18fbe53fae
+  metadata.gz: adc75a6f70d8fc625b51e5015f903728c00ca72b9301187cd58133f0a0088e31f908cbc8d4f28292964093aeb12506d107575474d6e9b273543c2354e175c167
+  data.tar.gz: 509bb3955d8313ef5cd56fbfefa6d151b2002535fefabae6b3926f9ff05aaa22ea0e87802d9ab8d08a108b252e0b2d8483a5c90a72c78cf391a8a3bdfbf922f5

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

@@ -26,7 +26,7 @@ jobs:
 
     - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: '3.2'
+        ruby-version: '3.3'
         bundler-cache: true
 
     - uses: actions/checkout@v3

data/CLAUDE.md

@@ -37,6 +37,18 @@ bin/console
 
 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.

data/lib/relaton/bib/model/bibdata.rb

@@ -1,5 +1,3 @@
-require_relative "bibdata_shared"
-
 module Relaton
   module Bib
     # Bibliographic item serialized as <bibdata>. Has ext, no id.

data/lib/relaton/bib/model/bibdata_shared.rb

@@ -1,5 +1,3 @@
-require_relative "item_shared"
-
 module Relaton
   module Bib
     module BibdataShared

data/lib/relaton/bib/model/bibitem.rb

@@ -1,5 +1,3 @@
-require_relative "bibitem_shared"
-
 module Relaton
   module Bib
     # Bibliographic item serialized as <bibitem>. Has id, no ext.

data/lib/relaton/bib/model/bibitem_shared.rb

@@ -1,5 +1,3 @@
-require_relative "item_shared"
-
 module Relaton
   module Bib
     module BibitemShared

data/lib/relaton/bib/model/contact.rb

@@ -1,7 +1,3 @@
-require_relative "address"
-require_relative "phone"
-require_relative "uri"
-
 module Relaton
   module Bib
     module Contact

data/lib/relaton/bib/model/date.rb

@@ -1,5 +1,3 @@
-require_relative "type/string_date"
-
 module Relaton
   module Bib
     class Date < Lutaml::Model::Serializable

data/lib/relaton/bib/model/ext.rb

@@ -1,7 +1,3 @@
-require_relative "doctype"
-require_relative "ics"
-require_relative "structured_identifier"
-
 module Relaton
   module Bib
     class Ext < Lutaml::Model::Serializable

data/lib/relaton/bib/model/item.rb

@@ -1,53 +1,8 @@
-require "lutaml/model"
-require "lutaml/xml"
-require_relative "localized_string_attrs"
-require_relative "localized_string"
-require_relative "formattedref"
-require_relative "abstract"
-require_relative "date"
-require_relative "locality"
-require_relative "locality_stack"
-require_relative "image"
-require_relative "title"
-require_relative "docidentifier"
-require_relative "note"
-require_relative "full_name_type"
-require_relative "fullname"
-require_relative "contact"
-require_relative "logo"
-require_relative "organization"
-require_relative "affiliation"
-require_relative "person"
-require_relative "contribution_info"
-require_relative "contributor"
-require_relative "edition"
-require_relative "version"
-require_relative "status"
-require_relative "copyright"
-require_relative "place"
-require_relative "series"
-require_relative "medium"
-require_relative "uri"
-require_relative "price"
-require_relative "extent"
-require_relative "size"
-require_relative "keyword"
-require_relative "validity"
-require_relative "depiction"
-require_relative "source_locality_stack"
-require_relative "ext"
-require_relative "item_shared"
-require_relative "type/plain_date"
-
-Lutaml::Model::Config.configure do |config|
-  config.xml_adapter_type = :nokogiri
-end
-
+# Model classes are wired via autoload (see model_autoload.rb); the lutaml
+# requires and XML adapter configuration live there so they run eagerly,
+# independent of which model class is referenced first.
 module Relaton
   module Bib
-    class Relation < Lutaml::Model::Serializable
-    end
-
     # Item class repesents bibliographic item metadata.
     # Used for YAML/JSON parsing and as the XML dispatch entry point.
     class Item < Lutaml::Model::Serializable

data/lib/relaton/bib/model/organization.rb

@@ -1,5 +1,3 @@
-require_relative "organization_type"
-
 module Relaton
   module Bib
     class Organization < Lutaml::Model::Serializable

data/lib/relaton/bib/model/organization_type.rb

@@ -13,8 +13,6 @@ module Relaton
       end
 
       def self.included(base) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
-        require_relative "subdivision"
-
         base.instance_eval do
           include Contact
 

data/lib/relaton/bib/model/relation.rb

@@ -1,8 +1,6 @@
-require_relative "item_base"
-
 module Relaton
   module Bib
-    class Relation
+    class Relation < Lutaml::Model::Serializable
       attribute :type, :string, values: %w[
         includes includedIn hasPart partOf merges mergedInto splits splitInto
         instanceOf hasInstance exemplarOf hasExemplar manifestationOf

data/lib/relaton/bib/model/series.rb

@@ -1,5 +1,3 @@
-require_relative "type/string_date"
-
 module Relaton
   module Bib
     class Series < Lutaml::Model::Serializable

data/lib/relaton/bib/model_autoload.rb

@@ -0,0 +1,85 @@
+# Central autoload manifest for the model + converter layer.
+#
+# Declaring these as autoloads (instead of a require_relative chain) makes load
+# order irrelevant and removes the circular require between OrganizationType and
+# Subdivision (issue #120): a constant is loaded on first reference rather than
+# at file-load time, so mutually-referencing classes resolve each other lazily.
+#
+# lutaml-model must be available before the first model autoload fires, and the
+# XML adapter must be configured eagerly here (not inside item.rb) so that
+# serializing through any model class works regardless of which one is
+# referenced first.
+require "lutaml/model"
+require "lutaml/xml"
+
+Lutaml::Model::Config.configure do |config|
+  config.xml_adapter_type = :nokogiri
+end
+
+module Relaton
+  module Bib
+    autoload :Abstract, "relaton/bib/model/abstract"
+    autoload :Address, "relaton/bib/model/address"
+    autoload :Affiliation, "relaton/bib/model/affiliation"
+    autoload :Bibdata, "relaton/bib/model/bibdata"
+    autoload :BibdataShared, "relaton/bib/model/bibdata_shared"
+    autoload :Bibitem, "relaton/bib/model/bibitem"
+    autoload :BibitemShared, "relaton/bib/model/bibitem_shared"
+    autoload :Contact, "relaton/bib/model/contact"
+    autoload :ContributionInfo, "relaton/bib/model/contribution_info"
+    autoload :Contributor, "relaton/bib/model/contributor"
+    autoload :Copyright, "relaton/bib/model/copyright"
+    autoload :Date, "relaton/bib/model/date"
+    autoload :Depiction, "relaton/bib/model/depiction"
+    autoload :Docidentifier, "relaton/bib/model/docidentifier"
+    autoload :Doctype, "relaton/bib/model/doctype"
+    autoload :Edition, "relaton/bib/model/edition"
+    autoload :Ext, "relaton/bib/model/ext"
+    autoload :Extent, "relaton/bib/model/extent"
+    autoload :Formattedref, "relaton/bib/model/formattedref"
+    autoload :FullName, "relaton/bib/model/fullname"
+    autoload :FullNameType, "relaton/bib/model/full_name_type"
+    autoload :ICS, "relaton/bib/model/ics"
+    autoload :Image, "relaton/bib/model/image"
+    autoload :Item, "relaton/bib/model/item"
+    autoload :ItemBase, "relaton/bib/model/item_base"
+    autoload :ItemShared, "relaton/bib/model/item_shared"
+    autoload :Keyword, "relaton/bib/model/keyword"
+    autoload :Locality, "relaton/bib/model/locality"
+    autoload :LocalityStack, "relaton/bib/model/locality_stack"
+    # localized_string.rb defines three top-level constants:
+    autoload :LocalizedString, "relaton/bib/model/localized_string"
+    autoload :TypedLocalizedString, "relaton/bib/model/localized_string"
+    autoload :LocalizedMarkedUpString, "relaton/bib/model/localized_string"
+    autoload :LocalizedStringAttrs, "relaton/bib/model/localized_string_attrs"
+    autoload :Logo, "relaton/bib/model/logo"
+    autoload :Medium, "relaton/bib/model/medium"
+    autoload :Note, "relaton/bib/model/note"
+    autoload :Organization, "relaton/bib/model/organization"
+    autoload :OrganizationType, "relaton/bib/model/organization_type"
+    autoload :Person, "relaton/bib/model/person"
+    autoload :Phone, "relaton/bib/model/phone"
+    autoload :Place, "relaton/bib/model/place"
+    # type/ is only a directory; these constants are top-level under Bib:
+    autoload :PlainDate, "relaton/bib/model/type/plain_date"
+    autoload :StringDate, "relaton/bib/model/type/string_date"
+    autoload :Price, "relaton/bib/model/price"
+    autoload :Relation, "relaton/bib/model/relation"
+    autoload :Series, "relaton/bib/model/series"
+    autoload :Size, "relaton/bib/model/size"
+    autoload :SourceLocalityStack, "relaton/bib/model/source_locality_stack"
+    autoload :Status, "relaton/bib/model/status"
+    autoload :StructuredIdentifier, "relaton/bib/model/structured_identifier"
+    autoload :Subdivision, "relaton/bib/model/subdivision"
+    autoload :Title, "relaton/bib/model/title"
+    autoload :Uri, "relaton/bib/model/uri"
+    autoload :Validity, "relaton/bib/model/validity"
+    autoload :Version, "relaton/bib/model/version"
+
+    module Converter
+      autoload :BibXml, "relaton/bib/converter/bibxml"
+      autoload :Bibtex, "relaton/bib/converter/bibtex"
+      autoload :Asciibib, "relaton/bib/converter/asciibib"
+    end
+  end
+end

data/lib/relaton/bib/sanitizer.rb

@@ -12,12 +12,24 @@ module Relaton
     # consumers — notably relaton-render's own inline-tag allow-list —
     # already accept <fn> as a legitimate child of <title>. Stripping it
     # here would break the round-trip.
+    #
+    # OPAQUE elements (currently <stem>) are also allowed, but the
+    # sanitiser does not descend into them: their contents are out-of-band
+    # inline notation (MathML, AsciiMath, LaTeX) rather than basicdoc
+    # markup, and must be preserved verbatim. Without the opaque-skip,
+    # the recursive walk would unwrap MathML / AsciiMath elements down to
+    # bare text nodes — see #116 for the round-trip-loss symptom.
     module Sanitizer
       ALLOWED = %w[
         em strong sub sup tt underline strike smallcap br stem
         p eref xref fn
       ].freeze
 
+      # Elements whose children are non-basicdoc inline notation
+      # (MathML, AsciiMath, LaTeX, …) and must be preserved verbatim
+      # rather than sanitised against ALLOWED.
+      OPAQUE = %w[stem].freeze
+
       RENAME = {
         "italic" => "em",
       }.freeze
@@ -44,6 +56,8 @@ module Relaton
           next unless child.element?
 
           child.name = RENAME[child.name] if RENAME.key?(child.name)
+          next if OPAQUE.include?(child.name)
+
           sanitize_children(child)
           child.replace(child.children) unless ALLOWED.include?(child.name)
         end

data/lib/relaton/bib/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Bib
-    VERSION = "2.1.4".freeze
+    VERSION = "2.1.6".freeze
   end
 end

data/lib/relaton/bib.rb

@@ -9,17 +9,10 @@ require_relative "bib/version"
 require_relative "bib/util"
 require_relative "bib/sanitizer"
 require_relative "bib/namespace_helper"
+# Model and converter classes are wired via autoload (see model_autoload.rb) so
+# that load order is irrelevant and mutually-referencing classes resolve lazily.
+require_relative "bib/model_autoload"
 require_relative "bib/item_data"
-require_relative "bib/model/item"
-require_relative "bib/model/item_base"
-require_relative "bib/model/bibitem_shared"
-require_relative "bib/model/bibdata_shared"
-require_relative "bib/model/bibitem"
-require_relative "bib/model/bibdata"
-require_relative "bib/converter/bibxml"
-require_relative "bib/converter/bibtex"
-require_relative "bib/converter/asciibib"
-require_relative "bib/model/relation"
 
 module Relaton
   # class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bib
 version: !ruby/object:Gem::Version
-  version: 2.1.4
+  version: 2.1.6
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-06-02 00:00:00.000000000 Z
+date: 2026-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bibtex-ruby
@@ -226,6 +226,7 @@ files:
 - lib/relaton/bib/model/uri.rb
 - lib/relaton/bib/model/validity.rb
 - lib/relaton/bib/model/version.rb
+- lib/relaton/bib/model_autoload.rb
 - lib/relaton/bib/namespace_helper.rb
 - lib/relaton/bib/sanitizer.rb
 - lib/relaton/bib/util.rb