asciimath2unitsml 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f51b82e234fddaf66252f77a276a3acf68dae4356502a3c900253f5d4d4dffcf
-  data.tar.gz: 59dd18f009952329c1c07af2132ec06123c06dd3caea4ee7f22f17c0f4ec1cbc
+  metadata.gz: 829d573c90a88f5d26b2310d69f5ea575084df208cd3f441342435b0a6a3d353
+  data.tar.gz: 534c2ea7485b1de1c126de112a1ad8c9b10683797034e99313fda199c5f7e572
 SHA512:
-  metadata.gz: 9a925e3db85d3086d676c07c101609e87674d620394f5fa0a536ab3652f3aa9c0cc6a74507d79264e0154bf51ea4121d47b7275a94212bc934b822b0392a9970
-  data.tar.gz: 59d98ebd629a20e8f03dc32a1870474e5808b9d38f51a87feec5eae9f0746535bed9dcf38b1faf3939319bb3989b1d926088e8d834388e48f045070e3749312a
+  metadata.gz: c6eec2cb24fff7931d236a9a14a6d4ae1a938fe348d1e1d02a4d2f9be8e7f72e124e633ef0ef4b0f1e476ee8a2dee900210e60010600e0b082eb95237d2c70d2
+  data.tar.gz: e6943596be90a3bd1e6336b7bfa395cee4aa41e88ab6e5b2d003216a2271fc72249a018218d65c4ef446f4d246412e2b9fa0ac0d9721095abd4d9baa95515389

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', '2.4' ]
         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

data/Gemfile

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

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"
 
@@ -29,25 +29,23 @@ Gem::Specification.new do |spec|
     .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

@@ -46,7 +46,7 @@ module Asciimath2UnitsML
 
     def prefix(units)
       units.map { |u| u[:prefix] }.reject(&:nil?).uniq.map do |p|
-        <<~END
+        <<~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>
@@ -55,18 +55,18 @@ module Asciimath2UnitsML
             <PrefixSymbol type="LaTeX">#{@prefixes[p].latex}</PrefixSymbol>
             <PrefixSymbol type="HTML">#{htmlent @prefixes[p].html}</PrefixSymbol>
           </Prefix>
-        END
+        XML
       end.join("\n")
     end
 
     def dimension_components(dims)
       return if dims.nil? || dims.empty?
 
-      <<~END
+      <<~XML
         <Dimension xmlns='#{UNITSML_NS}' xml:id="#{dim_id(dims)}">
         #{dims.map { |u| dimension1(u) }.join("\n")}
         </Dimension>
-      END
+      XML
     end
 
     U2D = {
@@ -98,9 +98,9 @@ module Asciimath2UnitsML
       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])}"/>)
+    def dimension1(dim)
+      %(<#{dim[:dimension]} symbol="#{dim[:symbol]}"
+      powerNumerator="#{float_to_display(dim[:exponent])}"/>)
     end
 
     def dim_id(dims)
@@ -188,11 +188,11 @@ module Asciimath2UnitsML
       id = quantity || @units[normtext].quantities.first
       @units[normtext]&.dimension and
         dim = %( dimensionURL="##{@units[normtext].dimension}")
-      <<~END
+      <<~XML
         <Quantity xmlns='#{UNITSML_NS}' xml:id="#{id}"#{dim} quantityType="base">
         #{quantityname(id)}
         </Quantity>
-      END
+      XML
     end
 
     def dimid2dimensions(normtext)
@@ -207,22 +207,22 @@ module Asciimath2UnitsML
       return unless @units[normtext]&.dimension
 
       dims = dimid2dimensions(@units[normtext]&.dimension)
-      <<~END
+      <<~XML
         <Dimension xmlns='#{UNITSML_NS}' xml:id="#{@units[normtext]&.dimension}">
         #{dims.map { |u| dimension1(u) }.join("\n")}
         </Dimension>
-      END
+      XML
     end
 
     def unitsml(units, origtext, normtext, quantity, name)
       dims = units2dimensions(units)
-      <<~END
+      <<~XML
         #{unit(units, origtext, normtext, dims, name)}
         #{prefix(units)}
         #{dimension(normtext)}
         #{dimension_components(dims)}
         #{quantity(normtext, quantity)}
-      END
+      XML
     end
   end
 end

data/lib/asciimath2unitsml/parse.rb

