kreuzberg 4.0.0.pre.rc.13 → 4.0.0.pre.rc.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gitignore +14 -14
- data/.rspec +3 -3
- data/.rubocop.yaml +1 -1
- data/.rubocop.yml +538 -538
- data/Gemfile +8 -8
- data/Gemfile.lock +105 -2
- data/README.md +454 -454
- data/Rakefile +33 -25
- data/Steepfile +47 -47
- data/examples/async_patterns.rb +341 -341
- data/ext/kreuzberg_rb/extconf.rb +45 -45
- data/ext/kreuzberg_rb/native/.cargo/config.toml +2 -2
- data/ext/kreuzberg_rb/native/Cargo.lock +6940 -6941
- data/ext/kreuzberg_rb/native/Cargo.toml +54 -54
- data/ext/kreuzberg_rb/native/README.md +425 -425
- data/ext/kreuzberg_rb/native/build.rs +15 -15
- data/ext/kreuzberg_rb/native/include/ieeefp.h +11 -11
- data/ext/kreuzberg_rb/native/include/msvc_compat/strings.h +14 -14
- data/ext/kreuzberg_rb/native/include/strings.h +20 -20
- data/ext/kreuzberg_rb/native/include/unistd.h +47 -47
- data/ext/kreuzberg_rb/native/src/lib.rs +3158 -3158
- data/extconf.rb +28 -28
- data/kreuzberg.gemspec +214 -214
- data/lib/kreuzberg/api_proxy.rb +142 -142
- data/lib/kreuzberg/cache_api.rb +81 -81
- data/lib/kreuzberg/cli.rb +55 -55
- data/lib/kreuzberg/cli_proxy.rb +127 -127
- data/lib/kreuzberg/config.rb +724 -724
- data/lib/kreuzberg/error_context.rb +80 -80
- data/lib/kreuzberg/errors.rb +118 -118
- data/lib/kreuzberg/extraction_api.rb +340 -340
- data/lib/kreuzberg/mcp_proxy.rb +186 -186
- data/lib/kreuzberg/ocr_backend_protocol.rb +113 -113
- data/lib/kreuzberg/post_processor_protocol.rb +86 -86
- data/lib/kreuzberg/result.rb +279 -279
- data/lib/kreuzberg/setup_lib_path.rb +80 -80
- data/lib/kreuzberg/validator_protocol.rb +89 -89
- data/lib/kreuzberg/version.rb +5 -5
- data/lib/kreuzberg.rb +109 -109
- data/lib/{pdfium.dll → libpdfium.dylib} +0 -0
- data/sig/kreuzberg/internal.rbs +184 -184
- data/sig/kreuzberg.rbs +546 -546
- data/spec/binding/cache_spec.rb +227 -227
- data/spec/binding/cli_proxy_spec.rb +85 -85
- data/spec/binding/cli_spec.rb +55 -55
- data/spec/binding/config_spec.rb +345 -345
- data/spec/binding/config_validation_spec.rb +283 -283
- data/spec/binding/error_handling_spec.rb +213 -213
- data/spec/binding/errors_spec.rb +66 -66
- data/spec/binding/plugins/ocr_backend_spec.rb +307 -307
- data/spec/binding/plugins/postprocessor_spec.rb +269 -269
- data/spec/binding/plugins/validator_spec.rb +274 -274
- data/spec/fixtures/config.toml +39 -39
- data/spec/fixtures/config.yaml +41 -41
- data/spec/fixtures/invalid_config.toml +4 -4
- data/spec/smoke/package_spec.rb +178 -178
- data/spec/spec_helper.rb +42 -42
- data/vendor/Cargo.toml +1 -1
- data/vendor/kreuzberg/Cargo.toml +5 -5
- data/vendor/kreuzberg/README.md +230 -230
- data/vendor/kreuzberg/benches/otel_overhead.rs +48 -48
- data/vendor/kreuzberg/build.rs +843 -843
- data/vendor/kreuzberg/src/api/error.rs +81 -81
- data/vendor/kreuzberg/src/api/handlers.rs +199 -199
- data/vendor/kreuzberg/src/api/mod.rs +79 -79
- data/vendor/kreuzberg/src/api/server.rs +353 -353
- data/vendor/kreuzberg/src/api/types.rs +170 -170
- data/vendor/kreuzberg/src/cache/mod.rs +1167 -1167
- data/vendor/kreuzberg/src/chunking/mod.rs +1877 -1877
- data/vendor/kreuzberg/src/chunking/processor.rs +220 -220
- data/vendor/kreuzberg/src/core/batch_mode.rs +95 -95
- data/vendor/kreuzberg/src/core/config.rs +1080 -1080
- data/vendor/kreuzberg/src/core/extractor.rs +1156 -1156
- data/vendor/kreuzberg/src/core/io.rs +329 -329
- data/vendor/kreuzberg/src/core/mime.rs +605 -605
- data/vendor/kreuzberg/src/core/mod.rs +47 -47
- data/vendor/kreuzberg/src/core/pipeline.rs +1184 -1184
- data/vendor/kreuzberg/src/embeddings.rs +500 -500
- data/vendor/kreuzberg/src/error.rs +431 -431
- data/vendor/kreuzberg/src/extraction/archive.rs +954 -954
- data/vendor/kreuzberg/src/extraction/docx.rs +398 -398
- data/vendor/kreuzberg/src/extraction/email.rs +854 -854
- data/vendor/kreuzberg/src/extraction/excel.rs +688 -688
- data/vendor/kreuzberg/src/extraction/html.rs +601 -601
- data/vendor/kreuzberg/src/extraction/image.rs +491 -491
- data/vendor/kreuzberg/src/extraction/libreoffice.rs +574 -574
- data/vendor/kreuzberg/src/extraction/markdown.rs +213 -213
- data/vendor/kreuzberg/src/extraction/mod.rs +81 -81
- data/vendor/kreuzberg/src/extraction/office_metadata/app_properties.rs +398 -398
- data/vendor/kreuzberg/src/extraction/office_metadata/core_properties.rs +247 -247
- data/vendor/kreuzberg/src/extraction/office_metadata/custom_properties.rs +240 -240
- data/vendor/kreuzberg/src/extraction/office_metadata/mod.rs +130 -130
- data/vendor/kreuzberg/src/extraction/office_metadata/odt_properties.rs +284 -284
- data/vendor/kreuzberg/src/extraction/pptx.rs +3100 -3100
- data/vendor/kreuzberg/src/extraction/structured.rs +490 -490
- data/vendor/kreuzberg/src/extraction/table.rs +328 -328
- data/vendor/kreuzberg/src/extraction/text.rs +269 -269
- data/vendor/kreuzberg/src/extraction/xml.rs +333 -333
- data/vendor/kreuzberg/src/extractors/archive.rs +447 -447
- data/vendor/kreuzberg/src/extractors/bibtex.rs +470 -470
- data/vendor/kreuzberg/src/extractors/docbook.rs +504 -504
- data/vendor/kreuzberg/src/extractors/docx.rs +400 -400
- data/vendor/kreuzberg/src/extractors/email.rs +157 -157
- data/vendor/kreuzberg/src/extractors/epub.rs +708 -708
- data/vendor/kreuzberg/src/extractors/excel.rs +345 -345
- data/vendor/kreuzberg/src/extractors/fictionbook.rs +492 -492
- data/vendor/kreuzberg/src/extractors/html.rs +407 -407
- data/vendor/kreuzberg/src/extractors/image.rs +219 -219
- data/vendor/kreuzberg/src/extractors/jats.rs +1054 -1054
- data/vendor/kreuzberg/src/extractors/jupyter.rs +368 -368
- data/vendor/kreuzberg/src/extractors/latex.rs +653 -653
- data/vendor/kreuzberg/src/extractors/markdown.rs +701 -701
- data/vendor/kreuzberg/src/extractors/mod.rs +429 -429
- data/vendor/kreuzberg/src/extractors/odt.rs +628 -628
- data/vendor/kreuzberg/src/extractors/opml.rs +635 -635
- data/vendor/kreuzberg/src/extractors/orgmode.rs +529 -529
- data/vendor/kreuzberg/src/extractors/pdf.rs +749 -749
- data/vendor/kreuzberg/src/extractors/pptx.rs +267 -267
- data/vendor/kreuzberg/src/extractors/rst.rs +577 -577
- data/vendor/kreuzberg/src/extractors/rtf.rs +809 -809
- data/vendor/kreuzberg/src/extractors/security.rs +484 -484
- data/vendor/kreuzberg/src/extractors/security_tests.rs +367 -367
- data/vendor/kreuzberg/src/extractors/structured.rs +142 -142
- data/vendor/kreuzberg/src/extractors/text.rs +265 -265
- data/vendor/kreuzberg/src/extractors/typst.rs +651 -651
- data/vendor/kreuzberg/src/extractors/xml.rs +147 -147
- data/vendor/kreuzberg/src/image/dpi.rs +164 -164
- data/vendor/kreuzberg/src/image/mod.rs +6 -6
- data/vendor/kreuzberg/src/image/preprocessing.rs +417 -417
- data/vendor/kreuzberg/src/image/resize.rs +89 -89
- data/vendor/kreuzberg/src/keywords/config.rs +154 -154
- data/vendor/kreuzberg/src/keywords/mod.rs +237 -237
- data/vendor/kreuzberg/src/keywords/processor.rs +275 -275
- data/vendor/kreuzberg/src/keywords/rake.rs +293 -293
- data/vendor/kreuzberg/src/keywords/types.rs +68 -68
- data/vendor/kreuzberg/src/keywords/yake.rs +163 -163
- data/vendor/kreuzberg/src/language_detection/mod.rs +985 -985
- data/vendor/kreuzberg/src/language_detection/processor.rs +219 -219
- data/vendor/kreuzberg/src/lib.rs +113 -113
- data/vendor/kreuzberg/src/mcp/mod.rs +35 -35
- data/vendor/kreuzberg/src/mcp/server.rs +2076 -2076
- data/vendor/kreuzberg/src/ocr/cache.rs +469 -469
- data/vendor/kreuzberg/src/ocr/error.rs +37 -37
- data/vendor/kreuzberg/src/ocr/hocr.rs +216 -216
- data/vendor/kreuzberg/src/ocr/mod.rs +58 -58
- data/vendor/kreuzberg/src/ocr/processor.rs +863 -863
- data/vendor/kreuzberg/src/ocr/table/mod.rs +4 -4
- data/vendor/kreuzberg/src/ocr/table/tsv_parser.rs +144 -144
- data/vendor/kreuzberg/src/ocr/tesseract_backend.rs +452 -452
- data/vendor/kreuzberg/src/ocr/types.rs +393 -393
- data/vendor/kreuzberg/src/ocr/utils.rs +47 -47
- data/vendor/kreuzberg/src/ocr/validation.rs +206 -206
- data/vendor/kreuzberg/src/panic_context.rs +154 -154
- data/vendor/kreuzberg/src/pdf/bindings.rs +44 -44
- data/vendor/kreuzberg/src/pdf/bundled.rs +346 -346
- data/vendor/kreuzberg/src/pdf/error.rs +130 -130
- data/vendor/kreuzberg/src/pdf/images.rs +139 -139
- data/vendor/kreuzberg/src/pdf/metadata.rs +489 -489
- data/vendor/kreuzberg/src/pdf/mod.rs +68 -68
- data/vendor/kreuzberg/src/pdf/rendering.rs +368 -368
- data/vendor/kreuzberg/src/pdf/table.rs +420 -420
- data/vendor/kreuzberg/src/pdf/text.rs +240 -240
- data/vendor/kreuzberg/src/plugins/extractor.rs +1044 -1044
- data/vendor/kreuzberg/src/plugins/mod.rs +212 -212
- data/vendor/kreuzberg/src/plugins/ocr.rs +639 -639
- data/vendor/kreuzberg/src/plugins/processor.rs +650 -650
- data/vendor/kreuzberg/src/plugins/registry.rs +1339 -1339
- data/vendor/kreuzberg/src/plugins/traits.rs +258 -258
- data/vendor/kreuzberg/src/plugins/validator.rs +967 -967
- data/vendor/kreuzberg/src/stopwords/mod.rs +1470 -1470
- data/vendor/kreuzberg/src/text/mod.rs +25 -25
- data/vendor/kreuzberg/src/text/quality.rs +697 -697
- data/vendor/kreuzberg/src/text/quality_processor.rs +219 -219
- data/vendor/kreuzberg/src/text/string_utils.rs +217 -217
- data/vendor/kreuzberg/src/text/token_reduction/cjk_utils.rs +164 -164
- data/vendor/kreuzberg/src/text/token_reduction/config.rs +100 -100
- data/vendor/kreuzberg/src/text/token_reduction/core.rs +796 -796
- data/vendor/kreuzberg/src/text/token_reduction/filters.rs +902 -902
- data/vendor/kreuzberg/src/text/token_reduction/mod.rs +160 -160
- data/vendor/kreuzberg/src/text/token_reduction/semantic.rs +619 -619
- data/vendor/kreuzberg/src/text/token_reduction/simd_text.rs +147 -147
- data/vendor/kreuzberg/src/types.rs +1055 -1055
- data/vendor/kreuzberg/src/utils/mod.rs +17 -17
- data/vendor/kreuzberg/src/utils/quality.rs +959 -959
- data/vendor/kreuzberg/src/utils/string_utils.rs +381 -381
- data/vendor/kreuzberg/stopwords/af_stopwords.json +53 -53
- data/vendor/kreuzberg/stopwords/ar_stopwords.json +482 -482
- data/vendor/kreuzberg/stopwords/bg_stopwords.json +261 -261
- data/vendor/kreuzberg/stopwords/bn_stopwords.json +400 -400
- data/vendor/kreuzberg/stopwords/br_stopwords.json +1205 -1205
- data/vendor/kreuzberg/stopwords/ca_stopwords.json +280 -280
- data/vendor/kreuzberg/stopwords/cs_stopwords.json +425 -425
- data/vendor/kreuzberg/stopwords/da_stopwords.json +172 -172
- data/vendor/kreuzberg/stopwords/de_stopwords.json +622 -622
- data/vendor/kreuzberg/stopwords/el_stopwords.json +849 -849
- data/vendor/kreuzberg/stopwords/en_stopwords.json +1300 -1300
- data/vendor/kreuzberg/stopwords/eo_stopwords.json +175 -175
- data/vendor/kreuzberg/stopwords/es_stopwords.json +734 -734
- data/vendor/kreuzberg/stopwords/et_stopwords.json +37 -37
- data/vendor/kreuzberg/stopwords/eu_stopwords.json +100 -100
- data/vendor/kreuzberg/stopwords/fa_stopwords.json +801 -801
- data/vendor/kreuzberg/stopwords/fi_stopwords.json +849 -849
- data/vendor/kreuzberg/stopwords/fr_stopwords.json +693 -693
- data/vendor/kreuzberg/stopwords/ga_stopwords.json +111 -111
- data/vendor/kreuzberg/stopwords/gl_stopwords.json +162 -162
- data/vendor/kreuzberg/stopwords/gu_stopwords.json +226 -226
- data/vendor/kreuzberg/stopwords/ha_stopwords.json +41 -41
- data/vendor/kreuzberg/stopwords/he_stopwords.json +196 -196
- data/vendor/kreuzberg/stopwords/hi_stopwords.json +227 -227
- data/vendor/kreuzberg/stopwords/hr_stopwords.json +181 -181
- data/vendor/kreuzberg/stopwords/hu_stopwords.json +791 -791
- data/vendor/kreuzberg/stopwords/hy_stopwords.json +47 -47
- data/vendor/kreuzberg/stopwords/id_stopwords.json +760 -760
- data/vendor/kreuzberg/stopwords/it_stopwords.json +634 -634
- data/vendor/kreuzberg/stopwords/ja_stopwords.json +136 -136
- data/vendor/kreuzberg/stopwords/kn_stopwords.json +84 -84
- data/vendor/kreuzberg/stopwords/ko_stopwords.json +681 -681
- data/vendor/kreuzberg/stopwords/ku_stopwords.json +64 -64
- data/vendor/kreuzberg/stopwords/la_stopwords.json +51 -51
- data/vendor/kreuzberg/stopwords/lt_stopwords.json +476 -476
- data/vendor/kreuzberg/stopwords/lv_stopwords.json +163 -163
- data/vendor/kreuzberg/stopwords/ml_stopwords.json +1 -1
- data/vendor/kreuzberg/stopwords/mr_stopwords.json +101 -101
- data/vendor/kreuzberg/stopwords/ms_stopwords.json +477 -477
- data/vendor/kreuzberg/stopwords/ne_stopwords.json +490 -490
- data/vendor/kreuzberg/stopwords/nl_stopwords.json +415 -415
- data/vendor/kreuzberg/stopwords/no_stopwords.json +223 -223
- data/vendor/kreuzberg/stopwords/pl_stopwords.json +331 -331
- data/vendor/kreuzberg/stopwords/pt_stopwords.json +562 -562
- data/vendor/kreuzberg/stopwords/ro_stopwords.json +436 -436
- data/vendor/kreuzberg/stopwords/ru_stopwords.json +561 -561
- data/vendor/kreuzberg/stopwords/si_stopwords.json +193 -193
- data/vendor/kreuzberg/stopwords/sk_stopwords.json +420 -420
- data/vendor/kreuzberg/stopwords/sl_stopwords.json +448 -448
- data/vendor/kreuzberg/stopwords/so_stopwords.json +32 -32
- data/vendor/kreuzberg/stopwords/st_stopwords.json +33 -33
- data/vendor/kreuzberg/stopwords/sv_stopwords.json +420 -420
- data/vendor/kreuzberg/stopwords/sw_stopwords.json +76 -76
- data/vendor/kreuzberg/stopwords/ta_stopwords.json +129 -129
- data/vendor/kreuzberg/stopwords/te_stopwords.json +54 -54
- data/vendor/kreuzberg/stopwords/th_stopwords.json +118 -118
- data/vendor/kreuzberg/stopwords/tl_stopwords.json +149 -149
- data/vendor/kreuzberg/stopwords/tr_stopwords.json +506 -506
- data/vendor/kreuzberg/stopwords/uk_stopwords.json +75 -75
- data/vendor/kreuzberg/stopwords/ur_stopwords.json +519 -519
- data/vendor/kreuzberg/stopwords/vi_stopwords.json +647 -647
- data/vendor/kreuzberg/stopwords/yo_stopwords.json +62 -62
- data/vendor/kreuzberg/stopwords/zh_stopwords.json +796 -796
- data/vendor/kreuzberg/stopwords/zu_stopwords.json +31 -31
- data/vendor/kreuzberg/tests/api_extract_multipart.rs +52 -52
- data/vendor/kreuzberg/tests/api_tests.rs +966 -966
- data/vendor/kreuzberg/tests/archive_integration.rs +545 -545
- data/vendor/kreuzberg/tests/batch_orchestration.rs +556 -556
- data/vendor/kreuzberg/tests/batch_processing.rs +318 -318
- data/vendor/kreuzberg/tests/bibtex_parity_test.rs +421 -421
- data/vendor/kreuzberg/tests/concurrency_stress.rs +533 -533
- data/vendor/kreuzberg/tests/config_features.rs +612 -612
- data/vendor/kreuzberg/tests/config_loading_tests.rs +416 -416
- data/vendor/kreuzberg/tests/core_integration.rs +510 -510
- data/vendor/kreuzberg/tests/csv_integration.rs +414 -414
- data/vendor/kreuzberg/tests/docbook_extractor_tests.rs +500 -500
- data/vendor/kreuzberg/tests/docx_metadata_extraction_test.rs +122 -122
- data/vendor/kreuzberg/tests/docx_vs_pandoc_comparison.rs +370 -370
- data/vendor/kreuzberg/tests/email_integration.rs +327 -327
- data/vendor/kreuzberg/tests/epub_native_extractor_tests.rs +275 -275
- data/vendor/kreuzberg/tests/error_handling.rs +402 -402
- data/vendor/kreuzberg/tests/fictionbook_extractor_tests.rs +228 -228
- data/vendor/kreuzberg/tests/format_integration.rs +164 -164
- data/vendor/kreuzberg/tests/helpers/mod.rs +142 -142
- data/vendor/kreuzberg/tests/html_table_test.rs +551 -551
- data/vendor/kreuzberg/tests/image_integration.rs +255 -255
- data/vendor/kreuzberg/tests/instrumentation_test.rs +139 -139
- data/vendor/kreuzberg/tests/jats_extractor_tests.rs +639 -639
- data/vendor/kreuzberg/tests/jupyter_extractor_tests.rs +704 -704
- data/vendor/kreuzberg/tests/keywords_integration.rs +479 -479
- data/vendor/kreuzberg/tests/keywords_quality.rs +509 -509
- data/vendor/kreuzberg/tests/latex_extractor_tests.rs +496 -496
- data/vendor/kreuzberg/tests/markdown_extractor_tests.rs +490 -490
- data/vendor/kreuzberg/tests/mime_detection.rs +429 -429
- data/vendor/kreuzberg/tests/ocr_configuration.rs +514 -514
- data/vendor/kreuzberg/tests/ocr_errors.rs +698 -698
- data/vendor/kreuzberg/tests/ocr_quality.rs +629 -629
- data/vendor/kreuzberg/tests/ocr_stress.rs +469 -469
- data/vendor/kreuzberg/tests/odt_extractor_tests.rs +674 -674
- data/vendor/kreuzberg/tests/opml_extractor_tests.rs +616 -616
- data/vendor/kreuzberg/tests/orgmode_extractor_tests.rs +822 -822
- data/vendor/kreuzberg/tests/pdf_integration.rs +45 -45
- data/vendor/kreuzberg/tests/pdfium_linking.rs +374 -374
- data/vendor/kreuzberg/tests/pipeline_integration.rs +1436 -1436
- data/vendor/kreuzberg/tests/plugin_ocr_backend_test.rs +776 -776
- data/vendor/kreuzberg/tests/plugin_postprocessor_test.rs +560 -560
- data/vendor/kreuzberg/tests/plugin_system.rs +927 -927
- data/vendor/kreuzberg/tests/plugin_validator_test.rs +783 -783
- data/vendor/kreuzberg/tests/registry_integration_tests.rs +587 -587
- data/vendor/kreuzberg/tests/rst_extractor_tests.rs +694 -694
- data/vendor/kreuzberg/tests/rtf_extractor_tests.rs +775 -775
- data/vendor/kreuzberg/tests/security_validation.rs +416 -416
- data/vendor/kreuzberg/tests/stopwords_integration_test.rs +888 -888
- data/vendor/kreuzberg/tests/test_fastembed.rs +631 -631
- data/vendor/kreuzberg/tests/typst_behavioral_tests.rs +1260 -1260
- data/vendor/kreuzberg/tests/typst_extractor_tests.rs +648 -648
- data/vendor/kreuzberg/tests/xlsx_metadata_extraction_test.rs +87 -87
- data/vendor/kreuzberg-ffi/Cargo.toml +1 -1
- data/vendor/kreuzberg-ffi/README.md +851 -851
- data/vendor/kreuzberg-ffi/build.rs +176 -176
- data/vendor/kreuzberg-ffi/cbindgen.toml +27 -27
- data/vendor/kreuzberg-ffi/kreuzberg-ffi.pc.in +12 -12
- data/vendor/kreuzberg-ffi/kreuzberg.h +1087 -1087
- data/vendor/kreuzberg-ffi/src/lib.rs +3616 -3616
- data/vendor/kreuzberg-ffi/src/panic_shield.rs +247 -247
- data/vendor/kreuzberg-ffi/tests.disabled/README.md +48 -48
- data/vendor/kreuzberg-ffi/tests.disabled/config_loading_tests.rs +299 -299
- data/vendor/kreuzberg-ffi/tests.disabled/config_tests.rs +346 -346
- data/vendor/kreuzberg-ffi/tests.disabled/extractor_tests.rs +232 -232
- data/vendor/kreuzberg-ffi/tests.disabled/plugin_registration_tests.rs +470 -470
- data/vendor/kreuzberg-tesseract/.commitlintrc.json +13 -13
- data/vendor/kreuzberg-tesseract/.crate-ignore +2 -2
- data/vendor/kreuzberg-tesseract/Cargo.lock +2933 -2933
- data/vendor/kreuzberg-tesseract/Cargo.toml +2 -2
- data/vendor/kreuzberg-tesseract/LICENSE +22 -22
- data/vendor/kreuzberg-tesseract/README.md +399 -399
- data/vendor/kreuzberg-tesseract/build.rs +1354 -1354
- data/vendor/kreuzberg-tesseract/patches/README.md +71 -71
- data/vendor/kreuzberg-tesseract/patches/tesseract.diff +199 -199
- data/vendor/kreuzberg-tesseract/src/api.rs +1371 -1371
- data/vendor/kreuzberg-tesseract/src/choice_iterator.rs +77 -77
- data/vendor/kreuzberg-tesseract/src/enums.rs +297 -297
- data/vendor/kreuzberg-tesseract/src/error.rs +81 -81
- data/vendor/kreuzberg-tesseract/src/lib.rs +145 -145
- data/vendor/kreuzberg-tesseract/src/monitor.rs +57 -57
- data/vendor/kreuzberg-tesseract/src/mutable_iterator.rs +197 -197
- data/vendor/kreuzberg-tesseract/src/page_iterator.rs +253 -253
- data/vendor/kreuzberg-tesseract/src/result_iterator.rs +286 -286
- data/vendor/kreuzberg-tesseract/src/result_renderer.rs +183 -183
- data/vendor/kreuzberg-tesseract/tests/integration_test.rs +211 -211
- data/vendor/rb-sys/.cargo_vcs_info.json +5 -5
- data/vendor/rb-sys/Cargo.lock +393 -393
- data/vendor/rb-sys/Cargo.toml +70 -70
- data/vendor/rb-sys/Cargo.toml.orig +57 -57
- data/vendor/rb-sys/LICENSE-APACHE +190 -190
- data/vendor/rb-sys/LICENSE-MIT +21 -21
- data/vendor/rb-sys/build/features.rs +111 -111
- data/vendor/rb-sys/build/main.rs +286 -286
- data/vendor/rb-sys/build/stable_api_config.rs +155 -155
- data/vendor/rb-sys/build/version.rs +50 -50
- data/vendor/rb-sys/readme.md +36 -36
- data/vendor/rb-sys/src/bindings.rs +21 -21
- data/vendor/rb-sys/src/hidden.rs +11 -11
- data/vendor/rb-sys/src/lib.rs +35 -35
- data/vendor/rb-sys/src/macros.rs +371 -371
- data/vendor/rb-sys/src/memory.rs +53 -53
- data/vendor/rb-sys/src/ruby_abi_version.rs +38 -38
- data/vendor/rb-sys/src/special_consts.rs +31 -31
- data/vendor/rb-sys/src/stable_api/compiled.c +179 -179
- data/vendor/rb-sys/src/stable_api/compiled.rs +257 -257
- data/vendor/rb-sys/src/stable_api/ruby_2_7.rs +324 -324
- data/vendor/rb-sys/src/stable_api/ruby_3_0.rs +332 -332
- data/vendor/rb-sys/src/stable_api/ruby_3_1.rs +325 -325
- data/vendor/rb-sys/src/stable_api/ruby_3_2.rs +323 -323
- data/vendor/rb-sys/src/stable_api/ruby_3_3.rs +339 -339
- data/vendor/rb-sys/src/stable_api/ruby_3_4.rs +339 -339
- data/vendor/rb-sys/src/stable_api.rs +260 -260
- data/vendor/rb-sys/src/symbol.rs +31 -31
- data/vendor/rb-sys/src/tracking_allocator.rs +330 -330
- data/vendor/rb-sys/src/utils.rs +89 -89
- data/vendor/rb-sys/src/value_type.rs +7 -7
- metadata +73 -4
- data/vendor/kreuzberg-ffi/kreuzberg-ffi-install.pc +0 -12
|
@@ -1,398 +1,398 @@
|
|
|
1
|
-
//! DOCX (Microsoft Word) text extraction using docx-lite.
|
|
2
|
-
//!
|
|
3
|
-
//! This module provides high-performance text extraction from DOCX files using the docx-lite
|
|
4
|
-
//! library, which uses streaming XML parsing for efficiency.
|
|
5
|
-
//!
|
|
6
|
-
//! Page break detection is best-effort, detecting only explicit page breaks (`<w:br w:type="page"/>`)
|
|
7
|
-
//! in the document XML. This does not account for automatic pagination based on content reflowing.
|
|
8
|
-
|
|
9
|
-
use crate::error::{KreuzbergError, Result};
|
|
10
|
-
use crate::types::PageBoundary;
|
|
11
|
-
use std::io::Cursor;
|
|
12
|
-
|
|
13
|
-
/// Extract text from DOCX bytes using docx-lite.
|
|
14
|
-
///
|
|
15
|
-
/// # Arguments
|
|
16
|
-
/// * `bytes` - The DOCX file contents as bytes
|
|
17
|
-
///
|
|
18
|
-
/// # Returns
|
|
19
|
-
/// * `Ok(String)` - The extracted text content
|
|
20
|
-
/// * `Err(KreuzbergError)` - If extraction fails
|
|
21
|
-
///
|
|
22
|
-
/// # Performance
|
|
23
|
-
/// docx-lite uses streaming XML parsing for minimal memory overhead and high throughput
|
|
24
|
-
/// (~160 MB/s average).
|
|
25
|
-
pub fn extract_text(bytes: &[u8]) -> Result<String> {
|
|
26
|
-
docx_lite::extract_text_from_bytes(bytes)
|
|
27
|
-
.map_err(|e| KreuzbergError::parsing(format!("DOCX text extraction failed: {}", e)))
|
|
28
|
-
}
|
|
29
|
-
|
|
30
|
-
/// Extract text and page boundaries from DOCX bytes.
|
|
31
|
-
///
|
|
32
|
-
/// Detects explicit page breaks (`<w:br w:type="page"/>`) in the document XML and maps them to
|
|
33
|
-
/// character offsets in the extracted text. This is a best-effort approach that only detects
|
|
34
|
-
/// explicit page breaks, not automatic pagination.
|
|
35
|
-
///
|
|
36
|
-
/// # Arguments
|
|
37
|
-
/// * `bytes` - The DOCX file contents as bytes
|
|
38
|
-
///
|
|
39
|
-
/// # Returns
|
|
40
|
-
/// * `Ok((String, Option<Vec<PageBoundary>>))` - Extracted text and optional page boundaries
|
|
41
|
-
/// * `Err(KreuzbergError)` - If extraction fails
|
|
42
|
-
///
|
|
43
|
-
/// # Limitations
|
|
44
|
-
/// - Only detects explicit page breaks, not reflowed content
|
|
45
|
-
/// - Page numbers are estimates, not guaranteed accurate
|
|
46
|
-
/// - Word's pagination may differ from detected breaks
|
|
47
|
-
/// - No page dimensions available (would require layout engine)
|
|
48
|
-
///
|
|
49
|
-
/// # Performance
|
|
50
|
-
/// Performs two passes: one with docx-lite for text extraction and one for page break detection.
|
|
51
|
-
pub fn extract_text_with_page_breaks(bytes: &[u8]) -> Result<(String, Option<Vec<PageBoundary>>)> {
|
|
52
|
-
let text = extract_text(bytes)?;
|
|
53
|
-
|
|
54
|
-
let page_breaks = detect_page_breaks(bytes)?;
|
|
55
|
-
|
|
56
|
-
if page_breaks.is_empty() {
|
|
57
|
-
return Ok((text, None));
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
let boundaries = map_page_breaks_to_boundaries(&text, page_breaks)?;
|
|
61
|
-
|
|
62
|
-
Ok((text, Some(boundaries)))
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
/// Detect explicit page break positions in document.xml and extract full text with page boundaries.
|
|
66
|
-
///
|
|
67
|
-
/// This is a convenience function for the extractor that combines text extraction with page
|
|
68
|
-
/// break detection. It returns the extracted text along with page boundaries.
|
|
69
|
-
///
|
|
70
|
-
/// # Arguments
|
|
71
|
-
/// * `bytes` - The DOCX file contents (ZIP archive)
|
|
72
|
-
///
|
|
73
|
-
/// # Returns
|
|
74
|
-
/// * `Ok(Option<Vec<PageBoundary>>)` - Optional page boundaries
|
|
75
|
-
/// * `Err(KreuzbergError)` - If extraction fails
|
|
76
|
-
///
|
|
77
|
-
/// # Limitations
|
|
78
|
-
/// - Only detects explicit page breaks, not reflowed content
|
|
79
|
-
/// - Page numbers are estimates based on detected breaks
|
|
80
|
-
pub fn detect_page_breaks_from_docx(bytes: &[u8]) -> Result<Option<Vec<PageBoundary>>> {
|
|
81
|
-
match extract_text_with_page_breaks(bytes) {
|
|
82
|
-
Ok((_, boundaries)) => Ok(boundaries),
|
|
83
|
-
Err(e) => {
|
|
84
|
-
tracing::debug!("Page break detection failed: {}", e);
|
|
85
|
-
Ok(None)
|
|
86
|
-
}
|
|
87
|
-
}
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
/// Detect explicit page break positions in document.xml.
|
|
91
|
-
///
|
|
92
|
-
/// Returns a vector of byte offsets within the document.xml content where page breaks occur.
|
|
93
|
-
/// These offsets will later be mapped to character positions in the extracted text.
|
|
94
|
-
///
|
|
95
|
-
/// # Arguments
|
|
96
|
-
/// * `bytes` - The DOCX file contents (ZIP archive)
|
|
97
|
-
///
|
|
98
|
-
/// # Returns
|
|
99
|
-
/// * `Ok(Vec<usize>)` - Vector of detected page break byte offsets (empty if none found)
|
|
100
|
-
/// * `Err(KreuzbergError)` - If ZIP/XML parsing fails
|
|
101
|
-
fn detect_page_breaks(bytes: &[u8]) -> Result<Vec<usize>> {
|
|
102
|
-
use zip::ZipArchive;
|
|
103
|
-
|
|
104
|
-
let cursor = Cursor::new(bytes);
|
|
105
|
-
let mut archive =
|
|
106
|
-
ZipArchive::new(cursor).map_err(|e| KreuzbergError::parsing(format!("Failed to open DOCX as ZIP: {}", e)))?;
|
|
107
|
-
|
|
108
|
-
let document_xml = match archive.by_name("word/document.xml") {
|
|
109
|
-
Ok(mut file) => {
|
|
110
|
-
let mut content = String::new();
|
|
111
|
-
std::io::Read::read_to_string(&mut file, &mut content)
|
|
112
|
-
.map_err(|e| KreuzbergError::parsing(format!("Failed to read document.xml: {}", e)))?;
|
|
113
|
-
content
|
|
114
|
-
}
|
|
115
|
-
Err(_) => return Ok(Vec::new()),
|
|
116
|
-
};
|
|
117
|
-
|
|
118
|
-
let mut breaks = Vec::new();
|
|
119
|
-
let search_pattern = r#"<w:br w:type="page"/>"#;
|
|
120
|
-
|
|
121
|
-
for (idx, _) in document_xml.match_indices(search_pattern) {
|
|
122
|
-
breaks.push(idx);
|
|
123
|
-
}
|
|
124
|
-
|
|
125
|
-
Ok(breaks)
|
|
126
|
-
}
|
|
127
|
-
|
|
128
|
-
/// Map detected page break positions to byte boundaries in extracted text.
|
|
129
|
-
///
|
|
130
|
-
/// Since we don't have a precise mapping between document.xml byte positions and final text
|
|
131
|
-
/// character positions, we use a heuristic: divide the text roughly equally between detected breaks.
|
|
132
|
-
/// This is best-effort and may not perfectly match Word's pagination.
|
|
133
|
-
///
|
|
134
|
-
/// # LIMITATION
|
|
135
|
-
/// This is a best-effort heuristic that distributes content evenly across detected page breaks.
|
|
136
|
-
/// It does not account for actual page layout, varying page sizes, or Word's pagination logic.
|
|
137
|
-
/// Use with caution. The function correctly handles multibyte UTF-8 characters (emoji, CJK, etc.)
|
|
138
|
-
/// by working with character indices rather than byte indices.
|
|
139
|
-
///
|
|
140
|
-
/// # Arguments
|
|
141
|
-
/// * `text` - The extracted document text
|
|
142
|
-
/// * `page_breaks` - Vector of detected page break positions (unused, but kept for extension)
|
|
143
|
-
///
|
|
144
|
-
/// # Returns
|
|
145
|
-
/// * `Ok(Vec<PageBoundary>)` - Byte boundaries for each page
|
|
146
|
-
fn map_page_breaks_to_boundaries(text: &str, page_breaks: Vec<usize>) -> Result<Vec<PageBoundary>> {
|
|
147
|
-
if page_breaks.is_empty() {
|
|
148
|
-
return Ok(Vec::new());
|
|
149
|
-
}
|
|
150
|
-
|
|
151
|
-
let page_count = page_breaks.len() + 1;
|
|
152
|
-
|
|
153
|
-
let char_count = text.chars().count();
|
|
154
|
-
let chars_per_page = char_count / page_count;
|
|
155
|
-
|
|
156
|
-
let mut boundaries = Vec::new();
|
|
157
|
-
let mut byte_offset = 0;
|
|
158
|
-
|
|
159
|
-
for page_num in 1..=page_count {
|
|
160
|
-
let start = byte_offset;
|
|
161
|
-
|
|
162
|
-
let end = if page_num == page_count {
|
|
163
|
-
text.len()
|
|
164
|
-
} else {
|
|
165
|
-
let remaining = &text[byte_offset..];
|
|
166
|
-
let chars_to_skip = chars_per_page;
|
|
167
|
-
byte_offset
|
|
168
|
-
+ remaining
|
|
169
|
-
.chars()
|
|
170
|
-
.take(chars_to_skip)
|
|
171
|
-
.map(|c| c.len_utf8())
|
|
172
|
-
.sum::<usize>()
|
|
173
|
-
};
|
|
174
|
-
|
|
175
|
-
byte_offset = end;
|
|
176
|
-
|
|
177
|
-
boundaries.push(PageBoundary {
|
|
178
|
-
byte_start: start,
|
|
179
|
-
byte_end: end,
|
|
180
|
-
page_number: page_num,
|
|
181
|
-
});
|
|
182
|
-
}
|
|
183
|
-
|
|
184
|
-
Ok(boundaries)
|
|
185
|
-
}
|
|
186
|
-
|
|
187
|
-
#[cfg(test)]
|
|
188
|
-
mod tests {
|
|
189
|
-
use super::*;
|
|
190
|
-
|
|
191
|
-
#[test]
|
|
192
|
-
fn test_extract_text_empty() {
|
|
193
|
-
let result = extract_text(b"");
|
|
194
|
-
assert!(result.is_err());
|
|
195
|
-
}
|
|
196
|
-
|
|
197
|
-
#[test]
|
|
198
|
-
fn test_extract_text_invalid() {
|
|
199
|
-
let result = extract_text(b"not a docx file");
|
|
200
|
-
assert!(result.is_err());
|
|
201
|
-
}
|
|
202
|
-
|
|
203
|
-
#[test]
|
|
204
|
-
fn test_map_page_breaks_to_boundaries_empty() {
|
|
205
|
-
let result = map_page_breaks_to_boundaries("test text", Vec::new()).unwrap();
|
|
206
|
-
assert!(result.is_empty());
|
|
207
|
-
}
|
|
208
|
-
|
|
209
|
-
#[test]
|
|
210
|
-
fn test_map_page_breaks_to_boundaries_single_break() {
|
|
211
|
-
let text = "Page 1 content here with some text.Page 2 content here with more text.";
|
|
212
|
-
let breaks = vec![0];
|
|
213
|
-
|
|
214
|
-
let result = map_page_breaks_to_boundaries(text, breaks).unwrap();
|
|
215
|
-
|
|
216
|
-
assert_eq!(result.len(), 2);
|
|
217
|
-
assert_eq!(result[0].page_number, 1);
|
|
218
|
-
assert_eq!(result[0].byte_start, 0);
|
|
219
|
-
assert!(result[0].byte_end > 0);
|
|
220
|
-
assert!(result[0].byte_end < text.len());
|
|
221
|
-
|
|
222
|
-
assert_eq!(result[1].page_number, 2);
|
|
223
|
-
assert_eq!(result[1].byte_start, result[0].byte_end);
|
|
224
|
-
assert_eq!(result[1].byte_end, text.len());
|
|
225
|
-
}
|
|
226
|
-
|
|
227
|
-
#[test]
|
|
228
|
-
fn test_map_page_breaks_to_boundaries_multiple_breaks() {
|
|
229
|
-
let text = "A".repeat(300);
|
|
230
|
-
let breaks = vec![0, 0, 0];
|
|
231
|
-
|
|
232
|
-
let result = map_page_breaks_to_boundaries(&text, breaks).unwrap();
|
|
233
|
-
|
|
234
|
-
assert_eq!(result.len(), 4);
|
|
235
|
-
assert_eq!(result[0].page_number, 1);
|
|
236
|
-
assert_eq!(result[3].page_number, 4);
|
|
237
|
-
assert_eq!(result[3].byte_end, text.len());
|
|
238
|
-
|
|
239
|
-
for i in 0..result.len() - 1 {
|
|
240
|
-
assert_eq!(result[i].byte_end, result[i + 1].byte_start);
|
|
241
|
-
}
|
|
242
|
-
}
|
|
243
|
-
|
|
244
|
-
#[test]
|
|
245
|
-
fn test_map_page_breaks_to_boundaries_utf8_boundary() {
|
|
246
|
-
let text = "Hello world! こんにちは世界! More text here.";
|
|
247
|
-
let breaks = vec![0];
|
|
248
|
-
|
|
249
|
-
let result = map_page_breaks_to_boundaries(text, breaks).unwrap();
|
|
250
|
-
|
|
251
|
-
assert_eq!(result.len(), 2);
|
|
252
|
-
assert!(text.is_char_boundary(result[0].byte_start));
|
|
253
|
-
assert!(text.is_char_boundary(result[0].byte_end));
|
|
254
|
-
assert!(text.is_char_boundary(result[1].byte_start));
|
|
255
|
-
assert!(text.is_char_boundary(result[1].byte_end));
|
|
256
|
-
}
|
|
257
|
-
|
|
258
|
-
#[test]
|
|
259
|
-
fn test_docx_page_breaks_with_emoji() {
|
|
260
|
-
let text = "Hello 😀 World 🌍 Foo 🎉 Bar";
|
|
261
|
-
let breaks = vec![0, 0];
|
|
262
|
-
|
|
263
|
-
let result = map_page_breaks_to_boundaries(text, breaks).unwrap();
|
|
264
|
-
|
|
265
|
-
assert_eq!(result.len(), 3);
|
|
266
|
-
assert_eq!(result[0].page_number, 1);
|
|
267
|
-
assert_eq!(result[1].page_number, 2);
|
|
268
|
-
assert_eq!(result[2].page_number, 3);
|
|
269
|
-
|
|
270
|
-
for boundary in &result {
|
|
271
|
-
assert!(
|
|
272
|
-
text.is_char_boundary(boundary.byte_start),
|
|
273
|
-
"byte_start {} is not a valid UTF-8 boundary",
|
|
274
|
-
boundary.byte_start
|
|
275
|
-
);
|
|
276
|
-
assert!(
|
|
277
|
-
text.is_char_boundary(boundary.byte_end),
|
|
278
|
-
"byte_end {} is not a valid UTF-8 boundary",
|
|
279
|
-
boundary.byte_end
|
|
280
|
-
);
|
|
281
|
-
}
|
|
282
|
-
|
|
283
|
-
assert_eq!(result[0].byte_start, 0);
|
|
284
|
-
assert_eq!(result[0].byte_end, result[1].byte_start);
|
|
285
|
-
assert_eq!(result[1].byte_end, result[2].byte_start);
|
|
286
|
-
assert_eq!(result[2].byte_end, text.len());
|
|
287
|
-
|
|
288
|
-
let reconstructed = format!(
|
|
289
|
-
"{}{}{}",
|
|
290
|
-
&text[result[0].byte_start..result[0].byte_end],
|
|
291
|
-
&text[result[1].byte_start..result[1].byte_end],
|
|
292
|
-
&text[result[2].byte_start..result[2].byte_end]
|
|
293
|
-
);
|
|
294
|
-
assert_eq!(reconstructed, text);
|
|
295
|
-
}
|
|
296
|
-
|
|
297
|
-
#[test]
|
|
298
|
-
fn test_docx_page_breaks_with_cjk() {
|
|
299
|
-
let text = "你好世界你好世界你好世界你好世界";
|
|
300
|
-
let breaks = vec![0];
|
|
301
|
-
|
|
302
|
-
let result = map_page_breaks_to_boundaries(text, breaks).unwrap();
|
|
303
|
-
|
|
304
|
-
assert_eq!(result.len(), 2);
|
|
305
|
-
assert_eq!(result[0].page_number, 1);
|
|
306
|
-
assert_eq!(result[1].page_number, 2);
|
|
307
|
-
|
|
308
|
-
for boundary in &result {
|
|
309
|
-
assert!(
|
|
310
|
-
text.is_char_boundary(boundary.byte_start),
|
|
311
|
-
"byte_start {} is not a valid UTF-8 boundary",
|
|
312
|
-
boundary.byte_start
|
|
313
|
-
);
|
|
314
|
-
assert!(
|
|
315
|
-
text.is_char_boundary(boundary.byte_end),
|
|
316
|
-
"byte_end {} is not a valid UTF-8 boundary",
|
|
317
|
-
boundary.byte_end
|
|
318
|
-
);
|
|
319
|
-
}
|
|
320
|
-
|
|
321
|
-
assert_eq!(result[0].byte_start, 0);
|
|
322
|
-
assert_eq!(result[0].byte_end, result[1].byte_start);
|
|
323
|
-
assert_eq!(result[1].byte_end, text.len());
|
|
324
|
-
|
|
325
|
-
let reconstructed = format!(
|
|
326
|
-
"{}{}",
|
|
327
|
-
&text[result[0].byte_start..result[0].byte_end],
|
|
328
|
-
&text[result[1].byte_start..result[1].byte_end]
|
|
329
|
-
);
|
|
330
|
-
assert_eq!(reconstructed, text);
|
|
331
|
-
}
|
|
332
|
-
|
|
333
|
-
#[test]
|
|
334
|
-
fn test_docx_page_breaks_multibyte_utf8() {
|
|
335
|
-
let text = "ASCII 😀 中文 hello 🎉 world 日本語";
|
|
336
|
-
let breaks = vec![0, 0];
|
|
337
|
-
|
|
338
|
-
let result = map_page_breaks_to_boundaries(text, breaks).unwrap();
|
|
339
|
-
|
|
340
|
-
assert_eq!(result.len(), 3);
|
|
341
|
-
|
|
342
|
-
for boundary in &result {
|
|
343
|
-
assert!(
|
|
344
|
-
text.is_char_boundary(boundary.byte_start),
|
|
345
|
-
"byte_start {} is not a valid UTF-8 boundary",
|
|
346
|
-
boundary.byte_start
|
|
347
|
-
);
|
|
348
|
-
assert!(
|
|
349
|
-
text.is_char_boundary(boundary.byte_end),
|
|
350
|
-
"byte_end {} is not a valid UTF-8 boundary",
|
|
351
|
-
boundary.byte_end
|
|
352
|
-
);
|
|
353
|
-
}
|
|
354
|
-
|
|
355
|
-
assert_eq!(result[0].byte_start, 0);
|
|
356
|
-
for i in 0..result.len() - 1 {
|
|
357
|
-
assert_eq!(
|
|
358
|
-
result[i].byte_end,
|
|
359
|
-
result[i + 1].byte_start,
|
|
360
|
-
"Gap or overlap between page {} and {}",
|
|
361
|
-
i + 1,
|
|
362
|
-
i + 2
|
|
363
|
-
);
|
|
364
|
-
}
|
|
365
|
-
assert_eq!(
|
|
366
|
-
result[result.len() - 1].byte_end,
|
|
367
|
-
text.len(),
|
|
368
|
-
"Last page does not end at text boundary"
|
|
369
|
-
);
|
|
370
|
-
|
|
371
|
-
let mut reconstructed = String::new();
|
|
372
|
-
for boundary in &result {
|
|
373
|
-
reconstructed.push_str(&text[boundary.byte_start..boundary.byte_end]);
|
|
374
|
-
}
|
|
375
|
-
assert_eq!(reconstructed, text);
|
|
376
|
-
}
|
|
377
|
-
|
|
378
|
-
#[test]
|
|
379
|
-
fn test_detect_page_breaks_no_feature() {
|
|
380
|
-
let result = detect_page_breaks(b"invalid");
|
|
381
|
-
assert!(result.is_err());
|
|
382
|
-
}
|
|
383
|
-
|
|
384
|
-
#[test]
|
|
385
|
-
fn test_extract_text_with_page_breaks_no_breaks() {
|
|
386
|
-
let docx_path =
|
|
387
|
-
std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join("../../test_documents/documents/lorem_ipsum.docx");
|
|
388
|
-
if let Ok(bytes) = std::fs::read(docx_path) {
|
|
389
|
-
let result = extract_text_with_page_breaks(&bytes);
|
|
390
|
-
if let Ok((text, boundaries)) = result {
|
|
391
|
-
assert!(!text.is_empty());
|
|
392
|
-
if let Some(b) = boundaries {
|
|
393
|
-
assert!(!b.is_empty());
|
|
394
|
-
}
|
|
395
|
-
}
|
|
396
|
-
}
|
|
397
|
-
}
|
|
398
|
-
}
|
|
1
|
+
//! DOCX (Microsoft Word) text extraction using docx-lite.
|
|
2
|
+
//!
|
|
3
|
+
//! This module provides high-performance text extraction from DOCX files using the docx-lite
|
|
4
|
+
//! library, which uses streaming XML parsing for efficiency.
|
|
5
|
+
//!
|
|
6
|
+
//! Page break detection is best-effort, detecting only explicit page breaks (`<w:br w:type="page"/>`)
|
|
7
|
+
//! in the document XML. This does not account for automatic pagination based on content reflowing.
|
|
8
|
+
|
|
9
|
+
use crate::error::{KreuzbergError, Result};
|
|
10
|
+
use crate::types::PageBoundary;
|
|
11
|
+
use std::io::Cursor;
|
|
12
|
+
|
|
13
|
+
/// Extract text from DOCX bytes using docx-lite.
|
|
14
|
+
///
|
|
15
|
+
/// # Arguments
|
|
16
|
+
/// * `bytes` - The DOCX file contents as bytes
|
|
17
|
+
///
|
|
18
|
+
/// # Returns
|
|
19
|
+
/// * `Ok(String)` - The extracted text content
|
|
20
|
+
/// * `Err(KreuzbergError)` - If extraction fails
|
|
21
|
+
///
|
|
22
|
+
/// # Performance
|
|
23
|
+
/// docx-lite uses streaming XML parsing for minimal memory overhead and high throughput
|
|
24
|
+
/// (~160 MB/s average).
|
|
25
|
+
pub fn extract_text(bytes: &[u8]) -> Result<String> {
|
|
26
|
+
docx_lite::extract_text_from_bytes(bytes)
|
|
27
|
+
.map_err(|e| KreuzbergError::parsing(format!("DOCX text extraction failed: {}", e)))
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
/// Extract text and page boundaries from DOCX bytes.
|
|
31
|
+
///
|
|
32
|
+
/// Detects explicit page breaks (`<w:br w:type="page"/>`) in the document XML and maps them to
|
|
33
|
+
/// character offsets in the extracted text. This is a best-effort approach that only detects
|
|
34
|
+
/// explicit page breaks, not automatic pagination.
|
|
35
|
+
///
|
|
36
|
+
/// # Arguments
|
|
37
|
+
/// * `bytes` - The DOCX file contents as bytes
|
|
38
|
+
///
|
|
39
|
+
/// # Returns
|
|
40
|
+
/// * `Ok((String, Option<Vec<PageBoundary>>))` - Extracted text and optional page boundaries
|
|
41
|
+
/// * `Err(KreuzbergError)` - If extraction fails
|
|
42
|
+
///
|
|
43
|
+
/// # Limitations
|
|
44
|
+
/// - Only detects explicit page breaks, not reflowed content
|
|
45
|
+
/// - Page numbers are estimates, not guaranteed accurate
|
|
46
|
+
/// - Word's pagination may differ from detected breaks
|
|
47
|
+
/// - No page dimensions available (would require layout engine)
|
|
48
|
+
///
|
|
49
|
+
/// # Performance
|
|
50
|
+
/// Performs two passes: one with docx-lite for text extraction and one for page break detection.
|
|
51
|
+
pub fn extract_text_with_page_breaks(bytes: &[u8]) -> Result<(String, Option<Vec<PageBoundary>>)> {
|
|
52
|
+
let text = extract_text(bytes)?;
|
|
53
|
+
|
|
54
|
+
let page_breaks = detect_page_breaks(bytes)?;
|
|
55
|
+
|
|
56
|
+
if page_breaks.is_empty() {
|
|
57
|
+
return Ok((text, None));
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
let boundaries = map_page_breaks_to_boundaries(&text, page_breaks)?;
|
|
61
|
+
|
|
62
|
+
Ok((text, Some(boundaries)))
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
/// Detect explicit page break positions in document.xml and extract full text with page boundaries.
|
|
66
|
+
///
|
|
67
|
+
/// This is a convenience function for the extractor that combines text extraction with page
|
|
68
|
+
/// break detection. It returns the extracted text along with page boundaries.
|
|
69
|
+
///
|
|
70
|
+
/// # Arguments
|
|
71
|
+
/// * `bytes` - The DOCX file contents (ZIP archive)
|
|
72
|
+
///
|
|
73
|
+
/// # Returns
|
|
74
|
+
/// * `Ok(Option<Vec<PageBoundary>>)` - Optional page boundaries
|
|
75
|
+
/// * `Err(KreuzbergError)` - If extraction fails
|
|
76
|
+
///
|
|
77
|
+
/// # Limitations
|
|
78
|
+
/// - Only detects explicit page breaks, not reflowed content
|
|
79
|
+
/// - Page numbers are estimates based on detected breaks
|
|
80
|
+
pub fn detect_page_breaks_from_docx(bytes: &[u8]) -> Result<Option<Vec<PageBoundary>>> {
|
|
81
|
+
match extract_text_with_page_breaks(bytes) {
|
|
82
|
+
Ok((_, boundaries)) => Ok(boundaries),
|
|
83
|
+
Err(e) => {
|
|
84
|
+
tracing::debug!("Page break detection failed: {}", e);
|
|
85
|
+
Ok(None)
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
/// Detect explicit page break positions in document.xml.
|
|
91
|
+
///
|
|
92
|
+
/// Returns a vector of byte offsets within the document.xml content where page breaks occur.
|
|
93
|
+
/// These offsets will later be mapped to character positions in the extracted text.
|
|
94
|
+
///
|
|
95
|
+
/// # Arguments
|
|
96
|
+
/// * `bytes` - The DOCX file contents (ZIP archive)
|
|
97
|
+
///
|
|
98
|
+
/// # Returns
|
|
99
|
+
/// * `Ok(Vec<usize>)` - Vector of detected page break byte offsets (empty if none found)
|
|
100
|
+
/// * `Err(KreuzbergError)` - If ZIP/XML parsing fails
|
|
101
|
+
fn detect_page_breaks(bytes: &[u8]) -> Result<Vec<usize>> {
|
|
102
|
+
use zip::ZipArchive;
|
|
103
|
+
|
|
104
|
+
let cursor = Cursor::new(bytes);
|
|
105
|
+
let mut archive =
|
|
106
|
+
ZipArchive::new(cursor).map_err(|e| KreuzbergError::parsing(format!("Failed to open DOCX as ZIP: {}", e)))?;
|
|
107
|
+
|
|
108
|
+
let document_xml = match archive.by_name("word/document.xml") {
|
|
109
|
+
Ok(mut file) => {
|
|
110
|
+
let mut content = String::new();
|
|
111
|
+
std::io::Read::read_to_string(&mut file, &mut content)
|
|
112
|
+
.map_err(|e| KreuzbergError::parsing(format!("Failed to read document.xml: {}", e)))?;
|
|
113
|
+
content
|
|
114
|
+
}
|
|
115
|
+
Err(_) => return Ok(Vec::new()),
|
|
116
|
+
};
|
|
117
|
+
|
|
118
|
+
let mut breaks = Vec::new();
|
|
119
|
+
let search_pattern = r#"<w:br w:type="page"/>"#;
|
|
120
|
+
|
|
121
|
+
for (idx, _) in document_xml.match_indices(search_pattern) {
|
|
122
|
+
breaks.push(idx);
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
Ok(breaks)
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
/// Map detected page break positions to byte boundaries in extracted text.
|
|
129
|
+
///
|
|
130
|
+
/// Since we don't have a precise mapping between document.xml byte positions and final text
|
|
131
|
+
/// character positions, we use a heuristic: divide the text roughly equally between detected breaks.
|
|
132
|
+
/// This is best-effort and may not perfectly match Word's pagination.
|
|
133
|
+
///
|
|
134
|
+
/// # LIMITATION
|
|
135
|
+
/// This is a best-effort heuristic that distributes content evenly across detected page breaks.
|
|
136
|
+
/// It does not account for actual page layout, varying page sizes, or Word's pagination logic.
|
|
137
|
+
/// Use with caution. The function correctly handles multibyte UTF-8 characters (emoji, CJK, etc.)
|
|
138
|
+
/// by working with character indices rather than byte indices.
|
|
139
|
+
///
|
|
140
|
+
/// # Arguments
|
|
141
|
+
/// * `text` - The extracted document text
|
|
142
|
+
/// * `page_breaks` - Vector of detected page break positions (unused, but kept for extension)
|
|
143
|
+
///
|
|
144
|
+
/// # Returns
|
|
145
|
+
/// * `Ok(Vec<PageBoundary>)` - Byte boundaries for each page
|
|
146
|
+
fn map_page_breaks_to_boundaries(text: &str, page_breaks: Vec<usize>) -> Result<Vec<PageBoundary>> {
|
|
147
|
+
if page_breaks.is_empty() {
|
|
148
|
+
return Ok(Vec::new());
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
let page_count = page_breaks.len() + 1;
|
|
152
|
+
|
|
153
|
+
let char_count = text.chars().count();
|
|
154
|
+
let chars_per_page = char_count / page_count;
|
|
155
|
+
|
|
156
|
+
let mut boundaries = Vec::new();
|
|
157
|
+
let mut byte_offset = 0;
|
|
158
|
+
|
|
159
|
+
for page_num in 1..=page_count {
|
|
160
|
+
let start = byte_offset;
|
|
161
|
+
|
|
162
|
+
let end = if page_num == page_count {
|
|
163
|
+
text.len()
|
|
164
|
+
} else {
|
|
165
|
+
let remaining = &text[byte_offset..];
|
|
166
|
+
let chars_to_skip = chars_per_page;
|
|
167
|
+
byte_offset
|
|
168
|
+
+ remaining
|
|
169
|
+
.chars()
|
|
170
|
+
.take(chars_to_skip)
|
|
171
|
+
.map(|c| c.len_utf8())
|
|
172
|
+
.sum::<usize>()
|
|
173
|
+
};
|
|
174
|
+
|
|
175
|
+
byte_offset = end;
|
|
176
|
+
|
|
177
|
+
boundaries.push(PageBoundary {
|
|
178
|
+
byte_start: start,
|
|
179
|
+
byte_end: end,
|
|
180
|
+
page_number: page_num,
|
|
181
|
+
});
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
Ok(boundaries)
|
|
185
|
+
}
|
|
186
|
+
|
|
187
|
+
#[cfg(test)]
|
|
188
|
+
mod tests {
|
|
189
|
+
use super::*;
|
|
190
|
+
|
|
191
|
+
#[test]
|
|
192
|
+
fn test_extract_text_empty() {
|
|
193
|
+
let result = extract_text(b"");
|
|
194
|
+
assert!(result.is_err());
|
|
195
|
+
}
|
|
196
|
+
|
|
197
|
+
#[test]
|
|
198
|
+
fn test_extract_text_invalid() {
|
|
199
|
+
let result = extract_text(b"not a docx file");
|
|
200
|
+
assert!(result.is_err());
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
#[test]
|
|
204
|
+
fn test_map_page_breaks_to_boundaries_empty() {
|
|
205
|
+
let result = map_page_breaks_to_boundaries("test text", Vec::new()).unwrap();
|
|
206
|
+
assert!(result.is_empty());
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
#[test]
|
|
210
|
+
fn test_map_page_breaks_to_boundaries_single_break() {
|
|
211
|
+
let text = "Page 1 content here with some text.Page 2 content here with more text.";
|
|
212
|
+
let breaks = vec![0];
|
|
213
|
+
|
|
214
|
+
let result = map_page_breaks_to_boundaries(text, breaks).unwrap();
|
|
215
|
+
|
|
216
|
+
assert_eq!(result.len(), 2);
|
|
217
|
+
assert_eq!(result[0].page_number, 1);
|
|
218
|
+
assert_eq!(result[0].byte_start, 0);
|
|
219
|
+
assert!(result[0].byte_end > 0);
|
|
220
|
+
assert!(result[0].byte_end < text.len());
|
|
221
|
+
|
|
222
|
+
assert_eq!(result[1].page_number, 2);
|
|
223
|
+
assert_eq!(result[1].byte_start, result[0].byte_end);
|
|
224
|
+
assert_eq!(result[1].byte_end, text.len());
|
|
225
|
+
}
|
|
226
|
+
|
|
227
|
+
#[test]
|
|
228
|
+
fn test_map_page_breaks_to_boundaries_multiple_breaks() {
|
|
229
|
+
let text = "A".repeat(300);
|
|
230
|
+
let breaks = vec![0, 0, 0];
|
|
231
|
+
|
|
232
|
+
let result = map_page_breaks_to_boundaries(&text, breaks).unwrap();
|
|
233
|
+
|
|
234
|
+
assert_eq!(result.len(), 4);
|
|
235
|
+
assert_eq!(result[0].page_number, 1);
|
|
236
|
+
assert_eq!(result[3].page_number, 4);
|
|
237
|
+
assert_eq!(result[3].byte_end, text.len());
|
|
238
|
+
|
|
239
|
+
for i in 0..result.len() - 1 {
|
|
240
|
+
assert_eq!(result[i].byte_end, result[i + 1].byte_start);
|
|
241
|
+
}
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
#[test]
|
|
245
|
+
fn test_map_page_breaks_to_boundaries_utf8_boundary() {
|
|
246
|
+
let text = "Hello world! こんにちは世界! More text here.";
|
|
247
|
+
let breaks = vec![0];
|
|
248
|
+
|
|
249
|
+
let result = map_page_breaks_to_boundaries(text, breaks).unwrap();
|
|
250
|
+
|
|
251
|
+
assert_eq!(result.len(), 2);
|
|
252
|
+
assert!(text.is_char_boundary(result[0].byte_start));
|
|
253
|
+
assert!(text.is_char_boundary(result[0].byte_end));
|
|
254
|
+
assert!(text.is_char_boundary(result[1].byte_start));
|
|
255
|
+
assert!(text.is_char_boundary(result[1].byte_end));
|
|
256
|
+
}
|
|
257
|
+
|
|
258
|
+
#[test]
|
|
259
|
+
fn test_docx_page_breaks_with_emoji() {
|
|
260
|
+
let text = "Hello 😀 World 🌍 Foo 🎉 Bar";
|
|
261
|
+
let breaks = vec![0, 0];
|
|
262
|
+
|
|
263
|
+
let result = map_page_breaks_to_boundaries(text, breaks).unwrap();
|
|
264
|
+
|
|
265
|
+
assert_eq!(result.len(), 3);
|
|
266
|
+
assert_eq!(result[0].page_number, 1);
|
|
267
|
+
assert_eq!(result[1].page_number, 2);
|
|
268
|
+
assert_eq!(result[2].page_number, 3);
|
|
269
|
+
|
|
270
|
+
for boundary in &result {
|
|
271
|
+
assert!(
|
|
272
|
+
text.is_char_boundary(boundary.byte_start),
|
|
273
|
+
"byte_start {} is not a valid UTF-8 boundary",
|
|
274
|
+
boundary.byte_start
|
|
275
|
+
);
|
|
276
|
+
assert!(
|
|
277
|
+
text.is_char_boundary(boundary.byte_end),
|
|
278
|
+
"byte_end {} is not a valid UTF-8 boundary",
|
|
279
|
+
boundary.byte_end
|
|
280
|
+
);
|
|
281
|
+
}
|
|
282
|
+
|
|
283
|
+
assert_eq!(result[0].byte_start, 0);
|
|
284
|
+
assert_eq!(result[0].byte_end, result[1].byte_start);
|
|
285
|
+
assert_eq!(result[1].byte_end, result[2].byte_start);
|
|
286
|
+
assert_eq!(result[2].byte_end, text.len());
|
|
287
|
+
|
|
288
|
+
let reconstructed = format!(
|
|
289
|
+
"{}{}{}",
|
|
290
|
+
&text[result[0].byte_start..result[0].byte_end],
|
|
291
|
+
&text[result[1].byte_start..result[1].byte_end],
|
|
292
|
+
&text[result[2].byte_start..result[2].byte_end]
|
|
293
|
+
);
|
|
294
|
+
assert_eq!(reconstructed, text);
|
|
295
|
+
}
|
|
296
|
+
|
|
297
|
+
#[test]
|
|
298
|
+
fn test_docx_page_breaks_with_cjk() {
|
|
299
|
+
let text = "你好世界你好世界你好世界你好世界";
|
|
300
|
+
let breaks = vec![0];
|
|
301
|
+
|
|
302
|
+
let result = map_page_breaks_to_boundaries(text, breaks).unwrap();
|
|
303
|
+
|
|
304
|
+
assert_eq!(result.len(), 2);
|
|
305
|
+
assert_eq!(result[0].page_number, 1);
|
|
306
|
+
assert_eq!(result[1].page_number, 2);
|
|
307
|
+
|
|
308
|
+
for boundary in &result {
|
|
309
|
+
assert!(
|
|
310
|
+
text.is_char_boundary(boundary.byte_start),
|
|
311
|
+
"byte_start {} is not a valid UTF-8 boundary",
|
|
312
|
+
boundary.byte_start
|
|
313
|
+
);
|
|
314
|
+
assert!(
|
|
315
|
+
text.is_char_boundary(boundary.byte_end),
|
|
316
|
+
"byte_end {} is not a valid UTF-8 boundary",
|
|
317
|
+
boundary.byte_end
|
|
318
|
+
);
|
|
319
|
+
}
|
|
320
|
+
|
|
321
|
+
assert_eq!(result[0].byte_start, 0);
|
|
322
|
+
assert_eq!(result[0].byte_end, result[1].byte_start);
|
|
323
|
+
assert_eq!(result[1].byte_end, text.len());
|
|
324
|
+
|
|
325
|
+
let reconstructed = format!(
|
|
326
|
+
"{}{}",
|
|
327
|
+
&text[result[0].byte_start..result[0].byte_end],
|
|
328
|
+
&text[result[1].byte_start..result[1].byte_end]
|
|
329
|
+
);
|
|
330
|
+
assert_eq!(reconstructed, text);
|
|
331
|
+
}
|
|
332
|
+
|
|
333
|
+
#[test]
|
|
334
|
+
fn test_docx_page_breaks_multibyte_utf8() {
|
|
335
|
+
let text = "ASCII 😀 中文 hello 🎉 world 日本語";
|
|
336
|
+
let breaks = vec![0, 0];
|
|
337
|
+
|
|
338
|
+
let result = map_page_breaks_to_boundaries(text, breaks).unwrap();
|
|
339
|
+
|
|
340
|
+
assert_eq!(result.len(), 3);
|
|
341
|
+
|
|
342
|
+
for boundary in &result {
|
|
343
|
+
assert!(
|
|
344
|
+
text.is_char_boundary(boundary.byte_start),
|
|
345
|
+
"byte_start {} is not a valid UTF-8 boundary",
|
|
346
|
+
boundary.byte_start
|
|
347
|
+
);
|
|
348
|
+
assert!(
|
|
349
|
+
text.is_char_boundary(boundary.byte_end),
|
|
350
|
+
"byte_end {} is not a valid UTF-8 boundary",
|
|
351
|
+
boundary.byte_end
|
|
352
|
+
);
|
|
353
|
+
}
|
|
354
|
+
|
|
355
|
+
assert_eq!(result[0].byte_start, 0);
|
|
356
|
+
for i in 0..result.len() - 1 {
|
|
357
|
+
assert_eq!(
|
|
358
|
+
result[i].byte_end,
|
|
359
|
+
result[i + 1].byte_start,
|
|
360
|
+
"Gap or overlap between page {} and {}",
|
|
361
|
+
i + 1,
|
|
362
|
+
i + 2
|
|
363
|
+
);
|
|
364
|
+
}
|
|
365
|
+
assert_eq!(
|
|
366
|
+
result[result.len() - 1].byte_end,
|
|
367
|
+
text.len(),
|
|
368
|
+
"Last page does not end at text boundary"
|
|
369
|
+
);
|
|
370
|
+
|
|
371
|
+
let mut reconstructed = String::new();
|
|
372
|
+
for boundary in &result {
|
|
373
|
+
reconstructed.push_str(&text[boundary.byte_start..boundary.byte_end]);
|
|
374
|
+
}
|
|
375
|
+
assert_eq!(reconstructed, text);
|
|
376
|
+
}
|
|
377
|
+
|
|
378
|
+
#[test]
|
|
379
|
+
fn test_detect_page_breaks_no_feature() {
|
|
380
|
+
let result = detect_page_breaks(b"invalid");
|
|
381
|
+
assert!(result.is_err());
|
|
382
|
+
}
|
|
383
|
+
|
|
384
|
+
#[test]
|
|
385
|
+
fn test_extract_text_with_page_breaks_no_breaks() {
|
|
386
|
+
let docx_path =
|
|
387
|
+
std::path::Path::new(env!("CARGO_MANIFEST_DIR")).join("../../test_documents/documents/lorem_ipsum.docx");
|
|
388
|
+
if let Ok(bytes) = std::fs::read(docx_path) {
|
|
389
|
+
let result = extract_text_with_page_breaks(&bytes);
|
|
390
|
+
if let Ok((text, boundaries)) = result {
|
|
391
|
+
assert!(!text.is_empty());
|
|
392
|
+
if let Some(b) = boundaries {
|
|
393
|
+
assert!(!b.is_empty());
|
|
394
|
+
}
|
|
395
|
+
}
|
|
396
|
+
}
|
|
397
|
+
}
|
|
398
|
+
}
|