jpdfer 0.3.1-java → 0.4.0-java

data/lib/jpdfer/pdf.rb

@@ -34,67 +34,98 @@ module Jpdfer
       descriptions.count > 0 ? descriptions.first.text : ""
     end
 
-    def self.open(pdf_path, save_path, options={})
+    # A convenience method which concatenates the pages of several pdfs into one pdf. If a block is given,
+    # the new pdf is yielded and saved to +save_path+ after the block has been called.
+    #
+    # The available options are :keystore and :flatten.
+    #
+    # Returns the created pdf. If no block is given, save_as must be called to save the pdf.
+    def self.concatenate(pdfs, save_path=nil, options={})
+      output_buffer = StringIO.new
       flatten = options.delete(:flatten)
-      pdf = self.new(pdf_path, options)
+      concatenator = PdfCopyFields.new output_buffer.to_outputstream
+
+      pdfs.each do |pdf|
+        concatenator.addDocument pdf.reader
+      end
+      concatenator.close
+
+      pdf = new(StringIO.new(output_buffer.string), options)
       if block_given?
         yield pdf
         pdf.save_as(save_path, flatten)
-      else
-        pdf
       end
+      pdf
+    end
+
+    # A convenience method which initializes a new pdf. If a block is given,
+    # the new pdf is yielded and saved to +save_path+ after the block has been called.
+    #
+    # The options accept :flatten and :keystore.
+    #
+    # Returns the created pdf. If no block is given, save_as must be called to save the pdf.
+    def self.open(pdf_path, save_path=nil, options={})
+      flatten = options.delete(:flatten)
+      pdf = new(pdf_path, options)
+      if block_given?
+        yield pdf
+        pdf.save_as(save_path, flatten)
+      end
+      pdf
     end
 
     # Currently the only option is :keystore
-    def initialize(path, options = {})
-      @data = File.read(path)
-      @output_buffer = StringIO.new
-      reader = PdfReader.new(@data.to_java_bytes)
-      @stamper = create_stamper(reader, options[:keystore])
-      @saved = false
+    def initialize(file_or_path, options = {})
+      data = file_or_path.read if file_or_path.respond_to?(:read)
+      data ||= File.read file_or_path
+
+      @keystore = options[:keystore]
+
+      init(data)
     end
 
-    # helper method for initialize not ment to be used publicly
-    def create_stamper(reader, keystore = nil)
-      if keystore
-        stamper = PdfStamper.createSignature(reader, @output_buffer.to_outputstream, 0)
-        key, certificate_chain = keystore.private_key, keystore.certificate_chain
-        # TODO: Should not always be self-signed
-        signature_type = Pdf::PdfSignatureAppearance::SELF_SIGNED
-        stamper.getSignatureAppearance.setCrypto(key, certificate_chain, nil, signature_type)
-      else
-        stamper = PdfStamper.new(reader, @output_buffer.to_outputstream)
-      end
-      stamper
+    # Instances of Pdf forward any possible unknown method calls to the underlying
+    # iText PdfReader instance
+    def method_missing(method, *args)
+      return @reader.send(method, *args) if @reader.respond_to? method
+      super
+    end
+
+    # Returns an independent instance of the underlying iText PdfReader.
+    def reader
+      PdfReader.new @data.to_java_bytes
+    end
+
+    # Returns a string representation of the Pdf object
+    def inspect
+      "<Jpdfer::Pdf @reader=#{@reader}, @stamper=#{@stamper}>"
     end
 
     # Writes PDF to +path+. If +flatten+ is true, also flattens the form
     # so that the form is printed on the PDF document but the form is no
     # longer editable.
     #
-    # Once a this has been called the PDF becomes read-only and any
-    # subsequent calls to +save_as+, +set_field+, or +set_fields+
-    # will raise an ReadOnlyError.
-    #
     # save_as returns *UNTESTED* if the PDF form is not valid
     def save_as(path, flatten=false)
-      raise ReadOnlyError.new("Cannot save a previously saved pdf") if @saved
-      @saved = true
       if flatten
         metadata = self.class.create_flatten_fields_xml(fields)
         @stamper.setXmpMetadata metadata.to_java_bytes
       end
+
       @stamper.setFormFlattening(flatten)
       @stamper.close
+
       File.open(path, 'wb') do |file|
         file.write(@output_buffer.string)
       end
+
+      init(@output_buffer.string)
     end
 
     # Returns the page size of the pdf as [width (Float), height (Float)]
     def page_size
-      page_size = @stamper.reader.crop_box(1)
-      if @stamper.reader.page_rotation(1) % 180 == 0
+      page_size = @reader.crop_box(1)
+      if @reader.page_rotation(1) % 180 == 0
         [page_size.width, page_size.height]
       else
         [page_size.height, page_size.width]
