nguyen 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 87249f3df0276b081523efa08c46dd8feb43db2f
-  data.tar.gz: d872b66be7d38fbd3f20f3a053b5cb6b260dda36
+SHA256:
+  metadata.gz: f506bb08df03fd015f7b9abac64a8788717daf5c3f3c7eaacc58f9c96590c7ef
+  data.tar.gz: 7f425f695f794dbddef3e7550e212e845b9cbb85cd6c5e121c9f066e3b1beb53
 SHA512:
-  metadata.gz: 0d1e6f777d4603591fc638e70af122cf1913c0aa7df534833062d653ba869bf8696b30a96e25658bc00f202dc5e241adae4acc76728629d117e2259db8bc78b2
-  data.tar.gz: bef8d65f125f49319afb248023a9be1eda31a44f5679f101d2e22d619309ffe172376a37ed2d3ad64ca323c90a639b96a74702b9e3bc8f8ab3457de6252a0df6
+  metadata.gz: 0ed2625129d36a1175e10316e771591815b6f1ed71dd85c9d6a07c38ec237cc80dad4fd6df20c2fb6de4a165d067434bafb095ab1d93d70bc3c7a58fe3da0f07
+  data.tar.gz: 4ceb1deadd047804d440e31230eeb49eaca8ddd6be5cf2c4295b6dbedb6001ea7aa9c9e63cc7c4336baa20a7ccb7c7dd803cff847f5ef60128910b5236ec9135

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)
-[![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/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:
 
@@ -49,6 +52,27 @@ pdftk.fill_form('/path/to/form.pdf', 'myform.pdf', fdf)
 # with xfdf
 xfdf = Nguyen::Xfdf.new(foo: 'bar')
 pdftk.fill_form('/path/to/form.pdf', 'myform.pdf', xfdf)
+
+# will work with xfdf or fdf xml string directly as well
+xfdf_string = <<XML
+<?xml version="1.0" encoding="UTF-8"?>
+<xfdf xmlns="http://ns.adobe.com/xfdf/" xml:space="preserve"><fields><field name="foo"><value>bar</value></field></fields></xfdf>
+XML
+# or xfdf_string = Nguyen::Xfdf.new(foo: 'bar').to_xfdf
+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:

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.open(path, 'w') << to_fdf).close
+      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
+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

@@ -14,11 +14,11 @@ module Nguyen
       @options = options
     end
 
-    # pdftk.fill_form '/path/to/form.pdf', '/path/to/destination.pdf', xfdf_or_fdf_object
-    def fill_form(template, destination, form_data_format)
+    # pdftk.fill_form '/path/to/form.pdf', '/path/to/destination.pdf', xfdf_or_fdf_object or xfdf_or_fdf_string
+    def fill_form(template, destination, form_data)
       tmp = Tempfile.new('pdf_forms-fdf')
       tmp.close
-      form_data_format.save_to tmp.path
+      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}}
       unless File.readable?(destination) && File.size(destination) > 0
@@ -28,6 +28,18 @@ module Nguyen
       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)
@@ -50,6 +62,14 @@ module Nguyen
 
     protected
 
+      def stamp_operation(operation, template, stamp_file, destination)
+        command = pdftk_command %Q("#{template}"), operation, %Q("#{stamp_file}"), 'output', %Q("#{destination}")
+        output = %x{#{command}}
+        unless File.readable?(destination) && File.size(destination) > 0
+          raise PdftkError.new("failed to #{operation} with command\n#{command}\ncommand output was:\n#{output}")
+        end
+      end
+
       def pdftk_command(*args)
         "#{pdftk} #{args.flatten.compact.join ' '} 2>&1"
       end

data/lib/nguyen/version.rb

@@ -1,3 +1,3 @@
 module Nguyen
-  VERSION = '1.0.2'
-end
+  VERSION = '2.0.0'
+end

data/lib/nguyen/xfdf.rb

@@ -37,8 +37,8 @@ module Nguyen
 
     # write fdf content to path
     def save_to(path)
-      (File.open(path, 'w') << to_xfdf).close
+      File.write(path, to_xfdf)
     end
 
   end
-end
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: nguyen
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Trung Lê
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -16,15 +15,29 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.16'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
-description: Forms for Nguyên is Ruby library that could merge PDF fields by XFDF/FDF
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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: []
@@ -44,7 +57,6 @@ homepage: http://github.com/ruby-journal/nguyen
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -52,17 +64,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.25
+      version: '0'
 requirements:
 - pdtk 1.44.1 or newer
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Fill out PDF forms by XFDF/FDF via pdftk.
 test_files: []