Module: Canon::Xml::WhitespacePolicy

Defined in:
lib/canon/xml/whitespace_policy.rb

Overview

Parse-time whitespace policy: whether a character-data node survives conversion. One home for the keep/strip rules so the DOM/SAX/HTML differences are visible here instead of implied by copy-paste across conversion sites.

Document-level character data (outside the root element) can only be whitespace per the XML grammar, and the XPath data model — which canon's tree and C14N follow — has no root text children at all. Every policy therefore drops whitespace-only document-level text; engines that report it (libxml2 does not, libleptris 1.9.38+ does) stay byte-compatible through here.

Constant Summary collapse

HTML_WHITESPACE_SENSITIVE_TAGS =

HTML conversion rule: whitespace-only text is dropped except in whitespace-sensitive elements (pre/code/textarea/script/style), between inline siblings (semantically significant), and when it carries NBSP (U+00A0 — never insignificant; strip is ASCII-only so it is checked explicitly).

%w[pre code textarea script style].freeze

Class Method Summary collapse

Class Method Details

.keep_dom_text?(content, preserve_whitespace:, element_parent: true) ⇒ Boolean

DOM conversion rule: whitespace-only text is dropped unless preserving. Non-ASCII whitespace (NBSP, U+3000) survives — String#strip only removes ASCII whitespace.

NOTE: CR-only nodes are dropped on this path; the SAX rule keeps them (character references must survive for C14N).

Returns:

  • (Boolean) 


25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/canon/xml/whitespace_policy.rb', line 25

def keep_dom_text?(content, preserve_whitespace:,
element_parent: true)
  # The XPath data model has no root text children — drop
  # whitespace-only document-level text even when preserving
  # (engines that report it stay byte-compatible with libxml2).
  return false if !element_parent && content.strip.empty?

  return true if preserve_whitespace

  !content.strip.empty?
end

.keep_html_text?(content, parent_name:, inline_significant: false) ⇒ Boolean

Returns:

  • (Boolean) 


57
58
59
60
61
62
63
64
65
66
 
# File 'lib/canon/xml/whitespace_policy.rb', line 57

def keep_html_text?(content, parent_name:, inline_significant: false)
  return true unless content.strip.empty?
  return true if content.include?(" ")

  parent_name = parent_name.to_s.downcase
  return true if HTML_WHITESPACE_SENSITIVE_TAGS.include?(parent_name)
  return true if inline_significant

  false
end

.keep_sax_text?(content, preserve_whitespace:, element_parent: true) ⇒ Boolean

SAX rule: same shape, plus CR-bearing content is always kept ( must survive parsing for C14N) — only runs of pure ASCII whitespace (space, tab, CR, LF) are dropped when not preserving.

Returns:

  • (Boolean) 


40
41
42
43
44
45
46
47
48
 
# File 'lib/canon/xml/whitespace_policy.rb', line 40

def keep_sax_text?(content, preserve_whitespace:,
element_parent: true)
  return false if !element_parent && content.strip.empty?

  return true if preserve_whitespace
  return true if content.include?("\r")

  !content.gsub(/[ \t\r\n]/, "").empty?
end