sparklemotion/nokogiri

[feature request] HTML5 parser for JRuby implementation

Open

#2227 opened on Apr 29, 2021

View on GitHub
 (4 comments) (2 reactions) (0 assignees)Ruby (5,615 stars) (806 forks)batch import
help wantedplatform/jruby

Description

This issue is a placeholder for collaboration with the JRuby community to find a way to provide HTML5-compliant parsing for Nokogiri's JRuby implementation.

#2204 provides an HTML5 parser for the CRuby implementation by leveraging the Gumbo parser, implemented in C, and a C extension that is tightly coupled to libxml2. As a result, the Nokogiri::HTML5 module will not be immediately available on JRuby, which uses Xerces in place of libxml2.

The Nokogiri maintainers feel it is important to think about and we hope to work on this in the future. If you're interested in helping with HTML5 support on JRuby, please comment on this issue or ping the maintainers on the mailing list or the Discord channel.

Contributor guide

Tech stack
rubyjava
Domain
backend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
unclear
Prerequisites
RubyJRubyHTML5 parsingNokogiri internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
10
Research direction
Review the existing CRuby HTML5 parser implementation in issue #2204, which uses the Gumbo C parser and a C extension. Investigate how to achieve similar functionality on JRuby using Java based HTML5 parsers (e.g., Xerces or HTMLCleaner). Examine any comments on this issue for suggested approaches or maintainer input. Propose a high level architecture for a JRuby compatible HTML5 module that bridges Ruby and Java.