unitsdb 0.1.1 → 2.0.1

data/lib/unitsdb/dimension.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "dimension_quantity"
+require_relative "identifier"
+require_relative "dimension_details"
+require_relative "quantity"
+require_relative "localized_string"
 # NISTd1:
 #   length:
-#     powerNumerator: 1
+#     power: 1
 #     symbol: L
 #     dim_symbols:
 #     - id: "dim_L"
@@ -23,33 +26,24 @@ require_relative "dimension_quantity"
 # -    latex: "\\ensuremath{\\mathsf{\\phi}}"
 # -    mathml: "<mi mathvariant='sans-serif'>&#x3c6;</mi>"
 # -    unicode: "\U0001D785"
-# -  powerNumerator: 1
+# -  power: 1
 # -  symbol: phi
 
 module Unitsdb
   class Dimension < Lutaml::Model::Serializable
-    attribute :id, :string
-    attribute :dimensionless, :boolean
-    attribute :length, DimensionQuantity
-    attribute :mass, DimensionQuantity
-    attribute :time, DimensionQuantity
-    attribute :electric_current, DimensionQuantity
-    attribute :thermodynamic_temperature, DimensionQuantity
-    attribute :amount_of_substance, DimensionQuantity
-    attribute :luminous_intensity, DimensionQuantity
-    attribute :plane_angle, DimensionQuantity
+    # model Config.model_for(:dimension)
 
-    key_value do
-      map :id, to: :id
-      map :dimensionless, to: :dimensionless
-      map :length, to: :length
-      map :mass, to: :mass
-      map :time, to: :time
-      map :electric_current, to: :electric_current
-      map :thermodynamic_temperature, to: :thermodynamic_temperature
-      map :amount_of_substance, to: :amount_of_substance
-      map :luminous_intensity, to: :luminous_intensity
-      map :plane_angle, to: :plane_angle
-    end
+    attribute :identifiers, Identifier, collection: true
+    attribute :dimensionless, :boolean
+    attribute :length, DimensionDetails
+    attribute :mass, DimensionDetails
+    attribute :time, DimensionDetails
+    attribute :electric_current, DimensionDetails
+    attribute :thermodynamic_temperature, DimensionDetails
+    attribute :amount_of_substance, DimensionDetails
+    attribute :luminous_intensity, DimensionDetails
+    attribute :plane_angle, DimensionDetails
+    attribute :short, :string
+    attribute :names, LocalizedString, collection: true
   end
 end

data/lib/unitsdb/dimension_details.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# power: 1
+# symbol: M
+# symbols:
+# - ascii: M
+#   html: "𝖬"
+#   id: dim_M
+#   latex: "\\ensuremath{\\mathsf{M}}"
+#   mathml: "<mi mathvariant='sans-serif'>M</mi>"
+#   unicode: "\U0001D5AC"
+
+require_relative "symbol_presentations"
+module Unitsdb
+  class DimensionDetails < Lutaml::Model::Serializable
+    attribute :power, :integer
+    attribute :symbol, :string
+    attribute :symbols, SymbolPresentations, collection: true
+  end
+end

data/lib/unitsdb/dimension_reference.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Unitsdb
+  class DimensionReference < Identifier
+    attribute :id, :string
+    attribute :type, :string
+  end
+end

data/lib/unitsdb/dimensions.rb

@@ -4,12 +4,10 @@ require_relative "dimension"
 
 module Unitsdb
   class Dimensions < Lutaml::Model::Serializable
-    attribute :dimension, Dimension, collection: true
+    # model Config.model_for(:dimensions)
 
-    key_value do
-      map to: :dimension, root_mappings: {
-        id: :key
-      }
-    end
+    attribute :schema_version, :string
+    attribute :version, :string
+    attribute :dimensions, Dimension, collection: true
   end
 end

data/lib/unitsdb/errors.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Unitsdb
+  module Errors
+    class DatabaseError < StandardError; end
+    class DatabaseNotFoundError < DatabaseError; end
+    class DatabaseFileNotFoundError < DatabaseError; end
+    class DatabaseFileInvalidError < DatabaseError; end
+    class DatabaseLoadError < DatabaseError; end
+    class VersionMismatchError < DatabaseError; end
+    class UnsupportedVersionError < DatabaseError; end
+  end
+end

