plurimath 0.2.9 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8c97fcf3901a7da18bbac329563b358490117e3ec3103f6c5c9e4e8ad7b5d3c8
-  data.tar.gz: abe2849aa2d81cb246b2b703576c6ae0df283b323e27433a9af95d07c1dd9932
+  metadata.gz: 80f221bdd7b1327b1773cb34581837b8e1dce2dd869d8908ce6da6c70cd6af33
+  data.tar.gz: abf97a179d3b56a42a36cdeedd5323caf9873125c88cbc1109ecbd32c13be70e
 SHA512:
-  metadata.gz: 2ac0c52f647ba6ff70bbf2fd0d9af2a33df8176c287699e8e99aa3478eaa44fe9b8fabcb54d115de5116f6823f2cdcda0f53965bbde806f47b948f3ca5d2a81c
-  data.tar.gz: ba854ed8ecd87cd3fb30e2c80508abfaa0d900a22f3492d531f0b592272d692d9886203db73d81da1dbe0b3402831c2164f8c32472d69926f8976f069eab3718
+  metadata.gz: efa17041d13cb3107a5364777b0cf9cff7e20daf37a885ecf43680a9e9a01d47df2610416042316068fc85a92145aeb888635800994d917dbcb67b91333c2b59
+  data.tar.gz: 9f2af614455c09f6475692431db914ac750dfe405cdf0af4ed38a9dc8e0d6adc7b5d5cf3f2e3e331818b4532c9b4a200f88cdee0ac03e907b2c6fcb26ca994c9

data/lib/plurimath/asciimath/constants.rb

@@ -197,7 +197,7 @@ module Plurimath
         neg: :"¬",
         not: :"¬",
         "*": :"⋅",
-        "@": :"@",
+        "@": :"∘",
         "<": :"&#x3c;",
         ">": :"&#x3e;",
         "/": :"&#x2f;",

data/lib/plurimath/asciimath/transform.rb

@@ -352,7 +352,7 @@ module Plurimath
           font_style.to_s,
         )
         Math::Function::Base.new(
-          Utility.unfenced_value(font_object),
+          font_object,
           Utility.unfenced_value(base),
         )
       end
@@ -460,7 +460,7 @@ module Plurimath
       rule(power_base: simple(:power_base),
            base: simple(:base)) do
         Math::Function::Base.new(
-          Utility.unfenced_value(power_base),
+          power_base,
           Utility.unfenced_value(base),
         )
       end
@@ -469,7 +469,7 @@ module Plurimath
            base: simple(:base),
            expr: sequence(:expr)) do
         base_object = Math::Function::Base.new(
-          Utility.unfenced_value(power_base),
+          power_base,
           Utility.unfenced_value(base),
         )
         Math::Formula.new(
@@ -481,7 +481,7 @@ module Plurimath
            base: simple(:base),
            expr: simple(:expr)) do
         base_object = Math::Function::Base.new(
-          Utility.unfenced_value(power_base),
+          power_base,
           Utility.unfenced_value(base),
         )
         formula_array = [base_object]
@@ -494,7 +494,7 @@ module Plurimath
            base_value: simple(:base_value),
            power_value: simple(:power_value)) do
         Math::Function::PowerBase.new(
-          Utility.unfenced_value(power_base),
+          power_base,
           Utility.unfenced_value(base_value),
           Utility.unfenced_value(power_value),
         )
@@ -506,7 +506,7 @@ module Plurimath
         first_value = power_value
         first_value = power_value.shift if Utility.frac_values(power_value)
         power_base_object = Math::Function::PowerBase.new(
-          Utility.unfenced_value(power_base),
+          power_base,
           Utility.unfenced_value(base_value),
           Utility.filter_values(first_value),
         )
@@ -527,7 +527,7 @@ module Plurimath
            power_value: simple(:power_value),
            expr: sequence(:expr)) do
         power_base_object = Math::Function::PowerBase.new(
-          Utility.unfenced_value(power_base),
+          power_base,
           Utility.unfenced_value(base_value),
           Utility.unfenced_value(power_value),
         )
@@ -649,7 +649,7 @@ module Plurimath
       rule(intermediate_exp: simple(:int_exp),
            base: simple(:base)) do
         Math::Function::Base.new(
-          Utility.unfenced_value(int_exp),
+          int_exp,
           Utility.unfenced_value(base),
         )
       end

data/lib/plurimath/latex/parse.rb

@@ -208,7 +208,7 @@ module Plurimath
 
       def unary_rules(first_value)
         (slashed_value(first_value, :unary_functions) >> dynamic_power_base) |
-          (slashed_value(first_value, :unary) >> intermediate_exp.as(:first_value)).as(:unary_functions) |
+          (slashed_value(first_value, :unary) >> (left_right | intermediate_exp).as(:first_value)).as(:unary_functions) |
           (slashed_value(first_value, :unary))
       end
 

data/lib/plurimath/math/formula.rb

