html2asciimath 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf33dc42507a6cc5e93f188c5350c1917f756b4650ac57b1b1ea35c01d15ffc6
+  data.tar.gz: 51b88bae00fc7ec60138969f69dab9931dfb188acebee4f644933934572d02b6
+SHA512:
+  metadata.gz: 12b27fae00e9f1cfddecc0c7002396c61ecc0f673653fcae0eb4152faeda091ceb57be153fa992ca6bf7ed8de9ddaadba81c61cba4047f12372f9e54de1b4b0a
+  data.tar.gz: 2d25c46e21b49ee2450c61c50b62769ffbc47c8edc3688d6ac169c6b9c785f026f956c94a15ca2ad5390be6d8441368dc4d9116020132978e789bcae97b0a489

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Sebastian Skałacki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# HTML2AsciiMath
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/html2asciimath`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'html2asciimath'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install html2asciimath
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/html2asciimath.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/html2asciimath.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/html2asciimath/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "html2asciimath"
+  spec.version       = HTML2AsciiMath::VERSION
+  spec.authors       = ["Ribose"]
+  spec.email         = ["open.source@ribose.com"]
+  spec.license       = "MIT"
+
+  spec.summary       = "Converts simple math formulae written in pure HTML " +
+    "to AsciiMath"
+
+  spec.homepage      = "https://www.plurimath.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/plurimath/html2asciimath"
+
+  all_files_in_git = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0")
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files = all_files_in_git.select do |f|
+    f.start_with?("exe/", "lib/", "README.", "LICENSE.") ||
+      f.end_with?(".gemspec")
+  end
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.6.0")
+
+  spec.add_runtime_dependency "nokogiri"
+  spec.add_runtime_dependency "unicode_scanner", "~> 1.0"
+end

data/lib/html2asciimath/ast.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# (c) 2021 Ribose Inc.
+
+module HTML2AsciiMath
+  # Abstract syntax tree implemented as array of arrays and other objects.
+  class AST < Array
+    module Refinements
+      refine Object do
+        def to_asciimath(**)
+          itself
+        end
+      end
+    end
+
+    using Refinements
+
+    def to_asciimath(child: false)
+      result = map { |item| item.to_asciimath(child: true) }.join(" ")
+      child && size > 1 ? "( #{result} )" : result
+    end
+  end
+end

data/lib/html2asciimath/converter.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# (c) 2021 Ribose Inc.
+
+module HTML2AsciiMath
+  # This class is responsible for converting HTML math expressions to AsciiMath.
+  #
+  # It runs two small parsers: first HTMLparser deals with HTML syntax, and then
+  # HTMLTextParser processes textual content found between HTML elements.
+  # Thanks to this two-phase processing, HTMLTextParser receives input which is
+  # already decoded (i.e. without any HTML entities), which in turn allows to
+  # keep its grammar simple.
+  #
+  # @example
+  #   html_string = "<i>x</i>+<i>y</i>"
+  #   Converter.new(html_string).transform # => "x + y"
+  class Converter
+    attr_reader :ast, :ast_stack, :html_parser
+    attr_accessor :variable_mode
+
+    def initialize(str)
+      @html_parser = HTMLParser.new(str, self)
+    end
+
+    def transform
+      to_asciimath
+    end
+
+    def open_group
+      ast_stack.push AST.new
+    end
+
+    def close_group
+      push ast_stack.pop
+    end
+
+    def push(*objs)
+      ast_stack.last.push(*objs)
+    end
+
+    def to_asciimath
+      parse
+      ast.to_asciimath
+    end
+
+    def parse
+      return if @ast
+
+      @ast = AST.new
+      @ast_stack = [@ast]
+      @variable_mode = false
+      html_parser.parse
+    end
+  end
+end

data/lib/html2asciimath/detector.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+# (c) 2021 Ribose Inc.
+
+require "unicode_scanner"
+
+module HTML2AsciiMath
+  class Detector < UnicodeScanner
+    def initialize(str)
+      super(str.dup)
+    end
+
+    def replace(&block)
+      scan_for_math do |math_start, math_end, score|
+        range = (math_start...math_end)
+        source_math = string[range]
+        target_math = yield source_math
+        string[range] = target_math
+        self.pos += (target_math.size - source_math.size)
+      end
+      string
+    end
+
+    private
+
+    def scan_for_math
+      fast_forward_inline_whitespace
+
+      until eos? do
+        assess_candidate
+        yield [@start, @end, @score] if good_score?
+        fast_forward_to_next_candidate
+      end
+    end
+
+    def assess_candidate
+      init_candidate
+      nil while match_candidate_fragment
+    end
+
+    def match_candidate_fragment
+      fast_forward_inline_whitespace
+
+      case
+      when scan(FRAGMENT_WORD_AND_BRACKETS)
+        score_sure
+      when scan(FRAGMENT_SUB_OR_SUP)
+        score_almost_sure
+      when scan(FRAGMENT_B_OR_I)
+        single_char_or_entity?(self[:inner]) ? score_sure : score_maybe
+      when scan(FRAGMENT_OTHER)
+        score_maybe
+      end
+
+      matched?
+    end
+
+    def fast_forward_inline_whitespace
+      skip(/\p{Zs}*/)
+    end
+
+    def fast_forward_to_next_candidate
+      skip(/(?>\p{L}+|.)[[:space:]]*/m)
+    end
+
+    def init_candidate
+      @score = 0
+      @start = pos
+    end
+
+    def score_sure
+      @score += GOOD_SCORE_THRESHOLD
+      @end = pos
+    end
+
+    def score_almost_sure
+      @score += GOOD_SCORE_THRESHOLD - 1
+      @end = pos
+    end
+
+    def score_maybe
+      @score += 1
+      @end = pos
+    end
+
+    def good_score?
+      @score >= GOOD_SCORE_THRESHOLD
+    end
+
+    def single_char_or_entity?(str)
+      str.match? /\A(\S|#{RX_ENTITY})\Z/o
+    end
+
+    # HTML entity
+    RX_ENTITY = /&#?\w{,8};/
+
+    # Word immediately followed with brackets.
+    FRAGMENT_WORD_AND_BRACKETS = %r{
+      (?> \p{L}+)
+      (?: \( .*? \) | \[ .*? \] | \{ .*? \} )
+    }x
+
+    FRAGMENT_SUB_OR_SUP = %r{
+      \< sub \> .*? \< / sub \> |
+      \< sup \> .*? \< / sup \>
+    }xi
+
+    FRAGMENT_B_OR_I = %r{
+      (?<b_or_i>
+        (?> \< b \> ) (?: \g<b_or_i> | (?<inner> [^<>\p{Z}\p{C}]*?)) \< / b \>
+        |
+        (?> \< i \> ) (?: \g<b_or_i> | (?<inner> [^<>\p{Z}\p{C}]*?)) \< / i \>
+      )
+    }xi
+
+    FRAGMENT_OTHER = %r{
+      # numbers
+      \d+[,.]\d+ |
+      \d+ |
+      # entities
+      #{RX_ENTITY} |
+      # math symbols with exception of angle brackets which are part of HTML
+      # syntax
+      (?![<>]) \p{Sm} |
+      # some ASCII characters used as operators which do not belong to Sm
+      [-/()]
+    }xo
+
+    GOOD_SCORE_THRESHOLD = 11
+  end
+end

data/lib/html2asciimath/html_parser.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+# (c) 2021 Ribose Inc.
+
+require "forwardable"
+require "nokogiri"
+
+module HTML2AsciiMath
+  class HTMLParser < Nokogiri::HTML::SAX::Parser
+    extend Forwardable
+
+    attr_reader :converter, :string
+
+    def_delegators :@converter, :push, :open_group, :close_group, :variable_mode=
+
+    def initialize(str, converter)
+      super(SAXCallbacks.new(self))
+      @string = str
+      @converter = converter
+    end
+
+    def parse
+      super(string)
+    end
+
+    private
+
+    def on_i(opening)
+      self.variable_mode = opening
+    end
+
+    def on_sub(opening)
+      if opening
+        push "_"
+        open_group
+      else
+        close_group
+      end
+    end
+
+    def on_sup(opening)
+      if opening
+        push "^"
+        open_group
+      else
+        close_group
+      end
+    end
+
+    # Associates element names with element handlers.
+    #
+    # Example: <code>{ "some_tag_name" => :on_some_tag_name }</code>
+    ELEMENT_HANDLERS = (instance_methods + private_instance_methods)
+      .grep(/\Aon_/)
+      .map { |h| [h.to_s[3..].freeze, h] }
+      .to_h
+      .freeze
+
+    class SAXCallbacks < Nokogiri::XML::SAX::Document
+      attr_reader :parser
+
+      def initialize(parser)
+        @parser = parser
+      end
+
+      def characters(text)
+        HTMLTextParser.new(text, parser.converter).parse
+        true
+      end
+
+      def start_element(elem_name, _attrs = [])
+        # TODO maintain some elements stack
+        handler = ELEMENT_HANDLERS[elem_name]
+        handler && parser.send(handler, true)
+      end
+
+      def end_element(elem_name)
+        # TODO auto-close elements which are above this one in elements stack
+        handler = ELEMENT_HANDLERS[elem_name]
+        handler && parser.send(handler, false)
+      end
+    end
+  end
+end

data/lib/html2asciimath/html_text_parser.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+# (c) 2021 Ribose Inc.
+
+require "forwardable"
+require "unicode_scanner"
+
+module HTML2AsciiMath
+  class HTMLTextParser < UnicodeScanner
+    extend Forwardable
+
+    attr_reader :converter
+
+    def_delegators :@converter, :push, :open_group, :close_group, :variable_mode
+
+    def initialize(str, converter)
+      super(str)
+      @converter = converter
+    end
+
+    def parse # rubocop:disable Metrics/CyclomaticComplexity
+      repeat_until_error_or_eos do
+        skip_ws or scan_number or scan_text or scan_symbol or scan_error
+      end
+    end
+
+    private
+
+    def repeat_until_error_or_eos
+      catch(:error) do
+        yield until eos?
+      end
+    end
+
+    def scan_error
+      throw :error
+    end
+
+    def skip_ws
+      skip(/\s+/)
+    end
+
+    def scan_number
+      number = scan(/\d+(?:\.\d+)?/) or return
+      push(number)
+      true
+    end
+
+    def scan_text
+      text = scan(/\p{Letter}+/) or return
+      # TODO distinguish variables (which should be left unquoted), regular
+      # text (which should be quoted), and textual operators (e.g. sum).
+      push(variable_mode ? text : %["#{text}"])
+      true
+    end
+
+    def scan_symbol
+      # Any character that does not belong to Control category.
+      str = scan(/\p{^C}/) or return
+      symb = SYMBOLS[str] || str
+      push(symb)
+      true
+    end
+
+    # Left side is a HTML math symbol recognized by scanner.  Right side is its
+    # AsciiMath equivalent or nil when no translation is needed.
+    # @todo Perhaps brackets should be handled separately.
+    SYMBOLS = {
+      "-" => nil,
+      "+" => nil,
+      "×" => "xx",
+      "/" => "//",
+      "÷" => "-:",
+      "\u22c5" => "*", # (dot operator)
+      "=" => nil,
+      "≤" => "<=",
+      "≥" => ">=",
+      "≠" => "!=",
+      "¬" => "not",
+      "∧" => "and",
+      "∨" => "or",
+      "(" => nil,
+      ")" => nil,
+      "%" => nil,
+      "!" => nil,
+      "∃" => "EE",
+      "∀" => "AA",
+      "∞" => "oo"
+    }
+    .freeze
+
+    # A regular expression which matches every symbol defined in +SYMBOLS+ hash.
+    SYMBOLS_RX =
+      Regexp.new(SYMBOLS.keys.map { |k| Regexp.escape(k) }.join("|")).freeze
+  end
+end

data/lib/html2asciimath/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# (c) 2021 Ribose Inc.
+
+module HTML2AsciiMath
+  VERSION = "0.1.0"
+end

data/lib/html2asciimath.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+# (c) 2021 Ribose Inc.
+
+require_relative "html2asciimath/version"
+require_relative "html2asciimath/ast"
+require_relative "html2asciimath/converter"
+require_relative "html2asciimath/detector"
+require_relative "html2asciimath/html_parser"
+require_relative "html2asciimath/html_text_parser"
+
+module HTML2AsciiMath
+  class Error < StandardError; end
+
+  def convert(input)
+    str = input&.strip
+    return str if str.nil? || str.empty?
+    Converter.new(str).transform
+  end
+
+  def html_replace(input, &block)
+    Detector.new(input).replace(&block)
+  end
+
+  module_function :convert, :html_replace
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: html2asciimath
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ribose
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: unicode_scanner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description:
+email:
+- open.source@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- html2asciimath.gemspec
+- lib/html2asciimath.rb
+- lib/html2asciimath/ast.rb
+- lib/html2asciimath/converter.rb
+- lib/html2asciimath/detector.rb
+- lib/html2asciimath/html_parser.rb
+- lib/html2asciimath/html_text_parser.rb
+- lib/html2asciimath/version.rb
+homepage: https://www.plurimath.org/
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.plurimath.org/
+  source_code_uri: https://github.com/plurimath/html2asciimath
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: Converts simple math formulae written in pure HTML to AsciiMath
+test_files: []