unitsdb 2.1.0 → 2.2.1

data/lib/unitsdb/database.rb

@@ -1,17 +1,11 @@
 # frozen_string_literal: true
 
-require_relative "unit"
-require_relative "prefix"
-require_relative "quantity"
-require_relative "dimension"
-require_relative "unit_system"
-require_relative "errors"
-
 module Unitsdb
   class Database < Lutaml::Model::Serializable
     # model Config.model_for(:units)
 
     attribute :schema_version, :string
+    attribute :version, :string
     attribute :units, Unit, collection: true
     attribute :prefixes, Prefix, collection: true
     attribute :quantities, Quantity, collection: true
@@ -24,7 +18,11 @@ module Unitsdb
     # @return [Object, nil] the first entity with matching identifier or nil if not found
     def find_by_type(id:, type:)
       collection = send(type.to_s)
-      collection.find { |entity| entity.identifiers&.any? { |identifier| identifier.id == id } }
+      collection.find do |entity|
+        entity.identifiers&.any? do |identifier|
+          identifier.id == id
+        end
+      end
     end
 
     # Find an entity by its identifier id across all entity types
@@ -32,7 +30,8 @@ module Unitsdb
     # @param type [String, nil] optional identifier type to match
     # @return [Object, nil] the first entity with matching identifier or nil if not found
     def get_by_id(id:, type: nil)
-      %w[units prefixes quantities dimensions unit_systems].each do |collection_name|
+      %w[units prefixes quantities dimensions
+         unit_systems].each do |collection_name|
         next unless respond_to?(collection_name)
 
         collection = send(collection_name)
@@ -62,7 +61,12 @@ module Unitsdb
       results = []
 
       # Define which collections to search based on type parameter
-      collections = type ? [type.to_s] : %w[units prefixes quantities dimensions unit_systems]
+      collections = if type
+                      [type.to_s]
+                    else
+                      %w[units prefixes quantities
+                         dimensions unit_systems]
+                    end
 
       collections.each do |collection_name|
         next unless respond_to?(collection_name)
@@ -70,7 +74,9 @@ module Unitsdb
         collection = send(collection_name)
         collection.each do |entity|
           # Search in identifiers
-          if entity.identifiers&.any? { |identifier| identifier.id.to_s.downcase.include?(text.downcase) }
+          if entity.identifiers&.any? do |identifier|
+            identifier.id.to_s.downcase.include?(text.downcase)
+          end
             results << entity
             next
           end
@@ -85,14 +91,14 @@ module Unitsdb
 
           # Search in short description
           if entity.respond_to?(:short) && entity.short &&
-             entity.short.to_s.downcase.include?(text.downcase)
+              entity.short.to_s.downcase.include?(text.downcase)
             results << entity
             next
           end
 
           # Special case for prefix name (prefixes don't have names array)
           next unless collection_name == "prefixes" && entity.respond_to?(:name) &&
-                      entity.name.to_s.downcase.include?(text.downcase)
+            entity.name.to_s.downcase.include?(text.downcase)
 
           results << entity
           next
@@ -115,7 +121,8 @@ module Unitsdb
       collections = entity_type ? [entity_type.to_s] : %w[units prefixes]
 
       collections.each do |collection_name|
-        next unless respond_to?(collection_name) && %w[units prefixes].include?(collection_name)
+        next unless respond_to?(collection_name) && %w[units
+                                                       prefixes].include?(collection_name)
 
         collection = send(collection_name)
         collection.each do |entity|
@@ -157,11 +164,16 @@ module Unitsdb
 
       result = {
         exact: [],
-        symbol_match: []
+        symbol_match: [],
       }
 
       # Define collections to search based on entity_type parameter
-      collections = entity_type ? [entity_type.to_s] : %w[units prefixes quantities dimensions unit_systems]
+      collections = if entity_type
+                      [entity_type.to_s]
+                    else
+                      %w[units prefixes
+                         quantities dimensions unit_systems]
+                    end
 
       collections.each do |collection_name|
         next unless respond_to?(collection_name)
