jekyll-tex-eqn 0.9.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e7da3c797d328f1dc308a8eba1c235ef925f4e66c6364f218023d4d6e99131d
-  data.tar.gz: 78439154af7d5e02d9fcc3a39053ba3c9bd737fd5087c43b4c3b559c69feec27
+  metadata.gz: 6bf0089e27fafd98d16aa5d8a8c7d4feaaa9ea1a0fc135bf8afa594936c1501a
+  data.tar.gz: a792c706fff9b4fbd55d3cf5896042e3215a7fb5ef31f0930ba910d4b7038253
 SHA512:
-  metadata.gz: e0e18ffc63f1b4635b28ae93105e7b4d27066b90af9d29b18b904cba6506d4a77242296d24bf8e4fa6c0c816da677f6330526ce1096913d8f8aa416aa47f17f8
-  data.tar.gz: f2c9d78a7cdbc3c82892d5445aaecf84061f74112306ce1bc090c32c017c900ed74621e7eb4469e39bbbc41c607736c760e269f8454880e9708e92a80f22f6bd
+  metadata.gz: b5880241dd57e19b3072a2dcb4cbcbb9081172c6a9496f19d5928a62d2feeefb488e5e7be6216b0079bbe1c6c26fb7709a37890f8072ffe8eb358c9578211474
+  data.tar.gz: 45fda985ffdd7f6f1530f533944db009a786f10eb50f895200f2d0d1eff96f87e9784b6ce4b2ae6d614ecfe159396a9b3894ccdb9e8c01377b1bfe682d73cc61

data/lib/jekyll-tex-eqn.rb

@@ -48,6 +48,7 @@ module Jekyll
       EXTRAHEAD_KEY="extra_head"              # Key for the extra header
       INLINE_SCALE_KEY="inline_scale"         # Key for setting up image scaling for inline equations
       BLOCK_SCALE_KEY="block_scale"           # Key for setting up image scaling for block equations
+      OPTIMIZE_KEY="optimize"                 # Key for enabling SVG optimization using SVGO
   
       # Default values
       DEFAULT_BACKEND="pdflatex"
@@ -61,6 +62,7 @@ module Jekyll
       DEFAULT_OUTPUTDIR="assets/texeqn"
       DEFAULT_INLINE_SCALE="2.4"
       DEFAULT_BLOCK_SCALE="2.4"
+      DEFAULT_OPTIMIZE="false"
 
       # Retrieve Jekyll configuration for this plugin
       @@config = Jekyll.configuration({})[ROOT]
@@ -119,30 +121,49 @@ module Jekyll
       # where to export the SVG, and "pdf", the pdfxx command that performs the
       # TeX => PDF conversion (easier because then this value is calculated only
       # once).
-      def self.run_cmd(base)
+      def self.run_cmd(texbase, svgfile)
         text = ""
 
-        # Cleanup if needed (in case of past error for instanec)
-        if !File.exist?("#{@@basedir}/#{base}") then
-          Dir.mkdir("#{@@basedir}/#{base}")
+        Jekyll.logger.debug("Clean up...")
+
+        # Cleanup if needed (in case of past error for instance)
+        if !File.exist?("#{texbase}") then
+          Dir.mkdir("#{texbase}")
+        end
+
+        # Ensure output dir exists
+        if !File.exist?("#{@@outdir}") then
+          Dir.mkdir("#{@@outdir}")
         end
 
         # Run pdfxx, compile TeX into PDF
-        text = %x|#{@@pdf} -output-directory=#{@@basedir}/#{base}/ #{@@basedir}/#{base}.tex 2>&1|
+        Jekyll.logger.debug("Run LaTeX compiler (#{@pdf})")
+        text = %x|#{@@pdf} -output-directory=#{texbase}/ #{texbase}.tex 2>&1|
         if $?.exitstatus != 0 then
-          raise "[#{base}] Error #{$?.exitstatus} while executing backend:\n#{text}"
+          raise "[#{texbase}] Error #{$?.exitstatus} while executing backend:\n#{text}"
         end
 
         # Use pdfcrop to crop the PDF
-        text = %x|pdfcrop #{@@basedir}/#{base}/output.pdf #{@@basedir}/#{base}/output-crop.pdf 2>&1|
+        Jekyll.logger.debug("Crop PDF")
+        text = %x|pdfcrop #{texbase}/output.pdf #{texbase}/output-crop.pdf 2>&1|
         if $?.exitstatus != 0 then
