jekyll-latex-pdf 0.4.2 → 0.5.0

data/bin/setup

@@ -1,7 +1,9 @@
 #!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
+# frozen_string_literal: true
+
+# set -euo pipefail
+# IFS=$'\n\t'
+# set -vx
 
 bundle install
 

data/data/kramdown/apa6.latex

@@ -29,7 +29,9 @@ enclang = {
 
 \usepackage{amsmath}
 \usepackage{graphicx}
-\usepackage[colorinlistoftodos]{todonotes}
+%\usepackage[colorinlistoftodos]{todonotes}
+\usepackage{tikz}
+
 
 \usepackage{hyperref}
 \hypersetup{
@@ -64,6 +66,10 @@ urlcolor=black
 <% if data[:note] %>\note{<%= data[:note] %>}<% end %>
 <% if data[:authornote] %>\authornote{<%= data[:authornote] %>}<% end %>
 <% if data[:keywords] %>\keywords{<%= data[:keywords] %>}<% end %>
+<% if data[:journal] %>\journal{<%= data[:journal] %>}<% end %>
+<% if data[:volume] %>\volume{<%= data[:volume] %>}<% end %>
+<% if data[:ccoppy] %>\ccoppy{<%= data[:ccoppy] %>}<% end %>
+<% if data[:copnum] %>\copnum{<%= data[:copnum] %>}<% end %>
 
 \begin{document}
 <% if data[:title] %>

data/data/kramdown/jekyll-latex-pdf.latex

@@ -37,6 +37,7 @@ enclang = {
 \usepackage{listings}
 <% @converter.data[:packages].each {|pkg| %>\usepackage{<%= pkg %>}
 <% } %>
+\usepackage{tikz}
 \usepackage{hyperref}
 
 <% if data[:lang] %>

data/jekyll-latex-pdf.gemspec

@@ -29,6 +29,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rubocop", "~> 0.67"
   spec.add_development_dependency "jekyll-scholar", "~> 5.14.1"
+  #spec.add_development_dependency "minitest", "~> 5.0.0"
+  #spec.add_development_dependency "rouge"
+  #spec.add_development_dependency "stringex", "~> 1.5.1"
 
   spec.add_runtime_dependency "jekyll", "~> 3.8.5"
   spec.add_runtime_dependency "kramdown", "~> 1.17"

data/lib/jekyll/latex/pdf.rb

@@ -1,15 +1,20 @@
 # frozen_string_literal: true
 
-require "jekyll/latex/pdf/options"
+require "jekyll/latex/pdf/defaults"
+require "jekyll/latex/pdf/kramdown_data"
 require "jekyll/latex/pdf/utilities"
 require "jekyll/latex/pdf/liquid"
 
-# having jekyll-scholar installed?
-if Jekyll.configuration({})["plugins"].include? "jekyll-scholar"
-  require "jekyll/scholar"
+if Jekyll::External.require_if_present "jekyll/scholar"
   require "jekyll/latex/pdf/scholar"
 end
 
+if Jekyll::External.require_if_present "jekyll/figure"
+  require "jekyll/latex/pdf/figure"
+end
+
+require "jekyll/latex/pdf/tikz"
+
 require "jekyll/latex/pdf/latex"
 require "jekyll/latex/pdf/document"
 require "jekyll/latex/pdf/generator"

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Latex
+    # Default values for configuration.
+    module Pdf
+      class Defaults
+
+        # Defaults
+        @defaults = {
+
+          # Engine to render latex to pdf.
+          "pdf_engine" => "lualatex",
+
+          # Default binary to handle bibtex files.  Using biblatex for default.
+          "bib_engine" => "biber",
+
+          # Default template to use
+          "template" => "jekyll-latex-pdf",
+
+          # Template path under site
+          "template_path" => "_latex",
+
+          # Use the date in the \note command instead of the \date.  Usefull for apa6
+          "date_as_note" => false,
+
+          # Set the path where the rendered svg files should be stored.
+          "tikz_path" => "assets/tikz",
+        }
+        class << self
+
+          def prepare_defaults
+            @defaults["default_template_path"] = File.expand_path(File.join(File.dirname(__FILE__),
+                                                                            "..", "..", "..", "..",
+                                                                            "data", "kramdown"))
+          end
+
+          def defaults
+            prepare_defaults
+            @defaults
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -8,6 +8,7 @@ module Jekyll
     module Pdf
       # The document adds the file.
       class Document < Jekyll::Page
+
         attr_accessor :source
 
         def initialize(site, page)
@@ -16,7 +17,7 @@ module Jekyll
           @dir = File.dirname(page.url)
           @name = File.basename(page.url, File.extname(page.url)) + ".pdf"
           @texname = File.basename(page.url, File.extname(page.url)) + ".tex"
-          @settings = site.config.key?("pdf") ? site.config["pdf"].clone : {}
+          #          @settings = site.config["pdf"] ? site.config["pdf"].clone : {}
 
           process(@name)
 
@@ -27,34 +28,51 @@ module Jekyll
           # data["layout"] = layout
           data["html_url"] = page.url
           data["date_str"] = data["date"].strftime("%Y-%m-%d")
-          @options = Options.new @settings
-          @options.add_data data
+          @config = Defaults.defaults.merge(site.config["pdf"] || {})
+
+          @kramdowndata = KramdownData.new data
+          @kramdowndata.add(site.config["pdf"] || {})
 
           check_scholar
         end
 
         def check_scholar
-          if Jekyll.configuration({})["plugins"].include? "jekyll-scholar"
-            (class <<self; include Jekyll::Scholar::Utilities; end)
+          if @site.config["plugins"].include? "jekyll-scholar"
+            # (class <<self; include Jekyll::Scholar::Utilities; end)
             # getting bibtex files
-            @config = Jekyll::Scholar.defaults.dup
-            @options.add_data(:bibtex_files => bibtex_files.map { |bibfile| File.join(config["source"], bibfile) })
+            #            @config = Jekyll::Scholar.defaults.dup
+            # config = @site.config["scholar"]
+            @kramdowndata.add(bibtex_files: bibtex_files.map do |bibfile|
+                                              File.join(@site.config["scholar"]["source"], bibfile)
+                                            end)
           end
         end
 
         def permalink
-          data.key? "permalink" ? nil : (data["permalink"] + ext)
+          data.key?("permalink") ? (data["permalink"] + ext) : nil
         end
 
         def write(dest)
           path = File.join(dest, CGI.unescape(url))
 
-          latex = Latex.new(source, @site, @options)
-          if latex.compile == 0
+          latex = Latex.new(source, @site, @kramdowndata, @name)
+          if 0 == latex.compile
             FileUtils.cp(latex.pdf_file, path)
             Jekyll.logger.debug "cp " + latex.pdf_file.to_s + " " + path.to_s
           end
         end
+
+        def bibtex_files
+          if @site.config["scholar"]['bibliography'].include? '*'
+            @bibtex_files ||= Dir.glob(File.join(@site.config["scholar"]["source"],
+                                                 @site.config["scholar"]["bibliography"])).
+              collect do |f|
+              Pathname(f).relative_path_from(Pathname(@site.config["scholar"]['source'])).to_s
+            end
+          end
+          @bibtex_files ||= [@site.config["scholar"]['bibliography']]
+        end
+
       end
     end
   end

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

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require "jekyll/latex/pdf/figure/figure"

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+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 Figure
+        # Overrides the Figure tag from jekyll-figure
+        class FigureTag < Liquid::Block
+
+          include Utilities
+
+          def initialize(tag_name, markup, tokens)
+            @markup = markup
+            super
+          end
+
+          def render(context)
+            # Render any liquid variables
+            markup = Liquid::Template.parse(@markup).render(context)
+
+            # Extract tag attributes
+            attributes = {}
+            markup.scan(Liquid::TagAttributes) do |key, value|
+              attributes[key] = value
+            end
+
+            @caption = attributes["caption"] if attributes.include? "caption"
+            @label = attributes["label"] if attributes.include? "label"
+
+            # Caption: convert markdown and remove paragraphs
+            unless @caption.nil?
+              figure_caption = @caption.gsub!(/\A"|"\Z/, "")
+              #              figure_caption = converter.convert(figure_caption).gsub(/<\/?p[^>]*>/, "").chomp
+              #              figure_caption = "  <figcaption>#{figure_caption}</figcaption>\n"
+              figure_caption = Kramdown::Document.new(figure_caption).to_latex.strip
+              figure_caption = "\\caption{#{figure_caption}}\n"
+            end
+
+            figure_main = super context
+
+            # render figure
+            figure_latex = nomarkdown_p "\\begin{figure}"
+            figure_latex += nomarkdown_p "\\centering"
+            figure_latex += figure_main.to_s
+            figure_latex += nomarkdown_p figure_caption.to_s
+            figure_latex += nomarkdown_p "\\label{#{@label}}" unless @label.nil?
+            figure_latex + nomarkdown_p("\\end{figure}")
+          end
+
+        end
+      end
+      TempLiquid.register_tag("figure", Figure::FigureTag)
+    end
+  end
+end

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

@@ -2,16 +2,28 @@
 
 module Jekyll
   module Latex
+    # This module generates pdf files using latex (must be installed on the system) and
+    # should be highly configurable.
     module Pdf
+      # The generator acutally generates pdf files for posts with `pdf: true` in the yaml header.
       class Generator < Jekyll::Generator
+
         safe true
         priority :lowest
 
+        attr_reader :config
+
         def generate(site)
-          site.posts.docs.each do |post|
-            site.pages << Document.new(site, post) if post.data["pdf"]
+          @site, @config = site, Defaults.defaults.merge(site.config["pdf"] || {})
+
+          @site.config["pdf"].merge! @config
+          @site.config["exclude"].concat [".latex-cache" + File::SEPARATOR, ".tikz-cache" + File::SEPARATOR]
+
+          @site.posts.docs.each do |post|
+            @site.pages << Document.new(@site, post) if post.data["pdf"]
           end
         end
+
       end
     end
   end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Latex
+    module Pdf
+
+      # Hold data for kramdown renderer.  We have some extra things added to the
+      # default post content.
+      class KramdownData
+
+        def initialize(*args)
+          add(*args)
+        end
+
+        def add(*args)
+          @data ||= {}
+          @data.merge! hash_args(*args)
+        end
+
+        attr_reader :data
+
+        private
+
+        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
+
+      end
+    end
+  end
+end

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

@@ -1,67 +1,91 @@
 # frozen_string_literal: true
 
-require "tmpdir"
 require "open3"
-# require 'fileutils'
 
 module Jekyll
   module Latex
     module Pdf
       # The Latex Class will create the tex file and compile it to the pdf file.
       class Latex < Jekyll::Document
+
+        include Utilities
+
         attr_accessor :source, :latex
         attr_reader :pdf_file
-        def initialize(source, site, options)
-          @options = options
-          @engine = @options.options[:pdf_engine]
-          @bibengine = @options.options[:bib_engine]
+        def initialize(source, site, data, name)
+          #        @options = options
+          @kramdowndata = data
           @site = site
+          @name = name
+          @engine = @site.config["pdf"]["pdf_engine"] # @options.options[:pdf_engine]
+          @bibengine = @site.config["pdf"]["bib_engine"] # @options.options[:bib_engine]
 
           @source = source
         end
 
+        def find_template
+          template = @site.config["pdf"]["template"]
+
+          template.concat(".latex") unless template.end_with?(".latex")
+
+          t = File.expand_path(File.join(@site.config["pdf"]["template_path"], template))
+          if File.file? t
+            return t
+          else
+            t = File.expand_path(File.join(@site.config["pdf"]["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 prepare_latex
           TempLiquid.run do
-            liquid_parsed = Liquid::Template.parse(@source, :error_mode => :strict)
+            liquid_parsed = Liquid::Template.parse(@source, error_mode: :strict)
             unless liquid_parsed.errors.empty?
               Jekyll.logger.warn("Liquid parse errors", liquid_parsed.errors.join(", "))
             end
-            prep_latex = liquid_parsed.render(:strict_filters   => true,
-                                              :strict_variables => true)
+            prep_latex = liquid_parsed.render(strict_filters: true,
+                                              strict_variables: true)
             unless liquid_parsed.errors.empty?
-              Jekyll.logger.warn("Liquid render errors", liquid_parsed.errors.join(", "))
+              Jekyll.logger.warn liquid_parsed.errors.join ", "
             end
-            @latex = Kramdown::Document
-              .new(prep_latex, @options.options)
-              .to_latex
+            options = {"data" => @kramdowndata.data,
+                       "template" => find_template}
+            @latex = Kramdown::Document.
+              new(prep_latex, options).
+              to_latex
           end
         end
 
         def prepare_abstract
           # only when excerpt is present
-          unless @options.data.key? :abstract
+          unless @kramdowndata.data.key? :abstract
             Jekyll.logger.debug "Abstract missing. This may be ok for your latex template."
-            if @options.data.key? :excerpt
+            if @kramdowndata.data.key? :excerpt
               Jekyll.logger.debug "Trying to get the abstract from the excerpt."
               abstract, _, @source = @source.to_s.partition(excerpt_separator)
-              @options.add_data(:abstract => Kramdown::Document.new(abstract).to_latex)
+              @kramdowndata.add(abstract: Kramdown::Document.new(abstract).to_latex)
             end
-          end
+           end
         end
 
         def prepare_date_as_note
-          @options.add_data(:note => "\\printdate{#{@options.data[:date_str]}}")
+          @kramdowndata.add(note: "\\printdate{#{@kramdowndata.data[:date_str]}}")
         end
 
         def prepare
           prepare_abstract
-          prepare_date_as_note if @options[:date_as_note]
+          prepare_date_as_note if @site.config["pdf"]["date_as_note"]
           prepare_latex
 
-          @tempdir = Dir.mktmpdir("jekyll-latex-pdf")
-          @latexfile = "texput.tex" # File.join(@tempdir, "texput.tex")
+          basename = File.basename(@name, ".*")
+          @tempdir = File.join(Dir.pwd, ".latex-cache", basename)
+          FileUtils.mkdir_p @tempdir
+          @latexfile = basename + ".tex"
 
-          # puts "writing to #{@latexfile}:", latex
           File.open(File.join(@tempdir, @latexfile), "w:UTF-8") do |f|
             f.write(latex)
           end
@@ -70,25 +94,30 @@ module Jekyll
         end
 
         def add_bibliography
-          if @options.data.key? :bibtex_files
-            @options.data[:bibtex_files].each do |bibfile|
-              bibpath = File.join(@tempdir, File.dirname(bibfile))
-              FileUtils.mkdir_p bibpath unless File.directory? bibpath
-              FileUtils.cp(bibfile, bibpath)
+          if @kramdowndata.data.key? :bibtex_files
+            @kramdowndata.data[:bibtex_files].each do |bibfile|
+              bib_target = File.join(@tempdir, bibfile)
+              if File.exist?(bib_target)
+                unless FileUtils.compare_file(bibfile, bib_target)
+                  FileUtils.cp(bibfile, bib_target)
+                end
+              else
+                FileUtils.mkdir_p File.dirname(bib_target)
+                FileUtils.cp(bibfile, bib_target)
+              end
             end
           end
         end
 
         def prepare_cmds
-          cmds = [[@options.options[:pdf_engine],
-                   # "--output-directory=#{@tempdir}",
+          cmds = [[@site.config["pdf"]["pdf_engine"],
                    "--output-format=pdf",
                    "--interaction=batchmode",
-                   @latexfile,]]
+                   @latexfile]]
           # biber if bibfiles given
-          if @options.data.key? :bibtex_files
-            cmds << [@options.options[:bib_engine],
-                     File.basename(@latexfile, File.extname(@latexfile)),]
+          if @kramdowndata.data.key? :bibtex_files
+            cmds << [@site.config["pdf"]["bib_engine"],
+                     File.basename(@latexfile, File.extname(@latexfile))]
             cmds << cmds[0]
           end
           cmds
@@ -98,29 +127,23 @@ module Jekyll
           prepare
           cmds = prepare_cmds
 
-          Jekyll.logger.info "jekyll-latex-pdf", "compiling in tempdir: #{@tempdir}"
+          Jekyll.logger.debug "jekyll-latex-pdf", "compiling in tempdir: #{@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
-          end
+          out, status = run_cmds cmds, @tempdir
 
-          # puts stdout_str
-          if status == 0
-            @pdf_file = File.join(@tempdir, "texput.pdf")
+          if 0 == status
+            @pdf_file = File.join(@tempdir, File.basename(@latexfile, ".*") + ".pdf")
           else
-            # puts stdout_str
-            Jekyll.logger.error "jekyll-latex-pdf", "Error when trying to run #{@options.options[:pdf_engine]}."
+            Jekyll.logger.error "jekyll-latex-pdf",
+                                "Error when trying to run #{@site.config['pdf']['pdf_engine']}."
             Jekyll.logger.error "jekyll-latex-pdf", "status: #{status}"
-            Jekyll.logger.error "jekyll-latex-pdf", "output: #{out}"
-            Jekyll.logger.error "jekyll-latex-pdf", "See #{@tempdir}/texput.log"
+            Jekyll.logger.error "jekyll-latex-pdf",
+                                "Hint: Try to run #{site.config['pdf']['pdf_engine']} \
+              inside #{@tempdir} by hand."
           end
           status
         end
+
       end
     end
   end