nguyen 1.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acfaf8065a261f6cc2b2f5b95887a48d450686b6529a315664982c13ecc0c8d0
-  data.tar.gz: 99729f86c46f23fc9846f1af8c727da593066dc9df39c4283eceba5b6bd2bb68
+  metadata.gz: 74a1c2e3015f9f5338b2e3140a85f26bc7190d6884f5fcfcd22b76bf0e5ed23a
+  data.tar.gz: 9704aa598ac801cd59171aa081ca3c3d9b76d2dc3d9d0001ea33e9dceba9e217
 SHA512:
-  metadata.gz: 5d65ce412084256c66f6061c32301f4d48772aafd28b438049877191bb93d72592cc13b9727c46d445be4d7cb8d41fb1db2163ba22c1d03d3739fd0a64907d8f
-  data.tar.gz: b8ebe36c4cbff4e667b38dad208c305035bfc18623b68bace90ff8753f0a6aa7fb203fcec0332a959b155166c9a646d3cee455bb9601cf26b2abeee9d85f7d07
+  metadata.gz: 22d0fe163418da9d6023d757d1a2a48ccd5dd976ee186d6c68e5a5965d8b49ddba1638e324e286dfeee536bd310e5ec506b62270a55fe33472119c15b6bde85f
+  data.tar.gz: 8b8328c35cd0a98be573d9dd50fb6ddb79e27b9275df57be34b682016ca7c85ecc7e88e5e966f36a99e62d2de4e107018e1927eec23b13aaf83a494c39b63b8e

data/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2014 Trung Lê
+Copyright (c) 2014 - 2026 Trung Lê
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,13 +1,16 @@
-# Nguyên the PDF Field Merger
+# Nguyễn the PDF Field Merger
 
 A very lightweight library that fill PDF forms using XFDF/FDF with pdftk
 
 You could download pdftk at http://www.accesspdf.com/pdftk/
 
-Nguyên is a fork of Jens Krämer's pdf-forms with addition of filling forms with XFDF feature.
+Nguyễn is a fork of Jens Krämer's pdf-forms with addition of filling forms with XFDF feature.
 
