unitsml 0.6.2 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 519edb3bcbb3adee7983969d11be6a300340d782e8e305dae7622633b86e7677
-  data.tar.gz: 68becf0180daf138fc4f38048f052debef3d82433f4806d0f631c0c14e6ea852
+  metadata.gz: 70a152434290d3e4f3274a3b5beed15db5d0e6184c93b629363311b8dcc39579
+  data.tar.gz: d70bd8514fafbfec08624c17f11440aa4277f57c0d6d045a39c8611f70952c56
 SHA512:
-  metadata.gz: b6cb0077f5037893a02e69e6ff6c4b8a7c75ae3e67615897a4ccee3966349121bdaa1d8a8b244c42b6e9ba59898c6b2243a4c911239a54fd7f254a360208154a
-  data.tar.gz: 3fa4b5a9542487d7e502a18a22eca293664dc44b556cd9acca4e1bf589f6cd4d88daa9448b2ac18f37a678de4d63646e8f558ac128192d188a46efc56d5d27c6
+  metadata.gz: b18a3a711ca1f5fb60a59283ec4d62d976cd0e0ad30fd199ca0c17327fdad398b1b345d76f8e08d57bdee4f2ea2d9ab36accf9016e647214b640a564f938f0a8
+  data.tar.gz: 6e8c2bcb409905222668fdf87e2470df42d3fde887dcf065d085111b588995529648fd296ef0b2da9040fc040bc2ffb8045f1e940d1dba5d1e99ac8ff156ab8b

data/.rubocop_todo.yml

@@ -1,24 +1,25 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2026-04-04 03:19:03 UTC using RuboCop version 1.86.0.
+# on 2026-04-15 09:29:09 UTC using RuboCop version 1.86.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 2
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: TreatCommentsAsGroupSeparators, ConsiderPunctuation.
-Bundler/OrderedGems:
-  Exclude:
-    - 'Gemfile'
-
 # Offense count: 1
 Gemspec/RequiredRubyVersion:
   Exclude:
     - 'unitsml.gemspec'
 
-# Offense count: 75
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: with_first_argument, with_fixed_indentation
+Layout/ArgumentAlignment:
+  Exclude:
+    - 'lib/unitsml/unit.rb'
+
+# Offense count: 76
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
@@ -40,6 +41,13 @@ Layout/LineLength:
     - 'spec/unitsml/conv/xml_spec.rb'
     - 'unitsml.gemspec'
 
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowInHeredoc.
+Layout/TrailingWhitespace:
+  Exclude:
+    - 'lib/unitsml/unit.rb'
+
 # Offense count: 3
 Lint/ReturnInVoidContext:
   Exclude:
@@ -160,6 +168,12 @@ RSpec/SpecFilePathFormat:
     - 'spec/unitsml/conv/unicode_spec.rb'
     - 'spec/unitsml/conv/xml_spec.rb'
 
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Style/MultilineIfModifier:
+  Exclude:
+    - 'lib/unitsml/unit.rb'
+
 # Offense count: 2
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: respond_to_missing?

data/Gemfile

@@ -6,11 +6,13 @@ source "https://rubygems.org"
 gemspec
 
 gem "canon"
-gem "lutaml-model", "~> 0.8.0", github: "lutaml/lutaml-model", branch: "main"
-gem "mml"
+gem "lutaml-model",
+    github: "lutaml/lutaml-model",
+    branch: "fix/global-context-register-lookup-fallback"
 gem "oga"
 gem "ox"
-gem "plurimath", github: "plurimath/plurimath", branch: "rt-lutaml-080"
+gem "plurimath", github: "plurimath/plurimath",
+                 branch: "rt-lutaml-080"
 gem "pry"
 gem "rake"
 gem "rspec"

data/docs/README.adoc

@@ -40,8 +40,22 @@ The UnitsML Ruby library consists of several key components:
 * Prefix: Represents unit prefixes (k, m, μ, etc.)
 * Dimension: Represents physical dimensions
 
-The library also includes the full https://github.com/unitsml/unitsdb[UnitsDB]
-units database, which contains standard units, prefixes, and dimensions.
+The library uses the https://github.com/unitsml/unitsdb-ruby[unitsdb-ruby]
+gem as the primary runtime source for standard units, prefixes, and dimensions.
+
+== Development setup
+
+The development `Gemfile` pins the current integration branches for
+`lutaml-model`, `mml`, `plurimath`, and `unitsdb-ruby`. If you need to test
+coordinated local changes across those repositories, temporarily switch those
+dependencies to Bundler `path` entries that point at sibling checkouts, for
+example `../lutaml-model` or `../unitsdb-ruby`. Keep those local path changes
+out of commits unless the branch intentionally requires them.
+
+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 in the `unitsdb-ruby` gem's `vendor/unitsdb`
+directory, rather than a `vendor/unitsdb` directory in this repository.
 
 
 == Usage

