acrobat 0.1.0 → 0.3.0

data/lib/acrobat/pdoc.rb

@@ -1,137 +1,155 @@
-module Acrobat
-
-  class PDoc
-
-    attr_reader :app, :ole_obj, :path
-
-    def initialize(app,ole,path=nil)
-      @app = app
-      @ole_obj = ole
-      @path = path
-    end
-
-    def show(name = nil)
-      name = name ||  ole_obj.GetFileName
-      ole_obj.OpenAVDoc(name)
-    end
-
-    # @return [Fixnum] the number of pages in the pdf
-    def page_count
-      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)
-      src = open_pdoc(doc)
-      merge_pdoc(src)
-    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)
-      fill_form(results)
-      is_saved = save_as(name: name, dir: dir)
-      puts "saved file: %s" % [dir + name] if is_saved
-      true
-    end
-
-    def insert_pages(src: , insert_after: nil, src_page_start: nil, src_page_end: nil)
-      insert_hash = { 'nPage' => insert_after -1 }
-      insert_hash['nStart'] = src_page_start + 1 if src_page_start
-      insert_hash['nEnd'] = src_page_end + 1 if src_page_end
-      ole_obj.InsertPages(**insert_hash)
-    end
-
-    def prepend_pages(src_path: , src_page_start: 1, src_page_end: nil)
-      insert_pages( insert_after: 0, src_path: src_path, src_page_start: src_page_start, src_page_end: src_page_end)
-    end
-
-    # 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,dir:nil)
-      name = path.basename unless name
-      dir = Pathname(dir || Pathname.getwd)
-      dir.mkpath
-      windows_path = FileSystemObject.windows_path(dir + name )
-      ole_obj.save(ACRO::PDSaveFull | ACRO::PDSaveCopy,windows_path)
-    end
-
-    def name
-      ole_obj.GetFileName
-    end
-
-    def close
-      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
-
-    def fill_form(results)
-      jso.fill_form(results)
-    end
-
-    protected
-    def merge_pdoc(doc, **options)
-      begin
-        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
-    end
-  end
-
-end
+module Acrobat
+  class PDoc
+    attr_reader :ole_obj
+    
+    attr_reader  :path #: Path | Nil
+
+    def self.from_path(path)
+      filepath = Pathname(path).expand_path
+      raise FileNotFound.new(filepath) unless filepath.file?
+      pdoc = WIN32OLE.new("AcroExch.PDDoc")
+      result = pdoc.open FileSystemObject.windows_path(filepath)
+      raise "Error opening Acrobat::Pdoc from #{filepath}" if result == 0
+      new(pdoc, path)
+    end
+
+    def initialize(ole, path = nil)
+      @ole_obj = ole
+      @path = path
+    end
+
+    def show(name = nil)
+      name ||= ole_obj.GetFileName
+      ole_obj.OpenAVDoc(name)
+    end
+
+    # @rbs return Fixnum -- the number of pages in the pdf
+    def page_count
+      ole_obj.GetNumPages()
+    end
+
+    def last_page # : Fixnum
+      page_count - 1
+    end
+
+    # merges the doc to the
+    #   @rbs doc: PDoc|String|Pathname --  an open PDoc to merge or filename
+    # @rbs return Boolean -- whether the doc was merged correctly
+    def merge(doc)
+      src = open_ole_pdoc(doc)
+      ole_insert_pages(src, self_start_page: last_page, merge_doc_page_start: 0,
+        number_pages: src.page_count, bookmarks: true)
+    end
+
+    # opens and/or returns PDoc
+    #   @rbs doc: String|Pathname|Pdoc  -- the String path of a pdf file
+    def open_ole_pdoc(doc) # : Pdoc
+      case doc
+      when PDoc
+        doc
+      when String, Pathname
+        self.class.from_path(doc)
+      end
+    end
+
+    def fill_and_save(results, name: nil, dir: nil)
+      fill_form(results)
+      is_saved = save_as(name: name, dir: dir)
+      puts "saved file: %s" % [dir + name] if is_saved
+      true
+    end
+
+    def prepend_pages(src_path:, src_page_start: 1, src_page_end: nil)
+      insert_pages(insert_after: 0, src_path: src_path, src_page_start: src_page_start, src_page_end: src_page_end)
+    end
+
+    # returns [Pathname] of d
+    #   @rbs dir: [String, Nil] the String path
+    # @rbs return dir [Pathname] Pathname of dir or of working directory
+    def default_dir(dir)
+      Pathname(dir || Pathname.getw)
+    end
+
+    def save_as(name, dir: nil)
+      name ||= path.basename
+      dir = Pathname(dir || Pathname.getwd)
+      dir.mkpath
+      windows_path = FileSystemObject.windows_path(dir + name)
+      ole_obj.save(ACRO::PDSaveFull | ACRO::PDSaveCopy, windows_path)
+    end
+
+    def name
+      ole_obj.GetFileName
+    end
+
+    def close # : Bool -- true if closes successfully
+      result = ole_obj.Close
+      result == -1
+    rescue
+      false
+    end
+
+    def replace_pages(doc, start: 0, replace_start: 0, num_of_pages: 1, merge_annotations: true)
+      src = open_ole_pdoc(doc)
+
+      ole_obj.ReplacePages(start, src.ole_obj, replace_start, num_of_pages, merge_annotations)
+    end
+
+    # return the instance of JSO object
+    # @rbs 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
+
+    def fill_form(results)
+      jso.fill_form(results)
+    end
+
+    protected
+
+    def ole_insert_pages(merge_doc, self_start_page: 0, merge_doc_page_start: 0,
+      number_pages: nil, bookmarks: true)
+      bookmarks_ole = bookmarks ? 1 : 0
+      result = ole_obj.InsertPages(self_start_page, merge_doc.ole_obj, merge_doc_page_start, number_pages, bookmarks_ole)
+      if result == 0
+        raise "ole.InsertPages unable to insert merge doc #{merge_doc.name} into #{name}"
+      end
+      true
+    end
+
+    def ole_replace_pages(merge_doc, self_start_page: nil, merge_doc_page_start: nil,
+      number_pages: nil, bookmarks: true)
+      self_start_page_ole = self_start_page ? self_start_page - 1 : page_count - 1
+      page_start_ole = merge_doc_page_start ? merge_doc_page_start - 1 : merge_doc.GetNumPages - 1
+      number_pages_ole = number_pages || merge_doc
+      bookmarks_ole = bookmarks ? 1 : 0
+      result = ole_obj.ReplacePages(self_start_page_ole, merge_doc.ole, page_start_ole, number_pages_ole, bookmarks_ole)
+    end
+
+    def insert_pages(src:, insert_after: nil, src_page_start: nil, src_page_end: nil)
+      insert_hash = {"nPage" => insert_after - 1}
+      insert_hash["nStart"] = src_page_start + 1 if src_page_start
+      insert_hash["nEnd"] = src_page_end + 1 if src_page_end
+      ole_obj.InsertPages(**insert_hash)
+    end
+
+    def merge_pdoc(doc, **options)
+      if options
+        start = options[:start]
+        start_page
+        options[:pages]
+        ole_obj.InsertPages(start, doc.ole_obj, 0, doc.page_count, true)
+      else
+        ole_obj.InsertPages(page_count - 1, doc.ole_obj, 0, doc.page_count, true)
+
+      end
+    rescue
+      false
+    end
+  end
+end

