asciimath2unitsml 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfcf63b9b9f9f447f63f744608bb19423025756a5f174a123acb5fbecb2143a4
-  data.tar.gz: a45ba18eb0b8090ba886453bedf91ed18f531afc31061a90e9f33a6bc6e0085b
+  metadata.gz: b4d619489e5063d9e3616163d69c6c1f4796615412ee40f0a92f356603f0e366
+  data.tar.gz: 0465ac8a99f8929d1d4f8f2db152821e4d1fae7ac66af1a8a3e2feb6092e0c3a
 SHA512:
-  metadata.gz: 61c26594d8ab5b4ab07439085ce23de798b8f4e38c0272790a60d64a247f10a19778e4d0cbdb37b9a3a79d6994a6a14ebf97c0dd031551366019ebe2905c5612
-  data.tar.gz: e60ff3e91ff37a31ac3d5ac0beccb30c5f05c9c9590e1cc0dd01915ff1c9b57520af1d11b14c1b718173d7258a41b318f67db4a509ccd3ed3b4af43501b50d87
+  metadata.gz: 3de256a40d7eb24439409664a8b7bb14f1893403a4cfc762b70bd9693a15c0304766a7d20491de4094571fd5b117695350a5ad56100cf67bde1e7c61c4e99004
+  data.tar.gz: 4f053e85ff192f040856d0f63ff2d1ffb7a49eb72735f668785a3396e82ff145b8d678d754b8a26b26deee4c3072de4f8af8686f7ee60cb9e339dfe3f7be08c3

data/.github/workflows/rake.yml

@@ -16,21 +16,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.7', '2.6', '2.5', '2.4' ]
+        ruby: [ '3.0', '2.7', '2.6', '2.5' ]
         os: [ ubuntu-latest, windows-latest, macos-latest ]
         experimental: [ false ]
-        include:
-          - ruby: '3.0'
-            os: 'ubuntu-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'windows-latest'
-            experimental: true
-          - ruby: '3.0'
-            os: 'macos-latest'
-            experimental: true
     steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@v2
         with:
           submodules: true
 
@@ -40,14 +30,3 @@ jobs:
           bundler-cache: true
 
       - run: bundle exec rake
-
-  tests-passed:
-    needs: rake
-    runs-on: ubuntu-latest
-    steps:
-      - uses: peter-evans/repository-dispatch@v1
-        with:
-          token: ${{ secrets.METANORMA_CI_PAT_TOKEN || secrets.GITHUB_TOKEN }}
-          repository: ${{ github.repository }}
-          event-type: notify
-          client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}"}'

data/.hound.yml

@@ -0,0 +1,5 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+ruby:
+  enabled: true
+  config_file: .rubocop.yml

data/.rubocop.yml

@@ -1,14 +1,10 @@
-# This project follows the Ribose OSS style guide.
-# https://github.com/riboseinc/oss-guides
-# All project-specific additions and overrides should be specified in this file.
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
 inherit_from:
   - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
 
 # local repo-specific modifications
+# ...
 
 AllCops:
-  DisplayCopNames: false
-  StyleGuideCopsOnly: false
-  TargetRubyVersion: 2.4
-Rails:
-  Enabled: true
+  TargetRubyVersion: 2.5

data/Gemfile

@@ -1,4 +1,4 @@
 source "https://rubygems.org"
-  
+
 # Specify your gem's dependencies in ruby-vobject.gemspec
 gemspec

data/README.adoc

