plurimath 0.10.0 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e78c38692b0343fbe7666f309339f0e94180803b8aa81e48c71897d37eab606
-  data.tar.gz: 44c7c9ae6c2fb5d9b09d869c09c91775172f77b9bf27dee0aeb511f5bb272046
+  metadata.gz: a2ce7ef29dd4032b83c86b06d92276325630994243ef48e193aa8d3092e2fe22
+  data.tar.gz: ebaec8740845b7f1cb76e690f95f349d98d18a0b1342528463d8af3187138d1c
 SHA512:
-  metadata.gz: 4d79d19001092a56d19ae94705c3777460fd24cd57ebca84b1a6ee1d9b68ed473e0cf3799d45c58ba6af6f3aa0e56dc8b8160559bc43c70404885adb024a2232
-  data.tar.gz: c256d08993caa5a78caded66b7aaa65c8c7a52f413bb14dacfafbe29f2984fa604516942a8b28b5684486f34eb99ca3da8f03dc5f11513a41381484e0a507d7d
+  metadata.gz: a80a5ad2febd36bad53adc58c6a3d6406ee04bd78c05c2e3ea7eeecf0f924818798de20c745995ee38b161ffc3758389bb80d6ad6487de16183abdc12e88f166
+  data.tar.gz: 2f1258c3745a73a0c1d4336f489d1908cfc4691a19b093dc2d0a4bcd19612ad4d449a6f452ff963a27ca01aba6eada160be778e22f7705129fc44f43ad092985

data/.rspec-opal

@@ -3,8 +3,8 @@
 -q oga/setup_opal
 -q ll/setup_opal
 --opal-opt=-g,htmlentities
---opal-opt=-g,equivalent-xml
 --opal-opt=-g,parslet
+--opal-opt=-g,canon
 --opal-opt=-g,oga
 --format documentation
 --color

data/.rubocop.yml

@@ -1,10 +1,14 @@
-# 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
+  - .rubocop_todo.yml
 
-# local repo-specific modifications
-# ...
+plugins:
+- rubocop-performance
+- rubocop-rake
+- rubocop-rspec
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.0
+  NewCops: enable
+  Exclude:
+    - 'vendor/**/*'

data/Gemfile

@@ -3,12 +3,14 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in plurimath.gemspec
 gemspec
 
+gem 'lutaml-model', github: "lutaml/lutaml-model", branch: "main"
+gem 'canon'
 gem "rake", "~> 12.0"
 gem "rspec", "~> 3.0"
-gem 'simplecov', require: false, group: :test
-gem 'htmlentities'
-gem 'equivalent-xml'
-gem 'opal-rspec', "~> 1.1.0a"
+gem "rubocop-performance"
+gem "rubocop-rake"
+gem "rubocop-rspec"
 gem 'oga'
+gem 'opal-rspec', "~> 1.1.0a"
 gem 'ox'
-gem "debug"
+gem 'simplecov', require: false, group: :test

data/README.adoc

@@ -1135,7 +1135,9 @@ method using a `formatter` option, which serializes the formula into an math
 representation language.
 
 The formatter should be an instance of `Plurimath::NumberFormatter` or a custom
-formatter derived from `Plurimath::Formatter::Standard`.
+formatter derived from `Plurimath::Formatter::Standard`. Custom formatters can
+define a `format(formula, number)` method to make context-aware formatting
+decisions based on the surrounding formula (see <<Contextual number formatting>>).
 
 The quick example below demonstrates how to format a number in a formula.
 
@@ -1346,6 +1348,60 @@ end
 ====
 
 
