acrobat 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6073a8a04f7af59dd0b8825ff3286975f0197d7d
-  data.tar.gz: 6004fca142d6c6856acf3bb83a2c918600ce3458
+SHA256:
+  metadata.gz: 0c99bfc29e7fb060276f39533f1f762f937eca16d6961d0d889243f5f4882878
+  data.tar.gz: ceb386e7cdc9abba3085c515f2e11cbed715aeff2d48e175b3d61818a5c767cd
 SHA512:
-  metadata.gz: 8af177966f67905aba759fbced241768d2da6b5aa6128f531c505c6217d8b63d3893ec3092d88162c2d5d35ece6502f33d4db39d97640f6e3af3e3b4371a6ed8
-  data.tar.gz: 3e32a912018fcde36ee7ec584484e1f249313f356d29fa6535ee501052f8475d6248a03ffbe2334ce31a06166eefe3e3e75cdd39273deac5f7222cd5514ddc6c
+  metadata.gz: 51a1bb2f8f589f2226b160cda8e9be8b08585e95d96f221216a047bcc2a1d18c93e28b897aec2f7937b0f17a95f050ce29052c17cb43f0b123edd15d2ea3fb93
+  data.tar.gz: 2b6e94fce7255c41afb8b75a51364a9c8e51b4cdbda37a49e071675ff4fbee8882ea0dab4363f27322c05fa2df05cb60162ce622179b43a3d44b2f236d9dfc8e

data.tar.gz.sig

@@ -1 +1 @@
-��S����y�/��B���wq���Q��1]��
X�V�Y�L�VG88���9�hi߇���R_L,��q�V�>™��?.Eb�
+	X"����Ƙ�tŊ�����^���w���Q��­<ͥ��sBO��n���������0k��=b�Q��e4���(�#LS�{o������T�i(�e'N��/�����G��S*Z���%���T�@��4��J�K�¿�֕S��L*5xu�TH�bX��W���n��_

data/README.adoc

@@ -71,7 +71,7 @@ Using `bundle update` is *not* recommended as it will also update other gems, wh
 == Usage
 
 [source,ruby]
-====
+----
 
   require 'acrobat'
   Adobe::Acrobat.run do |app|
@@ -87,7 +87,7 @@ Using `bundle update` is *not* recommended as it will also update other gems, wh
     
     
 
-====
+----
 
 == Getting Help
 

data/Rakefile

@@ -29,15 +29,16 @@ Hoe.plugin :minitest
 Hoe.plugin :yard
 
 Hoe.spec "acrobat" do |s|
-  dependency("hoe-bundler", "> 0.0",:development)
-  dependency("hoe-yard", "> 0.0",:development)
+  dependency("hoe-bundler", "~> 1.4",:development)
+  dependency("hoe-yard", "> 0.1",:development)
   dependency("pry", "> 0.0", :development)
   dependency("pry-byebug", "> 0.0", :development)
   dependency("yard", "> 0.0", :development)
   dependency("guard", "> 0.0", :development)
-  dependency("wdm", "> 0.1.0", :development) if Gem.win_platform?
+  dependency("wdm", "> 0.1", :development) if Gem.win_platform?
   dependency("guard-minitest", "> 0.0", :development)
-  dependency("asciidoctor", ">0.0",:development)
+  dependency("asciidoctor", "> 0.0",:development)
+#  dependency("minitest-utils", "> 0.0", :development)
   developer("Dominic Sisneros","dsisnero@gmail.com")
   clean_globs << "tmp"
   license "MIT" # this should match the license in the README

data/lib/acrobat.rb

@@ -3,7 +3,7 @@ require 'acrobat/app'
 
 
 module Acrobat
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end
 
 

data/lib/acrobat/app.rb

@@ -25,9 +25,14 @@ module Acrobat
 
   class App
 
+    #  [WIN32_OLE] ole_obj
+    attr_reader :ole_obj
 
-    attr_reader :ole_obj, :pdoc
+    # the wrapped [PDoc] PDoc object
+    attr_reader :pdoc
 
+    # Initialize the
+    # @return [App] return an instance of App
     def initialize()
       @ole_obj = WIN32OLE.new('AcroExch.App')
       load_constants(@ole_obj)
@@ -39,11 +44,12 @@ module Acrobat
     # Runs the adobe app and quits at the end
     # @yield app [App]
     #
-    # Acrobat::App.run do |app|
-    #    doc = app.open('doc.pdf')
-    #    doc.fill_form( city: 'City', state: 'ST')
-    #    doc.save_as('filled.pdf')
-    # end
+    # @example
+    #   Acrobat::App.run do |app|
+    #     doc = app.open('doc.pdf')
+    #     doc.fill_form( city: 'City', state: 'ST')
+    #     doc.save_as('filled.pdf')
+    #   end
     #
     # @return nil
     def self.run
@@ -58,6 +64,32 @@ module Acrobat
       end
     end
 
+    def self.replace_pages(src, replacement, output_name: , **opts)
+      self.run do |app|
+        app.open(src) do |doc|
+          doc.replace_pages(replacement, opts)
+          doc.save_as(output_name)
+        end
+      end
+    end
+
+    # Fills the form with updates in a hash
+    # @example
+    #    Acrobat::App.fill_form(myform.pdf, output_name: 'filled.pdf
+    #                                 , update_hash: { name: 'dom', filled_date: 1/20/2013
+    # @param doc [String] the String path of a fillable pdf file
+    # @param output_name [String] the name of the saved filled pdf file
+    # @param update_hash [Hash] the hash with updates
+    def self.fill_form(form,output_name: , update_hash: )
+      self.run do |app|
+        doc = app.open(form)
+        doc.fill_form(update_hash)
+        doc.save_as(output_name)
+      end
+    end
+
+
+
     # show the Adobe Acrobat application
     def show
       ole_obj.Show
@@ -86,6 +118,8 @@ module Acrobat
       doc
     end
 
+
+
     # merges the pdfs in directory
     # @param dir [String] the path of the directory
     # @param name [String,Nil] the name of the returned pdf file
@@ -145,7 +179,7 @@ module Acrobat
     private
 
     def load_constants(ole_obj)
-      WIN32OLE.const_load(ole_obj, ACRO) unless ACRO.constants.size > 0
+     WIN32OLE.const_load(ole_obj, ACRO) unless ACRO.constants.size > 0
     end
 
   end

data/lib/acrobat/pdoc.rb

@@ -20,22 +20,38 @@ module Acrobat
       ole_obj.GetNumPages()
     end
 
+    def last_page
+      page_count -1
+    end
+
     # merges the doc to the
     # @overload merge(doc)
     #   @param doc [String] the String path of a pdf file
     # @overload merge(doc)
     #   @param doc [PDoc] an open PDoc to merge
     # @return [Boolean] whether the doc was merged correctly
-    def merge(doc)
-      case doc
-      when PDoc
-        merge_pdoc(doc)
-      when String, Pathname
-        docpath = Pathname(doc)
-        raise 'File not found' unless docpath.file?
-        doc2 = app.open(docpath)
-        merge_pdoc(doc2)
-      end
+    def merge(doc, options = {})
+      src = open_pdoc(doc)
+      merge_pdoc(src,options)
+    end
+
+    # opens and/or returns PDoc
+    # @overload open(doc)
+    #   @param doc [String] the String path of a pdf file
+    # @overload open(PDoc] and open PDoc file
+    #   @param doc [PDoc] an already open PDoc file
+    # @return doc [PDOC] the opened PDoc
+    def open_pdoc(doc)
+      src = case doc
+            when PDoc
+              doc
+            when String, Pathname
+              docpath = Pathname(doc)
+              raise 'File not found' unless docpath.file?
+              doc2 = app.open(docpath)
+              doc2
+            end
+      src
     end
 
     def fill_and_save(results,name: nil, dir: nil)
@@ -45,11 +61,15 @@ module Acrobat
       true
     end
 
-    def default_dir(d)
+
+    # returns [Pathname] of d
+    #   @param dir [String, Nil] the String path
+    # @return dir [Pathname] Pathname of dir or of working directory
+    def default_dir(dir)
       Pathname(dir || Pathname.getw)
     end
 
-    def save_as(name:nil, dir:nil)
+    def save_as(name,dir:nil)
       name = path.basename unless name
       dir = Pathname(dir || Pathname.getwd)
       dir.mkpath
@@ -65,11 +85,19 @@ module Acrobat
       ole_obj.Close rescue nil
     end
 
+    def replace_pages(doc, start: 0, replace_start: 0, num_of_pages: 1,merge_annotations: true)
+      src = open_pdoc(doc)
+
+      ole_obj.ReplacePages(start,src.ole_obj,replace_start,num_of_pages,merge_annotations)
+    end
 
