combine_pdf 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47a88cf13f6bb93a5a75cbe4c227c204e16e3ec3
-  data.tar.gz: 3571716409c5586fef95c067211d4b890baa017a
+  metadata.gz: c17b1bcd778d60ecce5f1941ad98801e02ef1934
+  data.tar.gz: 74759b9ad7a766a4e50d891e9ad4629cf11b1f50
 SHA512:
-  metadata.gz: 89cce7a4ebc0dee9d51563568ea64918d8047b1d37fd7084f9dea424e6e4a06c5f5ad731fc868051d6f9c264d51ab6d7a93e8fbeb402a43542a3f4f109269273
-  data.tar.gz: 80a54f7d2c58399115b4be46a5b039fe1d0ece65c714ec878d1c22a0bf55a4d273506f8893448fdf2c1284a2646b9c1a43590e6da889e6ea25401ecd323e9161
+  metadata.gz: 549eb5a4caaa6b07bd522ea497537568932a67e79427a3e32bd28827e72dcfb8e15f4602e63337dae1f63ca49de7c0f08a19afc108b75a506276d4e719f1b7a1
+  data.tar.gz: a48b950943f4cc36712f96815aab68f310b8bc0f9debc0d2497ee3b5d7d3e3fd0a88f2957c7c6dc9ccdfbe2a2a498762494d5ed72e45686203d2de9633d9cec2

data/lib/combine_pdf.rb

@@ -1,19 +1,4 @@
 # -*- encoding : utf-8 -*-
-
-# this file is part of the CombinePDF library and the code
-# is subject to the same license (GPLv3).
-#########################################################
-
-
-
-# PDF object types cross reference:
-# Indirect objects, references, dictionaries and streams are Hash
-# arrays are Array
-# strings are String
-# names are Symbols (String.to_sym)
-# numbers are Fixnum or Float
-# boolean are TrueClass or FalseClass
-
 require 'zlib'
 require 'strscan'
 require 'combine_pdf/combine_pdf_pdf'
@@ -21,6 +6,7 @@ require 'combine_pdf/combine_pdf_decrypt'
 require 'combine_pdf/combine_pdf_filter'
 require 'combine_pdf/combine_pdf_parser'
 
+
 # This is a pure ruby library to merge PDF files.
 # In the future, this library will also allow stamping and watermarking PDFs (it allows this now, only with some issues).
 #
@@ -88,12 +74,16 @@ module CombinePDF
 	end
 end
 
-module CombinePDF #:nodoc: all
+module CombinePDF
+
+	#:nodoc: all
 	################################################################
 	## These are common functions, used within the different classes
 	## These functions aren't open to the public.
 	################################################################
+	#@private
 	PRIVATE_HASH_KEYS = [:indirect_reference_id, :indirect_generation_number, :raw_stream_content, :is_reference_only, :referenced_object, :indirect_without_dictionary]
+	#@private
 	LITERAL_STRING_REPLACEMENT_HASH = {
 		110 => 10, # "\\n".bytes = [92, 110]  "\n".ord = 10
 		114 => 13, #r
@@ -104,7 +94,9 @@ module CombinePDF #:nodoc: all
 		41 => 41, #)
 		92 => 92 #\
 		}
-	module PDFOperations #:nodoc: all
+	#@private
+	#:nodoc: all	
+	module PDFOperations
 		module_function
 		def inject_to_page page = {Type: :Page, MediaBox: [0,0,612.0,792.0], Resources: {}, Contents: []}, stream = nil, top = true
 			# make sure both the page reciving the new data and the injected page are of the correct data type.
@@ -455,6 +447,17 @@ module CombinePDF #:nodoc: all
 	end
 end
 
+#########################################################
+# this file is part of the CombinePDF library and the code
+# is subject to the same license (GPLv3).
+#########################################################
+# PDF object types cross reference:
+# Indirect objects, references, dictionaries and streams are Hash
+# arrays are Array
+# strings are String
+# names are Symbols (String.to_sym)
+# numbers are Fixnum or Float
+# boolean are TrueClass or FalseClass
 
 ## You can test performance with:
 ## puts Benchmark.measure { pdf = CombinePDF.new(file_name); pdf.save "test.pdf" } # PDFEditor.new_pdf

data/lib/combine_pdf/combine_pdf_basic_writer.rb

@@ -5,8 +5,17 @@
 ## is subject to the same license.
 ########################################################
 
-module CombinePDF #:nodoc: all
 
+
+module CombinePDF
+
+	#@private
+	#:nodoc: all
+	# This doesn't work yet!
+	# in the future I wish to make a simple PDF page writer, that has only one functions - the text box.
+	# Once the simple writer is ready (creates a text box in a self contained Page element),
+	# I could add it to the << operators and add it as either a self contained page or as an overlay.
+	# if all goes well, maybe I will also create an add_image function.
 	class PDFWriter
 
 		def initialize(media_box = [0.0, 0.0, 612.0, 792.0])

data/lib/combine_pdf/combine_pdf_decrypt.rb

@@ -5,7 +5,11 @@
 ## is subject to the same license.
 ########################################################
 
-module CombinePDF #:nodoc: all
+
+
+module CombinePDF
+	#@private
+	#:nodoc: all
 	class PDFDecrypt
 		
 		def initialize objects=[], root_doctionary = {}

data/lib/combine_pdf/combine_pdf_filter.rb

@@ -5,8 +5,12 @@
 ## is subject to the same license.
 ########################################################
 
-module CombinePDF #:nodoc: all
 
+
+module CombinePDF
+
+	#@private
+	#:nodoc: all
 	module PDFFilter
 		module_function
 		