data/lib/acrobat/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Acrobat
+  VERSION = "0.3.0"
+end

data/lib/acrobat.rb

@@ -1,48 +1,9 @@
-require 'win32ole'
-require 'acrobat/app'
+# frozen_string_literal: true; -*- rbs_inline: enabled -*-
 
+require_relative "acrobat/version"
+require_relative "acrobat/app"
 
 module Acrobat
-  VERSION = "0.1.0"
-end
-
-
-if $0 ==  __FILE__
-  require 'pry'
-
-  app = Acrobat::App.run do |app|
-
-    data = Pathname(__dir__).parent + 'data'
-    antenna_form = data + 'faa.6030.17.antenna.pdf'
-
-
-    doc1 = app.open(antenna_form)
-    doc1.show
-
-    fields = {'city' => 'OGD', 'state' => 'Utah',
-              'lid' => 'OGD',
-              'fac' => 'RTR',
-             }
-    doc1.fill_form(fields)
-
-
-    doc1.save_as(name: 'ogd.rtr.pdf', dir: 'tmp')
-    binding.pry
-    jso = doc1.jso
-    jso.show_console
-    puts "field count: #{jso.field_count}"
-    puts "field names: \n#{jso.field_names}"
-    binding.pry
-
-
-
-    doc2 = app.open(data + 'faa.6030.17.cm300.uhf.tx.pdf')
-    doc2.show
-    doc2.fill_form(fields)
-
-    doc1.merge(doc2)
-    doc1.save_as(name: 'ogd.merged_antenna_tx.pdf', dir: 'tmp')
-
-  end
-
+  class Error < StandardError; end
+  # Your code goes here...
 end

data/rbs_collection.yaml

@@ -0,0 +1,19 @@
+# Download sources
+sources:
+  - type: git
+    name: ruby/gem_rbs_collection
+    remote: https://github.com/ruby/gem_rbs_collection.git
+    revision: main
+    repo_dir: gems
+
+# You can specify local directories as sources also.
+# - type: local
+#   path: path/to/your/local/repository
+
+# A directory to install the downloaded RBSs
+path: .gem_rbs_collection
+
+# gems:
+#   # If you want to avoid installing rbs files for gems, you can specify them here.
+#   - name: GEM_NAME
+#     ignore: true

data/samples_other/background.js

@@ -0,0 +1,40 @@
+Private Function ApplyBackgroundToPDF(BasePDF As String, BackgroundPDF As String)
+    Dim pdDoc As Acrobat.CAcroPDDoc
+    Dim pdTemplate As Acrobat.CAcroPDDoc
+    Dim template As Variant
+    Dim lngPage As Long
+    
+    'Open base document
+        Set pdDoc = CreateObject("AcroExch.PDDoc")
+        pdDoc.Open BasePDF
+        DoEvents
+    
+    'Open background document
+        Set pdTemplate = CreateObject("AcroExch.PDDoc")
+        pdTemplate.Open BackgroundPDF
+        DoEvents
+    
+    'Add background document to base document
+        pdDoc.InsertPages pdDoc.GetNumPages - 1, pdTemplate, 0, 1, 0
+    
+    'Create a template from the inserted background document
+        Set template = pdDoc.GetJSObject.CreateTemplate("background", pdDoc.GetNumPages - 1)
+    
+    'Place the template as a background to all pages
+        For lngPage = 0 To pdDoc.GetNumPages - 2
+            template.Spawn lngPage, True, True
+        Next
+    
+    'Delete last page (used for template creation purposes only)
+        pdDoc.DeletePages pdDoc.GetNumPages - 1, pdDoc.GetNumPages - 1
+    
+    'Save
+        pdDoc.Save 1, BasePDF
+    
+    'Close & Destroy Objects
+        pdDoc.Close
+        Set pdDoc = Nothing
+        
+        pdTemplate.Close
+        Set pdTemplate = Nothing
+End Function