petit-felix 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dd1314254a58bf139622785e904f6461480b148d809e2eb0e777c319dbf391f
-  data.tar.gz: d70547db0dabee7c9af618cd8c7f79bf5086ad3a074e3b2a5d0ffa3194296abf
+  metadata.gz: 8520f2febc5661d5cc6c5be58d294a6a92e03996be301164da8be5c8a2cbfa32
+  data.tar.gz: ee3505a8ed5f1dc356c8b052e95b4eea6332e4e313fe20872cf5a092d35a6211
 SHA512:
-  metadata.gz: 49ee539a073acc0668a1c414190e36a05b3e9c8d628c01b78c2c437e1866e2e83c36c36a1f13aeb56fad3877388f98bdc287fcdeee6d3f469abbba1b60b9e121
-  data.tar.gz: a3f8e8dda4dd750ffe7d1849ae4d181ae76799c161cc14bb82c3e1f46ead121a59c078b7b3a172ae40e4dc03f3b75bc2d51824fe4818a8f066d08d12c9a80815
+  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
@@ -41,7 +43,7 @@ module PetitFelix
 
 		### 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
 
@@ -53,7 +55,7 @@ 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 = []
 	
@@ -67,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"))
+				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?("task")
+			# Gets the task to run.
+			
+			if default_options.key? "task"
 				worker = default_options["task"]
 			end
 			
-			if default_config.key?("task")
+			if default_config.key? "task"
 				worker = default_config["task"]
 			end
 			
-			if cl_args.key?("task")
+			if cl_args.key? "task"
 				worker = cl_args["task"]
 			end
 			
-			if passed_args.key?("task")
+			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
@@ -129,7 +135,7 @@ module PetitFelix
 		end
 
 		# Loads command line arguments
-		def load_cl_args(args)
+		def load_cl_args args
 			cl_args = {}
 			
 			index = 0
@@ -138,14 +144,14 @@ module PetitFelix
 			
 				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/metadata.rb

@@ -6,26 +6,34 @@ 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(":", 2)
 					index = data[0].strip.downcase
 					metadata[index] = data[1].strip.gsub("\\\"", "\"")
+					
 				end
 			end
 			
@@ -34,22 +42,32 @@ module PetitFelix
 		
 		## 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
 end

data/lib/felix/task_manager.rb

@@ -47,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
@@ -63,7 +63,7 @@ module PetitFelix
 					name = "[UNDEFINED]"
 				end
 			
-				err_no_task_found name, additional_text: "Unable to get options for Task " + name + ":\n"
+				err_no_task_found name, additional_text: "Unable to get options for Task #{name}:\n"
 			end
 			
 			return nil
@@ -71,10 +71,10 @@ module PetitFelix
 		
 		# No task found error
 		def err_no_task_found task, additional_text: ""
-				text = "Task " + task.downcase + " not found. Make sure the variable \"task\" is set correctly in your configuration settings. Available Tasks: "
+				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

data/lib/task/basic_pdf_classic_task.rb

@@ -8,12 +8,16 @@ module PetitFelix
 		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,
@@ -46,11 +50,12 @@ module PetitFelix
 						"back_author" => "",
 						"back_author_size" => 16,
 				}
+				
 			end
 
-			def render_zine
+			def render_zine options
 				
-				page = File.read(options["filename"])
+				page = File.read options["filename"]
 				
 				# splits the page into parts for metadata and content
 				
@@ -67,25 +72,17 @@ module PetitFelix
 				
 				# Only continue if metadata has a title
 					
-				if @metadata.key?("title")
+				if @metadata.key? "title"
 								
 					# Parameters
 						
 					page_layout = :portrait
 					print_scaling = :none
 					
-					if @metaoptions.key?("page_layout")
-						page_layout = @metaoptions["page_layout"]
+					if @metaoptions.key? "page_layout"
+					
+						page_layout = @metaoptions["page_layout"].to_sym
 						
-						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
@@ -128,36 +125,33 @@ module PetitFelix
 				@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"]
-					
-					if page_layout.is_a? String
-						if page_layout.include?("portrait")
-							@metaoptions["page_layout"] = :portrait
-						else 
-							if page_layout.include?("landscape")
-							@metaoptions["page_layout"] = :landscape
-							end
-						end
-					end
+				if @metaoptions.key? "page_layout"
+					page_layout = @metaoptions["page_layout"].to_sym
 				end
 				
 			end
 			
 			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|
@@ -167,18 +161,15 @@ module PetitFelix
 					if !file_list.empty?
 				
 						file_list.each do |file|
+						
 							options["filename"] = file.strip
 							
-							if File.file?(options["filename"])
-								render_zine
+							if File.file? options["filename"]
+								render_zine options
 							end
 						
 						end
 						
-					else
-						if File.file?(page)
-							render_zine(page)
-						end
 					end
 				end
 

data/lib/task/default_task.rb

@@ -6,42 +6,56 @@ module PetitFelix
 	
 		class DefaultTask
 		
+			## 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")
+				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|
@@ -51,19 +65,18 @@ module PetitFelix
 					if !file_list.empty?
 				
 						file_list.each do |file|
+						
 							options["filename"] = file.strip
 							
-							if File.file?(options["filename"])
+							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

@@ -7,21 +7,29 @@ module PetitFelix
 	
 		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"])
 				
@@ -37,7 +45,7 @@ module PetitFelix
 				# Always forces you to use this template
 				@metaoptions["template"] = File.dirname(__FILE__) + "/../../templates/zine-single.json"
 
-				if metadata.key?("pdf") && metadata["pdf"] == "true"
+				if metadata["pdf"] == "true"
 					
 					pdf = PetitFelix::Worker::TemplatePDFWriter.new(
 						page_layout: @metaoptions["page_layout"],
@@ -58,12 +66,9 @@ module PetitFelix
 					pdf.output
 					
 				end
-
 			end
 			
 		
 		end
-		
 	end
-
 end

data/lib/task/template_pdf_task.rb

@@ -8,15 +8,19 @@ module PetitFelix
 		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
@@ -33,9 +37,6 @@ module PetitFelix
 				pdf.init_values @metaoptions, pdf
 
 				pdf.read_template
-
-				# Adds extra fonts
-				#pdf.initialize_font
 				
 				# Outputs to file
 				pdf.output

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.5"
+      VERSION = "0.1.6"
     end
 end

data/lib/worker/basic_pdf_writer_classic.rb

@@ -53,7 +53,7 @@ module PetitFelix
 		
 			def output
 				FileUtils.mkdir_p @options["output_dir"]
-				render_file(@options["output_dir"] + "/" + @options["title"].gsub(/[^\w\s]/, '').tr(" ", "_") + '.pdf')
+				render_file("#{@options["output_dir"]}/#{@options["title"].gsub(/[^\w\s]/, '').tr(" ", "_")}.pdf")
 			end
 		
 			# Draws page numbering
@@ -67,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
@@ -263,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
@@ -325,7 +325,7 @@ module PetitFelix
 			rescue
 				if @options.key?("markdown_margin_array")
 					print "\n"
-					print "Note: unable to parse argument " + @options["markdown_margin_array"]
+					print "Note: unable to parse argument #{@options["markdown_margin_array"]}"
 				end
 			end