plurimath 0.9.11 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ecaec3071c4b2925d95eceffec830c054c840c7813db4f0b8f4e6e95c366ced
-  data.tar.gz: 19adb5616581e744f45805329324b950dcad692c670fa07153579ff71f319d05
+  metadata.gz: cc005169c3f0268023980ba0d02d40a3e169c73ec1c75541f1ea71d8cadf6de6
+  data.tar.gz: 0d9fb467134da2b44ad20d1952d1795f4fa7e233a657b5589ea3b5cf5e99fb26
 SHA512:
-  metadata.gz: a4d1ee78250433329ab39e542804c8199afcf9afecb43027c76611c9619fc6f4eb72d2e49ff0b93c801d53f2986ee97b926217c0fe99c57898992aa900f12079
-  data.tar.gz: 020112a942828e93440ebdc3c95af0a720c8766411f4edf19cca7ec1f39423c67b8808a6cb95ef01e99429dc6f7d06d322f63829b3b2f7a832d2e308fd1aedd9
+  metadata.gz: c4d59a8681ab5b3b988d3a46ecfadc50661c43cc2d897816d943b3c621a6f8db202a8fca9b59c72fa732384284071aeec20851051b645cb7c29e4126fa0377d3
+  data.tar.gz: 54013f676433c00728a7b022b5c16ec3b77d2afd1949573ee56c0d90c936600289647cef2a886978e23da5be20af8d232dabf4e6ff9d3454dca77667f69d0f50

data/.github/workflows/release.yml

@@ -15,6 +15,9 @@ on:
 
 jobs:
   release:
+    permissions:
+      contents: write
+      id-token: write
     uses: metanorma/ci/.github/workflows/rubygems-release.yml@main
     with:
       next_version: ${{ github.event.inputs.next_version }}

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

@@ -129,7 +129,7 @@ plurimath convert -i "equation" -f omml -t mathml -d true
 ====
 [source,bash]
 ----
-plurimath convert -e <file_path> -t unicodemath
+plurimath convert -p <file_path> -f asciimath -t unicodemath
 ----
 ====
 
@@ -524,14 +524,25 @@ Symbol to use for the decimal point. Accepts a character.
 ====
 
 `digit_count`:: (`Numeric` value)
-Total number of digits to render, with the value truncated.
-Accepts an integer value.
+Total number of digits to render (integer + fractional), with the value truncated
+or rounded as necessary. Accepts an integer value.
++
+When `digit_count` is less than or equal to the integer length, the fractional
+part is omitted entirely, and the integer is rounded based on whether the
+fractional value is >= 0.5 (or >= base/2 for non-decimal bases).
 +
 .Specifying a total of 6 digits in rendering the number
 [example]
 ====
 "32232.232" => "32232.2"
 ====
++
+.When digit_count is smaller than the integer length
+[example]
+====
+"99999.999" with `digit_count: 3` => "100,000" (fractional part omitted, integer rounded up)
+"12345.123" with `digit_count: 3` => "12,345" (fractional part omitted, no rounding)
+====
 
 
 `group`:: (`String` value)
@@ -555,6 +566,116 @@ Accepts an integer value. (default is 3 in most locales.)
 "32232.232" => "3 22 32.232"
 ====
 
