test(postgrest): increase code coverage (#651)

* test(postgrest): increase code coverage

* move deprecated code to Deprecated.swift file

Author: grdsdev

.swiftpm/xcode/xcshareddata/xcschemes/PostgREST.xcscheme

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <Scheme
    LastUpgradeVersion = "1510"
-   version = "1.7">
+   version = "1.3">
    <BuildAction
       parallelizeBuildables = "YES"
       buildImplicitDependencies = "YES">
@@ -26,8 +26,29 @@
       buildConfiguration = "Debug"
       selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB"
       selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB"
-      shouldUseLaunchSchemeArgsEnv = "YES">
+      shouldUseLaunchSchemeArgsEnv = "YES"
+      codeCoverageEnabled = "YES"
+      onlyGenerateCoverageForSpecifiedTargets = "YES">
+      <CodeCoverageTargets>
+         <BuildableReference
+            BuildableIdentifier = "primary"
+            BlueprintIdentifier = "PostgREST"
+            BuildableName = "PostgREST"
+            BlueprintName = "PostgREST"
+            ReferencedContainer = "container:">
+         </BuildableReference>
+      </CodeCoverageTargets>
       <Testables>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "PostgRESTTests"
+               BuildableName = "PostgRESTTests"
+               BlueprintName = "PostgRESTTests"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </TestableReference>
       </Testables>
    </TestAction>
    <LaunchAction

Sources/PostgREST/Deprecated.swift

@@ -23,7 +23,8 @@ extension PostgrestClient.Configuration {
   @available(
     *,
     deprecated,
-    message: "Replace usages of this initializer with new init(url:schema:headers:logger:fetch:encoder:decoder:)"
+    message:
+      "Replace usages of this initializer with new init(url:schema:headers:logger:fetch:encoder:decoder:)"
   )
   public init(
     url: URL,
@@ -57,7 +58,8 @@ extension PostgrestClient {
   @available(
     *,
     deprecated,
-    message: "Replace usages of this initializer with new init(url:schema:headers:logger:fetch:encoder:decoder:)"
+    message:
+      "Replace usages of this initializer with new init(url:schema:headers:logger:fetch:encoder:decoder:)"
   )
   public convenience init(
     url: URL,
@@ -78,3 +80,57 @@ extension PostgrestClient {
     )
   }
 }
+
+extension PostgrestFilterBuilder {
+
+  @available(*, deprecated, renamed: "like(_:pattern:)")
+  public func like(
+    _ column: String,
+    value: any URLQueryRepresentable
+  ) -> PostgrestFilterBuilder {
+    like(column, pattern: value)
+  }
+
+  @available(*, deprecated, renamed: "in(_:values:)")
+  public func `in`(
+    _ column: String,
+    value: [any URLQueryRepresentable]
+  ) -> PostgrestFilterBuilder {
+    `in`(column, values: value)
+  }
+
+  @available(*, deprecated, message: "Use textSearch(_:query:config:type) with .plain type.")
+  public func plfts(
+    _ column: String,
+    query: any URLQueryRepresentable,
+    config: String? = nil
+  ) -> PostgrestFilterBuilder {
+    textSearch(column, query: query, config: config, type: .plain)
+  }
+
+  @available(*, deprecated, message: "Use textSearch(_:query:config:type) with .phrase type.")
+  public func phfts(
+    _ column: String,
+    query: any URLQueryRepresentable,
+    config: String? = nil
+  ) -> PostgrestFilterBuilder {
+    textSearch(column, query: query, config: config, type: .phrase)
+  }
+
+  @available(*, deprecated, message: "Use textSearch(_:query:config:type) with .websearch type.")
+  public func wfts(
+    _ column: String,
+    query: any URLQueryRepresentable,
+    config: String? = nil
+  ) -> PostgrestFilterBuilder {
+    textSearch(column, query: query, config: config, type: .websearch)
+  }
+
+  @available(*, deprecated, renamed: "ilike(_:pattern:)")
+  public func ilike(
+    _ column: String,
+    value: any URLQueryRepresentable
+  ) -> PostgrestFilterBuilder {
+    ilike(column, pattern: value)
+  }
+}

Sources/PostgREST/PostgrestBuilder.swift

@@ -106,11 +106,7 @@ public class PostgrestBuilder: @unchecked Sendable {
       }
 
       if let count = $0.fetchOptions.count {
-        if let prefer = $0.request.headers[.prefer] {
-          $0.request.headers[.prefer] = "\(prefer),count=\(count.rawValue)"
-        } else {
-          $0.request.headers[.prefer] = "count=\(count.rawValue)"
-        }
+        $0.request.headers.appendOrUpdate(.prefer, value: "count=\(count.rawValue)")
       }
 
       if $0.request.headers[.accept] == nil {

Sources/PostgREST/PostgrestFilterBuilder.swift

@@ -4,7 +4,7 @@ import Helpers
 public class PostgrestFilterBuilder: PostgrestTransformBuilder, @unchecked Sendable {
   public enum Operator: String, CaseIterable, Sendable {
     case eq, neq, gt, gte, lt, lte, like, ilike, `is`, `in`, cs, cd, sl, sr, nxl, nxr, adj, ov, fts,
-         plfts, phfts, wfts
+      plfts, phfts, wfts
   }
 
   // MARK: - Filters
@@ -17,10 +17,11 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder, @unchecked Senda
     let queryValue = value.queryValue
 
     mutableState.withValue {
-      $0.request.query.append(URLQueryItem(
-        name: column,
-        value: "not.\(op.rawValue).\(queryValue)"
-      ))
+      $0.request.query.append(
+        URLQueryItem(
+          name: column,
+          value: "not.\(op.rawValue).\(queryValue)"
+        ))
     }
 
     return self
@@ -152,14 +153,6 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder, @unchecked Senda
     return self
   }
 
-  @available(*, deprecated, renamed: "like(_:pattern:)")
-  public func like(
-    _ column: String,
-    value: any URLQueryRepresentable
-  ) -> PostgrestFilterBuilder {
-    like(column, pattern: value)
-  }
-
   /// Match only rows where `column` matches all of `patterns` case-sensitively.
   /// - Parameters:
   ///   - column: The column to filter on
@@ -206,14 +199,6 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder, @unchecked Senda
     return self
   }
 
-  @available(*, deprecated, renamed: "ilike(_:pattern:)")
-  public func ilike(
-    _ column: String,
-    value: any URLQueryRepresentable
-  ) -> PostgrestFilterBuilder {
-    ilike(column, pattern: value)
-  }
-
   /// Match only rows where `column` matches all of `patterns` case-insensitively.
   /// - Parameters:
   ///   - column: The column to filter on
@@ -284,14 +269,6 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder, @unchecked Senda
     return self
   }
 
-  @available(*, deprecated, renamed: "in(_:values:)")
-  public func `in`(
-    _ column: String,
-    value: [any URLQueryRepresentable]
-  ) -> PostgrestFilterBuilder {
-    `in`(column, values: value)
-  }
-
   /// Match only rows where `column` contains every element appearing in `value`.
   ///
   /// Only relevant for jsonb, array, and range columns.
@@ -472,33 +449,6 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder, @unchecked Senda
     textSearch(column, query: query, config: config, type: nil)
   }
 
-  @available(*, deprecated, message: "Use textSearch(_:query:config:type) with .plain type.")
-  public func plfts(
-    _ column: String,
-    query: any URLQueryRepresentable,
-    config: String? = nil
-  ) -> PostgrestFilterBuilder {
-    textSearch(column, query: query, config: config, type: .plain)
-  }
-
-  @available(*, deprecated, message: "Use textSearch(_:query:config:type) with .phrase type.")
-  public func phfts(
-    _ column: String,
-    query: any URLQueryRepresentable,
-    config: String? = nil
-  ) -> PostgrestFilterBuilder {
-    textSearch(column, query: query, config: config, type: .phrase)
-  }
-
-  @available(*, deprecated, message: "Use textSearch(_:query:config:type) with .websearch type.")
-  public func wfts(
-    _ column: String,
-    query: any URLQueryRepresentable,
-    config: String? = nil
-  ) -> PostgrestFilterBuilder {
-    textSearch(column, query: query, config: config, type: .websearch)
-  }
-
   /// Match only rows which satisfy the filter. This is an escape hatch - you should use the specific filter methods wherever possible.
   ///
   /// Unlike most filters, `opearator` and `value` are used as-is and need to follow [PostgREST syntax](https://postgrest.org/en/stable/api.html#operators). You also need to make sure they are properly sanitized.
@@ -513,10 +463,11 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder, @unchecked Senda
     value: String
   ) -> PostgrestFilterBuilder {
     mutableState.withValue {
-      $0.request.query.append(URLQueryItem(
-        name: column,
-        value: "\(`operator`).\(value)"
-      ))
+      $0.request.query.append(
+        URLQueryItem(
+          name: column,
+          value: "\(`operator`).\(value)"
+        ))
     }
     return self
   }
