jekyll-t4j 0.2.2 → 0.3.0

data/lib/jekyll-t4j/engine/katex.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "execjs"
+
+module Jekyll::T4J
+    module Engine
+        KATEX_CSS_VERSION = "0.16.4"
+
+        @@_katex_js_ = ExecJS.runtime.compile File.read(File.join(__dir__, "katex.js"))
+
+        def self.katex_raw(snippet, options = nil)
+            snippet = split_snippet(snippet)
+            options = {} unless options
+            options[:displayMode] = snippet[1]
+
+            @@_katex_js_.call("katex.renderToString", snippet[0], options)
+        end
+    end
+end

data/lib/jekyll-t4j/engine.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+unless system("latex -version", [:out, :err]=>File::NULL)
+    STDERR.puts "You are missing a TeX distribution. Please install:"
+    STDERR.puts "  MiKTeX or TeX Live"
+    raise "Missing TeX distribution"
+end
+
+require "jekyll/cache"
+
+require "jekyll-t4j/engine/dvisvgm"
+require "jekyll-t4j/engine/katex"
+
+module Jekyll::T4J
+    module Engine
+        @@cache_katex = Jekyll::Cache.new "Jekyll::T4J::Katex"
+        @@cache_dvisvgm = Jekyll::Cache.new "Jekyll::T4J::Dvisvgm"
+
+        @@header = <<~HEREDOC
+            <link rel=\"stylesheet\" href=\"https://unpkg.com/katex@#{KATEX_CSS_VERSION}/dist/katex.min.css\">
+            <style>
+                .katex-ext-d {
+                    border-radius: 0px;
+                    display: block;
+                    margin: 5px auto;
+                }
+                .katex-ext-i {
+                    border-radius: 0px;
+                    display: inline;
+                    vertical-align: middle;
+                }
+            </style>
+        HEREDOC
+
+        def self.header
+            @@header
+        end
+
+        def self.render(snippets, merger)
+            gen = ->(svg_data, displayMode) {
+                "<img src=\"#{merger.(svg_data, ".svg")}\" class=\"#{
+                    displayMode ? "katex-ext-d" : "katex-ext-i"
+                }\" style=\"height:#{
+                    (svg_data[/height='(\S+?)pt'/, 1].to_f * 0.1).to_s[/\d+\.\d{1,4}/]
+                }em\">"
+            }
+
+            # normalize 'snippets'
+            snippets.map! {|s|
+                if not s.start_with?("\\") then
+                    s = split_snippet(s)
+                    s = s[1] ? "\\[#{s[0]}\\]" : "\\(#{s[0]}\\)"
+                end
+
+                s
+            }
+
+            # fill 'snippets' with katex and cached dvisvgm
+            unset = []
+            uncached = {}
+            snippets.each_index {|i|
+                s = snippets[i]
+                r = @@cache_katex.getset(s) {
+                    begin
+                        katex_raw(s, {strict: true})
+                    rescue
+                        "NIL"
+                    end
+                }
+
+                if r == "NIL" then
+                    begin
+                        r = gen.(@@cache_dvisvgm[Jekyll::T4J.cfg_pkgs + s], is_display_mode?(s))
+                    rescue
+                        uncached[s] = r = nil
+                        unset << [i, s]
+                    end
+                end
+
+                snippets[i] = r
+            }
+
+            # render 'uncached'
+            if not uncached.empty? then
+                # bulk render 'uncached'
+                begin
+                    uncached_snippets = uncached.keys
+                    rendered = dvisvgm_raw_bulk(uncached_snippets)
+                    rendered.each_index {|i| uncached[uncached_snippets[i]] = rendered[i]}
+                end
+
+                # flush 'uncached' to 'snippets' and cache them
+                unset.each {|b|
+                    s = b[1]
+                    snippets[b[0]] = gen.(uncached[s], is_display_mode?(s))
+                    @@cache_dvisvgm[Jekyll::T4J.cfg_pkgs + s] = uncached[s]
+                }
+            end
+        end
+
+        def self.is_display_mode?(snippet)
+            snippet.start_with?("\\[") or snippet.start_with?("$$")
+        end
+
+        def self.split_snippet(snippet)
+            displayMode = false
+            range = 2..-3
+
+            if snippet.start_with?("\\[") or snippet.start_with?("$$") then
+                displayMode = true
+            elsif snippet.start_with?("$") then
+                range = 1..-2
+            end
+
+            [snippet[range], displayMode]
+        end
+    end
+end

