htmlentity 1.0.0

Encode a unicode character to html entity, decode html entity to a unicode character.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148

use htmlentity::entity::{
  decode, encode, encode_default, encode_filter, encode_with, EncodeType, EntitySet, NOOP,
};

#[test]
fn test_escape() {
  // test 1
  let content = "
    \t
    \n
    <br>this is a multiple line text.
    <div class='product'>
      <span><span>￥</span>100</span>
      <h4>this is a title&lt;main&gt;</h4>
    </div>
  ";
  let result = encode_default(content);
  assert_eq!(decode(&result), content);
  // test 2
  let content = "<div>";
  let encoded_content = "&lt;div&gt;";
  assert_eq!(
    encode(content, EntitySet::SpecialChars, Default::default()),
    encoded_content
  );
  assert_eq!(decode(encoded_content), content);
  // test 3
  let content = "<div>";
  let encoded_content = "&lt;&#x64;&#x69;&#x76;&gt;";
  assert_eq!(
    encode(content, EntitySet::All, EncodeType::NamedOrHex),
    encoded_content
  );
  assert_eq!(decode(encoded_content), content);
  // test 4
  let content = "\t<div>";
  let encoded_content = encode_filter(
    content,
    |_ch: char| true,
    EncodeType::Named,
    Some(|ch| ch == '<'),
  );
  assert_eq!(encoded_content, "&Tab;<div&gt;");
  // test 5
  let content = "\t<div>";
  let encoded_content = encode_with(content, |ch: char| {
    if ch == '<' {
      return None;
    }
    Some(EncodeType::Named)
  });
  assert_eq!(encoded_content, "&Tab;<div&gt;");
}

#[test]
fn test_wrong_entity() {
  let content = "&#;";
  assert_eq!(decode(content), content);
  let content = "&;";
  assert_eq!(decode(content), content);
}
#[test]
fn test_decode_named() {
  // wrong named
  let content = "&#q123;";
  assert_eq!(decode(content), content);
  let content = "&123;";
  assert_eq!(decode(content), content);
  let content = "&q123;";
  assert_eq!(decode(content), content);
}

#[test]
fn test_decode_hex() {
  // hex
  let content = "&#x2192;";
  assert_eq!(decode(content), "→");
  // HEX
  let content = "&#X2192;";
  assert_eq!(decode(content), "→");
  // hex with leading zeros
  let content = "&#x0002192;";
  assert_eq!(decode(content), "→");
  // wrong hex unicode ranges
  let content = "&#x110000;";
  assert_eq!(decode(content), content);
  let content = "&#xDC00;";
  assert_eq!(decode(content), content);
  // wrong hex
  let content = "&#xa0fh;";
  assert_eq!(decode(content), content);
  // wrong hex or decimal
  let content = "&#a00;";
  assert_eq!(decode(content), content);
}

#[test]
fn test_decode_decimal() {
  // decimal
  let content = "&#8594;";
  assert_eq!(decode(content), "→");
  // decimal with leading zeros
  let content = "&#0008594;";
  assert_eq!(decode(content), "→");
  // wrong decimal unicode ranges
  let content = "&#1114112;";
  assert_eq!(decode(content), content);
  let content = "&#56320;";
  assert_eq!(decode(content), content);
}

#[test]
fn test_exclude_named() {
  let html = "<div class='header'></div>";
  let html_encoded = encode_filter(
    html,
    |ch| ch != '<' && EntitySet::SpecialChars.contains(&ch),
    EncodeType::Named,
    NOOP,
  );
  assert_eq!(html_encoded, "<div class=&apos;header&apos;&gt;</div&gt;");

  // special characters, but exclude the single quote "'" use named.
  let html = "<div class='header'></div>";
  let html_encoded = encode_filter(
    html,
    |ch| EntitySet::SpecialChars.contains(&ch),
    EncodeType::NamedOrDecimal,
    Some(|ch| ch == '\''),
  );
  assert_eq!(
    html_encoded,
    "&lt;div class=&#39;header&#39;&gt;&lt;/div&gt;"
  );

  // the same as the EncodeType::Decimal.
  let html = "<div class='header'></div>";
  let html_encoded = encode_filter(
    html,
    |ch| EntitySet::SpecialChars.contains(&ch),
    EncodeType::NamedOrDecimal,
    Some(|ch| EntitySet::SpecialChars.contains(&ch)),
  );
  assert_eq!(
    html_encoded,
    "&#60;div class=&#39;header&#39;&#62;&#60;/div&#62;"
  );
}