Update UnitsML for latest MathML, Plurimath, and UnitsDB integration changes by suleman-uzair · Pull Request #61 · unitsml/unitsml-ruby

suleman-uzair · 2026-04-06T14:03:27Z

This draft PR updates UnitsML to align with the latest MML, Plurimath, and UnitsDB changes.

update UnitsML MathML generation to the latest MML context/register flow
align Plurimath conversion with the current MathML parsing structure
update UnitsDB integration for the latest database loading and model behavior
keep parser, MathML, Plurimath, and XML behavior green on the current branch

[Work-in-progress]: I am still working on Opal / Plurimath-js compatibility, especially around UnitsDB loading without filesystem access in browser-style runtimes.

…nagement

# Conflicts: # Gemfile # lib/unitsml/formula.rb # lib/unitsml/unit.rb

Copilot

Pull request overview

This draft PR updates UnitsML’s integration points with the latest MathML (MML v4), Plurimath parsing, and unitsdb-ruby’s context/register loading model, including Opal-compatible database loading behavior.

Changes:

Introduce a shared MathmlHelper and update MathML generation to use MML v4 context/register APIs.
Replace the prior Unitsdb/Lutaml global register wiring with a new Unitsml::Configuration context + model substitution registration flow.
Add Opal-specific Unitsdb database loading support and corresponding specs/error type.

Reviewed changes

Copilot reviewed 28 out of 28 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
spec/unitsml_spec.rb	Adds a basic parse regression spec for a prefixed unit (“mm”).
spec/unitsml/unitsdb/database_spec.rb	Adds specs for UnitsML’s Unitsdb database loader behavior (ruby vs opal).
lib/unitsml/utility.rb	Updates XML generation to pass `lutaml_register`, refactors prefix handling/helpers, and tweaks unit/dimension/quantity XML serialization calls.
lib/unitsml/unitsdb/units.rb	Removes manual wrapping setter and registers the model for context substitution.
lib/unitsml/unitsdb/unit.rb	Removes manual wrapping setter and registers the model for context substitution.
lib/unitsml/unitsdb/si_derived_base.rb	Removes the wrapper class (no longer needed with new substitution flow).
lib/unitsml/unitsdb/quantities.rb	Registers the model for context substitution.
lib/unitsml/unitsdb/prefixes.rb	Registers the model for context substitution.
lib/unitsml/unitsdb/prefix_reference.rb	Registers the model for context substitution.
lib/unitsml/unitsdb/dimensions.rb	Registers the model for context substitution.
lib/unitsml/unitsdb/dimension_details.rb	Renames/aligns wrapper class and registers the model for context substitution.
lib/unitsml/unitsdb/dimension.rb	Simplifies dimension handling and registers the model for context substitution.
lib/unitsml/unitsdb/database.rb	Adds UnitsML database wrapper with Opal payload loading and model registration.
lib/unitsml/unitsdb.rb	Reworks Unitsdb loading/caching and introduces filesystem-path probing/fallbacks.
lib/unitsml/unit.rb	Updates Unit MathML generation to use helper/context-aware constructors.
lib/unitsml/prefix.rb	Updates Prefix MathML generation to use helper/context-aware constructors.
lib/unitsml/number.rb	Updates Number MathML generation to use helper/context-aware constructors.
lib/unitsml/mathml_helper.rb	Adds helper module to centralize MML v4 context/register element creation/parsing.
lib/unitsml/formula.rb	Updates MathML serialization to use helper/context and compacts MathML before Plurimath parse.
lib/unitsml/fenced.rb	Updates fenced-parenthesis MathML generation to use helper/context-aware constructors.
lib/unitsml/extender.rb	Updates extender/operator MathML generation to use helper/context-aware constructors.
lib/unitsml/errors/opal_payload_not_bundled_error.rb	Adds a dedicated error type for missing Opal-bundled Unitsdb payload.
lib/unitsml/errors.rb	Autoloads the new Opal payload error.
lib/unitsml/dimension.rb	Updates Dimension MathML/XML generation to use helper/context-aware constructors.
lib/unitsml/configuration.rb	Introduces UnitsML-specific Unitsdb context creation + model substitution registry.
lib/unitsml.rb	Removes old global register setup and autoloads the new configuration/helper modules.
docs/README.adoc	Updates documentation to reflect unitsdb-ruby as the runtime data source and documents dev setup/fallbacks.
Gemfile	Pins integration branches for lutaml-model/mml/plurimath/unitsdb-ruby for coordinated changes.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-20T08:24:40Z