data/lib/jekyll-t4j/merger.rb

@@ -2,46 +2,30 @@
 
 module Jekyll::T4J
     module Merger
-        @@available = true
-        @@cache = {}
+        @@table = {}
         @@rnd_range = "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ$@".chars
-    
-        def self.ask_for_merge(url, filedata, extname)
-            raise "Merge request during post processing!" unless @@available
-
-            request = @@cache[url]
-            request = @@cache[url] = {} unless request
-
-            entry = request.rassoc(filedata.freeze)
-            return entry[0] if entry and entry[0].split(".")[1] == extname
-
-            filename = @@rnd_range.sample(22).join.prepend("_") << "." << extname
-            request[filename] = filedata
-            filename.freeze
-        end
-
-        # write external files
-        Jekyll::Hooks.register :documents, :post_write do |doc|
-            @@available = false
-
-            url = doc.url
-            request = @@cache[url]
 
+        def self.ask_for_merge(filedata, extname)
+            request = @@table[filedata]
+            
             if request then
-                url = File.dirname url unless url.end_with? "/"
-
-                request.each {|k, v|
-                    File.write File.join(doc.site.dest, url, k), v
-                }
-
-                request.clear
+                request[1] << extname
+            else
+                basename = @@rnd_range.sample(22).join.prepend("_").freeze
+                request = @@table[filedata] = [basename, [extname]]
             end
+
+            "/" + request[0] + extname
         end
 
-        # clean up
-        Jekyll::Hooks.register :site, :post_write do
-            @@cache.clear
-            @@available = true
+        # write external files and clean up
+        Jekyll::Hooks.register :site, :post_write, priority: Jekyll::Hooks::PRIORITY_MAP[:low] do |site|
+            @@table.each {|filedata, request|
+                basename = request[0]
+                request[1].each {|extname| File.write(File.join(site.dest, basename + extname), filedata)}
+            }
+
+            @@table.clear
         end
     end
 end

data/lib/jekyll-t4j/renderer.rb

@@ -14,13 +14,13 @@ module Jekyll::T4J
     ).freeze
 
     TEXT_TEX_MASK = Regexp.union(
-        /\\\[([\s\S]*?)\\\]/,
-        /\$\$([\s\S]*?)\$\$/,
-        /\\\(([\s\S]*?)\\\)/,
-        /\$([\s\S]*?)\$/
+        /\\\[[\s\S]*?\\\]/,
+        /\$\$[\s\S]*?\$\$/,
+        /\\\([\s\S]*?\\\)/,
+        /\$[\s\S]*?\$/
     ).freeze
 
-    def self.mask(str, reg, capture = false)
+    def self.mask(str, reg)
         s = StringScanner.new str
         parts = []
 
@@ -32,7 +32,7 @@ module Jekyll::T4J
                 p1 = s.charpos - s.matched.size - 1
 
                 parts << [str[p0..p1], true] unless p1 < p0
-                parts << (capture ? [s.matched, false, s.captures] : [s.matched, false])
+                parts << [s.matched, false]
             else
                 parts << [str[p0..-1], true]
                 break
@@ -41,38 +41,75 @@ module Jekyll::T4J
 
         parts
     end
-end
 
-Jekyll::Hooks.register :documents, :post_render do |doc|
-    result = String.new
+    def self.extract(html)
+        result = []
+        prev = nil
 
