RubyGems - asciimath2unitsml - Versions diffs - 0.0.2 → 0.1.0 - Mend

asciimath2unitsml 0.0.2 → 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

checksums.yaml +4 -4
data/README.adoc +28 -6
data/lib/asciimath2unitsml/conv.rb +12 -43
data/lib/asciimath2unitsml/parse.rb +34 -0
data/lib/asciimath2unitsml/version.rb +1 -1
data/spec/conv_spec.rb +180 -3
metadata +2 -2

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2ef44eb717d6b445489de85ee1e8eb3f5b81a6d83602c48ea23a8cbe4f100c7
-  data.tar.gz: 84b867f5a97b3ad154c7be8e5975ca4c97446049c4368ece6ae5e23da3c94437
+  metadata.gz: 97081f507478d1952ab2010cd4810efe745980341b9d4d1a420dbd8132be88b0
+  data.tar.gz: ef63bceb0dc7b7c8dc8c40a1b6fa3795b02a3d0f0d9454be41e121d3a5199054
 SHA512:
-  metadata.gz: b749aa65924f4b815a7d38d2df9c9d6b48e4cd8f9db62678c100d732a60c8159b537fa2c3bd192296f533371f731ec85365f0d7f231f560f173d167971c38871
-  data.tar.gz: 64a47773ef26b6b870fc6a4406b697ec10b943e637a82f549946d8126830db9a521f3bdcb4e314718d084e40b7cfacbc820417476cd98663760ec8de29ba566e
+  metadata.gz: ead9d484a747edf442ff9ce220d46e53f32ccfeada2653ca44e2ecac9a3da4ade854fbfe0dbb6d0120b87358e5cfae0dee3135e7798eed331b7cff25b3558a9c
+  data.tar.gz: ed1aaf1967055b8ca4e270bef69b02b24ccef20fb075cc9f46acee7f5447e7c92e9c2f9bfd36646ee043b4f335dd4fd15920d958d429bdf89d155c5ddc14d729

data/README.adoc CHANGED Viewed

@@ -1,21 +1,27 @@
 = asciimath2unitsml
-Convert Asciimath via MathML to UnitsML
+Convert Units expressions via MathML to UnitsML
-Encode UnitsML expressions in AsciiMath as `"unitsml(...)"`. The gem converts
-AsciiMath incorporating UnitsML expressions (based on the Ascii representation provided by NIST)
+This gem converts
+MathML incorporating UnitsML expressions (based on the Ascii representation provided by NIST)
 into MathML complying with https://www.w3.org/TR/mathml-units/[], with
-UnitsML markup embedded in it, with identifiers for each unit and dimension.
+UnitsML markup embedded in it, and with unique identifiers for each distinct unit and dimension.
+Units expressions are identified in MathML as `<mtext>unitsml(...)</mtext>`, which in turn
+can be identified in AsciiMath  as `"unitsml(...)"`.
 The consuming document is meant to deduplicate the instances of UnitsML markup
 with the same identifier, and potentially remove them to elsewhere in the document
 or another document.
-The AsciiMath conventions used are:
+The conventions used for writing units are:
 * `^` for exponents, e.g. `m^-2`
 * `*` to combine two units by multiplication; e.g. `m*s^-2`. Division is not supported, use negative exponents instead
 * `u` for μ (micro-)
-So
+The gem follows the MathML Units convention of inserting a spacing invisible times operator
+(`<mo rspace='thickmathspace'>&#x2062;</mo>`) between any numbers (`<mn>`) and unit expressions
+in MathML, and representing units in MathML as non-italic variables (`<mi mathvariant='normal'>`).
+So:
 [source]
 ----
@@ -77,4 +83,20 @@ is converted into:
 </math>
 ----
+The converter is run as:
+[source,ruby]
+----
+c = Asciimath2UnitsML::Conv.new()
+c.Asciimath2UnitsML({Asciimath string containing "unitsml()"})
+c.MathML2UnitsML({Nokogiri parse of MathML document containing <mtext>unitsml()</mtext>})
+----
+The converter class may be initialised with options:
+* `multiplier` is the symbol used to represent the multiplication of units. By default,
+following MathML Units, the symbol is middle dot (`&#xB7`). An arbitrary UTF-8 string can be
+supplied instead; it will be encoded as XML entities. The value `:space` is rendered
+as a spacing invisible times in MathML (`<mo rspace='thickmathspace'>&#x2062;</mo>`),
+and as a non-breaking space in HTML. The value `:nospace` is rendered as a non-spacing
+invisible times in MathML (`<mo>&#x2062;</mo>`), and is not rendered in HTML.