data/lib/unitsdb/external_reference.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# references:
+# - uri: http://si-digital-framework.org/quantities/LENG
+#   type: normative
+#   authority: si-digital-framework
+
+module Unitsdb
+  class ExternalReference < Identifier
+    attribute :uri, :string
+    attribute :type, :string, values: %w[normative informative]
+    attribute :authority, :string
+  end
+end

data/lib/unitsdb/identifier.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Unitsdb
+  class Identifier < Lutaml::Model::Serializable
+    attribute :id, :string
+    attribute :type, :string
+  end
+end

data/lib/unitsdb/localized_string.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Unitsdb
+  # Represents a localized string with a language tag
+  class LocalizedString < Lutaml::Model::Serializable
+    attribute :value, :string
+    attribute :lang, :string
+
+    def to_s
+      "#{value} (#{lang})"
+    end
+
+    def downcase
+      value&.downcase
+    end
+  end
+end

data/lib/unitsdb/prefix.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
-require_relative "prefix_symbol"
+require_relative "identifier"
+require_relative "symbol_presentations"
+require_relative "external_reference"
+require_relative "localized_string"
 # ---
 # NISTp10_30:
 #   name: quetta
@@ -14,18 +17,14 @@ require_relative "prefix_symbol"
 
 module Unitsdb
   class Prefix < Lutaml::Model::Serializable
-    attribute :id, :string
-    attribute :name, :string
-    attribute :symbol, PrefixSymbol
+    # model Config.model_for(:prefix)
+
+    attribute :identifiers, Identifier, collection: true
+    attribute :names, LocalizedString, collection: true
+    attribute :short, :string
+    attribute :symbols, SymbolPresentations, collection: true
     attribute :base, :integer
     attribute :power, :integer
-
-    key_value do
-      map :id, to: :id
-      map :name, to: :name
-      map :symbol, to: :symbol
-      map :base, to: :base
-      map :power, to: :power
-    end
+    attribute :references, ExternalReference, collection: true
   end
 end

data/lib/unitsdb/prefix_reference.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "identifier"
+
+module Unitsdb
+  class PrefixReference < Identifier
+    attribute :id, :string
+    attribute :type, :string
+  end
+end

data/lib/unitsdb/prefixes.rb

@@ -14,12 +14,10 @@ require_relative "prefix"
 
 module Unitsdb
   class Prefixes < Lutaml::Model::Serializable
-    attribute :prefix, Prefix, collection: true
+    # model Config.model_for(:prefixes)
 
-    key_value do
-      map to: :prefix, root_mappings: {
-        id: :key
-      }
-    end
+    attribute :schema_version, :string
+    attribute :version, :string
+    attribute :prefixes, Prefix, collection: true
   end
 end

data/lib/unitsdb/quantities.rb

@@ -1,35 +1,12 @@
 # frozen_string_literal: true
 
-# # Quantities
-# NISTq156:
-#   dimension_url: "#NISTd68"
-#   quantity_type: derived
-#   quantity_name:
-#       - linear expansion coefficient
-#   unit_reference:
-#       - name: kelvin to the power minus one
-#         url: "#NISTu5e-1/1"
-
-# NISTq155:
-#   dimension_url: "#NISTd57"
-#   quantity_type: derived
-#   quantity_name:
-#     - area moment of inertia
-#     - second moment of area
-#   unit_reference:
-#     - name: inch to the fourth power
-#       url: "#NISTu208"
-
 require_relative "quantity"
 
 module Unitsdb
   class Quantities < Lutaml::Model::Serializable
-    attribute :quantity, Quantity, collection: true
-
-    key_value do
-      map to: :quantity, root_mappings: {
-        id: :key
-      }
-    end
+    # 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,33 +1,21 @@
 # frozen_string_literal: true
 