@@ -67,8 +67,8 @@ module Asciimath2UnitsML
       parser = units.eof
     end
 
-    def parse(x)
-      text = Array(x.split(/,\s*/))
+    def parse(expr)
+      text = Array(expr.split(/,\s*/))
       units = @parser.parse!(text[0])
       if !units || Rsec::INVALID[units]
         raise Rsec::SyntaxError.new "error parsing UnitsML expression", x, 1, 0
@@ -80,10 +80,18 @@ module Asciimath2UnitsML
 
     def postprocess(units, text)
       units = postprocess1(units.flatten)
-      quantity = text[1..-1]&.select { |x| /^quantity:/.match(x) }&.first&.sub(/^quantity:\s*/, "")
-      name = text[1..-1]&.select { |x| /^name:/.match(x) }&.first&.sub(/^name:\s*/, "")
-      symbol = text[1..-1]&.select { |x| /^symbol:/.match(x) }&.first&.sub(/^symbol:\s*/, "")
-      multiplier = text[1..-1]&.select { |x| /^multiplier:/.match(x) }&.first&.sub(/^multiplier:\s*/, "")
+      quantity = text[1..-1]&.select do |x|
+        /^quantity:/.match(x)
+      end&.first&.sub(/^quantity:\s*/, "")
+      name = text[1..-1]&.select do |x|
+        /^name:/.match(x)
+      end&.first&.sub(/^name:\s*/, "")
+      symbol = text[1..-1]&.select do |x|
+        /^symbol:/.match(x)
+      end&.first&.sub(/^symbol:\s*/, "")
+      multiplier = text[1..-1]&.select do |x|
+        /^multiplier:/.match(x)
+      end&.first&.sub(/^multiplier:\s*/, "")
       normtext = units_only(units).each.map do |u|
         exp = u[:exponent] && u[:exponent] != "1" ? "^#{u[:exponent]}" : ""
         "#{u[:prefix]}#{u[:unit]}#{exp}"
@@ -110,14 +118,16 @@ module Asciimath2UnitsML
       MathML2UnitsML(xml).to_xml
     end
 
-    # https://www.w3.org/TR/mathml-units/ section 2: delimit number Invisible-Times unit
+    # https://www.w3.org/TR/mathml-units/ section 2:
+    # delimit number Invisible-Times unit
     def MathML2UnitsML(xml)
       xml.is_a? String and xml = Nokogiri::XML(xml)
       xml.xpath(".//m:mtext", "m" => MATHML_NS).each do |x|
-        next unless %r{^unitsml\(.+\)$}.match(x.text)
+        next unless %r{^unitsml\(.+\)$}.match?(x.text)
 
         text = x.text.sub(%r{^unitsml\((.+)\)$}m, "\\1")
-        units, origtext, normtext, quantity, name, symbol, multiplier = parse(text)
+        units, origtext, normtext, quantity, name, symbol, multiplier =
+          parse(text)
         rendering = symbol ? embeddedmathml(asciimath2mathml(symbol)) :
           mathmlsymbol(units, false, multiplier)
         x.replace("#{delimspace(rendering, x)}"\
@@ -127,11 +137,13 @@ module Asciimath2UnitsML
       dedup_ids(xml)
     end
 
-    # if previous sibling's last descendent non-whitespace is MathML and mn or mi, no space
+    # if previous sibling's last descendent non-whitespace is MathML and
+    # mn or mi, no space
     def delimspace(rendering, elem)
       prec_text_elem =
         elem.xpath("./preceding-sibling::*[namespace-uri() = '#{MATHML_NS}']/"\
-                   "descendant::text()[normalize-space()!=''][last()]/parent::*").last
+                   "descendant::text()[normalize-space()!='']"\
+                   "[last()]/parent::*").last
       return "" if prec_text_elem.nil? ||
         !%w(mn mi).include?(prec_text_elem&.name)
 
@@ -157,8 +169,8 @@ module Asciimath2UnitsML
 
     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}'>")
+        AsciiMath.parse(HTMLEntities.new.decode(expression)).ast
+      ).to_s.gsub(/<math>/, "<math xmlns='#{MATHML_NS}'>")
     end
 
     def embeddedmathml(mathml)
@@ -185,13 +197,13 @@ module Asciimath2UnitsML
     def render_ambig_units(u)
       maxcols = 0
       u.each { |_, v| maxcols = v.size if maxcols < v.size }
