plurimath 0.5.0 → 0.7.0

data/lib/plurimath/xml_engine/oga.rb

@@ -0,0 +1,246 @@
+# frozen_string_literal: true
+
+require "plurimath/xml_engine"
+require "corelib/array/pack" if RUBY_ENGINE == "opal"
+require "oga"
+
+module Plurimath
+  module XMLEngine
+    class Oga
+      class << self
+        def new_element(name)
+          data = ::Oga::XML::Element.new(name: name)
+          Node.new(data)
+        end
+
+        def dump(data, indent: nil)
+          Dumper.new(data, indent: indent).dump.out
+        end
+
+        def load(data)
+          data = ::Oga::XML::Parser.new(data, html: true).parse
+          if data.xml_declaration
+            Document.new(data)
+          else
+            Document.new(data).nodes.first
+          end
+        end
+
+        def is_xml_comment?(node)
+          node = node.unwrap if node.respond_to? :unwrap
+          node.is_a?(Comment)
+        end
+      end
+
+      # Create API compatible with Ox, per Plurimath usage
+      class Wrapper
+        def initialize(value)
+          @wrapped = value
+        end
+
+        def unwrap
+          @wrapped
+        end
+
+        def ==(other)
+          self.class == other.class &&
+            @wrapped.inspect == other.unwrap.inspect
+        end
+      end
+
+      class Node < Wrapper
+        # Ox removes text nodes that are whitespace-only.
+        # There exists a weird edge case on which Plurimath depends:
+        # <mi> <!-- xxx --> &#x3C0;<!--GREEK SMALL LETTER PI--> </mi>
+        # If the last text node of an element that does not contain other
+        # elements is a whitespace, it preserves it. The first one can be
+        # safely removed.
+        def nodes
+          children = @wrapped.children
+          length = children.length
+          preserve_last = true
+          children.map.with_index do |i,idx|
+            if preserve_last && idx == length-1 && i.is_a?(::Oga::XML::Text)
+              i.text
+            elsif i.is_a? ::Oga::XML::Text
+              remove_indentation(i)
+            elsif i.is_a? ::Oga::XML::Comment
+              Node.new(i)
+            else
+              preserve_last = false
+              Node.new(i)
+            end
+          end.compact
+        end
+
+        def [](attr)
+          attr = attr.to_s
+
+          @wrapped.attributes.each do |e|
+            return e.value if [e.name, e.name.split(":").last].include? attr
+          end
+
+          nil
+        end
+
+        def []=(attr, value)
+          # Here we tap into the internal representation due to some likely
+          # bug in Oga
+          attr = ::Oga::XML::Attribute.new(name: attr.to_s)
+          attr.element = @wrapped
+          attr.instance_variable_set(:@value, value.to_s)
+          attr.instance_variable_set(:@decoded, true)
+          @wrapped.attributes << attr
+        end
+
+        def <<(other)
+          other = other.unwrap if other.respond_to? :unwrap
+
+          case other
+          when String
+            text = other
+            # Here we tap into the internal representation due to some likely
+            # bug in Oga
+            other = ::Oga::XML::Text.new
+            other.instance_variable_set(:@from_plurimath, true)
+            other.instance_variable_set(:@text, text)
+            other.instance_variable_set(:@decoded, true)
+          end
+
+          @wrapped.children << other.dup
+          self
+        end
+
+        def attributes
+          @wrapped.attributes.to_h do |e|
+            [e.name.split(":").last, e.value]
+          end
+        end
+
+        def locate(xpath)
+          @wrapped.xpath(xpath).map do |i|
+            case i
+            when ::Oga::XML::Text
+              i.text
+            when ::Oga::XML::Attribute
+              i.value
+            else
+              Node.new(i)
+            end
+          end
+        end
+
+        def name
+          @wrapped.name
+        end
+
+        def name=(new_name)
+          @wrapped.name = new_name
+        end
+
+        private
+
+        def remove_indentation(text)
+          from_us = text.instance_variable_get(:@from_plurimath)
+          !from_us && text.text.strip == "" ? nil : text.text
+        end
+      end
+
+      class Document < Node
+      end
+
+      Comment = ::Oga::XML::Comment
+
+      # Dump the tree just as if we were Ox. This is a limited implementation.
+      class Dumper
+        def initialize(tree, indent: nil)
+          @tree = tree
+          @indent = indent
+          @depth = 0
+          @out = ""
+        end
+
+        def dump(node = @tree)
+          case node
+          when Node
+            nodes = node.nodes
+            if nodes.length == 0
+              line_break
+              @out += "<#{node.unwrap.name}#{dump_attrs(node)}/>"
+            else
+              line_break
+              @out += "<#{node.unwrap.name}#{dump_attrs(node)}>"
+              @depth += 1
+              nodes.each { |i| dump(i) }
+              @depth -= 1
+              line_break unless nodes.last.is_a?(::String)
+              @out += "</#{node.unwrap.name}>"
+            end
+          when ::String
+            @out += entities(node)
+          end
+
+          line_break if node.object_id == @tree.object_id
+
+          self
+        end
+
+        attr_reader :out
+
+        ORD_AMP="&".ord
+        ORD_LT="<".ord
+        ORD_GT=">".ord
+        ORD_APOS="'".ord
+        ORD_QUOT='"'.ord
+        ORD_NEWLINE="\n".ord
+        ORD_CARRIAGERETURN="\r".ord
+
+        def self.entities(text,attr=false)
+          text.to_s.chars.map(&:ord).map do |i|
+            if i == ORD_AMP
+              "&amp;"
+            elsif i == ORD_LT
+              "&lt;"
+            elsif i == ORD_GT
+              "&gt;"
+            elsif i == ORD_QUOT && attr
+              "&quot;"
+            elsif i == ORD_NEWLINE || i == ORD_CARRIAGERETURN
+              i.chr("utf-8")
+            elsif i < 0x20
+              "&#x#{i.to_s(16).rjust(4, "0")};"
+            else
+              i.chr("utf-8")
+            end
+          end.join
+        end
+
+        private
+
+        def dump_attrs(node)
+          node.unwrap.attributes.map do |i|
+            # Currently, this is not part of the contract. But in the future
+            # it may be needed to also handle namespaces:
+            #
+            # if i.namespace
+            #   %{ #{i.namespace.name}:#{i.name}="#{attr_entities i.value}"}
+            %{ #{i.name}="#{attr_entities i.value}"}
+          end.join
+        end
+
+        def entities(text)
+          self.class.entities(text)
+        end
+
+        def attr_entities(text)
+          self.class.entities(text, true)
+        end
+
+        def line_break
+          @out += "\n"
+          @out += " " * (@indent * @depth) if @indent
+        end
+      end
+    end
+  end
+end

data/lib/plurimath/xml_engine/ox.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "plurimath/xml_engine"
+require "ox"
+Ox.default_options = { encoding: "UTF-8" }
+
+module Plurimath
+  module XMLEngine
+    class Ox
+      class << self
+        def new_element(name)
+          ::Ox::Element.new(name)
+        end
+
+        def dump(data, **options)
+          ::Ox.dump(data, **options)
+        end
+
+        def load(data)
+          ::Ox.load(data, strip_namespace: true)
+        end
+
+        def is_xml_comment?(node)
+          node.is_a?(::Ox::Comment)
+        end
+      end
+    end
+  end
+end

data/lib/plurimath/xml_engine.rb

@@ -0,0 +1,6 @@
+module Plurimath
+  singleton_class.attr_accessor :xml_engine
+
+  module XMLEngine
+  end
+end

data/lib/plurimath.rb

@@ -1,4 +1,14 @@
-# frozen_string_literal: true
 
 require_relative "plurimath/version"
-require_relative "plurimath/math"
+
+# Select an XML engine
+if RUBY_ENGINE == 'opal'
+  require "plurimath/setup/oga"
+  require "plurimath/setup/opal"
+elsif ENV['PLURIMATH_OGA']
+  require "plurimath/setup/oga"
+else
+  require "plurimath/setup/ox"
+end
+
+require "plurimath/math"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plurimath
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-09-08 00:00:00.000000000 Z
+date: 2023-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -49,6 +49,8 @@ files:
 - ".github/workflows/release.yml"
 - ".gitignore"
 - ".hound.yml"
+- ".rspec"
+- ".rspec-opal"
 - ".rubocop.yml"
 - AsciiMath-Supported-Data.adoc
 - CODE_OF_CONDUCT.md
@@ -133,6 +135,7 @@ files:
 - lib/plurimath/math/function/liminf.rb
 - lib/plurimath/math/function/limits.rb
 - lib/plurimath/math/function/limsup.rb
+- lib/plurimath/math/function/linebreak.rb
 - lib/plurimath/math/function/ln.rb
 - lib/plurimath/math/function/log.rb
 - lib/plurimath/math/function/longdiv.rb
@@ -146,6 +149,7 @@ files:
 - lib/plurimath/math/function/msgroup.rb
 - lib/plurimath/math/function/msline.rb
 - lib/plurimath/math/function/multiscript.rb
+- lib/plurimath/math/function/nary.rb
 - lib/plurimath/math/function/norm.rb
 - lib/plurimath/math/function/obrace.rb
 - lib/plurimath/math/function/oint.rb
@@ -159,7 +163,6 @@ files:
 - lib/plurimath/math/function/root.rb
 - lib/plurimath/math/function/rule.rb
 - lib/plurimath/math/function/scarries.rb
-- lib/plurimath/math/function/scarry.rb
 - lib/plurimath/math/function/sec.rb
 - lib/plurimath/math/function/sech.rb
 - lib/plurimath/math/function/semantics.rb
@@ -202,10 +205,16 @@ files:
 - lib/plurimath/omml.rb
 - lib/plurimath/omml/parser.rb
 - lib/plurimath/omml/transform.rb
+- lib/plurimath/setup/oga.rb
+- lib/plurimath/setup/opal.rb.erb
+- lib/plurimath/setup/ox.rb
 - lib/plurimath/unicode.rb
 - lib/plurimath/unitsml.rb
 - lib/plurimath/utility.rb
 - lib/plurimath/version.rb
+- lib/plurimath/xml_engine.rb
+- lib/plurimath/xml_engine/oga.rb
+- lib/plurimath/xml_engine/ox.rb
 - plurimath.gemspec
 homepage: https://github.com/plurimath/plurimath
 licenses:

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

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "unary_function"
-
-module Plurimath
-  module Math
-    module Function
-      class Scarry < UnaryFunction
-      end
-    end
-  end
-end