pdf_oxide 0.3.55

data/lib/pdf_oxide/pdf_validator.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module PdfOxide
+  # PDF/A · PDF/X · PDF/UA compliance validation (v0.3.50).
+  #
+  # Mirrors `fyi.oxide.pdf.PdfValidator`.  Stateless façade.
+  #
+  # @example
+  #   PdfOxide::PdfDocument.open('compliant.pdf') do |doc|
+  #     puts PdfOxide::PdfValidator.pdf_a?(doc, level: :a1b)
+  #   end
+  module PdfValidator
+    module_function
+
+    # PDF/A level → cdylib wire-format integer.
+    #
+    # Matches `src/ffi.rs:1225` (`0=A1b 1=A1a 2=A2b 3=A2a 4=A2u 5=A3b
+    # 6=A3a 7=A3u`). Every binding (Java, Ruby, PHP, C#, Go) sends the
+    # SAME integer for the same PDF/A level — the "B before A"
+    # intra-level order is the cdylib's contract, not a Ruby choice.
+    PDF_A_LEVELS = { a1b: 0, a1a: 1, a2b: 2, a2a: 3, a2u: 4, a3b: 5, a3a: 6, a3u: 7 }.freeze
+
+    # PDF/UA level → cdylib wire-format integer.
+    #
+    # Matches `src/ffi.rs:5538` (`level == 2 → UA-2, else UA-1`).
+    # 1-indexed, not 0-indexed; mirrors the C# `PdfUaLevel` enum.
+    PDF_UA_LEVELS = { ua1: 1, ua2: 2 }.freeze
+
+    # @return [Boolean] PDF/A compliance for `level`.
+    def pdf_a?(doc, level: :a1b)
+      raise ::PdfOxide::ArgumentError, 'doc cannot be nil' if doc.nil?
+
+      ordinal = PDF_A_LEVELS.fetch(level) do
+        raise ::PdfOxide::ArgumentError, "unknown PDF/A level: #{level.inspect}"
+      end
+      # If the native symbol is absent (older cdylib), surface a clean
+      # "unavailable" verdict instead of reading an uninitialised err
+      # buffer and raising a spurious ComplianceError.
+      return false unless Bindings.respond_to?(:pdf_validate_pdf_a_level)
+
+      err = ::FFI::MemoryPointer.new(:int32)
+      result_ptr = Bindings.pdf_validate_pdf_a_level(doc.handle, ordinal, err)
+      code = err.read_int32
+      raise ComplianceError, "pdf_validate_pdf_a_level failed (#{code})" if code != 0
+
+      compliance_verdict(result_ptr, :pdf_pdf_a_is_compliant, :pdf_pdf_a_results_free)
+    rescue ::FFI::NotFoundError
+      false
+    end
+
+    # @return [Boolean] PDF/UA compliance for `level`.
+    def pdf_ua?(doc, level: :ua1)
+      raise ::PdfOxide::ArgumentError, 'doc cannot be nil' if doc.nil?
+
+      ordinal = PDF_UA_LEVELS.fetch(level) do
+        raise ::PdfOxide::ArgumentError, "unknown PDF/UA level: #{level.inspect}"
+      end
+      err = ::FFI::MemoryPointer.new(:int32)
+      result_ptr = Bindings.pdf_validate_pdf_ua(doc.handle, ordinal, err)
+      code = err.read_int32
+      raise ComplianceError, "pdf_validate_pdf_ua failed (#{code})" if code != 0
+
+      compliance_verdict(result_ptr, :pdf_pdf_ua_is_accessible, :pdf_pdf_ua_results_free)
+    rescue ::FFI::NotFoundError
+      false
+    end
+
+    # @return [Hash] simplified PDF/A validation result: { compliant:, violations: }.
+    def validate_pdf_a(doc, level: :a1b)
+      { compliant: pdf_a?(doc, level: level), violations: [] }
+    end
+
+    # @return [Hash] simplified PDF/UA validation result.
+    def validate_pdf_ua(doc, level: :ua1)
+      { compliant: pdf_ua?(doc, level: level), violations: [] }
+    end
+
+    # The accessor symbols (pdf_pdf_a_is_compliant, pdf_pdf_x_is_compliant,
+    # pdf_pdf_ua_is_accessible) all take (results, int32_t *error_code).
+    # Pre-v0.3.55 Ruby bound them with just (results) — register garbage
+    # was used as the err pointer and the cdylib wrote through it,
+    # producing the same flaky segfault class as the search-result
+    # accessors (#547). Both args are passed here so the new 2-arg
+    # binding is honoured.
+    def self.compliance_verdict(result_ptr, accessor_sym, free_sym)
+      return false if result_ptr.nil? || result_ptr.null?
+
+      err = ::FFI::MemoryPointer.new(:int32)
+      begin
+        Bindings.send(accessor_sym, result_ptr, err)
+      ensure
+        Bindings.send(free_sym, result_ptr) if Bindings.respond_to?(free_sym)
+      end
+    end
+    private_class_method :compliance_verdict
+  end
+end

