jekyll-latex-pdf 0.4.2 → 0.5.0

data/lib/jekyll/latex/pdf/liquid.rb

@@ -6,18 +6,18 @@ module Jekyll
       # Generates an environment where we temporarily can add new tags to the templet,
       # without changing the registered tags.
       class TempLiquid
-        def save_liquid_tags
-          @saved_liquid_tags = Liquid::Template.tags.dup
+
+        def saved_liquid_tags
+          @saved_liquid_tags ||= {}
         end
 
         def register_tag(tag_key, tag_value)
+          saved_liquid_tags[tag_key] = Liquid::Template.tags[tag_key]
           Liquid::Template.register_tag(tag_key, tag_value)
-          @tmp_keys ||= []
-          @tmp_keys << tag_key
         end
 
         def register_tags
-          Options.tags.each do |tag_key, tag_value|
+          TempLiquid.tags.each do |tag_key, tag_value|
             register_tag(tag_key, tag_value)
             Jekyll.logger.debug "Register tag:", tag_key.to_s
           end
@@ -28,22 +28,27 @@ module Jekyll
         end
 
         def restore_liquid_tags
-          tmp_keys.each do |k|
-            if @saved_liquid_tags[k]
-              Liquid::Template.register_tag(k, @saved_liquid_tags[k])
-            else
-              Liquit::Template.tags.delete(k)
-            end
+          saved_liquid_tags.each do |tag_key, tag_value|
+            Liquid::Template.register_tag tag_key, tag_value
           end
         end
 
         def self.run
           s = TempLiquid.new
-          s.save_liquid_tags
           s.register_tags
           yield s
           s.restore_liquid_tags
         end
+
+        def self.tags
+          @@liquid_tags_register || {}
+        end
+
+        def self.register_tag(name, klass)
+          @@liquid_tags_register ||= {}
+          @@liquid_tags_register[name.to_s] = klass
+        end
+
       end
     end
   end

data/lib/jekyll/latex/pdf/scholar/bibliography.rb

@@ -2,10 +2,14 @@
 
 module Jekyll
   module Latex
+    # This module generates pdf files using latex (must be installed on the system) and
+    # should be highly configurable.
     module Pdf
       ## here we add support for jekyll-scholar, a great module for scientific writing.
       module Scholar
+        # Overrides the jekyll-scholar bibliography tag to be used for latex generation.
         class Bibliography < Liquid::Tag
+
           include Utilities
 
           def initialize(tag_name, arguments, tokens)
@@ -16,10 +20,11 @@ module Jekyll
           def render(_context)
             nomarkdown "\\printbibliography"
           end
+
         end
       end
 
-      Options.register_tag("bibliography", Scholar::Bibliography)
+      TempLiquid.register_tag("bibliography", Scholar::Bibliography)
     end
   end
 end

data/lib/jekyll/latex/pdf/scholar/cite.rb

@@ -2,10 +2,14 @@
 
 module Jekyll
   module Latex
+    # This module generates pdf files using latex (must be installed on the system) and
+    # should be highly configurable.
     module Pdf
-      ## here we add support for jekyll-scholar, a great module for scientific writing.
+      # here we add support for jekyll-scholar, a great module for scientific writing.
       module Scholar
+        # Overrides the jekyll-scholar cite tag to be used for generating latex documents.
         class Cite < Liquid::Tag
+
           include Utilities
           def initialize(tag_name, arguments, tokens)
             super
@@ -15,16 +19,17 @@ module Jekyll
 
           def render(_context)
             # set_context_to context+
-            if @keys.is_a? String
+            if @keys.kind_of? String
               nomarkdown "\\parencite\{#{@keys.strip}\}"
             else
-              nomarkdown "\\parencite\{" + @keys.collect { |x| x.strip || x }.join(",") + "\}"
+              nomarkdown "\\parencite\{" + @keys.collect {|x| x.strip || x }.join(",") + "\}"
             end
           end
+
         end
       end
 
-      Options.register_tag("cite", Scholar::Cite)
+      TempLiquid.register_tag("cite", Scholar::Cite)
     end
   end
 end

data/lib/jekyll/latex/pdf/tikz.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "jekyll/latex/pdf/tikz/tikz-html"
+require "jekyll/latex/pdf/tikz/tikz-latex"

