combine_pdf 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1415b642f2d84f101f6f444d16191faa35d3a6b9
-  data.tar.gz: aa872079b6576afd266bcb2b628772e80e33b9b8
+  metadata.gz: c5d50f2ddbf6142442857b65ec46d9565ae774e2
+  data.tar.gz: caaa8ac30c72919c54d28d21a4d30979a40ff41e
 SHA512:
-  metadata.gz: 78ada1b24bc160cc492b272dd31a1115a76dd217baebbac78fc259a077720427c837c053c5fe54cdfab6f84629142a45275629a714f693a6e8416bf47cb3bfa7
-  data.tar.gz: 03ced7106be2f831f5dc51df810d810f1f8b1828f8d6364800eb4d248764d30a6e67281b5d34d40fdbe5581673e9da1bed7a494f094e4a7ef4d6550c6e2984f2
+  metadata.gz: 0814bd7cfdfbd06d58506dc83f2160099bb6741c60625279850b6d8f525fa970228ce99425223a54998136cecff3593e1530bd0e77f5071d931a173bc26128ff
+  data.tar.gz: 88230912c86e10a0949c63c0a10b358da411a96a615860bd8c62985c2c62ff4d98a05b0fb5982e9f6fab7a6fb3cd8d049254660d6c1c449e84c5922783cf7552

data/lib/combine_pdf.rb

@@ -184,6 +184,114 @@ module CombinePDF
 		PDFWriter.new mediabox
 	end
 
+	# makes a PDF object containing a table
+	#
+	# all the pages in this PDF object are PDFWriter objects and are
+	# writable using the texbox function (should you wish to add a title, or more info)
+	#
+	# the main intended use of this method is to create indexes (a table of contents) for merged data.
+	#
+	# example:
+	#   pdf = CombinePDF.new_table headers: ["header 1", "another header"], table_data: [ ["this is one row", "with two columns"] , ["this is another row", "also two columns", "the third will be ignored"] ]
+	#   pdf.save "table_file.pdf"
+	#
+	# accepts a Hash with any of the following keys as well as any of the PDFWriter#textbox options:
+	# headers:: an Array of strings with the headers (will be repeated every page).
+	# table_data:: as Array of Arrays, each containing a string for each column. the first row sets the number of columns. extra columns will be ignored.
+	# font:: a registered or standard font name (see PDFWriter). defaults to nil (:Helvetica).
+	# header_font:: a registered or standard font name for the headers (see PDFWriter). defaults to nil (the font for all the table rows).
+	# max_font_size:: the maximum font size. if the string doesn't fit, it will be resized. defaults to 14.
+	# column_widths:: an array of relative column widths ([1,2] will display only the first two columns, the second twice as big as the first). defaults to nil (even widths).
+	# header_color:: the header color. defaults to [0.8, 0.8, 0.8] (light gray).
+	# main_color:: main row color. defaults to nil (transparent / white).
+	# alternate_color: alternate row color. defaults to [0.95, 0.95, 0.95] (very light gray).
+	# font_color: font color. defaults to [0,0,0] (black).
+	# border_color: border color. defaults to [0,0,0] (black).
+	# border_width: border width in PDF units. defaults to 1.
+	# header_align: the header text alignment within each column (:right, :left, :center). defaults to :center.
+	# row_align:: the row text alignment within each column. defaults to :left (:right for RTL table).
+	# direction: the table's writing direction (:ltr or :rtl). this reffers to the direction of the columns and doesn't effect text (rtl text is automatically recognized). defaults to :ltr.
+	# rows_per_page: the number of rows per page, INCLUDING the header row. deafults to 25.
+	# page_size: the size of the page in PDF points. defaults to [0, 0, 595.3, 841.9] (A4).
+	def new_table (options = {})
+		defaults = {
+			headers: nil,
+			table_data: [[]],
+			font: nil,
+			header_font: nil,
+			max_font_size: 14,
+			column_widths: nil,
+			header_color: [0.8, 0.8, 0.8],
+			main_color: nil,
+			alternate_color: [0.95, 0.95, 0.95],
+			font_color: [0,0,0],
+			border_color: [0,0,0],
+			border_width: 1,
+			header_align: :center,
+			row_align: nil,
+			direction: :ltr,
+			rows_per_page: 25,
+			page_size: [0, 0, 595.3, 841.9] #A4
+		}
+		options = defaults.merge options
+		options[:header_font] = options[:font] unless options[:header_font]
+		options[:row_align] ||= ( (options[:direction] == :rtl) ? :right : :left )
+		# assert table_data is an array of arrays
+		return false unless (options[:table_data].select {|r| !r.is_a?(Array) }).empty?
+		# compute sizes
+		page_size = options[:page_size]
+		top = page_size[3] * 0.9
+		height = page_size[3] * 0.8 / options[:rows_per_page]
+		from_side = page_size[2] * 0.1
+		width = page_size[2] * 0.8
+		columns = options[:table_data][0].length
+		column_widths = []
+		columns.times {|i| column_widths << (width/columns) }
+		if options[:column_widths]
+			scale = 0
+			options[:column_widths].each {|w| scale += w}
+			column_widths = []
+			options[:column_widths].each { |w|  column_widths << (width*w/scale) }
+		end
+		column_widths = column_widths.reverse if options[:direction] == :rtl
+		# set pdf object and start writing the data
+		table = PDF.new()
+		page = nil
+		rows_per_page = options[:rows_per_page]
+		row_number = rows_per_page + 1
+
+		options[:table_data].each do |row_data|
+			if row_number > rows_per_page
+				page = create_page page_size
+				table << page
+				row_number = 1
+				# add headers
+				if options[:headers]
+					x = from_side
+					headers = options[:headers]
+					headers = headers.reverse if options[:direction] == :rtl
+					column_widths.each_index do |i|
+						text = headers[i].to_s
+						page.textbox text, {x: x, y: (top - (height*row_number)), width: column_widths[i], height: height, box_color: options[:header_color], text_align: options[:header_align] }.merge(options).merge({font: options[:header_font]})
+						x += column_widths[i]
+					end
+					row_number += 1
+				end
+			end
+			x = from_side
+			row_data = row_data.reverse if options[:direction] == :rtl
+			column_widths.each_index do |i|
+				text = row_data[i].to_s
+				box_color = options[:main_color]
+				box_color = options[:alternate_color] if options[:alternate_color] && row_number.odd?
+				page.textbox text, {x: x, y: (top - (height*row_number)), width: column_widths[i], height: height, box_color: box_color, text_align: options[:row_align]}.merge(options)
+				x += column_widths[i]
+			end			
+			row_number += 1
+		end
+		table
+	end
+
 	# adds a correctly formatted font object to the font library.
 	#
 	# registered fonts will remain in the library and will only be embeded in

data/lib/combine_pdf/combine_pdf_basic_writer.rb

@@ -72,6 +72,7 @@ module CombinePDF
 		# height:: the height of the box. negative values will be computed from edge of page. defaults to 0 (end of page).
 		# text_align:: symbol for horizontal text alignment, can be ":center" (default), ":right", ":left"
 		# text_valign:: symbol for vertical text alignment, can be ":center" (default), ":top", ":buttom"
+		# text_padding:: a Float between 0 and 1, setting the padding for the text. defaults to 0.05 (5%).
 		# font:: a registered font name or an Array of names. defaults to ":Helvetica". The 14 standard fonts names are:
 		# - :"Times-Roman"
 		# - :"Times-Bold"
@@ -105,6 +106,7 @@ module CombinePDF
 				height: -1,
 				text_align: :center,
 				text_valign: :center,
+				text_padding: 0.1,
 				font: nil,
 				font_size: :fit_text,
 				max_font_size: nil,
@@ -122,6 +124,9 @@ module CombinePDF
 			options[:width] = mediabox[2] - options[:x] + options[:width] if options[:width] <= 0
 			options[:height] = mediabox[3] - options[:y] + options[:height] if options[:height] <= 0
 
+			# reset the padding value
+			options[:text_padding] = 0 if options[:text_padding].to_f >= 1
+
 			# create box stream
 			box_stream = ""
 			# set graphic state for box
@@ -199,29 +204,29 @@ module CombinePDF
 			text_stream = ""
 			if text.to_s != "" && options[:font_size] != 0 && (options[:font_color] || options[:stroke_color])
 				# compute x and y position for text
-				x = options[:x]
-				y = options[:y]
+				x = options[:x] + (options[:width]*options[:text_padding])
+				y = options[:y] + (options[:height]*options[:text_padding])
 
 				# set the fonts (fonts array, with :Helvetica as fallback).
 				fonts = [*options[:font], :Helvetica]
 				# fit text in box, if requested
 				font_size = options[:font_size]
 				if options[:font_size] == :fit_text
-					font_size = self.fit_text text, fonts, options[:width], options[:height]
+					font_size = self.fit_text text, fonts, (options[:width]*(1-options[:text_padding])), (options[:height]*(1-options[:text_padding]))
 					font_size = options[:max_font_size] if options[:max_font_size] && font_size > options[:max_font_size]
 				end
 
 				text_size = dimensions_of text, fonts, font_size
 
 				if options[:text_align] == :center
-					x = (options[:width] - text_size[0])/2 + x
+					x = ( ( options[:width]*(1-(2*options[:text_padding])) ) - text_size[0] )/2 + x
 				elsif options[:text_align] == :right
-					x = (options[:width] - text_size[0]) + x
+					x = ( ( options[:width]*(1-(1.5*options[:text_padding])) ) - text_size[0] ) + x
 				end
 				if options[:text_valign] == :center
-					y = (options[:height] - text_size[1])/2 + y
+					y = ( ( options[:height]*(1-(2*options[:text_padding])) ) - text_size[1] )/2 + y
 				elsif options[:text_valign] == :top
-					y = (options[:height] - text_size[1]) + y
+					y = ( options[:height]*(1-(1.5*options[:text_padding])) ) - text_size[1] + y
 				end
 
 				# set graphic state for text

data/lib/combine_pdf/combine_pdf_fonts.rb

@@ -217,7 +217,11 @@ module CombinePDF
 				old_widths = font_object[:DescendantFonts]
 				old_widths = old_widths[:referenced_object][:indirect_without_dictionary] if old_widths[:is_reference_only]
 				old_widths = old_widths[0][:referenced_object] 
-				avarage_bbox = [0, 0, 0, 0] # data is missing for full box metrics, just ignore
+				avrg_height = 360
+				avrg_height = old_widths[:XHeight] if old_widths[:XHeight]
+				avrg_height = (avrg_height + old_widths[:CapHeight])/2 if old_widths[:CapHeight]
+				avrg_width = old_widths[:AvgWidth] || 0
+				avarage_bbox = [0, 0, avrg_width, avrg_height] # data is missing for full box metrics, just ignore
 			end
 
 			# compute the metrics values using the appropiate system (TrueType vs. Type0 fonts)

data/lib/combine_pdf/combine_pdf_pdf.rb

@@ -87,17 +87,32 @@ module CombinePDF
 			@info = {}
 			if args[0].is_a? PDFParser
 				@objects = args[0].parse
+				# connecting references with original objects
+				serialize_objects_and_references
+				# make sure there is only one Catalog (the latest Catalog)
+				if args[0].root_object[:Root]
+					@objects.delete_if {|obj| obj[:Type] == :Catalog}
+					@objects << args[0].root_object[:Root]
+				else
+					last_calalog = (@objects.select {|obj| obj[:Type] == :Catalog}).last
+					unless last_calalog.nil?
+					@objects.delete_if {|obj| obj[:Type] == :Catalog}
+					@objects << last_calalog
+					end
+				end
 				@version = args[0].version if args[0].version.is_a? Float
 				@info = args[0].info_object || {}
 			elsif args[0].is_a? Array
 				# object initialization
 				@objects = args[0]
 				@version = args[1] if args[1].is_a? Float
+				# connecting references with original objects
+				serialize_objects_and_references
 			elsif args[0].is_a? Hash
 				@objects = args
+				# connecting references with original objects
+				serialize_objects_and_references
 			end
-			# connecting references with original objects
-			serialize_objects_and_references
 			# general globals
 			@string_output = :literal
 			@need_to_rebuild_resources = false
@@ -224,6 +239,10 @@ module CombinePDF
 								self
 							end
 						end
+						catalogs[:MediaBox] ||= catalogs[:Parent][:referenced_object][:MediaBox] if catalogs[:Parent].is_a?(Hash) && catalogs[:Parent][:referenced_object].is_a?(Hash) && catalogs[:Parent][:referenced_object][:MediaBox]
+						catalogs[:CropBox] ||= catalogs[:Parent][:referenced_object][:CropBox] if catalogs[:CropBox].is_a?(Hash) && catalogs[:CropBox][:referenced_object].is_a?(Hash) && catalogs[:Parent][:referenced_object][:CropBox]
+						catalogs[:MediaBox] = catalogs[:MediaBox][:referenced_object][:indirect_without_dictionary] if catalogs[:MediaBox].is_a?(Hash) && catalogs[:MediaBox][:referenced_object].is_a?(Hash) && catalogs[:MediaBox][:referenced_object][:indirect_without_dictionary]
+						catalogs[:CropBox] = catalogs[:CropBox][:referenced_object][:indirect_without_dictionary] if catalogs[:CropBox].is_a?(Hash) && catalogs[:CropBox][:referenced_object].is_a?(Hash) && catalogs[:CropBox][:referenced_object][:indirect_without_dictionary]
 						page_list << catalogs
 					when :Pages
 						page_list.push *(pages(catalogs[:Kids])) unless catalogs[:Kids].nil?
@@ -330,11 +349,8 @@ module CombinePDF
 			page_number = opt[:start_at]
 			pages.each do |page|
 				# create a "stamp" PDF page with the same size as the target page
-				mediabox = page[:MediaBox]
+				mediabox = page[:CropBox] || page[:MediaBox] || [0, 0, 595.3, 841.9]
 				stamp = PDFWriter.new mediabox
-				# set the visible dimensions to the CropBox, if it exists.
-				cropbox = page[:CropBox]
-				mediabox = cropbox if cropbox
 				# set stamp text
 				text = opt[:number_format] % page_number
 				# compute locations for text boxes

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: combine_pdf
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Boaz Segev
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-13 00:00:00.000000000 Z
+date: 2014-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-rc4