Class: Tahweel::PdfSplitter

Inherits:
Object
  • Object
show all
Defined in:
lib/tahweel/pdf_splitter.rb

Overview

Handles the logic for splitting a PDF file into individual image pages. Uses Poppler utils (pdftoppm, pdfinfo) for high-performance image processing.

Constant Summary collapse

DEFAULT_DPI =

Default DPI used when converting PDF pages to images. 150 DPI is a good balance between quality and file size for general documents.

150

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(pdf_path, dpi: DEFAULT_DPI) ⇒ PdfSplitter

Initializes a new PdfSplitter instance.

Parameters:

  • pdf_path (String) —

    The local file path to the PDF document.

  • dpi (Integer) (defaults to: DEFAULT_DPI) —

    The resolution (Dots Per Inch) to use. Defaults to 150.



37
38
39
40
 
# File 'lib/tahweel/pdf_splitter.rb', line 37

def initialize(pdf_path, dpi: DEFAULT_DPI)
  @pdf_path = pdf_path
  @dpi = dpi
end

Class Method Details

.split(pdf_path, dpi: DEFAULT_DPI) {|Hash| ... } ⇒ Hash

Convenience class method to initialize and execute the split operation in one go.

}

Parameters:

  • pdf_path (String) —

    The local file path to the PDF document.

  • dpi (Integer) (defaults to: DEFAULT_DPI) —

    The resolution (Dots Per Inch) for rendering the PDF pages. Defaults to 150.

  • &block (Proc) —

    A block that will be yielded with progress info.

Yields:

  • (Hash) —

    Progress info: { stage: :splitting, current_page: Integer, percentage: Float, remaining_pages: Integer

Returns:

  • (Hash) —

    A hash containing the :folder_path (String) and :images_paths (Array).



31
 
# File 'lib/tahweel/pdf_splitter.rb', line 31

def self.split(pdf_path, dpi: DEFAULT_DPI, &) = new(pdf_path, dpi:).split(&)

Instance Method Details

#split {|Hash| ... } ⇒ Hash

Executes the PDF splitting process.

This method performs the following steps:

  1. Checks if Poppler utils are available (installs if missing on Windows).
  2. Validates the existence of the source PDF file.
  3. Creates a unique temporary directory for output.
  4. Iterates through each page of the PDF and converts it to a PNG image.

}

Parameters:

  • &block (Proc) —

    A block that will be yielded with progress info.

Yields:

  • (Hash) —

    Progress info: { stage: :splitting, current_page: Integer, percentage: Float, remaining_pages: Integer

Returns:

  • (Hash) —

    Result hash with keys:

    • :folder_path [String] The absolute path to the temporary directory containing the images.
    • :images_paths [Array] List of absolute paths for each generated image file.

Raises:

  • (RuntimeError) —

    If the PDF file is not found.



61
62
63
64
65
66
67
 
# File 'lib/tahweel/pdf_splitter.rb', line 61

def split(&)
  validate_file_exists!
  PopplerInstaller.ensure_installed!
  setup_output_directory
  process_pages(&)
  result
end