# frozen_string_literal: true module HtmlEscapedHelpers extend self # Checks if +content+ contains HTML escaped tags and returns its match. # # It matches escaped opening and closing tags `<` and # `</`. The match is discarded if the tag is inside a quoted # attribute value. # Foor example, `
`. # # @return [MatchData, nil] Returns the match or +nil+ if no match was found. def match_html_escaped_tags(content) match_data = %r{<\s*(?:/\s*)?\w+}.match(content) return unless match_data # Escaped HTML tags are allowed inside quoted attribute values like: # `title="Press <back>"` return if %r{=\s*["'][^>]*\z}.match?(match_data.pre_match) match_data end # Checks if +content+ contains HTML escaped tags and raises an exception # if it does. # # See #match_html_escaped_tags for details. def ensure_no_html_escaped_tags!(content, example) match_data = match_html_escaped_tags(content) return unless match_data # Truncate pre_match = match_data.pre_match.last(50) match = match_data[0] post_match = match_data.post_match.first(50) string = "#{pre_match}«#{match}»#{post_match}" raise <<~MESSAGE The following string contains HTML escaped tags: #{string} Please consider using `.html_safe`. This check can be disabled via: it #{example.description.inspect}, :skip_html_escaped_tags_check do ... end MESSAGE end end