@@ -111,11 +142,9 @@ module Jpdfer
     # fields returns an empty hash if PDF document does not contain a form
     def fields
       form = @stamper.getAcroFields
-      h = {}
-      form.getFields.each_pair do |name, value|
-        h[name.to_sym] = form.getField(name)
+      form.getFields.each_with_object({}) do |(name, value), fields|
+        fields[name.to_sym] = form.getField(name)
       end
-      h
     end
 
     # Returns value of named field.
@@ -129,10 +158,8 @@ module Jpdfer
 
     # Sets named field. set_field returns value set.
     #
-    # Raises Pdf::NonexistentFieldError if field does not exist.
     # +name+: Symbol naming the field to write
     def set_field(name, value)
-      raise ReadOnlyError.new('Previously saved pdfs are read-only') if @saved
       name = name.to_sym
       raise NonexistentFieldError.new("'#{name}' field does not exist in form") unless has_field?(name)
       @stamper.getAcroFields.setField(name.to_s, value.to_s)
@@ -142,7 +169,6 @@ module Jpdfer
     # Sets many fields at once. Returns the hash of fields set (should
     # always be equal to given set of fields).
     #
-    # Raises Pdf::NonexistentFieldError if any field does not exist.
     # +fields+:: A hash of :key => "value" pairs.
     def set_fields(fields)
       fields.each_pair do |name, value|
@@ -167,20 +193,32 @@ module Jpdfer
     # form in this pdf before flattening.
     # Returns an empty hash if there are not any.
     def flattened_fields
-      reader = @stamper.reader
-      metadata_string = String.from_java_bytes reader.getMetadata
+      metadata_string = String.from_java_bytes @reader.getMetadata
       description_text = self.class.description_from_metadata_xml(metadata_string)
       begin
         metadata = JSON(description_text)
-        _flattened_fields = metadata.key?('jpdfer_flattened_fields') ? metadata['jpdfer_flattened_fields'] : {}
+        flattened_fields = metadata.key?('jpdfer_flattened_fields') ? metadata['jpdfer_flattened_fields'] : {}
       rescue JSON::ParserError
-        _flattened_fields = {}
+        flattened_fields = {}
       end
-      h = {}
-      _flattened_fields.each_pair do |name, value|
-        h[name.to_sym] = value
+      flattened_fields.each_with_object({}) do |(name, value), fields|
+        fields[name.to_sym] = value
       end
-      h
+    end
+
+    # Adds viewer preferences to the pdf.
+    # For all possible key value pairs see:
+    # http://api.itextpdf.com/itext/com/itextpdf/text/pdf/interfaces/PdfViewerPreferences.html#addViewerPreference(com.itextpdf.text.pdf.PdfName, com.itextpdf.text.pdf.PdfObject)
+    #
+    # keys and values can be passed in as lower or upper case symbols or strings
+    def add_viewer_preference(key, value)
+      converted_key = PdfName.const_get(key.upcase) rescue nil
+      converted_key ||= PdfBoolean.const_get(key.upcase)
+
+      converted_value = PdfName.const_get(value.upcase) rescue nil
+      converted_value ||= PdfBoolean.const_get(value.upcase)
+
+      @stamper.add_viewer_preference(converted_key, converted_value)
     end
 
     # true if the receiving Pdf instance was previously flattened with jpdfer
@@ -190,7 +228,7 @@ module Jpdfer
 
     # Returns the certification level of the pdf
     def certification_level
-      case @stamper.reader.getCertificationLevel
+      case @reader.getCertificationLevel
       when PdfSignatureAppearance::CERTIFIED_FORM_FILLING
         level = :form_filling
       when PdfSignatureAppearance::CERTIFIED_FORM_FILLING_AND_ANNOTATIONS
@@ -241,6 +279,35 @@ module Jpdfer
       canvas.addImage(image, false)
     end
 
-  end
+    # Replaces any javascript currently attached to the page with
+    # the contents of +script+
+    #
+    # Returns +script+
+    def javascript=(script)
+      @stamper.addJavaScript(script)
+      script
+    end
+
+    private
 
+    def init(data)
+      @data = data
+      @reader = PdfReader.new(data.to_java_bytes)
+      @output_buffer = StringIO.new
+      @stamper = create_stamper
+    end
+
+    def create_stamper
+      if @keystore
+        stamper = PdfStamper.createSignature(@reader, @output_buffer.to_outputstream, 0)
+        key, certificate_chain = @keystore.private_key, @keystore.certificate_chain
+        # TODO: Should not always be self-signed
+        signature_type = Pdf::PdfSignatureAppearance::SELF_SIGNED
+        stamper.getSignatureAppearance.setCrypto(key, certificate_chain, nil, signature_type)
+      else
+        stamper = PdfStamper.new(@reader, @output_buffer.to_outputstream)
+      end
+      stamper
+    end
+  end
 end

