Skip to content

Commit 33c63e3

Browse files
alexaubryalexaubry
authored
Release v2.1.0 (#4)
1 parent 146b239 commit 33c63e3

40 files changed

+1575
-1702
lines changed

‎.DS_Store‎

6 KB
Binary file not shown.

‎.codecov.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
ignore:
22
- "Tests"
3+
- "Sources/Performance"

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.DS_Store
12
build/
23
DerivedData/
34
xcuserdata/

‎.jazzy.yaml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
clean: true
2+
author: "Alexis Aubry Radanovic"
3+
author_url: https://github.com/alexaubry
4+
github_url: https://github.com/alexaubry/HTMLString
5+
github_file_prefix: https://github.com/alexaubry/HTMLString/tree/2.1.0
6+
module_version: 2.1.0
7+
xcodebuild_arguments: -scheme,HTMLString
8+
module: HTMLString
9+
root_url: https://alexaubry.github.io/HTMLString
10+
output: docs/
11+
swift_version: 3.0.2
12+
copyright: "Copyright © 2016-2017 Alexis Aubry Radanovic. Licensed under the [MIT License](https://github.com/alexaubry/HTMLString/blob/master/LICENSE)"
13+
podspec: ./HTMLString.podspec
14+
skip-undocumented: true
15+
theme: apple

‎.swift-version‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
3.0.1
1+
3.0.2

‎.travis.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ os:
44
language: generic
55
sudo: required
66
dist: trusty
7-
osx_image: xcode8.1
7+
osx_image: xcode8.2
88

99
script:
1010
- eval "$(curl -sL https://swift.vapor.sh/ci)"

‎Benchmark.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# ⚡ Benchmarks
2+
3+
A set of measures tracking the performance of the library.
4+
5+
## ⏱ Compile times
6+
7+
| Configuration | v2.0.1 | v2.1.0 |
8+
|:---|---|---|
9+
| Debug | 7.15s | 6.40s |
10+
| Release | 32.83s | 27.21ss |
11+
12+
## 🤖 Common Tasks
13+
14+
### Debug
15+
16+
| Task | v2.0.1 | v2.1.0 |
17+
|:---|---|---|
18+
| Unicode-escaping 2 emojis | 0.000083s | 0.000040s |
19+
| ASCII-escaping 2 emojis | 0.000104s | 0.000035s |
20+
| Unescaping 2 emojis | 0.000046s | 0.000049s |
21+
| Unescaping a tweet | 0.000085s | 0.000033s |
22+
| Unicode-escaping a tweet | 0.000844s | 0.000131s |
23+
| ASCII-escaping a tweet | 0.001023s | 0.000158s |
24+
| Unicode-escaping 23,145 characters | 0.159909s | 0.024684s |
25+
| ASCII-escaping 23,145 characters | 0.198981s | 0.030419s |
26+
| Unescaping 3,026 words with 366 escapes | 0.165962s | 0.001686s |
27+
28+
### Release
29+
30+
| Task | v2.0.1 | v2.1.0 |
31+
|:---|---|---|
32+
| Unicode-escaping 2 emojis | 0.000022s | 0.000010s |
33+
| ASCII-escaping 2 emojis | 0.000033s | 0.000015s |
34+
| Unescaping 2 emojis | 0.000031s | 0.000016s |
35+
| Unescaping a tweet | 0.000052s | 0.000017s |
36+
| Unicode-escaping a tweet | 0.000183s | 0.000064s |
37+
| ASCII-escaping a tweet | 0.000276s | 0.000077s |
38+
| Unicode-escaping 23,145 characters | 0.034701s | 0.011941s |
39+
| ASCII-escaping 23,145 characters | 0.052937s | 0.014950s |
40+
| Unescaping 3,026 words with 366 escapes | 0.014192s | 0.001162s |
41+
42+
## ❓ Complexity
43+
44+
TODO
45+
46+
| Algorithm | v2.0.1 | v2.1.0 |
47+
|:---|---|---|
48+
| ASCII escaping | N/A | N/A |
49+
| Unicode escaping | N/A | N/A |
50+
| Unescaping | N/A | N/A |

‎CHANGELOG.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,17 @@
11
# HTMLString Change Log
22

3+
## 2017-01-04 — Version 2.1.0
4+
5+
- Change the escaping algorithm (`reduce` instead of `map`)
6+
- Reduced the size of the escaping mappings
7+
- Performance improvements: escaping is up to **6.5 times** faster and unescaping is up to **98 times** faster
8+
- Improved documentation
9+
- New benchmark tool and reports
10+
11+
#### Source breaking changes
12+
13+
- The `Character` (un)escaping extensions have been removed.
14+
315
## 2016-12-06 — Version 2.0.1
416

517
- Performance improvements : escaping is **99.37%** faster and unescaping is **10,38%** faster (in average)

‎Carthage/.DS_Store‎

6 KB
Binary file not shown.

‎Gemfile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
source "https://rubygems.org"
22
gem 'json', '~> 1.7'
33
gem 'jazzy', '~> 0.7.3'
4+
gem 'xcov', '~> 0.12.5'

0 commit comments

Comments
 (0)