asciimath2unitsml 0.3.1 → 0.4.1

data/lib/asciimath2unitsml/validate.rb

@@ -0,0 +1,59 @@
+module Asciimath2UnitsML
+  class Conv
+    def validate_yaml(hash, path)
+      return hash if path == "../unitsdb/quantities.yaml"
+      return hash if path == "../unitsdb/dimensions.yaml"
+
+      hash.each_with_object({}) do |(k, v), m|
+        path == "../unitsdb/units.yaml" and validate_unit(v)
+        m = validate_symbols(m, v)
+        v[:unit_symbols]&.each { |s| validate_unit_symbol_cardinality(s, k) }
+      end
+      hash
+    end
+
+    def validate_unit(unit)
+      if unit[:quantity_reference]
+        unit[:quantity_reference].is_a?(Array) or
+          raise StandardError
+            .new "No quantity_reference array provided for unit: #{unit}"
+      end
+      if unit[:unit_name]
+        unit[:unit_name].is_a?(Array) or
+          raise StandardError
+            .new "No unit_name array provided for unit: #{unit}"
+      end
+    end
+
+    def validate_symbols(acc, val)
+      symbol = symbol_key(val)
+      !symbol.nil? or
+        raise StandardError.new "No symbol provided for unit: #{val}"
+      Array(symbol)&.each do |s|
+        acc[s] && s != "1" and
+          raise StandardError.new "symbol #{s} is not unique in #{val}: "\
+          "already used for #{acc[s]}"
+        acc[s] = val
+      end
+      acc
+    end
+
+    def validate_unit_symbol_cardinality(sym, key)
+      return true if sym.nil?
+
+      !sym[:id].nil? && !sym[:ascii].nil? && !sym[:html].nil? &&
+        !sym[:mathml].nil? && !sym[:latex].nil? &&
+        !sym[:unicode].nil? and return true
+      raise StandardError.new "malformed unit_symbol for #{key}: #{sym}"
+    end
+
+    def symbol_key(val)
+      symbol = val[:unit_symbols]&.each_with_object([]) do |s, m|
+        m << (s["id"] || s[:id])
+      end || val.dig(:symbol, :ascii) || val[:symbol] # || val[:short]
+      !symbol.nil? && val[:unit_symbols] && !symbol.is_a?(Array) and
+        symbol = [symbol]
+      symbol
+    end
+  end
+end

data/lib/asciimath2unitsml/version.rb

@@ -1,3 +1,3 @@
 module Asciimath2UnitsML
-  VERSION = '0.3.1'.freeze
+  VERSION = "0.4.1".freeze
 end

data/lib/asciimath2unitsml.rb

@@ -1,4 +1,3 @@
 require_relative "asciimath2unitsml/version"
 require_relative "asciimath2unitsml/conv"
 require_relative "unitsdb_ruby/unitsdb"
-

data/lib/unitsdb/dimensions.yaml

@@ -3,36 +3,86 @@ NISTd1:
   length:
     powerNumerator: 1
     symbol: L
+    dim_symbols:
+    - id: "dim_L"
+      ascii: "L"
+      html: "𝖫"
+      mathml: "<mi mathvariant='sans-serif'>L</mi>"
+      latex: \ensuremath{\mathsf{L}}
+      unicode: "𝖫"
+
 
 NISTd2:
   mass:
     powerNumerator: 1
     symbol: M
+    dim_symbols:
+    - id: "dim_M"
+      ascii: "M"
+      html: "&#x1D5AC;"
+      mathml: "<mi mathvariant='sans-serif'>M</mi>"
+      latex: \ensuremath{\mathsf{M}}
+      unicode: "𝖬"
 
 NISTd3:
   time:
     powerNumerator: 1
     symbol: T
+    dim_symbols:
+    - id: "dim_T"
+      ascii: "T"
+      html: "&#x1D5B3;"
+      mathml: "<mi mathvariant='sans-serif'>T</mi>"
+      latex: \ensuremath{\mathsf{T}}
+      unicode: "𝖳"
 
 NISTd4:
   electric_current:
     powerNumerator: 1
     symbol: I
