jekyll-printing-press 1.0.0rc1

data/lib/jekyll/pandoc/documents/imposed.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require_relative '../document'
+require_relative '../renderers/imposition'
+
+module Jekyll
+  module Pandoc
+    module Documents
+      # An imposed document is a PDF with pages arranged for printing
+      # and folding.
+      class Imposed < Jekyll::Pandoc::Document
+        # Do nothing, content is not read, but Jekyll expects a String
+        #
+        # @return [nil]
+        def read_content(**)
+          self.content = ''
+          nil
+        end
+
+        # Adds relations to source documents
+        #
+        # @return [nil]
+        def read_post_data
+          if data.key? 'uuid'
+            require 'securerandom'
+            data['uuid'] = SecureRandom.uuid
+          end
+
+          source_document.source_document.data['imposed'] =
+            source_document.data['imposed'] = self
+
+          source_document.source_document.data['formats'] << self
+
+          nil
+        end
+
+        # Imposition
+        #
+        # @return [Jekyll::Pandoc::Renderers::Imposition]
+        def renderer
+          @renderer ||= Jekyll::Pandoc::Renderers::Imposition.new(site, self)
+        end
+
+        # The file is always binary
+        #
+        # @return [TrueClass]
+        def binary?
+          true
+        end
+
+        # PDFs can't be rendered with Liquid
+        #
+        # @return [FalseClass]
+        def render_with_liquid?
+          false
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/pandoc/documents/multiple.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require 'jekyll/utils'
+require_relative '../document'
+require_relative '../utils'
+
+module Jekyll
+  module Pandoc
+    module Documents
+      # A document composed of several documents
+      class Multiple < Jekyll::Pandoc::Document
+        # Documents group
+        #
+        # @return [Array]
+        attr_reader :source_documents
+
+        # @param path [String]
+        # @param relations [Hash]
+        def initialize(path, relations = {})
+          @source_documents = relations[:source_documents]
+          relations[:source_document] = self
+          super
+
+          Jekyll::Utils.deep_merge_hashes!(data, relations[:data])
+        end
+
+        # Data must be provided externally
+        #
+        # @return [Hash]
+        def data
+          @data ||= { 'multiple' => true }
+        end
+
+        # The content is a concatenated string of source_documents
+        # content with their titles.
+        #
+        # The ID is attached to a title so you can map IDs to metadata
+        # on a Pandoc filter later.
+        #
+        # @return [nil]
+        def read_content(**)
+          self.content = source_documents.map do |doc|
+            ["\n\n# #{doc['title']} {##{extract_id(doc)} data-chapter-title=true}", doc.content]
+          end.flatten.join("\n\n")
+
+          nil
+        end
+
+        # Generates a data hash from source documents so they can be
+        # accessed later as Pandoc metadata.  For instance, to generate
+        # authors per chapter.
+        #
+        # @return [nil]
+        def read_post_data
+          data['uuid'] ||= SecureRandom.uuid
+
+          source_documents.each do |doc|
+            data[extract_id(doc)] = Jekyll::Pandoc::Utils.sanitize_data doc.data
+          end
+
+          nil
+        end
+
+        private
+
+        # Extracts an ID from a document
+        #
+        # @return [String]
+        def extract_id(document)
+          document['uuid'] || document.id.tr('/', '-').sub(/\A-/, '')
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/pandoc/generator.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Pandoc
+    # Generates all Pandoc documents and adds them to the site.  The
+    # documents are not written, just prepared for later rendering and
+    # writing following Jekyll's process.
+    #
+    # @see Jekyll::Site#generate
+    # @see Jekyll::Generator
+    class Generator < ::Jekyll::Generator
+      safe true
+      priority :highest
+
+      # Site
+      #
+      # @return [Jekyll::Site]
+      attr_reader :site
+
+      # Pandoc collections
+      #
+      # @return [Hash]
+      attr_reader :collections
+
+      # Generate documents for every format.
+      #
+      # @return [nil]
+      def generate(site)
+        @site = site
+        @collections = {}
+
+        return unless generate?
+
+        setup
+        generate_documents!
+      end
+
+      private
+
+      # Do nothing for now
+      def setup; end
+
+      # Source documents.  Every generator know how to fetch its own
+      # documents.
+      #
+      # @return [Array]
+      def source_documents
+        raise NotImplementedError
+      end
+
+      # This method knows how to collect documents, and generate
+      # collections and Pandoc documents.
+      #
+      # @return [nil]
+      def generate_documents!
+        raise NotImplementedError
+      end
+
+      # @return [Hash]
+      def config
+        site.config['pandoc']
+      end
+
+      # Jekyll runs every Jekyll::Generator descendant, but we don't
+      # want to run this one, just use it as a template.
+      #
+      # @return [Boolean]
+      def generate?
+        self.class != Jekyll::Pandoc::Generator
+      end
+
+      # Creates or finds a collection by a label, performs basic
+      # configuration and brings everything else from site
+      # configuration.
+      #
+      # @param label [String]
+      # @return [Hash]
+      def collection_for(label)
+        site.collections[label] ||=
+          Jekyll::Collection.new(site, label).tap do |col|
+            # Allow to configure the collection
+            # @see https://jekyllrb.com/docs/collections/
+            col.metadata['output'] = true unless col.metadata.key? 'output'
+            # Follow the same permalink structure unless otherwise
+            # specified.
+            unless site.config.dig('collections', label, 'permalink')
+              col.metadata['permalink'] =
+                site.posts.url_template
+            end
+          end
+      end
+    end
+  end
+end

data/lib/jekyll/pandoc/generators/binder.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative '../generator'
+require_relative '../documents/bound'
+
+module Jekyll
+  module Pandoc
+    module Generators
+      # Generates a ready for print PDF for use in a binding machine.
+      class Binder < Jekyll::Pandoc::Generator
+        priority :high
+
+        private
+
+        # Only generate if the site asks for imposition
+        #
+        # @return [Boolean]
+        def generate?
+          site.config.dig('pandoc', 'printing', 'formats')&.include? 'binder'
+        end
+
+        # Only PDFs are imposed
+        #
+        # @return [Array]
+        def source_documents
+          @source_documents ||= site.collections['pdf'].docs
+        end
+
+        # Generate a {Jekyll::Pandoc::Documents::Bound} per document
+        #
+        # @return [nil]
+        def generate_documents!
+          source_documents.each do |document|
+            collection_for('bound').tap do |col|
+              col.docs << Jekyll::Pandoc::Documents::Bound.new(document.path, site: site, collection: col,
+                                                                              source_document: document).tap(&:read)
+            end
+          end
+
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/pandoc/generators/category.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../generator'
+require_relative 'multiple'
+
+module Jekyll
+  module Pandoc
+    module Generators
+      class Category < Jekyll::Pandoc::Generator
+        include Multiple
+
+        priority :high
+
+        private
+
+        # Group posts by categories
+        #
+        # @return [String]
+        def generator_type
+          @generator_type ||= 'categories'
+        end
+
+        # Groups documents by category
+        #
+        # @return [Array]
+        def source_documents
+          @source_documents ||= site.categories.to_a
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/pandoc/generators/imposition.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require_relative '../generator'
+require_relative '../documents/imposed'
+
+module Jekyll
+  module Pandoc
+    module Generators
+      # Generates a ready for print PDF by creating 4-pages sheets.
+      class Imposition < Jekyll::Pandoc::Generator
+        priority :high
+
+        private
+
+        # Only generate if the site asks for imposition
+        #
+        # @return [Boolean]
+        def generate?
+          site.config.dig('pandoc', 'printing', 'formats')&.include? 'imposition'
+        end
+
+        # Only PDFs are imposed
+        #
+        # @return [Array]
+        def source_documents
+          @source_documents ||= site.collections['pdf'].docs
+        end
+
+        # Generate a {Jekyll::Pandoc::Documents::Imposed} per document
+        #
+        # @return [nil]
+        def generate_documents!
+          source_documents.each do |document|
+            collection_for('imposed').tap do |col|
+              col.docs << Jekyll::Pandoc::Documents::Imposed.new(document.path, site: site, collection: col,
+                                                                                source_document: document).tap(&:read)
+            end
+          end
+
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/pandoc/generators/multiple.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+require 'jekyll/utils'
+require_relative '../documents/multiple'
+
+module Jekyll
+  module Pandoc
+    module Generators
+      # Mixin for multiple-file generators
+      module Multiple
+        private
+
+        # Generator type
+        #
+        # @return [String]
+        def generator_type
+          raise NotImplementedError
+        end
+
+        # Must return an Array of grouped documents (an Array of Arrays)
+        #
+        # @return [Array]
+        def source_documents
+          raise NotImplementedError
+        end
+
+        # @return [Boolean]
+        def generate?
+          config['documents']&.include? generator_type
+        end
+
+        # Generates a temporary file on site source per each document
+        # group and passes data as a relation.
+        #
+        # @return [nil]
+        def generate_documents!
+          source_documents.each do |(title, documents)|
+            config.available_formats.each do |format|
+              next if format == :html5
+
+              data = {
+                'title' => title,
+                'slug' => Jekyll::Utils.slugify(title, mode: 'pretty'),
+                'data' => Time.now
+              }
+              label = format.to_s
+              file = Tempfile.new([data['slug'], '.markdown'], site.source)
+
+              collection_for(label).tap do |col|
+                col.docs << Jekyll::Pandoc::Documents::Multiple.new(file.path, site: site, collection: col,
+                                                                               source_documents: documents, data: data).tap(&:read)
+              end
+            end
+          end
+
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/pandoc/generators/posts.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative '../document'
+require_relative '../generator'
+
+module Jekyll
+  module Pandoc
+    class Generator
+      # Generates Pandoc documents from Jekyll posts collection.  Each
+      # format is a collection.
+      class Posts < Generator
+        priority :highest
+
+        private
+
+        # Only generate if aggregating posts is enabled
+        #
+        # @return [Boolean]
+        def generate?
+          config['documents']&.include? 'posts'
+        end
+
+        # Documents to generate from
+        #
+        # @return [Array]
+        def source_documents
+          @source_documents ||= site.posts.docs.reject(&:asset_file?)
+        end
+
+        # Generate a Pandoc document for each format and adds it to
+        # a collection.
+        #
+        # HTML5 is already generated by
+        # {Jekyll::Converters::Markdown::Pandoc}
+        #
+        # @return [nil]
+        def generate_documents!
+          source_documents.each do |document|
+            config.available_formats.each do |format|
+              next if format == :html5
+
+              collection_for(format.to_s).tap do |col|
+                col.docs << Document.new(document.path, site: site, collection: col,
+                                                        source_document: document).tap(&:read)
+              end
+            end
+          end
+
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/pandoc/generators/site.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative '../generator'
+require_relative 'multiple'
+
+module Jekyll
+  module Pandoc
+    module Generators
+      class Site < Jekyll::Pandoc::Generator
+        include Multiple
+
+        priority :high
+
+        private
+
+        # All posts
+        #
+        # @return [String]
+        def generator_type
+          @generator_type ||= 'site'
+        end
+
+        # All posts
+        #
+        # @return [Array]
+        def source_documents
+          @source_documents ||= [ [ site.config['title'], site.posts.docs.reject(&:asset_file?) ] ]
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/pandoc/paru_helper.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'paru/pandoc'
+
+module Jekyll
+  module Pandoc
+    # Creates a Paru::Pandoc with options from configuration
+    module ParuHelper
+      extend self
+
+      # Returns a Paru::Pandoc with options set
+      #
+      # @param options [Hash]
+      # @return [Paru::Pandoc]
+      def from(options)
+        Paru::Pandoc.new.tap do |paru|
+          options.each do |option, value|
+            paru.send option, value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/pandoc/printing.latex.liquid

@@ -0,0 +1,10 @@
+\documentclass[{{ sheetsize }},10pt]{article}
+
+\usepackage{pgfpages}
+\usepackage{pdfpages}
+
+\pgfpagesuselayout{ {{- nup }} on 1}[{{ sheetsize }},{{ options }}]
+
+\begin{document}
+  \includepdf[pages={ {{- pages | join: ',' -}} }]{ {{- path -}} }
+\end{document}