Renamed func currentSender() -> SenderType to var currentSender: SenderType (MessageKit#1714)

martinpucik · Patrick-Kladek · commit c31bbe678a07 · 2023-10-24T20:43:15.000+08:00
* refactor: Renamed `func currentSender() -&gt; SenderType` to `var currentSender: SenderType`

* refactor: Renamed `func currentSender() -&gt; SenderType` to `var currentSender: SenderType`

Changelog
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,6 +16,7 @@ See [MIGRATION_GUIDE.md](https://github.com/MessageKit/MessageKit/blob/main/Docu
 - **Breaking change**: Dropped CocoaPods support
 - **Breaking change**: Dropped support for iOS 12 [2bd234b](https://github.com/MessageKit/MessageKit/commit/2bd234b1e878f392089f166d6868ce644d6c9e95) by [@martinpucik](https://github.com/martinpucik)
 - **Breaking change**: Moved messageInputBar from inputAccessoryView to a subview in MessagesViewController [#1704](https://github.com/MessageKit/MessageKit/pull/1704) by [@martinpucik](https://github.com/martinpucik)
+- **Breaking change**: Renamed `func currentSender() -> SenderType` to `var currentSender: SenderType` [#1714](https://github.com/MessageKit/MessageKit/pull/1714) by [@martinpucik](https://github.com/martinpucik)
 - **Deprecation**: Deprecated `maintainPositionOnKeyboardFrameChangedMoved` in favor of `maintainPositionOnInputBarHeightChanged` which better describes the intended use of this property [#1704](https://github.com/MessageKit/MessageKit/pull/1705) by [@martinpucik](https://github.com/martinpucik)
 - **Breaking change**: Added an argument to `messageContainerMaxWidth` [cd4f75b](https://github.com/MessageKit/MessageKit/commit/cd4f75b561129fc25e6c4576000e5a92ccd81cad) by [@martinpucik](https://github.com/martinpucik)
     ```swift
diff --git a/Documentation/FAQs.md b/Documentation/FAQs.md
@@ -109,7 +109,7 @@ func didTapMessage(in cell: MessageCollectionViewCell) {
 
 ## Animations are laggy/Scrolling is not smooth/General poor performance
 
-In general, if you're experiencing performance issues, you should look through the implementation of your MessageKit delegate methods like `currentSender()`, etc to find any expensive/blocking method calls or operations. Some delegate methods are called many times per message rendered and thus if their implementations are not efficient then performance can significantly degrade. Avoid doing blocking activities like synchronous database lookups, keychain access, networking, etc. in your MessageKit delegate methods. You should instead cache what you need.
+In general, if you're experiencing performance issues, you should look through the implementation of your MessageKit delegate methods like `var currentSender`, etc to find any expensive/blocking method calls or operations. Some delegate methods are called many times per message rendered and thus if their implementations are not efficient then performance can significantly degrade. Avoid doing blocking activities like synchronous database lookups, keychain access, networking, etc. in your MessageKit delegate methods. You should instead cache what you need.
 
 ## How can I use MessageKit with SwiftUI?
 
diff --git a/Documentation/QuickStart.md b/Documentation/QuickStart.md
@@ -105,7 +105,7 @@ let messages: [MessageType] = []
 
 extension ChatViewController: MessagesDataSource {
 
-	func currentSender() -> SenderType {
+	var currentSender: SenderType {
 		return Sender(senderId: "any_unique_id", displayName: "Steven")
 	}
 
diff --git a/Example/Sources/View Controllers/AdvancedExampleViewController.swift b/Example/Sources/View Controllers/AdvancedExampleViewController.swift
@@ -467,7 +467,7 @@ extension AdvancedExampleViewController: CameraInputBarAccessoryViewDelegate {
     
     func sendImageMessage( photo  : UIImage)  {
        
-        let photoMessage = MockMessage(image: photo, user: self.currentSender() as! MockUser, messageId: UUID().uuidString, date: Date())
+        let photoMessage = MockMessage(image: photo, user: self.currentSender as! MockUser, messageId: UUID().uuidString, date: Date())
         self.insertMessage(photoMessage)
     }
     
diff --git a/Example/Sources/View Controllers/ChatViewController.swift b/Example/Sources/View Controllers/ChatViewController.swift
@@ -152,7 +152,7 @@ class ChatViewController: MessagesViewController, MessagesDataSource {
 
     // MARK: - MessagesDataSource
 
-    func currentSender() -> SenderType {
+    var currentSender: SenderType {
         return SampleData.shared.currentSender
     }
 
diff --git a/Example/Sources/Views/SwiftUI/MessagesView.swift b/Example/Sources/Views/SwiftUI/MessagesView.swift
@@ -89,7 +89,7 @@ struct MessagesView: UIViewControllerRepresentable {
 }
 
 extension MessagesView.Coordinator: MessagesDataSource {
-    func currentSender() -> SenderType {
+    var currentSender: SenderType {
         return SampleData.shared.currentSender
     }
     
diff --git a/Sources/Protocols/MessagesDataSource.swift b/Sources/Protocols/MessagesDataSource.swift
@@ -29,7 +29,7 @@ import UIKit
 public protocol MessagesDataSource: AnyObject {
 
     /// The `SenderType` of new messages in the `MessagesCollectionView`.
-    func currentSender() -> SenderType
+    var currentSender: SenderType { get }
 
     /// A helper method to determine if a given message is from the current `SenderType`.
     ///
@@ -192,7 +192,7 @@ public protocol MessagesDataSource: AnyObject {
 public extension MessagesDataSource {
 
     func isFromCurrentSender(message: MessageType) -> Bool {
-        return message.sender.senderId == currentSender().senderId
+        return message.sender.senderId == currentSender.senderId
     }
 
     func numberOfItems(inSection section: Int, in messagesCollectionView: MessagesCollectionView) -> Int {
diff --git a/Tests/MessageKitTests/Mocks/MockMessagesDataSource.swift b/Tests/MessageKitTests/Mocks/MockMessagesDataSource.swift
@@ -37,7 +37,7 @@ class MockMessagesDataSource: MessagesDataSource {
         return senders[0]
     }
 
-    func currentSender() -> SenderType {
+    var currentSender: SenderType {
         return currentUser
     }
 

Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ let messages: [MessageType] = []`
`105`	`105`
`106`	`106`	`extension ChatViewController: MessagesDataSource {`
`107`	`107`
`108`		`- func currentSender() -> SenderType {`
	`108`	`+ var currentSender: SenderType {`
`109`	`109`	`return Sender(senderId: "any_unique_id", displayName: "Steven")`
`110`	`110`	`}`
`111`	`111`
Original file line number	Diff line number	Diff line change
`@@ -467,7 +467,7 @@ extension AdvancedExampleViewController: CameraInputBarAccessoryViewDelegate {`
`467`	`467`
`468`	`468`	`func sendImageMessage( photo : UIImage) {`
`469`	`469`
`470`		`- let photoMessage = MockMessage(image: photo, user: self.currentSender() as! MockUser, messageId: UUID().uuidString, date: Date())`
	`470`	`+ let photoMessage = MockMessage(image: photo, user: self.currentSender as! MockUser, messageId: UUID().uuidString, date: Date())`
`471`	`471`	`self.insertMessage(photoMessage)`
`472`	`472`	`}`
`473`	`473`
Original file line number	Diff line number	Diff line change
`@@ -152,7 +152,7 @@ class ChatViewController: MessagesViewController, MessagesDataSource {`
`152`	`152`
`153`	`153`	`// MARK: - MessagesDataSource`
`154`	`154`
`155`		`- func currentSender() -> SenderType {`
	`155`	`+ var currentSender: SenderType {`
`156`	`156`	`return SampleData.shared.currentSender`
`157`	`157`	`}`
`158`	`158`
Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,7 @@ struct MessagesView: UIViewControllerRepresentable {`
`89`	`89`	`}`
`90`	`90`
`91`	`91`	`extension MessagesView.Coordinator: MessagesDataSource {`
`92`		`- func currentSender() -> SenderType {`
	`92`	`+ var currentSender: SenderType {`
`93`	`93`	`return SampleData.shared.currentSender`
`94`	`94`	`}`
`95`	`95`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ class MockMessagesDataSource: MessagesDataSource {`
`37`	`37`	`return senders[0]`
`38`	`38`	`}`
`39`	`39`
`40`		`- func currentSender() -> SenderType {`
	`40`	`+ var currentSender: SenderType {`
`41`	`41`	`return currentUser`
`42`	`42`	`}`
`43`	`43`