+    dim_symbols:
+    - id: "dim_T"
+      ascii: "T"
+      html: "&#x1D5A8;"
+      mathml: "<mi mathvariant='sans-serif'>T</mi>"
+      latex: \ensuremath{\mathsf{T}}
+      unicode: "𝖨"
 
 NISTd5:
   thermodynamic_temperature:
     powerNumerator: 1
-    symbol:
+    symbol: Theta
+    dim_symbols:
+    - id: "dim_Theta"
+      ascii: "Theta"
+      html: "&#x1D760;"
+      mathml: "<mi mathvariant='sans-serif'>&#x398;</mi>"
+      latex: \ensuremath{\mathsf{\Theta}}
+      unicode: "𝝧"
 
 NISTd6:
   amount_of_substance:
     powerNumerator: 1
     symbol: N
+    dim_symbols:
+    - id: "dim_N"
+      ascii: "N"
+      html: "&#x1D5AD;"
+      mathml: "<mi mathvariant='sans-serif'>N</mi>"
+      latex: \ensuremath{\mathsf{N}}
+      unicode: "𝖭"
 
 NISTd7:
   luminous_intensity:
     powerNumerator: 1
     symbol: J
+    dim_symbols:
+    - id: "dim_J"
+      ascii: "J"
+      html: "&#x1D5A9;"
+      mathml: "<mi mathvariant='sans-serif'>J</mi>"
+      latex: \ensuremath{\mathsf{J}}
+      unicode: "𝖩"
 
 NISTd8:
   length:
@@ -44,6 +94,13 @@ NISTd9:
   plane_angle:
     powerNumerator: 1
     symbol: phi
+    dim_symbols:
+    - id: "dim_phi"
+      ascii: "phi"
+      html: "&#x1D785;"
+      mathml: "<mi mathvariant='sans-serif'>&#x3c6;</mi>"
+      latex: \ensuremath{\mathsf{\phi}}
+      unicode: "𝞅"
 
 NISTd10:
   length:
@@ -312,7 +369,7 @@ NISTd39:
     symbol: T
   thermodynamic_temperature:
     powerNumerator: -1
-    symbol:
+    symbol: Theta
 
 NISTd36:
   length:
@@ -367,7 +424,7 @@ NISTd40:
     symbol: T
   thermodynamic_temperature:
     powerNumerator: -1
-    symbol:
+    symbol: Theta
 
 NISTd41:
   length:
@@ -381,7 +438,7 @@ NISTd41:
     symbol: T
   thermodynamic_temperature:
     powerNumerator: -1
-    symbol:
+    symbol: Theta
 
 NISTd46:
   length:
@@ -475,7 +532,7 @@ NISTd48:
     symbol: T
   thermodynamic_temperature:
     powerNumerator: -1
-    symbol:
+    symbol: Theta
   amount_of_substance:
     powerNumerator: -1
     symbol: N
@@ -603,7 +660,7 @@ NISTd60:
 NISTd68:
   thermodynamic_temperature:
     powerNumerator: -1
-    symbol:
+    symbol: Theta
 
 NISTd69:
   length:
@@ -617,7 +674,7 @@ NISTd69:
     symbol: T
   thermodynamic_temperature:
     powerNumerator: -1
-    symbol:
+    symbol: Theta
 
 NISTd70:
   length:
@@ -639,7 +696,7 @@ NISTd71:
     symbol: T
   thermodynamic_temperature:
     powerNumerator: -1
-    symbol:
+    symbol: Theta
 
 NISTd64:
   dimensionless: true

data/lib/unitsdb_ruby/unitsdb.rb

@@ -1,24 +1,49 @@
 module UnitsDB
   class Dimension
-    attr_reader :id, :length, :mass, :time, :electric_current, :thermodynamic_temperature,
-      :amount_of_substance, :luminous_intensity, :plane_angle, :dimensionless
+    attr_reader :id, :name, :symbols, :symbols_hash,
+                :length, :mass, :time, :electric_current,
+                :thermodynamic_temperature,
+                :amount_of_substance, :luminous_intensity, :plane_angle,
+                :dimensionless
 
     def initialize(id, hash)
