jekyll-pandoc-multiple-formats-jekyll34 0.2.10 → 0.2.12

data/lib/jekyll-pandoc-multiple-formats-jekyll34/converter.rb

@@ -0,0 +1,81 @@
+# Copyright (c) 2012-2015 Nicolás Reynolds <fauno@endefensadelsl.org>
+#               2012-2013 Mauricio Pasquier Juan <mpj@endefensadelsl.org>
+#               2013      Brian Candler <b.candler@pobox.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+# Namespacing and metaprogramming FTW
+module JekyllPandocMultipleFormats
+  # Determines the correct module where it lives the converter
+  def self.namespace
+    Jekyll::VERSION >= '1.0.0' ? Jekyll::Converters : Jekyll
+  end
+
+  # Determines the correct class name. Jekyll has the converters class kinda
+  # hardcoded
+  def self.class_name
+    Jekyll::VERSION >= '1.0.0' ? 'Markdown' : 'MarkdownConverter'
+  end
+
+  def self.build
+    namespace::const_get(class_name).send :include, ConverterMethods
+  end
+
+  # When included in the correspondant markdown class this module redefines the
+  # three needed Converter instance methods
+  module ConverterMethods
+    def self.included(base)
+      base.class_eval do
+        # Just return html5
+        def convert(content)
+          flags  = "#{@config['pandoc']['flags']} #{@config['pandoc']['site_flags']}"
+
+          output = ''
+          Dir::chdir(@config['source']) do
+            Open3::popen3("pandoc -t html5 #{flags}") do |stdin, stdout, stderr, thread|
+              stdin.puts content
+              stdin.close
+
+              output = stdout.read.strip
+              STDERR.print stderr.read
+
+              # Wait for the process to finish
+              thread.value
+            end
+          end
+
+          output
+        end
+
+        def matches(ext)
+          rgx = '(' + @config['markdown_ext'].gsub(',','|') +')'
+          ext =~ Regexp.new(rgx, Regexp::IGNORECASE)
+        end
+
+        def output_ext(ext)
+          '.html'
+        end
+      end
+    end
+  end
+end
+
+# Conjures the metamagic
+JekyllPandocMultipleFormats.build

data/lib/jekyll-pandoc-multiple-formats-jekyll34/generator.rb

@@ -0,0 +1,110 @@
+# Copyright (c) 2012-2015 Nicolás Reynolds <fauno@endefensadelsl.org>
+#               2012-2013 Mauricio Pasquier Juan <mpj@endefensadelsl.org>
+#               2013      Brian Candler <b.candler@pobox.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module Jekyll
+
+class PandocGenerator < Generator
+  safe true
+
+  attr_accessor :site, :config
+
+  def generate(site)
+    @site     ||= site
+    @config   ||= JekyllPandocMultipleFormats::Config.new(@site.config['pandoc'])
+
+    return if @config.skip?
+
+    # we create a single array of files
+    @pandoc_files = []
+
+    @config.outputs.each_pair do |output, extra_flags|
+      @site.posts.docs.each do |post|
+
+        pandoc_file = PandocFile.new(@site, output, post)
+        next unless pandoc_file.write
+
+        @site.keep_files << pandoc_file.relative_path
+        @pandoc_files << pandoc_file
+      end
+
+      @site.post_attr_hash('categories').each_pair do |title, posts|
+        posts.sort!
+        pandoc_file = PandocFile.new(@site, output, posts, title)
+
+        if @site.keep_files.include? pandoc_file.relative_path
+          puts "#{pandoc_file.relative_path} is a category file AND a post file"
+          puts 'change the category name to fix this'
+          next
+        end
+
+        next unless pandoc_file.write
+
+        @site.keep_files << pandoc_file.relative_path
+        @pandoc_files << pandoc_file
+      end
+    end
+
+    @pandoc_files.each do |pandoc_file|
+      # If output is PDF, we also create the imposed PDF
+      if pandoc_file.pdf?
+
+        if @config.imposition?
+
+          imposed_file = JekyllPandocMultipleFormats::Imposition
+            .new(pandoc_file.path, pandoc_file.papersize,
+            pandoc_file.sheetsize, pandoc_file.signature)
+
+          imposed_file.write
+          @site.keep_files << imposed_file.relative_path(@site.dest)
+        end
+
+        # If output is PDF, we also create the imposed PDF
+        if @config.binder?
+
+          binder_file = JekyllPandocMultipleFormats::Binder
+            .new(pandoc_file.path, pandoc_file.papersize,
+            pandoc_file.sheetsize)
+
+          binder_file.write
+          @site.keep_files << binder_file.relative_path(@site.dest)
+        end
+
+        # Add covers to PDFs after building ready for print files
+        if pandoc_file.has_cover?
+          # Generate the cover
+          next unless pandoc_file.pdf_cover!
+          united_output = pandoc_file.path.gsub(/\.pdf\Z/, '-cover.pdf')
+          united_file = JekyllPandocMultipleFormats::Unite
+            .new(united_output, [pandoc_file.pdf_cover,pandoc_file.path])
+
+          if united_file.write
+            # Replace the original file with the one with cover
+            FileUtils.rm_f(pandoc_file.path)
+            FileUtils.mv(united_output, pandoc_file.path)
+          end
+        end
+      end
+    end
+  end
+end
+end

