unitsml 0.6.5 → 0.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 259201a79075b2582ec667b6e6aa248c73bad6ca3ac8cc459e97132fd0caa185
-  data.tar.gz: ad0f345f72489cc4bde6de16662487952ec4d69dda6ada63fc6db6807e2ec41c
+  metadata.gz: e322bdcbc4d88923eb7a82c77d492e9adfa22bd6bbde18d597dcb4ebd31b27b9
+  data.tar.gz: dab029431c9ba4393680944b2b4ba8f0cf3943bf0b004f2a8338a9efff856a3a
 SHA512:
-  metadata.gz: 6fb49ee8588876bd5447b72d88fc1d5a9aa59863c4f147f75db8b2fc9e7a7a52c1edb95d94679e8f135935c5683d6986b4b02ad39e80362b19a4226d4b55c81b
-  data.tar.gz: 258c8491a3072e86cb4004060fc1dd4ef22f0a8959164882ebfa1c8323123926e869e1167c178e8ecc9d7d73c3d8f2d97d24b9511a4b04f363f02d0780cff151
+  metadata.gz: 55c5698138fd5c5b0bc2dce065374688485b7cff2f8622acb64407876bd5c207def0939df6284fa47afb468e8656ce14d72905566f9266c8167b22cb925aa8ea
+  data.tar.gz: b81e21da16dfc6797901147c7223209973e9050163b766e21f2a4a6422659337be9c339e51b7fd9979c560044573011a05af24f106290b7b7aa27e2fcf50bd01

data/.github/workflows/opal.yml

@@ -0,0 +1,42 @@
+name: opal
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  opal-verification:
+    name: Opal boot file and payload verification
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '3.3'
+        bundler-cache: true
+
+    - name: Set up Node.js
+      uses: actions/setup-node@v4
+      with:
+        node-version: '18'
+
+    - name: Run Opal specs
+      # Verifies the Opal toolchain for unitsml:
+      # - the boot file (lib/unitsml/opal.rb) eager-requires every
+      #   autoloaded entry point so Opal users see no NameError,
+      # - the committed database_payload.rb is in sync with the
+      #   PayloadGenerator output for the current unitsdb gem,
+      # - the PayloadGenerator produces evaluable Ruby that round-trips
+      #   through Unitsml::Unitsdb::Database.from_hash,
+      # - Opal::Builder can compile the boot file end-to-end with
+      #   native-only deps stubbed (the consumer provides them).
+      run: |
+        bundle exec rspec spec/unitsml/opal_boot_spec.rb \
+                          spec/unitsml/payload_sync_spec.rb \
+                          spec/unitsml/opal/payload_generator_spec.rb

data/.gitignore

@@ -9,5 +9,14 @@
 
 # rspec failure tracking
 .rspec_status
+
+# Local planning / scratch files — never ship in the gem
+TODO*
+NOTES*
+
+# Editor / OS noise
+.DS_Store
+/.ruby-lsp/
+
 Gemfile.lock
 /vendor/bundle/

data/.rubocop.yml

@@ -16,3 +16,4 @@ AllCops:
   Exclude:
     - 'unitsdb/**/*'
     - 'vendor/**/*'
+    - 'lib/unitsml/opal/database_payload.rb'

data/.rubocop_todo.yml

@@ -1,31 +1,84 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2026-04-15 09:29:09 UTC using RuboCop version 1.86.1.
+# on 2026-06-29 02:49:40 UTC using RuboCop version 1.88.0.
 # 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.
+Gemspec/OrderedDependencies:
+  Exclude:
+    - 'unitsml.gemspec'
+
 # Offense count: 1
 Gemspec/RequiredRubyVersion:
   Exclude:
     - 'unitsml.gemspec'
 
-# Offense count: 1
+# Offense count: 3
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, IndentationWidth.
 # SupportedStyles: with_first_argument, with_fixed_indentation
 Layout/ArgumentAlignment:
   Exclude:
-    - 'lib/unitsml/unit.rb'
+    - 'lib/unitsml/formula.rb'
+    - 'lib/unitsml/utility.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyleAlignWith.
+# SupportedStylesAlignWith: either, start_of_block, start_of_line
+Layout/BlockAlignment:
+  Exclude:
+    - 'lib/unitsml/utility.rb'
 
