petit-felix 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97cba85bae835c95a94b3143517e5e7276772f287ad58a41047f5562dd6d746b
-  data.tar.gz: 69d0d789487e81046db93826ed0481f613b4fa70d3e13fdc6fde5e063422f973
+  metadata.gz: 8520f2febc5661d5cc6c5be58d294a6a92e03996be301164da8be5c8a2cbfa32
+  data.tar.gz: ee3505a8ed5f1dc356c8b052e95b4eea6332e4e313fe20872cf5a092d35a6211
 SHA512:
-  metadata.gz: cbbce50a26a2351b24c17d092995fa9d5c7bfa5dac8afa51b5e93eb88c9e83182d1b5770a1a793c2967d2623f5c93a6abfa2965b710c042a94a6c513ea34653b
-  data.tar.gz: 289b9746a5c0129fa8b8aab09c38b06fdb05bd9e3e279371edac4f7d9ad927ab34225e8946c165de6b898e52d9024b54e39aaea055dde03b66ee1ff093f79617
+  metadata.gz: 403e8b620ea5a35712ccd6ef83cc37e8ceadc05ae1ae1dde46771e016834579f3936f2dd0884716079a251cecda4a8b1e2c394dc3d5951dd339ac78b212da9e4
+  data.tar.gz: 8d69e16b180af01aeee3d81b60fbf3343d655b0933c9970cb2574f2a02d622aa3d7d7975267bae1f8e2c384fbad332603f0ed58d27fce7f619dc70d491a6ae06

data/lib/felix/config.rb

@@ -1,6 +1,8 @@
 ## Helper class that handles configs
 require "felix/metadata"
 
+## Processes loaded options. Doesn't actually store them, though.
+
 module PetitFelix
 
 	class	Config
@@ -14,7 +16,7 @@ module PetitFelix
 			"image_dir" => "./assets/images",
 			"input_files" => "./md/*",
 			"output_dir" => "./output",
-			"worker" => "basic_pdf",
+			"task" => "pdf-single",
 		}
 
 		## Hash for custom command line argument calls
@@ -35,11 +37,13 @@ module PetitFelix
 			"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) },
 			"image_dir" => -> (command, args, index, cl_args) { cl_add_config(command, args, index, cl_args) },
+			"task" => -> (command, args, index, cl_args) { cl_add_config(command, args, index, cl_args) },
+			"template" => -> (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)
+		def self.cl_add_config command,args, index, cl_args
 			cl_args[command] = args[index + 1]
 		end
 
@@ -51,7 +55,8 @@ module PetitFelix
 		## then command line arguments,
 		## then finally any arguments defined in the metadata.
 
-		def load_config(wm, passed_args, args)
+		def load_config wm, passed_args, args
+		
 			@processed_arguments = []
 	
 			# Felix metadata handler
@@ -64,34 +69,38 @@ module PetitFelix
 			
 			default_config = {}
 			
-			if File.file?("./default.cfg")
+			if File.file? "./default.cfg" 
 				
-				default_config = metadata.get_metadata(File.read("./default.cfg")[0])
+				default_config = metadata.get_metadata(File.read "./default.cfg")
 			end
 			
 			# Loads command line arguments
-			cl_args = load_cl_args(args)
+			cl_args = load_cl_args args
 			
 			# Loads default worker options
 			worker = ""
 			worker_options = nil
 			
-			if default_options.key?("worker")
-				worker = default_options["worker"]
+			# Gets the task to run.
+			
+			if default_options.key? "task"
+				worker = default_options["task"]
 			end
 			
-			if default_config.key?("worker")
-				worker = default_config["worker"]
+			if default_config.key? "task"
+				worker = default_config["task"]
 			end
 			
-			if cl_args.key?("worker")
-				worker = cl_args["worker"]
+			if cl_args.key? "task"
+				worker = cl_args["task"]
 			end
 			
-			if passed_args.key?("worker")
-				worker = passed_args["worker"]
+			if passed_args.key? "task"
+				worker = passed_args["task"]
 			end
 			
