acro_that 0.1.8 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1d3505b27f84c80388049dd3d167c73c88859f076cb0f02e42ead53e8a9c63a
-  data.tar.gz: 5bfa90b434d7f35722879ad0e3b6414d8160e4267281a433500de1e496cb5a2d
+  metadata.gz: 35e82f82af4a5ad469ce89111633daea2b86ca0f9a965282824c03bd5f9b8af6
+  data.tar.gz: 47e8c25c2f8d1a9243ed9c6e5c85ba6f65aa1cc52b8abe62c3fdaed3a72f8361
 SHA512:
-  metadata.gz: '09ea0329b659add9744960363196db63715e99cb873ef75bc6a0162ad6a33c6295211aadd1e3dcbdb8d0d857571f1f32b7fb0a2e2442599b1fb65628302922ca'
-  data.tar.gz: a458bb09017f0b01af6b6f6f4923e8b8ae8a41e4c5c0660d97874769c9eaf8141b2dbb6ed0a3de62a4878cff738354bd5655269d5c216e1dcc78aba72432e4f6
+  metadata.gz: d20594b2b72776e4eea071d87036e2151cfcbb5a36f09d1b11ecd4d055168a613ba1d8fcd308b1748706b30c4ea6cc84742e2f895a21f594ef6c9a79351f5cc1
+  data.tar.gz: fb36a88b91eced4f62b027f920e5233e626f4d469087fe7c46419091020324b9d92d0f5a70d55479064c93bd787513950b2ce84bbcb185834a706c7f83fa9555

data/CHANGELOG.md

@@ -8,10 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## [0.1.8] - 2025-11-04
 
 ### Fixed
-- Fixed PDF parsing error when PDFs are wrapped in multipart form data. PDFs uploaded via web forms (with boundary markers like `------WebKitFormBoundary...`) are now automatically extracted before processing, ensuring correct offset calculations.
-- Fixed xref stream parsing to properly validate objects are actually xref streams before attempting to parse them. Added fallback logic to find classic xref tables nearby when xref stream parsing fails.
-- Fixed annotation removal to preserve non-widget annotations (such as highlighting, comments, etc.) when clearing fields. Only widget annotations associated with form fields are now removed.
-- Improved PDF trailer Size calculation to handle object number gaps correctly.
+- Fixed PDF parsing error when PDFs are wrapped in multipart form data. PDFs uploaded via web forms (with boundary markers like `------WebKitFormBoundary...`) are now automatically extracted before processing, ensuring correct offset calculations for xref tables and streams.
 
 ## [0.1.5] - 2025-11-01
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    acro_that (0.1.7)
+    acro_that (1.0.0)
       chunky_png (~> 1.4)
 
 GEM

data/README.md

@@ -175,6 +175,84 @@ doc.write("form_with_signature.pdf")
 
 **Note**: PNG image processing requires the `chunky_png` gem, which is included as a dependency. JPEG images can be processed without any additional dependencies.
 