-# # Quantities
-# NISTq156:
-#   dimension_url: "#NISTd68"
-#   quantity_type: derived
-#   quantity_name:
-#       - linear expansion coefficient
-#   unit_reference:
-#       - name: kelvin to the power minus one
-#         url: "#NISTu5e-1/1"
-
-# NISTq155:
-#   dimension_url: "#NISTd57"
-#   quantity_type: derived
-#   quantity_name:
-#     - area moment of inertia
-#     - second moment of area
-#   unit_reference:
-#     - name: inch to the fourth power
-#       url: "#NISTu208"
-
+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
-    attribute :id, :string
-    attribute :dimension_url, :string
+    # model Config.model_for(:quantity)
+
+    attribute :identifiers, Identifier, collection: true
     attribute :quantity_type, :string
-    attribute :quantity_name, :string, collection: true
-    attribute :unit_reference, UnitReference, collection: true
+    attribute :names, LocalizedString, collection: true
+    attribute :short, :string
+    attribute :unit_references, UnitReference, collection: true
+    attribute :dimension_reference, DimensionReference
+    attribute :references, ExternalReference, collection: true
   end
 end

data/lib/unitsdb/quantity_reference.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
 
 module Unitsdb
-  class QuantityReference < Lutaml::Model::Serializable
-    attribute :name, :string
-    attribute :url, :string
+  class QuantityReference < Identifier
+    # model Config.model_for(:quantity_reference)
 
-    key_value do
-      map :name, to: :name
-      map :url, to: :url
-    end
+    attribute :id, :string
+    attribute :type, :string
   end
 end

data/lib/unitsdb/root_unit_reference.rb

@@ -0,0 +1,14 @@
+# 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)
+
+    attribute :power, :integer
+    attribute :unit_reference, UnitReference
+    attribute :prefix_reference, PrefixReference
+  end
+end

data/lib/unitsdb/scale.rb

@@ -0,0 +1,17 @@
+# 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)
+
+    attribute :identifiers, Identifier, collection: true
+    attribute :names, LocalizedString, collection: true
+    attribute :description, LocalizedString, collection: true
+    attribute :short, :string
+    attribute :properties, ScaleProperties
+  end
+end

data/lib/unitsdb/scale_properties.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Unitsdb
+  class ScaleProperties < Lutaml::Model::Serializable
+    # model Config.model_for(:quantity)
+    attribute :continuous, :boolean
+    attribute :ordered, :boolean
+    attribute :logarithmic, :boolean
+    attribute :interval, :boolean
+    attribute :ratio, :boolean
+  end
+end

data/lib/unitsdb/scale_reference.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "identifier"
+
+module Unitsdb
+  class ScaleReference < Identifier
+    attribute :id, :string
+    attribute :type, :string
+  end
+end

data/lib/unitsdb/scales.rb

@@ -0,0 +1,12 @@
+# 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,20 +1,19 @@
 # frozen_string_literal: true
 
-# - id: NISTu1
-#   prefix:
-#   power: 1
-# - id: NISTu1
-#   prefix:
-#   power: -1
+require_relative "root_unit_reference"
 
-class SiDerivedBase < Lutaml::Model::Serializable
-  attribute :id, :string
-  attribute :prefix, :string
-  attribute :power, :integer
+# si_derived_bases:
+# - power: 2
+#   unit_reference:
+#     id: NISTu1
+#     type: nist
+# - power: -2
+#   unit_reference:
+#     id: NISTu1
+#     type: nist
 
-  key_value do
-    map :id, to: :id
-    map :prefix, to: :prefix, render_nil: true
-    map :power, to: :power
+module Unitsdb
+  class SiDerivedBase < RootUnitReference
+    # model Config.model_for(:si_derived_base)
   end
 end

data/lib/unitsdb/symbol_presentations.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Unitsdb
+  class SymbolPresentations < Lutaml::Model::Serializable
+    # model Config.model_for(:symbol_presentations)
+
+    attribute :id, :string
+    attribute :ascii, :string
+    attribute :html, :string
+    attribute :latex, :string
+    attribute :mathml, :string
+    attribute :unicode, :string
+  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