@@ -3,14 +3,17 @@
 module Plurimath
   module Math
     class Formula
-      attr_accessor :value
+      attr_accessor :value, :left_right_wrapper
 
-      def initialize(value = [])
+      def initialize(value = [], left_right_wrapper = true)
         @value = value.is_a?(Array) ? value : [value]
+        left_right_wrapper = false if @value.first.is_a?(Function::Left)
+        @left_right_wrapper = left_right_wrapper
       end
 
       def ==(object)
-        object.value == value
+        object.value == value &&
+          object.left_right_wrapper == left_right_wrapper
       end
 
       def to_asciimath
@@ -31,6 +34,8 @@ module Plurimath
       end
 
       def to_mathml_without_math_tag
+        return mathml_content unless left_right_wrapper
+
         Utility.update_nodes(
           Utility.ox_element("mrow"),
           mathml_content,

data/lib/plurimath/math/function/abs.rb

@@ -6,6 +6,14 @@ module Plurimath
   module Math
     module Function
       class Abs < UnaryFunction
+        def to_mathml_without_math_tag
+          symbol = Utility.ox_element("mo") << "|"
+          first_value = mathml_value&.insert(0, symbol)
+          Utility.update_nodes(
+            Utility.ox_element("mrow"),
+            first_value << symbol,
+          )
+        end
       end
     end
   end

data/lib/plurimath/math/function/binary_function.rb

@@ -9,6 +9,7 @@ module Plurimath
         def initialize(parameter_one = nil, parameter_two = nil)
           @parameter_one = parameter_one
           @parameter_two = parameter_two
+          Utility.validate_left_right([parameter_one, parameter_two])
         end
 
         def to_asciimath

data/lib/plurimath/math/function/ceil.rb

@@ -9,6 +9,16 @@ module Plurimath
         def to_latex
           "{\\lceil #{latex_value} \\rceil}"
         end
+
+        def to_mathml_without_math_tag
+          left_value = Utility.ox_element("mo") << "&#x2308;"
+          first_value = mathml_value&.insert(0, left_value)
+          right_value = Utility.ox_element("mo") << "&#x2309;"
+          Utility.update_nodes(
+            Utility.ox_element("mrow"),
+            first_value << right_value,
+          )
+        end
       end
     end
   end

data/lib/plurimath/math/function/ddot.rb

@@ -6,6 +6,13 @@ module Plurimath
   module Math
     module Function
       class Ddot < UnaryFunction
+        def to_mathml_without_math_tag
+          second_value = Utility.ox_element("mo") << ".."
+          Utility.update_nodes(
+            Utility.ox_element("mover", attributes: { accent: "true" }),
+            mathml_value << second_value,
+          )
+        end
       end
     end
   end

data/lib/plurimath/math/function/sum.rb

@@ -56,7 +56,7 @@ module Plurimath
         protected
 
         def omml_first_value
-          return parameter_one&.to_omml_without_math_tag unless parameter_one&.is_a?(Math::Symbol)
+          return parameter_one&.to_omml_without_math_tag unless parameter_one.is_a?(Math::Symbol)
 
           mt = Utility.ox_element("t", namespace: "m")
           mt << parameter_one.to_omml_without_math_tag if parameter_one
@@ -64,7 +64,7 @@ module Plurimath
         end
 
         def omml_second_value
-          return parameter_two&.to_omml_without_math_tag unless parameter_two&.is_a?(Math::Symbol)
+          return parameter_two&.to_omml_without_math_tag unless parameter_two.is_a?(Math::Symbol)
 
           mt = Utility.ox_element("t", namespace: "m")
           mt << parameter_two.to_omml_without_math_tag if parameter_two

data/lib/plurimath/math/function/ternary_function.rb

@@ -12,6 +12,7 @@ module Plurimath
           @parameter_one = parameter_one
           @parameter_two = parameter_two
           @parameter_three = parameter_three
+          Utility.validate_left_right([parameter_one, parameter_two, parameter_three])
         end
 
         def to_asciimath

data/lib/plurimath/math/function/tilde.rb

@@ -6,6 +6,12 @@ module Plurimath
   module Math
     module Function
       class Tilde < UnaryFunction
+        def to_mathml_without_math_tag
+          mover = Utility.ox_element("mover")
+          first_value = (Utility.ox_element("mo") << "~")
+          second_value = parameter_one.to_mathml_without_math_tag if parameter_one
+          Utility.update_nodes(mover, [second_value, first_value])
+        end
       end
     end
   end

data/lib/plurimath/math/function/unary_function.rb

@@ -9,6 +9,7 @@ module Plurimath
         def initialize(parameter_one = nil)
           parameter_one  = parameter_one.to_s if parameter_one.is_a?(Parslet::Slice)
           @parameter_one = parameter_one
+          Utility.validate_left_right([parameter_one])
         end
 
         def ==(object)
@@ -104,10 +105,10 @@ module Plurimath
 
         def omml_value
           if parameter_one.is_a?(Array)
-            return parameter_one.compact.map(&:to_omml_without_math_tag)
+            return parameter_one&.compact&.map(&:to_omml_without_math_tag)
           end
 
-          first_value = parameter_one.to_omml_without_math_tag
+          first_value = parameter_one&.to_omml_without_math_tag
           if parameter_one.is_a?(Symbol)
             first_value = Utility.ox_element("t", namespace: "m") << first_value
           end

data/lib/plurimath/math/symbol.rb

@@ -31,7 +31,7 @@ module Plurimath
 
         unicodes = Mathml::Constants::UNICODE_SYMBOLS
         unicode = unicodes.invert[value]
-        if operator?(unicode) || unicode
+        if operator?(unicode) || unicode || explicit_checks(unicode)
           mo_value = (unicodes[value] || unicode || value).to_s
           return Utility.ox_element("mo") << mo_value
         end
@@ -70,6 +70,10 @@ module Plurimath
         end
       end
 
+      def explicit_checks(unicode)
+        return true if [unicode, value].any?{|v| ["∣", "|"].include?(v) }
+      end
+
       def specific_values
         return "" if ["{:", ":}"].include?(value)
 

data/lib/plurimath/math.rb

@@ -24,7 +24,8 @@ Ox.default_options = { encoding: "UTF-8" }
 
 module Plurimath
   module Math
-    class Error < StandardError; end
+    class ParseError < StandardError; end
+    class InvalidTypeError < TypeError; end
 
     VALID_TYPES = {
       omml: Omml,
@@ -37,25 +38,39 @@ module Plurimath
     }.freeze
 
     def parse(text, type)
-      raise_error! unless valid_type?(type)
+      type_error! unless valid_type?(type)
 
-      klass = VALID_TYPES[type.to_sym]
-      klass.new(text).to_formula
-    rescue => ee
-      message = <<~MESSAGE
-        An error occurred while processing the input. Please check your input to ensure it is valid or open an issue on Github If you believe the input is correct.
-        ---- INPUT START ----
-          #{text}
-        ---- INPUT END ----
-      MESSAGE
-      raise Math::Error.new(message), cause: nil
+      begin
+        klass = klass_from_type(type)
+        klass.new(text).to_formula
+      rescue => ee
+        parse_error!(text, type.to_sym)
+      end
     end
 
     private
 
-    def raise_error!
-      raise Plurimath::Math::Error, Error.new("Type is not valid, "\
-                                              "please enter string or symbol")
+    def klass_from_type(type_string_or_sym)
+      VALID_TYPES[type_string_or_sym.to_sym]
+    end
+
+    def parse_error!(text, type)
+      message = <<~MESSAGE
+        [plurimath] Error: Failed to parse the following formula with type `#{type}`.
+        [plurimath] Please first manually validate the formula.
+        [plurimath] If this is a bug, please report the formula at our issue tracker at:
+        [plurimath] https://github.com/plurimath/plurimath/issues
+        ---- FORMULA BEGIN ----
+        #{text}
+        ---- FORMULA END ----
+      MESSAGE
+      raise ParseError.new(message), cause: nil
+    end
+
+    def type_error!
+      raise InvalidTypeError.new(
+        "`type` must be one of: `#{VALID_TYPES.keys.join('`, `')}`"
+      )
     end
 
     def valid_type?(type)
@@ -63,6 +78,6 @@ module Plurimath
         VALID_TYPES.key?(type.to_sym)
     end
 
-    module_function :parse, :raise_error!, :valid_type?
+    module_function :parse, :klass_from_type, :parse_error!, :type_error!, :valid_type?
   end
 end

data/lib/plurimath/utility.rb

@@ -190,7 +190,10 @@ module Plurimath
       end
 
       def update_nodes(element, nodes)
-        nodes&.each { |node| element << node unless node.nil? }
+        nodes&.each do |node|
+          next update_nodes(element, node) if node.is_a?(Array)
+          element << node unless node.nil?
+        end
         element
       end
 
@@ -361,8 +364,7 @@ module Plurimath
       def unfenced_value(object)
         case object
         when Math::Function::Fenced
-          value = filter_values(object.parameter_two)
-          unfenced_value(value)
+          filter_values(object.parameter_two)
         when Array
           filter_values(object)
         else
@@ -397,6 +399,14 @@ module Plurimath
                 end
         Math::Symbol.new(value)
       end
+
+      def validate_left_right(fields = [])
+        fields.each do |field|
+          if field.is_a?(Math::Formula) && field.value.first.is_a?(Math::Function::Left)
+            field.left_right_wrapper = true
+          end
+        end
+      end
     end
   end
 end

data/lib/plurimath/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Plurimath
-  VERSION = "0.2.9"
+  VERSION = "0.3.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plurimath
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.3.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-19 00:00:00.000000000 Z
+date: 2023-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet