acrobat 0.0.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c99bfc29e7fb060276f39533f1f762f937eca16d6961d0d889243f5f4882878
-  data.tar.gz: ceb386e7cdc9abba3085c515f2e11cbed715aeff2d48e175b3d61818a5c767cd
+  metadata.gz: c0dbaa90ebab7df2e5eeb70d4bfff5a75448134d3efa100a45fe172080b85df8
+  data.tar.gz: f9b04d87101a45da0fdc675ea98a54c2eb73abd723e10844078d7d0474799947
 SHA512:
-  metadata.gz: 51a1bb2f8f589f2226b160cda8e9be8b08585e95d96f221216a047bcc2a1d18c93e28b897aec2f7937b0f17a95f050ce29052c17cb43f0b123edd15d2ea3fb93
-  data.tar.gz: 2b6e94fce7255c41afb8b75a51364a9c8e51b4cdbda37a49e071675ff4fbee8882ea0dab4363f27322c05fa2df05cb60162ce622179b43a3d44b2f236d9dfc8e
+  metadata.gz: b306b051e57f3a9224d3cdb9b7f57df2b07d99533eac4d9dcf4d6bf59836d78a93dcafac356e8ea15ab76c9fe7fb847e67ff245d76239337e85b4224675571b7
+  data.tar.gz: 9811e4ca8066d17b88b3e010a162ade3b10cae13e3c322e3c9db7705702e9d7b5c324b5e6d45146c9531620d586ed2506e0a723d589a47e447e679c22731d40c

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/standardrb/standard
+ruby_version: 3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-08-12
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/Guardfile

@@ -1,30 +1,28 @@
-# A sample Guardfile
-# More info at https://github.com/guard/guard#readme
-
-## Uncomment and set this to only include directories you want to watch
-# directories %w(app lib config test spec features) \
-#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
-
-## Note: if you are using the `directories` clause above and you are not
-## watching the project directory ('.'), then you will want to move
-## the Guardfile to a watched dir and symlink it back, e.g.
-#
-#  $ mkdir config
-#  $ mv Guardfile config/
-#  $ ln -s config/Guardfile .
-#
-# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
-
-guard :minitest do
-  # with Minitest::Unit
-  watch(%r{^test/(.*)\/?test_(.*)\.rb$})
-  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
-  watch(%r{^test/test_helper\.rb$})      { 'test' }
-
-  # with Minitest::Spec
-  # watch(%r{^spec/(.*)_spec\.rb$})
-  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
-  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
-
-
-end
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)/?test_(.*)\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$}) { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r{^test/test_helper\.rb$}) { "test" }
+
+  # with Minitest::Spec
+  # watch(%r{^spec/(.*)_spec\.rb$})
+  # watch(%r{^lib/(.+)\.rb$})         { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r{^spec/spec_helper\.rb$}) { 'spec' }
+end

data/{LICENSE.adoc → LICENSE.txt}

