combine_pdf 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4bac3486fb9fc968d2ca625eb4ad9c0f9423cc7
-  data.tar.gz: 5d7d3b20987af05c2cf71c2513bf09418125cae3
+  metadata.gz: 60f4dfc06ecb66c5c876b69028868bbd5bb7cde9
+  data.tar.gz: 5a0944cbfdbc39283fbb62a2205f5897ecbb6dd0
 SHA512:
-  metadata.gz: cb03d4476aa78f13d783142c9f91263814d5c9dce299ceb5728dddc79cac0253f4d45ea048953dc69b04fa4ad8416926cd09f05c124ba3b6f3169b827fed86be
-  data.tar.gz: c3dbbfc3716b9caa49ffc1b98282a266d20ebf66a126d2cd7d8a06699ed196a97491a51ad425e1d0d4dcc940eb87721e5114b9aed3d2511b4f0ae33ec05ebb6a
+  metadata.gz: fea4291167b6d5f0585bba371467e552dafbc32aeb957312a28fda7e0431bac20f35c49ee64bf36fac0b7c18ce5d1c89097db18e3af8170318c6401a56c07af7
+  data.tar.gz: 329afc35c2754b77b77fec6606be4e6938f535bff5e7bc1e0f1b02bf75dbf077174221448ec86cbcf0109a42e77446a9041079a75fc727bc16503b93d5151b8d

data/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 ***
 
+Change log v.0.2.1
+
+**fix**: better page stamping... or, at least more secure (we hope).
+
+**feature**: added the PDF#stamp shortcut method. Credit to Tania (@taniarv) for the concept.
+
+**fix**: possible string encoding issues could have arose when strings were rendered to PDF format. Credit to Tania (@taniarv) for exposing the issue.
+
+**feature**: Metadata is now easiyer to set by allowing fast access to the Information header when using PDF#save and PDF#to_pdf. Credit to Tania (@taniarv) for code.
+
+***
+
 Change log v.0.2.0
 
 Refractoring of code and API overhall.

data/lib/combine_pdf/page_methods.rb

@@ -73,15 +73,12 @@ module CombinePDF
 			if top # if this is a stamp (overlay)
 				insert_content CONTENT_CONTAINER_START, 0
 				insert_content CONTENT_CONTAINER_MIDDLE
-				obj[:Contents].each {|c| insert_content c }
+				self[:Contents].concat obj[:Contents]
 				insert_content CONTENT_CONTAINER_END
 			else #if this was a watermark (underlay? would be lost if the page was scanned, as white might not be transparent)
-				old_contents = self[:Contents]
-				self[:Contents] = []
-				insert_content CONTENT_CONTAINER_START
-				obj[:Contents].each {|c| insert_content c }
-				insert_content CONTENT_CONTAINER_MIDDLE
-				old_contents.each { |c| insert_content c }
+				insert_content CONTENT_CONTAINER_MIDDLE, 0
+				insert_content CONTENT_CONTAINER_START, 0
+				self[:Contents].insert 1, *obj[:Contents]
 				insert_content CONTENT_CONTAINER_END
 			end
 			init_contents

data/lib/combine_pdf/pdf_public.rb

@@ -106,7 +106,7 @@ module CombinePDF
 
 			# general globals
 			@set_start_id = 1
-			@info[:Producer] = "Ruby CombinePDF #{CombinePDF::VERSION} Library by B. Segev"
+			@info[:Producer] = "Ruby CombinePDF #{CombinePDF::VERSION} Library"
 			@info.delete :CreationDate
 			@info.delete :ModDate
 		end
@@ -149,8 +149,8 @@ module CombinePDF
 		# file_name:: is a string or path object for the output.
 		#
 		# **Notice!** if the file exists, it **WILL** be overwritten.
-		def save(file_name)
-			IO.binwrite file_name, to_pdf
+		def save(file_name, options = {})
+			IO.binwrite file_name, to_pdf(options)
 		end
 
 		# Formats the data to PDF formats and returns a binary string that represents the PDF file content.
@@ -158,7 +158,7 @@ module CombinePDF
 		# This method is used by the save(file_name) method to save the content to a file.
 		#
 		# use this to export the PDF file without saving to disk (such as sending through HTTP ect').
-		def to_pdf
+		def to_pdf options = {}
 			#reset version if not specified
 			@version = 1.5 if @version.to_f == 0.0
 			#set creation date for merged file
@@ -193,6 +193,9 @@ module CombinePDF
 			out << "/Size #{indirect_object_count.to_s}"
 			if @info.is_a?(Hash)
 				PRIVATE_HASH_KEYS.each {|key| @info.delete key} # make sure the dictionary is rendered inline, without stream
+				@info[:CreationDate] = @info[:ModDate] = Time.now.strftime "D:%Y%m%d%H%M%S%:::z'00"
+				@info[:Subject] = options[:subject] if options[:subject]
+				@info[:Producer] = options[:producer] if options[:producer]
 				out << "/Info #{object_to_pdf @info}"
 			end
 			out << ">>\nstartxref\n#{xref_location.to_s}\n%%EOF"
@@ -336,16 +339,16 @@ module CombinePDF
 		#
 		# 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 ' - %s - ' (allows for letter numbering as well, such as "a", "b"...).
-		# - :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].
+		# - :location an Array containing the location for the page numbers, can be :top, :buttom, :top_left, :top_right, :bottom_left, :bottom_right or :center (:center == full page). defaults to [:top, :buttom].
 		# - :start_at a Fixnum that sets the number for first page number. also accepts a letter ("a") for letter numbering. 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.