+			# Loads the worker based on the task.
+			
 			if worker != ""
 				worker_options = Marshal.load(Marshal.dump(wm.get_task_options worker))
 			end
@@ -100,11 +109,6 @@ module PetitFelix
 			# First, default options
 			options = default_options
 			
-			# Then loading default config file
-			default_config.keys.each do |key|
-				options[key] = default_config[key]
-			end
-			
 			# Then loading default worker args
 			if !worker_options.nil?
 				worker_options.keys.each do |key|
@@ -112,6 +116,11 @@ module PetitFelix
 				end
 			end
 			
+			# Then loading default config file
+			default_config.keys.each do |key|
+				options[key] = default_config[key]
+			end
+				
 			# Then loading CLI arguments
 			cl_args.keys.each do |key|
 				options[key] = cl_args[key]
@@ -126,22 +135,23 @@ module PetitFelix
 		end
 
 		# Loads command line arguments
-		def load_cl_args(args)
+		def load_cl_args args
 			cl_args = {}
 			
 			index = 0
 			
 			args.each do |com|
+			
 				command = com.downcase
 			
-				if command.start_with?("--")
+				if command.start_with? "--"
 					command = command[2..]
 				
-					if !@processed_arguments.include?(command)
+					if !@processed_arguments.include? command
 				
-						if CL_DATA.key?(command)
+						if CL_DATA.key? command
 						
-							CL_DATA[command].call(command, args, index, cl_args)
+							CL_DATA[command].call command, args, index, cl_args
 
 						end
 						

data/lib/felix/error.rb

@@ -1,8 +1,10 @@
+## Prints an error message.
+
 module PetitFelix
 	class Error
 	
-		def print_err(error)
-			print "\n\nError: " + error + "\n"
+		def print_err error
+			print "\n\nError: #{error}\n"
 		end
 		
 	end

data/lib/felix/generator.rb

@@ -1,4 +1,3 @@
-require "task/basic_pdf_task"
 require "felix/task_manager"
 
 module PetitFelix
@@ -9,10 +8,14 @@ module PetitFelix
 		
 		def render_files(wm, options)
 			
-			task = wm.get_task options["worker"]
+			task = wm.get_task options["task"]
 			
+			default_options = wm.get_task_options options["task"]
+			
+			default_options = default_options.merge(options)
+
 			if !task.nil?
-				task.render_files options
+				task.render_files default_options
 			end
 
 		end

data/lib/felix/metadata.rb

@@ -6,38 +6,67 @@ module PetitFelix
 
 		## Gets image from path and location
 		def get_image_location img_dir, filename
-			file = img_dir + "/" + filename
+		
+			file = "#{img_dir}/#{filename}"
 			
 			if !File.file?(file)
-				file = "." + img_dir + "/" + filename
+			
+				file = ".#{img_dir}/#{filename}"
+				
 			end
 			
 			file
+			
 		end
 
 		## 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(":")
+				
+					data = set.split(":", 2)
 					index = data[0].strip.downcase
 					metadata[index] = data[1].strip.gsub("\\\"", "\"")
+					
 				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
+		
+		## Transforms string into JSON parsed object
+		def parse_property string, base="${x}"
+		
+			begin
+			
+				return JSON.parse(base.sub("${x}", string), symbolize_names: true)
+				
+			rescue
+			
+				return parse_property
+				
+			end
 		end
 		
 	end

data/lib/felix/task_manager.rb

@@ -4,13 +4,22 @@ require "felix/error"
 module PetitFelix
 	class TaskManager
 		
+		def load_task filename
+			load filename
+		end
+		
+		
 		# Gets the list of tasks loaded
 		def initialize
 			@error_printer = PetitFelix::Error.new
 			@task_list = {}
+			
+			load_task "task/template_pdf_task.rb"
+			load_task "task/pdf_single_task.rb"
+			load_task "task/basic_pdf_classic_task.rb"
 		
 			task_list = PetitFelix::Task.constants.select {|c| PetitFelix::Task.const_get(c).is_a? Class}