data/lib/jekyll-pandoc-multiple-formats-jekyll34/imposition.rb

@@ -0,0 +1,97 @@
+# Copyright (c) 2012-2015 Nicolás Reynolds <fauno@endefensadelsl.org>
+#               2012-2013 Mauricio Pasquier Juan <mpj@endefensadelsl.org>
+#               2013      Brian Candler <b.candler@pobox.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module JekyllPandocMultipleFormats
+  class Imposition < Printer
+
+    attr_accessor :rounded_pages, :blank_pages, :signature
+
+    def initialize(file, papersize = nil, sheetsize = nil, signature = nil, extra_options = nil)
+      super(file, papersize, sheetsize, extra_options)
+      @output_file   = file.gsub(/\.pdf\Z/, '-imposed.pdf')
+      # Total pages must be modulo 4
+      @rounded_pages = round_to_nearest(@pages, 4)
+      @blank_pages   = @rounded_pages - @pages
+      # If we don't use a signature, make a single fold
+      @signature     = signature || @rounded_pages
+      # Also if we specified 0
+      @signature     = @rounded_pages if signature == 0
+
+      render_template
+      self
+    end
+
+    def to_nup
+      # 14 pages example:
+      # [ {}, 1, 2, {}, 14, 3, 4, 13, 12, 5, 6, 11, 10, 7, 8, 9 ]
+      #
+      # * Add {} to missing pages
+      #   [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, {}, {}]
+      # * Take first half [ 1, 2, 3, 4, 5, 6, 7, 8 ]
+      # * Reverse second half [ {}, {}, 14, 13, 12, 11, 10, 9 ]
+      # * Intercalate the first half into the second half by two
+      #   elements
+      #   [ {}, 1, 2, {}, 14, 3, 4, 13, 12, 5, 6, 11, 10, 7, 8, 9 ]
+      #
+      # An array of numbered pages padded with blank pages ('{}')
+      #
+      # [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14 ] + [ '{}', '{}' ]
+      padded = @pages.times.map{|i|i+1} + Array.new(@blank_pages, '{}')
+
+      # If we have a signature, we have to split in groups up to the
+      # amount of pages per signature, and then continue with the rest
+      #
+      # If we have no signature, we assume it's equal to the total
+      # amount of pages, so you only have one fold
+      signed = padded.each_slice(@signature).to_a
+      folds = []
+      signed.each do |fold|
+        #
+        # Split in halves
+        # [ [ 1, 2, 3, 4, 5, 6, 7, 8 ],
+        #   [ 9, 10, 11, 12, 13, 14, '{}', '{}' ] ]
+        halved = fold.each_slice(fold.size / 2).to_a
+        # Add a nil as last page.  When we reverse it and intercalate by
+        # two pages, we'll have [nil, last_page] instead of
+        # [last_page,second_to_last_page]
+        #
+        # [ [ 1, 2, 3, 4, 5, 6, 7, 8 ],
+        #   [ 9, 10, 11, 12, 13, 14, '{}', '{}', nil ] ]
+        halved.last << nil
+        # Reverse the second half and intercalate by two pages into the
+        # first one.  Then remove nil elements and flatten the array.
+        #
+        # [ [ 1, 2, 3, 4, 5, 6, 7, 8 ],
+        #   [ nil, '{}', '{}', 14, 13, 12, 11, 10 ] ]
+        #
+        # [ {}, 1, 2, {}, 14, 3, 4, 13, 12, 5, 6, 11, 10, 7, 8, 9 ]
+        folds << halved.last.reverse.each_slice(2).zip(halved.first.each_slice(2).to_a).flatten.compact
+      end
+
+      # Create the matrix of pages (N-Up) per fold
+      #
+      # ["{}", 1, "{}", 1, 2, "{}", 2, "{}", 14, 3, 14, 3, 4, 13, 4, 13, 12, 5, 12, 5, 6, 11, 6, 11, 10, 7, 10, 7, 8, 9, 8, 9]
+      folds.map { |o| o.each_slice(2).map{ |i| a=[]; (@nup/2).times { a = a+i }; a }}.flatten
+    end
+  end
+end

