mml 2.4.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06746c57ed678055de388f7762532af6ee4b2c5384357d02bfe5e70b171bc978
-  data.tar.gz: cb6e5039fa287dc23cec0deb104c6f11b2916c0862d12accda17a62211adcc8c
+  metadata.gz: 753f58cf7a8516296624dc7eb472621cd4ecaab7a7d1c3f34d7e8d67eff9bbce
+  data.tar.gz: 062164c14aa4475421fc48ca37de907be75938d8b574a768cc8e8e374bd91252
 SHA512:
-  metadata.gz: 6f323d41ded39d4f7098684c0be92c63b40fc74fa807eda838800015503760a73e08bfa4bd9601ab4a9087301f01a57b9b96376c3c3663c37cb5cee0fdd457c1
-  data.tar.gz: de5b3d389ea005d3738933e0074f0400408e6be04ff86d058a17fd9bd705bd822b4f7e1cab93ef846542a6030681535c1570b9082a87b42ab1e780aefe9f04c2
+  metadata.gz: b43c4d0bd97523c911860ff881eb7375ae9755ac5755985408c27c4aa43246d57cd4b26d7a8bb00c8e5020ee1b9cf9d331f49a6e3a5524957f36469d3c5b9549
+  data.tar.gz: 5d93d2e051d43efb46e83e36bc5464339020e73742183369e6b45813cf3fcd90203c3d3440768c8259f0e174c6435b20863a994debf4417f30308391c9df2e90

data/CLAUDE.md

@@ -95,9 +95,15 @@ end
 
 A `no_root` Lutaml model imported into container elements via `import_model`. It dynamically creates `#{tag}_value` attributes for each tag in `Configuration::SUPPORTED_TAGS`. Classes that receive it are listed in `Configuration::COMMON_ATTRIBUTES_CLASSES`.
 
-### Per-file registration
+### Version module body registration
 
-Each `lib/mml/v{2,3,4}/<tag>.rb` ends with `Configuration.register_model(Klass, id: :tag)` so the type is registered as soon as the file is loaded (eager via `require_relative` at the bottom of each version file).
+Each `lib/mml/v{2,3,4}.rb` declares `autoload :Klass, "mml/v{2,3,4}/klass"` for every element class, then calls `Configuration.register_model(Klass, id: :tag)` in the module body. The register_model call triggers autoload on first reference, preserving eager-registration semantics while using Ruby autoload (no `require_relative` for internal code).
+
+Per-element files (e.g. `lib/mml/v3/math.rb`) define only the class — they no longer call `register_model` themselves. The version module is the single source of truth for registration.
+
+For grouped files (e.g. `lib/mml/v3/arith.rb` defines 22 classes), each class has its own `autoload` entry pointing at the shared file.
+
+`spec/mml/code_quality_spec.rb` enforces the lint rules and verifies every expected element ID is registered in its version's context.
 
 **Namespace:** All versions use the same URI (`http://www.w3.org/1998/Math/MathML`) — MathML 4 chose backward compatibility over a new namespace.
 

data/TODO.complete/1-v3-autoload.md