data/lib/pdf_oxide/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PdfOxide
+  VERSION = '0.3.55'
+end

data/lib/pdf_oxide.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+# Ruby bindings for pdf_oxide — high-performance PDF processing.
+#
+# Idiomatic 9-class API mirroring the Java binding's shape at
+# `fyi.oxide.pdf.*`.  All native calls route through the FFI layer
+# at `PdfOxide::FFI::Bindings`; UTF-8 marshalling is via
+# `PdfOxide::FFI::StringMarshaller`.
+#
+# Public surface:
+#   - {PdfOxide::PdfDocument}     — read-only entry point.
+#   - {PdfOxide::PdfPage}         — per-page view.
+#   - {PdfOxide::Pdf}             — create + transform (markdown/html/text → PDF).
+#   - {PdfOxide::DocumentEditor}  — write-side: form-fill, redaction, save.
+#   - {PdfOxide::AutoExtractor}   — typed-reason auto-extraction (#519).
+#   - {PdfOxide::MarkdownConverter} — PDF → Markdown / HTML.
+#   - {PdfOxide::PdfValidator}    — PDF/A · PDF/UA compliance.
+#   - {PdfOxide::PdfSigner}       — PAdES B/T/LT/LTA signing.
+#   - {PdfOxide::PdfPolicy}       — process-global crypto-governance.
+
+require 'ffi'
+
+require_relative 'pdf_oxide/version'
+require_relative 'pdf_oxide/errors'
+require_relative 'pdf_oxide/ffi/library'
+require_relative 'pdf_oxide/ffi/bindings'
+require_relative 'pdf_oxide/ffi/string_marshaller'
+
+module PdfOxide
+  # Convenience constants reaching into the FFI sub-module.  Keeps
+  # downstream callers free of the `PdfOxide::FFI::` prefix when
+  # accessing the binding layer; matches the Java binding's flat shape.
+  Bindings         = FFI::Bindings
+  StringMarshaller = FFI::StringMarshaller
+end
+
+require_relative 'pdf_oxide/pdf_page'
+require_relative 'pdf_oxide/markdown_converter'
+require_relative 'pdf_oxide/auto_extractor'
+require_relative 'pdf_oxide/pdf_document'
+require_relative 'pdf_oxide/pdf'
+require_relative 'pdf_oxide/document_editor'
+require_relative 'pdf_oxide/pdf_signer'
+require_relative 'pdf_oxide/pdf_validator'
+require_relative 'pdf_oxide/pdf_policy'
+
+module PdfOxide
+  class << self
+    # Open a PDF for reading.
+    # @return [PdfDocument]
+    def open(source, password: nil, &block)
+      PdfDocument.open(source, password: password, &block)
+    end
+
+    # @return [String] library version.
+    def version
+      VERSION
+    end
+  end
+end

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: pdf_oxide
+version: !ruby/object:Gem::Version
+  version: 0.3.55
+platform: ruby
+authors:
+- PDF Oxide Contributors
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ffi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.86'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.86'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.20'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+description: Idiomatic Ruby bindings for PDF Oxide. Process, analyze, and generate
+  PDFs through the libpdf_oxide cdylib used by the Python, Java, Node, Go, and C#
+  bindings.
+email:
+- support@pdf-oxide.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- LICENSE-APACHE
+- LICENSE-MIT
+- README.md
+- lib/pdf_oxide.rb
+- lib/pdf_oxide/auto_extractor.rb
+- lib/pdf_oxide/document_editor.rb
+- lib/pdf_oxide/errors.rb
+- lib/pdf_oxide/ffi/bindings.rb
+- lib/pdf_oxide/ffi/library.rb
+- lib/pdf_oxide/ffi/string_marshaller.rb
+- lib/pdf_oxide/markdown_converter.rb
+- lib/pdf_oxide/pdf.rb
+- lib/pdf_oxide/pdf_document.rb
+- lib/pdf_oxide/pdf_page.rb
+- lib/pdf_oxide/pdf_policy.rb
+- lib/pdf_oxide/pdf_signer.rb
+- lib/pdf_oxide/pdf_validator.rb
+- lib/pdf_oxide/version.rb
+homepage: https://github.com/yfedoseev/pdf_oxide
+licenses:
+- MIT
+- Apache-2.0
+metadata:
+  homepage_uri: https://github.com/yfedoseev/pdf_oxide
+  source_code_uri: https://github.com/yfedoseev/pdf_oxide
+  bug_tracker_uri: https://github.com/yfedoseev/pdf_oxide/issues
+  documentation_uri: https://rubydoc.info/gems/pdf_oxide
+  changelog_uri: https://github.com/yfedoseev/pdf_oxide/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Ruby bindings for PDF Oxide - high-performance PDF processing
+test_files: []