petit-felix 0.1.4 → 0.1.6

data/lib/task/template_pdf_task.rb

@@ -0,0 +1,51 @@
+require "task/default_task"
+require "worker/template_pdf_writer"
+
+module PetitFelix
+
+	module Task
+	
+		class TemplatePDFTask < PetitFelix::Task::DefaultTask
+		
+			def self.name
+			
+				"template-pdf"
+				
+			end
+
+			## Default options of the application
+			def self.default_options 
+			
+				return {
+					"template" => "./templates/test.json",
+					"output_file" => "./output/test.pdf"
+				}
+				
+			end
+		
+			def render_zine
+
+				# Only continue if metadata has a title
+				# Generates PDF
+					
+				pdf = PetitFelix::Worker::TemplatePDFWriter.new(
+					page_layout: @metaoptions["page_layout"],
+					print_scaling: @metaoptions["print_scaling"])
+
+				pdf.set_options @metaoptions
+
+				pdf.init_values @metaoptions, pdf
+
+				pdf.read_template
+				
+				# Outputs to file
+				pdf.output
+
+			end
+			
+		
+		end
+		
+	end
+
+end

data/lib/version.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+# Version handler, update this when you make a new version.
+
 module PetitFelix
     module Felix
-      VERSION = "0.1.4"
+      VERSION = "0.1.6"
     end
 end

data/lib/worker/{basic_pdf_writer.rb → basic_pdf_writer_classic.rb}

@@ -2,18 +2,16 @@ require "prawn"
 require 'fileutils'
 require "prawndown-ext"
 require "felix/metadata"
+require "worker/pdf_writer"
 
 module PetitFelix
 	module Worker
 
-		class	BasicPDFWriter < Prawn::Document
-
-			def set_options metaoptions
-				@options = metaoptions
-			end
+		class	BasicPDFWriter < PetitFelix::Worker::DefaultPDFWriter
 
 			# Initializes fonts
 			def initialize_font