@@ -0,0 +1,63 @@
+# TODO 1 — Migrate `lib/mml/v3.rb` from `require_relative` to `autoload`
+
+## Why
+Global rule: never use `require_relative` for code inside our own library.
+Use Ruby `autoload` declared in the immediate parent namespace's file
+(`lib/mml/v3.rb`). `lib/mml/v4.rb` already follows this pattern; V3 should
+match it for consistency (MECE/SSOT).
+
+## Scope
+- `lib/mml/v3.rb` — replace every `require_relative "v3/..."` with the
+  corresponding `autoload :Klass, "mml/v3/..."`.
+- Grouped files (e.g. `v3/arith.rb`) contain multiple classes — emit one
+  `autoload` line per class, all pointing at the same file path.
+- Keep the existing `Configuration.register_model(...)` calls in the module
+  body — they trigger autoload on first reference and preserve eager
+  registration behavior.
+- Foundational files (`configuration`, `namespace`, `common_elements`) also
+  switch to `autoload`.
+
+## Class → file map (V3)
+### One-class files (presentation)
+Maction, Maligngroup, Malignmark, Menclose, Merror, Mfenced, Mfrac,
+Mfraction, Mglyph, Mi, Mlabeledtr, Mlongdiv, Mmultiscripts, Mn, Mo, Mover,
+Mpadded, Mphantom, Mprescripts, Mroot, Mrow, Ms, Mscarries, Mscarry,
+Msgroup, Msline, Mspace, Msqrt, Msrow, Mstack, Mstyle, Msub, Msubsup, Msup,
+Mtable, Mtd, Mtext, Mtr, Munder, Munderover, None, Semantics, Math
+
+### One-class files (content)
+Apply, Cbytes, Cerror, Cs, Ci, Cn, Csymbol, AnnotationXml, Annotation,
+Bind, Bvar, Condition, Degree, Interval, Inverse, Lambda, Otherwise, Piece,
+Piecewise, Reln, Sep, Fn, Declare, Share
+
+### Grouped files (multiple classes per file)
+- `v3/arith.rb` → Abs, Conjugate, Arg, Real, Imaginary, Floor, Ceiling,
+  Quotient, Divide, Rem, Minus, Plus, Times, Power, Root, Max, Min, Gcd, Lcm,
+  Sum, Product, Factorial
+- `v3/calculus.rb` → Int, Diff, Partialdiff, Limit, Lowlimit, Uplimit, Tendsto
+- `v3/constants.rb` → Naturalnumbers, Primes, Integers, Rationals, Reals,
+  Complexes, Emptyset, Exponentiale, Imaginaryi, Pi, Eulergamma, Mtrue,
+  Mfalse, Infinity, Notanumber
+- `v3/elementary_functions.rb` → Exp, Ln, Log, Logbase, Sin, Cos, Tan, Sec,
+  Csc, Cot, Arcsin, Arccos, Arctan, Arccot, Arccsc, Arcsec, Sinh, Cosh, Tanh,
+  Sech, Csch, Coth, Arcsinh, Arccosh, Arctanh, Arccoth, Arccsch, Arcsech
+- `v3/functions.rb` → Compose, Domain, Codomain, Image, Ident,
+  Domainofapplication
+- `v3/linear_algebra.rb` → Vector, Matrix, Matrixrow, Determinant, Transpose,
+  Selector, Vectorproduct, Scalarproduct, Outerproduct
+- `v3/logic.rb` → And, Or, Xor, Not, Exists, Forall, Implies
+- `v3/relations.rb` → Eq, Neq, Leq, Lt, Geq, Gt, Equivalent, Approx, Factorof
+- `v3/sets.rb` → Set, Mlist, Union, Intersect, In, Notin, Subset, Prsubset,
+  Notsubset, Notprsubset, Setdiff, Card, Cartesianproduct
+- `v3/statistics.rb` → Mean, Sdev, Variance, Median, Mode, Moment, Momentabout
+- `v3/vector_calculus.rb` → Divergence, Grad, Curl, Laplacian
+- `v3/constructs.rb` → Bvar, Condition, Interval, Lambda, Inverse, Degree,
+  Piecewise, Piece, Otherwise, Sep
+- `v3/deprecated_content.rb` → Fn, Reln, Declare, Share
+
+## Acceptance
+- `grep -rn "require_relative" lib/mml/v3.rb` returns nothing.
+- `bundle exec rspec` passes (2940+ examples, 36 pre-existing pending).
+- `bundle exec rubocop lib/mml/v3.rb` clean.
+- All `Mml::V3::*` constants remain accessible and registered after
+  `require "mml"`.

data/TODO.complete/2-v2-autoload.md

@@ -0,0 +1,46 @@
+# TODO 2 — Migrate `lib/mml/v2.rb` from `require_relative` to `autoload`
+
+## Why
+Same as TODO 1 but for V2. Mirror the V4 pattern.
+
+## Scope
+- Replace every `require_relative "v2/..."` with `autoload :Klass, "mml/v2/..."`.
+- Grouped files have multiple classes per file.
+
+## Class → file map (V2)
+### One-class files (presentation + content)
+Same shape as V3 but in `v2/` directory: Maction, Maligngroup, Malignmark,
+Menclose, Merror, Mfenced, Mfrac, Mfraction, Mglyph, Mi, Mlabeledtr, Mlongdiv,
+Mmultiscripts, Mn, Mo, Mover, Mpadded, Mphantom, Mprescripts, Mroot, Mrow,
+Ms, Mscarries, Mscarry, Msgroup, Msline, Mspace, Msqrt, Msrow, Mstack,
+Mstyle, Msub, Msubsup, Msup, Mtable, Mtd, Mtext, Mtr, Munder, Munderover,
+None, Semantics, Math, Annotation, AnnotationXml, Apply, Bvar, Bind, Ci,
+Cn, Condition, Csymbol, Degree, Fn, Interval, Inverse, Lambda, Otherwise,
+Piece, Piecewise, Reln, Sep
+
+### Grouped files
+- `v2/arith.rb` → Abs, Conjugate, Arg, Real, Imaginary, Floor, Ceiling,
+  Quotient, Divide, Rem, Minus, Plus, Times, Power, Root, Max, Min, Gcd, Lcm,
+  Sum, Product, Factorial
+- `v2/calculus.rb` → Int, Diff, Partialdiff, Limit, Lowlimit, Uplimit, Tendsto
+- `v2/constants.rb` → Naturalnumbers, Primes, Integers, Rationals, Reals,
+  Complexes, Emptyset, Exponentiale, Imaginaryi, Pi, Eulergamma, Mtrue,
+  Mfalse, Infinity, Notanumber
+- `v2/elementary_functions.rb` → Exp, Ln, Log, Logbase, Sin, Cos, Tan, Sec,
+  Csc, Cot, Arcsin, Arccos, Arctan, Arccot, Arccsc, Arcsec, Sinh, Cosh, Tanh,
+  Sech, Csch, Coth, Arcsinh, Arccosh, Arctanh, Arccoth, Arccsch, Arcsech
+- `v2/functions.rb` → Compose, Domain, Codomain, Image, Ident,
+  Domainofapplication
+- `v2/linear_algebra.rb` → Vector, Matrix, Matrixrow, Determinant, Transpose,
+  Selector, Vectorproduct, Scalarproduct, Outerproduct
+- `v2/logic.rb` → And, Or, Xor, Not, Exists, Forall, Implies
+- `v2/relations.rb` → Eq, Neq, Leq, Lt, Geq, Gt, Equivalent, Approx, Factorof
+- `v2/sets.rb` → Set, Mlist, Union, Intersect, In, Notin, Subset, Prsubset,
+  Notsubset, Notprsubset, Setdiff, Card, Cartesianproduct
+- `v2/statistics.rb` → Mean, Sdev, Variance, Median, Mode, Moment, Momentabout
+- `v2/vector_calculus.rb` → Divergence, Grad, Curl, Laplacian
+
+## Acceptance
+- `grep -rn "require_relative" lib/mml/v2.rb` returns nothing.
+- `bundle exec rspec` passes.
+- `bundle exec rubocop lib/mml/v2.rb` clean.

data/TODO.complete/3-no-require-relative.md

@@ -0,0 +1,32 @@
+# TODO 3 — Eliminate remaining `require_relative` in `lib/mml/`
+
+## Why
+After TODO 1 & 2, the only remaining `require_relative` calls in `lib/mml/`
+are:
+- `lib/mml/v2.rb:4`  — `require_relative "versioned_parser"`
+- `lib/mml/v3.rb:4`  — `require_relative "versioned_parser"`
+- `lib/mml/v4.rb:4`  — `require_relative "versioned_parser"`
+- `lib/mml/v{2,3,4}/configuration.rb:3` — `require_relative "../context_configuration"`
+- `lib/mml/v{2,3,4}.rb` top — `require_relative "v{2,3,4}/configuration"`,
+  `"v{2,3,4}/namespace"`, `"v{2,3,4}/common_elements"` (V4 only today, but if
+  V2/V3 also adopt the same pattern during TODO 1/2 they need the same fix).
+
+All of these can be replaced with autoloads declared in `lib/mml.rb` and in
+the version module files.
+
+## Scope
+1. `lib/mml.rb` — add `autoload :VersionedParser, "mml/versioned_parser"`
+   (currently `ContextOptions` and others are autoloaded; `VersionedParser`
+   is missing).
+2. `lib/mml/v{2,3,4}/configuration.rb` — remove the
+   `require_relative "../context_configuration"` line. `Mml::ContextConfiguration`
+   is autoloaded from `lib/mml.rb`, so the `extend Mml::ContextConfiguration`
+   call resolves correctly.
+3. `lib/mml/v{2,3,4}.rb` — replace `require_relative "v{2,3,4}/configuration"`
+   and the foundational requires with `autoload` declarations.
+
+## Acceptance
+- `grep -rn "require_relative" lib/mml/` returns zero matches.
+- `bundle exec rspec` passes.
+- `bundle exec rubocop lib/` clean.
+- Smoke spec (TODO 7) confirms every `Mml::V{2,3,4}::*` class resolves.

data/TODO.complete/4-remove-duplicate-register-model.md

@@ -0,0 +1,31 @@
+# TODO 4 — Remove duplicate per-element `Configuration.register_model` (DRY/SSOT)
+
+## Why
+After TODO 1 & 2, V2 and V3 will mirror V4's pattern of `autoload + module-body
+register_model`. The per-element files (`lib/mml/v{2,3}/<tag>.rb`) currently
+also end with `Configuration.register_model(Klass, id: :tag)`. That is
+duplicate work — `register_model` overwrites the same key with the same class.
+
+V4 is inconsistent: most files omit the per-element call, but `annotation.rb`,
+`elementary_functions.rb`, and `functions.rb` still have it.
+
+Single source of truth: the version module body (`lib/mml/v{2,3,4}.rb`).
+
+## Scope
+- Remove the trailing `Configuration.register_model(...)` line from every
+  per-element file under `lib/mml/v2/`, `lib/mml/v3/`, `lib/mml/v4/`.
+- Do NOT touch `lib/mml/v{2,3,4}.rb` (module-body registrations stay).
+
+## Files affected
+- V3: 66 per-element files (every file under `lib/mml/v3/` except
+  `configuration.rb`, `namespace.rb`, `common_elements.rb`, `version.rb`).
+- V2: ~62 per-element files.
+- V4: 3 files — `annotation.rb`, `elementary_functions.rb`, `functions.rb`.
+
+## Acceptance
+- `grep -rn "Configuration.register_model" lib/mml/v2 lib/mml/v3 lib/mml/v4 |
+  grep -v "v[234]\.rb:"` returns nothing (only version module files have it).
+- `bundle exec rspec` passes.
+- `bundle exec rubocop lib/` clean.
+- Registration spec (TODO 7) confirms all element IDs are still registered
+  in their respective contexts.

data/TODO.complete/5-context-options-type-check.md

@@ -0,0 +1,44 @@
+# TODO 5 — Replace `respond_to?(:id)` with explicit type check in `context_options.rb`
+
+## Why
+Global rule: never use `respond_to?` for type checking. Use `is_a?` or
+design the type hierarchy so the check isn't needed.
+
+`lib/mml/context_options.rb:34` uses `reference.respond_to?(:id)` to duck-type
+any object that exposes an `id`. The actual types that can reach this code are:
+- `Symbol` — handled earlier
+- `String` — handled earlier
+- `Lutaml::Model::TypeContext` (lutaml-model) — has `attr_reader :id`
+- `Lutaml::Model::Register` (lutaml-model) — has `attr_reader :id`
+
+## Scope
+- Replace the `respond_to?` branch with explicit `is_a?` checks against the
+  two known lutaml-model classes.
+- Keep the `ArgumentError` fallback for unknown types — preserves
+  fail-fast behavior.
+
+## Implementation
+```ruby
+def normalize_context_reference(reference)
+  return nil if reference.nil?
+  return reference if reference.is_a?(Symbol)
+  return reference.to_sym if reference.is_a?(String)
+  return reference.id.to_sym if context_reference_object?(reference)
+
+  raise ArgumentError,
+        "Unsupported context/register reference: #{reference.inspect}"
+end
+
+private
+
+def context_reference_object?(reference)
+  reference.is_a?(Lutaml::Model::TypeContext) ||
+    reference.is_a?(Lutaml::Model::Register)
+end
+```
+
+## Acceptance
+- `grep -n "respond_to?" lib/mml/context_options.rb` returns nothing.
+- `bundle exec rspec spec/mml/context_options_spec.rb` passes (new spec from
+  TODO 7).
+- Existing parse/configuration specs still pass.

data/TODO.complete/6-context-configuration-type-check.md

@@ -0,0 +1,32 @@
+# TODO 6 — Replace `respond_to?(:clear_cache)` with explicit type check in `context_configuration.rb`
+
+## Why
+Global rule: never use `respond_to?` for type checking.
+
+`lib/mml/context_configuration.rb:144` uses
+`klass.clear_cache(context_id) if klass.respond_to?(:clear_cache)`.
+
+Every class registered via `Configuration.register_model` inherits from
+`Lutaml::Model::Serializable`, which defines `clear_cache` as a class method
+(see lutaml-model `lib/lutaml/model/serialize/initialization.rb:180`).
+
+## Scope
+- Replace the `respond_to?` guard with an explicit type check:
+  `klass.is_a?(Class) && klass <= Lutaml::Model::Serialize`.
+- Note the use of `<=` (subclass-or-equal) rather than `<` so that
+  `Serializable` itself would also qualify, matching the intent of "any class
+  in the Serializable hierarchy".
+
+## Implementation
+```ruby
+def clear_cache(klass)
+  return unless klass.is_a?(Class) && (klass <= Lutaml::Model::Serialize)
+
+  klass.clear_cache(context_id)
+end
+```
+
+## Acceptance
+- `grep -n "respond_to?" lib/mml/context_configuration.rb` returns nothing.
+- `bundle exec rspec` passes.
+- `bundle exec rubocop lib/mml/context_configuration.rb` clean.

data/TODO.complete/7-specs-for-refactor.md

@@ -0,0 +1,38 @@
+# TODO 7 — Add specs covering the refactorings
+
+## Why
+Lock in the behavior of the refactorings in TODOs 1–6 so future regressions
+are caught. MECE with existing specs:
+- `spec/mml/adapter_configuration_spec.rb` — adapter selection
+- `spec/mml/ordered_content_spec.rb` — mixed_content vs ordered
+- `spec/mml/nested_in_mixed_content_spec.rb` — entity preservation in host
+- `spec/lutaml_default_register_spec.rb` — every Serializable class has
+  `lutaml_default_register`
+- `spec/context_support_spec.rb` — context creation/substitution
+
+None of these cover:
+- `ContextOptions.normalize_context_reference` for `TypeContext`/`Register`
+  inputs.
+- Lint: no `require_relative` in `lib/mml/**/*.rb`.
+- Lint: no `respond_to?` in `lib/mml/**/*.rb`.
+- Lint: no `.send(` / `instance_variable_set` / `instance_variable_get` in
+  `lib/mml/**/*.rb`.
+- Smoke: every `Mml::V{2,3,4}` autoload constant resolves and is registered
+  after `require "mml"`.
+
+## Scope
+Create `spec/mml/code_quality_spec.rb` covering all four lint checks plus a
+smoke test that iterates the Configuration register and asserts every
+expected element ID is present for V2, V3, V4.
+
+Update `spec/context_support_spec.rb` (or add a new spec) to cover
+`ContextOptions.normalize_context_reference` with `TypeContext` and `Register`
+inputs — these now flow through the new `is_a?` branches.
+
+## Acceptance
+- New spec file(s) added.
+- `bundle exec rspec` passes.
+- `bundle exec rubocop` clean.
+- Removing any autoload declaration or per-element class breaks the smoke
+  spec.
+- Adding a new `require_relative` to `lib/mml/` breaks the lint spec.

data/lib/mml/context_configuration.rb

@@ -141,7 +141,9 @@ module Mml
     end
 
     def clear_cache(klass)
-      klass.clear_cache(context_id) if klass.respond_to?(:clear_cache)
+      return unless klass.is_a?(Class) && (klass <= Lutaml::Model::Serialize)
+
+      klass.clear_cache(context_id)
     end
   end
 end

data/lib/mml/context_options.rb

@@ -31,7 +31,7 @@ module Mml
       return nil if reference.nil?
       return reference if reference.is_a?(Symbol)
       return reference.to_sym if reference.is_a?(String)
-      return reference.id.to_sym if reference.respond_to?(:id)
+      return reference.id.to_sym if lutaml_context_reference?(reference)
 
       raise ArgumentError,
             "Unsupported context/register reference: #{reference.inspect}"
@@ -48,6 +48,15 @@ module Mml
       !context.equal?(Mml::UNSPECIFIED_CONTEXT)
     end
 
+    # Lutaml::Model exposes context identity through both TypeContext (returned
+    # by GlobalContext.context) and Register (the public registration handle).
+    # Both classes expose `attr_reader :id`. We accept either by explicit type
+    # check rather than `respond_to?` duck-typing so the contract is verifiable.
+    def lutaml_context_reference?(reference)
+      reference.is_a?(Lutaml::Model::TypeContext) ||
+        reference.is_a?(Lutaml::Model::Register)
+    end
+
     # MML accepts the old `register:` alias, but never both inputs at once.
     def raise_if_conflicting_context_options!(context, register)
       return unless context_specified?(context) && register

data/lib/mml/v2/configuration.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../context_configuration"
-
 module Mml
   module V2
     module Configuration