Release 2.0.1 (#3)

- Performance improvements : escaping is 99.37% faster and unescaping is 10,38% faster (in average)
- Changed the escaping/unescaping tables model
- Better tests and coverage

Author: alexaubry

.codecov.yml

@@ -0,0 +1,2 @@
+ignore:
+    - "Tests"

.gitignore

@@ -1,65 +1,7 @@
-# Xcode
-#
-# gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore
-
-## Build generated
 build/
 DerivedData/
-
-## Various settings
-*.pbxuser
-!default.pbxuser
-*.mode1v3
-!default.mode1v3
-*.mode2v3
-!default.mode2v3
-*.perspectivev3
-!default.perspectivev3
 xcuserdata/
-
-## Other
-*.moved-aside
-*.xcuserstate
-
-## Obj-C/Swift specific
-*.hmap
-*.ipa
-*.dSYM.zip
-*.dSYM
-
-## Playgrounds
-timeline.xctimeline
-playground.xcworkspace
-
-# Swift Package Manager
-#
-# Add this line if you want to avoid checking in source code from Swift Package Manager dependencies.
-# Packages/
+Packages/
 .build/
-
-# CocoaPods
-#
-# We recommend against adding the Pods directory to your .gitignore. However
-# you should judge for yourself, the pros and cons are mentioned at:
-# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
-#
-# Pods/
-
-# Carthage
-#
-# Add this line if you want to avoid checking in source code from Carthage dependencies.
-# Carthage/Checkouts
-
 Carthage/Build
-
-# fastlane
-#
-# It is recommended to not store the screenshots in the git repo. Instead, use fastlane to re-generate the
-# screenshots whenever they are needed.
-# For more information about the recommended setup visit:
-# https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Gitignore.md
-
-fastlane/report.xml
-fastlane/Preview.html
-fastlane/screenshots
-fastlane/test_output
+docs/undocumented.json

CHANGELOG.md

@@ -1,5 +1,11 @@
 # HTMLString Change Log
 
+## 2016-12-06 — Version 2.0.1
+
+- Performance improvements : escaping is **99.37%** faster and unescaping is **10,38%** faster (in average)
+- Changed the escaping/unescaping tables model
+- Better tests and coverage
+
 ## 2016-12-03 — Version 2.0.0
 
 - Transitioned to a `Character`-based API: this adds full support for extended grapheme clusters.

Gemfile

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

Gemfile.lock

@@ -0,0 +1,92 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    CFPropertyList (2.3.4)
+    activesupport (4.2.7.1)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    claide (1.0.1)
+    cocoapods (1.1.1)
+      activesupport (>= 4.0.2, < 5)
+      claide (>= 1.0.1, < 2.0)
+      cocoapods-core (= 1.1.1)
+      cocoapods-deintegrate (>= 1.0.1, < 2.0)
+      cocoapods-downloader (>= 1.1.2, < 2.0)
+      cocoapods-plugins (>= 1.0.0, < 2.0)
+      cocoapods-search (>= 1.0.0, < 2.0)
+      cocoapods-stats (>= 1.0.0, < 2.0)
+      cocoapods-trunk (>= 1.1.1, < 2.0)
+      cocoapods-try (>= 1.1.0, < 2.0)
+      colored (~> 1.2)
+      escape (~> 0.0.4)
+      fourflusher (~> 2.0.1)
+      gh_inspector (~> 1.0)
+      molinillo (~> 0.5.1)
+      nap (~> 1.0)
+      xcodeproj (>= 1.3.3, < 2.0)
+    cocoapods-core (1.1.1)
+      activesupport (>= 4.0.2, < 5)
+      fuzzy_match (~> 2.0.4)
+      nap (~> 1.0)
+    cocoapods-deintegrate (1.0.1)
+    cocoapods-downloader (1.1.2)
+    cocoapods-plugins (1.0.0)
+      nap
+    cocoapods-search (1.0.0)
+    cocoapods-stats (1.0.0)
+    cocoapods-trunk (1.1.1)
+      nap (>= 0.8, < 2.0)
+      netrc (= 0.7.8)
+    cocoapods-try (1.1.0)
+    colored (1.2)
+    escape (0.0.4)
+    fourflusher (2.0.1)
+    fuzzy_match (2.0.4)
+    gh_inspector (1.0.2)
+    i18n (0.7.0)
+    jazzy (0.7.3)
+      cocoapods (~> 1.0)
+      mustache (~> 0.99)
+      open4
+      redcarpet (~> 3.2)
+      rouge (~> 1.5)
+      sass (~> 3.4)
+      sqlite3 (~> 1.3)
+      xcinvoke (~> 0.3.0)
+    json (1.8.3)
+    liferaft (0.0.6)
+    minitest (5.10.1)
+    molinillo (0.5.4)
+    mustache (0.99.8)
+    nanaimo (0.2.3)
+    nap (1.1.0)
+    netrc (0.7.8)
+    open4 (1.3.4)
+    redcarpet (3.3.4)
+    rouge (1.11.1)
+    sass (3.4.22)
+    sqlite3 (1.3.12)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    xcinvoke (0.3.0)
+      liferaft (~> 0.0.6)
+    xcodeproj (1.4.1)
+      CFPropertyList (~> 2.3.3)
+      activesupport (>= 3)
+      claide (>= 1.0.1, < 2.0)
+      colored (~> 1.2)
+      nanaimo (~> 0.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jazzy (~> 0.7.3)
+  json (~> 1.7)
+
+BUNDLED WITH
+   1.13.6

HTMLString.podspec

@@ -1,7 +1,7 @@
 Pod::Spec.new do |s|
 
   s.name         = "HTMLString"
-  s.version      = "2.0.0"
+  s.version      = "2.0.1"
   s.summary      = "Convert Strings that contains HTML in Swift"
 
   s.description  = <<-DESC

Sources/HTMLString.swift

@@ -77,16 +77,9 @@ public extension String {
     ///
 
     fileprivate func escapeHTML(isEncodingUnicode: Bool) -> String {
-
-        var finalString = String()
-
-        for character in characters {
-            let escapingSequence = isEncodingUnicode ? character.escapingForUnicode : character.escapingForASCII
-            finalString.append(escapingSequence)
-        }
-
-        return finalString
-
+        return self.characters.map {
+            isEncodingUnicode ? $0.escapingForUnicode : $0.escapingForASCII
+        }.joined()
     }
 
     // MARK: - Unescaping
@@ -103,95 +96,101 @@ public extension String {
             return self
         }
 
-        var finalString = self
-        var searchRange = finalString.startIndex ..< finalString.endIndex
+        var unescapedString = self
+        var searchRange = unescapedString.startIndex ..< unescapedString.endIndex
 
-        while let delimiterRange = finalString.range(of: "&", options: [], range: searchRange, locale: nil) {
+        while let delimiterRange = unescapedString.range(of: "&", range: searchRange) {
 
-            let semicolonSearchRange = delimiterRange.upperBound ..< finalString.endIndex
+            let semicolonSearchRange = delimiterRange.upperBound ..< unescapedString.endIndex
 
-            guard let semicolonRange = finalString.range(of: ";", options: [], range: semicolonSearchRange, locale: nil) else {
-                searchRange = delimiterRange.upperBound ..< finalString.endIndex
+            guard let semicolonRange = unescapedString.range(of: ";", range: semicolonSearchRange) else {
+                searchRange = delimiterRange.upperBound ..< unescapedString.endIndex
                 continue
             }
 
             let escapeSequenceBounds = delimiterRange.lowerBound ..< semicolonRange.upperBound
-            let escapeRange = delimiterRange.upperBound ..< semicolonRange.lowerBound
 
-            let escapeString = finalString.substring(with: escapeRange)
+            let escapableContentRange = delimiterRange.upperBound ..< semicolonRange.lowerBound
+            let escapableContent = unescapedString.substring(with: escapableContentRange)
 
             let replacementString: String
 
-            if escapeString[escapeString.startIndex] == "#" {
-
-                let secondCharacter = escapeString[escapeString.index(after: escapeString.startIndex)]
+            if escapableContent[escapableContent.startIndex] == "#" {
 
-                let isHexadecimal = (secondCharacter == "X" || secondCharacter == "x")
-                let firstCharacterOffset = isHexadecimal ? 2 : 1
+                guard let unescapedNumericalSequence = unescaped(numericalSequence: escapableContent) else {
+                    searchRange = escapeSequenceBounds.upperBound ..< unescapedString.endIndex
+                    continue
+                }
 
-                let sequenceRange = escapeString.index(escapeString.startIndex, offsetBy: firstCharacterOffset) ..< escapeString.endIndex
+                replacementString = unescapedNumericalSequence
 
-                let sequence = escapeString.substring(with: sequenceRange)
+            } else {
 
-                var value = UInt32()
+                guard let unescapedCharacter = HTMLTables.unescapingTable[escapableContent] else {
+                    searchRange = escapeSequenceBounds.upperBound ..< unescapedString.endIndex
+                    continue
+                }
 
-                if isHexadecimal {
+                replacementString = unescapedCharacter
 
-                    let scanner = Scanner(string: sequence)
+            }
 
-                    #if os(OSX) || os(iOS) || os(watchOS) || os(tvOS)
+            unescapedString.replaceSubrange(escapeSequenceBounds, with: replacementString)
+            searchRange = delimiterRange.upperBound ..< unescapedString.endIndex
 
-                    guard scanner.scanHexInt32(&value) && value > 0 else {
-                        searchRange = escapeSequenceBounds.upperBound ..< finalString.endIndex
-                        continue
-                    }
+        }
 
-                    #else
+        return unescapedString
 
-		            guard let _value = scanner.scanHexInt() else {
-                        searchRange = escapeSequenceBounds.upperBound ..< finalString.endIndex
-                        continue
-                    }
+    }
 
-                    value = _value
+    ///
+    /// Unescapes a numerical escape sequence.
+    ///
+    /// Numerical sequences can be either decimal (`&#45;`) or hexadecimal (`&#xc1`).
+    ///
+    /// - parameter numericalSequence: The sequence to escape. It must not contain the `&` prefix of the `;` suffix.
+    ///
+    /// - returns: The unescaped version of the sequence, or `nil` if unescaping failed.
+    ///
 
-                    #endif
+    fileprivate func unescaped(numericalSequence: String) -> String? {
 
-                } else {
+        let secondCharacter = numericalSequence[numericalSequence.index(after: numericalSequence.startIndex)]
 
-                    guard let _value = UInt32(sequence) else {
-                        searchRange = escapeSequenceBounds.upperBound ..< finalString.endIndex
-                        continue
-                    }
+        let isHexadecimal = (secondCharacter == "X" || secondCharacter == "x")
+        let numberStartIndexOffset = isHexadecimal ? 2 : 1
 
-                    value = _value
+        let numberStringRange = numericalSequence.index(numericalSequence.startIndex, offsetBy: numberStartIndexOffset) ..< numericalSequence.endIndex
+        let numberString = numericalSequence.substring(with: numberStringRange)
 
-                }
+        var codePoint = UInt32()
 
-                guard let scalar = UnicodeScalar(value) else {
-                    searchRange = escapeSequenceBounds.upperBound ..< finalString.endIndex
-                    continue
-                }
+        if isHexadecimal {
 
-                replacementString = String(Character(scalar))
+            let scanner = Scanner(string: numberString)
 
-            } else {
+            guard let _codePoint = scanner.scanHexInt() else {
+                return nil
+            }
 
-                guard let escapeSequence = HTMLEscaping.escapeSequenceTable[escapeString] else {
-                    searchRange = escapeSequenceBounds.upperBound ..< finalString.endIndex
-                    continue
-                }
+            codePoint = _codePoint
 
-                replacementString = escapeSequence
+        } else {
 
+            guard let _codePoint = UInt32(numberString) else {
+                return nil
             }
 
-            finalString.replaceSubrange(escapeSequenceBounds, with: replacementString)
-            searchRange = delimiterRange.upperBound ..< finalString.endIndex
+            codePoint = _codePoint
+
+        }
 
+        guard let scalar = UnicodeScalar(codePoint) else {
+            return nil
         }
 
-        return finalString
+        return String(Character(scalar))
 
     }