-    gen = -> (s, is_display) {
-        s.strip!
-        return "" if s.empty?
+        for p0 in mask(html, HTML_TEXT_MASK)
+            if p0[1] then #p0[0] is a text node
+                for p1 in mask(p0[0], TEXT_TEX_MASK)
+                    if not p1[1] then #p1[0] is a tex snippet
+                        prev = nil
+                        p1[1] = true
+                        result << p1
+                    else
+                        if prev then
+                            prev << p1[0]
+                        else
+                            prev = p1[0]
+                            p1[1] = false
+                            result << p1
+                        end
+                    end
+                end
+            else
+                if prev then
+                    prev << p0[0]
+                else
+                    prev = p0[0]
+                    result << p0
+                end
+            end
+        end
+
+        result
+    end
 
-        s.prepend "\\documentclass{article}#{Jekyll::T4J.cfg_pkgs}\\begin{document}\\pagenumbering{gobble}\\begin{math}"
-        s << "\\end{math}\\end{document}"
-        s = Jekyll::T4J::Engines.dvisvgm(s)
+    # T4J rendering phase
+    Jekyll::Hooks.register :site, :post_render do |site|
+        snippets = []
+        docs = []
 
-        "<img src=\"#{Jekyll::T4J::Merger.ask_for_merge(doc.url, s, "svg")}\" style=\"#{
-            is_display ? "display:block;margin:0 auto" : "display:inline;vertical-align:middle"
-        };height:#{(s[/height='(\S+?)pt'/, 1].to_f * 0.1).to_s}em\">"
-    }
+        # collect tex snippets
+        site.each_site_file {|f|
+            if !f.is_a?(Jekyll::StaticFile) then
+                parts = extract(f.output)
+                if parts.size > 1 then #'f' has tex snippet(s)
+                    parts.each {|part| snippets << CGI::unescapeHTML(part[0]) if part[1]} # TODO: a subtle bug about unescaping HTML
+                    docs << [f, parts]
+                end
+            end
+        }
+
+        # render 'snippets'
+        Jekyll::T4J::Engine.render(snippets, ->(data, extname) {Jekyll::T4J::Merger.ask_for_merge(data, extname)})
+
+        # 'snippets' -> 'docs'
+        i = 0
+        for doc in docs
+            newoutput = String.new
 
-    for p0 in Jekyll::T4J.mask(doc.output, Jekyll::T4J::HTML_TEXT_MASK)
-        if p0[1] then
-            for p1 in Jekyll::T4J.mask(p0[0], Jekyll::T4J::TEXT_TEX_MASK, true)
-                p1[2].each_index {|i|
-                    c = p1[2][i]
-                    p1[0] = gen.(CGI::unescapeHTML(c), i < 2) if not c.empty?
-                } if not p1[1]
+            for part in doc[1]
+                if part[1] then
+                    part[0] = snippets[i]
+                    i += 1
+                end
 
-                result << p1[0]
+                newoutput << part[0]
             end
-        else
-            result << p0[0]
+
+            doc[0].output = newoutput.insert(newoutput.index("</head>"), Jekyll::T4J::Engine.header)
         end
     end
-
-    doc.output = result
 end

data/lib/jekyll-t4j/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
     module T4J
-        VERSION = "0.2.2"
+        VERSION = "0.3.0"
     end
 end

data/lib/jekyll-t4j.rb

@@ -14,21 +14,22 @@ module Jekyll::T4J
     # initialize plugin
     Jekyll::Hooks.register :site, :after_init do |site|
         cfg = site.config["t4j"]
-        @@cfg_pkgs = (cfg and (cfg = cfg["packages"])) ? parse_cfg_pkgs(cfg) : ""
-    end
 
-    def self.parse_cfg_pkgs(cfg)
-        ret = String.new
+        if cfg and (cfg = cfg["packages"]) then
+            pkgs = String.new
 