-      puts %([cols="#{maxcols + 1}*"]\n|===\n|Symbol | Unit + ID #{"| " * (maxcols - 1)}\n)
+      puts %([cols="#{maxcols + 1}*"]\n|===\n|Symbol | Unit + ID #{'| ' * (maxcols - 1)}\n)
       puts "\n\n"
       u.keys.sort_by { |a| [-u[a].size, a.gsub(%r{\&[^;]+;}, "")
         .gsub(/[^A-Za-z]/, "").downcase] }.each do |k|
         print "| #{html2adoc(k)} "
         u[k].sort_by(&:size).each { |v1| print "| #{@units[v1].name}: `#{v1}` " }
-        puts "#{'| ' * (maxcols - u[k].size) }\n"
+        puts "#{'| ' * (maxcols - u[k].size)}\n"
       end
       puts "|===\n"
     end

data/lib/asciimath2unitsml/render.rb

@@ -7,7 +7,8 @@ module Asciimath2UnitsML
       when :nospace
         { html: "", mathml: "<mo>&#x2062;</mo>" }
       else
-        { html: HTMLEntities.new.encode(x), mathml: "<mo>#{HTMLEntities.new.encode(x)}</mo>" }
+        { html: HTMLEntities.new.encode(x),
+          mathml: "<mo>#{HTMLEntities.new.encode(x)}</mo>" }
       end
     end
 
@@ -15,18 +16,21 @@ module Asciimath2UnitsML
       @symbols[unit][style] || unit
     end
 
-    def htmlent(x)
-      HTMLEntities.new.decode(x).split(/([<>&])/)
-        .map { |c| /[<>'"]/.match(c) ? c : HTMLEntities.new.encode(c, :hexadecimal) }.join
+    def htmlent(xml)
+      HTMLEntities.new.decode(xml).split(/([<>&])/).map do |c|
+        /[<>'"]/.match?(c) ? c : HTMLEntities.new.encode(c, :hexadecimal)
+      end.join
     end
 
     def htmlsymbol(units, normalise)
       units.map do |u|
-        if u[:multiplier] then u[:multiplier] == "*" ? @multiplier[:html] : u[:multiplier]
+        if u[:multiplier]
+          u[:multiplier] == "*" ? @multiplier[:html] : u[:multiplier]
         elsif u[:unit].nil? && u[:prefix]
           @prefixes[u[:prefix]].html
         else
-          base = (u[:prefix] || "") + render(normalise ? @units[u[:unit]].symbolid : u[:unit], :html)
+          base = (u[:prefix] || "") +
+            render(normalise ? @units[u[:unit]].symbolid : u[:unit], :html)
           htmlsymbol_exponent(u, base)
         end
       end.join("")
@@ -36,7 +40,7 @@ module Asciimath2UnitsML
       if u[:display_exponent] == "0.5"
         base = "&#x221a;#{base}"
       elsif u[:display_exponent]
-        exp = "<sup>#{u[:display_exponent].sub(/-/, "&#x2212;")}</sup>"
+        exp = "<sup>#{u[:display_exponent].sub(/-/, '&#x2212;')}</sup>"
         base += exp
       end
       base
@@ -44,8 +48,9 @@ module Asciimath2UnitsML
 
     def mathmlsymbol(units, normalise, multiplier = nil)
       multiplier = multiplier ? "<mo>#{multiplier}</mo>" : @multiplier[:mathml]
-      exp = units.map do |u|
-        if u[:multiplier] then u[:multiplier] == "*" ? multiplier : "<mo>#{u[:multiplier]}</mo>"
+      units.map do |u|
+        if u[:multiplier]
+          u[:multiplier] == "*" ? multiplier : "<mo>#{u[:multiplier]}</mo>"
         elsif u[:unit].nil? && u[:prefix]
           %(<mi mathvariant='normal'>#{htmlent(@prefixes[u[:prefix]].html)}</mi>)
         else
@@ -65,20 +70,21 @@ module Asciimath2UnitsML
       mathmlsymbol_exponent(u, base)
     end
 
-    def mathmlsymbol_exponent(u, base)
-      if u[:display_exponent] == "0.5"
+    def mathmlsymbol_exponent(unit, base)
+      if unit[:display_exponent] == "0.5"
         base = "<msqrt>#{base}</msqrt>"
-      elsif u[:display_exponent]
-        exp = "<mn>#{u[:display_exponent]}</mn>".sub(/<mn>-/, "<mo>&#x2212;</mo><mn>")
+      elsif unit[:display_exponent]
+        exp = "<mn>#{unit[:display_exponent]}</mn>"
+          .sub(/<mn>-/, "<mo>&#x2212;</mo><mn>")
         base = "<msup><mrow>#{base}</mrow><mrow>#{exp}</mrow></msup>"
       end
       base
     end
 
     def mathmlsymbolwrap(units, normalise)
-      <<~END
-      <math xmlns='#{MATHML_NS}'><mrow>#{mathmlsymbol(units, normalise)}</mrow></math>
-      END
+      <<~XML
+        <math xmlns='#{MATHML_NS}'><mrow>#{mathmlsymbol(units, normalise)}</mrow></math>
+      XML
     end
   end
 end

data/lib/asciimath2unitsml/unit.rb

@@ -12,16 +12,17 @@ module Asciimath2UnitsML
 
     def unit(units, origtext, normtext, dims, name)
       return if units_only(units).any? { |x| x[:unit].nil? }
+
       dimid = dim_id(dims)
       norm_units = normalise_units(units)
-      <<~END
-      <Unit xmlns='#{UNITSML_NS}' xml:id='#{unit_id(normtext)}'#{dimid ? " dimensionURL='##{dimid}'" : ""}>
-      #{unitsystem(units)}
-      #{unitname(norm_units, normtext, name)}
-      #{unitsymbol(norm_units)}
-      #{rootunits(units)}
-      </Unit>
-      END
+      <<~XML
+        <Unit xmlns='#{UNITSML_NS}' xml:id='#{unit_id(normtext)}'#{dimid ? " dimensionURL='##{dimid}'" : ""}>
+        #{unitsystem(units)}
+        #{unitname(norm_units, normtext, name)}
+        #{unitsymbol(norm_units)}
+        #{rootunits(units)}
+        </Unit>
+      XML
     end
 
     def normalise_units(units)
@@ -36,6 +37,7 @@ module Asciimath2UnitsML
     # kg exception
     def unitsystem(units)
       return if units_only(units).any? { |x| x[:unit].nil? }
+
       ret = []
       units = units_only(units)
       units.any? { |x| @units[x[:unit]].system_name != "SI" } and
@@ -43,7 +45,7 @@ module Asciimath2UnitsML
       if units.any? { |x| @units[x[:unit]].system_name == "SI" }
         base = units.size == 1 && @units[units[0][:unit]].system_type == "SI-base"
         base = true if units.size == 1 && units[0][:unit] == "g" && units[0][:prefix] == "k"
-        ret << "<UnitSystem name='SI' type='#{base ? "SI_base" : "SI_derived"}' xml:lang='en-US'/>"
+        ret << "<UnitSystem name='SI' type='#{base ? 'SI_base' : 'SI_derived'}' xml:lang='en-US'/>"
       end
       ret.join("\n")
     end
@@ -59,23 +61,25 @@ module Asciimath2UnitsML
     end
 
     def unitsymbol(units)
-      <<~END
-      <UnitSymbol type="HTML">#{htmlsymbol(units, true)}</UnitSymbol>
-      <UnitSymbol type="MathML">#{mathmlsymbolwrap(units, true)}</UnitSymbol>
-      END
+      <<~XML
+        <UnitSymbol type="HTML">#{htmlsymbol(units, true)}</UnitSymbol>
+        <UnitSymbol type="MathML">#{mathmlsymbolwrap(units, true)}</UnitSymbol>
+      XML
     end
 
     def rootunits(units)
       return if units_only(units).any? { |x| x[:unit].nil? }
       return if units.size == 1 && !units[0][:prefix]
+
       exp = units_only(units).map do |u|
         prefix = " prefix='#{u[:prefix]}'" if u[:prefix]
-        exponent = " powerNumerator='#{u[:exponent]}'" if u[:exponent] && u[:exponent] != "1"
+        u[:exponent] && u[:exponent] != "1" and
+          exponent = " powerNumerator='#{u[:exponent]}'"
         "<EnumeratedRootUnit unit='#{@units[u[:unit]].name}'#{prefix}#{exponent}/>"
       end.join("\n")
-      <<~END
-      <RootUnits>#{exp}</RootUnits>
-      END
+      <<~XML
+        <RootUnits>#{exp}</RootUnits>
+      XML
     end
   end
 end