+`base`:: (`Numeric` value)
+Sets the numeric base (radix) used to render both the integer and fractional parts of the number.
+Supported values are 2 (binary), 8 (octal), 10 (decimal, default) and 16 (hexadecimal).
+Passing any other value for `base` raises `Plurimath::Formatter::UnsupportedBase`.
++
+.Rendering numbers in different bases
+[example]
+====
+"10"    with `base: 2, group_digits: 2, group: ","`  => "0b10,10"
+"9"     with `base: 8`  => "0o11"
+"255"   with `base: 16` => "0xff"
+"10.75" with `base: 2, group_digits: 2, group: ","`  => "0b10,10.11" (integer and fractional parts converted, with grouping)
+====
+
+`base_prefix`:: (`String` or `nil` value)
+Overrides the default base prefix for non‑decimal bases.
+When omitted, standard prefixes are used (`0b` for base 2, `0o` for base 8, `0x` for base 16).
+`nil` or an empty string can be used to omit the prefix.
++
+.Custom base prefixes
+[example]
+====
+"255" with `base: 16, base_prefix: "16#"` => "16#ff"
+"255" with `base: 16, base_prefix: nil`   => "ff"
+"255" with `base: 16, base_prefix: ""`   => "ff"
+====
+
+`base_postfix`:: (`String` value)
+If present, a postfix is appended to the converted number instead of using any base prefix.
+This is applied after digit grouping.
+`nil` or an empty string can be used to omit the postfix.
++
+.Using postfix notation
+[example]
+====
+"255" with `base: 16, base_postfix: "_16"` => "ff_16"
+"255" with `base: 16, base_postfix: nil` => "ff"
+"255" with `base: 16, base_postfix: ""` => "ff"
+====
+
+`hex_capital`:: (`Boolean` value)
+When `true` and `base: 16`, all characters in the range `a`-`f` in the converted output
+are rendered using uppercase letters. This includes both hexadecimal digits and any
+separators (such as `decimal`, `group`, `fraction_group`) that happen to be letters
+in the `a`-`f` range. The `base_prefix` and `base_postfix` values are never modified.
+It has no effect for other bases.
++
+.Uppercase hexadecimal output
+[example]
+====
+"48879" with `base: 16, hex_capital: true` => "0xBE,EF"
+====
++
+WARNING: If you use separator characters in the range `a`-`f` (such as `decimal: "d"` or `fraction_group: "f"`), those separators will also be uppercased when `hex_capital: true`. Choose separators outside this range (e.g., `".", ",", " ", "_"`) if you need them to remain unchanged.
++
+.Separator uppercasing behavior
+[example]
+====
+"48879" with `base: 16, hex_capital: true, group: "g"` => "0xBEgEF" (g remains lowercase)
+
+"48879" with `base: 16, hex_capital: true, group: "f"` => "0xBEFEF" (f separator becomes F)
+====
+
+NOTE: When `base` is not 10, both the integer and fractional parts are converted to the specified base.
+The decimal separator is rendered as configured by the `decimal` option.
++
+NOTE: The fractional-part conversion treats the digits after the decimal point as a fractional value (for example, `"10.75"` is interpreted
+as decimal `0.75` for the fractional part) and converts that real value to the requested base, honoring the configured precision.
+
+===== Base conversion with other formatting options
+
+Base conversion works seamlessly with other formatting options such as `precision`, `digit_count`,
+`fraction_group`, `fraction_group_digits`, and `significant`.
+
+.Base conversion with precision
+[example]
+====
+Controls the maximum number of fractional digits in the converted base (pads with zeros when needed and truncates repeating expansions to the configured precision):
++
+"10.75" with `base: 2, precision: 4` => "0b10,10.1100" (fractional part padded to 4 digits in base 2)
+"0.5"   with `base: 16, precision: 6` => "0x0.800000" (fractional part converted to base 16 and padded to 6 digits)
+====
+
+.Base conversion with fraction grouping
+[example]
+====
+Groups fractional digits in the converted base:
++
+"10.75" with `base: 2, fraction_group_digits: 1, fraction_group: " ", group_digits: 10` => "0b1010.1 1"
+====
+
+.Base conversion with digit_count
+[example]
+====
+Limits total digits when using base conversion:
++
+"14236.39239" with `base: 10, digit_count: 6, group_digits: 3` => "14,236.4"
+"10.75"       with `base: 2, digit_count: 7, group_digits: 10` => "0b1010.110"
+"255.9"       with `base: 16, digit_count: 2, group_digits: 10` => "0x100" (fractional part omitted, integer rounded)
+====
+
+.Base conversion with significant digits
+[example]
+====
+Applies significant digit rounding with base conversion:
++
+"1234.56" with `base: 10, significant: 4` => "1,235"
+"1999"    with `base: 10, significant: 2` => "2,000"
+====
+
 `fraction_group`:: (`String` value)
 Delimiter to use between groups of fractional digits specified in
 `fraction_group_digits`. Accepts a character.
@@ -607,7 +728,7 @@ selected to be divisible by three to match the common metric prefixes.
 ====
 
 `e`:: (`String` value)