-# Offense count: 76
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Layout/BlockEndNewline:
+  Exclude:
+    - 'lib/unitsml/utility.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Layout/ElseAlignment:
+  Exclude:
+    - 'lib/unitsml/utility.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: EnforcedStyleAlignWith.
+# SupportedStylesAlignWith: keyword, variable, start_of_line
+Layout/EndAlignment:
+  Exclude:
+    - 'lib/unitsml/utility.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
+# SupportedHashRocketStyles: key, separator, table
+# SupportedColonStyles: key, separator, table
+# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
+Layout/HashAlignment:
+  Exclude:
+    - 'lib/unitsml/utility.rb'
+
+# Offense count: 4
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: Width, EnforcedStyleAlignWith, AllowedPatterns.
+# SupportedStylesAlignWith: start_of_line, relative_to_receiver
+Layout/IndentationWidth:
+  Exclude:
+    - 'lib/unitsml/utility.rb'
+
+# Offense count: 78
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Max, AllowHeredoc, AllowURI, AllowQualifiedName, URISchemes, AllowRBSInlineAnnotation, AllowCopDirectives, AllowedPatterns, SplitStrings.
 # URISchemes: http, https
 Layout/LineLength:
   Exclude:
-    - 'lib/unitsml/fenced.rb'
     - 'lib/unitsml/formula.rb'
     - 'lib/unitsml/intermediate_exp_rules.rb'
     - 'lib/unitsml/parse.rb'
@@ -41,20 +94,15 @@ Layout/LineLength:
     - 'spec/unitsml/conv/xml_spec.rb'
     - 'unitsml.gemspec'
 
-# Offense count: 1
+# Offense count: 2
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowInHeredoc.
 Layout/TrailingWhitespace:
   Exclude:
-    - 'lib/unitsml/unit.rb'
-
-# Offense count: 3
-Lint/ReturnInVoidContext:
-  Exclude:
-    - 'lib/unitsml/unitsdb/si_derived_base.rb'
-    - 'lib/unitsml/unitsdb/unit.rb'
+    - 'lib/unitsml/formula.rb'
+    - 'lib/unitsml/utility.rb'
 
-# Offense count: 19
+# Offense count: 17
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes, Max.
 Metrics/AbcSize:
   Exclude:
@@ -74,7 +122,7 @@ Metrics/CyclomaticComplexity:
     - 'lib/unitsml/parser.rb'
     - 'lib/unitsml/utility.rb'
 
-# Offense count: 14
+# Offense count: 18
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
   Max: 20
@@ -84,11 +132,10 @@ Metrics/MethodLength:
 Metrics/ParameterLists:
   Max: 6
 
-# Offense count: 9
+# Offense count: 8
 # Configuration parameters: AllowedMethods, AllowedPatterns, Max.
 Metrics/PerceivedComplexity:
   Exclude:
-    - 'lib/unitsml/formula.rb'
     - 'lib/unitsml/parse.rb'
     - 'lib/unitsml/parser.rb'
     - 'lib/unitsml/utility.rb'
@@ -132,12 +179,12 @@ RSpec/ContextWording:
     - 'spec/unitsml/parse_spec.rb'
     - 'spec/unitsml/parser_spec.rb'
 
-# Offense count: 5
+# Offense count: 15
 # Configuration parameters: CountAsOne.
 RSpec/ExampleLength:
   Max: 7
 
-# Offense count: 15
+# Offense count: 36
 RSpec/MultipleExpectations:
   Max: 6
 
@@ -170,9 +217,20 @@ RSpec/SpecFilePathFormat:
 
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
-Style/MultilineIfModifier:
+# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, AllowedMethods, AllowedPatterns, AllowBracesOnProceduralOneLiners, BracesRequiredMethods.
+# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
+# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
+# FunctionalMethods: let, let!, subject, watch
+# AllowedMethods: lambda, proc, it
+Style/BlockDelimiters:
   Exclude:
-    - 'lib/unitsml/unit.rb'
+    - 'lib/unitsml/utility.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Style/MultilineTernaryOperator:
+  Exclude:
+    - 'lib/unitsml/utility.rb'
 
 # Offense count: 2
 # Configuration parameters: AllowedMethods.

data/Gemfile

@@ -6,10 +6,11 @@ source "https://rubygems.org"
 gemspec
 
 gem "canon"
-gem "lutaml-model", github: "lutaml/lutaml-model", branch: "main"
+gem "nokogiri"
 gem "oga"
