html-to-markdown 2.16.0 → 2.18.0

data/bin/benchmark.rb

@@ -23,7 +23,8 @@ end
 options = {
   iterations: 50,
   format: 'html',
-  scenario: 'convert-default'
+  scenario: 'convert-default',
+  visitor: nil
 }
 
 OptionParser.new do |parser|
@@ -44,6 +45,10 @@ OptionParser.new do |parser|
   parser.on('--format FORMAT', 'Fixture format (html or hocr)') do |format|
     options[:format] = format.downcase
   end
+
+  parser.on('--visitor VISITOR', 'Visitor type (noop, simple, custom, complex)') do |visitor|
+    options[:visitor] = visitor if %w[noop simple custom complex].include?(visitor)
+  end
 end.parse!
 
 fixture = options.fetch(:file) do
@@ -74,6 +79,70 @@ unless supported_scenarios.include?(options[:scenario])
   exit 1
 end
 
+# Visitor factory functions
+def create_noop_visitor
+  {
+    visit_text: proc { |_ctx, _text| 'continue' },
+    visit_heading: proc { |_ctx, _level, _text, _id| 'continue' },
+    visit_paragraph: proc { |_ctx, _text| 'continue' },
+    visit_link: proc { |_ctx, _href, _text, _title| 'continue' },
+    visit_image: proc { |_ctx, _src, _alt, _title| 'continue' },
+    visit_strong: proc { |_ctx, _text| 'continue' },
+    visit_em: proc { |_ctx, _text| 'continue' },
+    visit_code: proc { |_ctx, _text| 'continue' },
+    visit_br: proc { |_ctx| 'continue' }
+  }
+end
+
+def create_simple_visitor
+  {
+    text_count: 0,
+    link_count: 0,
+    image_count: 0,
+    visit_text: proc { |_ctx, _text| 'continue' },
+    visit_heading: proc { |_ctx, _level, _text, _id| 'continue' },
+    visit_paragraph: proc { |_ctx, _text| 'continue' },
+    visit_link: proc { |_ctx, _href, _text, _title| 'continue' },
+    visit_image: proc { |_ctx, _src, _alt, _title| 'continue' },
+    visit_strong: proc { |_ctx, _text| 'continue' },
+    visit_em: proc { |_ctx, _text| 'continue' },
+    visit_code: proc { |_ctx, _text| 'continue' },
+    visit_br: proc { |_ctx| 'continue' }
+  }
+end
+
+def create_custom_visitor
+  {
+    visit_text: proc { |_ctx, _text| 'continue' },
+    visit_heading: proc { |_ctx, _level, _text, _id| 'continue' },
+    visit_paragraph: proc { |_ctx, _text| 'continue' },
+    visit_link: proc { |_ctx, href, text, _title| ['custom', "LINK[#{text}](#{href})"] },
+    visit_image: proc { |_ctx, src, alt, _title| ['custom', "![#{alt}](#{src})"] },
+    visit_strong: proc { |_ctx, _text| 'continue' },
+    visit_em: proc { |_ctx, _text| 'continue' },
+    visit_code: proc { |_ctx, _text| 'continue' },
+    visit_br: proc { |_ctx| 'continue' }
+  }
+end
+
+def create_complex_visitor
+  {
+    texts: 0,
+    links: 0,
+    images: 0,
+    headings: 0,
+    visit_text: proc { |_ctx, _text| 'continue' },
+    visit_heading: proc { |_ctx, _level, _text, _id| 'continue' },
+    visit_paragraph: proc { |_ctx, _text| 'continue' },
+    visit_link: proc { |_ctx, href, text, _title| ['custom', "[#{text}](#{href})"] },
+    visit_image: proc { |_ctx, _src, _alt, _title| 'skip' },
+    visit_strong: proc { |_ctx, _text| 'continue' },
+    visit_em: proc { |_ctx, _text| 'continue' },
+    visit_code: proc { |_ctx, _text| 'continue' },
+    visit_br: proc { |_ctx| 'continue' }
+  }
+end
+
 html = File.binread(fixture)
 html.force_encoding(Encoding::UTF_8)
 html.freeze
@@ -83,33 +152,52 @@ options_handle = if %w[convert-options inline-images-options metadata-options].i
                    HtmlToMarkdown.options(conversion_options)
                  end
 
+# Create visitor if specified
+visitor = nil
+if options[:visitor]
+  visitor_creators = {
+    'noop' => method(:create_noop_visitor),
+    'simple' => method(:create_simple_visitor),
+    'custom' => method(:create_custom_visitor),
+    'complex' => method(:create_complex_visitor)
+  }
+  creator = visitor_creators[options[:visitor]]
+  visitor = creator.call if creator
+end
+
 SCENARIO_RUNNERS = {
-  'convert-default' => ->(html, _options, _handle) { HtmlToMarkdown.convert(html) },
-  'convert-options' => lambda do |html, _options, handle|
+  'convert-default' => ->(html, _options, _handle, _visitor) { HtmlToMarkdown.convert(html) },
+  'convert-options' => lambda do |html, _options, handle, _visitor|
     raise ArgumentError, 'options handle required' unless handle
 
     HtmlToMarkdown.convert_with_options(html, handle)
   end,
-  'inline-images-default' => ->(html, _options, _handle) { HtmlToMarkdown.convert_with_inline_images(html, nil, nil) },
-  'inline-images-options' => lambda do |html, _options, handle|
+  'inline-images-default' => lambda { |html, _options, _handle, _visitor|
+    HtmlToMarkdown.convert_with_inline_images(html, nil, nil)
+  },
+  'inline-images-options' => lambda do |html, _options, handle, _visitor|
     raise ArgumentError, 'options handle required' unless handle
 
     HtmlToMarkdown.convert_with_inline_images_handle(html, handle, nil)
   end,
-  'metadata-default' => ->(html, _options, _handle) { HtmlToMarkdown.convert_with_metadata(html, nil, nil) },
-  'metadata-options' => lambda do |html, _options, handle|
+  'metadata-default' => ->(html, _options, _handle, _visitor) { HtmlToMarkdown.convert_with_metadata(html, nil, nil) },
+  'metadata-options' => lambda do |html, _options, handle, _visitor|
     raise ArgumentError, 'options handle required' unless handle
 
     HtmlToMarkdown.convert_with_metadata_handle(html, handle, nil)
   end
 }.freeze
 