@@ -173,23 +185,25 @@ module Unitsdb
           if %w[exact all].include?(match_type)
             # Match by short
             if entity.respond_to?(:short) && entity.short &&
-               entity.short.downcase == value.downcase
+                entity.short.downcase == value.downcase
               result[:exact] << {
                 entity: entity,
                 match_desc: "short_to_name",
-                details: "UnitsDB short '#{entity.short}' matches '#{value}'"
+                details: "UnitsDB short '#{entity.short}' matches '#{value}'",
               }
               next
             end
 
             # Match by names
             if entity.respond_to?(:names) && entity.names
-              matching_name = entity.names.find { |name| name.value.to_s.downcase == value.downcase }
+              matching_name = entity.names.find do |name|
+                name.value.to_s.downcase == value.downcase
+              end
               if matching_name
                 result[:exact] << {
                   entity: entity,
                   match_desc: "name_to_name",
-                  details: "UnitsDB name '#{matching_name.value}' (#{matching_name.lang}) matches '#{value}'"
+                  details: "UnitsDB name '#{matching_name.value}' (#{matching_name.lang}) matches '#{value}'",
                 }
                 next
               end
@@ -198,7 +212,7 @@ module Unitsdb
 
           # For symbol matches - only applicable to units and prefixes
           if %w[symbol all].include?(match_type) &&
-             %w[units prefixes].include?(collection_name)
+              %w[units prefixes].include?(collection_name)
             if collection_name == "units" && entity.respond_to?(:symbols) && entity.symbols
               # Units can have multiple symbols
               matching_symbol = entity.symbols.find do |sym|
@@ -210,7 +224,7 @@ module Unitsdb
                 result[:symbol_match] << {
                   entity: entity,
                   match_desc: "symbol_match",
-                  details: "UnitsDB symbol '#{matching_symbol.ascii}' matches '#{value}'"
+                  details: "UnitsDB symbol '#{matching_symbol.ascii}' matches '#{value}'",
                 }
               end
             elsif collection_name == "prefixes" && entity.respond_to?(:symbols) && entity.symbols
@@ -224,7 +238,7 @@ module Unitsdb
                 result[:symbol_match] << {
                   entity: entity,
                   match_desc: "symbol_match",
-                  details: "UnitsDB symbol '#{matching_symbol.ascii}' matches '#{value}'"
+                  details: "UnitsDB symbol '#{matching_symbol.ascii}' matches '#{value}'",
                 }
               end
             end
@@ -242,7 +256,7 @@ module Unitsdb
     def validate_uniqueness
       results = {
         short: {},
-        id: {}
+        id: {},
       }
 
       # Validate short names for applicable collections
@@ -282,18 +296,24 @@ module Unitsdb
       puts "Database directory path: #{db_path}"
 
       # Check if the directory exists
-      raise Errors::DatabaseNotFoundError, "Database directory not found: #{db_path}" unless Dir.exist?(db_path)
+      unless Dir.exist?(db_path)
+        raise Errors::DatabaseNotFoundError,
+              "Database directory not found: #{db_path}"
+      end
 
       # Define required files
-      required_files = %w[prefixes.yaml dimensions.yaml units.yaml quantities.yaml unit_systems.yaml]
+      required_files = %w[prefixes.yaml dimensions.yaml units.yaml
+                          quantities.yaml unit_systems.yaml]
       yaml_files = required_files.map { |file| File.join(dir_path, file) }
 
       # Check if all required files exist
-      missing_files = required_files.reject { |file| File.exist?(File.join(dir_path, file)) }
+      missing_files = required_files.reject do |file|
+        File.exist?(File.join(dir_path, file))
+      end
 
       if missing_files.any?
         raise Errors::DatabaseFileNotFoundError,
-              "Missing required database files: #{missing_files.join(", ")}"
+              "Missing required database files: #{missing_files.join(', ')}"
       end
 
       # Ensure we have path properly joined with filenames