+==== Contextual number formatting
+
+In some cases, certain numbers within a formula should be formatted differently
+depending on their context. For example, a year like "2024" should not have digit
+grouping applied, while other numbers in the same formula should.
+
+The `format` method on the formatter receives both the root
+`Plurimath::Math::Formula` tree and the current `Plurimath::Math::Number` node
+being processed, allowing context-aware formatting decisions.
+
+.Signature of the `format` method
+[source,ruby]
+----
+def format(formula, number)
+  # formula: the root Plurimath::Math::Formula containing the full equation
+  # number:  the Plurimath::Math::Number node currently being formatted
+  # returns: a formatted string
+end
+----
+
+Formatters that do not define `format` will fall back to `localized_number`, so
+existing formatters continue to work without changes.
+
+To implement contextual formatting, define a `format` method in a custom
+formatter subclass.
+
+.Creating a year-aware formatter that skips digit grouping for year-like numbers
+[example]
+====
+[source,ruby]
+----
+class YearFormatter < Plurimath::Formatter::Standard
+  def format(formula, number) <1>
+    int_value = Integer(number.value, exception: false)
+    if int_value && int_value > 1800 && int_value < 2200 <2>
+      number.value.to_s
+    else
+      localized_number(number.value.to_s) <3>
+    end
+  end
+end
+
+formatter = YearFormatter.new
+formula = Plurimath::Math.parse("2024 + 1000000", :asciimath)
+formula.to_latex(formatter: formatter)
+# => "2024 + 1,000,000" <4>
+----
+<1> Define `format` to receive the formula tree and number node.
+<2> Detect year-like numbers and return them unformatted.
+<3> Call `localized_number` to apply locale-based formatting for other numbers.
+<4> "2024" is left as-is, while "1000000" is formatted with digit grouping.
+====
+
+
 [[standard_configuration]]
 === Default number formatting configuration
 

data/Rakefile

@@ -105,7 +105,18 @@ def write_intent_doc_file(file)
   file.write("\nIntent for unary classes like, sin, cos, tan, etc. will be `Function`.\n")
 end
 
+def require_math_function_files
+  (
+    Dir.glob(File.join(__dir__, "lib/plurimath/math/function", "*.rb")) +
+    Dir.glob(File.join(__dir__, "lib/plurimath/math/function", "*", "*.rb"))
+  ).each do |file|
+    require file
+  end
+end
+
 def intent_classes
