refactor: made minor updates in code and comments

htmlprogrammist · htmlprogrammist · commit 1a0025bfb568 · 2023-01-14T00:33:15.000+03:00
diff --git a/EmojiPicker.podspec b/EmojiPicker.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name = 'EmojiPicker'
-  s.version = '2.1.1'
+  s.version = '2.1.2'
   s.license = 'MIT'
   s.summary = 'Emoji picker for iOS like on MacOS'
   s.homepage = 'https://github.com/htmlprogrammist/EmojiPicker'
diff --git a/EmojiPicker.xcodeproj/project.pbxproj b/EmojiPicker.xcodeproj/project.pbxproj
@@ -7,6 +7,8 @@
 	objects = {
 
 /* Begin PBXBuildFile section */
+		F011B17E297202540088F3FA /* CODE_OF_CONDUCT.md in Resources */ = {isa = PBXBuildFile; fileRef = F011B17C297202540088F3FA /* CODE_OF_CONDUCT.md */; };
+		F011B17F297202540088F3FA /* CONTRIBUTING.md in Resources */ = {isa = PBXBuildFile; fileRef = F011B17D297202540088F3FA /* CONTRIBUTING.md */; };
 		F0A434F42971A0C200663826 /* EmojiPickerViewModelTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = F0A434F32971A0C200663826 /* EmojiPickerViewModelTests.swift */; };
 		F0A434F82971A0DC00663826 /* UnicodeManagerStub.swift in Sources */ = {isa = PBXBuildFile; fileRef = F0A434F62971A0DB00663826 /* UnicodeManagerStub.swift */; };
 		F0A434FA2971A3B900663826 /* ArrayExtensionTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = F0A434F92971A3B900663826 /* ArrayExtensionTests.swift */; };
@@ -57,6 +59,8 @@
 /* End PBXContainerItemProxy section */
 
 /* Begin PBXFileReference section */
+		F011B17C297202540088F3FA /* CODE_OF_CONDUCT.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = net.daringfireball.markdown; path = CODE_OF_CONDUCT.md; sourceTree = "<group>"; };
+		F011B17D297202540088F3FA /* CONTRIBUTING.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = net.daringfireball.markdown; path = CONTRIBUTING.md; sourceTree = "<group>"; };
 		F0A434F32971A0C200663826 /* EmojiPickerViewModelTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = EmojiPickerViewModelTests.swift; sourceTree = "<group>"; };
 		F0A434F62971A0DB00663826 /* UnicodeManagerStub.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UnicodeManagerStub.swift; sourceTree = "<group>"; };
 		F0A434F92971A3B900663826 /* ArrayExtensionTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ArrayExtensionTests.swift; sourceTree = "<group>"; };
@@ -139,6 +143,8 @@
 				F0BB7EC6297157D3004EEBFC /* Tests */,
 				F0BB7ED9297158BC004EEBFC /* EmojiPicker.podspec */,
 				F0BB7F34297169E4004EEBFC /* LICENSE */,
+				F011B17C297202540088F3FA /* CODE_OF_CONDUCT.md */,
+				F011B17D297202540088F3FA /* CONTRIBUTING.md */,
 				F0BB7EBB297157D3004EEBFC /* Products */,
 			);
 			sourceTree = "<group>";
@@ -377,6 +383,7 @@
 					};
 					F0BB7EC1297157D3004EEBFC = {
 						CreatedOnToolsVersion = 13.4.1;
+						LastSwiftMigration = 1340;
 					};
 				};
 			};
