relaton-bib 2.0.0 → 2.1.7

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

@@ -0,0 +1,88 @@
+module Relaton
+  module Bib
+    # Shared attribute and XML mapping declarations for Item/Bibitem/Bibdata/ItemBase.
+    # Each class composes these with its own header (id/schema_version/fetched/ext)
+    # via instance_exec, so subtractive monkey-patching of inherited mappings is
+    # not needed.
+    module ItemShared
+      ATTRIBUTES = lambda do # rubocop:disable Metrics/BlockLength
+        attribute :type, :string, values: %W[
+          article book booklet manual proceedings presentation thesis techreport standard
+          unpublished map electronic\sresource audiovisual film video boradcast software
+          graphic_work music patent inbook incollection inproceedings journal website
+          webresource dataset archival social_media alert message convesation misc
+        ]
+        attribute :formattedref, Formattedref
+        attribute :title, Title, collection: true, initialize_empty: true
+        attribute :source, Uri, collection: true, initialize_empty: true
+        attribute :docidentifier, Docidentifier, collection: true, initialize_empty: true
+        attribute :docnumber, :string
+        attribute :date, Date, collection: true, initialize_empty: true
+        attribute :contributor, Contributor, collection: true, initialize_empty: true
+        attribute :edition, Edition
+        attribute :version, Version, collection: true, initialize_empty: true
+        attribute :note, Note, collection: true, initialize_empty: true
+        attribute :language, :string, collection: true, initialize_empty: true
+        attribute :locale, :string, collection: true, initialize_empty: true
+        attribute :script, :string, collection: true, initialize_empty: true
+        attribute :abstract, Abstract, collection: true, initialize_empty: true
+        attribute :status, Status
+        attribute :copyright, Copyright, collection: true, initialize_empty: true
+        attribute :relation, Relation, collection: true, initialize_empty: true
+        attribute :series, Series, collection: true, initialize_empty: true
+        attribute :medium, Medium
+        attribute :place, Place, collection: true, initialize_empty: true
+        attribute :price, Price, collection: true, initialize_empty: true
+        attribute :extent, Extent, collection: true, initialize_empty: true
+        attribute :size, Size
+        attribute :accesslocation, :string, collection: true, initialize_empty: true
+        attribute :license, :string, collection: true, initialize_empty: true
+        attribute :classification, Docidentifier, collection: true, initialize_empty: true
+        attribute :keyword, Keyword, collection: true, initialize_empty: true
+        attribute :validity, Validity
+        attribute :depiction, Depiction, collection: true, initialize_empty: true
+      end
+
+      def self.prune_attribute(base, attr_name, xml_name)
+        return unless base.attributes.key?(attr_name)
+
+        xml_mapping = base.mappings[:xml]
+        xml_mapping.instance_variable_get(:@elements).delete(xml_name)
+        xml_mapping.instance_variable_get(:@attributes).delete(xml_name)
+        base.attributes.delete(attr_name)
+      end
+
+      XML_BODY = lambda do # rubocop:disable Metrics/BlockLength
+        map_element "formattedref", to: :formattedref
+        map_element "title", to: :title
+        map_element "uri", to: :source
+        map_element "docidentifier", to: :docidentifier
+        map_element "docnumber", to: :docnumber
+        map_element "date", to: :date
+        map_element "contributor", to: :contributor
+        map_element "edition", to: :edition
+        map_element "version", to: :version
+        map_element "note", to: :note
+        map_element "language", to: :language
+        map_element "locale", to: :locale
+        map_element "script", to: :script
+        map_element "abstract", to: :abstract
+        map_element "status", to: :status
+        map_element "copyright", to: :copyright
+        map_element "relation", to: :relation
+        map_element "series", to: :series
+        map_element "medium", to: :medium
+        map_element "place", to: :place
+        map_element "price", to: :price
+        map_element "extent", to: :extent
+        map_element "size", to: :size
+        map_element "accesslocation", to: :accesslocation
+        map_element "license", to: :license
+        map_element "classification", to: :classification
+        map_element "keyword", to: :keyword
+        map_element "validity", to: :validity
+        map_element "depiction", to: :depiction
+      end
+    end
+  end
+end

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

@@ -8,7 +8,7 @@ module Relaton
       end
 
       key_value do
-        map "content", to: :content # , with: { from: :content_from_key_value, to: :content_to_key_value }
+        map "content", to: :content
         map "language", to: :language
       end
     end
