pdf-forms 0.6.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dafa2a5c9130fc6e580251237c45d7c423f4e178
-  data.tar.gz: ade160fa891ee6d433f0d8baedb404eee2750d44
+  metadata.gz: 00aacbca71befeb06614093686dcf6e77de19a7a
+  data.tar.gz: 65ff4a6bc3c2e9ae17b79ec2b2796667ca1cfba6
 SHA512:
-  metadata.gz: de0909cb12fc43557003d02b6fc972ee2fad1916da68b318d52df36b3fa5bb3aabd7055d6c0e9744d6f0f92c4c74a731cc87fc4e5a36de96773a27c8958620ed
-  data.tar.gz: 8f0eadfcdd96afa187303644909c5db91de9c18771731aebd2a89cac98fa63ac13289b62c7e0677428879ad484a39098c1fd5ebb63f816b0295e7227b2e4a2bb
+  metadata.gz: 3ceacae28cd5ac5389144a712d1eab0ea26e1ab3bc7e13d4cc0502d193e8fe96f3f3cc48d1e9fbad8d6219c2e81160c7d8d5a9e9ec9ca4445c4523f6923926f9
+  data.tar.gz: 921095f8f6fb83ea26fc5af61b2c8e84f6ab57316c14433dc12c1af9a1fc2e38c3af982e6ede02a48955a05d3c057969deb8690241b9d7665028db41c3b572d3

data/lib/pdf_forms.rb

@@ -1,7 +1,7 @@
 # coding: UTF-8
 
 require 'pdf_forms/version'
-require 'pdf_forms/safe_path'
+require 'pdf_forms/normalize_path'
 require 'pdf_forms/data_format'
 require 'pdf_forms/fdf'
 require 'pdf_forms/xfdf'

data/lib/pdf_forms/data_format.rb

@@ -38,7 +38,8 @@ module PdfForms
       (File.open(path, 'wb') << to_fdf).close
     end
 
-    protected
+    private
+
     def encode_data(data)
       data
     end

data/lib/pdf_forms/fdf.rb

@@ -12,7 +12,7 @@ module PdfForms
       super
     end
 
-    protected
+    private
 
     def encode_data(fdf)
       # I have yet to see a version of pdftk which can handle UTF8 input,
@@ -49,10 +49,8 @@ module PdfForms
     end
 
     def quote(value)
-      value.to_s.strip.
-        gsub( /\\/, '\\' ).
-        gsub( /\(/, '\(' ).
-        gsub( /\)/, '\)' ).
+      value.to_s.
+        gsub( /(\\|\(|\))/ ) { '\\' + $1 }.
         gsub( /\n/, '\r' )
     end
 

data/lib/pdf_forms/normalize_path.rb

@@ -0,0 +1,14 @@
+# coding: UTF-8
+
+module PdfForms
+
+  module NormalizePath
+
+    def normalize_path(path)
+      path = path.to_path if path.respond_to? :to_path
+      path.to_str
+    end
+
+  end
+
+end

data/lib/pdf_forms/pdf.rb

@@ -4,14 +4,13 @@ require 'pdf_forms/field'
 
 module PdfForms
   class Pdf
-
-    include SafePath
+    include NormalizePath
 
     attr_reader :path, :options
 
     def initialize(path, pdftk, options = {})
       @options = options
-      @path = file_path(path)
+      @path = normalize_path(path)
       raise IOError unless File.readable?(@path)
       @pdftk = pdftk
     end
@@ -29,11 +28,11 @@ module PdfForms
       fields.detect{ |f| f.name == name }
     end
 
-    protected
+    private
 
     def read_fields
       dump_method = options[:utf8_fields] ? 'dump_data_fields_utf8' : 'dump_data_fields'
-      field_output = @pdftk.call_pdftk quote_path(path), dump_method
+      field_output = @pdftk.call_pdftk path, dump_method
       @fields = field_output.split(/^---\n/).map do |field_text|
         Field.new field_text if field_text =~ /FieldName:/
       end.compact

data/lib/pdf_forms/pdftk_wrapper.rb