data/lib/jpdfer/version.rb

@@ -1,3 +1,3 @@
 module Jpdfer
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

data/spec/{acceptance/jpdfer/pdf_acceptance_spec.rb → pdf_spec.rb}

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 module Jpdfer
 
-describe "Pdf Acceptance" do
+describe Pdf do
   before(:each) do
     @data_path = File.join(ROOT, 'spec', 'data')
     @pdf_path = File.join(@data_path, 'simple_form.pdf')
@@ -109,7 +109,7 @@ describe "Pdf Acceptance" do
       FileUtils.rm_f(@save_path)
     end
 
-    it 'should instaniate a new pdf a pass it to the block and then save it' do
+    it 'should instaniate a new pdf and yield it to the block and then save it' do
       Pdf.open(@pdf_path, @save_path) do |pdf|
         pdf.set_fields(@filled_fields)
       end
@@ -128,6 +128,41 @@ describe "Pdf Acceptance" do
     end
   end
 
+  describe '.concatenate' do
+    before(:each) do
+      @pdf_1, @pdf_2 = Pdf.new(@pdf_path), Pdf.new(@pdf_path)
+      @save_path = File.join(@data_path, 'new_pdf.pdf')
+    end
+
+    after(:each) do
+      FileUtils.rm_f(@save_path)
+    end
+
+    it 'should return a new pdf with the pages of all the given pdfs' do
+      pdf = Pdf.concatenate([@pdf_1, @pdf_2])
+      pdf.number_of_pages.should == @pdf_1.number_of_pages + @pdf_2.number_of_pages
+    end
+
+    it 'should yield the pdf if given a block and then save it' do
+      Pdf.concatenate([@pdf_1, @pdf_2], @save_path) do |pdf|
+        pdf.number_of_pages.should == @pdf_1.number_of_pages + @pdf_2.number_of_pages
+      end
+
+      new_pdf = Pdf.new(@save_path)
+      new_pdf.number_of_pages.should == @pdf_1.number_of_pages + @pdf_2.number_of_pages
+    end
+  end
+
+  describe 'forwards any potential messages to the reader if it will respond' do
+    it 'should respond to number_of_pages' do
+      @pdf.number_of_pages.should == 1
+    end
+
+    it 'should not respond to foo_bar' do
+      lambda { @pdf.foo_bar }.should raise_error NoMethodError
+    end
+  end
+
   describe '#page_size' do
     it 'should return the page size as an array of floats' do
       @pdf.page_size.should == [612.0, 792.0]
@@ -274,30 +309,6 @@ describe "Pdf Acceptance" do
         new_pdf.should_not have_form
       end
     end
-
-    describe 'with a saved PDF' do
-      before(:each) do
-        @pdf.save_as(@new_path)
-      end
-
-      describe 'saving again' do
-        it "should raise Pdf::ReadOnlyError" do
-          lambda { @pdf.save_as(@new_path) }.should raise_error(Pdf::ReadOnlyError, /Cannot save a previously saved pdf/)
-        end
-      end
-
-      describe "#set_field" do
-        it "should raise Pdf:ReadOnlyError" do
-          lambda { @pdf.set_field(:important_field, 'I am important') }.should raise_error(Pdf::ReadOnlyError, /Previously saved pdfs are read-only/)
-        end
-      end
-
-      describe "#set_fields" do
-        it "should raise Pdf::ReadOnlyError" do
-          lambda { @pdf.set_fields(@filled_fields) }.should raise_error(Pdf::ReadOnlyError, /Previously saved pdfs are read-only/)
-        end
-      end
-    end
   end
 
   describe '#has_field?' do

metadata

@@ -1,114 +1,107 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: jpdfer
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.3.1
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.4.0
 platform: java
-authors: 
-  - Scott Nielsen
-  - David Brady
-autorequire: 
+authors:
+- Scott Nielsen
+- David Brady
+autorequire:
 bindir: bin
 cert_chain: []