-[![Build Status](https://secure.travis-ci.org/ruby-journal/nguyen.png)](http://travis-ci.org/ruby-journal/nguyen)
+[![CI](https://github.com/ruby-journal/nguyen/actions/workflows/ci.yml/badge.svg)](https://github.com/ruby-journal/nguyen/actions/workflows/ci.yml)
 [![Code Climate](https://codeclimate.com/github/ruby-journal/nguyen/badges/gpa.svg)](https://codeclimate.com/github/ruby-journal/nguyen)
+[![From Vietnam with <3](https://raw.githubusercontent.com/webuild-community/badge/master/svg/love.svg)](https://webuild.community)
+[![Made in Vietnam](https://raw.githubusercontent.com/webuild-community/badge/master/svg/made.svg)](https://webuild.community)
+[![Built with WeBuild](https://raw.githubusercontent.com/webuild-community/badge/master/svg/WeBuild.svg)](https://webuild.community)
 
 ## EXAMPLE:
 
@@ -59,6 +62,19 @@ XML
 pdftk.fill_form('/path/to/form', 'myform.pdf', xfdf_string)
 ```
 
+### Stamp PDFs
+
+```ruby
+pdftk = Nguyen::PdftkWrapper.new('/usr/local/bin/pdftk')
+
+# overlay stamp.pdf (e.g. a watermark or signature) on top of every page of source.pdf
+pdftk.stamp('source.pdf', 'stamp.pdf', 'stamped.pdf')
+
+# overlay stamp.pdf page by page: page 1 of stamp.pdf onto page 1 of source.pdf, etc.
+# the last page of stamp.pdf is repeated if source.pdf has more pages
+pdftk.multistamp('source.pdf', 'stamp.pdf', 'stamped.pdf')
+```
+
 ## INSTALL:
 
     gem install nguyen

data/lib/nguyen/fdf.rb

@@ -5,9 +5,9 @@ module Nguyen
   # Straight port of Perl's PDF::FDF::Simple by Steffen Schwigon.
   # Parsing FDF files is not supported (yet).
   class Fdf
-    
+
     attr_reader :options
-    
+
     def initialize(data = {}, options = {})
       @data = data
       @options = {
@@ -20,7 +20,7 @@ module Nguyen
     # generate FDF content
     def to_fdf
       fdf = header
-      
+
       @data.each do |key, value|
         if Hash === value
           value.each do |sub_key, sub_value|
@@ -34,34 +34,42 @@ module Nguyen
       fdf << footer
       return fdf
     end
-    
+
     # write fdf content to path
     def save_to(path)
       File.write(path, to_fdf)
     end
-    
+
     protected
-    
+
     def header
-      header = "%FDF-1.2\n\n1 0 obj\n<<\n/FDF << /Fields 2 0 R"
-      
+      header = +"%FDF-1.2\n\n1 0 obj\n<<\n/FDF << /Fields 2 0 R"
+
       # /F
       header << "/F (#{options[:file]})" if options[:file]
       # /UF
       header << "/UF (#{options[:ufile]})" if options[:ufile]
       # /ID
       header << "/ID[" << options[:id].join << "]" if options[:id]
-      
+
       header << ">>\n>>\nendobj\n2 0 obj\n["
       return header
     end
 
     def field(key, value)
-      "<</T(#{key})/V" +
-        (Array === value ? "[#{value.map{ |v|"(#{quote(v)})" }.join}]" : "(#{quote(value)})") +
-        ">>\n"
+      value_string = case value
+                       when TrueClass
+                         '/1'
+                       when FalseClass
+                         '/0'
+                       when Array
+                         '[' + value.map { |v| "(#{quote(v)})" }.join + ']'
+                       else
+                         "(#{quote(value)})"
+                     end
+      "<<\n/T(#{key})\n/V #{value_string}\n>>\n"
     end
-    
+
     def quote(value)
       value.to_s.strip.
         gsub( /\\/, '\\' ).
@@ -69,7 +77,7 @@ module Nguyen
         gsub( /\)/, '\)' ).
         gsub( /\n/, '\r' )
     end
-    
+
     FOOTER =<<-EOFOOTER
 ]
 endobj
@@ -80,10 +88,10 @@ trailer
 >>
 %%EOF
 EOFOOTER
-    
+
     def footer
       FOOTER
     end
-    
+
   end
 end

data/lib/nguyen/pdf.rb

@@ -14,13 +14,13 @@ module Nguyen
 
     protected
 
-      def read_fields
-        field_output = @pdftk.call_pdftk %Q("#{path}"), 'dump_data_fields'
-        @fields = field_output.split(/^---\n/).map do |field_text|
-          if field_text =~ /^FieldName: (\w+)$/
-            $1
-          end
-        end.compact.uniq
-      end
+    def read_fields
+      field_output = @pdftk.call_pdftk path, 'dump_data_fields_utf8'
+      @fields = field_output.split("\n").map do |field_text|
+        if field_text =~ /^FieldName: (.+)$/
+          $1
+        end
+      end.compact.uniq
+    end
   end
 end

data/lib/nguyen/pdftk_wrapper.rb

@@ -1,4 +1,6 @@
 require 'tempfile'
+require 'open3'
+require 'shellwords'
 module Nguyen
   class PdftkError < StandardError
   end
@@ -19,15 +21,27 @@ module Nguyen
       tmp = Tempfile.new('pdf_forms-fdf')
       tmp.close
       form_data.respond_to?(:save_to) ? form_data.save_to(tmp.path) : File.write(tmp.path, form_data)
-      command = pdftk_command %Q("#{template}"), 'fill_form', %Q("#{tmp.path}"), 'output', destination, add_options(tmp.path)
-      output = %x{#{command}}
+      args = [template, 'fill_form', tmp.path, 'output', destination, add_options(tmp.path)]
+      output = call_pdftk(*args)
       unless File.readable?(destination) && File.size(destination) > 0
-        raise PdftkError.new("failed to fill form with command\n#{command}\ncommand output was:\n#{output}")
+        raise PdftkError.new("failed to fill form with command\n#{describe_command(args)}\ncommand output was:\n#{output}")
       end
     ensure
       tmp.unlink if tmp
     end
 
+    # pdftk.stamp '/path/to/source.pdf', '/path/to/stamp.pdf', '/path/to/destination.pdf'
+    # overlays the stamp PDF on top of every page of the source PDF
+    def stamp(template, stamp_file, destination)
+      stamp_operation 'stamp', template, stamp_file, destination
+    end
+
+    # pdftk.multistamp '/path/to/source.pdf', '/path/to/stamp.pdf', '/path/to/destination.pdf'
+    # overlays the stamp PDF onto the source PDF page by page
+    def multistamp(template, stamp_file, destination)
+      stamp_operation 'multistamp', template, stamp_file, destination
+    end
+
     # pdftk.read '/path/to/form.pdf'
     # returns an instance of Nguyen::Pdf representing the given template
     def read(path)
@@ -38,20 +52,37 @@ module Nguyen
       read(template).fields
     end
 
+    # invokes pdftk with the given arguments and returns its output (stdout
+    # and stderr combined); arguments are passed to the process verbatim,
+    # without any shell involved, so paths need no quoting or escaping
     def call_pdftk(*args)
-      %x{#{pdftk_command args}}
+      output, _status = Open3.capture2e(pdftk, *normalize_args(args))
+      output
     end
 
-    def cat(*files,output)
-      files = files[0] if files[0].class == Array
-      input = files.map{|f| %Q(#{f})}
-      call_pdftk(*input,'output',output)
+    def cat(*files, output)
+      files = files.flatten
+      input = files.flat_map { |f| f.to_s.include?('*') ? Dir.glob(f) : [f] }
+      call_pdftk(*input, 'output', output)
     end
 
     protected
 
-      def pdftk_command(*args)
-        "#{pdftk} #{args.flatten.compact.join ' '} 2>&1"
+      def stamp_operation(operation, template, stamp_file, destination)
+        args = [template, operation, stamp_file, 'output', destination]
+        output = call_pdftk(*args)
+        unless File.readable?(destination) && File.size(destination) > 0
+          raise PdftkError.new("failed to #{operation} with command\n#{describe_command(args)}\ncommand output was:\n#{output}")
+        end
+      end
+
+      def normalize_args(args)
+        args.flatten.compact.map(&:to_s)
+      end
+
+      # human readable rendition of a pdftk invocation, for error messages
+      def describe_command(args)
+        Shellwords.join([pdftk, *normalize_args(args)])
       end
 
       def add_options(pwd)
@@ -61,7 +92,8 @@ module Nguyen
           opt_args << 'flatten'
         end
         if options[:encrypt]
-          opt_args.concat ['encrypt_128bit', 'owner_pw', pwd, options[:encrypt_options]]
+          opt_args.concat ['encrypt_128bit', 'owner_pw', pwd]
+          opt_args.concat Shellwords.split(options[:encrypt_options]) if options[:encrypt_options]
         end
         opt_args
       end

data/lib/nguyen/version.rb

@@ -1,3 +1,3 @@
 module Nguyen
-  VERSION = '1.0.3'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: nguyen
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Trung Lê
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +37,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Forms for Nguyên is Ruby library that could merge PDF fields by XFDF/FDF
+description: Forms for Nguyễn is Ruby library that could merge PDF fields by XFDF/FDF
   via pdftk.
 email: trung.le@ruby-journal.com
 executables: []
@@ -58,7 +57,6 @@ homepage: http://github.com/ruby-journal/nguyen
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -66,7 +64,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -74,8 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - pdtk 1.44.1 or newer
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Fill out PDF forms by XFDF/FDF via pdftk.
 test_files: []