unitsdb 2.1.0 → 2.1.1

data/lib/unitsdb/commands/ucum/updater.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require "yaml"
+require "fileutils"
+
+module Unitsdb
+  module Commands
+    module Ucum
+      # Updater for adding UCUM references to UnitsDB entities
+      module Updater
+        UCUM_AUTHORITY = "ucum"
+
+        module_function
+
+        # Update references in UnitsDB entities with UCUM references
+        def update_references(entity_type, matches, db_entities, output_file, include_potential = false)
+          puts "Updating UCUM references for #{entity_type}..."
+
+          # Create a map of entity IDs to their UCUM references
+          entity_references = {}
+
+          # Process each match
+          matches.each do |match|
+            db_entity = match[:db_entity]
+            ucum_entity = match[:ucum_entity]
+
+            # Skip potential matches unless specified
+            next if match[:potential] && !include_potential
+
+            # Get entity ID
+            entity_id = get_entity_id(db_entity)
+            next unless entity_id
+
+            # Initialize references for this entity
+            entity_references[entity_id] = ExternalReference.new(
+              uri: ucum_entity.identifier,
+              type: "informative",
+              authority: UCUM_AUTHORITY
+            )
+          end
+
+          # Update the YAML content
+          db_entities.send(entity_type).each do |entity|
+            # Find entity by ID
+            entity_id = if entity.identifiers
+                          begin
+                            entity.identifiers.first.id
+                          rescue StandardError
+                            nil
+                          end
+                        end
+
+            next unless entity_id && entity_references.key?(entity_id)
+
+            # Initialize references array if it doesn't exist
+            entity.references ||= []
+
+            # Add new references
+            if (ext_ref = entity_references[entity_id])
+              if entity.references.detect { |ref| ref.uri == ext_ref.uri && ref.authority == ext_ref.authority }
+                # Skip if reference already exists
+                puts "Reference already exists for entity ID: #{entity_id}"
+              else
+                # Add the reference
+                puts "Adding reference for entity ID: #{entity_id}, URI: #{ext_ref.uri}, Authority: #{ext_ref.authority}"
+                entity.references << ext_ref
+              end
+            end
+          end
+
+          # Write to YAML file
+          write_yaml_file(output_file, db_entities)
+
+          puts "Added #{entity_references.values.flatten.size} UCUM references to #{entity_type}"
+        end
+
+        # Helper to write YAML file
+        def write_yaml_file(output_file, output_data)
+          # Ensure the output directory exists
+          output_dir = File.dirname(output_file)
+          FileUtils.mkdir_p(output_dir) unless Dir.exist?(output_dir)
+
+          # Write to YAML file
+          File.write(output_file, output_data.to_yaml)
+        end
+
+        # Get entity ID (either from identifiers array or directly)
+        def get_entity_id(entity)
+          if entity.respond_to?(:identifiers) && entity.identifiers && !entity.identifiers.empty?
+            entity.identifiers.first.id
+          elsif entity.respond_to?(:id)
+            entity.id
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unitsdb/commands/ucum/xml_parser.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "../../ucum"
+
+module Unitsdb
+  module Commands
+    module Ucum
+      # Parser for UCUM XML files
+      module XmlParser
+        module_function
+
+        # Parse UCUM XML file and return parsed data
+        def parse_ucum_file(file_path)
+          puts "Parsing UCUM XML file: #{file_path}..."
+          content = File.read(file_path)
+          Unitsdb::UcumFile.from_xml(content)
+        end
+
+        # Get entities from parsed UCUM data based on entity type
+        def get_entities_from_ucum(entity_type, ucum_data)
+          case entity_type
+          when "prefixes"
+            ucum_data.prefixes
+          when "units"
+            # Combine base-units and units into a single array
+            ucum_data.base_units + ucum_data.units
+          else
+            []
+          end
+        end
+      end
+    end
+  end
+end