@@ -26,32 +26,23 @@ module Relaton
     end
 
     class LocalizedMarkedUpString < LocalizedStringAttrs
-      attribute :content, :string
+      module ContentSanitization
+        def content=(value)
+          super(Relaton::Bib::Sanitizer.sanitize(value))
+        end
+      end
+
+      attribute :content, :string, raw: true
+      prepend ContentSanitization
 
       xml do
-        map_all to: :content, with: { from: :content_from_xml, to: :content_to_xml }
+        map_all to: :content
       end
 
       key_value do
-        map "content", to: :content, with: { from: :content_from_key_value, to: :content_to_key_value }
+        map "content", to: :content
         map "language", to: :language
       end
-
-      def content_from_xml(model, value)
-        model.content = value
-      end
-
-      def content_to_xml(model, parent, doc)
-        doc.add_xml_fragment parent, model.content
-      end
-
-      def content_from_key_value(model, value)
-        model.content = value
-      end
-
-      def content_to_key_value(model, doc)
-        doc["content"] = model.content
-      end
     end
   end
 end

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/type/plain_date.rb

@@ -0,0 +1,16 @@
+require "date"
+
+module Relaton
+  module Bib
+    # xs:date value type that always casts to ::Date, dropping any time and
+    # timezone component. Without this, lutaml-model's built-in Date type
+    # promotes inputs like "2018-04-15T00:00:00Z" to ::DateTime and serializes
+    # them back as "2018-04-15Z" — valid xs:date, but not valid ISO 8601.
+    class PlainDate < Lutaml::Model::Type::Date
+      def self.cast(value, options = {})
+        result = super
+        result.is_a?(::DateTime) ? result.to_date : result
+      end
+    end
+  end
+end

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

@@ -1,14 +1,43 @@
 module Relaton
   module Bib
     class Version < Lutaml::Model::Serializable
-      attribute :revision_date, :date
+      attribute :type, :string
+      attribute :content, :string
+      attribute :revision_date, :string
       attribute :draft, :string
 
       xml do
         root "version"
+        map_attribute "type", to: :type
+        map_content to: :content
         map_element "revision-date", to: :revision_date
         map_element "draft", to: :draft
       end
+
+      key_value do
+        map "type", to: :type
+        map "content", to: :content
+        map "revision_date", to: :revision_date
+        map "draft", to: :draft
+      end
+
+      def content
+        return @content if @content && !@content.empty?
+
+        parts = [@draft, @revision_date].compact
+        case parts.size
+        when 2 then "#{@draft} (#{@revision_date})"
+        when 1 then parts.first
+        end
+      end
+
+      def revision_date
+        nil
+      end
+
+      def draft
+        nil
+      end
     end
   end
 end

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

@@ -0,0 +1,74 @@
+require "nokogiri"
+
+module Relaton
+  module Bib
+    # Strips inline markup not in the basicdoc PureTextElement set
+    # (plus <p>, <eref>, <xref>, <fn>, <link>) from raw marked-up content
+    # strings. Disallowed elements are unwrapped: tags removed, inner text
+    # kept.
+    #
+    # <link> is admitted because basicdoc expresses external hyperlinks as
+    # <link target="...">; without it a from_xml -> to_xml round-trip drops
+    # the tag and its target URL, keeping only the link text (see #122,
+    # which broke metanorma amend()).
+    #
+    # <fn> is admitted beyond strict PureTextElement because bibliographic
+    # titles in real Metanorma input routinely carry footnotes (e.g. ISO
+    # standards titles with a disclaimer footnote), and downstream
+    # 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 link
+      ].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
+
+      TAG_RX = %r{<[a-zA-Z/!?]}
+
+      def self.sanitize(content)
+        return content unless sanitizable?(content)
+
+        fragment = Nokogiri::XML::DocumentFragment.parse(content)
+        return content if fragment.errors.any?
+
+        sanitize_children(fragment)
+        fragment.children.map { |c| c.to_xml(encoding: "UTF-8") }.join
+      end
+
+      def self.sanitizable?(content)
+        content.is_a?(::String) && !content.empty? && content.match?(TAG_RX)
+      end
+      private_class_method :sanitizable?
+
+      def self.sanitize_children(node)
+        node.children.to_a.each do |child|
+          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
+      end
+      private_class_method :sanitize_children
+    end
+  end
+end

data/lib/relaton/bib/version.rb

