combine_pdf 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d910d296f84bd5493a258317eace2f9cabf7d4b
-  data.tar.gz: 67efe73d182be27f9ad597e48cff83c3147ab37d
+  metadata.gz: a3cb89ac3e41d8582aeee1a3805ff69081b3c334
+  data.tar.gz: e0d9e8e57a96d2dc02fe671e3b7cffef7880bfed
 SHA512:
-  metadata.gz: 8924f5bb53e5f8e00c224f360e343688b9902d1c2e7b59c319e07cc66ce763b08651619be64217d1af4a7e1029344091dcb106ffbc7ac41a3e496c5a0e0f7bbc
-  data.tar.gz: d2162982205d6c89a6ace341d8d2a3e123caff712d7c8dd3e9220ec4ce4dc67dfa2759e4429a07bc2c28d66600be00c5b6221d26c11bb34501d4fdb42092aba5
+  metadata.gz: adbe88e6e502ad73499eff03b69dbece9d046d7147fdec3ca25aa161c7e9b18adc66a76db021b3a5e5585957c9541386442f6cc46f2016724598ec40e44fbcff
+  data.tar.gz: 24be2b53ea8582ebb0cba3e48f4dbd350d67992cc4eb81f32ee48e4a1b1bda4e06c8d6d96a7e4e374097f73cb2a19f7a49b834334faa624cfe195517e60d2fae

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+#Change Log
+
+***
+
+Change log v.0.1.6
+
+**fix**: added Mutex to font library (which was shared by all PDFWriter objects) - now fonts are thread safe (PDF objects are NOT thread safe by design).
+
+**fix**: RTL recognition did not reverse brackets, it should now correctly perform brackets reversal for any of the following: (,),[,],{,},<,>.
+
+**update**: updated license to MIT.
+
+**known issues**: encrypted PDF files can sometimes silently fail (producing empty pages) - this is because on an attempted decrypt. more work should be done to support encrypted PDF files. please feel fee to help.
+
+I use this version on production, where I have control over the PDF files I use. It is beter then system calls to pdftk (which can cause all threads in ruby to hold, effectively causing my web app to hang).

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in combine_pdf.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Myst
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,117 @@
+# CombinePDF - the ruby way for merging PDF files
+CombinePDF is a nifty model, written 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 and pure Ruby code).
+
+# Install
+
+Install with ruby gems:
+```
+gem install combine_pdf
+```
+
+## Combine/Merge PDF files or Pages
+To combine PDF files (or data):
+```ruby
+pdf = CombinePDF.new
+pdf << CombinePDF.new("file1.pdf") # one way to combine, very fast.
+pdf << CombinePDF.new("file2.pdf")
+pdf.save "combined.pdf"
+```
+Or even a one liner:
+```ruby
+(CombinePDF.new("file1.pdf") << CombinePDF.new("file2.pdf") << CombinePDF.new("file3.pdf")).save("combined.pdf")
+```
+you can also add just odd or even pages:
+```ruby
+pdf = CombinePDF.new
+i = 0
+CombinePDF.new("file.pdf").pages.each do |page|
+  i += 1
+  pdf << page if i.even?
+end
+pdf.save "even_pages.pdf"
+```
+
+notice that adding all the pages one by one is slower then adding the whole file.
+## Add content to existing pages (Stamp / Watermark)
+
+To add content to existing PDF pages, first import the new content from an existing PDF file. After that, add the content to each of the pages in your existing PDF.
+
+In this example, we will add a company logo to each page:
+```ruby
+company_logo = CombinePDF.new("company_logo.pdf").pages[0]
+pdf = CombinePDF.new "content_file.pdf"
+pdf.pages.each {|page| page << company_logo} # notice the << operator is on a page and not a PDF object.
+pdf.save "content_with_logo.pdf"
+```
+Notice the << operator is on a page and not a PDF object. The << operator acts differently on PDF objects and on Pages.
+
+The << operator defaults to secure injection by renaming references to avoid conflics. For overlaying pages using compressed data that might not be editable (due to limited filter support), you can use:
+```ruby
+pdf.pages(nil, false).each {|page| page << stamp_page}
+```
+## Page Numbering
+adding page numbers to a PDF object or file is as simple as can be:
+```ruby
+pdf = CombinePDF.new "file_to_number.pdf"
+pdf.number_pages
+pdf.save "file_with_numbering.pdf"
+```
+Numbering can be done with many different options, with different formating, with or without a box object, and even with opacity values - see documentation.
+
+## Loading PDF data
+Loading PDF data can be done from file system or directly from the memory.
+
+Loading data from a file is easy:
+```ruby
+pdf = CombinePDF.new("file.pdf")
+```
+you can also parse PDF files from memory:
+```ruby
+pdf_data = IO.read 'file.pdf' # for this demo, load a file to memory
+pdf = CombinePDF.parse(pdf_data)
+```
+Loading from the memory is especially effective for importing PDF data recieved through the internet or from a different authoring library such as Prawn.
+
+Demo
+====
+
+You can see a Demo for a ["Bates stumping web-app"](http://nameless-gorge-3596.herokuapp.com/bates) and read through it's [code](http://nameless-gorge-3596.herokuapp.com/code) . Good luck :)
+
+Decryption & Filters
+====================
+
+Some PDF files are encrypted and some are compressed (the use of filters)...
+
+There is very little support for encrypted files and very very basic and limited support for compressed files.
+
+I need help with that.
+
+Comments and file structure
+===========================
+
+If you want to help with the code, please be aware:
+
+I'm a self learned hobbiest at heart. The documentation is lacking and the comments in the code are poor guidlines.
+
+The code itself should be very straight forward, but feel free to ask whatever you want.
+
+Credit
+======
+
+Caige Nichols wrote an amazing RC4 gem which I used in my code.
+
+I wanted to install the gem, but I had issues with the internet and ended up copying the code itself into the combine_pdf_decrypt class file.
+
+Credit to his wonderful is given here. Please respect his license and copyright... and mine.
+
+License
+=======
+MIT
+
+
+
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/combine_pdf.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'combine_pdf/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "combine_pdf"
+  spec.version       = CombinePdf::VERSION
+  spec.authors       = ["Boaz Segev"]
+  spec.email         = ["We try, we fail, we do, we are"]
+  spec.summary       = %q{Combine, stamp and watermark PDF files in pure Ruby.}
+  spec.description   = %q{A nifty gem, in pure Ruby, to parse PDF files and combine (merge) them with other PDF files, number the pages, watermark them or stamp them, create tables or basic text objects etc` (all using the PDF file format).}
+  spec.homepage      = "https://github.com/boazsegev/combine_pdf"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'ruby-rc4', '>= 0.1.5'
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/combine_pdf.rb

@@ -1,5 +1,4 @@
 # -*- encoding : utf-8 -*-
-# use under GPLv3 terms only
 
 require 'zlib'
 require 'securerandom'
@@ -16,6 +15,7 @@ load "combine_pdf/combine_pdf_fonts.rb"
 load "combine_pdf/combine_pdf_filter.rb"
 load "combine_pdf/combine_pdf_parser.rb"
 load "combine_pdf/combine_pdf_pdf.rb"
+require "combine_pdf/version"
 
 
 # This is a pure ruby library to combine/merge, stmap/overlay and number PDF files - as well as to create tables (ment for indexing combined files).
@@ -101,7 +101,7 @@ load "combine_pdf/combine_pdf_pdf.rb"
 #
 # == License
 #
-# GPLv3
+# MIT
 module CombinePDF
 	module_function
 
@@ -288,7 +288,7 @@ end
 
 #########################################################
 # this file is part of the CombinePDF library and the code
-# is subject to the same license (GPLv3).
+# is subject to the same license (MIT).
 #########################################################
 # PDF object types cross reference:
 # Indirect objects, references, dictionaries and streams are Hash

data/lib/combine_pdf/combine_pdf_basic_writer.rb

@@ -403,6 +403,11 @@ module CombinePDF
 		# ...still, it works (I think).
 		def reorder_rtl_content text
 			rtl_characters = "\u05d0-\u05ea\u05f0-\u05f4\u0600-\u06ff\u0750-\u077f"
+			rtl_replaces = { '(' => ')', ')' => '(',
+							'[' => ']', ']'=>'[',
+							'{' => '}', '}'=>'{',
+							'<' => '>', '>'=>'<',
+							}
 			return text unless text =~ /[#{rtl_characters}]/
 
 			out = []
@@ -412,10 +417,11 @@ module CombinePDF
 					out.unshift scanner.matched
 				elsif scanner.scan /[^#{rtl_characters}]+/
 					if out.empty? && scanner.matched.match(/[\s]$/) && !scanner.eos?
-						warn "MOVING SPACE: #{scanner.matched}"
 						white_space_to_move = scanner.matched.match(/[\s]+$/).to_s
 						out.unshift scanner.matched[0..-1-white_space_to_move.length]
 						out.unshift white_space_to_move
+					elsif scanner.matched.match /^[\(\)\[\]\{\}\<\>]$/
+						out.unshift rtl_replaces[scanner.matched]
 					else
 						out.unshift scanner.matched
 					end

data/lib/combine_pdf/combine_pdf_fonts.rb

@@ -103,7 +103,9 @@ module CombinePDF
 			new_font.cmap = font_cmap
 			new_font[:is_reference_only] = true
 			new_font[:referenced_object] = font_pdf_object
-			FONTS_LIBRARY[new_font.name] = new_font
+			FONTS_LIBRARY_MUTEX.synchronize do
+				FONTS_LIBRARY[new_font.name] = new_font
+			end
 			new_font
 		end
 
@@ -342,6 +344,10 @@ module CombinePDF
 		# the Hash listing all the fonts.
 		FONTS_LIBRARY = {}
 
+		# the Mutex for library write access
+
+		FONTS_LIBRARY_MUTEX = Mutex.new
+
 
 		# this method parses a cmap file using it's data stream
 		# FIXME:

data/lib/combine_pdf/combine_pdf_operations.rb

@@ -392,7 +392,7 @@ end
 
 #########################################################
 # this file is part of the CombinePDF library and the code
-# is subject to the same license (GPLv3).
+# is subject to the same license (MIT).
 #########################################################
 # PDF object types cross reference:
 # Indirect objects, references, dictionaries and streams are Hash

data/lib/combine_pdf/version.rb

@@ -0,0 +1,3 @@
+module CombinePdf
+  VERSION = "0.1.6"
+end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: combine_pdf
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Boaz Segev
-- Masters of the open source community
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-27 00:00:00.000000000 Z
+date: 2014-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-rc4
@@ -25,14 +24,50 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.1.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
 description: A nifty gem, in pure Ruby, to parse PDF files and combine (merge) them
   with other PDF files, number the pages, watermark them or stamp them, create tables
   or basic text objects etc` (all using the PDF file format).
-email: bsegev@gmail.com
+email:
+- We try, we fail, we do, we are
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- combine_pdf.gemspec
 - lib/combine_pdf.rb
 - lib/combine_pdf/combine_pdf_basic_writer.rb
 - lib/combine_pdf/combine_pdf_decrypt.rb
@@ -41,9 +76,10 @@ files:
 - lib/combine_pdf/combine_pdf_operations.rb
 - lib/combine_pdf/combine_pdf_parser.rb
 - lib/combine_pdf/combine_pdf_pdf.rb
+- lib/combine_pdf/version.rb
 homepage: https://github.com/boazsegev/combine_pdf
 licenses:
-- GPLv3
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -53,7 +89,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -66,4 +102,3 @@ signing_key:
 specification_version: 4
 summary: Combine, stamp and watermark PDF files in pure Ruby.
 test_files: []
-has_rdoc: