nguyen 0.0.2 → 1.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: acfaf8065a261f6cc2b2f5b95887a48d450686b6529a315664982c13ecc0c8d0
+  data.tar.gz: 99729f86c46f23fc9846f1af8c727da593066dc9df39c4283eceba5b6bd2bb68
+SHA512:
+  metadata.gz: 5d65ce412084256c66f6061c32301f4d48772aafd28b438049877191bb93d72592cc13b9727c46d445be4d7cb8d41fb1db2163ba22c1d03d3739fd0a64907d8f
+  data.tar.gz: b8ebe36c4cbff4e667b38dad208c305035bfc18623b68bace90ff8753f0a6aa7fb203fcec0332a959b155166c9a646d3cee455bb9601cf26b2abeee9d85f7d07

data/CONTRIBUTING.md

@@ -0,0 +1,49 @@
+## Filing an issue
+
+When filing an issue, please provide these details:
+
+* A comprehensive list of steps to reproduce the issue.
+* The version of Nguyen.
+* Any relevant stack traces ("Full trace" preferred)
+
+In 99% of cases, this information is enough to determine the cause and solution to the problem that is being described.
+
+Any issue that is open for 14 days without actionable information or activity will be marked as "stalled" and then closed. Stalled issues can be re-opened if the information requested is provided.
+
+## Pull requests
+
+We gladly accept pull requests to fix bugs and, in some circumstances, add new features to Spree.
+
+Here's a quick guide:
+
+1. Fork the repo.
+
+2. Run the tests. We only take pull requests with passing tests, and it's great
+to know that you have a clean slate:
+
+        bundle install
+        bundle exec rake test
+
+3. Add a test for your change. Only refactoring and documentation changes
+require no new tests. If you are adding functionality or fixing a bug, we need
+a test!
+
+4. Make the test pass.
+
+5. Push to your fork and submit a pull request. If the changes will apply cleanly to the latest stable branches and master branch, you will only need to submit one pull request.
+
+At this point you're waiting on us. We like to at least comment on, if not
+accept, pull requests within three business days (and, typically, one business
+day). We may suggest some changes or improvements or alternatives.
+
+Syntax:
+
+* Two spaces, no tabs.
+* No trailing whitespace. Blank lines should not have any space.
+* Prefer &&/|| over and/or.
+* `MyClass.my_method(my_arg)` not `my_method( my_arg )` or my_method my_arg.
+* `a = b` and not `a=b`.
+* `a_method { |block| ... }` and not `a_method { | block | ... }`
+* Follow the conventions you see used in the source already.
+
+And in case we didn't emphasize it enough: we love tests!

data/LICENSE

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2012 Trung Lê
+Copyright (c) 2014 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

@@ -0,0 +1,76 @@
+# 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.
+
+[![Build Status](https://secure.travis-ci.org/ruby-journal/nguyen.png)](http://travis-ci.org/ruby-journal/nguyen)
+[![Code Climate](https://codeclimate.com/github/ruby-journal/nguyen/badges/gpa.svg)](https://codeclimate.com/github/ruby-journal/nguyen)
+
+## EXAMPLE:
+
+### FDF creation
+
+```ruby
+fdf = Nguyen::Fdf.new(key: 'value', other_key: 'other value')
+# use to_fdf if you just want the FDF data, without writing it to a file
+puts fdf.to_fdf
+# write fdf file
+fdf.save_to('path/to/file.fdf')
+```
+
+### XFDF creation
+
+```ruby
+xfdf = Nguyen::Xfdf.new(key: 'value', other_key: 'other value')
+# use to_xfdf if you just want the XFDF data, without writing it to a file
+puts xfdf.to_xfdf
+# write xfdf file
+xfdf.save_to('path/to/file.xfdf')
+```
+
+### Query form fields and fill out PDF forms with pdftk
+
+```ruby
+# adjust the pdftk path to suit your pdftk installation
+pdftk = Nguyen::PdftkWrapper.new('/usr/local/bin/pdftk')
+
+# find out the field names that are present in form.pdf
+pdftk.get_field_names('path/to/form.pdf')
+
+# take form.pdf, set the 'foo' field to 'bar' and save the document to myform.pdf
+
+# with fdf
+fdf = Nguyen::Fdf.new(foo: 'bar')
+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)
+```
+
+## INSTALL:
+
+    gem install nguyen
+
+## Source Code:
+
+    git clone http://github.com/ruby-journal/nguyen.git
+
+## Contribution:
+
+I greatly welcome contributions, please feel free to fork and submit pull request.
+
+## LICENSE
+
+see [LICENSE](LICENSE)

data/lib/nguyen.rb

@@ -1,11 +1,4 @@
-require 'nguyen/fdf'
-require 'nguyen/xfdf'
-require 'nguyen/pdf'
-require 'nguyen/pdftk_wrapper'
-
-module Nguyen
-  # shorthand for Nguyen::PdftkWrapper.new(...)
-  def self.new(*args)
-    PdftkWrapper.new(*args)
-  end
-end
+require_relative 'nguyen/fdf'
+require_relative 'nguyen/xfdf'
+require_relative 'nguyen/pdf'
+require_relative 'nguyen/pdftk_wrapper'

data/lib/nguyen/fdf.rb

@@ -11,9 +11,9 @@ module Nguyen
     def initialize(data = {}, options = {})
       @data = data
       @options = {
-        :file => nil,
-        :ufile => nil,
-        :id => nil
+        file: nil,
+        ufile: nil,
+        id: nil
       }.merge(options)
     end
 
@@ -37,7 +37,7 @@ module Nguyen
     
     # write fdf content to path
     def save_to(path)
-      (File.open(path, 'w') << to_fdf).close
+      File.write(path, to_fdf)
     end
     
     protected
@@ -86,4 +86,4 @@ EOFOOTER
     end
     
   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
@@ -29,7 +29,7 @@ module Nguyen
     end
 
     # pdftk.read '/path/to/form.pdf'
-    # returns an instance of PdfForms::Pdf representing the given template
+    # returns an instance of Nguyen::Pdf representing the given template
     def read(path)
       Pdf.new path, self
     end
@@ -44,7 +44,7 @@ module Nguyen
 
     def cat(*files,output)
       files = files[0] if files[0].class == Array
-      input = files.map{|f| %Q("#{f}")}
+      input = files.map{|f| %Q(#{f})}
       call_pdftk(*input,'output',output)
     end
 

data/lib/nguyen/version.rb

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

data/lib/nguyen/xfdf.rb

@@ -8,20 +8,20 @@ module Nguyen
     def initialize(fields = {}, options = {})
       @fields = fields
       @options = {
-        :file => nil,
-        :id => nil
+        file: nil,
+        id: nil
       }.merge(options)
     end
 
     # generate XFDF content
     def to_xfdf
-      builder = Nokogiri::XML::Builder.new(:encoding => 'UTF-8') do |xml|
+      builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
         xml.xfdf('xmlns' => 'http://ns.adobe.com/xfdf/', 'xml:space' => 'preserve') {
-          xml.f(:href => options[:file]) if options[:file]
-          xml.ids(:original => options[:id], :modified => options[:id]) if options[:id]
+          xml.f(href: options[:file]) if options[:file]
+          xml.ids(original: options[:id], modified: options[:id]) if options[:id]
           xml.fields {
             @fields.each do |field, value|
-              xml.field(:name => field) {
+              xml.field(name: field) {
                 if value.is_a? Array
                   value.each { |item| xml.value(item.to_s) }
                 else
@@ -32,13 +32,13 @@ module Nguyen
           }
         }
       end
-      builder.to_xml
+      builder.to_xml(save_with: Nokogiri::XML::Node::SaveOptions::AS_XML)
     end
 
     # 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,69 +1,81 @@
 --- !ruby/object:Gem::Specification
 name: nguyen
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 1.0.3
 platform: ruby
 authors:
 - Trung Lê
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-26 00:00:00.000000000 Z
+date: 2020-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.5
+        version: '1.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.5.5
+        version: '1.10'
+- !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: joneslee85@gmail.com
+email: trung.le@ruby-journal.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- lib/nguyen.rb
 - lib/nguyen/fdf.rb
 - lib/nguyen/pdf.rb
 - lib/nguyen/pdftk_wrapper.rb
+- lib/nguyen/version.rb
 - lib/nguyen/xfdf.rb
-- lib/nguyen.rb
-- LICENSE
-- README.rdoc
-homepage: http://github.com/joneslee85/nguyen
-licenses: []
+homepage: http://github.com/ruby-journal/nguyen
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: '0'
 requirements:
 - pdtk 1.44.1 or newer
-rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Fill out PDF forms by XFDF/FDF via pdftk.
 test_files: []

data/README.rdoc

@@ -1,60 +0,0 @@
-= 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.
-
-== EXAMPLE:
-
-=== FDF creation
-
-    fdf = Nguyen::Fdf.new(:key => 'value', :other_key => 'other value')
-    # use to_fdf if you just want the FDF data, without writing it to a file
-    puts fdf.to_fdf
-    # write fdf file
-    fdf.save_to('path/to/file.fdf')
-
-
-=== XFDF creation
-
-    xfdf = Nguyen::Xfdf.new(:key => 'value', :other_key => 'other value')
-    # use to_xfdf if you just want the XFDF data, without writing it to a file
-    puts xfdf.to_xfdf
-    # write xfdf file
-    xfdf.save_to('path/to/file.xfdf')
-
-=== Query form fields and fill out PDF forms with pdftk
-
-    # adjust the pdftk path to suit your pdftk installation
-    pdftk = Nguyen.new('/usr/local/bin/pdftk')
-
-    # find out the field names that are present in form.pdf
-    pdftk.get_field_names('path/to/form.pdf')
-
-    # take form.pdf, set the 'foo' field to 'bar' and save the document to myform.pdf
-
-    # with fdf
-    fdf = Nguyen::Fdf(:foo => 'bar')
-    pdftk.fill_form('/path/to/form.pdf', 'myform.pdf', fdf)
-
-    # with xfdf
-    xfdf = Nguyen::Xfdf(:foo => 'bar')
-    pdftk.fill_form('/path/to/form.pdf', 'myform.pdf', xfdf)
-
-== INSTALL:
-
-  $ gem install nguyen
-
-== Source Code:
-
-  $ git clone http://github.com/joneslee85/nguyen.git
-
-== Contribution:
-
-I greatly welcome contributions, please feel free to fork and submit pull request.
-
-== LICENSE
-
-see LICENSE