data/lib/unitsdb/commands/ucum.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module Unitsdb
+  module Commands
+    class UcumCommand < Thor
+      desc "check", "Check UCUM references in UnitsDB"
+      option :entity_type, type: :string, aliases: "-e",
+                           desc: "Entity type to check (units, prefixes). If not specified, all types are checked"
+      option :ucum_file, type: :string, required: true, aliases: "-u",
+                         desc: "Path to the UCUM essence XML file"
+      option :output_updated_database, type: :string, aliases: "-o",
+                                       desc: "Directory path to write updated YAML files with added UCUM references"
+      option :direction, type: :string, default: "both", aliases: "-r",
+                         desc: "Direction to check: 'to_ucum' (UnitsDB→UCUM), 'from_ucum' (UCUM→UnitsDB), or 'both'"
+      option :include_potential_matches, type: :boolean, default: false, aliases: "-p",
+                                         desc: "Include potential matches when updating references (default: false)"
+      option :database, type: :string, required: true, aliases: "-d",
+                        desc: "Path to UnitsDB database (required)"
+      def check
+        require_relative "ucum/check"
+        Ucum::Check.new(options).run
+      end
+
+      desc "update", "Update UnitsDB with UCUM references"
+      option :entity_type, type: :string, aliases: "-e",
+                           desc: "Entity type to update (units, prefixes). If not specified, all types are updated"
+      option :ucum_file, type: :string, required: true, aliases: "-u",
+                         desc: "Path to the UCUM essence XML file"
+      option :output_dir, type: :string, aliases: "-o",
+                          desc: "Directory path to write updated YAML files (defaults to database path)"
+      option :include_potential_matches, type: :boolean, default: false, aliases: "-p",
+                                         desc: "Include potential matches when updating references (default: false)"
+      option :database, type: :string, required: true, aliases: "-d",
+                        desc: "Path to UnitsDB database (required)"
+      def update
+        require_relative "ucum/update"
+        Ucum::Update.new(options).run
+      end
+    end
+  end
+end

data/lib/unitsdb/commands/validate/identifiers.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require_relative "../base"
+
 module Unitsdb
   module Commands
     module Validate
-      class Identifiers < Base
+      class Identifiers < Unitsdb::Commands::Base
         def run
           db = load_database
           all_dups = db.validate_uniqueness

data/lib/unitsdb/commands/validate/references.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require_relative "../base"
+
 module Unitsdb
   module Commands
     module Validate
-      class References < Base
+      class References < Unitsdb::Commands::Base
         def run
           # Load the database
           db = load_database(@options[:database])

data/lib/unitsdb/commands/validate/si_references.rb

@@ -103,12 +103,6 @@ module Unitsdb
           puts "Please fix the duplicates by either removing the reference from all but one entity,"
           puts "or by updating the references to use different URIs appropriate for each entity."
         end
-
-        def load_database(path)
-          Unitsdb::Database.from_db(path)
-        rescue StandardError => e
-          raise Unitsdb::Errors::DatabaseError, "Failed to load database: #{e.message}"
-        end
       end
     end
   end

data/lib/unitsdb/commands/validate.rb

@@ -13,7 +13,7 @@ module Unitsdb
       def references
         require_relative "validate/references"
 
-        Commands::References.new(options).run
+        Commands::Validate::References.new(options).run
       end
 
       desc "identifiers", "Check for uniqueness of identifier fields"
@@ -23,7 +23,7 @@ module Unitsdb
       def identifiers
         require_relative "validate/identifiers"
 
-        Commands::Identifiers.new(options).run
+        Commands::Validate::Identifiers.new(options).run
       end
 
       desc "si_references", "Validate that each SI digital framework reference is unique per entity type"
@@ -33,7 +33,7 @@ module Unitsdb
       def si_references
         require_relative "validate/si_references"
 
-        Validate::SiReferences.new(options).run
+        Commands::Validate::SiReferences.new(options).run
       end
     end
   end

data/lib/unitsdb/database.rb

@@ -12,6 +12,7 @@ module Unitsdb
     # 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

data/lib/unitsdb/dimensions.rb

@@ -7,6 +7,7 @@ module Unitsdb
     # model Config.model_for(:dimensions)
 
     attribute :schema_version, :string
+    attribute :version, :string
     attribute :dimensions, Dimension, collection: true
   end
 end

data/lib/unitsdb/prefixes.rb

@@ -17,6 +17,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

@@ -6,6 +6,7 @@ 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/scales.rb

@@ -6,6 +6,7 @@ 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/ucum.rb

