petit-felix 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 86191af109a9e5c6a646f9a449e00fdf1d24d88238f5b10ecd48ae0de4c8b589
+  data.tar.gz: 2719d5612122b24fae5af26bd6367df98a86774d1e4e41dea6abdb3ab642122c
+SHA512:
+  metadata.gz: a6b1647e10bf8507b53421b9f0515a87360c73bec8a1f3c67ec94bcbc87af01f9618a69160281b61352a08a31016c60bb41544b826be702576da21059efa9126
+  data.tar.gz: 73534102890ef599b1f4baf87b3d0d30f5e7701e12e08ec36cc6c3bb0fc2c5bc7b4ea7455150805e563c6ea8a313d292c63cda6bc35a0c9ea6716921872a351d

data/lib/felix/config.rb

@@ -0,0 +1,124 @@
+## Helper class that handles configs
+require "felix/metadata"
+
+module PetitFelix
+
+	class	Config
+
+		## Contains all CL arguments already processed
+		## Prevents weird intersection conditions
+		@processed_arguments
+
+		## Default options of the application
+		DEFAULT_OPTIONS = {
+				"columns" => 1,
+				"default_font_size" => 12,
+				"header1_size" => 32,
+				"header2_size" => 28,
+				"header3_size" => 20,
+				"header4_size" => 18,
+				"header5_size" => 16,
+				"header6_size" => 14,
+				"quote_size" => 14,
+				"margin" =>  40,
+				"font_normal" => "./assets/font/Unageo-Regular.ttf",
+				"font_italic"=> "./assets/font/Unageo-Regular-Italic.ttf",
+				"font_bold"=> "./assets/font/Unageo-ExtraBold.ttf",
+				"font_bold_italic" => "./assets/font/Unageo-ExtraBold-Italic.ttf"
+		}
+
+		## Hash for custom command line argument calls
+		CL_DATA = {
+			"columns" => -> (command, args, index, cl_args) { cl_add_config(command, args, index, cl_args).to_i },
+			"default_font_size" => -> (command, args, index, cl_args) { cl_add_config(command, args, index, cl_args).to_i },
+			"header1_size" => -> (command, args, index, cl_args) { cl_add_config(command, args, index, cl_args).to_i },
+			"header2_size" => -> (command, args, index, cl_args) { cl_add_config(command, args, index, cl_args).to_i },
+			"header3_size" => -> (command, args, index, cl_args) { cl_add_config(command, args, index, cl_args).to_i },
+			"header4_size" => -> (command, args, index, cl_args) { cl_add_config(command, args, index, cl_args).to_i },
+			"header5_size" => -> (command, args, index, cl_args) { cl_add_config(command, args, index, cl_args).to_i },
+			"header6_size" => -> (command, args, index, cl_args) { cl_add_config(command, args, index, cl_args).to_i },
+			"margin" => -> (command, args, index, cl_args) { cl_add_config(command, args, index, cl_args).to_i },
+			"font_normal" => -> (command, args, index, cl_args) { cl_add_config(command, args, index, cl_args) },
+			"font_italic" => -> (command, args, index, cl_args) { cl_add_config(command, args, index, cl_args) },
+			"font_bold" => -> (command, args, index, cl_args) { cl_add_config(command, args, index, cl_args) },
+			"font_bold_italic" => -> (command, args, index, cl_args) { cl_add_config(command, args, index, cl_args) },
+			"page_layout" => -> (command, args, index, cl_args) { cl_add_config(command, args, index, cl_args) },
+			"input_files" => -> (command, args, index, cl_args) { cl_add_config(command, args, index, cl_args) },
+		}
+
+		### Command Line Arguments
+
+		def self.cl_add_config(command,args, index, cl_args)
+			cl_args[command] = args[index + 1]
+		end
+
+		### Config Loading
+
+		## Loads default rendering options and config
+		## Default arguments are loaded first,
+		## then arguments loaded in ./default.cfg,
+		## then command line arguments,
+		## then finally any arguments defined in the metadata.
+
+		def load_config(args)
+			@processed_arguments = []
+	
+			# Felix metadata handler
+			metadata = PetitFelix::Metadata.new
+			
+			# load default options
+			options = Marshal.load(Marshal.dump(DEFAULT_OPTIONS))
+			
+			# Loads the default configuation in default.cfg
+			if File.file?("./default.cfg")
+				
+				config = metadata.get_metadata(File.read("./default.cfg")[0])
+				config.keys.each do |key|
+					options[key] = config[key]
+				end
+			end
+			
+			# Loads command line arguments
+			cl_args = load_cl_args(args)
+			
+			cl_args.keys.each do |key|
+				options[key] = cl_args[key]
+			end
+
+			options
+			
+		end
+
+		# Loads command line arguments
+		def load_cl_args(args)
+			cl_args = {}
+			
+			index = 0
+			
+			args.each do |com|
+				command = com.downcase
+			
+				if command.start_with?("--")
+					command = command[2..]
+				
+					if !@processed_arguments.include?(command)
+				
+						if CL_DATA.key?(command)
+						
+							CL_DATA[command].call(command, args, index, cl_args)
+
+						end
+						
+						@processed_arguments << command
+						
+					end
+				end
+				
+				index+=1
+			end
+
+			cl_args
+		end
+		
+	end
+end

