Release v2.1.0 (#4)

Author: alexaubry

.DS_Store

@@ -1,2 +1,3 @@
 ignore:
     - "Tests"
+    - "Sources/Performance"

.codecov.yml

@@ -1,3 +1,4 @@
+.DS_Store
 build/
 DerivedData/
 xcuserdata/

.gitignore

@@ -0,0 +1,15 @@
+clean: true
+author: "Alexis Aubry Radanovic"
+author_url: https://github.com/alexaubry
+github_url: https://github.com/alexaubry/HTMLString
+github_file_prefix: https://github.com/alexaubry/HTMLString/tree/2.1.0
+module_version: 2.1.0
+xcodebuild_arguments: -scheme,HTMLString
+module: HTMLString
+root_url: https://alexaubry.github.io/HTMLString
+output: docs/
+swift_version: 3.0.2
+copyright: "Copyright © 2016-2017 Alexis Aubry Radanovic. Licensed under the [MIT License](https://github.com/alexaubry/HTMLString/blob/master/LICENSE)"
+podspec: ./HTMLString.podspec
+skip-undocumented: true
+theme: apple

.jazzy.yaml

@@ -1 +1 @@
-3.0.1
+3.0.2

.swift-version

@@ -4,7 +4,7 @@ os:
 language: generic
 sudo: required
 dist: trusty
-osx_image: xcode8.1
+osx_image: xcode8.2
 
 script:
   - eval "$(curl -sL https://swift.vapor.sh/ci)"

.travis.yml

@@ -0,0 +1,50 @@
+# ⚡ Benchmarks
+
+A set of measures tracking the performance of the library.
+
+## ⏱ Compile times
+
+| Configuration | v2.0.1 | v2.1.0 |
+|:---|---|---|
+| Debug | 7.15s | 6.40s |
+| Release | 32.83s | 27.21ss |
+
+## 🤖 Common Tasks
+
+### Debug
+
+| Task | v2.0.1 | v2.1.0 |
+|:---|---|---|
+| Unicode-escaping 2 emojis | 0.000083s | 0.000040s |
+| ASCII-escaping 2 emojis | 0.000104s | 0.000035s |
+| Unescaping 2 emojis | 0.000046s | 0.000049s |
+| Unescaping a tweet | 0.000085s | 0.000033s |
+| Unicode-escaping a tweet | 0.000844s | 0.000131s |
+| ASCII-escaping a tweet | 0.001023s | 0.000158s |
+| Unicode-escaping 23,145 characters | 0.159909s | 0.024684s |
+| ASCII-escaping 23,145 characters | 0.198981s | 0.030419s |
+| Unescaping 3,026 words with 366 escapes | 0.165962s | 0.001686s |
+
+### Release
+
+| Task | v2.0.1 | v2.1.0 |
+|:---|---|---|
+| Unicode-escaping 2 emojis | 0.000022s | 0.000010s |
+| ASCII-escaping 2 emojis | 0.000033s | 0.000015s |
+| Unescaping 2 emojis | 0.000031s | 0.000016s |
+| Unescaping a tweet | 0.000052s | 0.000017s |
+| Unicode-escaping a tweet | 0.000183s | 0.000064s |
+| ASCII-escaping a tweet | 0.000276s | 0.000077s |
+| Unicode-escaping 23,145 characters | 0.034701s | 0.011941s |
+| ASCII-escaping 23,145 characters | 0.052937s | 0.014950s |
+| Unescaping 3,026 words with 366 escapes | 0.014192s | 0.001162s |
+
+## ❓ Complexity
+
+TODO
+
+| Algorithm | v2.0.1 | v2.1.0 |
+|:---|---|---|
+| ASCII escaping | N/A | N/A |
+| Unicode escaping | N/A | N/A |
+| Unescaping | N/A | N/A |

Benchmark.md

@@ -1,5 +1,17 @@
 # HTMLString Change Log
 
+## 2017-01-04 — Version 2.1.0
+
+- Change the escaping algorithm (`reduce` instead of `map`)
+- Reduced the size of the escaping mappings
+- Performance improvements: escaping is up to **6.5 times** faster and unescaping is up to **98 times** faster
+- Improved documentation
+- New benchmark tool and reports
+
+#### Source breaking changes
+
+- The `Character` (un)escaping extensions have been removed. 
+
 ## 2016-12-06 — Version 2.0.1
 
 - Performance improvements : escaping is **99.37%** faster and unescaping is **10,38%** faster (in average)

CHANGELOG.md

@@ -1,3 +1,4 @@
 source "https://rubygems.org"
 gem 'json', '~> 1.7'
 gem 'jazzy', '~> 0.7.3'
+gem 'xcov', '~> 0.12.5'

Carthage/.DS_Store

@@ -8,6 +8,9 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    babosa (1.0.2)
     claide (1.0.1)
     cocoapods (1.1.1)
       activesupport (>= 4.0.2, < 5)
@@ -32,20 +35,88 @@ GEM
       fuzzy_match (~> 2.0.4)
       nap (~> 1.0)
     cocoapods-deintegrate (1.0.1)
-    cocoapods-downloader (1.1.2)
+    cocoapods-downloader (1.1.3)
     cocoapods-plugins (1.0.0)
       nap
     cocoapods-search (1.0.0)
     cocoapods-stats (1.0.0)
-    cocoapods-trunk (1.1.1)
+    cocoapods-trunk (1.1.2)
       nap (>= 0.8, < 2.0)
       netrc (= 0.7.8)
     cocoapods-try (1.1.0)
     colored (1.2)
+    commander (4.4.3)
+      highline (~> 1.7.2)
+    domain_name (0.5.20161129)
+      unf (>= 0.0.5, < 1.0.0)
+    dotenv (2.1.1)
     escape (0.0.4)
+    excon (0.54.0)
+    faraday (0.10.1)
+      multipart-post (>= 1.2, < 3)
+    faraday-cookie_jar (0.0.6)
+      faraday (>= 0.7.4)
+      http-cookie (~> 1.0.0)
+    faraday_middleware (0.10.1)
+      faraday (>= 0.7.4, < 1.0)
+    fastimage (2.0.1)
+      addressable (~> 2)
+    fastlane (2.3.0)
+      activesupport (< 5)
+      addressable (>= 2.3, < 3.0.0)
+      babosa (>= 1.0.2, < 2.0.0)
+      bundler (~> 1.12)
+      colored
+      commander (>= 4.4.0, < 5.0.0)
+      dotenv (>= 2.1.1, < 3.0.0)
+      excon (>= 0.45.0, < 1.0.0)
+      faraday (~> 0.9)
+      faraday-cookie_jar (~> 0.0.6)
+      faraday_middleware (~> 0.9)
+      fastimage (>= 1.6)
+      gh_inspector (>= 1.0.1, < 2.0.0)
+      google-api-client (~> 0.9.1)
+      highline (>= 1.7.2, < 2.0.0)
+      json (< 3.0.0)
+      mini_magick (~> 4.5.1)
+      multi_json
+      multi_xml (~> 0.5)
+      multipart-post (~> 2.0.0)
+      plist (>= 3.1.0, < 4.0.0)
+      rubyzip (>= 1.1.0, < 2.0.0)
+      security (= 0.1.3)
+      slack-notifier (>= 1.3, < 2.0.0)
+      terminal-notifier (>= 1.6.2, < 2.0.0)
+      terminal-table (>= 1.4.5, < 2.0.0)
+      word_wrap (~> 1.0.0)
+      xcodeproj (>= 0.20, < 2.0.0)
+      xcpretty (>= 0.2.4, < 1.0.0)
+      xcpretty-travis-formatter (>= 0.0.3)
     fourflusher (2.0.1)
     fuzzy_match (2.0.4)
     gh_inspector (1.0.2)
+    google-api-client (0.9.20)
+      addressable (~> 2.3)
+      googleauth (~> 0.5)
+      httpclient (~> 2.7)
+      hurley (~> 0.1)
+      memoist (~> 0.11)
+      mime-types (>= 1.6)
+      representable (~> 2.3.0)
+      retriable (~> 2.0)
+    googleauth (0.5.1)
+      faraday (~> 0.9)
+      jwt (~> 1.4)
+      logging (~> 2.0)
+      memoist (~> 0.12)
+      multi_json (~> 1.11)
+      os (~> 0.9)
+      signet (~> 0.7)
+    highline (1.7.8)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    httpclient (2.8.3)
+    hurley (0.2)
     i18n (0.7.0)
     jazzy (0.7.3)
       cocoapods (~> 1.0)
@@ -57,36 +128,81 @@ GEM
       sqlite3 (~> 1.3)
       xcinvoke (~> 0.3.0)
     json (1.8.3)
+    jwt (1.5.6)
     liferaft (0.0.6)
+    little-plugger (1.1.4)
+    logging (2.1.0)
+      little-plugger (~> 1.1)
+      multi_json (~> 1.10)
+    memoist (0.15.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    mini_magick (4.5.1)
     minitest (5.10.1)
     molinillo (0.5.4)
+    multi_json (1.12.1)
+    multi_xml (0.6.0)
+    multipart-post (2.0.0)
     mustache (0.99.8)
     nanaimo (0.2.3)
     nap (1.1.0)
     netrc (0.7.8)
     open4 (1.3.4)
-    redcarpet (3.3.4)
+    os (0.9.6)
+    plist (3.2.0)
+    public_suffix (2.0.5)
+    redcarpet (3.4.0)
+    representable (2.3.0)
+      uber (~> 0.0.7)
+    retriable (2.1.0)
     rouge (1.11.1)
-    sass (3.4.22)
+    rubyzip (1.2.0)
+    sass (3.4.23)
+    security (0.1.3)
+    signet (0.7.3)
+      addressable (~> 2.3)
+      faraday (~> 0.9)
+      jwt (~> 1.5)
+      multi_json (~> 1.10)
+    slack-notifier (1.5.1)
     sqlite3 (1.3.12)
+    terminal-notifier (1.7.1)
+    terminal-table (1.7.3)
+      unicode-display_width (~> 1.1.1)
     thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    uber (0.0.15)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.2)
+    unicode-display_width (1.1.2)
+    word_wrap (1.0.0)
     xcinvoke (0.3.0)
       liferaft (~> 0.0.6)
-    xcodeproj (1.4.1)
+    xcodeproj (1.4.2)
       CFPropertyList (~> 2.3.3)
       activesupport (>= 3)
       claide (>= 1.0.1, < 2.0)
       colored (~> 1.2)
-      nanaimo (~> 0.2.0)
+      nanaimo (~> 0.2.3)
+    xcov (0.12.5)
+      fastlane (>= 2.0.3, < 3.0.0)
+      slack-notifier (~> 1.3)
+      terminal-table
+    xcpretty (0.2.4)
+      rouge (~> 1.8)
+    xcpretty-travis-formatter (0.0.4)
+      xcpretty (~> 0.2, >= 0.0.7)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   jazzy (~> 0.7.3)
   json (~> 1.7)
+  xcov (~> 0.12.5)
 
 BUNDLED WITH
    1.13.6

Gemfile

@@ -1,11 +1,11 @@
 Pod::Spec.new do |s|
 
   s.name         = "HTMLString"
-  s.version      = "2.0.1"
-  s.summary      = "Convert Strings that contains HTML in Swift"
+  s.version      = "2.1.0"
+  s.summary      = "Escape and unescape HTML Strings in Swift"
 
   s.description  = <<-DESC
-HTMLString is a micro-library written in Swift that enables your app to convert Strings that contain HTML. It supports ASCII and Unicode escaping, as well as unescaping. You can use it with 2125 named escape sequences (`&amp;`) as well as with decimal (`&#128;`) and hexadecimal (`&#x1F643;`) sequences.
+HTMLString is a fast micro-library written in Swift that enables your app to encode and decode HTML Strings. It supports ASCII and Unicode escaping, as well as unescaping. You can use it with 2125 named escape sequences (`&amp;`) and with all decimal (`&#128;`) and hexadecimal (`&#x1F643;`) sequences.
 DESC
 
   s.homepage     = "https://github.com/alexaubry/HTMLString"
@@ -21,6 +21,6 @@ DESC
   s.tvos.deployment_target = "9.0"
 
   s.source       = { :git => "https://github.com/alexaubry/HTMLString.git", :tag => "#{s.version}" }
-  s.source_files  = "Sources"
+  s.source_files  = "Sources/HTMLString/*"
 
 end