@@ -1,6 +1,9 @@
 # coding: UTF-8
 
 require 'tempfile'
+require 'cliver'
+require 'safe_shell'
+
 module PdfForms
   class PdftkError < StandardError
   end
@@ -8,28 +11,38 @@ module PdfForms
   # Wraps calls to PdfTk
   class PdftkWrapper
 
-    include SafePath
+    include NormalizePath
 
     attr_reader :pdftk, :options
 
+    PDFTK = 'pdftk'
+
+    # Initializes a new wrapper instance. Pdftk will be autodetected from PATH:
+    # PdftkWrapper.new(:flatten => true, :encrypt => true, :encrypt_options => 'allow Printing')
+    #
+    # The pdftk binary may also be explecitly specified:
     # PdftkWrapper.new('/usr/bin/pdftk', :flatten => true, :encrypt => true, :encrypt_options => 'allow Printing')
-    def initialize(pdftk_path, options = {})
-      @pdftk = file_path(pdftk_path)
-      raise "pdftk executable #{@pdftk} not found" unless call_pdftk('-h') =~ /pdftk\s+\d/i
+    def initialize(*args)
+      pdftk, options = normalize_args *args
+      @pdftk = Cliver.detect! pdftk
+      raise "pdftk executable #{@pdftk} not found" unless call_pdftk('-h') && $?.success?
       @options = options
     end
 
     # pdftk.fill_form '/path/to/form.pdf', '/path/to/destination.pdf', :field1 => 'value 1'
     def fill_form(template, destination, data = {}, fill_options = {})
-      q_template = safe_path(template)
-      q_destination = safe_path(destination)
+      q_template = normalize_path(template)
+      q_destination = normalize_path(destination)
       fdf = data_format(data)
       tmp = Tempfile.new('pdf_forms-fdf')
       tmp.close
       fdf.save_to tmp.path
       fill_options = {:tmp_path => tmp.path}.merge(fill_options)