-Symbol to use for exponents in E notation (default value `E`). (used in the
+Symbol to use for exponents in E notation (default value `e`). (used in the
 mode: `e` only).
 +
 .Using the lowercase 'e' symbol as the exponent symbol
@@ -743,9 +864,8 @@ formatter.localized_number(
 
 Where,
 
-`<number>`:: (mandatory) The number to be formatted. Value should be a Numeric,
-i.e. Integer, Float, or BigDecimal. If not provided, an `ArgumentError` will be
-raised.
+`<number>`:: (mandatory) The number to be formatted, as a `String` containing the
+decimal representation of the value (for example, `"1234.56789"`).
 
 `locale: <locale-symbol>`:: (optional) The locale to be used for number formatting.
 Value is a symbol.
@@ -1117,7 +1237,7 @@ locales are listed in the link:/blog/2024-07-09-number-formatter[number formatte
 `options`:: (default: empty) a hash of options (`localizer_symbols`). The options
 are listed in the link:/blog/2024-07-09-number-formatter[number formatter blog post].
 
-`format_string`:: (default: `nil`, disabled) a string value (localize_number)
+`string_format`:: (default: `nil`, disabled) a string value (`localize_number`)
 
 `precision`:: (default: `nil`, disabled) an integer value.
 
@@ -1136,7 +1256,7 @@ are listed in the link:/blog/2024-07-09-number-formatter[number formatter blog p
 }
 
 > formatter = Plurimath::Formatter::Standard.new(locale: :hy, options: options, precision: 2)
-# format_string: <string value> if provided
+# string_format: <string value> if provided
 
 > Plurimath::Math.parse('2121221.3434', :latex).to_latex(formatter: formatter)
 # => '2,12,12,21;34'
@@ -1160,7 +1280,7 @@ The custom formatter is to be subclassed from `Plurimath::Formatter::Standard`.
 [source,ruby]
 ----
 class MyCustomFormatter < Plurimath::Formatter::Standard <1>
-  def initialize(locale:, precision:, options:, format_string:) <2>
+  def initialize(locale:, precision:, options:, string_format:) <2>
     super
   end
 end
@@ -1175,7 +1295,7 @@ The default options of the custom formatter are set using the
 [source,ruby]
 ----
 class MyCustomFormatter < Plurimath::Formatter::Standard
-  def initialize(locale:, precision:, options:, format_string:)
+  def initialize(locale:, precision:, options:, string_format:)
     super
   end
 

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

@@ -1,8 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "math"
 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

@@ -77,7 +77,7 @@ module Plurimath
     no_commands do
       def warn_and_exit(message)
         warn(message)
-        exit 1
+        abort
       end
     end
   end

data/lib/plurimath/errors/formatter/unsupported_base.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Plurimath
+  module Formatter
+    class UnsupportedBase < StandardError
+      def initialize(base, supported_bases)
+        @base = base
+        @supported = supported_bases.keys.map { |key| key.to_s.inspect }.join(", ")
+      end
+
+      def to_s
+        <<~MESSAGE
+          [plurimath] Unsupported base `#{@base}` for number formatting.
+          [plurimath] The formatter `:base` option must be one of: #{@supported}.
+        MESSAGE
+      end
+    end
+  end
+end

data/lib/plurimath/errors/invalid_type_error.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Plurimath
+  module Math
+    class InvalidTypeError < TypeError
+      def initialize(type = nil)
+        super(type ? formula_message(type) : parse_message)
+      end
+
+      def parse_message
+        "`type` must be one of: `#{Math::VALID_TYPES.keys.join('`, `')}`"
+      end
+
+      def formula_message(type)
+        "Invalid type provided: #{type}. Must be one of #{Formula::MATH_ZONE_TYPES.join(', ')}."
+      end
+    end
+  end
+end

data/lib/plurimath/errors/parse_error.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Plurimath
+  module Math
+    class ParseError < StandardError
+      def initialize(text, type)
+        @text = text
+        @type = type.to_sym
+        super(@type == :invalid_unitsml ? unitsml_message : parsing_message)
+      end
+
+      def parsing_message
+        <<~MESSAGE
+          [plurimath] Error: Failed to parse the following formula with type `#{@type}`.
+          [plurimath] Please first manually validate the formula.
+          #{generic_part}
+          ---- FORMULA BEGIN ----
+          #{@text}
+          ---- FORMULA END ----
+        MESSAGE
+      end
+
+      def unitsml_message
+        <<~MESSAGE
+          [plurimath] Invalid formula `#{@text}`.
+          [plurimath] The use of a variable as an exponent is not valid.
+          #{generic_part}
+        MESSAGE
+      end
+
+      def generic_part
+        <<~MESSAGE.rstrip
+          [plurimath] If this is a bug, please report the formula at our issue tracker at:
+          [plurimath] https://github.com/plurimath/plurimath/issues
+        MESSAGE
+      end
+    end
+  end
+end

data/lib/plurimath/errors.rb

@@ -0,0 +1 @@
+# frozen_string_literal: true

data/lib/plurimath/formatter/number_formatter.rb

@@ -3,17 +3,33 @@
 module Plurimath
   module Formatter
     class NumberFormatter
-      attr_reader :number, :data_reader, :prefix
+      attr_reader :number, :data_reader
 
+      DEFAULT_BASE = Numbers::Base::DEFAULT_BASE
+      HEX_ALPHABETS = "abcdef".freeze
       STRING_SYMBOLS = {
-        dot: ".".freeze,
-        f: "F".freeze,
+        dot: ".",
+        f: "F",
+      }.freeze
+      DEFAULT_BASE_PREFIXES = {
+        2 => "0b",
+        8 => "0o",
+        10 => "",
+        16 => "0x",
       }.freeze
 
       def initialize(number, data_reader = {})
         @number = number
         @data_reader = data_reader
-        @prefix = "-" if number.negative?
+        @base = data_reader[:base] || DEFAULT_BASE
+        raise UnsupportedBase.new(@base, DEFAULT_BASE_PREFIXES) unless DEFAULT_BASE_PREFIXES.key?(@base)
+
+        # Handle base_prefix: if explicitly provided (even as nil), use it; otherwise use default
+        @base_prefix = if data_reader.key?(:base_prefix)
+                         data_reader[:base_prefix].to_s
+                       else
+                         DEFAULT_BASE_PREFIXES[@base]
+                       end
       end
 
       def format(precision: nil)
@@ -22,16 +38,37 @@ module Plurimath
         # FIX FOR:
         #   NotImplementedError: String#<< not supported. Mutable String methods are not supported in Opal.
         result = []
-        result << integer_format.apply(int, data_reader)
-        result << fraction_format.apply(frac, data_reader, int) if frac
+        result << integer_format.apply(int)
+        result << fraction_format.apply(frac, result, integer_format) # use formatted int for correct fraction formatting
         result = result.join
         result = signif_format.apply(result, integer_format, fraction_format)
-        result = "+#{result}" if number.positive? && data_reader[:number_sign].to_s == "plus"
-        "#{prefix}#{result}"
+        result = result.tr(HEX_ALPHABETS, HEX_ALPHABETS.upcase) if upcase_hex?
+        result = pre_post_fixed(result) unless base_default?
+        "#{prefix_symbol}#{result}"
       end
 
       private
 
+      def upcase_hex?
+        @base == 16 && data_reader[:hex_capital]
+      end
+
+      def prefix_symbol
+        if number.negative?
+          "-"
+        elsif data_reader[:number_sign]&.to_sym == :plus
+          "+"
+        end
+      end
+
+      def pre_post_fixed(result)
+        if data_reader.key?(:base_postfix)
+          "#{result}#{data_reader[:base_postfix]}"
+        else
+          "#{@base_prefix}#{result}"
+        end
+      end
+
       def partition_tokens(number)
         int, fraction = parse_number(number)
         [
@@ -53,10 +90,11 @@ module Plurimath
       def parse_number(number, options = data_reader)
         precision = options[:precision] || precision_from(number)
 
+        abs = round_to(number, precision).abs
         num = if precision == 0
-                round_to(number, precision).abs.fix.to_s(STRING_SYMBOLS[:f])
+                abs.fix.to_s(STRING_SYMBOLS[:f])
               else
-                round_to(number, precision).abs.round(precision).to_s(STRING_SYMBOLS[:f])
+                abs.round(precision).to_s(STRING_SYMBOLS[:f])
               end
         num.split(STRING_SYMBOLS[:dot])
       end
@@ -65,6 +103,10 @@ module Plurimath
         factor = BigDecimal(10).power(precision)
         (number * factor).fix / factor
       end
+
+      def base_default?
+        @base == DEFAULT_BASE
+      end
     end
   end
 end

data/lib/plurimath/formatter/numbers/base.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Plurimath
+  module Formatter
+    module Numbers
+      class Base
+        HEX_ALPHANUMERIC = %w[0 1 2 3 4 5 6 7 8 9 a b c d e f].freeze
+        DEFAULT_BASE = 10
+        DIGIT_VALUE = HEX_ALPHANUMERIC.each_with_index.to_h
+
+        attr_accessor :base, :symbols
+
+        def initialize(symbols = {})
+          @symbols = symbols
+          @base = symbols[:base] || DEFAULT_BASE
+        end
+
+        protected
+
+        def threshold
+          @threshold ||= base.div(2)
+        end
+
+        def base_default?
+          base == DEFAULT_BASE
+        end
+
+        def next_mapping_char(char)
+          current_idx = DIGIT_VALUE[char]
+          return nil unless current_idx
+
+          HEX_ALPHANUMERIC[current_idx + 1]
+        end
+      end
+    end
+  end
+end