-
-date: 2012-09-21 00:00:00 Z
-dependencies: 
-  - !ruby/object:Gem::Dependency 
-    name: nokogiri
-    prerelease: false
-    requirement: &id001 !ruby/object:Gem::Requirement 
-      none: false
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            version: "0"
-    type: :runtime
-    version_requirements: *id001
-  - !ruby/object:Gem::Dependency 
-    name: json-jruby
-    prerelease: false
-    requirement: &id002 !ruby/object:Gem::Requirement 
-      none: false
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            version: "0"
-    type: :runtime
-    version_requirements: *id002
-  - !ruby/object:Gem::Dependency 
-    name: rspec
-    prerelease: false
-    requirement: &id003 !ruby/object:Gem::Requirement 
-      none: false
-      requirements: 
-        - - ">="
-          - !ruby/object:Gem::Version 
-            version: "0"
-    type: :development
-    version_requirements: *id003
+date: 2012-09-26 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  version_requirements: &2058 !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: *2058
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: json-jruby
+  version_requirements: &2076 !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: *2076
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: &2092 !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: *2092
+  prerelease: false
+  type: :development
 description: Ruby-style wrapper in JRuby for reading and writing PDF forms
 email: scottnielsen5@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-  - README.rdoc
-  - jars/bcmail-jdk16-146.jar
-  - jars/bcprov-jdk16-146.jar
-  - jars/bctsp-jdk16-146.jar
-  - jars/itextpdf-5.1.1.jar
-  - lib/jpdfer.rb
-  - lib/jpdfer/key_store.rb
-  - lib/jpdfer/page_sizes.rb
-  - lib/jpdfer/pdf.rb
-  - lib/jpdfer/version.rb
-  - spec/spec_helper.rb
-  - spec/acceptance/jpdfer/pdf_acceptance_spec.rb
-  - spec/lib/jpdfer/pdf_spec.rb
-  - spec/data/keystore.ks
-  - spec/data/flattened.pdf
-  - spec/data/simple_form.pdf
-  - spec/data/simple_form_flattened.pdf
-  - spec/data/simple_form_flattened_signed.pdf
-  - spec/data/simple_form_signed_by_someone_else.pdf
+files:
+- README.rdoc
+- jars/bcmail-jdk16-146.jar
+- jars/bcprov-jdk16-146.jar
+- jars/bctsp-jdk16-146.jar
+- jars/itextpdf-5.1.1.jar
+- lib/jpdfer.rb
+- lib/jpdfer/key_store.rb
+- lib/jpdfer/page_sizes.rb
+- lib/jpdfer/pdf.rb
+- lib/jpdfer/version.rb
+- spec/pdf_spec.rb
+- spec/spec_helper.rb
+- spec/data/keystore.ks
+- spec/data/flattened.pdf
+- spec/data/simple_form.pdf
+- spec/data/simple_form_flattened.pdf
+- spec/data/simple_form_flattened_signed.pdf
+- spec/data/simple_form_signed_by_someone_else.pdf
 homepage: http://github.com/scizo/jpdfer
 licenses: []
-
-post_install_message: 
-rdoc_options: 
-  - --main
-  - README.rdoc
-require_paths: 
-  - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+post_install_message:
+rdoc_options:
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
   none: false
-  requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
   none: false
-  requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
 requirements: []
-
-rubyforge_project: 
+rubyforge_project:
 rubygems_version: 1.8.15
-signing_key: 
+signing_key:
 specification_version: 3
 summary: Read and write PDF forms in JRuby
-test_files: 
-  - spec/spec_helper.rb
-  - spec/acceptance/jpdfer/pdf_acceptance_spec.rb
-  - spec/lib/jpdfer/pdf_spec.rb
-  - spec/data/keystore.ks
-  - spec/data/flattened.pdf
-  - spec/data/simple_form.pdf
-  - spec/data/simple_form_flattened.pdf
-  - spec/data/simple_form_flattened_signed.pdf
-  - spec/data/simple_form_signed_by_someone_else.pdf
+test_files:
+- spec/pdf_spec.rb
+- spec/spec_helper.rb
+- spec/data/keystore.ks
+- spec/data/flattened.pdf
+- spec/data/simple_form.pdf
+- spec/data/simple_form_flattened.pdf
+- spec/data/simple_form_flattened_signed.pdf
+- spec/data/simple_form_signed_by_someone_else.pdf
+...

data/spec/lib/jpdfer/pdf_spec.rb

@@ -1,20 +0,0 @@
-require 'spec_helper'
-
-
-module Jpdfer
-# IMPORTANT: These are model/unit specs! Test in isolation as much as possible!
-describe Pdf do
-  before(:each) do
-    @data_path = File.join(ROOT, 'spec', 'data')
-    @pdf_path = File.join(@data_path, 'simple_form.pdf')
-    @pdf = Pdf.new(@pdf_path)
-  end
-
-  describe '.new' do
-    it 'should create new pdf' do
-      @pdf.should_not be_nil
-    end
-  end
-end
-
-end