asciidoctor-katex 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f22339f6723c08a19cc767595dcc38721506b4a36a637181213c4a123a37908
-  data.tar.gz: 934ea7f37bb904c1e5a437f5e576f673bd68e69a1d9cdac581683aea98b7c270
+  metadata.gz: 563feb091e023db762437c7dd7375a8238079780de324428e250da7844bb6b2f
+  data.tar.gz: 1567edd17da494abccc2a87832ef032ff9a63e35c9a07de4f53bd4a7584dde01
 SHA512:
-  metadata.gz: d433256d16093e1b1c723765deab5e87c242bf469916a8202073dff267152c4332a77fccf89700b13c68a12bf132cc7a02812cc468df7d74ba3ac5c8c62063c9
-  data.tar.gz: 7ff93fd5d24e49a29b414fa64ececcbc455f9f315959e04c0ddf1d1c0910e70727dca9580238fb0d2c1bb8eea63a1ee7035b22c3834880863f56040c66136e27
+  metadata.gz: 638dca239825461b452b6fabadfc2d80685daa02031aec634d5a80198bc9acbdfda4a357df188987f4b3c5ae4aa0425c75d868e90410c820ea834bc9e0eeb891
+  data.tar.gz: 3044648be03e130d47ae1deb4bc2fd402dab87334def8e11fe83714bbd5307ac2a8155f541b6ae796e7b2cf5e57b975075ed4d6079efd7ef0d4a8f678e17cf71

data/lib/asciidoctor/katex.rb

@@ -2,6 +2,7 @@
 require 'asciidoctor' unless RUBY_PLATFORM == 'opal'
 require 'asciidoctor/extensions' unless RUBY_PLATFORM == 'opal'
 require 'asciidoctor/katex/version'
+require 'asciidoctor/katex/errors'
 require 'asciidoctor/katex/treeprocessor'
 
 unless RUBY_PLATFORM == 'opal'

data/lib/asciidoctor/katex/errors.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'asciidoctor/katex/version'
+
+module Asciidoctor::Katex
+
+  # Exception raised when KaTeX throw any error except `ParseError`.
+  class KatexError < ::RuntimeError
+    attr_reader :expression
+
+    # @param msg [#to_s] the message.
+    # @param expression [String] the LaTeX expression that caused the error.
+    def initialize(msg, expression)
+      @expression = expression
+      super(msg.to_s)
+    end
+  end
+
+  # Exception raised when KaTeX throw `ParseError` which is the main error
+  # thrown by KaTeX functions when something has gone wrong.
+  class ParseError < KatexError; end
+end

data/lib/asciidoctor/katex/opal_katex_adapter.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+require 'asciidoctor/katex/version'
+require 'asciidoctor/katex/errors'
+require 'asciidoctor/katex/utils'
+
+module Asciidoctor::Katex
+  # Adapter for the KaTeX library for Opal/JS environment.
+  class OpalKatexAdapter
+    include Utils
+
+    # @param default_options [Hash] the default options for the KaTeX renderer.
+    # @param katex_object the katex object to use under Opal (defaults to
+    #   global variable `katex`).
+    def initialize(default_options = {}, katex_object = nil)
+      @default_options = hash_camelize(default_options)
+      @katex_object = katex_object || `katex`
+    end
+
+    # Renders the given math expression to HTML using KaTeX.
+    #
+    # @param math [String] the math (LaTeX) expression.
+    # @param opts [Hash] options for `katex.renderToString`.
+    #   Keys in under_score notation will be converted to camelCase.
+    #   See <https://github.com/Khan/KaTeX#rendering-options>.
+    # @return [String] a rendered HTML fragment.
+    def render(math, opts = {})
+      opts = @default_options.merge(hash_camelize(opts))
+
+      begin
+        `#{@katex_object}.renderToString(#{math}, #{opts}.$$smap)`
+      rescue ::JS::Error => err
+        # "#{err}" is really needed for Opal/JS, #to_s returns a different string.
+        # rubocop:disable UnneededInterpolation
+        raise ParseError.new(err, math) if "#{err}".start_with?('ParseError:')
+        raise KatexError.new(err, math)
+      end
+    end
+
+    alias call render
+  end
+
+  # The default KaTeX adapter.
+  KatexAdapter = OpalKatexAdapter unless defined? KatexAdapter
+end