-      command = pdftk_command q_template, 'fill_form', safe_path(tmp.path), 'output', q_destination, add_options(fill_options)
-      output = %x{#{command}}
+
+      args = [ q_template, 'fill_form', normalize_path(tmp.path), 'output', q_destination ]
+      append_options args, fill_options
+      result = call_pdftk *args
+
       unless File.readable?(destination) && File.size(destination) > 0
         fdf_path = nil
         begin
@@ -38,7 +51,7 @@ module PdfForms
         rescue Exception
           fdf_path = "#{$!}\n#{$!.backtrace.join("\n")}"
         end
-        raise PdftkError.new("failed to fill form with command\n#{command}\ncommand output was:\n#{output}\nfailing form data has been saved to #{fdf_path}")
+        raise PdftkError.new("failed to fill form with command\n#{pdftk} #{args.flatten.compact.join ' '}\ncommand output was:\n#{result}\nfailing form data has been saved to #{fdf_path}")
       end
     ensure
       tmp.unlink if tmp
@@ -66,47 +79,77 @@ module PdfForms
       read(template).fields.map{|f| f.name}
     end
 
+    # returns the commands output, check general execution success with
+    # $?.success?
     def call_pdftk(*args)
-      %x{#{pdftk_command args}}
+      SafeShell.execute pdftk, *(args.flatten)
     end
 
     # concatenate documents
     #
     # args: in_file1, in_file2, ... , in_file_n, output
     def cat(*args)
-      arguments = args.flatten.compact.map{|path| safe_path(path)}
+      arguments = args.flatten.compact.map{|path| normalize_path(path)}
       output = arguments.pop
-      call_pdftk(*([arguments, 'output', output].flatten))
+      call_pdftk arguments, 'output', output
     end
 
-    protected
+    # stamp one pdf with another
+    #
+    # args: primary_file, stamp_file, output
+    def stamp(primary_file, stamp_file, output)
+      call_pdftk primary_file, 'stamp', stamp_file, 'output', output
+    end
+
+    # applies each page of the stamp PDF to the corresponding page of the input PDF
+    # args: primary_file, stamp_file, output
+    def multistamp(primary_file, stamp_file, output)
+      call_pdftk primary_file, 'multistamp', stamp_file, 'output', output
+    end
+
+    private
 
     def data_format(data)
       data_format = options[:data_format] || 'Fdf'
       PdfForms.const_get(data_format).new(data)
     end
 
-    def pdftk_command(*args)
-      quote_path(pdftk) + " #{args.flatten.compact.join ' '} 2>&1"
-    end
-
     def option_or_global(attrib, local = {})
       local[attrib] || options[attrib]
     end
 
-    def add_options(local_options = {})
+    def append_options(args, local_options = {})
       return if options.empty? && local_options.empty?
-      opt_args = []
       if option_or_global(:flatten, local_options)
-        opt_args << 'flatten'
+        args << 'flatten'
       end
       if option_or_global(:encrypt, local_options)
         encrypt_pass = option_or_global(:encrypt_password, local_options)
         encrypt_pass ||= option_or_global(:tmp_path, local_options)
         encrypt_options = option_or_global(:encrypt_options, local_options)
-        opt_args.concat ['encrypt_128bit', 'owner_pw', encrypt_pass, encrypt_options]
+        args += ['encrypt_128bit', 'owner_pw', encrypt_pass, encrypt_options].flatten.compact
+      end
+      args
+    end
+
+    def normalize_args(*args)
+      args = args.dup
+      pdftk = PDFTK
+      options = {}
+      if first_arg = args.shift
+        case first_arg
+        when String
+          pdftk = first_arg
+          options = args.shift || {}
+          raise InvalidArgumentError.new("expected hash, got #{options.class.name}") unless Hash === options
+        when Hash
+          options = first_arg
+        else
+          raise InvalidArgumentError.new("expected string or hash, got #{first_arg.class.name}")
+        end
       end
-      opt_args
+      [pdftk, options]
     end
+
   end
 end

data/lib/pdf_forms/version.rb

@@ -1,5 +1,5 @@
 # coding: UTF-8
 
 module PdfForms
-  VERSION = '0.6.0'
+  VERSION = '0.6.1'
 end

data/lib/pdf_forms/xfdf.rb

@@ -7,7 +7,7 @@ module PdfForms
       super
     end
 
-    protected
+    private
 
     def encode_data(pdf_data)
       pdf_data

metadata

@@ -1,15 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: pdf-forms
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
 platform: ruby
 authors:
-- Jens Krämer
+- Jens Krämer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-14 00:00:00.000000000 Z
-dependencies: []
+date: 2015-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cliver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.2
+- !ruby/object:Gem::Dependency
+  name: safe_shell
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !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 Ruby frontend to the pdftk binary, including FDF and XFDF creation.
   Just pass your template and a hash of data to fill in.
 email:
@@ -25,9 +81,9 @@ files:
 - lib/pdf_forms/data_format.rb
 - lib/pdf_forms/fdf.rb
 - lib/pdf_forms/field.rb
+- lib/pdf_forms/normalize_path.rb
 - lib/pdf_forms/pdf.rb
 - lib/pdf_forms/pdftk_wrapper.rb
-- lib/pdf_forms/safe_path.rb
 - lib/pdf_forms/version.rb
 - lib/pdf_forms/xfdf.rb
 homepage: http://github.com/jkraemer/pdf-forms
@@ -40,17 +96,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: pdf-forms
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Fill out PDF forms with pdftk (http://www.accesspdf.com/pdftk/).

data/lib/pdf_forms/safe_path.rb

@@ -1,24 +0,0 @@
-# coding: UTF-8
-
-module PdfForms
-
-  module SafePath
-
-    def normalize_path(path)
-      fpath = file_path(path)
-      quote_path(fpath)
-    end
-
-    alias :safe_path :normalize_path
-
-    def quote_path(path)
-      %Q("#{path}")
-    end
-
-    def file_path(path)
-      path = path.to_path if path.respond_to? :to_path
-      path.to_str
-    end
-  end
-
-end