+        ::Unitsdb::Database.from_db(database_path)
+      rescue ::Unitsdb::Errors::DatabaseNotFoundError,
+             ::Unitsdb::Errors::DatabaseFileNotFoundError
+        ::Unitsdb::Database.from_db(database_path)


load_database falls back to ::Unitsdb::Database.from_db(database_path) without passing the configured context. That bypasses the UnitsML context/substitution flow and can return base Unitsdb models instead of the registered Unitsml wrappers. Consider calling Unitsml::Unitsdb::Database.from_db(database_path, context: Configuration.context.id) (or passing context: to ::Unitsdb::Database.from_db) in both the normal and rescue paths. Also, the rescue block currently retries the exact same call, which is unlikely to change the outcome; either remove it or make it attempt an actual fallback path/strategy.

Suggested change

::Unitsdb::Database.from_db(database_path)

rescue ::Unitsdb::Errors::DatabaseNotFoundError,

::Unitsdb::Errors::DatabaseFileNotFoundError

::Unitsdb::Database.from_db(database_path)

Database.from_db(database_path, context: Configuration.context.id)

Copilot · 2026-04-20T08:24:41Z

    def to_mathml(options = {})
      if root
        options = update_options(options)
-        nullify_mml_models if plurimath_available?
-        math = ::Mml::V4::Math.new(display: "block")
+        math = mml_v4_new(:math, display: "block")
        math.ordered = true
        math.element_order ||= []
        value.each do |instance|
          process_value(math, instance.to_mathml(options))
        end
-        generated_math = math.to_xml.gsub(%r{&amp;(.*?)(?=</)}, '&\1')
-        reset_mml_models if plurimath_available?
+        generated_math = math.to_xml(register: mml_v4_context.id)
+          .gsub(%r{&amp;(.*?)(?=</)}, '&\1')



to_mathml no longer calls nullify_mml_models / reset_mml_models, but the private methods remain in this file and are now unused. Consider removing them to reduce maintenance surface, or reintroduce the call site if they are still required for Plurimath/MML interoperability.

Copilot · 2026-04-20T08:24:41Z

+
+The standard Ruby runtime path goes through `::Unitsdb.database`. When
+`unitsdb-ruby` cannot load its bundled `data/` directory, UnitsML falls back to
+the packaged YAML files under `vendor/unitsdb`.


The fallback description is ambiguous: the code resolves vendor/unitsdb relative to the unitsdb-ruby gem path (not this repository). Consider clarifying the docs to explicitly say the fallback is to the unitsdb-ruby gem’s packaged vendor/unitsdb directory, so readers don’t assume unitsml-ruby/vendor/unitsdb is required at runtime.

Suggested change

the packaged YAML files under `vendor/unitsdb`.

the packaged YAML files in the `unitsdb-ruby` gem's `vendor/unitsdb`

directory, rather than a `vendor/unitsdb` directory in this repository.

Copilot · 2026-04-20T08:24:41Z

+      def load_database
+        if RUBY_ENGINE == "opal"
+          return Database.from_db(nil, context: Configuration.context.id)
+        end
+
+        if ::Unitsdb.respond_to?(:database)
+          return ::Unitsdb.database(context: Configuration.context.id)
+        end
+
+        ::Unitsdb::Database.from_db(database_path)
+      rescue ::Unitsdb::Errors::DatabaseNotFoundError,
+             ::Unitsdb::Errors::DatabaseFileNotFoundError
+        ::Unitsdb::Database.from_db(database_path)
+      end


The new database_path / fallback loader logic (including the ::Unitsdb.database(context: ...) branch and the ::Unitsdb::Database.from_db fallback) is not covered by specs. Adding tests for the non-Opal paths would help catch regressions across unitsdb-ruby versions and packaging layouts.

Copilot

Pull request overview

Copilot reviewed 28 out of 28 changed files in this pull request and generated 3 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-04-20T13:28:57Z