data/lib/asciidoctor/katex/ruby_katex_adapter.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+require 'asciidoctor/katex/version'
+require 'asciidoctor/katex/errors'
+require 'asciidoctor/katex/utils'
+require 'katex'
+
+module Asciidoctor::Katex
+  # Adapter for the KaTeX library for Ruby environment.
+  class RubyKatexAdapter
+    include Utils
+
+    # @param default_options [Hash] the default options for the KaTeX renderer.
+    def initialize(default_options = {})
+      @default_options = hash_camelize(default_options)
+    end
+
+    # Renders the given math expression to HTML using KaTeX.
+    #
+    # @param math [String] the math (LaTeX) expression.
+    # @param opts [Hash] options for `katex.renderToString`.
+    #   Keys in under_score notation will be converted to camelCase.
+    #   See <https://github.com/Khan/KaTeX#rendering-options>.
+    # @return [String] a rendered HTML fragment.
+    def render(math, opts = {})
+      opts = @default_options.merge(hash_camelize(opts))
+
+      opts[:throw_on_error] = opts[:throwOnError]
+      opts[:error_color] = opts[:errorColor] || '#cc0000'
+
+      begin
+        ::Katex.render(math, opts)
+      rescue ::ExecJS::ProgramError => err
+        raise ParseError.new(err, math) if err.to_s.start_with?('ParseError:')
+        raise KatexError.new(err, math)
+      end
+    end
+
+    alias call render
+  end
+
+  # The default KaTeX adapter.
+  KatexAdapter = RubyKatexAdapter unless defined? KatexAdapter
+end

data/lib/asciidoctor/katex/stem_converter_decorator.rb

@@ -43,9 +43,8 @@ module Asciidoctor::Katex
       isblock = node.block?
 
       output.sub(isblock ? @block_re : @inline_re) do
-        @math_renderer.call(::Regexp.last_match[1].strip,
-                            display_mode: isblock,
-                            throw_on_error: @throw_on_error)
+        math = decode_html_entities(::Regexp.last_match[1].strip)
+        @math_renderer.call(math, display_mode: isblock, throw_on_error: @throw_on_error)
       end
     end
 
@@ -68,7 +67,23 @@ module Asciidoctor::Katex
     # @return [Regexp]
     def regexp_from_delimiters(delimiters)
       open, close = delimiters.map { |s| ::Regexp.escape(s) }
-      /#{open}(.+)#{close}/m
+
+      # XXX: Opal 0.11.x does not properly escape interpolated regexps and
+      #   Regexp.new does not work at all. Thus we have to escape \s\S in
+      #   advance when running on Opal and this faulty behaviour is detected.
+      if ::RUBY_PLATFORM == 'opal' && /#{''}\\s/ == /\s/
+        /#{open}([\\s\\S]+)#{close}/m
+      else
+        /#{open}([\s\S]+)#{close}/m
+      end
+    end
+
+    # @param str [String]
+    # @return [String]
+    def decode_html_entities(str)
+      str.gsub('&lt;', '<')
+        .gsub('&gt;', '>')
+        .gsub('&amp;', '&')
     end
   end
 end

data/lib/asciidoctor/katex/treeprocessor.rb

@@ -2,25 +2,30 @@
 require 'asciidoctor' unless RUBY_PLATFORM == 'opal'
 require 'asciidoctor/extensions' unless RUBY_PLATFORM == 'opal'
 require 'asciidoctor/katex/version'
-require 'asciidoctor/katex/katex_adapter'
 require 'asciidoctor/katex/stem_converter_decorator'
 
+if RUBY_PLATFORM == 'opal'
+  require 'asciidoctor/katex/opal_katex_adapter'
+else
+  require 'asciidoctor/katex/ruby_katex_adapter'
+end
+
 module Asciidoctor::Katex
   # Asciidoctor processor that renders delimited latexmath expressions using
   # the KaTeX library.
   class Treeprocessor < ::Asciidoctor::Extensions::Treeprocessor
 
-    # @param katex_renderer [#call] callable that accepts a math expression
+    # @param katex_options [Hash] default options for the KaTeX renderer.
+    #   This parameter has no effect when *katex_renderer* is provided.
+    # @param katex_renderer [#call, nil] callable that accepts a math expression
     #   [String] and options [Hash], and returns a rendered expression [String].
-    #   Default is an instance of KatexAdapter.
+    #   Defaults to {KatexAdapter} initialized with the *katex_options*.
     # @param require_stem_attr [Boolean] `true` to skip when `stem` attribute
     #   is not declared, `false` to process anyway.