@@ -0,0 +1,198 @@
+# frozen_string_literal: true
+
+require "lutaml/model"
+
+module Unitsdb
+  # <base-unit Code="s" CODE="S" dim="T">
+  #   <name>second</name>
+  #   <printSymbol>s</printSymbol>
+  #   <property>time</property>
+  #  </base-unit>
+  class UcumBaseUnit < Lutaml::Model::Serializable
+    attribute :code_sensitive, :string
+    attribute :code, :string
+    attribute :dimension, :string
+    attribute :name, :string
+    attribute :print_symbol, :string, raw: true
+    attribute :property, :string
+
+    xml do
+      root "base-unit"
+      map_attribute "Code", to: :code_sensitive
+      map_attribute "CODE", to: :code
+      map_attribute "dim", to: :dimension
+      map_element "name", to: :name
+      map_element "printSymbol", to: :print_symbol
+      map_element "property", to: :property
+    end
+
+    def identifier
+      "ucum:base-unit:code:#{code_sensitive}"
+    end
+  end
+
+  #  <prefix Code="Y" CODE="YA">
+  #   <name>yotta</name>
+  #   <printSymbol>Y</printSymbol>
+  #   <value value="1e24">1 &#215; 10<sup>24</sup>
+  #   </value>
+  #  </prefix>
+
+  class UcumPrefixValue < Lutaml::Model::Serializable
+    attribute :value, :string
+    attribute :content, :string
+
+    xml do
+      root "value"
+      map_attribute "value", to: :value
+      map_content to: :content
+    end
+  end
+
+  class UcumPrefix < Lutaml::Model::Serializable
+    attribute :code_sensitive, :string
+    attribute :code, :string
+    attribute :name, :string
+    attribute :print_symbol, :string, raw: true
+    attribute :value, UcumPrefixValue
+
+    xml do
+      root "prefix"
+      map_attribute "Code", to: :code_sensitive
+      map_attribute "CODE", to: :code
+      map_element "name", to: :name
+      map_element "printSymbol", to: :print_symbol
+      map_element "value", to: :value
+    end
+
+    def identifier
+      "ucum:prefix:code:#{code_sensitive}"
+    end
+  end
+
+  #  <unit Code="10*" CODE="10*" isMetric="no" class="dimless">
+  #   <name>the number ten for arbitrary powers</name>
+  #   <printSymbol>10</printSymbol>
+  #   <property>number</property>
+  #   <value Unit="1" UNIT="1" value="10">10</value>
+  #  </unit>
+
+  #  <unit Code="gon" CODE="GON" isMetric="no" class="iso1000">
+  #     <name>gon</name>
+  #     <name>grade</name>
+  #     <printSymbol>
+  #        <sup>g</sup>
+  #     </printSymbol>
+  #     <property>plane angle</property>
+  #     <value Unit="deg" UNIT="DEG" value="0.9">0.9</value>
+  #  </unit>
+
+  # <unit Code="[D'ag'U]" CODE="[D'AG'U]" isMetric="no" isArbitrary="yes"
+  #       class="chemical">
+  #   <name>D-antigen unit</name>
+  #   <printSymbol/>
+  #   <property>procedure defined amount of a poliomyelitis d-antigen substance</property>
+  #   <value Unit="1" UNIT="1" value="1">1</value>
+  #  </unit>
+
+  #    <unit Code="Cel" CODE="CEL" isMetric="yes" isSpecial="yes" class="si">
+  #     <name>degree Celsius</name>
+  #     <printSymbol>&#176;C</printSymbol>
+  #     <property>temperature</property>
+  #     <value Unit="cel(1 K)" UNIT="CEL(1 K)">
+  #        <function name="Cel" value="1" Unit="K"/>
+  #     </value>
+  #  </unit>
+
+  class UcumUnitValueFunction < Lutaml::Model::Serializable
+    attribute :name, :string
+    attribute :value, :string
+    attribute :unit_sensitive, :string
+
+    xml do
+      root "function"
+      map_attribute "name", to: :name
+      map_attribute "value", to: :value
+      map_attribute "Unit", to: :unit_sensitive
+    end
+  end
+
+  class UcumUnitValue < Lutaml::Model::Serializable
+    attribute :unit_sensitive, :string
+    attribute :unit, :string
+    attribute :value, :string
+    attribute :function, UcumUnitValueFunction
+    attribute :content, :string
+
+    xml do
+      root "value"
+      map_attribute "Unit", to: :unit_sensitive
+      map_attribute "UNIT", to: :unit
+      map_attribute "value", to: :value
+      map_element "function", to: :function
+      map_content to: :content
+    end
+  end
+
+  class UcumUnit < Lutaml::Model::Serializable
+    attribute :code_sensitive, :string
+    attribute :code, :string
+    attribute :is_metric, :string
+    attribute :is_arbitrary, :string
+    attribute :is_special, :string
+    attribute :klass, :string
+    attribute :name, :string, collection: true
+    attribute :print_symbol, :string, raw: true
+    attribute :property, :string
+    attribute :value, UcumUnitValue
+
+    xml do
+      root "unit"
+      map_attribute "Code", to: :code_sensitive
+      map_attribute "CODE", to: :code
+      map_attribute "isMetric", to: :is_metric
+      map_attribute "isArbitrary", to: :is_arbitrary
+      map_attribute "isSpecial", to: :is_special
+      map_attribute "class", to: :klass
+
+      map_element "name", to: :name
+      map_element "printSymbol", to: :print_symbol
+      map_element "property", to: :property
+      map_element "value", to: :value
+    end
+
+    def identifier
+      # Use empty string if klass is not present
+      k = klass || ""
+      "ucum:unit:#{k}:code:#{code_sensitive}"
+    end
+  end
+
+  # This is the root element of the UCUM XML "ucum-essence.xml" file.
+  #
+  # <root xmlns="http://unitsofmeasure.org/ucum-essence" version="2.2" revision="N/A"
+  #     revision-date="2024-06-17">
+
+  class UcumFile < Lutaml::Model::Serializable
+    attribute :revision, :string
+    attribute :version, :string
+    attribute :revision_date, :date
+    attribute :prefixes, UcumPrefix, collection: true
+    attribute :base_units, UcumBaseUnit, collection: true
+    attribute :units, UcumUnit, collection: true
+
+    xml do
+      root "root"
+      namespace "http://unitsofmeasure.org/ucum-essence"
+      map_attribute "version", to: :version
+      map_attribute "revision", to: :revision
+      map_attribute "revision-date", to: :revision_date
+
+      map_element "prefix", to: :prefixes
+      map_element "base-unit", to: :base_units
+      map_element "unit", to: :units
+    end
+
+    # No adapter registration needed
+  end
+end