+  require_math_function_files
+
   intent_classes = [
     Plurimath::Math::Function::TernaryFunction.descendants,
     Plurimath::Math::Function::BinaryFunction.descendants,

data/lib/plurimath/asciimath/parse.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "parslet"
 module Plurimath
   class Asciimath
     class Parse < Parslet::Parser

data/lib/plurimath/asciimath/parser.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "parse"
-require_relative "constants"
-require_relative "transform"
 module Plurimath
   class Asciimath
     class Parser

data/lib/plurimath/asciimath.rb

@@ -2,6 +2,11 @@
 
 module Plurimath
   class Asciimath
+    autoload :Constants, "#{__dir__}/asciimath/constants"
+    autoload :Parse, "#{__dir__}/asciimath/parse"
+    autoload :Parser, "#{__dir__}/asciimath/parser"
+    autoload :Transform, "#{__dir__}/asciimath/transform"
+
     attr_accessor :text
 
     def initialize(text)

data/lib/plurimath/cli.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 require "thor"
+require_relative "../plurimath"
 
 module Plurimath
-  self.autoload :Math, "plurimath/math"
 
   class Cli < Thor
     desc "convert", "Convert between math formats"
@@ -43,6 +43,11 @@ module Plurimath
            desc: "Splits only MathML and OMML equations into multiple equations, Boolean only",
            force: :boolean
 
+    option :xml_engine,
+           aliases: "-e",
+           default: "ox",
+           desc: "XML engine to use for parsing and rendering (ox or oga)"
+
     def convert
       input          = options[:input]
       input_string   = options[:file_path] ? File.read(options[:file_path]) : input
@@ -50,6 +55,7 @@ module Plurimath
 
       input_format   = options[:input_format]
       output_format  = options[:output_format]
+      configure_xml_engine(input_format, output_format)
       formula        = Plurimath::Math.parse(input_string, input_format)
       return puts formula.to_display(output_format.to_sym) if YAML.safe_load(options[:math_rendering])
 
@@ -75,6 +81,27 @@ module Plurimath
     end
 
     no_commands do
+      def configure_xml_engine(input_format, output_format)
+        xml_formats = %w[mathml omml]
+        return unless xml_formats.include?(input_format) || xml_formats.include?(output_format)
+
+        set_xml_engine(options[:xml_engine])
+      end
+
+      def set_xml_engine(engine)
+        engine_class = case engine
+                       when "ox"
+                         require_relative "setup/ox_engine"
+                         Plurimath::XmlEngine::OxEngine
+                       when "oga"
+                         require_relative "setup/oga"
+                         Plurimath::XmlEngine::Oga
+                       else
+                         warn_and_exit("Invalid XML engine: #{engine}. Use 'ox' or 'oga'.")
+                       end
+        Plurimath.xml_engine = engine_class
+      end
+
       def warn_and_exit(message)
         warn(message)
         abort

data/lib/plurimath/errors.rb

@@ -1,5 +1 @@
 # frozen_string_literal: true
-
-require_relative "errors/parse_error"
-require_relative "errors/invalid_type_error"
-require_relative "errors/formatter/unsupported_base"

data/lib/plurimath/formatter/numbers.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Plurimath
+  module Formatter
+    module Numbers
+      autoload :Base, "#{__dir__}/numbers/base"
+      autoload :Fraction, "#{__dir__}/numbers/fraction"
+      autoload :Integer, "#{__dir__}/numbers/integer"
+      autoload :Significant, "#{__dir__}/numbers/significant"
+    end
+  end
+end

data/lib/plurimath/formatter/numeric_formatter.rb

@@ -78,7 +78,10 @@ module Plurimath
       end
 
       def notation_chars(num_str)
-        notation_array = BigDecimal(num_str).to_s("e").split("e")
+        bd = BigDecimal(num_str)
+        return [num_str, 0] if bd.zero?
+
+        notation_array = bd.to_s("e").split("e")
         notation_array[1] = update_exponent_value(notation_array[1])
         number_str = notation_array[0]
         number_str = number_str.gsub(/0\.(\d)/, '\1.')

data/lib/plurimath/formatter/standard.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../number_formatter"
 module Plurimath
   module Formatter
     class Standard < Plurimath::NumberFormatter

data/lib/plurimath/formatter.rb

@@ -1,15 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "errors/formatter/unsupported_base"
-require_relative "formatter/numeric_formatter"
-require_relative "formatter/supported_locales"
-require_relative "formatter/numbers/base"
-require_relative "formatter/numbers/integer"
-require_relative "formatter/numbers/fraction"
-require_relative "formatter/numbers/significant"
-require_relative "formatter/number_formatter"
-
 module Plurimath
   module Formatter
+    autoload :NumericFormatter, "#{__dir__}/formatter/numeric_formatter"
+    autoload :NumberFormatter, "#{__dir__}/formatter/number_formatter"
+    autoload :SupportedLocales, "#{__dir__}/formatter/supported_locales"
+    autoload :UnsupportedBase, "#{__dir__}/errors/formatter/unsupported_base"
+    autoload :Numbers, "#{__dir__}/formatter/numbers"
+    autoload :Standard, "#{__dir__}/formatter/standard"
   end
 end

data/lib/plurimath/html/parse.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "parslet"
 module Plurimath
   class Html
     class Parse < Parslet::Parser

data/lib/plurimath/html/parser.rb

@@ -2,9 +2,6 @@
 
 require "json"
 require "cgi"
-require_relative "parse"
-require_relative "constants"
-require_relative "transform"
 module Plurimath
   class Html
     class Parser

data/lib/plurimath/html.rb

@@ -2,6 +2,11 @@
 
 module Plurimath
   class Html
+    autoload :Constants, "#{__dir__}/html/constants"
+    autoload :Parse, "#{__dir__}/html/parse"
+    autoload :Parser, "#{__dir__}/html/parser"
+    autoload :Transform, "#{__dir__}/html/transform"
+
     attr_accessor :text
 
     def initialize(text)

data/lib/plurimath/latex/parse.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "parslet"
 module Plurimath
   class Latex
     class Parse < Parslet::Parser

data/lib/plurimath/latex/parser.rb

@@ -1,8 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "parse"
-require_relative "constants"
-require_relative "transform"
 module Plurimath
   class Latex
     class Parser
@@ -11,6 +8,7 @@ module Plurimath
       TEXT_REGEX = %r(\\(?:mbox|text)\{[^\}]+\})
 
       def initialize(text)