-    def initialize(katex_renderer: KatexAdapter.new,
-                   require_stem_attr: true,
-                   **)
-      super
-      @katex_renderer = katex_renderer
+    def initialize(katex_options: {}, katex_renderer: nil, require_stem_attr: true, **)
+      @katex_renderer = katex_renderer || KatexAdapter.new(katex_options)
       @require_stem_attr = require_stem_attr
+      super
     end
 
     # @param document [Asciidoctor::Document] the document to process.

data/lib/asciidoctor/katex/utils.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'asciidoctor/katex/version'
+
+module Asciidoctor::Katex
+  # @private
+  module Utils
+    module_function
+
+    # @param hash [Hash] the hash to transform.
+    # @return [Hash] a copy of the *hash* with under_score keys transformed to camelCase.
+    def hash_camelize(hash)
+      hash.map { |key, val|
+        key = key.to_s.gsub(/_\w/) { |s| s[1].upcase }.to_sym
+        [key, val]
+      }.to_h
+    end
+  end
+end

data/lib/asciidoctor/katex/version.rb

@@ -3,6 +3,6 @@
 module Asciidoctor
   module Katex
     # Version of the asciidoctor-katex gem.
-    VERSION = '0.1.2'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-katex
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Jakub Jirutka
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-30 00:00:00.000000000 Z
+date: 2018-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor
@@ -147,9 +147,12 @@ files:
 - asciidoctor-katex.gemspec
 - lib/asciidoctor-katex.rb
 - lib/asciidoctor/katex.rb
-- lib/asciidoctor/katex/katex_adapter.rb
+- lib/asciidoctor/katex/errors.rb
+- lib/asciidoctor/katex/opal_katex_adapter.rb
+- lib/asciidoctor/katex/ruby_katex_adapter.rb
 - lib/asciidoctor/katex/stem_converter_decorator.rb
 - lib/asciidoctor/katex/treeprocessor.rb
+- lib/asciidoctor/katex/utils.rb
 - lib/asciidoctor/katex/version.rb
 homepage: https://github.com/jirutka/asciidoctor-katex/
 licenses:

data/lib/asciidoctor/katex/katex_adapter.rb

@@ -1,65 +0,0 @@
-# frozen_string_literal: true
-require 'asciidoctor/katex/version'
-require 'katex' unless RUBY_PLATFORM == 'opal'
-
-module Asciidoctor::Katex
-  # Adapter for KaTeX library supporting both Ruby and Opal environment.
-  class KatexAdapter
-
-    # @param default_options [Hash] the default options for the KaTeX renderer.
-    # @param katex_object the katex object to use under Opal (defaults to
-    #   global variable `katex`).
-    def initialize(default_options = {}, katex_object = nil)
-      @default_options = default_options
-      @katex_object = katex_object || `katex` if RUBY_PLATFORM == 'opal'
-    end
-
-    # @return [Boolean] whether is KaTeX library installed and loaded.
-    #   This is useful only under Opal.
-    def available?
-      if RUBY_PLATFORM == 'opal'
-        `#{@katex_object} != 'undefined' && #{@katex_object}.renderToString != undefined`
-      else
-        defined? ::Katex
-      end
-    end
-
-    # Renders the given math expression to HTML using KaTeX.
-    #
-    # @param math [String] the math (LaTeX) expression.
-    # @param options [Hash] options for `katex.renderToString`.
-    #   Keys in under_score notation will be converted to camelCase.
-    #   See <https://github.com/Khan/KaTeX#rendering-options>.
-    # @return [String] a rendered HTML fragment.
-    def render(math, options = {})
-      options = hash_camelize(options || {})
-
-      if RUBY_PLATFORM == 'opal'
-        `#{@katex_object}.renderToString(#{math}, #{options}.$$smap)`
-      else
-        ::Katex.render(math, options)
-      end
-    end
-
-    alias call render
-
-    # @return [String] version of the KaTeX library.
-    def version
-      if RUBY_PLATFORM == 'opal'
-        '0.9.0'  # TODO: replace with `katex.version` after update to 0.10+.
-      else
-        ::Katex::KATEX_VERSION.sub(/^v/, '')
-      end
-    end
-
-    private
-
-    # @param hash [Hash] the hash to transform.
-    # @return [Hash] a copy of the *hash* with under_score keys transformed to camelCase.
-    def hash_camelize(hash)
-      hash.map { |k, v|
-        [k.to_s.gsub(/_\w/) { |s| s[1].upcase }.to_sym, v]
-      }.to_h
-    end
-  end
-end