+			
 				# Fonts that must always be defined
 				fonts = [
 					"quote",
@@ -53,53 +51,9 @@ module PetitFelix
 				
 			end
 		
-			# Adds a font to the pdf document
-			def add_font (type,
-									default_font: "default")
-
-					if @options.key?(type + "_font_normal")
-					
-						font_normal = type + "_font_normal"
-						font_italic = type + "_font_normal"
-						font_bold = type + "_font_normal"
-						font_bold_italic = type + "_font_normal"
-						
-						if @options.key?(type + "_font_italic")
-							font_italic = type + "_font_italic"
-						end
-						if @options.key?(type + "_font_bold")
-							font_bold = type + "_font_bold"
-						end
-						if @options.key?(type + "_font_bold_italic")
-							font_bold_italic = type + "_font_bold_italic"
-						end
-					
-						font_families.update(type => {
-							:normal => @options[font_normal],
-							:italic => @options[font_italic],
-							:bold => @options[font_bold],
-							:bold_italic => @options[font_bold_italic]
-						})
-						
-					else
-						if font_families.key?(default_font)
-							font_families.update(type => {
-								:normal => font_families[default_font][:normal],
-								:italic => font_families[default_font][:italic],
-								:bold => font_families[default_font][:bold],
-								:bold_italic => font_families[default_font][:bold_italic]
-							})
-							
-						else
-							font_families.update(type => {
-								:normal => @options["font_normal"],
-								:italic => @options["font_italic"],
-								:bold => @options["font_bold"],
-								:bold_italic => @options["font_bold_italic"]
-							})
-						end
-						
-					end
+			def output
+				FileUtils.mkdir_p @options["output_dir"]
+				render_file("#{@options["output_dir"]}/#{@options["title"].gsub(/[^\w\s]/, '').tr(" ", "_")}.pdf")
 			end
 		
 			# Draws page numbering
@@ -113,7 +67,7 @@ module PetitFelix
 					
 						font_size(@options["paginator_size"].to_i)
 						
-						string = @options["title"] + ": " ' <page>'
+						string = "#{@options["title"]}: <page>"
 						
 						page_start_count = @options["paginator_start_count"].to_i
 						page_start = @options["paginator_start"].to_i
@@ -139,7 +93,7 @@ module PetitFelix
 							odd_options[:page_filter] = ->(pg) { pg > page_start && pg % 2 == 1 }
 							
 							even_options = {
-								at: [0, bounds.left],
+								at: [bounds.left, 0],
 								width: bounds.width,
 								align: align_even,
 								start_count_at: page_start_count + 1,
@@ -153,7 +107,7 @@ module PetitFelix
 						else
 						
 							options = {
-								at: [0, 0],
+								at: [0, -10],
 								width: bounds.width,
 								align: :right,
 								start_count_at: page_start_count,
@@ -309,7 +263,7 @@ module PetitFelix
 					bounding_box([50, cursor], 
 					width: bounds.width - 100,
 					height: 30) do
-						text_box("Original Publication: " + @options["date"],#.strftime('%e %B, %Y'),
+						text_box("Original Publication: #{@options["date"]}",#.strftime('%e %B, %Y'),
 						align: :center)
 						#transparent(0.5) { stroke_bounds }
 					end
@@ -356,31 +310,49 @@ module PetitFelix
 			# content generation
 			font_size(@options["default_font_size"].to_i)
 			
+			base_margin = [{
+					:left => 10,
+					:right => 10,
+					:top => 10,
+					:bottom => 30
+				}]
+
+			begin
+				obj = PetitFelix::Metadata.new.parse_property @options["markdown_margin_array"], "{\"margin\" : ${x}}"
+			
+				base_margin = obj[:margin]
+			
+			rescue
+				if @options.key?("markdown_margin_array")
+					print "\n"
+					print "Note: unable to parse argument #{@options["markdown_margin_array"]}"
+				end
+			end
+			
 			if columns == 1
 
-				bounding_box([half_margin, cursor - half_margin],
-					width: bounds.width-margin,
-					height: [bounds.height - 20 - margin, bounds.height - margin].min) do
+				bounding_box([0, cursor],
+					width: bounds.width,
+					height: bounds.height,
+					base_margins: base_margin) do
 					markdown(content, options: @options)
 				end
 				
 			else
 			
-				column_box([half_margin, cursor - half_margin],
+				column_box([0, cursor],
 					columns: columns,
-					width: bounds.width-margin,
-					height: [bounds.height - 20 - margin, bounds.height - margin].min) do
+					width: bounds.width,
+					height: [bounds.height, bounds.height].min,
+					base_margins: base_margin) do
 					
 					markdown(content, options: @options)
 					
 				end
 			end
+			
 		end
 		
-		def output
-			FileUtils.mkdir_p @options["output_dir"]
-			render_file(@options["output_dir"] + "/" + @options["title"].gsub(/[^\w\s]/, '').tr(" ", "_") + '.pdf')
-		end
 
 	end
 

data/lib/worker/pdf_writer/bounding_box.rb

@@ -0,0 +1,135 @@
+require "prawn"
+
+## Custom column box that calculates bounding box
+
+module Prawn
+  class Document 
+		class BoundingBox
+      
+      def initialize(document, parent, point, options = {})
+        unless options[:width]
+          raise ArgumentError, 'BoundingBox needs the :width option to be set'
+        end
+
+        @document = document
+        @parent = parent
+        @x, @y = point
+        @base_x, @base_y = point
+        @width = options[:width]
+        @base_width = options[:width]
+        @height = options[:height]
+        @base_height = options[:height]
+        @total_left_padding = 0
+        @total_right_padding = 0
+        @stretched_height = nil
+        @margins = {}
+        @base_margins = []
+        if options.key?(:base_margins) && !options[:base_margins].nil?
+        	@base_margins = options[:base_margins]
+        end
+				
+      end
+      
+      def update_margins
+      
+      	@margins = {}
+      
+      	if @base_margins.count > 0
+      		@margins = @base_margins[@document.page_count % @base_margins.count]
+				end
+      end
+      
+      def absolute_left
+      	update_margins
+      
+      	margin = 0
+      	
+      	if !@margins.empty?
+      		margin = @margins[:left]
+      	end
+
+      	@base_x + margin
+      end
+      
+      def absolute_top
+      	update_margins
+      
+      	margin = 0
+
+      	if !@margins.empty?
+      		margin = @margins[:top]
+      	end
+      	
+      	@base_y - margin
+      end
+      
+      def top
+      	update_margins
+      
+      	margin = 0
+
+      	if !@margins.empty?
+      		margin = @margins[:top]
+      	end
+      
+        height - margin
+      end
+      
+      def width
+      	update_margins
+      
+      	margin_left = 0
+      	margin_right = 0
+      	
+      	if !@margins.empty?
+      		margin_left = @margins[:left]
+      		margin_right = @margins[:right]
+      	end
+  
+      	
+      	@base_width - (margin_left + margin_right)
+      end
+      
+      def height
+      	update_margins
+      
+      	margin_top = 0
+      	margin_bottom = 0
+      	
+      	if !@margins.empty?
+      		margin_top = @margins[:top]
+      		margin_bottom = @margins[:bottom]
+      	end
+      
+      	@base_height - (margin_top + margin_bottom)
+      end
+      
+      # Increase the left padding of the bounding box.
+      def add_left_padding(left_padding)
+        @total_left_padding += left_padding
+        @base_x += left_padding
+        @base_width -= left_padding
+      end
+
+      # Decrease the left padding of the bounding box.
+      def subtract_left_padding(left_padding)
+        @total_left_padding -= left_padding
+        @base_x -= left_padding
+        @base_width += left_padding
+      end
+
+      # Increase the right padding of the bounding box.
+      def add_right_padding(right_padding)
+        @total_right_padding += right_padding
+        @base_width -= right_padding
+      end
+
+      # Decrease the right padding of the bounding box.
+      def subtract_right_padding(right_padding)
+        @total_right_padding -= right_padding
+        @base_width += right_padding
+      end
+      
+		end
+	end
+end

data/lib/worker/pdf_writer/column_box.rb

@@ -0,0 +1,38 @@
+require "worker/pdf_writer/bounding_box"
+
+module Prawn
+  class Document 
+		class ColumnBox < BoundingBox
+		
+      def bare_column_width
+      	update_margins
+      
+      	margin_left = 0
+      	margin_right = 0
+      	
+      	if !@margins.empty?
+      		margin_left = @margins[:left]
+      		margin_right = @margins[:right]
+      	end
+      
+        ((@width - (margin_left + margin_right)) - (@spacer * (@columns - 1))) / @columns
+      end
+
+      # Moves to the next column or starts a new page if currently positioned at
+      # the rightmost column.
+      #
+      # @return [void]
+      def move_past_bottom
+        @current_column = (@current_column + 1) % @columns
+        @document.y = absolute_top
+        if @current_column.zero?
+          if @reflow_margins
+            @y = @parent.absolute_top
+          end
+          @document.start_new_page
+        end
+      end
+
+    end
+	end
+end

data/lib/worker/pdf_writer.rb

@@ -0,0 +1,98 @@
+require "prawn"
+require 'fileutils'
+require "prawndown-ext"
+require "worker/pdf_writer/column_box"
+require "worker/pdf_writer/bounding_box"
+
+## Prawn PDF writer that outputs template files
+
+module PetitFelix
+	module Worker
+
+		class	DefaultPDFWriter < Prawn::Document
+		
+			# Initializes fonts
+			def initialize_font
+			
+				add_font "default"
+
+			end
+		
+			# Adds a font to the pdf document
+			def add_font (type,
+									default_font: "default")
+
+					if @options.key? "#{type}_font_normal"
+					
+						font_normal = "#{type}_font_normal"
+						font_italic = "#{type}_font_normal"
+						font_bold = "#{type}_font_normal"
+						font_bold_italic = "#{type}_font_normal"
+						
+						if @options.key? "#{type}_font_italic"
+						
+							font_italic = "#{type}_font_italic"
+							
+						end
+						
+						if @options.key? "#{type}_font_bold"
+						
+							font_bold = "#{type}_font_bold"
+							
+						end
+						
+						if @options.key? "#{type}_font_bold_italic"
+						
+							font_bold_italic = "#{type}_font_bold_italic"
+							
+						end
+					
+						font_families.update(type => {
+						
+							:normal => @options[font_normal],
+							:italic => @options[font_italic],
+							:bold => @options[font_bold],
+							:bold_italic => @options[font_bold_italic]
+							
+						})
+						
+					else
+						if font_families.key?(default_font)
+						
+							font_families.update(type => {
+								:normal => font_families[default_font][:normal],
+								:italic => font_families[default_font][:italic],
+								:bold => font_families[default_font][:bold],
+								:bold_italic => font_families[default_font][:bold_italic]
+							})
+							
+						else
+						
+							font_families.update(type => {
+								:normal => @options["font_normal"],
+								:italic => @options["font_italic"],
+								:bold => @options["font_bold"],
+								:bold_italic => @options["font_bold_italic"]
+							})
+							
+						end
+						
+					end
+			end
+		
+			def set_options metaoptions
+			
+				@options = metaoptions
+				
+			end
+		
+			def output
+
+				FileUtils.mkdir_p File.dirname("#{@options["output_dir"]}/#{@options["output_file"]}")
+				render_file("#{@options["output_dir"]}/#{@options["output_file"]}")
+				
+			end
+		
+		end
+	end
+end