+gem "opal", "~> 1.8"
 gem "ox"
-gem "plurimath", github: "plurimath/plurimath", branch: "main"
+gem "plurimath", "~> 0.11.3"
 gem "pry"
 gem "rake"
 gem "rspec"

data/Rakefile

@@ -5,4 +5,14 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
+namespace :unitsml do
+  desc "Regenerate lib/unitsml/opal/database_payload.rb from unitsdb YAML"
+  task :generate_opal_payload do
+    require "unitsml/opal/payload_generator"
+    path = Unitsml::Opal::PayloadGenerator::DEFAULT_OUTPUT_PATH
+    Unitsml::Opal::PayloadGenerator.new.write_to(path)
+    puts "Wrote #{path}"
+  end
+end
+
 task default: :spec

data/lib/unitsml/configuration.rb

@@ -20,6 +20,10 @@ module Unitsml
     end
 
     def register_model(klass, id:)
+      unless unitsdb_model_subclass?(klass)
+        raise Unitsml::Errors::InvalidModelError, klass
+      end
+
       registered_models[id.to_sym] = klass
     end
 
@@ -30,11 +34,8 @@ module Unitsml
     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 }
+      substitutions = registered_models.each_value.map do |klass|
+        { from_type: klass.superclass, to_type: klass }
       end
 
       ::Unitsdb::Config.populate_context(
@@ -43,5 +44,14 @@ module Unitsml
         substitutions: substitutions,
       )
     end
+
+    def unitsdb_model_subclass?(klass)
+      return false unless klass.is_a?(Class)
+
+      parent = klass.superclass
+      return false if parent.nil? || parent == Object
+
+      parent.name&.start_with?("Unitsdb::")
+    end
   end
 end

data/lib/unitsml/dimension.rb

@@ -22,7 +22,7 @@ module Unitsml
     end
 
     def dim_symbols
-      dim_instance.send(dim_instance.processed_keys.last).symbols.first
+      dim_instance.public_send(dim_instance.processed_keys.last).symbols.first
     end
 
     def to_mathml(options)

data/lib/unitsml/errors/invalid_model_error.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Unitsml
+  module Errors
+    class InvalidModelError < Unitsml::Errors::BaseError
+      def initialize(klass)
+        class_name = display_name(klass)
+        parent = klass.is_a?(Class) ? klass.superclass : nil
+        super("[unitsml] Error: #{class_name} cannot be registered as a " \
+              "UnitsML model. register_model expects a subclass of " \
+              "::Unitsdb::*, got superclass #{parent}.")
+      end
+
+      private
+
+      def display_name(klass)
+        return klass.inspect unless klass.is_a?(Class)
+        return klass.name unless klass.name.nil?
+
+        klass.inspect
+      end
+    end
+  end
+end

data/lib/unitsml/errors/unsupported_payload_type_error.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Unitsml
+  module Errors
+    class UnsupportedPayloadTypeError < Unitsml::Errors::BaseError
+      def initialize(actual_class)
+        super("[unitsml] Error: Unsupported Opal payload type " \
+              "#{actual_class}. PayloadGenerator only emits Hash, Array, " \
+              "String, Symbol, Integer, Float, true, false, and nil.")
+      end
+    end
+  end
+end

data/lib/unitsml/errors.rb

@@ -3,8 +3,11 @@
 module Unitsml
   module Errors
     autoload :BaseError, "unitsml/errors/base_error"
+    autoload :InvalidModelError, "unitsml/errors/invalid_model_error"
     autoload :OpalPayloadNotBundledError,
              "unitsml/errors/opal_payload_not_bundled_error"
     autoload :PlurimathLoadError, "unitsml/errors/plurimath_load_error"
+    autoload :UnsupportedPayloadTypeError,
+             "unitsml/errors/unsupported_payload_type_error"
   end
 end

data/lib/unitsml/fenced.rb

@@ -92,7 +92,7 @@ module Unitsml
     end
 
     def fenced_conversion_for(lang:, options:)
-      lang_value = value.send(:"to_#{lang}", options)
+      lang_value = value.public_send(:"to_#{lang}", options)
       return lang_value unless options[:explicit_parenthesis]
 
       "#{open_paren}#{lang_value}#{close_paren}"

data/lib/unitsml/formula.rb

@@ -81,7 +81,8 @@ module Unitsml
                                      :asciimath)
       end
 
