refactor: add comments and made minor updates

Author: htmlprogrammist

EmojiPicker.xcodeproj/project.xcworkspace/xcuserdata/egbad.xcuserdatad/UserInterfaceState.xcuserstate

@@ -7,7 +7,7 @@ Emoji picker for iOS like on macOS
 <img src="https://user-images.githubusercontent.com/50948518/171909950-ebf388f3-83a1-4b63-ad54-f58ba947e3bb.png" width="230">
 </p>
 
-## Navigate
+## Navigation
 
 - [Installation](#installation)
     - [Swift Package Manager](#swift-package-manager)
@@ -130,10 +130,10 @@ configuration.customHeight = 300
 Feedback generator style. To turn off, set `nil` to this parameter. The default value of this property is `.light`.
 
 ```swift
-configuration.feedBackGeneratorStyle = .soft
+configuration.feedbackGeneratorStyle = .soft
 ```
 
-## To do
+## To Do
 
 - [x] The main functionality for choosing emojis
 - [x] Dark mode
@@ -143,7 +143,7 @@ configuration.feedBackGeneratorStyle = .soft
 - [ ] Seach bar and search results
 - [ ] Recently used
 
-## Localizations
+## Localization
 
 * English 🇬🇧
 * Russian 🇷🇺

README.md

@@ -21,6 +21,7 @@
 
 import Foundation
 
+/// A type of object that publishes a message after the object has changed.
 final class Observable<T> {
     typealias Listener = (T) -> Void
 

Sources/EmojiPicker/Bindings/Observable.swift

@@ -21,6 +21,11 @@
 
 import Foundation
 
+/**
+ Emojis are being represented as hex values. This code converts provided emojis (ints) to a one line string.
+ 
+ - Experiment: `[0x1F600, 0x1F601, 0x1F602, 0x1F923, 0x1F603]` -> "😀😁😂🤣😃".
+ */
 extension Array where Element == Int {
     func emoji() -> String {
         var emoji = ""

Sources/EmojiPicker/Extensions/Foundation/Array.swift

@@ -7,11 +7,16 @@
 
 import Foundation
 
+/// We don't want `Bundle.module` that is being generated automatically for Swift Package to be overriden by our property.
 #if !SWIFT_PACKAGE
 extension Bundle {
-    /// Resources bundle.
-    ///
-    /// - Note: It was named same as for Swift Package to simplify usage.
+    /**
+     Resources bundle.
+     
+     Since CocoaPods resources bundle is something other than SPM's `Bundle.module`, we need to create it.
+     
+     - Note: It was named same as for Swift Package to simplify usage.
+     */
     static var module: Bundle {
         let path = Bundle(for: UnicodeManager.self).path(forResource: "EmojiPicker", ofType: "bundle") ?? ""
         return Bundle(path: path) ?? Bundle.main

Sources/EmojiPicker/Extensions/Foundation/Bundle.swift

@@ -21,7 +21,7 @@
 
 import UIKit
 
-/// Configuration for an EmojiPicker.
+/// Configuration for an EmojiPicker. Represents list of requirements.
 public struct Configuration {
     /// A view controller on which EmojiPicker is being presented.
     public var delegate: EmojiPickerDelegate
@@ -34,28 +34,29 @@ public struct Configuration {
     /// Inset from the sourceView border.
     public var horizontalInset: CGFloat
     /// Defines whether to dismiss emoji picker or not after choosing.
-    public var isDismissAfterChoosing: Bool
+    public var isDismissedAfterChoosing: Bool
     /// Custom height for EmojiPicker.
     public var customHeight: CGFloat?
     /// Feedback generator style. To turn off, set `nil` to this parameter.
-    public var feedBackGeneratorStyle: UIImpactFeedbackGenerator.FeedbackStyle?
+    public var feedbackGeneratorStyle: UIImpactFeedbackGenerator.FeedbackStyle?
 
+    /// Creates configuration with optional values (memberwise).
     public init(delegate: EmojiPickerDelegate,
                 sender: UIView,
                 selectedEmojiCategoryTintColor: UIColor? = nil,
                 arrowDirection: PickerArrowDirectionMode = .up,
                 horizontalInset: CGFloat = 0,
-                isDismissAfterChoosing: Bool = true,
+                isDismissedAfterChoosing: Bool = true,
                 customHeight: CGFloat? = nil,
-                feedBackGeneratorStyle: UIImpactFeedbackGenerator.FeedbackStyle = .light
+                feedbackGeneratorStyle: UIImpactFeedbackGenerator.FeedbackStyle = .light
     ) {
         self.delegate = delegate
         self.sender = sender
         self.selectedEmojiCategoryTintColor = selectedEmojiCategoryTintColor
         self.arrowDirection = arrowDirection
         self.horizontalInset = horizontalInset
-        self.isDismissAfterChoosing = isDismissAfterChoosing
+        self.isDismissedAfterChoosing = isDismissedAfterChoosing
         self.customHeight = customHeight
-        self.feedBackGeneratorStyle = feedBackGeneratorStyle
+        self.feedbackGeneratorStyle = feedbackGeneratorStyle
     }
 }

Sources/EmojiPicker/Models/Configuration.swift

@@ -19,7 +19,7 @@
 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // SOFTWARE.
 
-import UIKit
+import UIKit.UIDevice
 
 /// The protocol is necessary to hide unnecessary methods with Unicode categories in UnicodeManager.
 protocol UnicodeManagerProtocol {

Sources/EmojiPicker/Services/UnicodeManager.swift

@@ -25,7 +25,7 @@ import UIKit
 protocol EmojiPickerViewDelegate: AnyObject {
     /// Processes an event by category selection.
     ///
-    /// - Parameter index: index of the selected category.
+    /// - Parameter index: Index of the selected category.
     func didChoiceEmojiCategory(at index: Int)
 }
 

Sources/EmojiPicker/Views/EmojiPickerView.swift

@@ -74,7 +74,7 @@ public final class EmojiPickerViewController: UIViewController {
 
      - Note: The default value of this property is `true`.
      */
-    let isDismissAfterChoosing: Bool
+    let isDismissedAfterChoosing: Bool
 
     /**
      Color for the selected emoji category.
@@ -93,20 +93,23 @@ public final class EmojiPickerViewController: UIViewController {
 
      - Note: The default value of this property is `.light`.
      */
-    var feedBackGeneratorStyle: UIImpactFeedbackGenerator.FeedbackStyle? {
+    var feedbackGeneratorStyle: UIImpactFeedbackGenerator.FeedbackStyle? {
         didSet {
-            guard let feedBackGeneratorStyle = feedBackGeneratorStyle else {
-                generator = nil
+            guard let feedBackGeneratorStyle = feedbackGeneratorStyle else {
+                feedbackGenerator = nil
                 return
             }
-            generator = UIImpactFeedbackGenerator(style: feedBackGeneratorStyle)
+            feedbackGenerator = UIImpactFeedbackGenerator(style: feedBackGeneratorStyle)
         }
     }
 
     // MARK: - Private Properties
 
+    /// View of this controller.
     private let emojiPickerView = EmojiPickerView()
-    private var generator: UIImpactFeedbackGenerator?
+    /// An obect that creates haptics to simulate physical impacts.
+    private var feedbackGenerator: UIImpactFeedbackGenerator?
+    /// View model of this module.
     private var viewModel: EmojiPickerViewModelProtocol
 
     // MARK: - Init
@@ -116,8 +119,9 @@ public final class EmojiPickerViewController: UIViewController {
         arrowDirection = configuration.arrowDirection
         selectedEmojiCategoryTintColor = configuration.selectedEmojiCategoryTintColor
         horizontalInset = configuration.horizontalInset
-        isDismissAfterChoosing = configuration.isDismissAfterChoosing
+        isDismissedAfterChoosing = configuration.isDismissAfterChoosing
         customHeight = configuration.customHeight
+        feedbackGeneratorStyle = configuration.feedbackGeneratorStyle
 
         let unicodeManager = UnicodeManager()
         viewModel = EmojiPickerViewModel(unicodeManager: unicodeManager)
@@ -155,12 +159,14 @@ public final class EmojiPickerViewController: UIViewController {
 
     private func bindViewModel() {
         viewModel.selectedEmoji.bind { [unowned self] emoji in
-            generator?.impactOccurred()
+            feedbackGenerator?.impactOccurred()
             delegate?.didGetEmoji(emoji: emoji)
-            if isDismissAfterChoosing {
+            
+            if isDismissedAfterChoosing {
                 dismiss(animated: true, completion: nil)
             }
         }
+        
         viewModel.selectedEmojiCategoryIndex.bind { [unowned self] categoryIndex in
             self.emojiPickerView.updateSelectedCategoryIcon(with: categoryIndex)
         }
@@ -288,7 +294,7 @@ extension EmojiPickerViewController: UICollectionViewDelegateFlowLayout {
 extension EmojiPickerViewController: EmojiPickerViewDelegate {
 
     func didChoiceEmojiCategory(at index: Int) {
-        generator?.impactOccurred()
+        feedbackGenerator?.impactOccurred()
         viewModel.selectedEmojiCategoryIndex.value = index
     }
 }

Sources/EmojiPicker/Views/EmojiPickerViewController.swift

@@ -27,7 +27,7 @@ class ConfigurationTests: XCTestCase {
         XCTAssertEqual(configuration.horizontalInset, 0)
         XCTAssertEqual(configuration.isDismissAfterChoosing, true)
         XCTAssertEqual(configuration.customHeight, nil)
-        XCTAssertEqual(configuration.feedBackGeneratorStyle, .light)
+        XCTAssertEqual(configuration.feedbackGeneratorStyle, .light)
     }
 
     func testFullDataProvided() throws {
@@ -36,7 +36,7 @@ class ConfigurationTests: XCTestCase {
         let horizontalInset: CGFloat = 100
         let isDismissAfterChoosing = false
         let customHeight: CGFloat = 100
-        let feedBackGeneratorStyle = UIImpactFeedbackGenerator.FeedbackStyle.medium
+        let feedbackGeneratorStyle = UIImpactFeedbackGenerator.FeedbackStyle.medium
 
         configuration = Configuration(delegate: delegate,
                                       sender: sender,
@@ -45,13 +45,13 @@ class ConfigurationTests: XCTestCase {
                                       horizontalInset: horizontalInset,
                                       isDismissAfterChoosing: isDismissAfterChoosing,
                                       customHeight: customHeight,
-                                      feedBackGeneratorStyle: feedBackGeneratorStyle)
+                                      feedbackGeneratorStyle: feedbackGeneratorStyle)
 
         XCTAssertEqual(configuration.selectedEmojiCategoryTintColor, selectedEmojiCategoryTintColor)
         XCTAssertEqual(configuration.arrowDirection, arrowDirection)
         XCTAssertEqual(configuration.horizontalInset, horizontalInset)
         XCTAssertEqual(configuration.isDismissAfterChoosing, isDismissAfterChoosing)
         XCTAssertEqual(configuration.customHeight, customHeight)
-        XCTAssertEqual(configuration.feedBackGeneratorStyle, feedBackGeneratorStyle)
+        XCTAssertEqual(configuration.feedbackGeneratorStyle, feedbackGeneratorStyle)
     }
 }