data/lib/jekyll/latex/pdf/tikz/tikz-html.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+# Authored my Maxfan http://github.com/Maxfan-zone http://maxfan.org
+# Adjusted to the need of jekyll-latex-pdf by Martin Kaffanke
+# This is used to convert tikz code into svg file and load in you jekyll site
+#
+# Install:
+#
+#   1. Copy this file in your _plugins/ directory. You can customize it, of course.
+#   2. Make sure texlive and pdf2svg are installed on your computer.
+#   3. Set path to pdf2svg in _config.yml in "pdf2svg" variable
+#
+# Input:
+#
+#   {% tikz filename %}
+#     \tikz code goes here
+#   {% endtikz %}
+#
+# This will generate a /img/post-title-from-filename/filename.svg in your jekyll directory
+#
+# And then return this in your HTML output file:
+#
+#   <embed src="/img/post-title-from-filename/tikz-filename.svg" type="image/svg+xml" />
+#
+
+require "open3"
+
+module Jekyll
+  module Latex
+    module Pdf
+      module Tikz
+        class TikzHtml < Liquid::Block
+
+          include Utilities
+
+          attr_reader :config, :site
+
+          def initialize(tag_name, markup, tokens)
+            super
+            @file_name = markup.gsub(/\s+/, "")
+
+            @header = <<-'END'
+        \documentclass{standalone}
+        \usepackage{tikz}
+        \begin{document}
+        \begin{tikzpicture}
+            END
+
+            @footer = <<-'END'
+        \end{tikzpicture}
+        \end{document}
+            END
+
+            @config = Defaults.defaults.dup
+          end
+
+          def render(context)
+            set_context_to context
+
+            tikz_code = @header + super + @footer
+
+            tmp_directory = File.join(Dir.pwd, ".tikz-cache", File.basename(context["page"]["url"], ".*"))
+            tex_path = File.join(tmp_directory, "#{@file_name}.tex")
+            pdf_path = File.join(tmp_directory, "#{@file_name}.pdf")
+            FileUtils.mkdir_p tmp_directory
+
+            dest_directory = File.join(Dir.pwd, @site.config["pdf"]["tikz_path"], File.basename(context["page"]["url"], ".*"))
+            svg_path = File.join(dest_directory, "#{@file_name}.svg")
+            png_path = File.join(dest_directory, "#{@file_name}.png")
+            FileUtils.mkdir_p dest_directory
+
+            # if the file doesn't exist or the tikz code is not the same with the file, then compile the file
+            if !File.exist?(tex_path) || !tikz_same?(tex_path, tikz_code) || !File.exist?(svg_path)
+              File.open(tex_path, 'w') {|file| file.write(tikz_code.to_s) }
+              cmds = [[@site.config["pdf"]["pdf_engine"],
+                       "--interaction=batchmode",
+                       "--output-format=pdf", tex_path],
+                      ["pdf2svg", pdf_path, svg_path],
+                      ["gm", "convert", svg_path, "-quality", "90", png_path]]
+
+              run_cmds cmds, tmp_directory
+            end
+
+            web_svg_path = File.join(@site.config["pdf"]["tikz_path"],
+                                     File.basename(context["page"]["url"], ".*"),
+                                     "#{@file_name}.svg")
+            web_png_path = File.join(@site.config["pdf"]["tikz_path"],
+                                     File.basename(context["page"]["url"], ".*"),
+                                     "#{@file_name}.png")
+            "\n<object data=\"/#{web_svg_path}\" type=\"image/svg+xml\">" \
+              "<img src=\"/#{web_png_path}\" alt=\"#{@file_name}\" />" \
+              "</object>\n"
+          end
+
+          private
+
+          def tikz_same?(file, code)
+            File.open(file, 'r') do |tikzfile|
+              tikzfile.read == code
+            end
+          end
+
+        end
+
+        Liquid::Template.register_tag('tikz', TikzHtml)
+      end
+    end
+  end
+end

data/lib/jekyll/latex/pdf/tikz/tikz-latex.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Latex
+    module Pdf
+      module Tikz
+        class TikzPdf < Liquid::Block
+
+          include Utilities
+
+          def initialize(tag_name, markup, tokens)
+            super
+            #            @file_name = markup.gsub(/\s+/, "")
+
+            @header = <<~'END'
+              \begin{tikzpicture}
+            END
+
+            @footer = <<~'END'
+              \end{tikzpicture}
+            END
+          end
+
+          def render(context)
+            nomarkdown_p(@header + super + @footer)
+          end
+
+        end
+      end
+
+      TempLiquid.register_tag("tikz", Tikz::TikzPdf)
+    end
+  end
+end

data/lib/jekyll/latex/pdf/utilities.rb

@@ -3,10 +3,43 @@
 module Jekyll
   module Latex
     module Pdf
+      # Add methods which can be useful anywhere in the package.
       module Utilities
+        # Surround a string with nomarkdown tags to tell kramdown that this is
+        # plain latex.
         def nomarkdown(string_to_wrap)
           "{::nomarkdown type=\"latex\"}" + string_to_wrap + "{:/}"
         end