-      Plurimath::Math.parse(compact_mathml_for_plurimath(to_mathml(options)), :mathml)
+      Plurimath::Math.parse(compact_mathml_for_plurimath(to_mathml(options)),
+                            :mathml)
     end
 
     def dimensions_extraction

data/lib/unitsml/mathml_helper.rb

@@ -36,7 +36,7 @@ module Unitsml
     private
 
     def coerce_mml_v4_collection_attributes!(klass, attributes)
-      return unless klass.respond_to?(:attributes)
+      return unless klass.is_a?(Class) && klass <= Lutaml::Model::Serializable
 
       attributes.each do |name, value|
         attribute = klass.attributes[name]

data/lib/unitsml/model/dimension_quantities.rb

@@ -4,18 +4,18 @@ module Unitsml
   module Model
     module DimensionQuantities
       autoload :AmountOfSubstance,
-               "#{__dir__}/dimension_quantities/amount_of_substance"
+               "unitsml/model/dimension_quantities/amount_of_substance"
       autoload :ElectricCurrent,
-               "#{__dir__}/dimension_quantities/electric_current"
-      autoload :Length, "#{__dir__}/dimension_quantities/length"
+               "unitsml/model/dimension_quantities/electric_current"
+      autoload :Length, "unitsml/model/dimension_quantities/length"
       autoload :LuminousIntensity,
-               "#{__dir__}/dimension_quantities/luminous_intensity"
-      autoload :Mass, "#{__dir__}/dimension_quantities/mass"
-      autoload :PlaneAngle, "#{__dir__}/dimension_quantities/plane_angle"
-      autoload :Quantity, "#{__dir__}/dimension_quantities/quantity"
+               "unitsml/model/dimension_quantities/luminous_intensity"
+      autoload :Mass, "unitsml/model/dimension_quantities/mass"
+      autoload :PlaneAngle, "unitsml/model/dimension_quantities/plane_angle"
+      autoload :Quantity, "unitsml/model/dimension_quantities/quantity"
       autoload :ThermodynamicTemperature,
-               "#{__dir__}/dimension_quantities/thermodynamic_temperature"
-      autoload :Time, "#{__dir__}/dimension_quantities/time"
+               "unitsml/model/dimension_quantities/thermodynamic_temperature"
+      autoload :Time, "unitsml/model/dimension_quantities/time"
     end
   end
 end

data/lib/unitsml/model/prefixes.rb

@@ -3,8 +3,8 @@
 module Unitsml
   module Model
     module Prefixes
-      autoload :Name, "#{__dir__}/prefixes/name"
-      autoload :Symbol, "#{__dir__}/prefixes/symbol"
+      autoload :Name, "unitsml/model/prefixes/name"
+      autoload :Symbol, "unitsml/model/prefixes/symbol"
     end
   end
 end

data/lib/unitsml/model/quantities.rb

@@ -3,7 +3,7 @@
 module Unitsml
   module Model
     module Quantities
-      autoload :Name, "#{__dir__}/quantities/name"
+      autoload :Name, "unitsml/model/quantities/name"
     end
   end
 end

data/lib/unitsml/model.rb

@@ -2,14 +2,13 @@
 
 module Unitsml
   module Model
-    autoload :Dimension, "#{__dir__}/model/dimension"
-    autoload :DimensionQuantities, "#{__dir__}/model/dimension_quantities"
-    autoload :Namespace, "#{__dir__}/model/namespace"
-    autoload :Prefix, "#{__dir__}/model/prefix"
-    autoload :Prefixes, "#{__dir__}/model/prefixes"
-    autoload :Quantities, "#{__dir__}/model/quantities"
-    autoload :Quantity, "#{__dir__}/model/quantity"
-    autoload :Unit, "#{__dir__}/model/unit"
-    autoload :Units, "#{__dir__}/model/units"
+    autoload :Dimension, "unitsml/model/dimension"
+    autoload :DimensionQuantities, "unitsml/model/dimension_quantities"
+    autoload :Prefix, "unitsml/model/prefix"
+    autoload :Prefixes, "unitsml/model/prefixes"
+    autoload :Quantities, "unitsml/model/quantities"
+    autoload :Quantity, "unitsml/model/quantity"
+    autoload :Unit, "unitsml/model/unit"
+    autoload :Units, "unitsml/model/units"
   end
 end