data/lib/jekyll-pandoc-multiple-formats-jekyll34/pandoc_file.rb

@@ -0,0 +1,276 @@
+# Copyright (c) 2012-2015 Nicolás Reynolds <fauno@endefensadelsl.org>
+#               2012-2013 Mauricio Pasquier Juan <mpj@endefensadelsl.org>
+#               2013      Brian Candler <b.candler@pobox.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+# 
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+module Jekyll
+  class PandocFile
+    include Convertible
+
+
+    attr_reader :format, :site, :config, :flags, :posts, :slug, :title, :url
+    attr_reader :papersize, :sheetsize, :signature
+
+    def initialize(site, format, posts, title = nil)
+      @site   = site
+      @config = JekyllPandocMultipleFormats::Config.new(@site.config['pandoc']).config
+      @format = format
+      @flags  = []
+
+      if posts.is_a? Array
+        @posts = posts
+
+        raise ArgumentError.new "'title' argument is required for multipost file" unless title
+
+        @title = title
+      else
+        @posts = [posts]
+        @title = posts.data['title'] unless title
+      end
+
+      @slug  = Utils.slugify(title)
+    end
+
+    def path
+      # path is full destination path with all elements of permalink
+      path = @site.in_dest_dir(relative_path)
+    end
+
+    def relative_path
+      path = URL.unescape_path(url)
+      path.gsub! /^\//, ''
+
+      # but if the post is going to be index.html, use slug + format
+      # (ie /year/month/slug/slug.pdf)
+      if url.end_with? '/'
+        path = File.join(path, @slug)
+        path << '.'
+        path << @format
+      end
+
+      path
+    end
+
+    # if it's just one article, the url is the same except it's not html
+    # otherwise we use the permalink template with some placeholder
+    def url
+      @url = if single_post?
+        single_post.url.gsub(/\.html$/, ".#{@format}")
+      else
+        URL.new({
+          template: @config['bundle_permalink'],
+          placeholders: url_placeholders,
+          permalink: nil }).to_s
+      end
+    end
+
+    def url_placeholders
+      { output_ext: @format,
+        slug: @slug,
+        title: @title }
+    end
+
+    # adds post metadata as yaml metadata
+    def yaml_metadata
+      if single_post?
+
+        # if we were to merge config to data, the default options would
+        # take precedence
+        data = Jekyll::Utils.deep_merge_hashes @config, single_post.data
+        single_post.merge_data! data
+
+
+        # we extract the excerpt because it serializes as an object and
+        # breaks pandoc
+        metadata = single_post.data.reject{ |k| k == 'excerpt' }
+
+        if @config['date_format']
+          metadata['date'] = metadata['date'].strftime(@config['date_format'])
+        else
+          metadata.delete('date')
+        end
+      else
+        # we have to use this fugly syntax because jekyll doesn't do
+        # symbols
+        metadata = {
+          'date'      => @config['date_format'] ? Date.today.strftime(@config['date_format']) : nil,
+          'title'     => @title,
+          'author'    => nil,
+          'papersize' => papersize,
+          'sheetsize' => sheetsize,
+          'signature' => signature
+        }
+      end
+
+      # fix page sizes, pandoc uses 'A4' while printer.rb uses
+      # 'a4paper'
+      %w[papersize sheetsize].each do |size|
+        metadata[size] = fix_size metadata[size]
+      end
+
+      metadata.to_yaml << "\n---\n"
+    end
+
+    def content
+      if single_post?
+        single_post.content
+      else
+        header_re = /^(#+.*\n*|.*\n[=-]+\n*)\Z/
+        bib_title = ""
+        @posts.map do |post|
+          bib_title = post.content.match(header_re).to_s if bib_title.empty?
+          # remove bibliography titles
+          # since pandoc does it's own bibliography output, it recommends
+          # leaving an empty chapter title to mark it as such
+          post.content.gsub(header_re, '')
+        # we add the first bibliography title we can find in the end
+        end.join("\n\n\n") << bib_title
+      end
+    end
+
+    def write
+      FileUtils.mkdir_p(File.dirname(path))
+      # Remove the file before creating it
+      FileUtils.rm_f(path)
+      # Move to the source dir since everything will be relative to that
+      Dir::chdir(@site.config['source']) do
+        # Do the stuff
+        Open3::popen3(command) do |stdin, stdout, stderr, thread|
+          stdin.puts yaml_metadata
+          stdin.puts content
+          stdin.close
+          STDERR.print stderr.read
+
+          # Wait for the process to finish
+          thread.value
+        end
+      end
+
+      File.exists?(path)
+    end
+
+    # Returns a cover, without checking if it exists
+    #
+    # It assumes covers are in PNG format
+    def cover
+      if single_post? && single_post.data['cover']
+        File.join(@site.config['source'], single_post.data['cover'])
+      else
+        File.join(@site.config['source'], @config['covers_dir'], "#{@slug}.png")
+      end
+    end
+
+    # Returns a PDF cover
+    def pdf_cover
+      cover.gsub(/\.[^\.]+\Z/, '.pdf')
+    end
+
+    def pdf_cover!
+      if has_cover? && !File.exists?(pdf_cover)
+        Open3::popen3("convert \"#{cover}\" \"#{pdf_cover}\"") do |stdin, stdout, stderr, thread|
+          STDERR.print stderr.read
+
+          # Wait for the process to finish
+          thread.value
+        end
+      end
+
+      File.exists?(pdf_cover)
+    end
+
+    def flags
+      return @flags.join ' ' unless @flags.empty?
+
+      @flags << @config['flags']
+      @flags << @config['outputs'][@format] if @config['outputs'].key?(@format)
+      @flags << '-o'
+      @flags << path
+
+      # Binary formats don't need a -t flag
+      unless binary?
+        @flags << '-t'
+        @flags << @format
+      end
+
+      if epub? && has_cover?
+        @flags << '--epub-cover-image'
+        @flags << cover
+      end
+
+      @flags.join ' '
+    end
+
+    def command
+      'pandoc ' << flags
+    end
+
+    def pdf?
+      @format == 'pdf'
+    end
+
+    def epub?
+      %w[epub epub3].include? @format
+    end
+
+    # These formats are binary files and must use the -o flag
+    def binary?
+      %w[pdf epub epub3 odt docx].include? @format
+    end
+
+    def single_post?
+      @posts.count == 1
+    end
+
+    def has_cover?
+      File.exists? cover
+    end
+
+    def papersize
+      @papersize ||= find_option 'papersize'
+    end
+
+    def sheetsize
+      @sheetsize ||= find_option 'sheetsize'
+    end
+
+    def signature
+      @signature ||= find_option 'signature'
+    end
+
+    private
+
+    def single_post
+      @posts.first
+    end
+
+    def find_option(name)
+      if @posts.any? { |p| p.data.key? name }
+        @posts.select { |p| p.data.key? name }.first.data[name]
+      else
+        @config[name]
+      end
+    end
+
+    def fix_size(size)
+      size.gsub /paper$/, ''
+    end
+  end
+end