combine_pdf 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e1bf0dc605e123de2a5e4e809c079c64da812a5
-  data.tar.gz: a3f744fbab605cb9abd85332566219ab9735e421
+  metadata.gz: 51a498d24b46760b925e4127a175868febcdb19a
+  data.tar.gz: 653351536fb043e14f94afc14805f488dc612c7a
 SHA512:
-  metadata.gz: 73845fbdabd424d02f5c1494df97a2e790d38c0c8575ee78214ab2279ba359bd41533ba9a493e755059904a18bd8ef39e78d574f3eae2ccd60c411733735f942
-  data.tar.gz: 7bd08ed3ea3131a1170f583e1a2c17eae17b406af1f4cec8d19b6c8cbbc59c36dd651d1e70a848b13be7d0767bad127686f9eae288037eba881517c492505c27
+  metadata.gz: c0089692cf609b368631b7e7afd59381c65403a69bfba0e27429cef04224f08074592781500b4e8ecf645ec0b422542920dd620a18e6e5fcdfaf6459d834640e
+  data.tar.gz: 95489bd58f7afab15904398fd9d52e3594ab44ce54f75390805c4f87073162d543a2eece82501895ed495fb78b7fe6a908140ed89dcf16fe64c1db009df19fc8

data/lib/combine_pdf.rb

@@ -45,7 +45,7 @@ require "combine_pdf/font_metrics/metrics_dictionary.rb"
 # you can also add just odd or even pages:
 #   pdf = CombinePDF.new
 #   i = 0
-#   CombinePDF.new("file.pdf").pages.each do |page
+#   CombinePDF.new("file.pdf").pages.each do |page|
 #     i += 1
 #     pdf << page if i.even?
 #   end
@@ -129,6 +129,11 @@ module CombinePDF
 		raise TypeError, "couldn't parse and data, expecting type String" unless data.is_a? String
 		PDF.new( PDFParser.new(data) )
 	end
+	# makes a PDFWriter object
+	# ::mediabox an Array representing the size of the PDF document. defaults to: [0.0, 0.0, 612.0, 792.0]
+	def create_page(mediabox = [0.0, 0.0, 612.0, 792.0])
+		PDFWriter.new mediabox
+	end
 end
 
 

data/lib/combine_pdf/combine_pdf_basic_writer.rb

@@ -25,7 +25,7 @@ module CombinePDF
 	#
 	# Writing on this Page is done using the textbox function.
 	#
-	# Setting the page dimentions can be either at the new or using the mediabox method.
+	# Setting the page dimensions can be either at the new or using the mediabox method.
 	#
 	# the rest of the methods are for internal use.
 	#
@@ -59,25 +59,23 @@ module CombinePDF
 			self[:MediaBox]
 		end
 		# accessor (setter) for the :MediaBox element of the page
-		# dimentions:: an Array consisting of four numbers (can be floats) setting the size of the media box.
-		def mediabox=(dimentions = [0.0, 0.0, 612.0, 792.0])
-			self[:MediaBox] = dimentions
+		# dimensions:: an Array consisting of four numbers (can be floats) setting the size of the media box.
+		def mediabox=(dimensions = [0.0, 0.0, 612.0, 792.0])
+			self[:MediaBox] = dimensions
 		end
 
-		# <b>INCOMPLETE</b>
-		#
-		# This function, when completed, will add a simple text box to the Page represented by the PDFWriter class.
+		# This method adds a simple text box to the Page represented by the PDFWriter class.
 		# This function takes two values:
 		# text:: the text to potin the box.
 		# properties:: a Hash of box properties.
 		# the symbols and values in the properties Hash could be any or all of the following:
 		# x:: the left position of the box.
 		# y:: the BUTTOM position of the box.
-		# length:: the length of the box.
-		# height:: the height of the box.
+		# length:: the length of the box. negative values will be computed from edge of page. defaults to 0 (end of page).
+		# 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"
-		# font_name:: a Symbol representing one of the 14 standard fonts. defaults to ":Helvetica". the options are:
+		# font:: a Symbol representing one of the 14 standard fonts. defaults to ":Helvetica". the options are:
 		# - :"Times-Roman"
 		# - :"Times-Bold"
 		# - :"Times-Italic"
