Document allowedCharacters

hyperoslo · Aug 16, 2017 · 1b4518e · 1b4518e
1 parent 9523275
commit 1b4518e
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/Sources/Utilities.swift b/Sources/Utilities.swift
@@ -4,11 +4,12 @@ struct PercentEncoder {
 
   /// Perform url encoding
   ///
+  /// - Parameter allowedCharacters: Won't encode allowed characters
   /// - Parameter string: The source string
   /// - Returns: The encoded string
-  static func encode(string: String, allowed: String) -> String {
+  static func encode(string: String, allowedCharacters: String) -> String {
     var set = CharacterSet.urlPathAllowed
-    allowed.unicodeScalars.forEach {
+    allowedCharacters.unicodeScalars.forEach {
       set.insert($0)
     }
 

diff --git a/Tests/Compass/UtilitiesTests.swift b/Tests/Compass/UtilitiesTests.swift
@@ -5,14 +5,14 @@ import XCTest
 class UtilitiesTests: XCTestCase {
   func testEncode() {
     let urn = "organization:hyper oslo:simply awesome"
-    let encodedUrn = PercentEncoder.encode(string: urn, allowed: ":")
+    let encodedUrn = PercentEncoder.encode(string: urn, allowedCharacters: ":")
 
     XCTAssertEqual(encodedUrn, "organization:hyper%20oslo:simply%20awesome")
   }
 
   func testDecode() {
     let urn = "organization:hyper oslo:simply awesome"
-    let encodedUrn = PercentEncoder.encode(string: urn, allowed: ":")
+    let encodedUrn = PercentEncoder.encode(string: urn, allowedCharacters: ":")
 
     XCTAssertEqual(PercentEncoder.decode(string: encodedUrn), urn)
   }