@@ -530,10 +481,11 @@ public class PostgrestFilterBuilder: PostgrestTransformBuilder, @unchecked Senda
     let query = query.mapValues(\.queryValue)
     mutableState.withValue { mutableState in
       for (key, value) in query {
-        mutableState.request.query.append(URLQueryItem(
-          name: key,
-          value: "eq.\(value.queryValue)"
-        ))
+        mutableState.request.query.append(
+          URLQueryItem(
+            name: key,
+            value: "eq.\(value.queryValue)"
+          ))
       }
     }
     return self

Sources/PostgREST/PostgrestTransformBuilder.swift

@@ -23,20 +23,7 @@ public class PostgrestTransformBuilder: PostgrestBuilder, @unchecked Sendable {
     .joined(separator: "")
     mutableState.withValue {
       $0.request.query.appendOrUpdate(URLQueryItem(name: "select", value: cleanedColumns))
-
-      if let prefer = $0.request.headers[.prefer] {
-        var components = prefer.components(separatedBy: ",")
-
-        if let index = components.firstIndex(where: { $0.hasPrefix("return=") }) {
-          components[index] = "return=representation"
-        } else {
-          components.append("return=representation")
-        }
-
-        $0.request.headers[.prefer] = components.joined(separator: ",")
-      } else {
-        $0.request.headers[.prefer] = "return=representation"
-      }
+      $0.request.headers.appendOrUpdate(.prefer, value: "return=representation")
     }
     return self
   }
@@ -64,7 +51,7 @@ public class PostgrestTransformBuilder: PostgrestBuilder, @unchecked Sendable {
         "\(column).\(ascending ? "asc" : "desc").\(nullsFirst ? "nullsfirst" : "nullslast")"
 
       if let existingOrderIndex,
-         let currentValue = $0.request.query[existingOrderIndex].value
+        let currentValue = $0.request.query[existingOrderIndex].value
       {
         $0.request.query[existingOrderIndex] = URLQueryItem(
           name: key,
@@ -85,11 +72,7 @@ public class PostgrestTransformBuilder: PostgrestBuilder, @unchecked Sendable {
   public func limit(_ count: Int, referencedTable: String? = nil) -> PostgrestTransformBuilder {
     mutableState.withValue {
       let key = referencedTable.map { "\($0).limit" } ?? "limit"
-      if let index = $0.request.query.firstIndex(where: { $0.name == key }) {
-        $0.request.query[index] = URLQueryItem(name: key, value: "\(count)")
-      } else {
-        $0.request.query.append(URLQueryItem(name: key, value: "\(count)"))
-      }
+      $0.request.query.appendOrUpdate(URLQueryItem(name: key, value: "\(count)"))
     }
     return self
   }
@@ -113,24 +96,10 @@ public class PostgrestTransformBuilder: PostgrestBuilder, @unchecked Sendable {
     let keyLimit = referencedTable.map { "\($0).limit" } ?? "limit"
 
     mutableState.withValue {
-      if let index = $0.request.query.firstIndex(where: { $0.name == keyOffset }) {
-        $0.request.query[index] = URLQueryItem(name: keyOffset, value: "\(from)")
-      } else {
-        $0.request.query.append(URLQueryItem(name: keyOffset, value: "\(from)"))
-      }
+      $0.request.query.appendOrUpdate(URLQueryItem(name: keyOffset, value: "\(from)"))
 
       // Range is inclusive, so add 1
-      if let index = $0.request.query.firstIndex(where: { $0.name == keyLimit }) {
-        $0.request.query[index] = URLQueryItem(
-          name: keyLimit,
-          value: "\(to - from + 1)"
-        )
-      } else {
-        $0.request.query.append(URLQueryItem(
-          name: keyLimit,
-          value: "\(to - from + 1)"
-        ))
-      }
+      $0.request.query.appendOrUpdate(URLQueryItem(name: keyLimit, value: "\(to - from + 1)"))
     }
 
     return self
@@ -195,7 +164,8 @@ public class PostgrestTransformBuilder: PostgrestBuilder, @unchecked Sendable {
       .compactMap { $0 }
       .joined(separator: "|")
       let forMediaType = $0.request.headers[.accept] ?? "application/json"
-      $0.request.headers[.accept] = "application/vnd.pgrst.plan+\"\(format)\"; for=\(forMediaType); options=\(options);"
+      $0.request.headers[.accept] =
+        "application/vnd.pgrst.plan+\"\(format)\"; for=\(forMediaType); options=\(options);"
     }
 
     return self

Sources/PostgREST/URLQueryRepresentable.swift

@@ -68,20 +68,15 @@ extension Optional: URLQueryRepresentable where Wrapped: URLQueryRepresentable {
 extension JSONObject: URLQueryRepresentable {
   public var queryValue: String {
     let value = mapValues(\.value)
-    return JSONSerialization.stringfy(value)
+    return JSONSerialization.stringfy(value)!
   }
 }
 
 extension JSONSerialization {
-  static func stringfy(_ object: Any) -> String {
-    guard
-      let data = try? data(
-        withJSONObject: object, options: [.withoutEscapingSlashes, .sortedKeys]
-      ),
-      let string = String(data: data, encoding: .utf8)
-    else {
-      return "{}"
-    }
-    return string
+  static func stringfy(_ object: Any) -> String? {
+    let data = try? data(
+      withJSONObject: object, options: [.withoutEscapingSlashes, .sortedKeys]
+    )
+    return data.flatMap { String(data: $0, encoding: .utf8) }
   }
 }