@@ -411,7 +418,9 @@
 			files = (
 				F0BB7ED829715831004EEBFC /* README.md in Resources */,
 				F0BB7F18297159A6004EEBFC /* Localizable.strings in Resources */,
+				F011B17F297202540088F3FA /* CONTRIBUTING.md in Resources */,
 				F0BB7F35297169E5004EEBFC /* LICENSE in Resources */,
+				F011B17E297202540088F3FA /* CODE_OF_CONDUCT.md in Resources */,
 				F0BB7EDB297158BD004EEBFC /* EmojiPicker.podspec in Resources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
diff --git a/EmojiPicker.xcodeproj/project.xcworkspace/xcuserdata/egbad.xcuserdatad/UserInterfaceState.xcuserstate b/EmojiPicker.xcodeproj/project.xcworkspace/xcuserdata/egbad.xcuserdatad/UserInterfaceState.xcuserstate
diff --git a/Example App/AppImport/Package.swift b/Example App/AppImport/Package.swift
@@ -11,7 +11,7 @@ let package = Package(
             targets: ["AppImport"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/htmlprogrammist/EmojiPicker", .upToNextMajor(from: "2.1.1"))
+        .package(url: "https://github.com/htmlprogrammist/EmojiPicker", .upToNextMajor(from: "2.1.2"))
     ],
     targets: [
         .target(
diff --git a/Example App/iOS Example.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved b/Example App/iOS Example.xcodeproj/project.xcworkspace/xcshareddata/swiftpm/Package.resolved
diff --git a/Example App/iOS Example.xcodeproj/project.xcworkspace/xcuserdata/egbad.xcuserdatad/UserInterfaceState.xcuserstate b/Example App/iOS Example.xcodeproj/project.xcworkspace/xcuserdata/egbad.xcuserdatad/UserInterfaceState.xcuserstate
diff --git a/Sources/EmojiPicker/ViewModel/EmojiPickerViewModel.swift b/Sources/EmojiPicker/ViewModel/EmojiPickerViewModel.swift
@@ -21,7 +21,7 @@
 
 import Foundation
 
-/// Protocol for the ViewModel which using in EmojiPickerViewController.
+/// Protocol for a ViewModel which is being used in `EmojiPickerViewController`.
 protocol EmojiPickerViewModelProtocol {
     /// The observed variable that is responsible for the choice of emoji.
     var selectedEmoji: Observable<String> { get set }
@@ -37,10 +37,12 @@ protocol EmojiPickerViewModelProtocol {
     func sectionHeaderViewModel(for section: Int) -> String
 }
 
-/// ViewModel which using in EmojiPickerViewController.
+/// Emoji Picker view model.
 final class EmojiPickerViewModel: EmojiPickerViewModelProtocol {
     
+    /// Observable object of selected emoji.
     var selectedEmoji = Observable<String>(value: "")
+    /// Observable object of selected category index of an emoji.
     var selectedEmojiCategoryIndex = Observable<Int>(value: 0)
     
     /// All emoji categories.
diff --git a/Sources/EmojiPicker/Views/EmojiCollectionViewCell.swift b/Sources/EmojiPicker/Views/EmojiCollectionViewCell.swift
@@ -23,12 +23,6 @@ import UIKit
 
 final class EmojiCollectionViewCell: UICollectionViewCell {
     
-    var emoji: String? {
-        didSet {
-            emojiLabel.text = emoji
-        }
-    }
-    
     // MARK: - Private Properties
     
     private let emojiLabel: UILabel = {
@@ -51,6 +45,12 @@ final class EmojiCollectionViewCell: UICollectionViewCell {
         fatalError("init(coder:) has not been implemented")
     }
     
+    // MARK: - Public Methods
+    
+    public func configure(with emoji: String) {
+        emojiLabel.text = emoji
+    }
+    
     // MARK: - Private Methods
     
     private func setupLayout() {
diff --git a/Sources/EmojiPicker/Views/EmojiCollectionViewHeader.swift b/Sources/EmojiPicker/Views/EmojiCollectionViewHeader.swift
@@ -23,12 +23,6 @@ import UIKit
 
 final class EmojiCollectionViewHeader: UICollectionReusableView {
     
-    var categoryName: String = "" {
-        didSet {
-            headerLabel.text = categoryName
-        }
-    }
-    
     // MARK: - Private Properties
     
     private let headerLabel: UILabel = {
@@ -51,6 +45,12 @@ final class EmojiCollectionViewHeader: UICollectionReusableView {
         fatalError("init(coder:) has not been implemented")
     }
     
+    // MARK: - Public Methods
+    
+    public func configure(with text: String) {
+        headerLabel.text = text
+    }
+    
     // MARK: - Private Methods
     
     private func setupLayout() {
diff --git a/Sources/EmojiPicker/Views/EmojiPickerView.swift b/Sources/EmojiPicker/Views/EmojiPickerView.swift
@@ -31,6 +31,8 @@ protocol EmojiPickerViewDelegate: AnyObject {
 
 final class EmojiPickerView: UIView {
     
+    // MARK: - Internal Properties
+    
     weak var delegate: EmojiPickerViewDelegate?
     
     var selectedEmojiCategoryTintColor: UIColor = .systemBlue
diff --git a/Sources/EmojiPicker/Views/EmojiPickerViewController.swift b/Sources/EmojiPicker/Views/EmojiPickerViewController.swift
@@ -21,35 +21,50 @@
 
 import UIKit
 
+/// Delegate protocol to match user interaction with emoji picker.
 public protocol EmojiPickerDelegate: AnyObject {
+    /// Provides chosen emoji.
+    ///
+    /// - Parameter emoji: String emoji.
     func didGetEmoji(emoji: String)
 }
 
+/// Emoji Picker view controller. 
 public final class EmojiPickerViewController: UIViewController {
-    /// Delegate for selecting an emoji object
-    public weak var delegate: EmojiPickerDelegate?
+    
+    // MARK: - Internal Properties
+    
+    /// Delegate for selecting an emoji object.
+    weak var delegate: EmojiPickerDelegate?
+    
+    /// The view containing the anchor rectangle for the popover.
+    var sourceView: UIView? {
+        didSet {
+            popoverPresentationController?.sourceView = sourceView
+        }
+    }
     
     /**
      The direction of the arrow for EmojiPicker.
      
      - Note: The default value of this property is `.up`.
      */
-    public var arrowDirection: PickerArrowDirectionMode
+    let arrowDirection: PickerArrowDirectionMode
     
     /**
      Custom height for EmojiPicker.
      
      - Note: The default value of this property is `nil`.
      - Important: it will be limited by the distance from `sourceView.origin.y` to the upper or lower bound(depends on `permittedArrowDirections`).
      */
-    public var customHeight: CGFloat?
+    let customHeight: CGFloat?
     
     /**
      Inset from the sourceView border.
      
      - Note: The default value of this property is `0`.
      */
-    public var horizontalInset: CGFloat
+    let horizontalInset: CGFloat
     
     /**
      A boolean value that determines whether the screen will be hidden after the emoji is selected.
@@ -59,33 +74,26 @@ public final class EmojiPickerViewController: UIViewController {
      
      - Note: The default value of this property is `true`.
      */
-    public var isDismissAfterChoosing: Bool
+    let isDismissAfterChoosing: Bool
     
     /**
      Color for the selected emoji category.
      
      - Note: The default value of this property is `.systemBlue`.
      */
-    public var selectedEmojiCategoryTintColor: UIColor? {
+    var selectedEmojiCategoryTintColor: UIColor? {
         didSet {
             guard let selectedEmojiCategoryTintColor = selectedEmojiCategoryTintColor else { return }
             emojiPickerView.selectedEmojiCategoryTintColor = selectedEmojiCategoryTintColor
         }
     }
     
-    /// The view containing the anchor rectangle for the popover
-    public var sourceView: UIView? {
-        didSet {
-            popoverPresentationController?.sourceView = sourceView
-        }
-    }
-    
     /**
      Feedback generator style. To turn off, set `nil` to this parameter.
      
      - Note: The default value of this property is `.light`.
      */
-    public var feedBackGeneratorStyle: UIImpactFeedbackGenerator.FeedbackStyle? {
+    var feedBackGeneratorStyle: UIImpactFeedbackGenerator.FeedbackStyle? {
         didSet {
             guard let feedBackGeneratorStyle = feedBackGeneratorStyle else {
                 generator = nil
@@ -95,10 +103,14 @@ public final class EmojiPickerViewController: UIViewController {
         }
     }
     
+    // MARK: - Private Properties
+    
     private let emojiPickerView = EmojiPickerView()
     private var generator: UIImpactFeedbackGenerator?
     private var viewModel: EmojiPickerViewModelProtocol
     
+    // MARK: - Init
+    
     /// Creates EmojiPicker view controller with provided configuration.
     public init(configuration: Configuration) {
         arrowDirection = configuration.arrowDirection
@@ -208,7 +220,7 @@ extension EmojiPickerViewController: UICollectionViewDataSource, UICollectionVie
         guard let cell = collectionView.dequeueReusableCell(withReuseIdentifier: EmojiCollectionViewCell.identifier, for: indexPath) as? EmojiCollectionViewCell
         else { return UICollectionViewCell() }
         
-        cell.emoji = viewModel.emoji(at: indexPath)
+        cell.configure(with: viewModel.emoji(at: indexPath))
         return cell
     }
     
@@ -217,7 +229,8 @@ extension EmojiPickerViewController: UICollectionViewDataSource, UICollectionVie
         case UICollectionView.elementKindSectionHeader:
             guard let sectionHeader = collectionView.dequeueReusableSupplementaryView(ofKind: kind, withReuseIdentifier: EmojiCollectionViewHeader.identifier, for: indexPath) as? EmojiCollectionViewHeader
             else { return UICollectionReusableView() }
-            sectionHeader.categoryName = viewModel.sectionHeaderViewModel(for: indexPath.section)
+            
+            sectionHeader.configure(with: viewModel.sectionHeaderViewModel(for: indexPath.section))
             return sectionHeader
         default:
             return UICollectionReusableView()