+		# - :page_range a range of pages to be numbered (i.e. (2..-1) ) defaults to all the pages (nil). Remember to set the :start_at to the correct value.
+		# the options Hash can also take all the options for {Page_Methods#textbox}.
 		# defaults to font: :Helvetica, font_size: 12 and no box (:border_width => 0, :box_color => nil).
 		def number_pages(options = {})
 			opt = {
 				number_format: ' - %s - ',
-				number_location: [:top, :bottom],
 				start_at: 1,
 				font_size: 12,
 				font: :Helvetica,
@@ -353,12 +356,15 @@ module CombinePDF
 				margin_from_side: 15
 			}
 			opt.update options
+			opt[:number_location] ||= opt[:stamp_location] ||= opt[:location] ||= [:top, :bottom]
 			page_number = opt[:start_at]
-			pages.each do |page|
+			format_repeater = opt[:number_format].count('%')
+			(opt[:page_range] ? pages[opt[:page_range]] : pages).each do |page|
 				# Get page dimensions
 				mediabox = page[:CropBox] || page[:MediaBox] || [0, 0, 595.3, 841.9]
 				# set stamp text
-				text = opt[:number_format] % page_number
+				text = opt[:number_format] % (Array.new(format_repeater) {page_number})
+				# text = opt[:number_format] % page_number
 				# compute locations for text boxes
 				text_dimantions = page.dimensions_of( text, opt[:font], opt[:font_size] )
 				box_width = text_dimantions[0] * 1.2
@@ -392,8 +398,36 @@ module CombinePDF
 				if opt[:number_location].include? :bottom_right
 					 page.textbox text, {x: right_position, y: bottom_position }.merge(opt)
 				end
+				if opt[:number_location].include? :center
+					 page.textbox text, opt
+				end
 				page_number = page_number.succ
 			end
+
+		end
+		# This method stamps all (or some) of the pages is the PDF with the requested stamp.
+		#
+		# The method accept:
+		# stamp:: either a String or a PDF page. If this is a String, you can add formating to add page numbering (i.e. "page number %i"). otherwise remember to escape any percent ('%') sign (i.e. "page \%number not shown\%").
+		# options:: an options Hash.
+		#
+		# If the stamp is a String, than all the options used by {#number_pages} or {Page_Methods#textbox} can be used.
+		#
+		# If the stamp is a PDF page, only :page_range and :underlay (to reverse-stamp) are valid options.
+		def stamp_pages stamp, options = {}
+			case stamp
+			when String
+				number_pages({number_format: stamp}.merge(options))
+			when Page_Methods
+				# stamp = stamp.copy(true) 
+				if options[:underlay]
+					(options[:page_range] ? pages[options[:page_range]] : pages).each {|p| p >> stamp}
+				else
+					(options[:page_range] ? pages[options[:page_range]] : pages).each {|p| p << stamp}
+				end
+			else
+				raise TypeError, "expecting a String or a PDF page as the stamp."
+			end
 		end
 
 	end

data/lib/combine_pdf/renderer.rb

@@ -34,11 +34,7 @@ module CombinePDF
 			end
 		end
 
-		def format_string_to_pdf(object)
-			object.force_encoding(Encoding::ASCII_8BIT)
-			if !object.force_encoding(Encoding::ASCII_8BIT).match(/[^D\:\d\+\-\Z\']/) #if format is set to Literal
-				#### can be better...
-				replacement_hash = {
+		STRING_REPLACEMENT_HASH = {
 					"\x0A" => "\\n",
 					"\x0D" => "\\r",
 					"\x09" => "\\t",
@@ -48,9 +44,13 @@ module CombinePDF
 					"\x29" => "\\)",
 					"\x5C" => "\\\\"
 				}
-				32.times {|i| replacement_hash[i.chr] ||= "\\#{i}"}
-				(256-128).times {|i| replacement_hash[(i + 127).chr] ||= "\\#{i+127}"}
-				("(" + ([].tap {|out| object.bytes.each {|byte| replacement_hash[ byte.chr ] ? (replacement_hash[ byte.chr ].bytes.each {|b| out << b}) : out << byte } }).pack('C*') + ")").force_encoding(Encoding::ASCII_8BIT)
+		32.times {|i| STRING_REPLACEMENT_HASH[i.chr] ||= "\\#{i}"}
+		(256-128).times {|i| STRING_REPLACEMENT_HASH[(i + 127).chr] ||= "\\#{i+127}"}
+
+		def format_string_to_pdf(object)
+			# object.force_encoding(Encoding::ASCII_8BIT)
+			if !object.match(/[^D\:\d\+\-\Z\']/) #if format is set to Literal
+				("(" + ([].tap {|out| object.bytes.each {|byte| STRING_REPLACEMENT_HASH[ byte.chr ] ? (STRING_REPLACEMENT_HASH[ byte.chr ].bytes.each {|b| out << b}) : out << byte } }).pack('C*') + ")").force_encoding(Encoding::ASCII_8BIT)
 			else
 				# A hexadecimal string shall be written as a sequence of hexadecimal digits (0–9 and either A–F or a–f)
 				# encoded as ASCII characters and enclosed within angle brackets (using LESS-THAN SIGN (3Ch) and GREATER- THAN SIGN (3Eh)). 

data/lib/combine_pdf/version.rb

@@ -1,3 +1,3 @@
 module CombinePDF
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: combine_pdf
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Boaz Segev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-26 00:00:00.000000000 Z
+date: 2015-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-rc4
@@ -101,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.7
 signing_key: 
 specification_version: 4
 summary: Combine, stamp and watermark PDF files in pure Ruby.