jektex 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 290626aa91c28cc4961baf40ec00dde81928da68e0a923ee84999027e7f3c9b0
-  data.tar.gz: 4ec8d501a4ab6f1b068ec01bb21a7d84bd844a5bca7d105bdc0c9c6e2652eec8
+  metadata.gz: 476a24b916af7e71a30a60cd2476063fa2d627959060179104e8a41871c5d4ab
+  data.tar.gz: 93243e4af6fea3e355f0cc4401e990cdb107f77c717b7e63d4902a172b56a7d0
 SHA512:
-  metadata.gz: ccdddba235b4d0462ccb5e4d2ee4cbf5b97e9964c10fd0395e814635281563c6363a381422feeefdd9eb6a895877a47aba6fae95de36c98a6f710785ed18ba51
-  data.tar.gz: 4d0a8dad642c30c5f26ca5903d715e3728d918bb17fe1eaeaf3ce8ad814a25e9c50d0df15533522275665978971ee269164a2969cf73db9823b71b9ea29a7217
+  metadata.gz: d0ae577416fec788441659e670f4e85c0b34c091c81f666ab1cd62f5a39b3500548efb4238f53d77f1ea0dd30bd3571f001aa418311dcf6786a70afbbd3d0e8c
+  data.tar.gz: a7feff881708ffb27bffb76c2f00146c0bb4f7f4a90fe341ea88f121f1442ace72294596112f8c139e9a5628f4f14f0022e2f18dabe5a7e15e56e985d31c9d73

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/jektex.svg)](https://rubygems.org/gems/jektex)
+
 # Jektex
 Jekyll plugin for blazing fast server side cached LaTeX rendering with support of macros.
 Enjoy comfort of latex and markdown without cluttering your site with bloated javascript.
@@ -14,6 +16,7 @@ Enjoy comfort of latex and markdown without cluttering your site with bloated ja
 - Marks invalid syntax in document
 - Prints location of invalid expression during rendering
 - Highly configurable but still having sensible defaults
+- Makes sure that cache does not contain expression rendered with outdated configuration
 
 ## Usage
 
@@ -98,8 +101,7 @@ jektex:
     - ["\\C", "\\mathbb{C}"]
 ```
 And yes you have to escape backlash(`\`) with another backlash. This is caused by
-[yaml definition](https://yaml.org/). YOU SHOULD ALWAYS delete jektex cache after changing
-definition of a macro for change to take effect.
+[yaml definition](https://yaml.org/).
 
 **Complete examples**  
 Recommended config:
@@ -146,7 +148,7 @@ and do not forget to add `katex.min.css` to you html head:
 ```html
 <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.15.2/dist/katex.min.css" integrity="sha384-MlJdn/WNKDGXveldHDdyRP1R4CTHr3FeuDNfhsLPYrq2t0UBkUdK2jyTnXPEK1NQ" crossorigin="anonymous">
 ```
-It is much better practice to download **css** file and load it as an asset from your server directly.
+It is much better practice to download [**css** file](https://cdn.jsdelivr.net/npm/katex@0.15.2/dist/katex.min.css) and load it as an asset from your server directly.
 You can find more information on [KaTeX's website](https://katex.org/docs/browser.html).
 
 ## Contributions and bug reports

data/lib/jektex/jektex.rb

@@ -9,91 +9,97 @@ CACHE_FILE = "jektex-cache.marshal"
 KATEX = ExecJS.compile(open(PATH_TO_JS).read)
 PARSE_ERROR_PLACEHOLDER = "<b style='color: red;'>PARSE ERROR</b>"
 FRONT_MATTER_TAG = "jektex"
+INDENT = " " * 13
+
 $global_macros = Hash.new
+$updated_global_macros = Array.new
+
 $count_newly_generated_expressions = 0
+
 $path_to_cache = File.join(DEFAULT_CACHE_DIR, CACHE_FILE)
 $cache = nil
 $disable_disk_cache = false
+
 $ignored = Array.new
 
+def get_list_of_updated_global_macros(current_macros, cached_global_macros)
+  return Array.new unless cached_global_macros || current_macros
+  return current_macros.keys unless cached_global_macros
+  return cached_global_macros.keys unless current_macros
+
+  macro_set = Set.new(cached_global_macros.keys + current_macros.keys)
+  macro_set.delete_if { |m| cached_global_macros[m] == current_macros[m] }
+  return macro_set.to_a
+end
+
 def is_ignored?(page)
-  for patern in $ignored
-    if File.fnmatch?(patern, page.relative_path, File::FNM_DOTMATCH) then
-      return true
-    end
-  end
-  return false
+  return true if page.data[FRONT_MATTER_TAG] == "false"
+  return $ignored.any? { |patern| File.fnmatch?(patern, page.relative_path, File::FNM_DOTMATCH) }
+end
+
+def contains_updated_global_macro?(expression)
+  return $updated_global_macros.any? { |m| expression[m] }
+end
+
+def print_stats
+  print "#{INDENT}LaTeX: " \
+  "#{$count_newly_generated_expressions} expressions rendered " \
+  "(#{$cache.size} already cached)".ljust(72) + "\r"
+  $stdout.flush
 end
 
 def render(page)
   # check if document is not set to be ignored
-  if page.data == nil or is_ignored?(page) or page.data[FRONT_MATTER_TAG] == "false" then
-    return page.output
-  end
-
+  return page.output if !page.data || is_ignored?(page)
   # convert HTML entities back to characters
   post = HTMLEntities.new.decode(page.output.to_s)
   # render inline expressions
-  post = post.gsub(/(\\\()((.|\n)*?)(?<!\\)\\\)/) { |m| escape_method($1, $2, page.path) }
-  # render display expressions
-  post = post.gsub(/(\\\[)((.|\n)*?)(?<!\\)\\\]/) { |m| escape_method($1, $2, page.path) }
+  post = post.gsub(/(\\\()((.|\n)*?)(?<!\\)\\\)/) { |m| escape_method($1, $2, page.relative_path) }
+  # render display mode expressions
+  post = post.gsub(/(\\\[)((.|\n)*?)(?<!\\)\\\]/) { |m| escape_method($1, $2, page.relative_path) }
   return post
 end
 
-def escape_method( type, string, doc_path )
-  @display = false
-
-  # detect if expression is display view
-  case type.downcase
-    when /\(/
-      @display = false
-    else /\[/
-      @display = true
-  end
+def escape_method( type, expression, doc_path )
+  # detect if expression is in display mode
+  is_in_display_mode? = type.downcase =~ /\[/
 
   # generate a hash from the math expression
-  @expression_hash = Digest::SHA2.hexdigest(string) + @display.to_s
+  expression_hash = Digest::SHA2.hexdigest(string) + is_in_display_mode?.to_s
 
   # use it if it exists
-  if($cache.has_key?(@expression_hash))
+  if($cache.has_key?(expression_hash) && !contains_updated_global_macro?(string))
+    # check if expressin conains updated macro
     $count_newly_generated_expressions += 1
     print_stats
-    return $cache[@expression_hash]
+    return $cache[expression_hash]
 
   # else generate one and store it
   else
     # create the cache directory, if it doesn't exist
     begin
       # render using ExecJS
-      @result =  KATEX.call("katex.renderToString", string,
-                          {displayMode: @display,  macros: $global_macros})
+      result =  KATEX.call("katex.renderToString", expression,
+                          {is_in_display_mode?Mode: is_in_display_mode?,  macros: $global_macros})
     rescue SystemExit, Interrupt
       # save cache to disk
       File.open($path_to_cache, "w"){|to_file| Marshal.dump($cache, to_file)}
       # this stops jekyll being immune to interrupts and kill command
       raise
-    rescue Exception => e
+    rescue ExecJS::ProgramError => pe
       # catch parse error
-      puts "\e[31m " + e.message.gsub("ParseError: ", "") + "\n\t"  + doc_path + "\e[0m"
+      puts "\e[31m " + pe.message.gsub("ParseError: ", "") + "\n\t"  + doc_path + "\e[0m"
       return PARSE_ERROR_PLACEHOLDER
     end
     # save to cache
-    $cache[@expression_hash] = @result
+    $cache[expression_hash] = @result
     # update count of newly generated expressions
     $count_newly_generated_expressions += 1
     print_stats
-    return @result
+    return result
   end
 end
 
-def print_stats
-  print "             LaTeX: " + 
-        ($count_newly_generated_expressions).to_s +
-        " expressions rendered (" + $cache.size.to_s +
-        " already cached)        \r"
-  $stdout.flush
-end
-
 Jekyll::Hooks.register :pages, :post_render do |page|
   page.output = render(page)
 end
@@ -103,50 +109,42 @@ Jekyll::Hooks.register :documents, :post_render do |doc|
 end
 
 Jekyll::Hooks.register :site, :after_init do |site|
-  if site.config["jektex"] == nil then
-    # if no config is defined make empty one
-    config = Hash.new
+  # load jektex config from config file and if no config is defined make empty one
+  config = site.config["jektex"] || Hash.new
+
+  # check if there is defined custom cache location in config
+  $path_to_cache = File.join(config["cache_dir"].to_s, CACHE_FILE) if config.has_key?("cache_dir")
+
+  # load content of cache file if it exists
+  if File.exist?($path_to_cache)
+    $cache = File.open($path_to_cache, "r"){ |from_file| Marshal.load(from_file)}
   else
-    # load jektex config from config file
-    config = site.config["jektex"]
+    $cache = Hash.new
   end
+
+  # check if cache is disable in config
+  $disable_disk_cache = site.config["disable_disk_cache"] if site.config.has_key?("disable_disk_cache")
+
   # load macros
-  if config["macros"] != nil then
+  if config.has_key?("macros")
     for macro_definition in config["macros"]
       $global_macros[macro_definition[0]] = macro_definition[1]
     end
   end
 
+  # make list of updated macros
+  $updated_global_macros = get_list_of_updated_global_macros($global_macros, $cache["cached_global_macros"])
   # print macro information
-  if $global_macros.size == 0 then
-    puts "             LaTeX: no macros loaded"
+  if $global_macros.empty?
+    puts "#{INDENT}LaTeX: no macros loaded"
   else
-    puts "             LaTeX: " + $global_macros.size.to_s + " macro" +
-          ($global_macros.size == 1 ? "" : "s") + " loaded"
-  end
-
-  # check if there is defined custom cache location in config
-  if config["cache_dir"] != nil then
-    $path_to_cache = File.join(config["cache_dir"].to_s, CACHE_FILE)
+    puts "#{INDENT}LaTeX: #{$global_macros.size} macro" +
+      ($global_macros.size == 1 ? "" : "s") + " loaded" +
+      ($updated_global_macros.empty? ? "" : " (#{$updated_global_macros.size} updated)")
   end
 
   # load list of ignored files
-  if config["ignore"] != nil then
-    $ignored = config["ignore"]
-  end
-
-  # load content of cache file if it exists
-  if(File.exist?($path_to_cache)) then
-    $cache = File.open($path_to_cache, "r"){|from_file| Marshal.load(from_file)}
-  else
-    $cache = Hash.new
-  end
-
-  # check if cache is disable in config
-  if site.config["disable_disk_cache"] != nil then
-    $disable_disk_cache = site.config["disable_disk_cache"]
-  end
-
+  $ignored = config["ignore"] if config.has_key?("ignore")
 end
 
 Jekyll::Hooks.register :site, :after_reset do
@@ -158,9 +156,13 @@ Jekyll::Hooks.register :site, :post_write do
   # print new line to prevent overwriting previous output
   print "\n"
   # check if caching is enabled
-  if $disable_disk_cache == false
+  if !$disable_disk_cache
+    # save global macros to cache
+    $cache["cached_global_macros"] = $global_macros
+    # create cache path
+    Pathname.new($path_to_cache).dirname.mkpath
     # save cache to disk
-    Dir.mkdir(File.dirname($path_to_cache)) unless File.exists?(File.dirname($path_to_cache))
     File.open($path_to_cache, "w"){|to_file| Marshal.dump($cache, to_file)}
   end
 end
+

data/lib/jektex/version.rb

@@ -1,3 +1,3 @@
 module Jektex
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jektex
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Jan Černý
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-22 00:00:00.000000000 Z
+date: 2022-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: execjs
@@ -108,7 +108,7 @@ licenses:
 - GPL-3.0-or-later
 metadata:
   bug_tracker_uri: https://github.com/yagarea/jektex/issues
-  documentation_uri: https://github.com/yagarea/jektex
+  documentation_uri: https://github.com/yagarea/jektex/blob/master/README.md
   homepage_uri: https://github.com/yagarea/jektex
   source_code_uri: https://github.com/yagarea/jektex
   changelog_uri: https://github.com/yagarea/jektex/blob/master/changelog.md