@@ -315,15 +335,17 @@ module Unitsdb
 
       # Load YAML files with better error handling
       begin
-        prefixes_hash = YAML.safe_load(File.read(prefixes_yaml))
-        dimensions_hash = YAML.safe_load(File.read(dimensions_yaml))
-        units_hash = YAML.safe_load(File.read(units_yaml))
-        quantities_hash = YAML.safe_load(File.read(quantities_yaml))
-        unit_systems_hash = YAML.safe_load(File.read(unit_systems_yaml))
+        prefixes_hash = YAML.safe_load_file(prefixes_yaml)
+        dimensions_hash = YAML.safe_load_file(dimensions_yaml)
+        units_hash = YAML.safe_load_file(units_yaml)
+        quantities_hash = YAML.safe_load_file(quantities_yaml)
+        unit_systems_hash = YAML.safe_load_file(unit_systems_yaml)
       rescue Errno::ENOENT => e
-        raise Errors::DatabaseFileNotFoundError, "Failed to read database file: #{e.message}"
+        raise Errors::DatabaseFileNotFoundError,
+              "Failed to read database file: #{e.message}"
       rescue Psych::SyntaxError => e
-        raise Errors::DatabaseFileInvalidError, "Invalid YAML in database file: #{e.message}"
+        raise Errors::DatabaseFileInvalidError,
+              "Invalid YAML in database file: #{e.message}"
       rescue StandardError => e
         raise Errors::DatabaseLoadError, "Error loading database: #{e.message}"
       end
@@ -338,7 +360,7 @@ module Unitsdb
 
       if missing_schema.any?
         raise Errors::DatabaseFileInvalidError,
-              "Missing schema_version in files: #{missing_schema.join(", ")}"
+              "Missing schema_version in files: #{missing_schema.join(', ')}"
       end
 
       # Extract versions from each file
@@ -354,7 +376,7 @@ module Unitsdb
         dimensions_version,
         units_version,
         quantities_version,
-        unit_systems_version
+        unit_systems_version,
       ]
 
       unless versions.uniq.size == 1
@@ -363,9 +385,10 @@ module Unitsdb
           "dimensions.yaml" => dimensions_version,
           "units.yaml" => units_version,
           "quantities.yaml" => quantities_version,
-          "unit_systems.yaml" => unit_systems_version
+          "unit_systems.yaml" => unit_systems_version,
         }
-        raise Errors::VersionMismatchError, "Version mismatch in database files: #{version_info.inspect}"
+        raise Errors::VersionMismatchError,
+              "Version mismatch in database files: #{version_info.inspect}"
       end
 
       # Check if the version is supported
@@ -381,7 +404,7 @@ module Unitsdb
         "dimensions" => dimensions_hash["dimensions"],
         "units" => units_hash["units"],
         "quantities" => quantities_hash["quantities"],
-        "unit_systems" => unit_systems_hash["unit_systems"]
+        "unit_systems" => unit_systems_hash["unit_systems"],
       }.to_yaml
 
       from_yaml(combined_yaml)
@@ -532,7 +555,8 @@ module Unitsdb
         ref_type = "dimensions"
         ref_path = "dimensions:index:#{index}:dimension_reference"
 
-        validate_reference(ref_id, ref_type, ref_path, registry, invalid_refs, "dimensions")
+        validate_reference(ref_id, ref_type, ref_path, registry, invalid_refs,
+                           "dimensions")
       end
     end
 
@@ -544,7 +568,8 @@ module Unitsdb
           ref_type = "unit_systems"
           ref_path = "units:index:#{index}:unit_system_reference[#{idx}]"
 
-          validate_reference(ref_id, ref_type, ref_path, registry, invalid_refs, "units")
+          validate_reference(ref_id, ref_type, ref_path, registry,
+                             invalid_refs, "units")
         end
       end
     end
@@ -557,7 +582,8 @@ module Unitsdb
           ref_type = "quantities"
           ref_path = "units:index:#{index}:quantity_references[#{idx}]"
 
