jektex 0.0.5 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 290626aa91c28cc4961baf40ec00dde81928da68e0a923ee84999027e7f3c9b0
-  data.tar.gz: 4ec8d501a4ab6f1b068ec01bb21a7d84bd844a5bca7d105bdc0c9c6e2652eec8
+  metadata.gz: 9405c84a9c1c4d137d5f9fe152943a72613a52fb741ea8dc3074c64368257b77
+  data.tar.gz: fcf023964df85b84be1ebab055fd778f923a63e3857facc083e451370168b366
 SHA512:
-  metadata.gz: ccdddba235b4d0462ccb5e4d2ee4cbf5b97e9964c10fd0395e814635281563c6363a381422feeefdd9eb6a895877a47aba6fae95de36c98a6f710785ed18ba51
-  data.tar.gz: 4d0a8dad642c30c5f26ca5903d715e3728d918bb17fe1eaeaf3ce8ad814a25e9c50d0df15533522275665978971ee269164a2969cf73db9823b71b9ea29a7217
+  metadata.gz: 1fda6a4eda19f919edc732da120ccfe2a20c520476465d53d79a98eb80087d94b438a84b863194009213781f5b15d180a5e7b22a6ca1eeb35e4bf3676da709c2
+  data.tar.gz: 7f3bd08cb26988e28c5ff910148404dcc0dee7f83478bbd04786aa5bf73ca5ea50fc93117e536c417549cb98f2192a27b20bdea99e598d3fcc15b49ef9b71208

data/README.md

