Class: Tahweel::Writers::Txt

Inherits:

Object

• Object
• Tahweel::Writers::Txt

Defined in:

lib/tahweel/writers/txt.rb

Overview

Writer class for outputting text to a .txt file.

Constant Summary

PAGE_SEPARATOR =

"\n\nPAGE_SEPARATOR\n\n"

Instance Method Summary

• #extension ⇒ String

  Returns the file extension for this writer.

• #write(texts, destination, options = {}) ⇒ void

  Writes the extracted texts to a file.

Instance Method Details

#extension ⇒ String

Returns the file extension for this writer.

Returns:

• (String) —

  The file extension.

# File 'lib/tahweel/writers/txt.rb', line 12

def extension = "txt"

#write(texts, destination, options = {}) ⇒ void

This method returns an undefined value.

Writes the extracted texts to a file.

Parameters:

• texts (Array<String>) —

  The extracted texts (one per page).

• destination (String) —

  The output file path.

• options (Hash) (defaults to: {}) —

  Options for writing.

Options Hash (options):

• :page_separator (String) — default: PAGE_SEPARATOR —

  Separator between pages.

# File 'lib/tahweel/writers/txt.rb', line 21

def write(texts, destination, options = {})
  separator = options[:page_separator] || PAGE_SEPARATOR
  File.write(destination, texts.map(&:strip).join(separator))
end