data/lib/felix/generator.rb

@@ -0,0 +1,25 @@
+require "felix/task/basic_pdf_task"
+
+module PetitFelix
+
+  class Generator
+	
+		## Renders all the files in the given directory.
+		
+		def render_files(options)
+		
+			## debugging section
+			input_path = "./md/*"
+			output_path ="./output"
+			
+			if !options.key?("input_files")
+				options["input_files"] = input_path
+			end
+			
+			options["output_dir"] = output_path
+			
+			PetitFelix::Task::BasicPDFTask.new.render_files options
+		end
+		
+	end
+end

data/lib/felix/metadata.rb

@@ -0,0 +1,33 @@
+## Helper class that handles metadata
+
+module PetitFelix
+
+	class	Metadata
+
+		## Gets metadata from string into paired hashes
+		def get_metadata(input)
+			array = input.lines
+
+			metadata = {}
+			
+			array.each do |set|
+				if set.count(":") >= 1
+					data = set.split(":")
+					index = data[0].strip.downcase
+					metadata[index] = data[1].strip
+				end
+			end
+			metadata
+		end
+		
+		## Splits files into array into metadata strings and content
+		def split(input)
+			input = input.split("---")
+			if input.count > 1
+				input = input.reject! { |s| s.nil? || s.empty? }
+			end
+			input
+		end
+		
+	end
+end

data/lib/felix/task/basic_pdf_task.rb

@@ -0,0 +1,171 @@
+require "felix/task/default_task"
+require "worker/basic_pdf_writer"
+
+module PetitFelix
+
+	module Task
+	
+		class BasicPDFTask < PetitFelix::Task::DefaultTask
+		
+			# Adds a font to the pdf document
+			def add_font pdf, metaoptions, type
+
+					if metaoptions.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 metaoptions.key?(type + "_font_italic")
+							font_italic = type + "_font_italic"
+						end
+						if metaoptions.key?(type + "_font_bold")
+							font_bold = type + "_font_bold"
+						end
+						if metaoptions.key?(type + "_font_bold_italic")
+							font_bold_italic = type + "_font_bold_italic"
+						end
+					
+						pdf.font_families.update(type => {
+							:normal => metaoptions[font_normal],
+							:italic => metaoptions[font_italic],
+							:bold => metaoptions[font_bold],
+							:bold_italic => metaoptions[font_bold_italic]
+						})
+						
+					else
+					
+						pdf.font_families.update(type => {
+							:normal => metaoptions["font_normal"],
+							:italic => metaoptions["font_italic"],
+							:bold => metaoptions["font_bold"],
+							:bold_italic => metaoptions["font_bold_italic"]
+						})
+						
+					end
+			end
+		
+			def render_zine options
+				
+				# Options that are always added for this task
+				options["quote_font"] = "quote"
+				options["header1_font"] = "header1"
+				options["header2_font"] = "header2"
+				options["header3_font"] = "header3"
+				options["header4_font"] = "header4"
+				options["header5_font"] = "header5"
+				options["header6_font"] = "header6"
+				
+				dir = options["output_dir"]
+				
+				
+				page = File.read(options["filename"])
+				
+				# splits the page into parts for metadata and content
+				
+				# Felix metadata handler
+				metadata_helper = PetitFelix::Metadata.new
+					
+				page_data = metadata_helper.split page
+						
+				metadata = metadata_helper.get_metadata page_data[0]
+					
+				content = page_data[1]
+				
+				# stores options + metadata. metadata overrides options.
+				metaoptions = {}
+				
+				options.keys.each do |key|
+					metaoptions[key] = options[key]
+				end
+				
+				metadata.keys.each do |key|
+					metaoptions[key] = metadata[key]
+				end
+				
+				# Only continue if metadata has a title
+					
+				if metadata.key?("title")
+								
+					# Parameters
+						
+					page_layout = :portrait
+					print_scaling = :none
+					
+					if metaoptions.key?("page_layout")
+						page_layout = metaoptions["page_layout"]
+						
+						if page_layout.is_a? String
+							if page_layout.include?("portrait")
+								page_layout = :portrait
+							else 
+								if page_layout.include?("landscape")
+								page_layout = :landscape
+								end
+							end
+						end
+					end
+
+					# Generates PDF
+						
+					pdf = PetitFelix::Worker::BasicPDFWriter.new(
+						page_layout: page_layout,
+						print_scaling: print_scaling)
+
+					pdf.font_families.update("OpenSans" => {
+					:normal => metaoptions["font_normal"],
+					:italic => metaoptions["font_italic"],
+					:bold => metaoptions["font_bold"],
+					:bold_italic => metaoptions["font_bold_italic"]
+					})
+					
+					add_font pdf, metaoptions, "quote"
+					
+					add_font pdf, metaoptions, "header1"
+					add_font pdf, metaoptions, "header2"
+					add_font pdf, metaoptions, "header3"
+					add_font pdf, metaoptions, "header4"
+					add_font pdf, metaoptions, "header5"
+					add_font pdf, metaoptions, "header6"
+					
+					# End quote font
+					
+					pdf.font "OpenSans"
+					
+					# If the title is generated
+					if metaoptions.key?("front_cover")
+						if metaoptions["front_cover"]
+							pdf.title_page(pdf, metaoptions)
+							pdf.start_new_page()
+							if metaoptions.key?("front_extra_page") && metaoptions["front_extra_page"]
+								pdf.start_new_page()
+							end
+						end
+					end
+					
+					# Does the main content
+					pdf.main_block(pdf, metaoptions, content)
+					
+					# If the back is generated
+					if metaoptions.key?("back_cover")
+						if metaoptions["back_cover"]
+							if metaoptions.key?("back_extra_page") && metaoptions["back_extra_page"]
+								pdf.start_new_page()
+							end
+						
+							pdf.start_new_page()
+							pdf.back_page(pdf, metaoptions)
+						end
+					end
+					
+
+					FileUtils.mkdir_p dir
+					pdf.render_file(dir + "/" + metadata["title"].gsub(/[^\w\s]/, '').tr(" ", "_") + '.pdf')
+				end
+			end
+		
+	end
+	
+end
+
+end

data/lib/felix/task/default_task.rb

@@ -0,0 +1,42 @@
+module PetitFelix
+
+	module Task
+	
+		class DefaultTask
+		
+			def render_zine options
+				print "render_zine() not implemented\n"
+			end
+		
+			def render_files options
+				if options.key?("input_files")
+					site_list = options["input_files"].split(",")
+				end
+
+				site_list.each do |page|
+				
+					file_list = Dir[page.strip].select { |path| File.file?(path) }
+				
+					if !file_list.empty?
+				
+						file_list.each do |file|
+							options["filename"] = file.strip
+							
+							if File.file?(options["filename"])
+								render_zine(options)
+							end
+						
+						end
+						
+					else
+						if File.file?(page)
+							render_zine(page)
+						end
+					end
+				end
+
+		end
+				
+		end
+	end
+end

data/lib/petit-felix.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+require "felix/generator"
+require "felix/config"
+
+module PetitFelix
+
+	class Output
+	
+		# cl_args - command line arguments passed from CLI
+		# options - hash passed by developer containing default rendering options
+		def initialize(cl_args: [], options: {})
+	
+			## Loads options from default values, ./default.cfg
+			config = PetitFelix::Config.new
+			loaded_options = config.load_config cl_args
+
+			## Makes sure stuff passed by options variable overrides
+			## any previous config loading
+			options.keys.each do |option|
+				loaded_options[option] = options[option]
+			end
+
+			## Starts producing stuff
+			felix_basic = PetitFelix::Generator.new
+			felix_basic.render_files loaded_options
+		
+		end
+		
+	end
+
+end
+

data/lib/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module PetitFelix
+    module Felix
+      VERSION = "0.1.0"
+    end
+end

data/lib/worker/basic_pdf_writer.rb

@@ -0,0 +1,164 @@
+require "prawn"
+require 'fileutils'
+require "prawndown-ext"
+require "felix/metadata"
+
+module PetitFelix
+	module Worker
+
+		class	BasicPDFWriter < Prawn::Document
+		
+			def page_numbering(page)
+			
+				font_size(12)
+				
+				string = page.title + ": " ' <page>/<total>'
+				
+			# Green page numbers 1 to 7
+			options = {
+				at: [0, 0],
+				width: bounds.width,
+				align: :right,
+				start_count_at: 1,
+				color: '000000'
+			}
+			options[:page_filter] = ->(pg) { pg > 1 }
+			
+			number_pages string, options
+		
+			end
+		
+			def back_page(pdf, metadata)
+			
+			# draw art
+			
+			box_width = 128
+			
+			pdf.font_size(24)
+			pdf.bounding_box([pdf.bounds.width * 0.5 - 64, pdf.cursor - 500], 
+			width: pdf.bounds.width - 100 - box_width,
+			height: box_width) do
+			
+				if metadata.key?("back_cover_image")
+					var = "./assets/images/" + metadata["back_cover_image"]
+					
+					if File.file?(var)
+						pdf.image(var,
+						width: box_width,
+						height: box_width,
+						align: :center)
+					end
+				end
+				#transparent(0.5) { pdf.stroke_bounds }
+			end
+			
+			# draw name
+			
+			pdf.font_size(20)
+			pdf.bounding_box([50, pdf.cursor - 20], 
+			width: pdf.bounds.width - 100,
+			height: 40) do
+				if metadata.key?("author_back")
+					pdf.text_box(metadata["author_back"],
+					align: :center)
+				end
+				#pdf.transparent(0.5) { pdf.stroke_bounds }
+			end
+			
+			end
+		
+	 	def title_page(pdf, metadata)
+			# draw title text
+			pdf.font_size(36)
+			pdf.bounding_box([25, pdf.cursor - 20], 
+			width: pdf.bounds.width - 50,
+			height: 150) do
+				pdf.text_box(metadata["title"],
+				align: :center,
+				style: :bold)
+				#pdf.transparent(0.5) { pdf.stroke_bounds }
+			end
+			
+			# draw art
+			
+			box_width = pdf.bounds.width - 100
+			
+			pdf.font_size(24)
+			pdf.bounding_box([50, pdf.cursor], 
+			width: box_width,
+			height: box_width) do
+			
+				if metadata.key?("front_cover_image")
+					var = "./assets/images/" + metadata["front_cover_image"]
+					
+					if File.file?(var)
+						pdf.image(var,
+						width: box_width,
+						height: box_width)
+					end
+				end
+				#pdf.transparent(0.5) { pdf.stroke_bounds }
+			end
+			
+			# draw name
+			
+			pdf.font_size(24)
+			pdf.bounding_box([50, pdf.cursor - 10], 
+			width: pdf.bounds.width - 100,
+			height: 40) do
+				if metadata.key?("author")
+					pdf.text_box(metadata["author"],
+					align: :center)
+				end
+				#pdf.transparent(0.5) { pdf.stroke_bounds }
+			end
+			
+			pdf.font_size(16)
+			pdf.bounding_box([50, pdf.cursor], 
+			width: pdf.bounds.width - 100,
+			height: 80) do
+				pdf.text_box("Original Publication: " + metadata["date"],#.strftime('%e %B, %Y'),
+				align: :center)
+				#pdf.transparent(0.5) { pdf.stroke_bounds }
+			end
+		end
+		
+		def main_block(pdf, options, content)
+			margin = 25
+			columns = 1
+			
+			if options.key?("margin")
+				margin = options["margin"].to_i
+			end
+			
+			if options.key?("columns")
+				columns = options["columns"].to_i
+			end
+		
+			half_margin = (margin * 0.5).floor()
+		
+			# content generation
+			pdf.font_size(options["default_font_size"].to_i)
+			
+			if columns == 1
+				pdf.bounding_box([half_margin, pdf.cursor - half_margin],
+					width: pdf.bounds.width-margin,
+					height: pdf.bounds.height - margin) do
+				
+					pdf.markdown(content, options: options)
+				end
+			else
+				pdf.column_box([half_margin, pdf.cursor - half_margin],
+					columns: columns,
+					width: pdf.bounds.width-margin,
+					height: pdf.bounds.height - margin) do
+				
+					pdf.markdown(content, options: options)
+				end
+			end
+		end
+
+	end
+
+	end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: petit-felix
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- PunishedFelix
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prawn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: prawndown-ext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.9
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.9
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.9
+description: Converts markdown files into PDF documents using options passed in a
+  hash.
+email:
+- labadore1844@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/felix/config.rb
+- lib/felix/generator.rb
+- lib/felix/metadata.rb
+- lib/felix/task/basic_pdf_task.rb
+- lib/felix/task/default_task.rb
+- lib/petit-felix.rb
+- lib/version.rb
+- lib/worker/basic_pdf_writer.rb
+homepage: https://github.com/badgernested/petitfelix
+licenses:
+- MIT
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Ruby gem that creates document files from markdown, such as on Jekyll blogs.
+test_files: []