fillable-pdf 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21838c4d6acfe2fee7d07688316c0b4fc32e7e5898dfcd0f77559424e3770802
-  data.tar.gz: 153fc518eee4b2fa76a91ce6228739d5d3cef4d5d4f1be05e3ee6a5f6fcf7ce7
+  metadata.gz: 7546695fbeb3213a736f94e783a85ddb1a60f9b54e2bacf47470f26edcd2b509
+  data.tar.gz: fe054623093ec69d7e6b8ef5c705963a56ed26054f26c00ff5669cbd7752a540
 SHA512:
-  metadata.gz: 41d10ee4f4751d2a8213ed969f16c1c1bb4e80e87e2da9e4dce0a8af73df26bf80c148edbfdbfd5bfdb4876ac090da6783a5304891110802b43a0d6251c7881a
-  data.tar.gz: 14b5a5d075ab12359ecda3d93ec1502c2b9b114376e81fbb2946fa9ff7fa1fbac93e091b90df8599280114735fedd3d2d201f5d607bcf3a2c1bd130e388a76c0
+  metadata.gz: 97c0a10edf7d8998c227f3a979dbdff318b77fe63eb51a9482d6c5436311589ee7dd675ddd5457b4e2f6d9dda65abd4191994c80cf8db93113bed2a743774b55
+  data.tar.gz: a78d845c56c35dfdaac5c71e09e4ff0306c807b95f368f55813a9b2cb2fb545e6534d6ca33cdd1d0d86fbd7e524f38abc5c544d118006f529ce359ddb0acfc77

data/.github/workflows/test.yml

@@ -3,8 +3,10 @@ name: Test
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
+  schedule:
+    - cron: '0 0 * * *'
 
 jobs:
   test:
@@ -13,8 +15,8 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '3.4', '3.3', '3.2', '3.1', '3.0', '2.7', '2.6', '2.5', '2.4' ]
-        java: [ '8', '11', '17', '21', '23' ]
+        ruby: [ '4.0', '3.4', '3.3', '3.2', '3.1', '3.0', '2.7', '2.6', '2.5', '2.4' ]
+        java: [ '8', '11', '17', '21', '23', '25' ]
 
     steps:
       - uses: actions/checkout@v4

data/README.md

@@ -103,6 +103,18 @@ pdf = FillablePDF.new 'input.pdf'
 pdf.close
 ```
 
+### Method Chaining
+
+All setter methods return `self`, allowing you to chain operations:
+
+```ruby
+pdf.set_field(:first_name, 'Richard')
+   .set_field(:last_name, 'Rahl')
+   .set_field(:date, Time.now.strftime('%B %e, %Y'))
+   .save
+   .close
+```
+
 ### Checking / Unchecking Checkboxes
 
 Use the values `'Yes'` and `'Off'` to check and uncheck checkboxes, respectively. For example:
@@ -290,7 +302,7 @@ An instance of `FillablePDF` has the following methods at its disposal:
     ```ruby
     pdf.save
     # result: document is saved without flattening
-    pdf.save_as(flatten: true)
+    pdf.save(flatten: true)
     # result: document is saved with flattening
     ```
 
@@ -335,6 +347,48 @@ An instance of `FillablePDF` has the following methods at its disposal:
     # output example: true
     ```
 
+## Error Handling
+
+The gem raises custom error classes for different error conditions, making it easier to catch specific problems:
+
+```ruby
+begin
+  pdf = FillablePDF.new('input.pdf')
+  pdf.field(:nonexistent_field)
+rescue FillablePDF::FieldNotFoundError => e
+  puts "Field not found: #{e.message}"
+rescue FillablePDF::InvalidArgumentError => e
+  puts "Invalid input: #{e.message}"
+rescue FillablePDF::FileOperationError => e
+  puts "File error: #{e.message}"
+rescue FillablePDF::Error => e
+  puts "General error: #{e.message}"
+end
+```
+
+### Error Classes
+
+- **`FillablePDF::Error`** - Base class for all gem errors
+- **`FillablePDF::FieldNotFoundError`** - Raised when a field doesn't exist in the PDF
+- **`FillablePDF::InvalidArgumentError`** - Raised when invalid arguments are provided
+- **`FillablePDF::FileOperationError`** - Raised when file operations fail (file not found, cannot save, etc.)
+
+### Common Error Scenarios
+
+```ruby
+# Field doesn't exist
+pdf.field(:nonexistent) # raises FieldNotFoundError
+
+# Invalid input
+pdf.set_field(:name, nil) # raises InvalidArgumentError
+
+# File not found
+pdf = FillablePDF.new('missing.pdf') # raises FileOperationError
+
+# Operations on closed document
+pdf.close
+pdf.set_field(:name, 'test') # raises FileOperationError
+```
 
 ## Deployment with Heroku
 

data/fillable-pdf.gemspec

@@ -22,6 +22,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w[ext lib]
 
   spec.add_dependency 'base64', '~> 0.1'
+  spec.add_dependency 'fiddle', '>= 1.0'
   spec.add_dependency 'rjb', '~> 1.6'
   spec.requirements << 'JDK >= 8'
 

data/lib/fillable-pdf/version.rb

@@ -1,3 +1,3 @@
 class FillablePDF
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fillable-pdf
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Vadim Kononov
@@ -23,6 +23,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: fiddle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rjb
   requirement: !ruby/object:Gem::Requirement
@@ -97,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - JDK >= 8
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Fill out or extract field values from simple fillable PDF forms using iText.
 test_files: []