-      begin
-        @id = id
-        @dimensionless = hash[:dimensionless]
-        hash[:length] and @length = hash[:length][:powerNumerator].to_i
-        hash[:mass] and @mass = hash[:mass][:powerNumerator].to_i
-        hash[:time] and @time = hash[:time][:powerNumerator].to_i
-        hash[:electric_current] and @electric_current = hash[:electric_current][:powerNumerator].to_i
-        hash[:thermodynamic_temperature] and
-          @thermodynamic_temperature = hash[:thermodynamic_temperature][:powerNumerator].to_i
-        hash[:amount_of_substance] and @amount_of_substance = hash[:amount_of_substance][:powerNumerator].to_i
-        hash[:luminous_intensity] and @luminous_intensity = hash[:luminous_intensity][:powerNumerator].to_i
-        hash[:plane_angle] and @plane_angle = hash[:plane_angle][:powerNumerator].to_i
-      rescue
-        raise StandardError.new "Parse fail on Dimension #{id}: #{hash}"
+      @id = id
+      @dimensionless = hash[:dimensionless]
+      init_dimension(hash)
+      name_dimension(hash)
+    rescue StandardError
+      raise StandardError.new "Parse fail on Dimension #{id}: #{hash}"
+    end
+
+    def init_dimension(hash)
+      hash[:length] and @length = hash[:length][:powerNumerator].to_i
+      hash[:mass] and @mass = hash[:mass][:powerNumerator].to_i
+      hash[:time] and @time = hash[:time][:powerNumerator].to_i
+      hash[:electric_current] and
+        @electric_current = hash[:electric_current][:powerNumerator].to_i
+      hash[:thermodynamic_temperature] and
+        @thermodynamic_temperature = hash[:thermodynamic_temperature][:powerNumerator].to_i
+      hash[:amount_of_substance] and
+        @amount_of_substance = hash[:amount_of_substance][:powerNumerator].to_i
+      hash[:luminous_intensity] and
+        @luminous_intensity = hash[:luminous_intensity][:powerNumerator].to_i
+      hash[:plane_angle] and
+        @plane_angle = hash[:plane_angle][:powerNumerator].to_i
+    end
+
+    def name_dimension(hash)
+      acc = %i(length mass time electric_current thermodynamic_temperature
+               amount_of_substance luminous_intensity plane_angle)
+        .each_with_object({}) do |x, m|
+        hash[x] and m[x] = hash[x][:powerNumerator]
       end
+      return unless acc.keys.size == 1 && acc.values[0] == 1
+
+      dim = acc.keys[0]
+      @name = dim.to_s
+      @symbols = hash[dim][:dim_symbols]
+      @symbols_hash =
+        @symbols&.each_with_object({}) { |h, m| m[h[:id]] = h } || {}
     end
 
     def keys
@@ -48,24 +73,31 @@ module UnitsDB
     end
 
     def vector
-      "#{@length}:#{@mass}:#{@time}:#{@electric_current}:#{@thermodynamic_temperature}:#{@amount_of_substance}:"\
+      "#{@length}:#{@mass}:#{@time}:#{@electric_current}:"\
+        "#{@thermodynamic_temperature}:#{@amount_of_substance}:"\
         "#{@luminous_intensity}:#{@plane_angle}"
     end
+
+    def symbolid
+      @symbols ? @symbols.first[:id] : nil
+    end
+
+    def symbolids
+      @symbols ? @symbols.map { |s| s[:id] } : []
+    end
   end
 
   class Prefix
     attr_reader :id, :name, :base, :power, :symbol
 
     def initialize(id, hash)
-      begin
-        @id = id
-        @name = hash[:name]
-        @base = hash[:base]
-        @power = hash[:power]
-        @symbol = hash[:symbol] # always is a hash
-      rescue
-        raise StandardError.new "Parse fail on Prefix #{id}: #{hash}"
-      end
+      @id = id
+      @name = hash[:name]
+      @base = hash[:base]
+      @power = hash[:power]
+      @symbol = hash[:symbol] # always is a hash
+    rescue StandardError
+      raise StandardError.new "Parse fail on Prefix #{id}: #{hash}"
     end
 
     def ascii
