Skip to content

Allow caller to override unsafeUnicodeCharacters #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Allow caller to override unsafeUnicodeCharacters #36

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions Sources/HTMLString/HTMLString.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ extension String {
/// Returns a copy of the current `String` where every character incompatible with HTML Unicode
/// encoding (UTF-16 or UTF-8) is replaced by a decimal HTML entity.
///
/// Pass `unsafeUnicodeCharacters` to override the default set of unsafe characters (`!"$%&'+,<=>@[]\`{}`).
///
/// ### Examples
///
/// | String | Result | Format |
Expand All @@ -18,11 +20,13 @@ extension String {
/// | `a` | `a` | Not escaped (alphanumerical) |
///

public func addingUnicodeEntities() -> String {
public func addingUnicodeEntities(unsafeUnicodeCharacters: Set<Character>? = nil) -> String {
var result = ""

let unsafeCharacters = unsafeUnicodeCharacters ?? HTMLStringMappings.unsafeUnicodeCharacters

for character in self {
if HTMLStringMappings.unsafeUnicodeCharacters.contains(character) {
if unsafeCharacters.contains(character) {
// One of the required escapes for security reasons
result.append(contentsOf: "&#\(character.asciiValue!);")
} else {
Expand Down
9 changes: 9 additions & 0 deletions Tests/HTMLStringTests/HTMLStringTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,15 @@ final class HTMLStringTests: XCTestCase {
XCTAssertEqual(doubleEmojiEscape, "Going to the 🇺🇸 next June")
}

/// Tests escaping a string for Unicode with a custom blocklist
func testStringUnicodeEscapingWithCustomUnsafeCharacters() {
let requiredEscape = ("Fish & Chips").addingUnicodeEntities()
XCTAssertEqual(requiredEscape, "Fish &#38; Chips")

let notRequiredEscape = ("Fish & Chips").addingUnicodeEntities(unsafeUnicodeCharacters: [])
XCTAssertEqual(notRequiredEscape, "Fish & Chips")
}

// MARK: - Unescaping

/// Tests unescaping strings.
Expand Down