data/lib/combine_pdf/combine_pdf_parser.rb

@@ -4,7 +4,11 @@
 ## this file is part of the CombinePDF library and the code
 ## is subject to the same license.
 ########################################################
-module CombinePDF #:nodoc: all
+
+
+
+
+module CombinePDF
 
 	########################################################
 	## This is the Parser class.
@@ -15,6 +19,8 @@ module CombinePDF #:nodoc: all
 	## file version.
 	########################################################
 
+	#@private
+	#:nodoc: all
 	class PDFParser
 		# LITERAL_STRING_REPLACEMENT_HASH = {
 		# 	110 => 10, # "\\n".bytes = [92, 110]  "\n".ord = 10

data/lib/combine_pdf/combine_pdf_pdf.rb

@@ -4,6 +4,11 @@
 ## this file is part of the CombinePDF library and the code
 ## is subject to the same license.
 ########################################################
+
+
+
+
+
 module CombinePDF
 	#######################################################
 	# PDF class is the PDF object that can save itself to
@@ -26,8 +31,19 @@ module CombinePDF
 	#   pdf.pages.each {|page| page << stamp_page} # notice the << operator is on a page and not a PDF object.
 	#######################################################
 	class PDF
-		attr_reader :objects, :info
+		# the objects attribute is an Array containing all the PDF sub-objects for te class.
+		attr_reader :objects
+		# the info attribute is a Hash that sets the Info data for the PDF.
+		# use, for example:
+		#   pdf.info[:Title] = "title"
+		attr_reader :info
+		# sets the string output format (PDF files store strings in to type of formats).
+		#
+		# Accepts:
+		# - :literal
+		# - :hex
 		attr_accessor :string_output
+		# A Float attrinute, setting and returning the PDF version of the file (1.1-1.7).
 		attr_accessor :version
 		def initialize (*args)
 			# default before setting
@@ -167,7 +183,8 @@ module CombinePDF
 		#
 		#   pdf << CombinePDF.new "second_file.pdf"
 		#
-		#   pdf.save "both_files_merged.pdf"		
+		#   pdf.save "both_files_merged.pdf"
+		# @params obj is Hash, PDF or Array of parsed PDF data.
 		def << (obj)
 			#########
 			## how should we add data to PDF?
@@ -201,6 +218,8 @@ module CombinePDF
 		end
 	end
 	class PDF #:nodoc: all
+
+		# @private
 		# this function returns all the Page objects - regardless of order and even if not cataloged
 		# could be used for finding "lost" pages... but actually rather useless. 
 		def all_pages
@@ -209,6 +228,7 @@ module CombinePDF
 			## referenced items and be reached through the connections.
 			[].tap {|out|  each_object {|obj| out << obj  if obj.is_a?(Hash) && obj[:Type] == :Page }  }
 		end
+		# @private
 		def serialize_objects_and_references(object = nil)
 			warn "connecting objects with their references (serialize_objects_and_references)."
 
@@ -250,6 +270,7 @@ module CombinePDF
 			# end
 
 		end
+		# @private
 		def renumber_object_ids(start = nil)
 			warn "Resetting Object Reference IDs"
 			@set_start_id ||= start
@@ -262,6 +283,7 @@ module CombinePDF
 			warn "Finished serializing IDs"
 		end
 
+		# @private
 		def references(indirect_reference_id = nil, indirect_generation_number = nil)
 			ref = {indirect_reference_id: indirect_reference_id, indirect_generation_number: indirect_generation_number}
 			out = []
@@ -276,9 +298,11 @@ module CombinePDF
 			end
 			out
 		end
+		# @private
 		def all_indirect_object
 			[].tap {|out| @objects.each {|obj| out << obj if (obj.is_a?(Hash) && obj[:is_reference_only].nil?) } }
 		end
+		# @private
 		def sort_objects_by_id
 			@objects.sort! do |a,b|
 				if a.is_a?(Hash) && a[:indirect_reference_id] && a[:is_reference_only].nil? && b.is_a?(Hash) && b[:indirect_reference_id] && b[:is_reference_only].nil?
@@ -288,6 +312,7 @@ module CombinePDF
 			end
 		end
 
+		# @private
 		def add_referenced(object)
 			# add references but not root
 			case 
@@ -308,6 +333,7 @@ module CombinePDF
 				end
 			end
 		end
+		# @private
 		def rebuild_catalog(*with_pages)
 			##########################
 			## Test-Run - How is that done?
@@ -348,6 +374,8 @@ module CombinePDF
 
 			catalog_object
 		end
+
+		# @private
 		# this is an alternative to the rebuild_catalog catalog method
 		# this method is used by the to_pdf method, for streamlining the PDF output.
 		# there is no point is calling the method before preparing the output.
@@ -360,6 +388,7 @@ module CombinePDF
 			catalog
 		end
 
+		# @private
 		# disabled, don't use. simpley returns true.
 		def rebuild_resources
 
@@ -402,10 +431,13 @@ module CombinePDF
 			# rebuild stream lengths?
 		end
 
+		# @private
 		# run block of code on evey object (Hash)
 		def each_object(&block)
 			PDFOperations._each_object(@objects, &block)
 		end
+
+		# @private
 		# the function rerturns true if the reference belongs to the object
 		def compare_reference_values(obj, ref)
 			if obj[:referenced_object] && ref[:referenced_object]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: combine_pdf
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Boaz Segev
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.5
 description: A nifty gem, in pure Ruby, to parse PDF files and combine (merge) them
   with other PDF files, watermark them or stamp them (all using the PDF file format).
 email: bsegev@gmail.com