+
+        def nomarkdown_p(string_to_wrap)
+          "\n" + nomarkdown(string_to_wrap) + "\n"
+        end
+
+        # Run some commands und stop on errors.
+        def run_cmds(cmds, tempdir)
+          status = 0
+          out = "\n"
+          cmds.each do |cmd|
+            Open3.popen2(*cmd, chdir: tempdir) do |_i, oe, t|
+              oe.each {|l| out += l + "\n" }
+
+              status = t.value
+            end
+            unless 0 == status
+              Jekyll.logger.warn "jekyll-latex-pdf", "Error running #{cmd.join ' '}"
+              Jekyll.logger.warn "Return status: #{status}"
+              Jekyll.logger.warn out
+            end
+          end
+          [out, status]
+        end
+
+        # stolen from jekyll-scholar
+        def set_context_to(context)
+          @context, @site, = context, context.registers[:site]
+          config.merge!(site.config['scholar'] || {})
+          self
+        end
       end
     end
   end

data/lib/jekyll/latex/pdf/version.rb

@@ -3,7 +3,7 @@
 module Jekyll
   module Latex
     module Pdf
-      VERSION = "0.4.2"
+      VERSION = "0.5.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-latex-pdf
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Martin Kaffanke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-21 00:00:00.000000000 Z
+date: 2019-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -160,20 +160,22 @@ files:
 - jekyll-latex-pdf.gemspec
 - lib/jekyll-latex-pdf.rb
 - lib/jekyll/latex/pdf.rb
+- lib/jekyll/latex/pdf/defaults.rb
 - lib/jekyll/latex/pdf/document.rb
+- lib/jekyll/latex/pdf/figure.rb
+- lib/jekyll/latex/pdf/figure/figure.rb
 - lib/jekyll/latex/pdf/generator.rb
+- lib/jekyll/latex/pdf/kramdown_data.rb
 - lib/jekyll/latex/pdf/latex.rb
 - lib/jekyll/latex/pdf/liquid.rb
-- lib/jekyll/latex/pdf/options.rb
 - lib/jekyll/latex/pdf/scholar.rb
 - lib/jekyll/latex/pdf/scholar/bibliography.rb
 - lib/jekyll/latex/pdf/scholar/cite.rb
+- lib/jekyll/latex/pdf/tikz.rb
+- lib/jekyll/latex/pdf/tikz/tikz-html.rb
+- lib/jekyll/latex/pdf/tikz/tikz-latex.rb
 - lib/jekyll/latex/pdf/utilities.rb
 - lib/jekyll/latex/pdf/version.rb
-- rubocop/jekyll.rb
-- rubocop/jekyll/assert_equal_literal_actual.rb
-- rubocop/jekyll/no_p_allowed.rb
-- rubocop/jekyll/no_puts_allowed.rb
 homepage: https://gitlab.com/grauschnabel/jekyll-latex-pdf
 licenses:
 - MIT

data/lib/jekyll/latex/pdf/options.rb

@@ -1,83 +0,0 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Latex
-    module Pdf
-      class Options
-        @@liquid_tags = {}
-        def initialize(*args)
-          template_dirname = File.expand_path(File.join(File.dirname(__FILE__),
-                                                        "..", "..", "..", "..",
-                                                        "data", "kramdown"))
-
-          @options = { :pdf_engine            => "lualatex",
-                       :bib_engine            => "biber",
-                       :template              => File.join(template_dirname, "jekyll-latex-pdf.latex"),
-                       :default_template_path => template_dirname,
-                       :template_path         => "_latex",
-                       :date_as_note          => false, }
-
-          @data = {}
-          @allowed_keys = @options.keys
-
-          add_options(*args)
-        end
-
-        def hash_args(*args)
-          hashed_args = args.detect { |f| f.class == Hash }
-          hashed_args.each_with_object({}) { |(k, v), memo| memo[k.to_sym] = v; }
-        end
-
-        def expand_template(template)
-          template.concat(".latex") unless template.end_with?(".latex")
-        end
-
-        def update_template(template)
-          t = expand_template File.expand_path(File.join(@options[:template_path], template))
-          if File.file? t
-            return t
-          else
-            t = expand_template File.expand_path(File.join(@options[:default_template_path], template))
-            if File.file? t
-              return t
-            else
-              Jekyll.warn "jekyll-latex-pdf", "Could not find template #{t}."
-            end
-          end
-        end
-
-        def add_options(*args)
-          hashed_args = hash_args(*args)
-          hashed_args[:template] = update_template(hashed_args[:template]) if hashed_args[:template]
-
-          allowed_args = hashed_args.select { |key, _| @allowed_keys.include? key }
-          @options.merge! allowed_args
-          add_data(hashed_args.reject { |key, _| @allowed_keys.include? key })
-        end
-
-        def options
-          @options[:data] = @data
-          @options
-        end
-
-        def [](key)
-          @options[key]
-        end
-
-        def add_data(*args)
-          @data.merge! hash_args(*args)
-        end
-
-        attr_reader :data
-
-        def self.tags
-          @@liquid_tags
-          end
-
-        def self.register_tag(name, klass)
-          @@liquid_tags[name.to_s] = klass
-        end
-      end
-    end
-  end
-end