data/lib/asciimath2unitsml/conv.rb CHANGED Viewed

@@ -11,36 +11,25 @@ module Asciimath2UnitsML
   UNITSML_NS = "http://unitsml.nist.gov/2005".freeze
   class Conv
-    def initialize
+    def initialize(options = {})
       @prefixes_id = read_yaml("../unitsdb/prefixes.yaml")
       @prefixes = flip_name_and_id(@prefixes_id)
       @quantities = read_yaml("../unitsdb/quantities.yaml")
       @units_id = read_yaml("../unitsdb/units.yaml")
       @units = flip_name_and_id(@units_id)
       @parser = parser
+      @multiplier = multiplier(options[:multiplier] || "\u00b7")
     end
-    # https://www.w3.org/TR/mathml-units/ section 2: delimit number Invisible-Times unit
-    def Asciimath2UnitsML(expression)
-      xml = Nokogiri::XML(asciimath2mathml(expression))
-      MathML2UnitsML(xml).to_xml
-    end
-    def MathML2UnitsML(xml)
-      xml.xpath(".//m:mtext", "m" => MATHML_NS).each do |x|
-        next unless %r{^unitsml\(.+\)$}.match(x.text)
-        text = x.text.sub(%r{^unitsml\((.+)\)$}m, "\\1")
-        units = parse(text)
-        delim = x&.previous_element&.name == "mn" ? "<mo rspace='thickmathspace'>&#x2062;</mo>" : ""
-        x.replace("#{delim}<mrow xref='#{unit_id(text)}'>#{mathmlsymbol(units)}</mrow>\n#{unitsml(units, text)}")
+    def multiplier(x)
+      case x
+      when :space
+        { html: "&nbsp;", mathml: "<mo rspace='thickmathspace'>&#x2062;</mo>" }
+      when :nospace
+        { html: "", mathml: "<mo>&#x2062;</mo>" }
+      else
+        { html: HTMLEntities.new.encode(x), mathml: "<mo>#{HTMLEntities.new.encode(x)}</mo>" }
       end
-      xml
-    end
-    def asciimath2mathml(expression)
-      AsciiMath::MathMLBuilder.new(:msword => true).append_expression(
-        AsciiMath.parse(HTMLEntities.new.decode(expression)).ast).to_s.
-      gsub(/<math>/, "<math xmlns='#{MATHML_NS}'>")
     end
     def unit_id(text)
@@ -92,7 +81,7 @@ module Asciimath2UnitsML
       units.map do |u|
         u[:exponent] and exp = "<sup>#{u[:exponent].sub(/-/, "&#x2212;")}</sup>"
         "#{u[:prefix]}#{u[:unit]}#{exp}"
-      end.join(" &#183; ")
+      end.join(@multiplier[:html])
     end
     def mathmlsymbol(units)
@@ -104,7 +93,7 @@ module Asciimath2UnitsML
         else
           base
         end
-      end.join("<mo>&#xB7;</mo>")
+      end.join(@multiplier[:mathml])
     end
     def mathmlsymbolwrap(units)
@@ -149,17 +138,6 @@ module Asciimath2UnitsML
       END
     end
-    U2D = {
-      "m" => { dimension: "Length", order: 1, symbol: "L" },
-      "g" => { dimension: "Mass", order: 2, symbol: "M" },
-      "kg" => { dimension: "Mass", order: 2, symbol: "M" },
-      "s" => { dimension: "Time", order: 3, symbol: "T" },
-      "A" => { dimension: "ElectricCurrent", order: 4, symbol: "I" },
-      "K" => { dimension: "ThermodynamicTemperature", order: 5, symbol: "Theta" },
-      "mol" => { dimension: "AmountOfSubstance", order: 6, symbol: "N" },
-      "cd" => { dimension: "LuminousIntensity", order: 7, symbol: "J" },
-    }
     def units2dimensions(units)
       norm = normalise_units(units)
       return if norm.any? { |u| u[:unit] == "unknown" || u[:prefix] == "unknown" }
