jektex 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daa553320105731fb20840fc40d211a73f576f6847b8b3de0019d72313ac0c97
-  data.tar.gz: 4479c3dc694c196845460e4ed63263ad5bb900ed9b3a42fe68e4900001dfccda
+  metadata.gz: db3eb57993f08e73ede3ba763410029942df4d4320c9d659c2b28fabd5a49f4e
+  data.tar.gz: fd8756624b5ff039c66d0896c4c0316dfe4be10045ed412d80240ce17f2e98fd
 SHA512:
-  metadata.gz: 42333a3f6325918d8e1da7c6dd983c3f8404d10b2ae84449076ba768846793ec992af35e6962ebde5c3ae2619dfc2f4c3211370d9c75f6f6883707fbdf355c03
-  data.tar.gz: 24849a110d4ac120fcccab47f357d0c74ae8f7d640dbcd21c7741dc7cf88096aaef6afe088b99a486fe9589e6f67afa13703f09f395ad5c157f6b3ee542c8672
+  metadata.gz: 6645b4a77ccfd8919db211dca542ef3a98ae1dfc9740c74580d74b62f5e1cbaea9ca07dabe14518c3b2cec2b68cfc3406cb5d1ec3a8c840e86b07302acaf7249
+  data.tar.gz: 04b011d1f6e6a7dccc2de68f159ee74a0bdaf7944c7c39fb5d627942425c6665b98803abb601a696d50c1c6ac738cb629086c5149d1ffb8eec636e7e441c854b

data/README.md

@@ -14,6 +14,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
 - Tags places within the rendered documents with syntax errors
+- Highly configurable but still having sensible defaults
 
 ## Usage
 
@@ -60,7 +61,16 @@ To clear cached expressions you have to delete `.jektex-cache` directory in your
 project directory.
 
 **Disabling cache**  
-You can disable caching with `disable_disk_cache = false` in `_config.yml`.
+You can disable caching with `disable_disk_cache = false` in `_config.yml`. Cache is
+enabled by default.
+
+**Setting cache location**  
+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 you just want to
+change location of cache from another reason you can achieve that specifying
+`jektex_cache_dir` in `_config.yml`.
+
+For example: `jektex_cache_dir: ".jektex-cache"`
 
 ## Installation
 This plugin is available as a [RubyGem](https://rubygems.org/gems/jektex).

data/lib/jektex/jektex.rb

@@ -3,14 +3,14 @@ require 'digest'
 require 'htmlentities'
 
 
-PATH_TO_JS = __dir__ + "/katex.min.js"
-CACHE_DIR = "./.jektex-cache/"
+PATH_TO_JS = File.join(__dir__, "/katex.min.js")
+DEFAULT_CACHE_DIR = ".jekyll-cache"
 CACHE_FILE = "jektex-cache.marshal"
-PATH_TO_CACHE = CACHE_DIR + CACHE_FILE
 KATEX = ExecJS.compile(open(PATH_TO_JS).read)
 PARSE_ERROR_PLACEHOLDER = "<b style='color: red;'>PARSE ERROR</b>"
 $global_macros = Hash.new
 $count_newly_generated_expressions = 0
+$path_to_cache = File.join(DEFAULT_CACHE_DIR, CACHE_FILE)
 $cache = nil
 $disable_disk_cache = false
 
@@ -51,7 +51,7 @@ def escape_method( type, string, doc_path )
                           {displayMode: @display,  macros: $global_macros})
     rescue SystemExit, Interrupt
       # save cache to disk
-      File.open(PATH_TO_CACHE, "w"){|to_file| Marshal.dump($cache, to_file)}
+      File.open($path_to_cache, "w"){|to_file| Marshal.dump($cache, to_file)}
       # this stops jekyll being immune to interupts and kill command
       raise
     rescue Exception => e
@@ -80,6 +80,10 @@ Jekyll::Hooks.register :pages, :post_render do |page|
   page.output = convert(page)
 end
 
+Jekyll::Hooks.register :documents, :post_render do |doc|
+  doc.output = convert(doc)
+end
+
 Jekyll::Hooks.register :site, :after_init do |site|
   # load macros from config file
   if site.config["jektex-macros"] != nil
@@ -95,13 +99,19 @@ Jekyll::Hooks.register :site, :after_init do |site|
           ($global_macros.size == 1 ? "" : "s") + " loaded"
   end
 
+  # check if cache is disable in config
   if site.config["disable_disk_cache"] != nil
     $disable_disk_cache = site.config["disable_disk_cache"]
   end
 
+  # check if there is defined custom cache location in config
+  if site.config["jektex_cache_dir"] != nil
+    $path_to_cache = File.join(site.config["jektex_cache_dir"].to_s, CACHE_FILE)
+  end
+
   # 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)}
+  if(File.exist?($path_to_cache))
+    $cache = File.open($path_to_cache, "r"){|from_file| Marshal.load(from_file)}
   else
     $cache = Hash.new
   end
@@ -118,7 +128,7 @@ Jekyll::Hooks.register :site, :post_write do
   # check if caching is enabled
   if $disable_disk_cache == false
     # save cache to disk
-    Dir.mkdir(CACHE_DIR) unless File.exists?(CACHE_DIR)
-    File.open(PATH_TO_CACHE, "w"){|to_file| Marshal.dump($cache, to_file)}
+    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.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jektex
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Jan Černý