@@ -1,5 +1,5 @@
 module Relaton
   module Bib
-    VERSION = "2.0.0".freeze
+    VERSION = "2.1.7".freeze
   end
 end

data/{grammars → lib/relaton/bib}/versions.json

@@ -31,5 +31,5 @@
 "relaton-model-ccsds": "",
 "relaton-model-un": "v1.0.2",
 "metanorma-model": "v2.1.6",
-"date": "2026-04-03T02:05:43Z"
+"date": "2026-04-30T03:49:24Z"
 }

data/lib/relaton/bib.rb

@@ -7,16 +7,12 @@ require "rfcxml"
 require "relaton/core"
 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"
-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
@@ -30,7 +26,7 @@ module Relaton
     # @return [Hash{String=>String}] schema versions
     #
     def schema_versions
-      @@schema_versions ||= JSON.parse File.read(File.join(__dir__, "../../grammars/versions.json"))
+      @@schema_versions ||= JSON.parse File.read(File.join(__dir__, "bib/versions.json"))
     end
   end
 

data/relaton-bib.gemspec

@@ -26,10 +26,10 @@ Gem::Specification.new do |spec|
   spec.add_dependency "bibtex-ruby"
   spec.add_dependency "iso639"
   spec.add_dependency "isoics", "~> 0.1.0"
-  spec.add_dependency "lutaml-model", "~> 0.7"
+  spec.add_dependency "lutaml-model", "~> 0.8.0"
   spec.add_dependency "nokogiri", ">= 1.16"
   spec.add_dependency "psych", "~> 5.2.0" # versin 5.3.0 crashes
   spec.add_dependency "relaton-core", "~> 0.0.8"
   spec.add_dependency "relaton-logger", "~> 0.2.0"
-  spec.add_dependency "rfcxml", "~> 0.2.1"
+  spec.add_dependency "rfcxml", "~> 0.4.3"
 end

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relaton-bib
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.7
 platform: ruby
 authors:
 - Ribose Inc.
+autorequire:
 bindir: exe
 cert_chain: []
-date: 1980-01-02 00:00:00.000000000 Z
+date: 2026-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bibtex-ruby
@@ -57,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -127,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.4.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.4.3
 description: 'Relaton::Bib: Ruby XMLDOC impementation.'
 email:
 - open.source@ribose.com
@@ -159,11 +160,6 @@ files:
 - bin/rspec
 - bin/setup
 - docs/hash.adoc
-- grammars/basicdoc.rng
-- grammars/biblio-compile.rng
-- grammars/biblio-standoc.rng
-- grammars/biblio.rng
-- grammars/versions.json
 - lib/relaton/bib.rb
 - lib/relaton/bib/converter/asciibib.rb
 - lib/relaton/bib/converter/asciibib/to_asciibib.rb
@@ -181,7 +177,9 @@ files:
 - lib/relaton/bib/model/address.rb
 - lib/relaton/bib/model/affiliation.rb
 - lib/relaton/bib/model/bibdata.rb
+- lib/relaton/bib/model/bibdata_shared.rb
 - lib/relaton/bib/model/bibitem.rb
+- lib/relaton/bib/model/bibitem_shared.rb
 - lib/relaton/bib/model/contact.rb
 - lib/relaton/bib/model/contribution_info.rb
 - lib/relaton/bib/model/contributor.rb
@@ -200,6 +198,7 @@ files:
 - lib/relaton/bib/model/image.rb
 - lib/relaton/bib/model/item.rb
 - lib/relaton/bib/model/item_base.rb
+- lib/relaton/bib/model/item_shared.rb
 - lib/relaton/bib/model/keyword.rb
 - lib/relaton/bib/model/locality.rb
 - lib/relaton/bib/model/locality_stack.rb
@@ -222,18 +221,23 @@ files:
 - lib/relaton/bib/model/structured_identifier.rb
 - lib/relaton/bib/model/subdivision.rb
 - lib/relaton/bib/model/title.rb
+- lib/relaton/bib/model/type/plain_date.rb
 - lib/relaton/bib/model/type/string_date.rb
 - 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
 - lib/relaton/bib/version.rb
+- lib/relaton/bib/versions.json
 - relaton-bib.gemspec
 homepage: https://github.com/relaton/relaton-bib
 licenses:
 - BSD-2-Clause
 metadata: {}
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -248,7 +252,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: 'Relaton::Bib: Ruby XMLDOC impementation.'
 test_files: []