@@ -219,15 +197,6 @@ module Asciimath2UnitsML
       "unknown"
     end
-    def parse(x)
-      units = @parser.parse(x)
-      if !units || Rsec::INVALID[units]
-        raise Rsec::SyntaxError.new "error parsing UnitsML expression", x, 1, 0
-      end
-      Rsec::Fail.reset
-      units
-    end
     def unitsml(units, text)
       dims = units2dimensions(units)
       <<~END

data/lib/asciimath2unitsml/parse.rb CHANGED Viewed

@@ -54,5 +54,39 @@ module Asciimath2UnitsML
       Rsec::Fail.reset
       units
     end
+    U2D = {
+      "m" => { dimension: "Length", order: 1, symbol: "L" },
+      "g" => { dimension: "Mass", order: 2, symbol: "M" },
+      "kg" => { dimension: "Mass", order: 2, symbol: "M" },
+      "s" => { dimension: "Time", order: 3, symbol: "T" },
+      "A" => { dimension: "ElectricCurrent", order: 4, symbol: "I" },
+      "K" => { dimension: "ThermodynamicTemperature", order: 5, symbol: "Theta" },
+      "mol" => { dimension: "AmountOfSubstance", order: 6, symbol: "N" },
+      "cd" => { dimension: "LuminousIntensity", order: 7, symbol: "J" },
+    }
+    def Asciimath2UnitsML(expression)
+      xml = Nokogiri::XML(asciimath2mathml(expression))
+      MathML2UnitsML(xml).to_xml
+    end
+    # https://www.w3.org/TR/mathml-units/ section 2: delimit number Invisible-Times unit
+    def MathML2UnitsML(xml)
+      xml.xpath(".//m:mtext", "m" => MATHML_NS).each do |x|
+        next unless %r{^unitsml\(.+\)$}.match(x.text)
+        text = x.text.sub(%r{^unitsml\((.+)\)$}m, "\\1")
+        units = parse(text)
+        delim = x&.previous_element&.name == "mn" ? "<mo rspace='thickmathspace'>&#x2062;</mo>" : ""
+        x.replace("#{delim}<mrow xref='#{unit_id(text)}'>#{mathmlsymbol(units)}</mrow>\n#{unitsml(units, text)}")
+      end
+      xml
+    end
+    def asciimath2mathml(expression)
+      AsciiMath::MathMLBuilder.new(:msword => true).append_expression(
+        AsciiMath.parse(HTMLEntities.new.decode(expression)).ast).to_s.
+      gsub(/<math>/, "<math xmlns='#{MATHML_NS}'>")
+    end
   end
 end

data/lib/asciimath2unitsml/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Asciimath2UnitsML
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.1.0'.freeze
 end

data/spec/conv_spec.rb CHANGED Viewed

@@ -94,7 +94,7 @@ RSpec.describe Asciimath2UnitsML do
            <UnitSystem name='SI' type='SI_derived' xml:lang='en-US'/>
            <UnitName xml:lang='en'>kg*s^-2</UnitName>
            <UnitSymbol type='HTML'>
-             kg &#xB7; s
+             kg&#xB7;s
              <sup>&#x2212;2</sup>
            </UnitSymbol>
            <UnitSymbol type='MathML'>
@@ -147,7 +147,7 @@ RSpec.describe Asciimath2UnitsML do
            <UnitSystem name='SI' type='SI_derived' xml:lang='en-US'/>
            <UnitName xml:lang='en'>meter per second squared</UnitName>
            <UnitSymbol type='HTML'>
-             m &#xB7; s
+             m&#xB7;s
              <sup>&#x2212;2</sup>
            </UnitSymbol>
            <UnitSymbol type='MathML'>
@@ -197,7 +197,7 @@ RSpec.describe Asciimath2UnitsML do
            <UnitSymbol type='HTML'>
              C
              <sup>3</sup>
-              &#xB7; A
+              &#xB7;A
            </UnitSymbol>
            <UnitSymbol type='MathML'>
              <math xmlns='http://www.w3.org/1998/Math/MathML'>