@@ -59,6 +59,24 @@ units. The options are an XML entity, or the values `space` or `nospace` (for wh
 Standalone prefixes can be recognised by replacing the unit with hyphen; so `unitsml(p-)` corresponds
 to the standalone prefix "pico" (and is rendered as "p").
 
+The gem also supports fundamental units, e.g. `unitsml(e)` for the atomic unit of charge, _e_,
+and symbols for dimensions. The latter are entered as `dim_XXX`, where `XXX` is their established symbol:
+
+|===
+|Symbol | Dimension
+
+|dim_L | Length
+|dim_M | Mass
+|dim_T | Time
+|dim_I | Electric Current
+|dim_Theta | Thermodynamic Temperature
+|dim_N | Amount of Substance
+|dim_J | Luminous Intensity
+|dim_phi | Plane Angle (dimensionless)
+|===
+
+e.g. `unitsml(dim_I)` for the dimension of electric current, 𝖨.
+
 == Rendering
 
 The output of the gem is MathML, with MathML unit expressions (expressed as `<mi>`, 
@@ -141,7 +159,7 @@ The converter is run as:
 [source,ruby]
 ----
 c = Asciimath2UnitsML::Conv.new()
-c.Asciimath2UnitsML(1 "unitsml(mm*s^-2)") # AsciiMath string containing UnitsML
+c.Asciimath2UnitsML('1 "unitsml(mm*s^-2)"') # AsciiMath string containing UnitsML
 c.MathML2UnitsML("<math xmlns='http://www.w3.org/1998/Math/MathML'><mn>7</mn>"\
   "<mtext>unitsml(kg^-2)</mtext></math>") # AsciiMath string containing <mtext>unitsml()</mtext>
 c.MathML2UnitsML(Nokogiri::XML("<math xmlns='http://www.w3.org/1998/Math/MathML'><mn>7</mn>"\

data/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/asciimath2unitsml.gemspec

@@ -1,6 +1,6 @@
 # coding: utf-8
 
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "asciimath2unitsml/version"
 
@@ -22,32 +22,30 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.files         = `git ls-files`.split("\n")
   spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   # get an array of submodule dirs relatively to root repo
   `git config --file .gitmodules --get-regexp '\\.path$'`
     .split("\n")
     .map { |kv_str| kv_str.split(" ") }
     .each do |(_, submodule_path)|
+    # for each submodule, change working directory to that submodule
+    Dir.chdir(submodule_path) do
+      # issue git ls-files in submodule's directory
+      submodule_files = `git ls-files | grep -i '.yaml$'`.split($\)
 
-      # for each submodule, change working directory to that submodule
-      Dir.chdir(submodule_path) do
-
-        # issue git ls-files in submodule's directory
-        submodule_files = `git ls-files | grep -i '.yaml$'`.split($\)
-
-        submodule_files_paths = submodule_files.map do |filename|
-          File.join submodule_path, filename
-        end
-
-        # add relative paths to gem.files
-        spec.files += submodule_files_paths
+      submodule_files_paths = submodule_files.map do |filename|
+        File.join submodule_path, filename
       end
+
+      # add relative paths to gem.files
+      spec.files += submodule_files_paths
+    end
   end
 
   spec.add_dependency "asciimath"
   spec.add_dependency "htmlentities"
-  spec.add_dependency "nokogiri", "~> 1.10.4"
+  spec.add_dependency "nokogiri", "~> 1.11"
   spec.add_dependency "rsec", "~> 1.0.0"
 
   spec.add_development_dependency "bundler"
@@ -56,10 +54,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-rspec", "~> 4.7"
   spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rexml"
   spec.add_development_dependency "rspec", "~> 3.6"
   spec.add_development_dependency "rubocop", "~> 1.5.2"
   spec.add_development_dependency "simplecov", "~> 0.15"
   spec.add_development_dependency "timecop", "~> 0.9"
-  spec.add_development_dependency "rexml"
 end
-

data/bin/rspec

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-  
+
 # This file was generated by Bundler.
 #
 # The application 'rspec' is installed as part of a gem, and
@@ -15,4 +15,3 @@ require "rubygems"
 require "bundler/setup"
 
 load Gem.bin_path("rspec-core", "rspec")
-

data/lib/asciimath2unitsml.rb

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

data/lib/asciimath2unitsml/conv.rb

@@ -3,10 +3,13 @@ require "nokogiri"
 require "htmlentities"
 require "yaml"
 require "rsec"
+require_relative "read"
+require_relative "dimensions"
 require_relative "string"
 require_relative "parse"
 require_relative "render"
 require_relative "unit"
+require_relative "validate"
 
 module Asciimath2UnitsML
   MATHML_NS = "http://www.w3.org/1998/Math/MathML".freeze
@@ -14,120 +17,86 @@ module Asciimath2UnitsML
 
   class Conv
     def initialize(options = {})
-      @dimensions_id = read_yaml("../unitsdb/dimensions.yaml").
-        each_with_object({}) do |(k, v), m|
+      @dimensions_id = read_yaml("../unitsdb/dimensions.yaml")
+        .each_with_object({}) do |(k, v), m|
         m[k.to_s] = UnitsDB::Dimension.new(k, v)
       end
-      @prefixes_id = read_yaml("../unitsdb/prefixes.yaml").
-        each_with_object({}) do |(k, v), m|
+      @dimensions = flip_name_and_symbols(@dimensions_id)
+      @prefixes_id = read_yaml("../unitsdb/prefixes.yaml")
+        .each_with_object({}) do |(k, v), m|
         m[k] = UnitsDB::Prefix.new(k, v)
       end
       @prefixes = flip_name_and_symbol(@prefixes_id)
-      @quantities = read_yaml("../unitsdb/quantities.yaml").
-        each_with_object({}) do |(k, v), m|
+      @quantities = read_yaml("../unitsdb/quantities.yaml")
+        .each_with_object({}) do |(k, v), m|
         m[k.to_s] = UnitsDB::Quantity.new(k, v)
       end
-      @units_id = read_yaml("../unitsdb/units.yaml").
-        each_with_object({}) do |(k, v), m|
+      @units_id = read_yaml("../unitsdb/units.yaml")
+        .each_with_object({}) do |(k, v), m|
         m[k.to_s] = UnitsDB::Unit.new(k.to_s, v)
       end
       @units = flip_name_and_symbols(@units_id)
-      @symbols = @units.each_with_object({}) do |(k, v), m|
+      @symbols = @units.merge(@dimensions).each_with_object({}) do |(_k, v), m|
         v.symbolids.each { |x| m[x] = v.symbols_hash[x] }
       end
-      @parser = parser
-      @multiplier = multiplier(options[:multiplier] || "\u00b7")
+      @parser, @dim_parser = parsers
+      @multiplier = multiplier(options[:multiplier] || "\u22c5")
     end
 
-    def float_to_display(f)
-      ret = f.to_f.round(1).to_s.sub(/\.0$/, "")
+    def float_to_display(float)
+      float.to_f.round(1).to_s.sub(/\.0$/, "")
     end
 
     def prefix(units)
-      units.map { |u| u[:prefix] }.reject { |u| u.nil? }.uniq.map do |p|
-        <<~END
-        <Prefix xmlns='#{UNITSML_NS}' prefixBase='#{@prefixes[p].base}'
-                prefixPower='#{@prefixes[p].power}' xml:id='#{@prefixes[p].id}'>
-          <PrefixName xml:lang="en">#{@prefixes[p].name}</PrefixName>
-          <PrefixSymbol type="ASCII">#{@prefixes[p].ascii}</PrefixSymbol>
-          <PrefixSymbol type="unicode">#{@prefixes[p].unicode}</PrefixSymbol>
-          <PrefixSymbol type="LaTeX">#{@prefixes[p].latex}</PrefixSymbol>
-          <PrefixSymbol type="HTML">#{htmlent @prefixes[p].html}</PrefixSymbol>
-        </Prefix>
-        END
+      units.map { |u| u[:prefix] }.reject(&:nil?).uniq.map do |p|
+        <<~XML
+          <Prefix xmlns='#{UNITSML_NS}' prefixBase='#{@prefixes[p].base}'
+                  prefixPower='#{@prefixes[p].power}' xml:id='#{@prefixes[p].id}'>
+            <PrefixName xml:lang="en">#{@prefixes[p].name}</PrefixName>
+            <PrefixSymbol type="ASCII">#{@prefixes[p].ascii}</PrefixSymbol>
+            <PrefixSymbol type="unicode">#{@prefixes[p].unicode}</PrefixSymbol>
+            <PrefixSymbol type="LaTeX">#{@prefixes[p].latex}</PrefixSymbol>
+            <PrefixSymbol type="HTML">#{htmlent @prefixes[p].html}</PrefixSymbol>
+          </Prefix>
+        XML
       end.join("\n")
     end
 
-    def dimension_components(dims)
-      return if dims.nil? || dims.empty?
-      <<~END
-      <Dimension xmlns='#{UNITSML_NS}' xml:id="#{dim_id(dims)}">
-      #{dims.map { |u| dimension1(u) }.join("\n") }
-      </Dimension>
-      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" },
-      "degK" => { dimension: "ThermodynamicTemperature", order: 5,
-                  symbol: "Theta" },
-      "mol" => { dimension: "AmountOfSubstance", order: 6, symbol: "N" },
-      "cd" => { dimension: "LuminousIntensity", order: 7, symbol: "J" },
-      "deg" => { dimension: "PlaneAngle", order: 8, symbol: "Phi" },
-    }.freeze
-
-    def units2dimensions(units)
-      norm = decompose_units(units)
-      return if norm.any? do |u|
-        u[:unit] == "unknown" || u[:prefix] == "unknown" || u[:unit].nil?
-      end
-      norm.map do |u|
-        { dimension: U2D[u[:unit]][:dimension],
-          unit: u[:unit],
-          exponent: u[:exponent] || 1,
-          symbol: U2D[u[:unit]][:symbol] } 
-      end.sort { |a, b| U2D[a[:unit]][:order] <=> U2D[b[:unit]][:order] }
-    end
-
-    def dimension1(u)
-      %(<#{u[:dimension]} symbol="#{u[:symbol]}" 
-      powerNumerator="#{float_to_display(u[:exponent])}"/>)
-    end
-
-    def dim_id(dims)
-      return nil if dims.nil? || dims.empty?
-      dimhash = dims.each_with_object({}) { |h, m| m[h[:dimension]] = h }
-      dimsvector = %w(Length Mass Time ElectricCurrent ThermodynamicTemperature 
-                      AmountOfSubstance LuminousIntensity PlaneAngle)
-        .map { |h| dimhash.dig(h, :exponent) }.join(":")
-      id = @dimensions_id&.values&.select { |d| d.vector == dimsvector }&.
-        first&.id and return id.to_s
-      "D_" + dims.map do |d|
-        U2D[d[:unit]][:symbol] +
-          (d[:exponent] == 1 ? "" : float_to_display(d[:exponent]))
-      end.join("")
-    end
-
     def decompose_units(units)
       gather_units(units_only(units).map { |u| decompose_unit(u) }.flatten)
     end
 
     def gather_units(units)
-      units.sort { |a, b| a[:unit] <=> b[:unit] }.each_with_object([]) do |k, m|
+      if units[0][:dim] then gather_dimensions(units)
+      else gather_units1(units)
+      end
+    end
+
+    def gather_units1(units)
+      units.sort_by { |a| a[:unit] }.each_with_object([]) do |k, m|
         if m.empty? || m[-1][:unit] != k[:unit] then m << k
         else
           m[-1] = {
             prefix: combine_prefixes(
-              @prefixes[m[-1][:prefix]], @prefixes[k[:prefix]]),
+              @prefixes[m[-1][:prefix]], @prefixes[k[:prefix]]
+            ),
             unit: m[-1][:unit],
             exponent: (k[:exponent]&.to_f || 1) +
-            (m[-1][:exponent]&.to_f || 1) }
+              (m[-1][:exponent]&.to_f || 1),
+          }
+        end
+      end
+    end
+
+    def gather_dimensions(units)
+      units.sort_by { |a| a[:dim] }.each_with_object([]) do |k, m| 
+        if m.empty? || m[-1][:dim] != k[:dim] then m << k
+        else
+          m[-1] = {
+            dim: m[-1][:dim],
+            exponent: (k[:exponent]&.to_f || 1) +
+              (m[-1][:exponent]&.to_f || 1),
+          }
         end
       end
     end
@@ -135,16 +104,18 @@ module Asciimath2UnitsML
     # treat g not kg as base unit: we have stripped the prefix k in parsing
     # reduce units down to basic units
     def decompose_unit(u)
-      if u[:unit].nil? then u
-      elsif u[:unit] == "g" then u
-      elsif @units[u[:unit]].system_type == "SI_base" then u
+      if u[:unit].nil? || u[:unit] == "g" ||
+          @units[u[:unit]].system_type == "SI_base" then u
       elsif !@units[u[:unit]].si_derived_bases
         { prefix: u[:prefix], unit: "unknown", exponent: u[:exponent] }
       else
         @units[u[:unit]].si_derived_bases.each_with_object([]) do |k, m|
-          prefix = !k[:prefix].nil? && !k[:prefix].empty? ?
-            combine_prefixes(@prefixes_id[k[:prefix]], @prefixes[u[:prefix]]) :
-            u[:prefix]
+          prefix = if !k[:prefix].nil? && !k[:prefix].empty?
+                     combine_prefixes(@prefixes_id[k[:prefix]],
+                                      @prefixes[u[:prefix]])
+                   else
+                     u[:prefix]
+                   end
           m << { prefix: prefix,
                  unit: @units_id[k[:id]].symbolid,
                  exponent: (k[:power]&.to_i || 1) * (u[:exponent]&.to_f || 1) }
@@ -157,6 +128,7 @@ module Asciimath2UnitsML
       return p1.symbolid if p2.nil?
       return p2.symbolid if p1.nil?
       return "unknown" if p1.base != p2.base
+
       @prefixes.each do |_, p|
         return p.symbolid if p.base == p1.base && p.power == p1.power + p2.power
       end
@@ -174,43 +146,26 @@ module Asciimath2UnitsML
     def quantity(normtext, quantity)
       return unless @units[normtext] && @units[normtext].quantities.size == 1 ||
         @quantities[quantity]
+
       id = quantity || @units[normtext].quantities.first
       @units[normtext]&.dimension and
         dim = %( dimensionURL="##{@units[normtext].dimension}")
-      <<~END
-      <Quantity xmlns='#{UNITSML_NS}' xml:id="#{id}"#{dim} quantityType="base">
-      #{quantityname(id)}
-      </Quantity>
-      END
-    end
-
-    def dimid2dimensions(normtext)
-      @dimensions_id[normtext].keys.map do |k|
-        { dimension: k,
-          symbol: U2D.values.select { |v| v[:dimension] == k }.first[:symbol],
-          exponent: @dimensions_id[normtext].exponent(k) }
-      end
-    end
-
-    def dimension(normtext)
-      return unless @units[normtext]&.dimension 
-      dims = dimid2dimensions(@units[normtext]&.dimension)
-      <<~END
-      <Dimension xmlns='#{UNITSML_NS}' xml:id="#{@units[normtext]&.dimension}">
-      #{dims.map { |u| dimension1(u) }.join("\n") }
-      </Dimension>
-      END
+      <<~XML
+        <Quantity xmlns='#{UNITSML_NS}' xml:id="#{id}"#{dim} quantityType="base">
+        #{quantityname(id)}
+        </Quantity>
+      XML
     end
 
     def unitsml(units, origtext, normtext, quantity, name)
       dims = units2dimensions(units)
-      <<~END
-      #{unit(units, origtext, normtext, dims, name)}
-      #{prefix(units)}
-      #{dimension(normtext)}
-      #{dimension_components(dims)}
-      #{quantity(normtext, quantity)}
-      END
+      <<~XML
+        #{unit(units, origtext, normtext, dims, name)}
+        #{prefix(units)}
+        #{dimension(normtext)}
+        #{dimension_components(dims)}
+        #{quantity(normtext, quantity)}
+      XML
     end
   end
 end