+#### Radio Buttons
+
+Radio buttons allow users to select a single option from a group of mutually exclusive choices. Radio buttons in AcroThat are created using the `:radio` type and require a `group_id` to group related buttons together.
+
+```ruby
+doc = AcroThat::Document.new("form.pdf")
+
+# Create a radio button group with multiple options
+# All buttons in the same group must share the same group_id
+
+# First radio button in the group (creates the parent field)
+doc.add_field("Option1", 
+  type: :radio,
+  group_id: "my_radio_group",
+  value: "option1",  # Export value for this button
+  x: 100,
+  y: 500,
+  width: 20,
+  height: 20,
+  page: 1,
+  selected: true  # This button will be selected by default
+)
+
+# Second radio button in the same group
+doc.add_field("Option2", 
+  type: :radio,
+  group_id: "my_radio_group",  # Same group_id as above
+  value: "option2",
+  x: 100,
+  y: 470,
+  width: 20,
+  height: 20,
+  page: 1
+)
+
+# Third radio button in the same group
+doc.add_field("Option3", 
+  type: :radio,
+  group_id: "my_radio_group",  # Same group_id
+  value: "option3",
+  x: 100,
+  y: 440,
+  width: 20,
+  height: 20,
+  page: 1
+)
+
+# Write the PDF with radio buttons
+doc.write("form_with_radio.pdf")
+```
+
+**Key Points:**
+- **`group_id`**: Required. All radio buttons that should be mutually exclusive must share the same `group_id`. This can be any string or identifier.
+- **`type: :radio`**: Required. Specifies that this is a radio button field.
+- **`value`**: The export value for this specific button. This is what gets returned when the button is selected. If not provided, a unique value will be generated automatically.
+- **`selected`**: Optional boolean (`true` or `false`, or string `"true"`). If set to `true`, this button will be selected by default. Only one button in a group should have `selected: true`. If not specified, the button defaults to unselected.
+- **Positioning**: Each radio button needs its own `x`, `y`, `width`, `height`, and `page` values to position it on the form.
+
+**Example with multiple groups:**
+
+```ruby
+doc = AcroThat::Document.new("form.pdf")
+
+# First radio button group (e.g., "Gender")
+doc.add_field("Male", type: :radio, group_id: "gender", value: "male", x: 100, y: 500, width: 20, height: 20, page: 1, selected: true)
+doc.add_field("Female", type: :radio, group_id: "gender", value: "female", x: 100, y: 470, width: 20, height: 20, page: 1)
+doc.add_field("Other", type: :radio, group_id: "gender", value: "other", x: 100, y: 440, width: 20, height: 20, page: 1)
+
+# Second radio button group (e.g., "Age Range")
+doc.add_field("18-25", type: :radio, group_id: "age", value: "18-25", x: 200, y: 500, width: 20, height: 20, page: 1)
+doc.add_field("26-35", type: :radio, group_id: "age", value: "26-35", x: 200, y: 470, width: 20, height: 20, page: 1, selected: true)
+doc.add_field("36+", type: :radio, group_id: "age", value: "36+", x: 200, y: 440, width: 20, height: 20, page: 1)
+
+doc.write("form_with_multiple_groups.pdf")
+```
+
+**Note:** Radio buttons are automatically configured with the correct PDF flags to enable mutual exclusivity within a group. When a user selects one radio button, all others in the same group are automatically deselected.
+
 #### Flattening PDFs
 
 ```ruby
@@ -269,8 +347,10 @@ Adds a new form field to the document. Options include:
 - `height`: Field height (Integer, default: 20)
 - `page`: Page number to add the field to (Integer, default: 1)
 - `type`: Field type (Symbol or String, default: `"/Tx"`). Options:
-  - Symbol keys: `:text`, `:button`, `:choice`, `:signature`
+  - Symbol keys: `:text`, `:button`, `:choice`, `:signature`, `:radio`
   - PDF type strings: `"/Tx"`, `"/Btn"`, `"/Ch"`, `"/Sig"`
+- `group_id`: Required for radio buttons. String or identifier to group radio buttons together. All radio buttons in the same group must share the same `group_id`.
+- `selected`: Optional for radio buttons. Boolean (`true` or `false`, or string `"true"`). If set to `true`, this radio button will be selected by default.
 
 Returns a `Field` object if successful.
 
@@ -280,6 +360,9 @@ field = doc.add_field("NewField", value: "Value", x: 100, y: 500, width: 200, he
 
 # Using PDF type strings
 field = doc.add_field("ButtonField", type: "/Btn", x: 100, y: 500, width: 20, height: 20, page: 1)
+
+# Radio button example
+field = doc.add_field("Option1", type: :radio, group_id: "my_group", value: "option1", x: 100, y: 500, width: 20, height: 20, page: 1, selected: true)
 ```
 
 #### `#update_field(name, new_value, new_name: nil)`
@@ -351,8 +434,8 @@ doc.clear!(remove_pattern: /^text-/)
 # Keep only specific fields
 doc.clear!(keep_fields: ["Name", "Email"])
 
-# Use block to filter fields
-doc.clear! { |name| !name.match?(/^[a-f0-9-]{30,}/) }
+# Use block to filter fields (return true to remove)
+doc.clear! { |field| field.name.match?(/^[a-f0-9-]{30,}/) }
 ```
 
 **Note:** This completely rewrites the PDF (like `flatten`), so it's more efficient than using `remove_field` multiple times. See [Clearing Fields Documentation](docs/cleaning_fields.md) for detailed information.

data/docs/clear_fields.md

@@ -75,11 +75,11 @@ doc.clear!(remove_fields: ["OldField1", "OldField2", "GeneratedField3"])
 ### Complex Selection with Block
 
 ```ruby
-# Remove all fields except those matching certain criteria
-doc.clear! do |field_name|
-  # Keep fields that don't look generated
-  !field_name.start_with?("text-") && 
-  !field_name.match?(/^[a-f0-9]{20,}/)
+# Remove fields matching certain criteria
+doc.clear! do |field|
+  # Remove fields that look generated
+  field.name.start_with?("text-") || 
+  field.name.match?(/^[a-f0-9]{20,}/)
 end
 ```
 
@@ -179,11 +179,11 @@ require 'acro_that'
 doc = AcroThat::Document.new("messy_form.pdf")
 
 # Remove all generated/UUID-like fields
-doc.clear! { |name| 
-  # Keep only fields that look intentional
-  !name.match?(/^[a-f0-9-]{30,}/) &&  # Not UUID-like
-  !name.start_with?("temp_") &&       # Not temporary
-  !name.empty?                         # Not empty
+doc.clear! { |field| 
+  # Remove fields that look generated or temporary
+  field.name.match?(/^[a-f0-9-]{30,}/) ||  # UUID-like
+  field.name.start_with?("temp_") ||       # Temporary
+  field.name.empty?                         # Empty name
 }
 
 # Add new fields