data/lib/unitsml/configuration.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "unitsdb"
+
+module Unitsml
+  module Configuration
+    CONTEXT_ID = :unitsml_ruby
+
+    module_function
+
+    def context_id
+      CONTEXT_ID
+    end
+
+    def context(force_populate: false)
+      existing = ::Unitsdb::Config.find_context(context_id)
+      return existing if existing && !force_populate
+
+      build_context
+    end
+
+    def register_model(klass, id:)
+      registered_models[id.to_sym] = klass
+    end
+
+    def registered_models
+      @registered_models ||= {}
+    end
+
+    def build_context
+      ::Unitsdb::Config.context # ensure unitsdb context exists
+
+      substitutions = registered_models.each_value.filter_map do |klass|
+        parent = klass.superclass
+        next if parent == Object
+
+        { from_type: parent, to_type: klass }
+      end
+
+      ::Unitsdb::Config.populate_context(
+        id: context_id,
+        fallback_to: [::Unitsdb::Config.context_id],
+        substitutions: substitutions,
+      )
+    end
+  end
+end

data/lib/unitsml/dimension.rb

@@ -2,6 +2,8 @@
 
 module Unitsml
   class Dimension
+    include MathmlHelper
+
     attr_accessor :dimension_name, :power_numerator
 
     def initialize(dimension_name, power_numerator = nil)
@@ -26,7 +28,7 @@ module Unitsml
     def to_mathml(options)
       # MathML key's value in unitsdb/dimensions.yaml
       # file includes mi tags only.
-      value = ::Mml::V4::Mi.from_xml(dim_symbols.mathml)
+      value = mml_v4_from_xml(:mi, dim_symbols.mathml)
       method_name = if power_numerator
                       value = msup_tag(value, options)
                       :msup
@@ -63,7 +65,10 @@ module Unitsml
         symbol: dim_instance.processed_symbol,
         power_numerator: power_numerator&.raw_value || 1,
       }
-      Model::DimensionQuantities.const_get(modelize(element_name)).new(attributes)
+      Model::DimensionQuantities.const_get(modelize(element_name)).new(
+        **attributes,
+        lutaml_register: Configuration.context.id,
+      )
     end
 
     def xml_instances_hash(options)
@@ -94,8 +99,9 @@ module Unitsml
 
     def msup_tag(value, options)
       mathml = power_numerator.to_mathml(options)