-			
+
 			task_list.delete(:DefaultTask)
 			
 			task_list.each do |task|
@@ -18,9 +27,10 @@ module PetitFelix
 			
 				task_obj = {}
 				task_obj["id"] = task
-				task_obj["options"] = task_instance::DEFAULT_OPTIONS
 				
-				name = task_instance::NAME
+				task_obj["options"] = task_instance.default_options
+				
+				name = task_instance.name
 				
 				@task_list[name] = task_obj
 			end
@@ -37,7 +47,7 @@ module PetitFelix
 					name = "[UNDEFINED]"
 				end
 			
-				err_no_task_found name, additional_text: "Unable to find task " + name + ":\n"
+				err_no_task_found name, additional_text: "Unable to find task #{name}:\n"
 			end
 		
 			return nil
@@ -53,7 +63,7 @@ module PetitFelix
 					name = "[UNDEFINED]"
 				end
 			
-				err_no_task_found name, additional_text: "Unable to get options for Worker " + name + ":\n"
+				err_no_task_found name, additional_text: "Unable to get options for Task #{name}:\n"
 			end
 			
 			return nil
@@ -61,10 +71,10 @@ module PetitFelix
 		
 		# No task found error
 		def err_no_task_found task, additional_text: ""
-				text = "Worker " + task.downcase + " not found. Make sure the variable \"worker\" is set correctly in your configuration settings. Available Workers: "
+				text = "Task #{task.downcase} not found. Make sure the variable \"task\" is set correctly in your configuration settings. Available Tasks: "
 				
 				@task_list.keys.each do |key|
-					text += "\n  " + key
+					text += "\n  #{key}"
 				end
 				
 				@error_printer.print_err text

data/lib/petit-felix.rb

@@ -3,6 +3,8 @@ require "felix/generator"
 require "felix/config"
 require "felix/task_manager"
 
+# Main entry point of the program for batch outputting files
+
 module PetitFelix
 
 	class Output
@@ -10,7 +12,7 @@ module PetitFelix
 		# cl_args - command line arguments passed from CLI
 		# options - hash passed by developer containing default rendering options
 		def initialize(cl_args: [], options: {})
-	
+		
 			# Creates a new worker manager, which has all the worker stuff
 			wm = PetitFelix::TaskManager.new
 	

data/lib/task/basic_pdf_classic_task.rb

@@ -0,0 +1,182 @@
+require "task/default_task"
+require "worker/basic_pdf_writer_classic"
+
+module PetitFelix
+
+	module Task
+	
+		class BasicPDFTask < PetitFelix::Task::DefaultTask
+		
+			def self.name 
+			
+				"basic-pdf-classic"
+				
+			end
+
+			## Default options of the application
+			def self.default_options 
+			
+				return {
+						"date" => "",
+						"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",
+						"paginator_start_count" => 1,
+						"paginator_start" => 1,
+						"paginator" => true,
+						"paginator_alternate" => false,
+						"back_text" => "",
+						"back_text_margin" => 0,
+						"back_text_size" => 14,
+						"front_title_size"=> 32,
+						"front_author_size" => 18,
+						"front_date_size" => 14,
+						"back_publisher" => "",
+						"back_publisher_size" => 14,
+						"front_publisher" => "",
+						"front_publisher_size" => 14,
+						"paginator_size" => 12,
+						"back_author" => "",
+						"back_author_size" => 16,
+				}
+				
+			end
+
+			def render_zine options
+				
+				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]
+				
+				prepare_options options
+				
+				# 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"].to_sym
+						
+					end
+
+					# Generates PDF
+						
+					pdf = PetitFelix::Worker::BasicPDFWriter.new(
+						page_layout: page_layout,
+						print_scaling: print_scaling)
+
+
+					pdf.set_options @metaoptions
+
+					# Adds extra fonts
+					
+					pdf.initialize_font
+					
+					# Title page generation
+
+					pdf.title_page
+
+					# Does the main content
+					pdf.main_block @content
+					
+					# Does page numbering
+					pdf.page_numbering
+					
+					pdf.go_to_page pdf.page_count
+
+					# Back page generation
+					pdf.back_page
+					
+					# Outputs to file
+					pdf.output
+					
+				end
+			end
+			
+			def prepare_options options
+			
+				# 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
+				
+				# Loads proper values from strings for certain params
+				page_layout = :portrait
+				print_scaling = :none
+				
+				if @metaoptions.key? "page_layout"
+					page_layout = @metaoptions["page_layout"].to_sym
+				end
+				
+			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
+						
+					end
+				end
+
+		end
+		
+	end
+	
+end
+
+end

data/lib/task/default_task.rb

@@ -1,18 +1,63 @@
+require "felix/metadata"
+
 module PetitFelix
 
 	module Task
 	
 		class DefaultTask
 		
-			def render_zine options
+			## Name of the task as visible to the Cli and "task" variable
+			def self.name 
+				""
+			end
+
+			## Default options of the application
+			def self.default_options
+			
+				return {}
+				
+			end
+		
+			# prepares the task's options from metadata
+			def prepare_options options
+			
+				# stores options + metadata. metadata overrides options.
+				@metaoptions = {}
+				
+				options.keys.each do |key|
+				
+					@metaoptions[key] = options[key]
+					
+				end
+				
+				# Loads proper values from strings for certain params
+				page_layout = :portrait
+				print_scaling = :none
+				
+				if @metaoptions.key? "page_layout"
+				
+					page_layout = @metaoptions["page_layout"].to_sym
+					
+				end
+				
+			end
+		
+			# renders the task
+			def render_zine
+			
 				print "render_zine() not implemented\n"
+				
 			end
 		
+			# gets the files from input files and renders them.
 			def render_files options
-				if options.key?("input_files")
+			
+				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) }
@@ -20,18 +65,18 @@ module PetitFelix
 					if !file_list.empty?
 				
 						file_list.each do |file|
+						
 							options["filename"] = file.strip
 							
-							if File.file?(options["filename"])
-								render_zine(options)
+							if File.file? options["filename"]
+							
+								prepare_options options
+								render_zine
+								
 							end
 						
 						end
 						
-					else
-						if File.file?(page)
-							render_zine(page)
-						end
 					end
 				end
 

data/lib/task/pdf_single_task.rb

@@ -0,0 +1,74 @@
+require "task/template_pdf_task"
+require "worker/template_pdf_writer"
+
+module PetitFelix
+
+	module Task
+	
+		class SinglePDFTask < PetitFelix::Task::DefaultTask
+		
+			# Task name
+			def self.name 
+			
+				"pdf-single"
+				
+			end
+
+			## Default options of the application
+			def self.default_options
+			
+				return {
+					"pdf" => "false"
+				}
+				
+			end
+		
+			# Renders zine
+			def render_zine
+			
+				# Only continue if metadata has a title
+				# Generates PDF
+			
+				@metaoptions["pdf"] = false
+
+				page = File.read(@metaoptions["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 = @metaoptions.merge(metadata_helper.get_metadata(page_data[0]))
+
+				# Always forces you to use this template
+				@metaoptions["template"] = File.dirname(__FILE__) + "/../../templates/zine-single.json"
+
+				if metadata["pdf"] == "true"
+					
+					pdf = PetitFelix::Worker::TemplatePDFWriter.new(
+						page_layout: @metaoptions["page_layout"],
+						print_scaling: @metaoptions["print_scaling"])
+
+					@metaoptions["output_file"] = File.basename(File.basename(@metaoptions["filename"], ".md"), ".markdown") + ".pdf"
+
+					pdf.set_options @metaoptions
+
+					pdf.init_values @metaoptions, pdf
+
+					pdf.read_template
+
+					# Adds extra fonts
+					#pdf.initialize_font
+					
+					# Outputs to file
+					pdf.output
+					
+				end
+			end
+			
+		
+		end
+	end
+end