Merge pull request #135 from mattpolzin/v2/rename-templatedurl

prefer the name URLTemplate over TemplatedURL

Author: mattpolzin

Sources/OpenAPIKit/Server.swift

@@ -13,7 +13,7 @@ extension OpenAPI {
     /// See [OpenAPI Server Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.3.md#server-object).
     ///
     public struct Server: Equatable, CodableVendorExtendable {
-        public let urlTemplate: TemplatedURL
+        public let urlTemplate: URLTemplate
         public let description: String?
         public let variables: OrderedDictionary<String, Variable>
 
@@ -30,7 +30,7 @@ extension OpenAPI {
             variables: OrderedDictionary<String, Variable> = [:],
             vendorExtensions: [String: AnyCodable] = [:]
         ) {
-            self.urlTemplate = TemplatedURL(url: url)
+            self.urlTemplate = URLTemplate(url: url)
             self.description = description
             self.variables = variables
             self.vendorExtensions = vendorExtensions
@@ -90,7 +90,7 @@ extension OpenAPI.Server: Decodable {
     public init(from decoder: Decoder) throws {
         let container = try decoder.container(keyedBy: CodingKeys.self)
 
-        urlTemplate = try container.decode(TemplatedURL.self, forKey: .url)
+        urlTemplate = try container.decode(URLTemplate.self, forKey: .url)
         description = try container.decodeIfPresent(String.self, forKey: .description)
         variables = try container.decodeIfPresent(OrderedDictionary<String, Variable>.self, forKey: .variables) ?? [:]
 

Sources/OpenAPIKit/TemplatedURL.swift Sources/OpenAPIKit/URLTemplate.swift

@@ -1,5 +1,5 @@
 //
-//  TemplatedURL.swift
+//  URLTemplate.swift
 //  
 //
 //  Created by Mathew Polzin on 8/13/20.
@@ -31,7 +31,7 @@ import Foundation
 ///
 ///     // etc.
 ///
-public struct TemplatedURL: Hashable, RawRepresentable {
+public struct URLTemplate: Hashable, RawRepresentable {
 
     /// The string value of the URL.
     ///
@@ -43,7 +43,7 @@ public struct TemplatedURL: Hashable, RawRepresentable {
     ///
     /// This is equivalent to the `absoluteString` provided
     /// by the Foundation `URL` type except that a
-    /// `TemplatedURL`'s `absoluteString` can contain
+    /// `URLTemplate`'s `absoluteString` can contain
     /// variable placeholders.
     public var absoluteString: String {
         rawValue
@@ -57,7 +57,7 @@ public struct TemplatedURL: Hashable, RawRepresentable {
         return URL(string: rawValue)
     }
 
-    /// Create a TemplatedURL from the string if possible.
+    /// Create a URLTemplate from the string if possible.
     public init?(rawValue: String) {
         // currently this is guaranteed to succeed but
         // in the future it will fail if variable placeholders
@@ -71,15 +71,15 @@ public struct TemplatedURL: Hashable, RawRepresentable {
     }
 }
 
-extension TemplatedURL: Encodable {
+extension URLTemplate: Encodable {
     public func encode(to encoder: Encoder) throws {
         var container = encoder.singleValueContainer()
 
         try container.encode(rawValue)
     }
 }
 
-extension TemplatedURL: Decodable {
+extension URLTemplate: Decodable {
     public init(from decoder: Decoder) throws {
         let container = try decoder.singleValueContainer()
 
@@ -91,4 +91,4 @@ extension TemplatedURL: Decodable {
     }
 }
 
-extension TemplatedURL: Validatable {}
+extension URLTemplate: Validatable {}

Tests/OpenAPIKitTests/ServerTests.swift

@@ -30,7 +30,7 @@ class ServerTests: XCTestCase {
     func test_serverInitialization() {
         let s1 = Server(url: URL(string: "https://hello.com")!)
 
-        XCTAssertEqual(s1.urlTemplate, TemplatedURL(rawValue: "https://hello.com")!)
+        XCTAssertEqual(s1.urlTemplate, URLTemplate(rawValue: "https://hello.com")!)
         XCTAssertNil(s1.description)
         XCTAssertEqual(s1.variables, [:])
 
@@ -41,7 +41,7 @@ class ServerTests: XCTestCase {
                             "hello": variable
             ])
 
-        XCTAssertEqual(s2.urlTemplate, TemplatedURL(rawValue: "https://hello.com")!)
+        XCTAssertEqual(s2.urlTemplate, URLTemplate(rawValue: "https://hello.com")!)
         XCTAssertEqual(s2.description, "hello world")
         XCTAssertEqual(s2.variables, ["hello": variable])
     }

Tests/OpenAPIKitTests/TemplatedURLTests.swift

@@ -1,5 +1,5 @@
 //
-//  TemplatedURLTests.swift
+//  URLTemplateTests.swift
 //  
 //
 //  Created by Mathew Polzin on 8/13/20.
@@ -9,24 +9,24 @@ import Foundation
 import OpenAPIKit
 import XCTest
 
-final class TemplatedURLTests: XCTestCase {
+final class URLTemplateTests: XCTestCase {
     func test_init() {
-        XCTAssertNotNil(TemplatedURL(rawValue: "https://website.com"))
-        XCTAssertEqual(TemplatedURL(rawValue: "https://website.com"), TemplatedURL(url: URL(string: "https://website.com")!))
+        XCTAssertNotNil(URLTemplate(rawValue: "https://website.com"))
+        XCTAssertEqual(URLTemplate(rawValue: "https://website.com"), URLTemplate(url: URL(string: "https://website.com")!))
     }
 
     func test_urlAccess() {
-        let t1 = TemplatedURL(rawValue: "https://website.com")
-        let t2 = TemplatedURL(rawValue: "{scheme}://website.com")
+        let t1 = URLTemplate(rawValue: "https://website.com")
+        let t2 = URLTemplate(rawValue: "{scheme}://website.com")
 
         XCTAssertEqual(t1?.url, URL(string: "https://website.com"))
         XCTAssertNil(t2?.url)
     }
 
     func test_absoluteString() {
-        let t1 = TemplatedURL(rawValue: "https://website.com")
-        let t2 = TemplatedURL(rawValue: "/a/relative/path")
-        let t3 = TemplatedURL(rawValue: "website.com?query=value")
+        let t1 = URLTemplate(rawValue: "https://website.com")
+        let t2 = URLTemplate(rawValue: "/a/relative/path")
+        let t3 = URLTemplate(rawValue: "website.com?query=value")
 
         XCTAssertEqual(t1?.absoluteString, URL(string: "https://website.com")?.absoluteString)
         XCTAssertEqual(t2?.absoluteString, URL(string: "/a/relative/path")?.absoluteString)
@@ -35,10 +35,10 @@ final class TemplatedURLTests: XCTestCase {
 }
 
 // MARK: - Codable
-extension TemplatedURLTests {
+extension URLTemplateTests {
     func test_encode() throws {
         let t1 = TemplatedURLWrapper(
-            url: TemplatedURL(rawValue: "https://website.com")
+            url: URLTemplate(rawValue: "https://website.com")
         )
 
         assertJSONEquivalent(
@@ -62,13 +62,13 @@ extension TemplatedURLTests {
 
         XCTAssertEqual(
             t1.url,
-            TemplatedURL(rawValue: "https://website.com")
+            URLTemplate(rawValue: "https://website.com")
         )
     }
 
     func test_encode_withVariables() throws {
         let t1 = TemplatedURLWrapper(
-            url: TemplatedURL(rawValue: "{scheme}://{host}.com")
+            url: URLTemplate(rawValue: "{scheme}://{host}.com")
         )
 
         assertJSONEquivalent(
@@ -92,11 +92,11 @@ extension TemplatedURLTests {
 
         XCTAssertEqual(
             t1.url,
-            TemplatedURL(rawValue: "{scheme}://{host}.com")
+            URLTemplate(rawValue: "{scheme}://{host}.com")
         )
     }
 }
 
 fileprivate struct TemplatedURLWrapper: Codable {
-    let url: TemplatedURL?
+    let url: URLTemplate?
 }

Tests/OpenAPIKitTests/Validator/ValidatorTests.swift

@@ -834,7 +834,7 @@ final class ValidatorTests: XCTestCase {
             .validating(
                 "At least two servers are specified on root Document if one of them is the test server.",
                 check: \.document.servers.count >= 2,
-                when: \OpenAPI.Server.urlTemplate == TemplatedURL(rawValue: "https://test.server.com")!
+                when: \OpenAPI.Server.urlTemplate == URLTemplate(rawValue: "https://test.server.com")!
                     && \.codingPath.first?.stringValue == "servers"
         )
 
@@ -851,7 +851,7 @@ final class ValidatorTests: XCTestCase {
             .validating(
                 "At least two servers are specified if one of them is the test server.",
                 check: \.document.servers.count >= 2,
-                when: \OpenAPI.Server.urlTemplate == TemplatedURL(rawValue: "https://test.server.com")!
+                when: \OpenAPI.Server.urlTemplate == URLTemplate(rawValue: "https://test.server.com")!
         )
 
         XCTAssertNoThrow(try document2.validate(using: validator2))