-def run_scenario(html, scenario, options, handle)
-  runner = SCENARIO_RUNNERS.fetch(scenario) { raise ArgumentError, "Unsupported scenario: #{scenario}" }
-  runner.call(html, options, handle)
+def run_scenario(html, scenario, options, handle, visitor = nil)
+  if visitor
+    HtmlToMarkdown.convert_with_visitor(html, nil, visitor)
+  else
+    runner = SCENARIO_RUNNERS.fetch(scenario) { raise ArgumentError, "Unsupported scenario: #{scenario}" }
+    runner.call(html, options, handle, visitor)
+  end
 end
 
-run_scenario(html, options[:scenario], conversion_options, options_handle)
+run_scenario(html, options[:scenario], conversion_options, options_handle, visitor)
 
 profile_output = ENV.fetch('HTML_TO_MARKDOWN_PROFILE_OUTPUT', nil)
 if profile_output && HtmlToMarkdown.respond_to?(:start_profiling)
@@ -118,7 +206,7 @@ if profile_output && HtmlToMarkdown.respond_to?(:start_profiling)
 end
 
 start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-iterations.times { run_scenario(html, options[:scenario], conversion_options, options_handle) }
+iterations.times { run_scenario(html, options[:scenario], conversion_options, options_handle, visitor) }
 elapsed = Process.clock_gettime(Process::CLOCK_MONOTONIC) - start
 
 HtmlToMarkdown.stop_profiling if profile_output && HtmlToMarkdown.respond_to?(:stop_profiling)

data/ext/html-to-markdown-rb/native/Cargo.toml

@@ -1,11 +1,11 @@
 [package]
 name = "html-to-markdown-rb"
-version = "2.16.0"
+version = "2.18.0"
 edition = "2024"
 authors = ["Na'aman Hirschfeld <nhirschfeld@gmail.com>"]
 license = "MIT"
-repository = "https://github.com/Goldziher/html-to-markdown"
-homepage = "https://github.com/Goldziher/html-to-markdown"
+repository = "https://github.com/kreuzberg-dev/html-to-markdown"
+homepage = "https://github.com/kreuzberg-dev/html-to-markdown"
 documentation = "https://docs.rs/html-to-markdown-rs"
 readme = "README.md"
 rust-version = "1.85"
@@ -18,7 +18,7 @@ name = "html_to_markdown_rb"
 crate-type = ["cdylib", "rlib"]
 
 [dependencies]
-html-to-markdown-rs = { version = "2.16.0", features = ["inline-images"] }
+html-to-markdown-rs = { version = "2.16.1", features = ["inline-images", "visitor", "metadata"] }
 magnus = { git = "https://github.com/matsadler/magnus", rev = "f6db11769efb517427bf7f121f9c32e18b059b38", features = ["rb-sys"] }
 
 [target.'cfg(not(target_os = "windows"))'.dependencies]
@@ -27,6 +27,8 @@ pprof = { version = "0.15", features = ["flamegraph"], optional = true }
 [dev-dependencies]
 pretty_assertions = "1.4"
 [features]
-default = ["metadata"]
+default = ["inline-images", "metadata", "visitor"]
+inline-images = ["html-to-markdown-rs/inline-images"]
 metadata = ["html-to-markdown-rs/metadata"]
+visitor = ["html-to-markdown-rs/visitor"]
 profiling = ["dep:pprof"]

data/ext/html-to-markdown-rb/native/README.md

@@ -8,7 +8,7 @@ Blazing-fast HTML → Markdown conversion for Ruby, powered by the same Rust eng
 [![PyPI](https://img.shields.io/pypi/v/html-to-markdown.svg?logo=pypi)](https://pypi.org/project/html-to-markdown/)
 [![Packagist](https://img.shields.io/packagist/v/goldziher/html-to-markdown.svg)](https://packagist.org/packages/goldziher/html-to-markdown)
 [![RubyGems](https://badge.fury.io/rb/html-to-markdown.svg)](https://rubygems.org/gems/html-to-markdown)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/Goldziher/html-to-markdown/blob/main/LICENSE)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/kreuzberg-dev/html-to-markdown/blob/main/LICENSE)
 
 ## Features
 
@@ -21,10 +21,10 @@ Blazing-fast HTML → Markdown conversion for Ruby, powered by the same Rust eng
 
 ## Documentation & Support
 
-- [GitHub repository](https://github.com/Goldziher/html-to-markdown)
-- [Issue tracker](https://github.com/Goldziher/html-to-markdown/issues)
-- [Changelog](https://github.com/Goldziher/html-to-markdown/blob/main/CHANGELOG.md)
-- [Live demo (WASM)](https://goldziher.github.io/html-to-markdown/)
+- [GitHub repository](https://github.com/kreuzberg-dev/html-to-markdown)
+- [Issue tracker](https://github.com/kreuzberg-dev/html-to-markdown/issues)
+- [Changelog](https://github.com/kreuzberg-dev/html-to-markdown/blob/main/CHANGELOG.md)
+- [Live demo (WASM)](https://kreuzberg-dev.github.io/html-to-markdown/)
 
 ## Installation