-          validate_reference(ref_id, ref_type, ref_path, registry, invalid_refs, "units")
+          validate_reference(ref_id, ref_type, ref_path, registry,
+                             invalid_refs, "units")
         end
       end
     end
@@ -574,7 +600,8 @@ module Unitsdb
           ref_type = "units"
           ref_path = "units:index:#{index}:root_units.#{idx}.unit_reference"
 
-          validate_reference(ref_id, ref_type, ref_path, registry, invalid_refs, "units")
+          validate_reference(ref_id, ref_type, ref_path, registry,
+                             invalid_refs, "units")
 
           # Check prefix reference if present
           next unless root_unit.respond_to?(:prefix_reference) && root_unit.prefix_reference
@@ -583,12 +610,14 @@ module Unitsdb
           ref_type = "prefixes"
           ref_path = "units:index:#{index}:root_units.#{idx}.prefix_reference"
 
-          validate_reference(ref_id, ref_type, ref_path, registry, invalid_refs, "units")
+          validate_reference(ref_id, ref_type, ref_path, registry,
+                             invalid_refs, "units")
         end
       end
     end
 
-    def validate_reference(ref_id, ref_type, ref_path, registry, invalid_refs, file_type)
+    def validate_reference(ref_id, ref_type, ref_path, registry, invalid_refs,
+file_type)
       # Handle references that are objects with id and type (could be a hash or an object)
       if ref_id.respond_to?(:id) && ref_id.respond_to?(:type)
         id = ref_id.id
@@ -607,8 +636,12 @@ module Unitsdb
         # 3. Try alternate ID formats for unit systems (e.g., SI_base vs si-base)
         if !valid && type == "unitsml" && ref_type == "unit_systems" && registry.key?(ref_type) && (
             registry[ref_type].keys.any? { |k| k.end_with?(":#{id}") } ||
-            registry[ref_type].keys.any? { |k| k.end_with?(":SI_#{id.sub("si-", "")}") } ||
-            registry[ref_type].keys.any? { |k| k.end_with?(":non-SI_#{id.sub("nonsi-", "")}") }
+            registry[ref_type].keys.any? do |k|
+              k.end_with?(":SI_#{id.sub('si-', '')}")
+            end ||
+            registry[ref_type].keys.any? do |k|
+              k.end_with?(":non-SI_#{id.sub('nonsi-', '')}")
+            end
           )
           # Special handling for unit_systems between unitsml and nist types
           valid = true
@@ -616,7 +649,8 @@ module Unitsdb
 
         unless valid
           invalid_refs[file_type] ||= {}
-          invalid_refs[file_type][ref_path] = { id: id, type: type, ref_type: ref_type }
+          invalid_refs[file_type][ref_path] =
+            { id: id, type: type, ref_type: ref_type }
         end
       # Handle references that are objects with id and type in a hash
       elsif ref_id.is_a?(Hash) && ref_id.key?("id") && ref_id.key?("type")
@@ -636,8 +670,12 @@ module Unitsdb
         # 3. Try alternate ID formats for unit systems (e.g., SI_base vs si-base)
         if !valid && type == "unitsml" && ref_type == "unit_systems" && registry.key?(ref_type) && (
             registry[ref_type].keys.any? { |k| k.end_with?(":#{id}") } ||
-            registry[ref_type].keys.any? { |k| k.end_with?(":SI_#{id.sub("si-", "")}") } ||
-            registry[ref_type].keys.any? { |k| k.end_with?(":non-SI_#{id.sub("nonsi-", "")}") }
+            registry[ref_type].keys.any? do |k|
+              k.end_with?(":SI_#{id.sub('si-', '')}")
+            end ||
+            registry[ref_type].keys.any? do |k|
+              k.end_with?(":non-SI_#{id.sub('nonsi-', '')}")
+            end
           )
           # Special handling for unit_systems between unitsml and nist types
           valid = true
@@ -645,7 +683,8 @@ module Unitsdb
 
         unless valid
           invalid_refs[file_type] ||= {}