-        for p in cfg
-            raise "Illegal config: #{p}" unless p.match(/\s*([\w-]+)(\[[^\[\]]*\])?\s*/)
-            ret << "\\usepackage#{$2}{#{$1}}"
-        end
+            for p in cfg
+                raise "Illegal config: #{p}" unless p.match(/\s*([\w-]+)(\[[^\[\]]*\])?\s*/)
+                pkgs << "\\usepackage#{$2}{#{$1}}"
+            end
 
-        ret
+            @@cfg_pkgs = pkgs
+        else
+            @@cfg_pkgs = ""
+        end
     end
 end
 
 require "jekyll-t4j/merger"
-require "jekyll-t4j/engines"
+require "jekyll-t4j/engine"
 require "jekyll-t4j/renderer"

metadata

@@ -1,36 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-t4j
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - crow02531
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-09 00:00:00.000000000 Z
+date: 2023-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
-    - - "<"
+- !ruby/object:Gem::Dependency
+  name: execjs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5'
-description:
+        version: '2.8'
+description: |2
+          A Jekyll plugin providing (nearly) full support of LaTeX. Capable of
+          rendering almost all packages, including tikz, chemfig, etc.
 email: crow02531@outlook.com
 executables: []
 extensions: []
@@ -39,8 +49,11 @@ files:
 - LICENSE
 - README.md
 - lib/jekyll-t4j.rb
-- lib/jekyll-t4j/engines.rb
-- lib/jekyll-t4j/engines/dvisvgm.rb
+- lib/jekyll-t4j/engine.rb
+- lib/jekyll-t4j/engine/dvisvgm.rb
+- lib/jekyll-t4j/engine/dvisvgm.tex
+- lib/jekyll-t4j/engine/katex.js
+- lib/jekyll-t4j/engine/katex.rb
 - lib/jekyll-t4j/merger.rb
 - lib/jekyll-t4j/renderer.rb
 - lib/jekyll-t4j/version.rb
@@ -63,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- TeX distribution
+- A TeX distribution
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4

data/lib/jekyll-t4j/engines/dvisvgm.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require "tmpdir"
-require "jekyll/cache"
-
-module Jekyll::T4J
-    module Engines
-        @@cache_dvisvgm = Jekyll::Cache.new "Jekyll::T4J::Dvisvgm"
-
-        def self.dvisvgm_raw(src)
-            # setup: write 'src' to 'content.tex'
-            check_tex
-            pwd = Dir.mktmpdir
-            File.write "#{pwd}/content.tex", src
-
-            # call 'latex' to compile: tex->dvi
-            system "latex -halt-on-error content", :chdir => pwd, [:out, :err] => File::NULL, exception: true
-            system "latex -halt-on-error content", :chdir => pwd, [:out, :err] => File::NULL, exception: true
-            # call 'dvisvgm' to convert dvi to svg
-            system "dvisvgm -n -e content", :chdir => pwd, [:out, :err] => File::NULL, exception: true
-
-            # fetch result
-            File.read "#{pwd}/content.svg"
-        ensure
-            FileUtils.remove_entry pwd if pwd
-        end
-
-        def self.dvisvgm(src)
-            @@cache_dvisvgm.getset(src) {dvisvgm_raw(src)}
-        end
-    end
-end

data/lib/jekyll-t4j/engines.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-module Jekyll::T4J
-    module Engines
-        @@_passed = nil
-
-        def self.has_tex?
-            if @@_passed == nil then
-                @@_passed = system("latex -version", [:out, :err]=>File::NULL) ? true : false
-            end
-
-            @@_passed
-        end
-
-        def self.check_tex
-            unless has_tex?
-                STDERR.puts "You are missing a TeX distribution. Please install:"
-                STDERR.puts "  MiKTeX or TeX Live"
-                raise "Missing TeX distribution"
-            end
-        end
-    end
-end
-
-require "jekyll-t4j/engines/dvisvgm"