data/lib/unitsdb/unit_systems.rb

@@ -7,6 +7,7 @@ module Unitsdb
     # model Config.model_for(:unit_systems)
 
     attribute :schema_version, :string
+    attribute :version, :string
     attribute :unit_systems, UnitSystem, collection: true
   end
 end

data/lib/unitsdb/units.rb

@@ -7,6 +7,7 @@ module Unitsdb
     # model Config.model_for(:units)
 
     attribute :schema_version, :string
+    attribute :version, :string
     attribute :units, Unit, collection: true
   end
 end

data/lib/unitsdb/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Unitsdb
-  VERSION = "2.1.0"
+  VERSION = "2.1.1"
 end

data/unitsdb.gemspec

@@ -19,8 +19,6 @@ Gem::Specification.new do |spec|
   spec.metadata["source_code_uri"] = spec.homepage
   spec.metadata["changelog_uri"] = "https://github.com/unitsml/unitsdb-ruby/releases"
 
-  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
-
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unitsdb
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-20 00:00:00.000000000 Z
+date: 2025-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lutaml-model
@@ -132,6 +132,13 @@ files:
 - lib/unitsdb/commands/si_matcher.rb
 - lib/unitsdb/commands/si_ttl_parser.rb
 - lib/unitsdb/commands/si_updater.rb
+- lib/unitsdb/commands/ucum.rb
+- lib/unitsdb/commands/ucum/check.rb
+- lib/unitsdb/commands/ucum/formatter.rb
+- lib/unitsdb/commands/ucum/matcher.rb
+- lib/unitsdb/commands/ucum/update.rb
+- lib/unitsdb/commands/ucum/updater.rb
+- lib/unitsdb/commands/ucum/xml_parser.rb
 - lib/unitsdb/commands/validate.rb
 - lib/unitsdb/commands/validate/identifiers.rb
 - lib/unitsdb/commands/validate/references.rb
@@ -159,6 +166,7 @@ files:
 - lib/unitsdb/scales.rb
 - lib/unitsdb/si_derived_base.rb
 - lib/unitsdb/symbol_presentations.rb
+- lib/unitsdb/ucum.rb
 - lib/unitsdb/unit.rb
 - lib/unitsdb/unit_reference.rb
 - lib/unitsdb/unit_system.rb