-          raise "[#{base}] Error #{$?.exitstatus} while croping PDF:\n#{text}"
+          raise "[#{texbase}] Error #{$?.exitstatus} while croping PDF:\n#{text}"
         end
-        
+
         # Use pdf2svg to transform the cropped PDF into an SVG
-        text = %x|pdf2svg #{@@basedir}/#{base}/output-crop.pdf #{@@outdir}/#{base}.svg 2>&1|
+        Jekyll.logger.debug("Convert PDF to SVG")
+        text = %x|pdf2svg #{texbase}/output-crop.pdf #{svgfile} 2>&1|
         if $?.exitstatus != 0 then
-          raise "[#{base}] Error #{$?.exitstatus} while generating SVG:\n#{text}"
+          raise "[#{texbase}] Error #{$?.exitstatus} while generating SVG:\n#{text}"
+        end
+
+        # Optional: optimzie SVG using SVGO
+        if Util.get_option(Util::OPTIMIZE_KEY, Util::DEFAULT_OPTIMIZE) == "true" then
+          Jekyll.logger.debug("Optimize SVG file")
+          text = %x|svgo -i #{svgfile}|
+          if $?.exitstatus != 0 then
+            raise "[#{svgfile}] Error #{$?.exitstatus} while optimizeing SVG:\n#{text}"
+          end
         end
 
       end
@@ -154,8 +175,10 @@ module Jekyll
       # a hash function on the content to obtain (virtually) unique names.
       def self.filename(filepath, content)
         id = Digest::MD5.hexdigest content
-        pagepath = filepath
-        pagepath.gsub("/", "_").gsub(" ", "-")
+        pagepath = filepath.gsub("/", "_").gsub(" ", "-")
+        while pagepath[0] == '_' do # Weird jekyll behaviour: files starting with an underscore are not copied during build
+          pagepath = pagepath[1..-1]
+        end
         "#{pagepath}-#{id}"
       end
   
@@ -195,7 +218,8 @@ module Jekyll
         content.strip!
         path = context.registers[:page]['path']
         file = Generate.filename(path, content)
-        texfile = "#{@@basedir}/#{file}.tex"
+        texbase = "#{@@basedir}/#{file}"
+        texfile = "#{texbase}.tex"
         svgfile = "#{@@outdir}/#{file}.svg"
 
         # If the SVG file already exists, no need to re-render it (usually)
@@ -204,9 +228,10 @@ module Jekyll
         if !File.exist?(texfile) && !File.exist?(svgfile) then
           Jekyll.logger.info("Generating image file #{file}")
           Generate.generate_file(context, content, begineqn, endeqn, texfile)
-          Generate.run_cmd(file)
+          Jekyll.logger.info("Processing file #{file}")
+          Generate.run_cmd(texbase, svgfile)
           File.delete(texfile)
-          if File.exist?("#{@@basedir}/#{file}") then
+          if File.exist?(texbase) then
             FileUtils.remove_dir("#{@@basedir}/#{file}")
           end
         end
@@ -232,6 +257,7 @@ module Jekyll
 
       def render(context)
         svg = Generate.do_render(context, @content, Util.get_option(Util::INLINE_SCALE_KEY, Util::DEFAULT_INLINE_SCALE).to_f, "$", "$")
+
         "<span class='#{Util.get_option(Util::INLINE_CLASS_KEY, "")}'><img width='#{svg[:width]}px' height='#{svg[:height]}px' src='/#{svg[:file]}'/></span>"
       end
     end
@@ -243,6 +269,7 @@ module Jekyll
       def render(context)
         content = super
         svg = Generate.do_render(context, content, Util.get_option(Util::BLOCK_SCALE_KEY, Util::DEFAULT_BLOCK_SCALE).to_f, "\\begin{displaymath}\n", "\n\\end{displaymath}")
+
         "<div class='#{Util.get_option(Util::BLOCK_CLASS_KEY, "")}'><img width='#{svg[:width]}px' height='#{svg[:height]}px' src='/#{svg[:file]}'/></div>"
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-tex-eqn
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 1.0.1
 platform: ruby
 authors:
 - krab5
@@ -33,42 +33,54 @@ dependencies:
   name: digest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: fileutils
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
 email: crab.delicieux@gmail.com
@@ -88,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="