-          invalid_refs[file_type][ref_path] = { id: id, type: type, ref_type: ref_type }
+          invalid_refs[file_type][ref_path] =
+            { id: id, type: type, ref_type: ref_type }
         end
       else
         # Handle plain string references (legacy format)

data/lib/unitsdb/dimension.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "identifier"
-require_relative "dimension_details"
-require_relative "quantity"
-require_relative "localized_string"
 # NISTd1:
 #   length:
 #     power: 1
@@ -45,5 +41,6 @@ module Unitsdb
     attribute :plane_angle, DimensionDetails
     attribute :short, :string
     attribute :names, LocalizedString, collection: true
+    attribute :references, ExternalReference, collection: true
   end
 end

data/lib/unitsdb/dimension_details.rb

@@ -10,7 +10,6 @@
 #   mathml: "<mi mathvariant='sans-serif'>M</mi>"
 #   unicode: "\U0001D5AC"
 
-require_relative "symbol_presentations"
 module Unitsdb
   class DimensionDetails < Lutaml::Model::Serializable
     attribute :power, :integer

data/lib/unitsdb/dimensions.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
-require_relative "dimension"
-
 module Unitsdb
   class Dimensions < Lutaml::Model::Serializable
     # model Config.model_for(:dimensions)
 
     attribute :schema_version, :string
+    attribute :version, :string
     attribute :dimensions, Dimension, collection: true
   end
 end

data/lib/unitsdb/errors.rb

@@ -9,5 +9,12 @@ module Unitsdb
     class DatabaseLoadError < DatabaseError; end
     class VersionMismatchError < DatabaseError; end
     class UnsupportedVersionError < DatabaseError; end
+
+    # CLI-specific errors
+    class CLIRuntimeError < StandardError; end
+    class InvalidParameterError < CLIRuntimeError; end
+    class FileNotFoundError < CLIRuntimeError; end
+    class ValidationError < CLIRuntimeError; end
+    class InvalidFormatError < CLIRuntimeError; end
   end
 end

data/lib/unitsdb/prefix.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "identifier"
-require_relative "symbol_presentations"
-require_relative "external_reference"
-require_relative "localized_string"
 # ---
 # NISTp10_30:
 #   name: quetta

data/lib/unitsdb/prefix_reference.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "identifier"
-
 module Unitsdb
   class PrefixReference < Identifier
     attribute :id, :string

data/lib/unitsdb/prefixes.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "prefix"
 # ---
 # NISTp10_30:
 #   name: quetta
@@ -17,6 +16,7 @@ module Unitsdb
     # model Config.model_for(:prefixes)
 
     attribute :schema_version, :string
+    attribute :version, :string
     attribute :prefixes, Prefix, collection: true
   end
 end

data/lib/unitsdb/quantities.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-require_relative "quantity"
-
 module Unitsdb
   class Quantities < Lutaml::Model::Serializable
     # model Config.model_for(:quantities)
     attribute :schema_version, :string
+    attribute :version, :string
     attribute :quantities, Quantity, collection: true
   end
 end

data/lib/unitsdb/quantity.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "identifier"
-require_relative "unit_reference"
-require_relative "dimension_reference"
-require_relative "external_reference"
-require_relative "localized_string"
-
 module Unitsdb
   class Quantity < Lutaml::Model::Serializable
     # model Config.model_for(:quantity)