+        @enti = ::HTMLEntities.new
         @text = pre_processing(text)
       end
 
@@ -26,8 +24,7 @@ module Plurimath
 
       def pre_processing(text)
         text_functions = text.scan(TEXT_REGEX)
-        enti = HTMLEntities.new
-        text = enti.encode(enti.decode(text), :hexadecimal)
+        text = @enti.encode(@enti.decode(text), :hexadecimal)
         text = gsub_space_and_unicodes(text)
         text.gsub(TEXT_REGEX) { |str| text_functions.shift }
       end

data/lib/plurimath/latex.rb

@@ -2,6 +2,11 @@
 
 module Plurimath
   class Latex
+    autoload :Constants, "#{__dir__}/latex/constants"
+    autoload :Parse, "#{__dir__}/latex/parse"
+    autoload :Parser, "#{__dir__}/latex/parser"
+    autoload :Transform, "#{__dir__}/latex/transform"
+
     attr_accessor :text
 
     def initialize(text)

data/lib/plurimath/math/core.rb

@@ -285,7 +285,12 @@ module Plurimath
       end
 
       def variables
-        instance_variables
+        instance_variables.reject do |var|
+          name = var.to_s
+          name.start_with?("@__") ||
+            name.start_with?("@lutaml") ||
+            name == "@using_default"
+        end
       end
 
       def ox_element(node, attributes: [], namespace: "")
@@ -348,7 +353,6 @@ module Plurimath
       def pretty_print_instance_variables
         excluded_vars = [
           :@left_right_wrapper,
-          :@temp_mathml_order,
           :@using_default,
           :@displaystyle,
           :@__encoding,

data/lib/plurimath/math/formula/mrow.rb

@@ -16,30 +16,10 @@ module Plurimath
           @is_mrow = true
         end
 
-        def element_order=(value)
-          @value = validated_order(value&.map(&:name), rejectable_array: ["comment"])
-        end
-
-        def content; end
-
-        def content=(value)
-          arr_value = Array(value)
-          if no_content_in?(arr_value)
-            delete_all_text
-          else
-            validate_text_order(
-              arr_value.map { |val| validate_symbols(val) unless val.strip.empty? }
-            )
-          end
-          organize_value
-        end
-
         def is_mrow?
           @is_mrow
         end
 
-        private
-
         def organize_value
           return if value.any?(String)
           return unless is_mrow
@@ -62,6 +42,8 @@ module Plurimath
           end
         end
 
+        private
+
         def update_current_element(element, value, index)
           if first_and_last_values_nil?(value)
             replace_symbols_with_parens(value)
@@ -70,27 +52,6 @@ module Plurimath
           end
         end
 
-        def validate_text_order(value)
-          @value.each_with_index do |item, index|
-            next unless item == "text"
-
-            if value.first
-              @value[index] = value.shift
-            else
-              value.shift
-              @value.delete_at(index)
-            end
-          end
-        end
-
-        def delete_all_text
-          @value.delete("text")
-        end
-
-        def no_content_in?(value)
-          value.nil? || value.empty? || value&.all? { |val| val.strip.empty? }
-        end
-
         def first_and_last_values_nil?(value)
           value.first.class_name == "symbol" &&
             value.first.value.nil? &&

data/lib/plurimath/math/formula/mstyle.rb

@@ -11,6 +11,12 @@ module Plurimath
         def is_mstyle?
           true
         end
+
+        def omml_content(display_style, options:)
+          # Use Mstyle's own @displaystyle, not the passed-in display_style
+          effective_display = @displaystyle.nil? ? display_style : @displaystyle
+          value&.map { |val| val.insert_t_tag(effective_display, options: options) }
+        end
       end
     end
   end