@@ -251,4 +251,181 @@ RSpec.describe Asciimath2UnitsML do
     12 "unitsml(que?)"
     INPUT
   end
+  it "initialises multiplier" do
+    expect(xmlpp(Asciimath2UnitsML::Conv.new(multiplier: "\u00d7").Asciimath2UnitsML(<<~INPUT))).to be_equivalent_to xmlpp(<<~OUTPUT)
+1 "unitsml(kg*s^-2)"
+    INPUT
+    <math xmlns='http://www.w3.org/1998/Math/MathML'>
+  <mn>1</mn>
+  <mo rspace='thickmathspace'>&#x2062;</mo>
+  <mrow xref='U_kg.s-2'>
+    <mi mathvariant='normal'>kg</mi>
+    <mo>&#xD7;</mo>
+    <msup>
+      <mrow>
+        <mi mathvariant='normal'>s</mi>
+      </mrow>
+      <mrow>
+        <mo>&#x2212;</mo>
+        <mn>2</mn>
+      </mrow>
+    </msup>
+  </mrow>
+  <Unit xmlns='http://unitsml.nist.gov/2005' xml:id='U_kg.s-2' dimensionURL='#D_MT-2'>
+    <UnitSystem name='SI' type='SI_derived' xml:lang='en-US'/>
+    <UnitName xml:lang='en'>kg*s^-2</UnitName>
+    <UnitSymbol type='HTML'>
+      kg&#xD7;s
+      <sup>&#x2212;2</sup>
+    </UnitSymbol>
+    <UnitSymbol type='MathML'>
+      <math xmlns='http://www.w3.org/1998/Math/MathML'>
+        <mrow>
+          <mi mathvariant='normal'>kg</mi>
+          <mo>&#xD7;</mo>
+          <msup>
+            <mrow>
+              <mi mathvariant='normal'>s</mi>
+            </mrow>
+            <mrow>
+              <mo>&#x2212;</mo>
+              <mn>2</mn>
+            </mrow>
+          </msup>
+        </mrow>
+      </math>
+    </UnitSymbol>
+    <RootUnits>
+      <EnumeratedRootUnit unit='gram' prefix='k'/>
+      <EnumeratedRootUnit unit='second' powerNumerator='-2'/>
+    </RootUnits>
+  </Unit>
+  <Prefix xmlns='http://unitsml.nist.gov/2005' prefixBase='10' prefixPower='3' xml:id='NISTp10_3'>
+    <PrefixName xml:lang='en'>kilo</PrefixName>
+    <PrefixSymbol type='ASCII'>k</PrefixSymbol>
+  </Prefix>
+  <Dimension xmlns='http://unitsml.nist.gov/2005' xml:id='D_MT-2'>
+    <Mass symbol='M' powerNumerator='1'/>
+    <Time symbol='T' powerNumerator='-2'/>
+  </Dimension>
+</math>
+    OUTPUT
+    expect(xmlpp(Asciimath2UnitsML::Conv.new(multiplier: :space).Asciimath2UnitsML(<<~INPUT))).to be_equivalent_to xmlpp(<<~OUTPUT)
+1 "unitsml(kg*s^-2)"
+    INPUT
+    <math xmlns='http://www.w3.org/1998/Math/MathML'>
+  <mn>1</mn>
+  <mo rspace='thickmathspace'>&#x2062;</mo>
+  <mrow xref='U_kg.s-2'>
+    <mi mathvariant='normal'>kg</mi>
+    <mo rspace='thickmathspace'>&#x2062;</mo>
+    <msup>
+      <mrow>
+        <mi mathvariant='normal'>s</mi>
+      </mrow>
+      <mrow>
+        <mo>&#x2212;</mo>
+        <mn>2</mn>
+      </mrow>
+    </msup>
+  </mrow>
+  <unit xmlns='http://unitsml.nist.gov/2005' dimensionurl='#D_MT-2' xml:id='U_kg.s-2'>
+    <unitsystem name='SI' type='SI_derived' xml:lang='en-US'/>
+    <unitname xml:lang='en'>kg*s^-2</unitname>
+    <unitsymbol type='HTML'>
+      kg&#xA0;s
+      <sup>&#x2212;2</sup>
+    </unitsymbol>
+    <unitsymbol type='MathML'>
+      <math xmlns='http://www.w3.org/1998/Math/MathML'>
+        <mrow>
+          <mi mathvariant='normal'>kg</mi>
+          <mo rspace='thickmathspace'>&#x2062;</mo>
+          <msup>
+            <mrow>
+              <mi mathvariant='normal'>s</mi>
+            </mrow>
+            <mrow>
+              <mo>&#x2212;</mo>
+              <mn>2</mn>
+            </mrow>
+          </msup>
+        </mrow>
+      </math>
+    </unitsymbol>
+    <rootunits>
+      <enumeratedrootunit unit='gram' prefix='k'/>
+      <enumeratedrootunit unit='second' powernumerator='-2'/>
+    </rootunits>
+  </unit>
+  <prefix xmlns='http://unitsml.nist.gov/2005' prefixbase='10' prefixpower='3' xml:id='NISTp10_3'>
+    <prefixname xml:lang='en'>kilo</prefixname>
+    <prefixsymbol type='ASCII'>k</prefixsymbol>
+  </prefix>
+  <dimension xmlns='http://unitsml.nist.gov/2005' xml:id='D_MT-2'>
+    <mass symbol='M' powernumerator='1'/>
+    <time symbol='T' powernumerator='-2'/>
+  </dimension>
+</math>
+    OUTPUT
+    expect(xmlpp(Asciimath2UnitsML::Conv.new(multiplier: :nospace).Asciimath2UnitsML(<<~INPUT))).to be_equivalent_to xmlpp(<<~OUTPUT)
+1 "unitsml(kg*s^-2)"
+    INPUT
+    <math xmlns='http://www.w3.org/1998/Math/MathML'>
+  <mn>1</mn>
+  <mo rspace='thickmathspace'>&#x2062;</mo>
+  <mrow xref='U_kg.s-2'>
+    <mi mathvariant='normal'>kg</mi>
+    <mo>&#x2062;</mo>
+    <msup>
+      <mrow>
+        <mi mathvariant='normal'>s</mi>
+      </mrow>
+      <mrow>
+        <mo>&#x2212;</mo>
+        <mn>2</mn>
+      </mrow>
+    </msup>
+  </mrow>
+  <Unit xmlns='http://unitsml.nist.gov/2005' xml:id='U_kg.s-2' dimensionURL='#D_MT-2'>
+    <UnitSystem name='SI' type='SI_derived' xml:lang='en-US'/>
+    <UnitName xml:lang='en'>kg*s^-2</UnitName>
+    <UnitSymbol type='HTML'>
+      kgs
+      <sup>&#x2212;2</sup>
+    </UnitSymbol>
+    <UnitSymbol type='MathML'>
+      <math xmlns='http://www.w3.org/1998/Math/MathML'>
+        <mrow>
+          <mi mathvariant='normal'>kg</mi>
+          <mo>&#x2062;</mo>
+          <msup>
+            <mrow>
+              <mi mathvariant='normal'>s</mi>
+            </mrow>
+            <mrow>
+              <mo>&#x2212;</mo>
+              <mn>2</mn>
+            </mrow>
+          </msup>
+        </mrow>
+      </math>
+    </UnitSymbol>
+    <RootUnits>
+      <EnumeratedRootUnit unit='gram' prefix='k'/>
+      <EnumeratedRootUnit unit='second' powerNumerator='-2'/>
+    </RootUnits>
+  </Unit>
+  <Prefix xmlns='http://unitsml.nist.gov/2005' prefixBase='10' prefixPower='3' xml:id='NISTp10_3'>
+    <PrefixName xml:lang='en'>kilo</PrefixName>
+    <PrefixSymbol type='ASCII'>k</PrefixSymbol>
+  </Prefix>
+  <Dimension xmlns='http://unitsml.nist.gov/2005' xml:id='D_MT-2'>
+    <Mass symbol='M' powerNumerator='1'/>
+    <Time symbol='T' powerNumerator='-2'/>
+  </Dimension>
+</math>
+    OUTPUT
+  end
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciimath2unitsml
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-15 00:00:00.000000000 Z
+date: 2021-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciimath