Module: LiteParse

Defined in:
lib/liteparse.rb,
lib/liteparse.rb,
lib/liteparse/cli.rb,
lib/liteparse/types.rb,
lib/liteparse/parser.rb,
lib/liteparse/version.rb

Overview

All types (TextItem, ParsedPage, ParseResult, etc.) are defined natively in the Rust extension. This file re-exports them for convenience.

Defined Under Namespace

Modules: CLI Classes: Config, Error, ExtractedImage, LiteParse, ParseResult, ParsedPage, ScreenshotResult, TextItem

Constant Summary collapse

VERSION =

Current version of liteparse-rb.

"0.2.0"

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.native_search_itemsObject



62
# File 'lib/liteparse.rb', line 62

alias_method :native_search_items, :search_items

.search_items(items, phrase, case_sensitive: false) ⇒ Array<LiteParse::TextItem>

Search text items for phrase matches, returning merged items with bounding boxes.

Parameters:

  • items (Array<LiteParse::TextItem>)

    Text items to search

  • phrase (String)

    Phrase to find (may span multiple adjacent items)

  • case_sensitive (Boolean) (defaults to: false)

    Whether matching is case-sensitive (default: false)

Returns:



69
70
71
# File 'lib/liteparse.rb', line 69

def search_items(items, phrase, case_sensitive: false)
  native_search_items(items, phrase, case_sensitive)
end

Instance Method Details

#configLiteParse::Config

Get the current parser configuration.

Returns:



# File 'lib/liteparse/parser.rb', line 32

#parse(input) ⇒ LiteParse::ParseResult

Parse a document from a file path.

Examples:

result = parser.parse("report.pdf")
result.pages.each { |page| puts page.text }

Parameters:

  • input (String)

    Path to the document file (.pdf, .docx, .pptx, .xlsx, .html, image, etc.)

Returns:

Raises:

  • (RuntimeError)

    If parsing fails



# File 'lib/liteparse/parser.rb', line 14

#parse_bytes(data) ⇒ LiteParse::ParseResult

Parse a document from raw bytes.

Examples:

data = File.binread("report.pdf")
result = parser.parse_bytes(data)

Parameters:

  • data (String)

    Raw document bytes (binary string)

Returns:

Raises:

  • (RuntimeError)

    If parsing fails



# File 'lib/liteparse/parser.rb', line 23