-      msup = ::Mml::V4::Msup.new(
-        mrow_value: [::Mml::V4::Mrow.new(mi_value: [value])],
+      msup = mml_v4_new(
+        :msup,
+        mrow_value: [mml_v4_new(:mrow, mi_value: [value])],
       )
       [mathml].flatten.each do |record|
         record_values = msup.public_send("#{record[:method_name]}_value") || []

data/lib/unitsml/errors/opal_payload_not_bundled_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Unitsml
+  module Errors
+    class OpalPayloadNotBundledError < Unitsml::Errors::BaseError
+      def to_s
+        "[unitsml] Error: Opal database payload is not bundled."
+      end
+    end
+  end
+end

data/lib/unitsml/errors.rb

@@ -3,6 +3,8 @@
 module Unitsml
   module Errors
     autoload :BaseError, "unitsml/errors/base_error"
+    autoload :OpalPayloadNotBundledError,
+             "unitsml/errors/opal_payload_not_bundled_error"
     autoload :PlurimathLoadError, "unitsml/errors/plurimath_load_error"
   end
 end

data/lib/unitsml/extender.rb

@@ -2,6 +2,8 @@
 
 module Unitsml
   class Extender
+    include MathmlHelper
+
     attr_accessor :symbol
 
     def initialize(symbol)
@@ -18,7 +20,7 @@ module Unitsml
       extender = multiplier(options[:multiplier] || "⋅", unicode: true)
       {
         method_name: :mo,
-        value: ::Mml::V4::Mo.new(value: extender, rspace: rspace),
+        value: mml_v4_new(:mo, value: extender, rspace: rspace),
       }
     end
 

data/lib/unitsml/fenced.rb

@@ -3,6 +3,7 @@
 module Unitsml
   class Fenced
     include FencedNumeric
+    include MathmlHelper
 
     attr_reader :open_paren, :value, :close_paren
 
@@ -31,11 +32,14 @@ module Unitsml
       mathml = value.to_mathml(options)
       return mathml unless options[:explicit_parenthesis]
 
-      fenced = ::Mml::V4::Mrow.new(mo_value: [::Mml::V4::Mo.new(value: open_paren)])
+      fenced = mml_v4_new(
+        :mrow,
+        mo_value: [mml_v4_new(:mo, value: open_paren)],
+      )
       fenced.ordered = true
       fenced.element_order ||= [xml_order_element("mo")]
       [mathml].flatten.each { |record| add_math_element(fenced, record) }
-      fenced.mo_value << ::Mml::V4::Mo.new(value: close_paren)
+      fenced.mo_value << mml_v4_new(:mo, value: close_paren)
       fenced.element_order << xml_order_element("mo")
       { method_name: :mrow, value: fenced }
     end

data/lib/unitsml/formula.rb

@@ -5,6 +5,8 @@ require "htmlentities"
 
 module Unitsml
   class Formula
+    include MathmlHelper
+
     attr_accessor :value, :explicit_value, :root
 
     def initialize(value = [],
@@ -29,15 +31,14 @@ module Unitsml
     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')
 
         generated_math.force_encoding("UTF-8")
       else
@@ -80,7 +81,7 @@ module Unitsml
                                      :asciimath)
       end
 
-      Plurimath::Math.parse(to_mathml(options), :mathml)
+      Plurimath::Math.parse(compact_mathml_for_plurimath(to_mathml(options)), :mathml)
     end
 
     def dimensions_extraction
@@ -151,7 +152,10 @@ module Unitsml
       dim_id = dims.map(&:generate_id).join
       attributes = { id: "D_#{dim_id}" }
       dims.each { |dim| attributes.merge!(dim.xml_instances_hash(options)) }
-      Model::Dimension.new(attributes).to_xml.force_encoding("UTF-8")
+      Model::Dimension.new(
+        **attributes,
+        lutaml_register: Configuration.context.id,
+      ).to_xml.force_encoding("UTF-8")
     end
 
     def sort_dims(values)
@@ -195,14 +199,6 @@ module Unitsml
         Plurimath.const_defined?(:Mathml)
     end
 
-    def nullify_mml_models
-      Plurimath::Mathml::Parser::CONFIGURATION.each_key { |klass| klass.model(klass) }
-    end
-
-    def reset_mml_models
-      ::Mml::V4::Configuration.custom_models = Plurimath::Mathml::Parser::CONFIGURATION
-    end
-
     def process_value(math, mathml_instances)
       case mathml_instances
       when Array
@@ -220,5 +216,9 @@ module Unitsml
       options.merge(multiplier: multiplier,
                     explicit_parenthesis: explicit_parenthesis).compact
     end
+
+    def compact_mathml_for_plurimath(mathml)
+      mathml.gsub(/>\s+</, "><").strip
+    end
   end
 end

data/lib/unitsml/mathml_helper.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module Unitsml
+  module MathmlHelper
+    module_function
+
+    def mml_v4_context
+      ::Mml::V4::Configuration.context
+    end
+
+    def mml_v4_from_xml(klass_ref, xml)
+      mml_v4_class_for(klass_ref).from_xml(xml, register: mml_v4_context.id)
+    end
+
+    def mml_v4_new(klass_ref, **attributes)
+      klass = mml_v4_class_for(klass_ref)
+      coerce_mml_v4_collection_attributes!(klass, attributes)
+      klass.new(**attributes, lutaml_register: mml_v4_context.id)
+    end
+
+    def mml_v4_with_content(instance, content)
+      attributes = instance.to_hash.transform_keys(&:to_sym)
+      mml_v4_new(
+        instance.class,
+        **attributes,
+        mml_v4_content_attribute(instance) => content,
+      )
+    end
+
+    def mml_v4_class_for(klass_ref)
+      return klass_ref if klass_ref.is_a?(Class)
+
+      mml_v4_context.lookup_local(klass_ref.to_sym)
+    end
+
+    private
+
+    def coerce_mml_v4_collection_attributes!(klass, attributes)
+      return unless klass.respond_to?(:attributes)
+
+      attributes.each do |name, value|
+        attribute = klass.attributes[name]
+        attributes[name] = coerce_mml_v4_collection_value(attribute, value)
+      end
+    end
+
+    def coerce_mml_v4_collection_value(attribute, value)
+      return value unless attribute&.collection?
+      return value if value.nil?
+      return value if attribute.collection_instance?(value)
+
+      attribute.build_collection(value)
+    end
+
+    def mml_v4_content_attribute(instance)
+      register = instance.lutaml_register || mml_v4_context.id
+      instance.class.mappings_for(:xml, register).content_mapping.to
+    end
+  end
+end

data/lib/unitsml/number.rb

@@ -3,6 +3,7 @@
 module Unitsml
   class Number
     include FencedNumeric
+    include MathmlHelper
 
     attr_accessor :value
     alias raw_value value
@@ -19,7 +20,7 @@ module Unitsml
     def to_mathml(_options)
       matched_value = value&.match(/-?(.+)/)
       mn_value = matched_value ? matched_value[1] : value
-      mn_tag = ::Mml::V4::Mn.new(value: mn_value)
+      mn_tag = mml_v4_new(:mn, value: mn_value)
       value.start_with?("-") ? mrow_hash(mn_tag) : mn_hash(mn_tag)
     end
 
@@ -62,8 +63,9 @@ module Unitsml
     def mrow_hash(mn_tag)
       {
         method_name: :mrow,
-        value: ::Mml::V4::Mrow.new(
-          mo_value: [::Mml::V4::Mo.new(value: "−")],
+        value: mml_v4_new(
+          :mrow,
+          mo_value: [mml_v4_new(:mo, value: "−")],
           mn_value: [mn_tag],
         ),
       }

data/lib/unitsml/prefix.rb

@@ -2,6 +2,8 @@
 
 module Unitsml
   class Prefix
+    include MathmlHelper
+
     attr_accessor :prefix_name, :only_instance
 
     def initialize(prefix_name, only_instance = false)
@@ -41,7 +43,7 @@ module Unitsml
       )
       return symbol unless only_instance
 
-      { method_name: :mi, value: ::Mml::V4::Mi.new(value: symbol) }
+      { method_name: :mi, value: mml_v4_new(:mi, value: symbol) }
     end
 
     def to_latex(_)

data/lib/unitsml/unit.rb

@@ -2,6 +2,8 @@
 
 module Unitsml
   class Unit
+    include MathmlHelper
+
     attr_accessor :unit_name, :power_numerator, :prefix
 
     SI_UNIT_SYSTEM = %w[si_base si_derived_special
@@ -37,8 +39,13 @@ module Unitsml
     def to_mathml(options)
       value = unit_symbols&.mathml
       tag_name = value.match(/^<(?<tag>\w+)/)[:tag]
-      value = ::Mml::V4.const_get(tag_name.capitalize).from_xml(value)
-      value.value = "#{prefix.to_mathml(options)}#{value.value}" if prefix
+      value = mml_v4_from_xml(tag_name, value)
+      if prefix
+        value = mml_v4_with_content(
+          value,
+          "#{prefix.to_mathml(options.merge(parent: value))}#{Array(value.value).join}",
+        )
+      end
       if power_numerator
         value = msup_tag(
           { method_name: tag_name, value: value },
@@ -127,7 +134,7 @@ module Unitsml
     end
 
     def msup_tag(value, options)
-      msup = ::Mml::V4::Msup.new
+      msup = mml_v4_new(:msup)
       msup.ordered = true
       msup.element_order = []
       [value, power_numerator.to_mathml(options)].flatten.each do |record|

data/lib/unitsml/unitsdb/database.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Unitsml
+  module Unitsdb
+    class Database < ::Unitsdb::Database
+      DATABASE = nil
+
+      def self.from_db(dir_path, context: Unitsml::Configuration.context.id)
+        return super unless RUBY_ENGINE == "opal"
+
+        context_id = context.to_sym
+        raise Unitsml::Errors::OpalPayloadNotBundledError unless DATABASE
+
+        Unitsml::Configuration.context
+
+        from_hash(DATABASE, register: context_id)
+      end
+
+      Configuration.register_model(self, id: :database)
+    end
+  end
+end

data/lib/unitsml/unitsdb/dimension.rb

@@ -16,43 +16,41 @@ module Unitsml
       end
 
       def length=(value)
-        quantities_common_code(:length, wrap_dimension_value(value))
+        quantities_common_code(:length, value)
       end
 
       def mass=(value)
-        quantities_common_code(:mass, wrap_dimension_value(value))
+        quantities_common_code(:mass, value)
       end
 
       def time=(value)
-        quantities_common_code(:time, wrap_dimension_value(value))
+        quantities_common_code(:time, value)
       end
 
       def thermodynamic_temperature=(value)
-        quantities_common_code(:thermodynamic_temperature,
-                               wrap_dimension_value(value))
+        quantities_common_code(:thermodynamic_temperature, value)
       end
 
       def amount_of_substance=(value)
-        quantities_common_code(:amount_of_substance,
-                               wrap_dimension_value(value))
+        quantities_common_code(:amount_of_substance, value)
       end
 
       def luminous_intensity=(value)
-        quantities_common_code(:luminous_intensity, wrap_dimension_value(value))
+        quantities_common_code(:luminous_intensity, value)
       end
 
       def plane_angle=(value)
-        quantities_common_code(:plane_angle, wrap_dimension_value(value))
+        quantities_common_code(:plane_angle, value)
       end
 
       def electric_current=(value)
-        quantities_common_code(:electric_current, wrap_dimension_value(value))
+        quantities_common_code(:electric_current, value)
       end
 
       def dim_symbols
-        processed_keys.map do |vec|
-          public_send(vec)&.dim_symbols&.map(&:id)
-        end.flatten.compact
+        processed_keys.flat_map do |vec|
+          dimension_symbols_for(public_send(vec)).map(&:id)
+        end.compact
       end
 
       def processed_symbol
@@ -76,19 +74,24 @@ module Unitsml
 
         instance_variable_set(:"@#{instance_var}", value)
         @processed_keys << instance_var.to_s
-        return if Lutaml::Model::Utils.empty?(value.symbols)
+        dim_symbols = dimension_symbols_for(value)
+        return if Lutaml::Model::Utils.empty?(dim_symbols)
 
         @parsable = true
-        value.dim_symbols_ids(@parsables, id)
+        dim_symbols.each { |dim_sym| @parsables[dim_sym.id] = id }
       end
 
-      def wrap_dimension_value(value)
-        return value if value.is_a?(DimensionQuantity)
-        return DimensionQuantity.new(value.to_hash) if value.is_a?(::Unitsdb::DimensionDetails)
-        return DimensionQuantity.new(value) if value.is_a?(Hash)
+      def dimension_symbols_for(value)
+        return [] if value.nil?
 
-        value
+        if value.respond_to?(:dim_symbols)
+          Array(value.dim_symbols)
+        else
+          Array(value.symbols)
+        end
       end
     end
+
+    Configuration.register_model(Dimension, id: :dimension)
   end
 end

data/lib/unitsml/unitsdb/{dimension_quantity.rb → dimension_details.rb}

@@ -2,10 +2,12 @@
 
 module Unitsml
   module Unitsdb
-    class DimensionQuantity < ::Unitsdb::DimensionDetails
+    class DimensionDetails < ::Unitsdb::DimensionDetails
       def dim_symbols_ids(hash, dim_id)
         symbols&.each { |dim_sym| hash[dim_sym.id] = dim_id }
       end
     end
+
+    Configuration.register_model(DimensionDetails, id: :dimension_details)
   end
 end

data/lib/unitsml/unitsdb/dimensions.rb

@@ -32,5 +32,7 @@ module Unitsml
         dimensions.find { |dim| dim.send(field) == matching_data }
       end
     end
+
+    Configuration.register_model(Dimensions, id: :dimensions)
   end
 end

data/lib/unitsml/unitsdb/prefix_reference.rb

@@ -16,10 +16,12 @@ module Unitsml
       end
 
       def prefix
-        @prefix ||= ::Unitsdb.database.prefixes.find do |p|
+        @prefix ||= Unitsml::Unitsdb.database.prefixes.find do |p|
           p.identifiers.any? { |i| i.id == id }
         end
       end
     end
+
+    Configuration.register_model(PrefixReference, id: :prefix_reference)
   end
 end

data/lib/unitsml/unitsdb/prefixes.rb

@@ -30,5 +30,7 @@ module Unitsml
         end
       end
     end
+
+    Configuration.register_model(Prefixes, id: :prefixes)
   end
 end

data/lib/unitsml/unitsdb/quantities.rb

@@ -9,5 +9,7 @@ module Unitsml
         end
       end
     end
+
+    Configuration.register_model(Quantities, id: :quantities)
   end
 end

data/lib/unitsml/unitsdb/unit.rb

@@ -3,14 +3,6 @@
 module Unitsml
   module Unitsdb
     class Unit < ::Unitsdb::Unit
-      def si_derived_bases=(value)
-        return super if value.nil?
-
-        super(value.map do |s|
-          SiDerivedBase.new(s.to_hash)
-        end)
-      end
-
       def dimension_url
         quantity_id = quantity_references[0].id
         quantity = Unitsml::Unitsdb.quantities.find_by_id(quantity_id)
@@ -24,6 +16,8 @@ module Unitsml
       def nist_id
         identifiers.find { |id| id.type == "nist" }&.id
       end
+
+      Configuration.register_model(self, id: :unit)
     end
   end
 end