+    # return the instance of JSO object
+    # @return [Jso] a WIN32OLE wrapped Jso object 'javascript object'
     def jso
       @jso ||= Jso.new(self,ole_obj.GetJSObject)
     end
 
+    # return the field_names of the pdf form
     def field_names
       jso.field_names
     end
@@ -79,10 +107,17 @@ module Acrobat
     end
 
     protected
-    def merge_pdoc(doc)
+    def merge_pdoc(doc,options = {})
       begin
-        merged = ole_obj.InsertPages(page_count - 1, doc.ole_obj, 0, doc.page_count, true)
-        return merged
+        unless options
+          merged = ole_obj.InsertPages(page_count - 1, doc.ole_obj, 0, doc.page_count, true)
+          return merged
+        else
+          start = options[:start]
+          start_page
+          pages = options[:pages]
+          ole_obj.InsertPages(start, doc.ole_obj, 0, doc.page_count, true)
+        end
       rescue
         return false
       end

data/test/acrobat_test.rb

@@ -1,4 +1,4 @@
-require 'test_helper'
+require_relative 'test_helper'
 
 
 require "acrobat"
@@ -12,9 +12,12 @@ module Acrobat
 
     describe 'new' do
 
+      it 'works' do
+        assert true
+      end
 
-      it 'can be created' do
 
+      it 'can be created' do
         app = App.new
         app.must_be_instance_of App
       end

data/test/test_helper.rb

@@ -7,3 +7,7 @@ else
 end
 
 
+require 'minitest/spec'
+require 'minitest/autorun'
+#require 'minitest/focus'
+#require 'minitest/utils'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acrobat
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Dominic Sisneros
@@ -10,27 +10,31 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQUFADA/MREwDwYDVQQDDAhkc2lz
-  bmVybzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
-  MB4XDTE3MDEzMTE2MDEyMVoXDTE4MDEzMTE2MDEyMVowPzERMA8GA1UEAwwIZHNp
-  c25lcm8xFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
-  bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAMEeU7rhCgCeSX2xM43x
-  WSfxn+McvtU5zL2Q15fibhe2UFSRM7+9kMElye9MpA2SvRvUdi1ffgifo5IbFskz
-  b872rX5NOTC5zdhc8/r7K2N5sNzuxtQS2neYwsDJYn+X4IXW+7vAC3tsEq60uotD
-  5ZCrGMzpe8+8QlOLhKBE8n8B1tGFqrJPLWGVT/4SLW6/AeegPXWzwaOUJioNnlP1
-  zoTq5xAqCFp+l5+gzj82hexnd3Mz6wTqfZn+z6KOeGYz2rHa1uaVWAJ4I03ofaso
-  4dj5N/R//djheKrZcRwvcHwglgNedKpKcDFvBmVh+/ueq1ZN4mxIOuWFfqH5EH1w
-  okECAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFDq6
-  Q3OD0phGy8SIVItmHiEfNUYNMB0GA1UdEQQWMBSBEmRzaXNuZXJvQGdtYWlsLmNv
-  bTAdBgNVHRIEFjAUgRJkc2lzbmVyb0BnbWFpbC5jb20wDQYJKoZIhvcNAQEFBQAD
-  ggEBAGordyPD1ZBGMaJ0ZHsaw8gmmPX45r2LOjiuthmQfWTbxkXGcfxZmQMp4Rgq
-  i2SEkJ1bcxKNf2QcIEaSMo3tFz0JZikMMCCav1al2TB10JShlzkmK6akYrD2EMca
-  skUBzdiaODmVIxaePQKTofH3Tr+muDj2k2Jt0GADDi464TXjB7+WAfj9PNB6L0Bo
-  XLAuEbpybfRTbmgT1izvF41ZtekUEupzZkfe4Zjwdcfth9NX9YQml8RTrw5xPlgp
-  YeDmGZXEg4lVRuTrhlS3p+s9c5mdx2nJxSRQ8cJDPhwGiGFfBMMXo+HTfjvnVrDI
-  R2Hvov2PJU3aGJ/5gQuBTYYf3/0=
+  MIIEODCCAqCgAwIBAgIBATANBgkqhkiG9w0BAQsFADAjMSEwHwYDVQQDDBhkc2lz
+  bmVyby9EQz1nbWFpbC9EQz1jb20wHhcNMTgwMjE2MDAxNDE3WhcNMTkwMjE2MDAx
+  NDE3WjAjMSEwHwYDVQQDDBhkc2lzbmVyby9EQz1nbWFpbC9EQz1jb20wggGiMA0G
+  CSqGSIb3DQEBAQUAA4IBjwAwggGKAoIBgQDm6q2PoCe9lSIK1ShDBHFHkfsxWFaK
+  v324PCtQtB6rdVBjgAVQ7v2AqMPjJIHfNz9u6FORAmjlNnMlvmvmytUwzRIVX+nH
+  iR1kUKbDbzl3sPizBz9Vy2GV1TC0nkXge5w7aCu1D+7d1RMmVflAm1JIGTSJG/Jd
+  IyVWh1ErMMmz8BLej2KNFQcPCieXN7pt2Kp4hfcJMqQF0KcxBYktyxLu0cDDYZZZ
+  eH0RFikmsmE1+wGguRTU4D2Nr7l3PkUIznqRQ3MH6ICrpKAtupJbpe4ZE9j3CYpo
+  LKgyjrMFG2LrXs6QbtdKO6WQoC0fnXOjGDCbbUxwMvktSa1tKNwbgDxFTM/tprIe
+  MlNyNjwZiuxAdZZq375rTIrRCgjci5dBIlRF5M9fTSDB7ZY3jD1RMFtqWeMQLgrC
+  HkteXipuuFCe7Au/qFxV+iJwii6FswS5Ysa+TjFt9TXfebcKpMIsyRqQKE1w6oNu
+  /YRnQvaIMRyY6FV/nrU5/sksPr5U/Ql3DwMCAwEAAaN3MHUwCQYDVR0TBAIwADAL
+  BgNVHQ8EBAMCBLAwHQYDVR0OBBYEFP/qHc8Ca+WsXZKhFxmn+ucN9sRgMB0GA1Ud
+  EQQWMBSBEmRzaXNuZXJvQGdtYWlsLmNvbTAdBgNVHRIEFjAUgRJkc2lzbmVyb0Bn
+  bWFpbC5jb20wDQYJKoZIhvcNAQELBQADggGBABZGwLTkRYYdfrlXSoxITxVb13id
+  fE4libPxIwMaJ+T78pwfFnPMFNmPFwSDZInzfZExsNxlxrkBFKXDZSHD4TFSUS5O
+  nmenPGns6K7kjwMVq9hLm4kMEZnKX5vq6YO/YbJbVJMn+sCiDb9nphL+HlkZ1YDe
+  Q6vlynaKWlzN2Dv2NIYxcGLYff+kTQZNsuCL5GF8O3C+WQpIe5Dy2foA7b6RTbNI
+  1ZHlj2wGWQ2ooLnkwKMJsOHTe5U12Aub/1dFFk+NsK8cXiP//5eipvtI6z/QY34C
+  I0E/5rKu54YgiKt1Waa6+JmM1k+kpakAYi2JwpyF8GyxM1UHuzcg/b0molfdS9gD
+  B2MEh8WYqwy827jl4vUZYuoquOG1Z83fN6ehSVro4yqbTkmPtOFTeFt/mUGMKC90
+  GkZB86BODcU2ZIxvw1AkKmr0YgWPfYunalhX5FirP9guVLlaoeJwn1wMf8ghBOrp
+  tvCvgfI163rqmb9syMyTmNffdkGy6U2IIja7hw==
   -----END CERTIFICATE-----
-date: 2017-01-31 00:00:00.000000000 Z
+date: 2018-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -38,42 +42,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.10'
+        version: '5.11'
 - !ruby/object:Gem::Dependency
   name: hoe-yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.2
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: hoe-bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -136,14 +140,14 @@ dependencies:
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: guard-minitest
   requirement: !ruby/object:Gem::Requirement
@@ -178,14 +182,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.16'
+        version: '3.17'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.16'
+        version: '3.17'
 description: |-
   <div class="paragraph">
   <p>The acrobat gem is a library that uses WIN32OLE to automate pdf functions.  Adobe Reader or Adobe Acrobat must be installed and then you can fill forms and merge documents</p>
@@ -237,7 +241,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: <div class="paragraph"> <p>The acrobat gem is a library that uses WIN32OLE