-                                   "#{prefix.to_mathml(options)}#{value.value}")
+        value = mml_v4_with_content(
+          value,
+          "#{prefix.to_mathml(**options, parent: value)}#{value.value}",


prefix.to_mathml(**options, parent: value) passes keyword arguments to Prefix#to_mathml, but Unitsml::Prefix#to_mathml only accepts a single positional options argument. This will raise ArgumentError at runtime when a prefixed unit is converted to MathML. Pass a hash instead (e.g., merge parent into the options hash) or update to_mathml signatures consistently to accept keywords.

Suggested change

"#{prefix.to_mathml(**options, parent: value)}#{value.value}",

"#{prefix.to_mathml(options.merge(parent: value))}#{value.value}",

Copilot · 2026-04-20T13:28:57Z

        end
      end
    end
+
+    Configuration.register_model(PrefixReference, id: :prefix_reference)


PrefixReference#prefix uses ::Unitsdb.database, which bypasses Unitsml::Unitsdb.database (and its context-aware / Opal-aware loading). In Opal runtimes this can trigger filesystem-based loading or a different database instance than the one UnitsML configured. Prefer looking up prefixes via Unitsml::Unitsdb.database (or ::Unitsdb.database(context: Unitsml::Configuration.context.id)) so the same context and payload are used.

Copilot · 2026-04-20T13:28:58Z

+        resolved_prefix = resolved_prefix(prefix)
+        return unless resolved_prefix
+
+        resolved_prefix.symbols&.first&.ascii


In prefix_symbolid, the local variable name resolved_prefix shadows the helper method resolved_prefix, which makes the code harder to read and easy to misinterpret when debugging. Rename the local variable (e.g., prefix_record) to avoid the shadowing.

Suggested change

resolved_prefix = resolved_prefix(prefix)

return unless resolved_prefix

resolved_prefix.symbols&.first&.ascii

prefix_record = resolved_prefix(prefix)

return unless prefix_record

prefix_record.symbols&.first&.ascii

suleman-uzair added 9 commits April 6, 2026 16:55

feat: use lutaml register for MathML v4 model resolution

59b8b02

Update UnitsML to support latest MML, Plurimath, and UnitsDB changes

e29bd4d

feat: use Unitsdb::Configuration for context and type substitution ma…

06238d0

…nagement

added unitsdb-ruby branch name

5f59792

feat: improve UnitsDB loading and add Opal payload error coverage

5aa5c95

refactor: fixed failing specs and Gemfile

60cb956

refactor: rubocop fixes

b160141

Merge remote-tracking branch 'origin/main' into feat/mml-v4-register

6b205b5

# Conflicts: # Gemfile # lib/unitsml/formula.rb # lib/unitsml/unit.rb

feat: lazy load unitsdb and handle opal payloads

5260d43

suleman-uzair requested a review from Copilot April 20, 2026 08:16

Copilot started reviewing on behalf of suleman-uzair April 20, 2026 08:17 View session

Copilot AI reviewed Apr 20, 2026

View reviewed changes

suleman-uzair requested a review from Copilot April 20, 2026 13:20

Copilot started reviewing on behalf of suleman-uzair April 20, 2026 13:21 View session

Copilot AI reviewed Apr 20, 2026

View reviewed changes

suleman-uzair added 5 commits April 20, 2026 21:23

fix: load UnitsDB with context fallback and clean up MathML handling

ba623e1

Fix MathML v4 content handling with released mml

12cee6c

Fix UnitsDB compatibility and MathML helper regressions

43a4890

Make MathML helper spec tolerate collection-backed content

91ee2c0

fixed rubocop warning

03953e1

suleman-uzair mentioned this pull request Apr 21, 2026

Support latest Plurimath UnitsML build with generated Opal payload plurimath/plurimath-js#42

Draft

suleman-uzair added 2 commits April 22, 2026 12:35

Remove redundant Opal branch from UnitsML UnitsDB loader

98ab447

Update UnitsDB spec for Opal loader delegation

00d8da7

suleman-uzair changed the title ~~[WIP] Update UnitsML for latest MathML, Plurimath, and UnitsDB integration changes~~ Update UnitsML for latest MathML, Plurimath, and UnitsDB integration changes Apr 22, 2026

suleman-uzair marked this pull request as ready for review April 22, 2026 08:19

suleman-uzair mentioned this pull request Apr 22, 2026

Refactor MathML Parsing, Translation, and Opal Loading plurimath/plurimath#412

Merged

suleman-uzair requested review from HassanAkbar and ronaldtse April 22, 2026 09:19

ronaldtse merged commit 7827404 into main Apr 22, 2026
18 checks passed

ronaldtse deleted the feat/mml-v4-register branch April 22, 2026 10:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update UnitsML for latest MathML, Plurimath, and UnitsDB integration changes#61

Update UnitsML for latest MathML, Plurimath, and UnitsDB integration changes#61
ronaldtse merged 16 commits intomainfrom
feat/mml-v4-register

suleman-uzair commented Apr 6, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Copilot AI Apr 20, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	the packaged YAML files under `vendor/unitsdb`.
	the packaged YAML files in the `unitsdb-ruby` gem's `vendor/unitsdb`
	directory, rather than a `vendor/unitsdb` directory in this repository.

	"#{prefix.to_mathml(**options, parent: value)}#{value.value}",
	"#{prefix.to_mathml(options.merge(parent: value))}#{value.value}",

Conversation

suleman-uzair commented Apr 6, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants