unitsml 0.4.6 → 0.5.1

data/unitsdb/schemas/scales-schema.yaml

@@ -0,0 +1,109 @@
+# yaml-language-server: $schema=http://json-schema.org/draft-06/schema
+---
+$schema: "http://json-schema.org/draft-06/schema#"
+$id: "https://unitsml.org/schemas/scales-schema.yaml"
+title: "Scales Database Schema"
+description: "Schema for scales.yaml - defines measurement scales with their mathematical properties"
+
+type: object
+required: ["schema_version", "scales"]
+properties:
+  schema_version:
+    type: string
+    pattern: "^\\d+\\.\\d+\\.\\d+$"
+    description: "Semantic version of the schema"
+  scales:
+    type: array
+    description: "Array of scale definitions"
+    items:
+      $ref: "#/definitions/Scale"
+
+definitions:
+  Scale:
+    type: object
+    required: ["identifiers", "names", "properties"]
+    properties:
+      identifiers:
+        type: array
+        description: "External identifiers for this scale"
+        items:
+          $ref: "#/definitions/Identifier"
+      names:
+        type: array
+        description: "Multilingual names for this scale"
+        items:
+          $ref: "#/definitions/Name"
+      properties:
+        $ref: "#/definitions/ScaleProperties"
+        description: "Mathematical properties of the scale"
+      references:
+        type: array
+        description: "External references and citations"
+        items:
+          $ref: "#/definitions/Reference"
+
+  Identifier:
+    type: object
+    required: ["type", "id"]
+    properties:
+      type:
+        type: string
+        description: "Type of identifier system"
+      id:
+        type: string
+        description: "Identifier value within the system"
+
+  Name:
+    type: object
+    required: ["value", "lang"]
+    properties:
+      value:
+        type: string
+        description: "Name in the specified language"
+      lang:
+        type: string
+        pattern: "^[a-z]{2}(-[A-Z]{2})?$"
+        description: "Language code (ISO 639-1, optionally with ISO 3166-1 country)"
+
+  ScaleProperties:
+    type: object
+    required: ["continuous", "ordered", "logarithmic", "interval", "ratio"]
+    properties:
+      continuous:
+        type: boolean
+        description: "Whether the scale is continuous"
+      ordered:
+        type: boolean
+        description: "Whether the scale has an ordering"
+      logarithmic:
+        type: boolean
+        description: "Whether the scale is logarithmic"
+      interval:
+        type: boolean
+        description: "Whether the scale has meaningful intervals"
+      ratio:
+        type: boolean
+        description: "Whether the scale has a meaningful zero point"
+
+  Reference:
+    type: object
+    required: ["type"]
+    properties:
+      type:
+        type: string
+        description: "Type of reference"
+      authority:
+        type: string
+        description: "Authoritative body or organization"
+      uri:
+        type: string
+        format: "uri"
+        description: "URI to the reference"
+      title:
+        type: string
+        description: "Title of the reference"
+      year:
+        type: integer
+        minimum: 1000
+        maximum: 9999
+        description: "Publication year"

data/unitsdb/schemas/unit_systems-schema.yaml

@@ -0,0 +1,120 @@
+# yaml-language-server: $schema=http://json-schema.org/draft-06/schema
+---
+$schema: "http://json-schema.org/draft-06/schema#"
+$id: "https://unitsml.org/schemas/unit_systems-schema.yaml"
+title: "Unit Systems Database Schema"
+description: "Schema for unit_systems.yaml - defines systems of measurement units"
+
+type: object
+required: ["schema_version", "unit_systems"]
+properties:
+  schema_version:
+    type: string
+    pattern: "^\\d+\\.\\d+\\.\\d+$"
+    description: "Semantic version of the schema"
+  unit_systems:
+    type: array
+    description: "Array of unit system definitions"
+    items:
+      $ref: "#/definitions/UnitSystem"
+
+definitions:
+  UnitSystem:
+    type: object
+    required: ["identifiers", "names"]
+    properties:
+      identifiers:
+        type: array
+        description: "External identifiers for this unit system"
+        items:
+          $ref: "#/definitions/Identifier"
+      names:
+        type: array
+        description: "Multilingual names for this unit system"
+        items:
+          $ref: "#/definitions/Name"
+      base_units:
+        type: array
+        description: "Base units that define this system"
+        items:
+          $ref: "#/definitions/BaseUnitReference"
+      references:
+        type: array
+        description: "External references and citations"
+        items:
+          $ref: "#/definitions/Reference"
+
+  Identifier:
+    type: object
+    required: ["type", "id"]
+    properties:
+      type:
+        type: string
+        enum: ["nist", "unitsml", "si-digital-framework"]
+        description: "Type of identifier system"
+      id:
+        type: string
+        description: "Identifier value within the system"
+
+  Name:
+    type: object
+    required: ["value", "lang"]
+    properties:
+      value:
+        type: string
+        description: "Name in the specified language"
+      lang:
+        type: string
+        pattern: "^[a-z]{2}(-[A-Z]{2})?$"
+        description: "Language code (ISO 639-1, optionally with ISO 3166-1 country)"
+
+  BaseUnitReference:
+    type: object
+    required: ["type", "id", "quantity_reference"]
+    properties:
+      type:
+        type: string
+        const: "unit"
+        description: "Reference type indicator"
+      id:
+        type: string
+        description: "Unit identifier"
+      quantity_reference:
+        $ref: "#/definitions/QuantityReference"
+        description: "Physical quantity this base unit measures"
+
+  QuantityReference:
+    type: object
+    required: ["type", "id"]
+    properties:
+      type:
+        type: string
+        const: "quantity"
+        description: "Reference type indicator"
+      id:
+        type: string
+        description: "Quantity identifier"
+
+  Reference:
+    type: object
+    required: ["type"]
+    properties:
+      type:
+        type: string
+        enum: ["standard", "specification", "publication", "website"]
+        description: "Type of reference"
+      authority:
+        type: string
+        description: "Authoritative body or organization"
+      uri:
+        type: string
+        format: "uri"
+        description: "URI to the reference"
+      title:
+        type: string
+        description: "Title of the reference"
+      year:
+        type: integer
+        minimum: 1000
+        maximum: 9999
+        description: "Publication year"

data/unitsdb/schemas/units-schema.yaml

@@ -0,0 +1,219 @@
+# yaml-language-server: $schema=http://json-schema.org/draft-06/schema
+---
+$schema: "http://json-schema.org/draft-06/schema#"
+$id: "https://unitsml.org/schemas/units-schema.yaml"
+title: "Units Database Schema"
+description: "Schema for units.yaml - defines measurement units with their properties, symbols, and relationships"
+
+type: object
+required: ["schema_version", "units"]
+properties:
+  schema_version:
+    type: string
+    pattern: "^\\d+\\.\\d+\\.\\d+$"
+    description: "Semantic version of the schema"
+  units:
+    type: array
+    description: "Array of unit definitions"
+    items:
+      $ref: "#/definitions/Unit"
+
+definitions:
+  Unit:
+    type: object
+    required: ["identifiers", "names", "scale_reference", "unit_system_reference", "root", "short", "symbols"]
+    properties:
+      identifiers:
+        type: array
+        description: "External identifiers for this unit"
+        items:
+          $ref: "#/definitions/Identifier"
+      names:
+        type: array
+        description: "Multilingual names for this unit"
+        items:
+          $ref: "#/definitions/Name"
+      scale_reference:
+        $ref: "#/definitions/ScaleReference"
+        description: "Reference to the measurement scale"
+      unit_system_reference:
+        type: array
+        description: "Reference to the unit system"
+        items:
+          $ref: "#/definitions/UnitSystemReference"
+        minimum: 1
+      root:
+        type: boolean
+        description: "Whether this unit is a root unit in its system"
+      root_units:
+        type: array
+        description: "Root units that compose this unit"
+        items:
+          $ref: "#/definitions/RootUnit"
+      short:
+        type: string
+        description: "Short description or definition"
+      symbols:
+        type: array
+        description: "Mathematical and textual representations"
+        items:
+          $ref: "#/definitions/Symbol"
+      quantity_reference:
+        $ref: "#/definitions/QuantityReference"
+        description: "Reference to the physical quantity (optional)"
+      references:
+        type: array
+        description: "External references and citations"
+        items:
+          $ref: "#/definitions/Reference"
+
+  Identifier:
+    type: object
+    required: ["type", "id"]
+    properties:
+      type:
+        type: string
+        enum: ["nist", "unitsml", "ucum", "si-digital-framework"]
+        description: "Type of identifier system"
+      id:
+        type: string
+        description: "Identifier value within the system"
+
+  Name:
+    type: object
+    required: ["value", "lang"]
+    properties:
+      value:
+        type: string
+        description: "Name in the specified language"
+      lang:
+        type: string
+        pattern: "^[a-z]{2}(-[A-Z]{2})?$"
+        description: "Language code (ISO 639-1, optionally with ISO 3166-1 country)"
+
+  ScaleReference:
+    type: object
+    required: ["type", "id"]
+    properties:
+      type:
+        type: string
+        description: "Reference type indicator"
+        enum: ["unitsml"]
+      id:
+        type: string
+        description: "Scale identifier"
+
+  UnitSystemReference:
+    type: object
+    required: ["type", "id"]
+    properties:
+      type:
+        type: string
+        description: "Reference type indicator"
+        enum: ["unitsml", "ucum", "nist"]
+      id:
+        type: string
+        description: "Unit system identifier"
+
+  QuantityReference:
+    type: object
+    required: ["type", "id"]
+    properties:
+      type:
+        type: string
+        description: "Reference type indicator"
+        enum: ["unitsml", "ucum", "nist"]
+      id:
+        type: string
+        description: "Quantity identifier"
+
+  RootUnit:
+    type: object
+    required: ["power", "unit_reference"]
+    properties:
+      power:
+        type: integer
+        description: "Exponent for this unit in the composition"
+      unit_reference:
+        $ref: "#/definitions/UnitReference"
+        description: "Reference to the base unit"
+
+  UnitReference:
+    type: object
+    required: ["type", "id"]
+    properties:
+      type:
+        type: string
+        description: "Reference type indicator"
+      id:
+        type: string
+        description: "Unit identifier"
+      prefix_reference:
+        $ref: "#/definitions/PrefixReference"
+        description: "Optional prefix applied to the unit"
+
+  PrefixReference:
+    type: object
+    required: ["type", "id"]
+    properties:
+      type:
+        type: string
+        description: "Reference type indicator"
+      id:
+        type: string
+        description: "Prefix identifier"
+
+    # - latex: "\\ensuremath{\\mathrm{m}}"
+    # unicode: m
+    # ascii: m
+    # html: m
+    # id: m
+    # mathml: "<mi mathvariant='normal'>m</mi>"
+
+  Symbol:
+    type: object
+    required: ["latex", "unicode", "ascii", "html", "id", "mathml"]
+    description: "Mathematical and textual representations of the unit"
+    properties:
+      latex:
+        type: string
+        description: "LaTeX representation"
+      unicode:
+        type: string
+        description: "Unicode representation"
+      ascii:
+        type: string
+        description: "ASCII representation"
+      html:
+        type: string
+        description: "HTML representation"
+      id:
+        type: string
+        description: "Symbol identifier"
+      mathml:
+        type: string
+        description: "MathML representation"
+
+  Reference:
+    type: object
+    required: ["type"]
+    properties:
+      type:
+        type: string
+        enum: ["normative", "informative"]
+        description: "Type of reference"
+      authority:
+        type: string
+        description: "Authoritative body or organization"
+      uri:
+        type: string
+        format: "uri"
+        description: "URI to the reference"
+      title:
+        type: string
+        description: "Title of the reference"
+      year:
+        type: integer
+        minimum: 1000
+        maximum: 9999
+        description: "Publication year"

data/unitsdb/spec/units_spec.rb

@@ -1,17 +1,18 @@
-require 'yaml'
-require 'rspec'
-require 'plurimath'
+# frozen_string_literal: true
 
-describe 'MathML in UnitsDB' do
-  unitsdb = YAML.load_file('units.yaml')
+require "yaml"
+require "rspec"
+require "plurimath/math"
+
+describe "Validate MathML in UnitsDB" do
+  unitsdb = YAML.load_file(File.join(__dir__, "../units.yaml"))
 
   unitsdb.each do |unit, unit_data|
     context "when parsing MathML for #{unit}" do
-
-      it 'parses successfully' do
-        unit_symbols = unit_data.dig("unit_symbols").flatten.compact
-        unit_symbols.each do |symbols_hash|
-          expect { Plurimath::Math.parse(symbols_hash.dig("mathml"), :mathml) }.not_to raise_error
+      it "parses successfully" do
+        symbols = unit_data["symbols"].flatten.compact
+        symbols.each do |symbols_hash|
+          expect { Plurimath::Math.parse(symbols_hash["mathml"], :mathml) }.not_to raise_error
         end
       end
     end

data/unitsdb/unit_systems.yaml

@@ -1,16 +1,74 @@
+# yaml-language-server: $schema=schemas/unit_systems-schema.yaml
 ---
-- id: SI_base
-  name: SI
-  acceptable: true
-- id: SI_derived_special
-  name: SI
-  acceptable: true
-- id: SI_derived_non-special
-  name: SI
-  acceptable: true
-- id: non-SI_acceptable
-  name: non-SI
-  acceptable: true
-- id: non-SI_not_acceptable
-  name: non-SI
-  acceptable: false
+schema_version: 2.0.0
+unit_systems:
+- acceptable: true
+  identifiers:
+  - type: nist
+    id: SI_base
+  - type: unitsml
+    id: us:si-base
+  names:
+  - value: SI base units
+    lang: en
+  short: si-base
+- acceptable: true
+  identifiers:
+  - type: nist
+    id: SI_compatible
+  - type: unitsml
+    id: us:si-compatible
+  names:
+  - value: Units compatible with SI
+    lang: en
+  short: si-compatible
+- acceptable: true
+  identifiers:
+  - type: nist
+    id: SI_derived_non-special
+  - type: unitsml
+    id: us:si-derived-nonspecial
+  names:
+  - value: SI-derived units non-special
+    lang: en
+  short: si-derived-nonspecial
+- acceptable: true
+  identifiers:
+  - type: nist
+    id: SI_derived_special
+  - type: unitsml
+    id: us:si-derived-special
+  names:
+  - value: SI-derived units special
+    lang: en
+  short: si-derived-special
+- acceptable: true
+  identifiers:
+  - type: nist
+    id: non-SI_acceptable
+  - type: unitsml
+    id: us:nonsi-acceptable
+  names:
+  - value: non-SI but acceptable
+    lang: en
+  short: nonsi-acceptable
+- acceptable: true
+  identifiers:
+  - type: nist
+    id: non-SI_nist_acceptable
+  - type: unitsml
+    id: us:nonsi-nist-acceptable
+  names:
+  - value: non-SI but acceptable by NIST SP 811
+    lang: en
+  short: nonsi-nist-acceptable
+- acceptable: false
+  identifiers:
+  - type: nist
+    id: non-SI_not_acceptable
+  - type: unitsml
+    id: us:nonsi-unacceptable
+  names:
+  - value: non-SI and not acceptable
+    lang: en
+  short: nonsi-unacceptable