@@ -97,15 +129,14 @@ module UnitsDB
     attr_reader :id, :dimension, :type, :names, :units
 
     def initialize(id, hash)
-      begin
-        @id = id
-        @dimension = hash[:dimension_url].sub(/^#/, "")
-        @type = hash[:quantity_type]
-        hash[:quantity_name] and @names = hash[:quantity_name]
-        hash[:unit_reference] and @units = hash[:unit_reference].map { |x| x[:url].sub(/^#/, "") }
-      rescue
-        raise StandardError.new "Parse fail on Quantity #{id}: #{hash}"
-      end
+      @id = id
+      @dimension = hash[:dimension_url].sub(/^#/, "")
+      @type = hash[:quantity_type]
+      hash[:quantity_name] and @names = hash[:quantity_name]
+      hash[:unit_reference] and
+        @units = hash[:unit_reference].map { |x| x[:url].sub(/^#/, "") }
+    rescue StandardError
+      raise StandardError.new "Parse fail on Quantity #{id}: #{hash}"
     end
 
     def name
@@ -118,27 +149,28 @@ module UnitsDB
   end
 
   class Unit
-    attr_reader :id, :dimension, :short, :root, :unit_system, :names, :symbols, :symbols_hash, :root_units, :quantities,
-      :si_derived_bases, :prefixed
+    attr_reader :id, :dimension, :short, :root, :unit_system, :names,
+                :symbols, :symbols_hash, :root_units, :quantities,
+                :si_derived_bases, :prefixed
 
     def initialize(id, hash)
-      begin
-        @id = id
-        @short = short
-        @dimension = hash[:dimension_url].sub(/^#/, "")
-        hash[:short] && !hash[:short].empty? and @short = hash[:short]
-        @unit_system = hash[:unit_system]
-        @names = hash[:unit_name]
-        @symbols_hash = hash[:unit_symbols]&.each_with_object({}) { |h, m| m[h[:id]] = h } || {}
-        @symbols = hash[:unit_symbols]
-        hash[:root_units] and hash[:root_units][:enumerated_root_units] and
-          @root = hash[:root_units][:enumerated_root_units]
-        hash[:quantity_reference] and @quantities = hash[:quantity_reference].map { |x| x[:url].sub(/^#/, "") }
-        hash[:si_derived_bases] and @si_derived_bases = hash[:si_derived_bases]
-        @prefixed = (hash[:prefixed] == true)
-      rescue
-        raise StandardError.new "Parse fail on Unit #{id}: #{hash}"
-      end
+      @id = id
+      @short = short
+      @dimension = hash[:dimension_url].sub(/^#/, "")
+      hash[:short] && !hash[:short].empty? and @short = hash[:short]
+      @unit_system = hash[:unit_system]
+      @names = hash[:unit_name]
+      @symbols_hash =
+        hash[:unit_symbols]&.each_with_object({}) { |h, m| m[h[:id]] = h } || {}
+      @symbols = hash[:unit_symbols]
+      hash[:root_units] and hash[:root_units][:enumerated_root_units] and
+        @root = hash[:root_units][:enumerated_root_units]
+      hash[:quantity_reference] and
+        @quantities = hash[:quantity_reference].map { |x| x[:url].sub(/^#/, "") }
+      hash[:si_derived_bases] and @si_derived_bases = hash[:si_derived_bases]
+      @prefixed = (hash[:prefixed] == true)
+    rescue StandardError
+      raise StandardError.new "Parse fail on Unit #{id}: #{hash}"
     end
 
     def system_name
@@ -158,7 +190,7 @@ module UnitsDB
     end
 
     def symbolids
-      @symbols ? @symbols.map { |s| s[:id] } : [ @short ]
+      @symbols ? @symbols.map { |s| s[:id] } : [@short]
     end
   end
 end