@@ -1,23 +1,27 @@
+[![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.
+A Jekyll plugin for blazing-fast server-side cached LaTeX rendering, with support for macros.
+Enjoy the comfort of LaTeX and Markdown without cluttering your site with bloated JavaScript.
 
 ## Features
 - Renders LaTeX formulas during Jekyll rendering
-- Works without any javascript on clients side
-- Is faster than any other server side Jekyll latex renderer
-- Supports user defined global macros
-- Has I/O efficient caching system
-- Has dynamic and informative log during rendering
-- Is easy to setup
-- Does not interfere with Jekyll workflow and project structure
-- Marks invalid syntax in document
-- Prints location of invalid expression during rendering
-- Highly configurable but still having sensible defaults
+- Works without any client-side JavaScript
+- Is faster than any other server-side Jekyll LaTeX renderer
+- Supports user-defined global macros
+- Has I/O-efficient caching system
+- Dynamically informs about the number of expressions during rendering
+- Is very easy to setup
+- Doesn't interfere with Jekyll workflow and project structure
+- Marks invalid expressions in document, printing its location during rendering
+- Is highly configurable with sensible defaults
+- Makes sure that cache does not contain expression rendered with outdated configuration
 
 ## Usage
 
-### Notation
+Jektex supports both the built-in Kramdown math notation, and the newer LaTeX-only math notation.
+
+### Kramdown notation
 **Inline formula**  
 Put formula between two pairs of dolar signs (`$$`) inside of paragraph.
 ```latex
@@ -26,7 +30,7 @@ adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliq
 ```
 
 **Display formula**  
-Put formula between two pairs of dolar sings (`$$`) and surround it by two empty lines.
+Put formula between two pairs of dolar sings (`$$`) and surround it with two empty lines.
 ```latex
 Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
 incididunt ut labore et dolore magna aliqua.
@@ -42,54 +46,74 @@ display mode?
 This is how [kramdown](https://kramdown.gettalong.org/)(Jekyll's markdown parser) works 
 so I decided to respect this convention. It makes this plugin more consistent and universal._
 
+
+### LaTex math mode notation
+**Inline formula**  
+Put formula between two escaped brackets `\(` `\)`.
+Its position in the text does not matter.
+```latex
+Lorem ipsum dolor sit amet, consectetur \(e^{i\theta}=\cos(\theta)+i\sin(\theta)\)
+adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+```
+
+**Display formula**  
+Put formula between two escaped square brackets `\[` `\]`.
+Its position in the text does not matter.
+```latex
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor
+incididunt ut labore et dolore magna aliqua.
+
+\[ \left[ \frac{-\hbar^2}{2\mu}\nabla^2 + V(\mathbf{r},t)\right] \Psi(\mathbf{r},t) \]
+
+Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex
+ea commodo consequat.
+```
+
 ### Config
-Jektex si highly configurable from your `_config.yml` file
+Jektex si highly configurable via your `_config.yml` file.
 
 **Disabling cache**  
-You can disable caching with `disable_disk_cache = true` in `_config.yml`. Cache is
-enabled by default. You can find more information on [Jekyll official website](https://jekyllrb.com/docs/configuration/options/).
+You can disable caching with `disable_disk_cache = true` in `_config.yml`.
+Caching is enabled by default.
+You can find more information on [Jekyll's official website](https://jekyllrb.com/docs/configuration/options/).
 
 **Setting cache location**  
-By default jektex cache will be saved in `.jekyll-cache` directory. This results in it's
-deletion when you call `jekyll clean`. To prevent cache deletion or you just want to
-change location of cache for another reason you can achieve that by specifying
-`cache_dir` in `_config.yml`.
+By default, Jektex cache will be saved in `.jekyll-cache` directory.
+This results in its deletion when you call `jekyll clean`.
+To prevent cache deletion or to change the cache location, you can specify `cache_dir` in `_config.yml`:
 ```yaml
 # Jektex cache dir location
 jektex:
   cache_dir: ".jektex-cache"
 ```
 
-**Ignore**  
-By default jektex tries to render LaTeX in all files not excluded by Jekyll. But 
-sometimes you get in situation when you do not want to render some files. For example
-_RSS feed_ with excerpts containing LaTeX. As a solution jektex offers `ignore` option.
-You can use conventional wild cards using `*`. For example:
+**Ignoring files**  
+By default, Jektex tries to render LaTeX in all files rendered by Jekyll.
+This can sometimes be undesirable, for example when rendering an _RSS feed_ with excerpts containing LaTeX.
+Jektex solves this by using the `ignore` option:
 ```yaml
 # Jektex ignore files
 jektex:
   ignore: ["*.xml", "README.md", "_drafts/*" ]
 ```
 
-This example configuration ignores all `.xml` files, `README.md` and all files 
-in `_drafts` directory.
+You can use conventional wild cards using `*`.
+This example configuration ignores all `.xml` files, `README.md` and all files in the `_drafts` directory.
 
-Another option for ignoring specific posts is setting `jektex` tag in front matter of
-post to `false`. For example:
+Another way to ignore specific posts is setting the `jektex` attribute in front matter to `false`:
 ```yaml
 ---
-title: "How Jektex works"
+ttle: "How Jektex works"
 category: "Development"
 jektex: false
 layout: post
 ---
 ```
 
-Setting `jektex` tag to `true` or not setting at all will result in jektex rendering LaTeX
-expressions in that post.
+Setting `jektex` tag to `true` or not setting at all will result in Jektex rendering LaTeX expressions in that post.
 
-**Macros**  
-You can define global macros like this:
+**Using macros**  
+You can define global macros:
 ```yaml
 # Jektex macros
 jektex:
@@ -97,9 +121,8 @@ jektex:
     - ["\\Q", "\\mathbb{Q}"]
     - ["\\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.
+And yes, you have to escape the backlash (`\`) with another backlash.
+This is due to the [yaml specification](https://yaml.org/).
 
 **Complete examples**  
 Recommended config:
@@ -111,6 +134,7 @@ jektex:
     - ["\\Q", "\\mathbb{Q}"]
     - ["\\C", "\\mathbb{C}"]
 ```
+
 Having no configuration is equivalent to this:
 ```yaml
 jektex:
@@ -123,7 +147,7 @@ jektex:
 This plugin is available as a [RubyGem](https://rubygems.org/gems/jektex).
 
 **Using bundler**  
-Add `jektex` to your `Gemfile` like this:
+Add Jektex to your `Gemfile`:
 ```ruby
 group :jekyll_plugins do
     gem "jektex"
@@ -133,22 +157,23 @@ end
 and run `bundle install`
 
 **Without bundler**  
-Just run `gem install jektex`
+Run `gem install jektex`
 
 **After installation**  
-Add jektex to your plugin list in your `_config.yml` file:
+Add Jektex to your plugin list in your `_config.yml` file
 ```yaml
 plugins:
     - jektex
 ```
 
-and do not forget to add `katex.min.css` to you html head:
+and don't 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 the [**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
 Feel free to repost any bugs or even make feature request in [issues on official repository](https://github.com/yagarea/jektex/issues).
 I am opened for pull requests as well.
+

data/lib/jektex/jektex.rb

@@ -7,146 +7,176 @@ PATH_TO_JS = File.join(__dir__, "/katex.min.js")
 DEFAULT_CACHE_DIR = ".jekyll-cache"
 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 render(page)
+def print_stats
+  print "#{INDENT}LaTeX: " \
+  "#{$count_newly_generated_expressions} expressions rendered " \
+  "(#{$cache.size} already cached)".ljust(72) + "\r"
+  $stdout.flush
+end
+
+#######################################################################################
+# Render
+
+def render_latex_notation(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.content if !page.data || is_ignored?(page)
+  # convert HTML entities back to characters
+  post = HTMLEntities.new.decode(page.content.to_s)
+  # render inline expressions
+  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 render_kramdown_notation(page)
+  # check if document is not set to be ignored
+  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(expression) + 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?(expression))
+    # 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,
+                          { displayMode: 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"
-      return PARSE_ERROR_PLACEHOLDER
+      puts "\e[31m #{pe.message.gsub("ParseError: ", "")}\n\t#{doc_path}\e[0m"
+      # render expression with error highlighting enabled
+      return KATEX.call("katex.renderToString", expression,
+                          { displayMode: is_in_display_mode,
+                            macros: $global_macros,
+                            throwOnError: false
+                          })
     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)
+  page.output = render_kramdown_notation(page)
 end
 
 Jekyll::Hooks.register :documents, :post_render do |doc|
-  doc.output = render(doc)
+  doc.output = render_kramdown_notation(doc)
+end
+
+Jekyll::Hooks.register :pages, :pre_render do |page|
+  page.content = render_latex_notation(page)
 end
 
+Jekyll::Hooks.register :documents, :pre_render do |doc|
+  doc.content = render_latex_notation(doc)
+end
+
+#######################################################################################
+# SETTINGS AND INIT
+
 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 disabled 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
@@ -155,12 +185,18 @@ Jekyll::Hooks.register :site, :after_reset do
 end
 
 Jekyll::Hooks.register :site, :post_write do
+  # print stats once more to prevent them from being overwriten by error log
+  print_stats
   # 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.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jektex
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.8
 platform: ruby
 authors:
 - Jan Černý
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-22 00:00:00.000000000 Z
+date: 2022-03-22 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
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.3.8
 signing_key:
 specification_version: 4
 summary: Highly optimized latex rendering for Jekyll