@@ -102,16 +100,15 @@ module CombinePDF
 		# border_width:: border width in PDF units. defaults to nil (none).
 		# box_radius:: border radius in PDF units. defaults to 0 (no corner rounding).
 		# opacity:: textbox opacity, a float between 0 (transparent) and 1 (opaque)
-		# <b>now on testing mode, defaults are different! box defaults to gray with border and rounding.</b>
 		def textbox(text, properties = {})
 			options = {
 				x: 0,
 				y: 0,
-				length: -1,
+				length: 0,
 				height: -1,
 				text_align: :center,
 				text_valign: :center,
-				font_name: :Helvetica,
+				font: :Helvetica,
 				font_size: :fit_text,
 				max_font_size: nil,
 				font_color: [0,0,0],
@@ -125,12 +122,12 @@ module CombinePDF
 			}
 			options.update properties
 			# reset the length and height to meaningful values, if negative
-			options[:length] = mediabox[2] - options[:x] if options[:length] < 0
-			options[:height] = mediabox[3] - options[:y] if options[:height] < 0
+			options[:length] = mediabox[2] - options[:x] + options[:length] if options[:length] <= 0
+			options[:height] = mediabox[3] - options[:y] + options[:height] if options[:height] <= 0
 			# fit text in box, if requested
 			font_size = options[:font_size]
 			if options[:font_size] == :fit_text
-				font_size = self.fit_text text, options[:font_name], options[:length], options[:height]
+				font_size = self.fit_text text, options[:font], options[:length], options[:height]
 				font_size = options[:max_font_size] if options[:max_font_size] && font_size > options[:max_font_size]
 			end
 
@@ -215,7 +212,7 @@ module CombinePDF
 				x = options[:x]
 				y = options[:y]
 
-				text_size = dimentions_of text, options[:font_name], font_size
+				text_size = dimensions_of text, options[:font], font_size
 				if options[:text_align] == :center
 					x = (options[:length] - text_size[0])/2 + x
 				elsif options[:text_align] == :right
@@ -249,7 +246,7 @@ module CombinePDF
 				end
 				# format text object
 				text_stream << "BT\n" # the Begine Text marker			
-				text_stream << PDFOperations._format_name_to_pdf(font options[:font_name]) # Set font name
+				text_stream << PDFOperations._format_name_to_pdf(set_font options[:font]) # Set font name
 				text_stream << " #{font_size} Tf\n" # set font size and add font operator
 				text_stream << "#{options[:font_color].join(' ')} rg\n" # sets the color state
 				text_stream << "#{x} #{y} Td\n" # set location for text object
@@ -276,7 +273,7 @@ module CombinePDF
 		end
 		# creates a font object and adds the font to the resources dictionary
 		# returns the name of the font for the content stream.
-		# font_name:: a Symbol of one of the 14 Type 1 fonts, known as the standard 14 fonts:
+		# font:: a Symbol of one of the 14 Type 1 fonts, known as the standard 14 fonts:
 		# - :"Times-Roman"
 		# - :"Times-Bold"
 		# - :"Times-Italic"
@@ -291,7 +288,7 @@ module CombinePDF
 		# - :"Courier-BoldOblique"
 		# - :Symbol
 		# - :ZapfDingbats
-		def font(font_name = :Helvetica)
+		def set_font(font = :Helvetica)
 			# refuse any other fonts that arn't basic standard fonts
 			allow_fonts = [ :"Times-Roman",
 					:"Times-Bold",
@@ -307,16 +304,16 @@ module CombinePDF
 					:"Courier-BoldOblique",
 					:Symbol,
 					:ZapfDingbats ]
-			raise "add_font(font_name) accepts only one of the 14 standards fonts - wrong font_name!" unless allow_fonts.include? font_name
+			raise "set_font(font) accepts only one of the 14 standards fonts - wrong font!" unless allow_fonts.include? font
 			# if the font exists, return it's name
 			resources[:Font] ||= {}
 			resources[:Font].each do |k,v|