data/lib/unitsdb/qudt.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Unitsdb
+  # QUDT Unit from units vocabulary
+  # Example: http://qudt.org/vocab/unit/M (meter)
+  class QudtUnit < Lutaml::Model::Serializable
+    attribute :uri, :string
+    attribute :label, :string
+    attribute :symbol, :string
+    attribute :has_quantity_kind, :string
+    attribute :has_dimension_vector, :string
+    attribute :conversion_multiplier, :float
+    attribute :conversion_offset, :float
+    attribute :description, :string
+    attribute :si_exact_match, :string
+
+    def identifier
+      "qudt:unit:#{uri}"
+    end
+  end
+
+  # QUDT QuantityKind from quantitykinds vocabulary
+  # Example: http://qudt.org/vocab/quantitykind/Length
+  class QudtQuantityKind < Lutaml::Model::Serializable
+    attribute :uri, :string
+    attribute :label, :string
+    attribute :has_dimension_vector, :string
+    attribute :description, :string
+    attribute :symbol, :string
+    attribute :si_exact_match, :string
+
+    def identifier
+      "qudt:quantitykind:#{uri}"
+    end
+  end
+
+  # QUDT DimensionVector from dimensionvectors vocabulary
+  # Example: http://qudt.org/vocab/dimensionvector/A0E0L1I0M0H0T0D0
+  class QudtDimensionVector < Lutaml::Model::Serializable
+    attribute :uri, :string
+    attribute :label, :string
+    attribute :dimension_exponent_for_length, :integer
+    attribute :dimension_exponent_for_mass, :integer
+    attribute :dimension_exponent_for_time, :integer
+    attribute :dimension_exponent_for_electric_current, :integer
+    attribute :dimension_exponent_for_thermodynamic_temperature, :integer
+    attribute :dimension_exponent_for_amount_of_substance, :integer
+    attribute :dimension_exponent_for_luminous_intensity, :integer
+    attribute :description, :string
+
+    def identifier
+      "qudt:dimensionvector:#{uri}"
+    end
+  end
+
+  # QUDT SystemOfUnits from sou vocabulary
+  # Example: http://qudt.org/vocab/sou/SI
+  class QudtSystemOfUnits < Lutaml::Model::Serializable
+    attribute :uri, :string
+    attribute :label, :string
+    attribute :abbreviation, :string
+    attribute :description, :string
+
+    def identifier
+      "qudt:sou:#{uri}"
+    end
+  end
+
+  # QUDT Prefix from prefixes vocabulary
+  # Example: http://qudt.org/vocab/prefix/Kilo
+  class QudtPrefix < Lutaml::Model::Serializable
+    attribute :uri, :string
+    attribute :label, :string
+    attribute :symbol, :string
+    attribute :prefix_multiplier, :float
+    attribute :prefix_multiplier_sn, :string
+    attribute :ucum_code, :string
+    attribute :si_exact_match, :string
+    attribute :description, :string
+    attribute :prefix_type, :string # "DecimalPrefix" or "BinaryPrefix"
+
+    def identifier
+      "qudt:prefix:#{uri}"
+    end
+  end
+
+  # Container for all QUDT vocabularies
+  class QudtVocabularies
+    attr_accessor :units, :quantity_kinds, :dimension_vectors,
+                  :systems_of_units, :prefixes
+
+    def initialize
+      @units = []
+      @quantity_kinds = []
+      @dimension_vectors = []
+      @systems_of_units = []
+      @prefixes = []
+    end
+  end
+end

data/lib/unitsdb/root_unit_reference.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "unit_reference"
-require_relative "prefix_reference"
-
 module Unitsdb
   class RootUnitReference < Lutaml::Model::Serializable
     # model Config.model_for(:root_unit)

data/lib/unitsdb/scale.rb

@@ -1,9 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "identifier"
-require_relative "localized_string"
-require_relative "scale_properties"
-
 module Unitsdb
   class Scale < Lutaml::Model::Serializable
     # model Config.model_for(:quantity)

data/lib/unitsdb/scale_reference.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "identifier"
-
 module Unitsdb
   class ScaleReference < Identifier
     attribute :id, :string

data/lib/unitsdb/scales.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-require_relative "scale"
-
 module Unitsdb
   class Scales < Lutaml::Model::Serializable
     # model Config.model_for(:Scale)
     attribute :schema_version, :string
+    attribute :version, :string
     attribute :scales, Scale, collection: true
   end
 end

data/lib/unitsdb/si_derived_base.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "root_unit_reference"
-
 # si_derived_bases:
 # - power: 2
 #   unit_reference: