rename substring

Author: cherylEnkidu

Firestore/Swift/Source/ExpressionImplementation.swift

@@ -671,20 +671,20 @@ public extension Expression {
     return FunctionExpression("byte_length", [self])
   }
 
-  func substr(position: Int, length: Int? = nil) -> FunctionExpression {
+  func substring(position: Int, length: Int? = nil) -> FunctionExpression {
     let positionExpr = Helper.sendableToExpr(position)
     if let length = length {
-      return FunctionExpression("substr", [self, positionExpr, Helper.sendableToExpr(length)])
+      return FunctionExpression("substring", [self, positionExpr, Helper.sendableToExpr(length)])
     } else {
-      return FunctionExpression("substr", [self, positionExpr])
+      return FunctionExpression("substring", [self, positionExpr])
     }
   }
 
-  func substr(position: Expression, length: Expression? = nil) -> FunctionExpression {
+  func substring(position: Expression, length: Expression? = nil) -> FunctionExpression {
     if let length = length {
-      return FunctionExpression("substr", [self, position, length])
+      return FunctionExpression("substring", [self, position, length])
     } else {
-      return FunctionExpression("substr", [self, position])
+      return FunctionExpression("substring", [self, position])
     }
   }
 

Firestore/Swift/Source/SwiftAPI/Pipeline/Expressions/Expression.swift

@@ -953,16 +953,16 @@ public protocol Expression: Sendable {
   ///
   /// ```swift
   /// // Get substring from index 5 with length 10
-  /// Field("myString").substr(5, 10)
+  /// Field("myString").substring(5, 10)
   ///
   /// // Get substring from "myString" starting at index 3 to the end
-  /// Field("myString").substr(3, nil)
+  /// Field("myString").substring(3, nil)
   /// ```
   ///
   /// - Parameter position: Literal `Int` index of the first character/byte.
   /// - Parameter length: Optional literal `Int` length of the substring. If `nil`, goes to the end.
   /// - Returns: A new `FunctionExpr` representing the substring.
-  func substr(position: Int, length: Int?) -> FunctionExpression
+  func substring(position: Int, length: Int?) -> FunctionExpression
 
   /// Creates an expression that returns a substring of this expression (String or Bytes) using
   /// expressions for position and optional length.
@@ -973,18 +973,18 @@ public protocol Expression: Sendable {
   ///
   /// ```swift
   /// // Get substring from index calculated by Field("start") with length from Field("len")
-  /// Field("myString").substr(Field("start"), Field("len"))
+  /// Field("myString").substring(Field("start"), Field("len"))
   ///
   /// // Get substring from index calculated by Field("start") to the end
-  /// Field("myString").substr(Field("start"), nil) // Passing nil for optional Expr length
+  /// Field("myString").substring(Field("start"), nil) // Passing nil for optional Expr length
   /// ```
   ///
   /// - Parameter position: An `Expr` (evaluating to an Int) for the index of the first
   /// character/byte.
   /// - Parameter length: Optional `Expr` (evaluating to an Int) for the length of the substring. If
   /// `nil`, goes to the end.
   /// - Returns: A new `FunctionExpr` representing the substring.
-  func substr(position: Expression, length: Expression?) -> FunctionExpression
+  func substring(position: Expression, length: Expression?) -> FunctionExpression
 
   // MARK: Map Operations
 

Firestore/Swift/Tests/Integration/PipelineTests.swift

@@ -3216,30 +3216,28 @@ class PipelineIntegrationTests: FSTIntegrationTestCase {
     )
   }
 
-  func testSubstr() async throws {
-    try XCTSkipIf(true, "Skip this test since backend has not yet supported.")
+  func testSubstring() async throws {
     let collRef = collectionRef(withDocuments: bookDocs)
     let db = collRef.firestore
 
     let pipeline = db.pipeline()
       .collection(collRef.path)
       .sort([Field("rating").descending()])
       .limit(1)
-      .select([Field("title").substr(position: 9, length: 2).as("of")])
+      .select([Field("title").substring(position: 9, length: 2).as("of")])
     let snapshot = try await pipeline.execute()
     TestHelper.compare(pipelineSnapshot: snapshot, expected: [["of": "of"]], enforceOrder: false)
   }
 
-  func testSubstrWithoutLength() async throws {
-    try XCTSkipIf(true, "Skip this test since backend has not yet supported.")
+  func testSubstringWithoutLength() async throws {
     let collRef = collectionRef(withDocuments: bookDocs)
     let db = collRef.firestore
 
     let pipeline = db.pipeline()
       .collection(collRef.path)
       .sort([Field("rating").descending()])
       .limit(1)
-      .select([Field("title").substr(position: 9).as("of")])
+      .select([Field("title").substring(position: 9).as("of")])
     let snapshot = try await pipeline.execute()
     TestHelper.compare(
       pipelineSnapshot: snapshot,