-				if v.is_a?(Hash) && v[:Type] == :Font && v[:BaseFont] == font_name
+				if v.is_a?(Hash) && v[:Type] == :Font && v[:BaseFont] == font
 					return k
 				end
 			end
 			# create font object
-			font_object = { Type: :Font, Subtype: :Type1, BaseFont: font_name}
+			font_object = { Type: :Font, Subtype: :Type1, BaseFont: font}
 			# set a secure name for the font
 			name = (SecureRandom.urlsafe_base64(9)).to_sym
 			# add object to reasource

data/lib/combine_pdf/combine_pdf_operations.rb

@@ -164,6 +164,12 @@ module CombinePDF
 				return object # objects that aren't Strings, Arrays or Hashes (such as Symbols and Fixnums) aren't pointers in Ruby and are always copied.
 			end
 		end
+		# removes id and generation number values, for better comparrison
+		# and avoiding object duplication
+		# objects:: one or more objects in a PDF file/page.
+		def remove_old_ids objects
+			_each_object(objects) {|obj| obj.delete(:indirect_reference_id); obj.delete(:indirect_generation_number)}
+		end
 		def get_refernced_object(objects_array = [], reference_hash = {})
 			objects_array.each do |stored_object|
 				return stored_object if ( stored_object.is_a?(Hash) &&

data/lib/combine_pdf/combine_pdf_pdf.rb

@@ -28,7 +28,7 @@ module CombinePDF
 	# you can also add just odd or even pages:
 	#   pdf = CombinePDF.new
 	#   i = 0
-	#   CombinePDF.new("file.pdf").pages.each do |page
+	#   CombinePDF.new("file.pdf").pages.each do |page|
 	#     i += 1
 	#     pdf << page if i.even?
 	#   end
@@ -280,12 +280,12 @@ module CombinePDF
 
 		# and page numbers to the PDF
 		# options:: a Hash of options setting the behavior and format of the page numbers:
-		#   - :number_format a string representing the format for page number. defaults to ' - %d - '.
-		#   - :number_location an Array containing the location for the page numbers, can be :top, :buttom, :top_left, :top_right, :bottom_left, :bottom_right. defaults to [:top, :buttom].
-		#   - :start_at a Fixnum that sets the number for first page number. defaults to 1.
-		#   - :margin_from_height a number (PDF points) for the top and buttom margins. defaults to 45.
-		#   - :margin_from_side a number (PDF points) for the left and right margins. defaults to 15.
-		# also take all the options for PDFWriter.textbox.
+		# - :number_format a string representing the format for page number. defaults to ' - %d - '.
+		# - :number_location an Array containing the location for the page numbers, can be :top, :buttom, :top_left, :top_right, :bottom_left, :bottom_right. defaults to [:top, :buttom].
+		# - :start_at a Fixnum that sets the number for first page number. defaults to 1.
+		# - :margin_from_height a number (PDF points) for the top and buttom margins. defaults to 45.
+		# - :margin_from_side a number (PDF points) for the left and right margins. defaults to 15.
+		# the options Hash can also take all the options for PDFWriter.textbox.
 		# defaults to font_name: :Helvetica, font_size: 12 and no box (:border_width => 0, :box_color => nil).
 		def number_pages(options = {})
 			opt = {
@@ -293,7 +293,7 @@ module CombinePDF
 				number_location: [:top, :bottom],
 				start_at: 1,
 				font_size: 12,
-				font_name: :Helvetica,
+				font: :Helvetica,
 				margin_from_height: 45,
 				margin_from_side: 15
 			}
@@ -303,17 +303,17 @@ module CombinePDF
 				# create a "stamp" PDF page with the same size as the target page
 				mediabox = page[:MediaBox]
 				stamp = PDFWriter.new mediabox
-				# set the visible dimentions to the CropBox, if it exists.
+				# 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
-				text_dimantions = stamp.dimentions_of( text, opt[:font_name], opt[:font_size] )
+				text_dimantions = stamp.dimensions_of( text, opt[:font], opt[:font_size] )
 				box_width = text_dimantions[0] * 1.2
 				box_height = text_dimantions[1] * 2
-				opt[:length] ||= box_width
-				opt[:height] ||= box_height
+				opt[:length] = box_width
+				opt[:height] = box_height
 				from_height = 45
 				from_side = 15
 				page_width = mediabox[2]
@@ -397,12 +397,20 @@ module CombinePDF
 				object.each {|it| add_referenced(it)}
 			when object.is_a?(Hash)
 				if object[:is_reference_only] && object[:referenced_object]
-					unless @objects.include? object[:referenced_object]
+					found_at = @objects.find_index object[:referenced_object]
+					if found_at
+						#if the objects are equal, they might still be different objects!
+						# so, we need to make sure they are the same object for the pointers to effect id numbering
+						# and formatting operations.
+						object[:referenced_object] = @objects[found_at]
+					else @objects.include? object[:referenced_object]
+						#the object wasn't found - add it to the @objects array
 						@objects << object[:referenced_object]
 						object[:referenced_object].each do |k, v|
 							add_referenced(v) unless k == :Parent
 						end						
 					end
+
 				else
 					object.each do |k, v|
 						add_referenced(v) unless k == :Parent 
@@ -458,6 +466,9 @@ module CombinePDF
 				end
 			end
 
+			# when finished, remove the old numbering system and keep only pointers
+			PDFOperations.remove_old_ids @objects
+
 			# # Version 3
 			# # benchmark 1000.times was 3.568246 sec for pdf = CombinePDF.new "/Users/2Be/Desktop/מוצגים/20121002\ הודעת\ הערעור.pdf" }
 			# # puts Benchmark.measure { 1000.times {pdf.serialize_objects_and_references} }

data/lib/combine_pdf/font_metrics/metrics_dictionary.rb

@@ -1,17 +1,24 @@
 module CombinePDF
 	class PDFWriter < Hash
-		# This function calculates the dimentions of a string in a PDF.
+		# This function calculates the dimensions of a string in a PDF.
 		#
 		# UNICODE SUPPORT IS MISSING!
 		#
 		# text:: String containing the text for which the demantion box will be calculated.
-		# font_name:: the font name, from the 14 fonts possible. @see font
+		# font:: the font name, from the 14 fonts possible. @see font
 		# size:: the size of the text, as it will be applied in the PDF.
-		def dimentions_of(text, font_name, size = 1000)
-			metrics = METRICS_DICTIONARY[font_name]
+		def dimensions_of(text, font, size = 1000)
+			metrics = METRICS_DICTIONARY[font]
 			metrics_array = []
 			# the following is only good for latin text - unicode support is missing!!!!
-			text.each_char{|c|  metrics_array << (metrics.select {|k,v| v[:charcode] == c.bytes[0].ord}).to_a[0][1] }
+			text.each_char do |c|
+				metrics_mappings = metrics.select {|k,v| v[:charcode] == c.bytes[0].ord}
+				######
+				# need to add unicode support
+				# this is a lousy patch that puts the bounds of @ inside...
+				metrics_mappings = metrics.select {|k,v| v[:charcode] == "@".ord} if metrics_mappings.empty?
+				metrics_array << metrics_mappings.to_a[0][1]
+			end
 			max_width = metrics_array.map {|m| m ? m[:wx] : 0} .max
 			height = metrics_array.map {|m| m ? m[:boundingbox][3] : 0} .max
 			height = height - (metrics_array.map {|m| m ? m[:boundingbox][1] : 0} ).min
@@ -59,7 +66,7 @@ module CombinePDF
 		def fit_text(text, font, length, height = 10000000)
 			size = 100000
 			size_array = [size]
-			metrics = dimentions_of text, font, size
+			metrics = dimensions_of text, font, size
 			if metrics[0] > length
 				size_array << size * length/metrics[0]
 			end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: combine_pdf
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Boaz Segev