@@ -1,22 +1,21 @@
-.The MIT License
-....
-Copyright (C) 2012-2016 Dominic Sisneros and the Microstation-Ruby project.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-....
+The MIT License (MIT)
+
+Copyright (c) 2024 dsisnero
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,107 @@
+# DESCRIPTION:
+
+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
+
+# Requirements
+
+-   Windows Adobe Acrobat installed
+
+# Install 0ptions
+
+acrobat can be installed using (a) the `gem install` command, (b)
+Bundler
+
+## (a) gem install
+
+Open a terminal and type \$ gem install acrobat
+
+:::: tip
+::: title
+Upgrading your installation
+:::
+
+If you have an earlier version of acrobat installed you can update it
+using:
+
+\$ gem update acrobat
+
+If you install a new version of the gem using `gem install` instead of
+gem update, you'll have multiple versions installed. If that's the case,
+use the following gem command to remove the old versions:
+
+\$ gem cleanup acrobat
+::::
+
+## (b) Bundler
+
+1.  Create a Gemfile in the root folder of your project (or the current
+    directory)
+
+2.  Add the `asciidoctor` gem to your Gemfile as follows:
+
+    ``` ruby
+    source 'https://rubygems.org'
+    gem 'acrobat'
+    # or specify the version explicitly
+    # gem 'acrobat', '0.0.5'
+    ```
+
+3.  Save the Gemfile
+
+4.  Open a terminal and install the gem using:
+
+        $ bundle
+
+To upgrade the gem, specify the new version in the Gemfile and run
+`bundle` again. Using `bundle update` is **not** recommended as it will
+also update other gems, which may not be the desired result.
+
+# Usage
+
+``` ruby
+  require 'acrobat'
+  Adobe::Acrobat.run do |app|
+    fields = {city: 'City', state: 'State', zip: 'zip'}
+    doc = app.open('apd_document.pdf')
+    doc.fill_form(fields)
+    doc.show
+    doc2 = app.open('another_doc.pdf')
+    doc2.fill_form(fields)
+    doc1.merge_doc(doc2)
+    doc1.save_as(name: 'merged_doc.pdf', dir: 'tmp')
+  end
+```
+
+# Getting Help
+
+We encourage you to ask questions and discuss any aspects of the project
+on the discussion list, Twitter or IRC.
+
+Mailing list
+
+:   {uri-discuss}
+
+The project's source code, issue tracker, and sub-projects are on github
+
+Source repository (git)
+
+:   <https://github.com/dsisnero/acrobat>
+
+Issue tracker
+
+:   <https://github.com/dsisnero/acrobat/issues>
+
+acrobat organization on GitHub
+
+:   <https://github.com/dsisnero>
+
+# Copyright and Licensing
+
+Copyright © 2012-2016 Dominic Sisneros and the acrobat-Ruby Project.
+Free use of this software is granted under the terms of the MIT License.
+
+See the
+[LICENSE](https://github.com/dsisnero/acrobat/blob/master/LICENSE.txt)
+file for details.

data/Rakefile

@@ -1,48 +1,10 @@
-# -*- ruby -*-
-
-require "rubygems"
-require "hoe"
-
-class Hoe
-
-  def intuit_values
-    require 'asciidoctor'
-    doc = Asciidoctor.load_file readme_file
-    urls = { "home" => doc.attributes['uri-repo']}
-    desc = doc.blocks.find{|b| b.id =~ /description/i}.content
-    summ = desc.split(/\.\s+/).first(summary_sentences).join(". ")
-    self.urls ||= urls
-    self.description ||= desc
-    self.summary ||= summ
-  end
-
-end
-
-# Hoe.plugin :compiler
-# Hoe.plugin :gem_prelude_sucks
-# Hoe.plugin :inline
-# Hoe.plugin :racc
-# Hoe.plugin :rcov
-# Hoe.plugin :rdoc
-Hoe.plugin :bundler
-Hoe.plugin :minitest
-Hoe.plugin :yard
-
-Hoe.spec "acrobat" do |s|
-  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", :development) if Gem.win_platform?
-  dependency("guard-minitest", "> 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
-end
-
-
-# vim: syntax=ruby
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/examples/form_field.rb

@@ -0,0 +1,21 @@
+require "acrobat"
+require "pry"
+
+Acrobat::App.new
+# app.show
+
+
+Acrobat::App.run do |app|
+  dir = Pathname(__dir__)
+  form_path = dir + "6030.17.antenna.pdf"
+  puts "Working on #{form_path}"
+  doc1 = app.open(form_path)
+  doc1.show
+  fields = {"city" => "Salt Lake City",
+            "state" => "Utah",
+            "lid" => "SLCB",
+            "fac" => "RTR",
+            :cost_center => "1234"}
+  doc1.fill_form(fields)
+  doc1.save_as(name: "slcb.example.pdf", dir: dir.parent + "tmp")
+end

data/examples/merge.rb

@@ -0,0 +1,11 @@
+require "acrobat/app"
+require "pry"
+Acrobat::App.run do |app|
+  dir = Pathname(__dir__)
+  form_path = dir + "6030.17.antenna.pdf"
+  doc = app.open(form_path)
+  binding.pry
+  doc.merge(dir + "6030.17.cm300.tx.pdf")
+  doc.show
+  doc.save_as(name: "example.merged.pdf", dir: dir.parent + "tmp")
+end

data/lib/acrobat/app.rb

@@ -1,30 +1,31 @@
-require 'pry'
-require  'win32ole'
-require_relative 'pdoc'
-require_relative 'jso'
+require "win32ole"
+require_relative "pdoc"
+require_relative "jso"
 
-module FileSystemObject
+module Acrobat
+  class FileNotFound < StandardError
+    def initialize(path)
+      super("File not found: #{path}")
+    end
+  end
+end
 
+module FileSystemObject
   @instance = nil
-  def FileSystemObject.instance
-    unless @instance
-      @instance = WIN32OLE.new('Scripting.FileSystemObject')
-    end
-    return @instance
+  def self.instance
+    @instance ||= WIN32OLE.new("Scripting.FileSystemObject")
+    @instance
   end
 
-  def FileSystemObject.windows_path(path)
+  def self.windows_path(path)
     FileSystemObject.instance.GetAbsolutePathname(path.to_s)
   end
-
 end
 
 module ACRO; end
 
 module Acrobat
-
   class App
-
     #  [WIN32_OLE] ole_obj
     attr_reader :ole_obj
 
@@ -33,12 +34,10 @@ module Acrobat
 
     # Initialize the
     # @return [App] return an instance of App
-    def initialize()
-      @ole_obj = WIN32OLE.new('AcroExch.App')
+    def initialize
+      @ole_obj = WIN32OLE.new("AcroExch.App")
       load_constants(@ole_obj)
-      @ole_obj
       @docs = []
-      self
     end
 
     # Runs the adobe app and quits at the end
@@ -53,21 +52,18 @@ module Acrobat
     #
     # @return nil
     def self.run
-      begin
-        the_app = new
-        yield the_app
-      ensure
-        the_app.quit unless the_app.nil?
-        the_app = nil
-        GC.start
-        nil
-      end
+      the_app = new
+      yield the_app
+    ensure
+      the_app&.quit
+      GC.start
+      nil
     end
 
-    def self.replace_pages(src, replacement, output_name: , **opts)
-      self.run do |app|
+    def self.replace_pages(src, replacement, output_name:, **opts)
+      run do |app|
         app.open(src) do |doc|
-          doc.replace_pages(replacement, opts)
+          doc.replace_pages(replacement, **opts)
           doc.save_as(output_name)
         end
       end
@@ -80,16 +76,14 @@ module Acrobat
     # @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|
+    def self.fill_form(form, output_name:, update_hash:)
+      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
@@ -104,22 +98,20 @@ module Acrobat
     # @param dir [String] the directory to find pdfs in
     # @return [Array] of pdf files
     def find_pdfs_in_dir(dir)
-      Pathname.glob( dir + '*.pdf')
+      Pathname.glob(dir + "/*.pdf")
     end
 
     def merge_pdfs(*pdfs)
-      pdf_array = Array(pdfs)
-      raise 'Not enough pdfs to merge' if pdfs.size < 2
+      pdf_array = Array(pdfs).flatten
+      raise "Not enough pdfs to merge" if pdf_array.size < 2
       first, *rest = pdf_array
-      doc = open(first)
+      doc = self.open(first)
       rest.each do |path|
         doc.merge(path)
       end
       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
@@ -127,12 +119,10 @@ module Acrobat
     # @param output_dir [String,Nil] the name of the output dir
     #    if the output_dir is nil, the output dir is the dir param
     # return [Boolean] if the merge was successful or not
-    def merge_pdfs_in_dir(dir, name: nil , output_dir: nil)
-      name = lname || "merged.pdf"
+    def merge_pdfs_in_dir(dir, name: nil, output_dir: nil)
+      name || "merged.pdf"
       dir = output_dir || dir
-      pdfs = Pathname.glob( dir + '*.pdf')
-      doc = merge_pdfs(pdfs)
-      doc
+      merge_pdfs(find_pdfs_in_dir(dir))
     end
 
     # quit the Adobe App.
@@ -140,7 +130,7 @@ module Acrobat
     # @return nil
     def quit
       begin
-        docs.each{ |d| d.close}
+        docs.each { |d| d.close }
         ole_obj.Exit
       rescue
         return nil
@@ -148,17 +138,15 @@ module Acrobat
       nil
     end
 
-    def docs
-      @docs
-    end
+    attr_reader :docs
 
     # open the file.
     # @param file [String #to_path]
     # @return [PDoc] the open file as a Pdoc instance
     def open(file)
       filepath = Pathname(file).expand_path
-      raise FileNotFound unless filepath.file?
-      pdoc = WIN32OLE.new('AcroExch.PDDoc')
+      raise FileNotFound.new(filepath) unless filepath.file?
+      pdoc = WIN32OLE.new("AcroExch.PDDoc")
       is_opened = pdoc.open FileSystemObject.windows_path(filepath)
       doc = PDoc.new(self, pdoc, filepath) if is_opened
       docs << doc if is_opened
@@ -167,21 +155,18 @@ module Acrobat
         yield doc
       ensure
         doc.close
-        doc = nil
+        nil
       end
     end
 
-
     def form
-      Form.new(self,WIN32OLE.new("AFormAut.App"))
+      Form.new(self, WIN32OLE.new("AFormAut.App"))
     end
 
     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
-
 end