Minor tweaks

Author: eonist

README.md

@@ -97,6 +97,9 @@ UpgradeAlert.showAlert(appInfo: .init(version: "1.0.1", trackViewUrl: "https://a
 - Doc params
 - Clean up comments
 - Add support for swiftui
-
-## License
-This project is licensed under the terms of the MIT license. See the [LICENSE](LICENSE) file.
+- Error Handling and Reporting: The current implementation of error handling in various parts of the codebase could be improved for better clarity and functionality. For instance: UpgradeAlert.swift: The method checkForUpdates uses a simple closure that returns an optional error. This could be enhanced by using a Result type to make the success and error handling paths clearer and more robust. 
+- UIAlertController+Ext.swift: The present method does not handle the scenario where there is no view controller available to present the alert. This could lead to silent failures in presenting critical update alerts.
+- Refactoring and Code Simplification_ Refactoring some parts of the code could improve readability and maintainability. For example: UpgradeAlert+Variables.swift: The method for generating the request URL could be simplified or made more robust by handling potential errors more gracefully.
+- NSAlert+Ext.swift: The method for presenting alerts in macOS could be refactored to reduce duplication and improve error handling.
+- Testing and Coverage Improving tests to cover edge cases and error scenarios would enhance the reliability of the application. For instance:
+- UpgradeAlertTests.swift: The test cases could be expanded to cover more scenarios, including error handling and user interaction outcomes.

Sources/UpgradeAlert/UpgradeAlert+Variables.swift

@@ -5,8 +5,10 @@ import Foundation
 extension UpgradeAlert {
    /**
     * Computed property to generate the request URL for app information.
-    * It uses the bundle identifier of the current app to create the URL.
-    * - Description: This property constructs a URL used to fetch information about the application from the iTunes API based on the application's bundle identifier.
+    * - Note: It uses the bundle identifier of the current app to create the URL.
+    * - Description: This property constructs a URL used to fetch information
+    *                about the application from the iTunes API based on the
+    *                application's bundle identifier.
     * - Returns: A URL pointing to the app's information on iTunes.
     * - Note: This URL might need a country code for region-specific apps.
     * - Fixme: ⚠️️ Consider renaming this to appInfoRequestURL for clarity.
@@ -24,7 +26,8 @@ extension UpgradeAlert {
 extension UpgradeAlert {
    /**
     * Typealias for a function that generates an alert message.
-    * - Description: Defines a function type used to generate a custom alert message based on the app's name and version.
+    * - Description: Defines a function type used to generate a custom alert
+    *                message based on the app's name and version.
     * - Parameters:
     *   - appName: The name of the app. This can be nil.
     *   - version: The version of the app.
@@ -34,16 +37,20 @@ extension UpgradeAlert {
    public typealias AlertMessage = (_ appName: String?, _ version: String) -> String
    /**
     * Typealias for a completion handler function.
-    * - Description: Defines a closure used as a completion handler to process the outcome of an update check or alert interaction.
+    * - Description: Defines a closure used as a completion handler to process
+    *                the outcome of an update check or alert interaction.
     * - Parameters:
-    *   - outcome: The outcome of the operation, encapsulated in a UAOutcome object.
+    *   - outcome: The outcome of the operation, encapsulated in a UAOutcome  object.
     * - Note: This function does not return a value.
     */
    public typealias Complete = (_ outcome: UAOutcome) -> Void
    /**
     * Default completion handler function.
-    * This function simply prints the outcome of the operation.
-    * - Description: This default completion handler logs the outcome of the operation to the console, providing a simple way to observe the results of the update check or alert interaction.
+    * - Abstract: This function simply prints the outcome of the operation.
+    * - Description: This default completion handler logs the outcome of the
+    *                operation to the console, providing a simple way to
+    *                observe the results of the update check or alert
+    *                interaction.
     */
    public static let defaultComplete: Complete = { (outcome: UAOutcome) in
       Swift.print("default complete - outcome: \(String(describing: outcome))")
@@ -55,7 +62,8 @@ extension UpgradeAlert {
 extension UpgradeAlert {
    /**
     * Static property to hold the configuration for UpgradeAlert.
-    * - Description: Holds the configuration settings for the UpgradeAlert system, which can be customized as needed.
+    * - Description: Holds the configuration settings for the UpgradeAlert
+    *                system, which can be customized as needed.
     * - Note: By default, it uses the default configuration defined in UAConfig.
     */
    public static var config: UAConfig = .defaultConfig

Sources/UpgradeAlert/UpgradeAlert.swift

@@ -5,7 +5,10 @@ import UIKit
 import Cocoa
 #endif
 /**
- * - Description: The `UpgradeAlert` class is responsible for managing the update notification process within an application. It checks for new versions of the app on the App Store, compares it with the current version, and alerts the user if an update is necessary.
+ * - Description: The `UpgradeAlert` class manages the update notification
+ *                process within an application. It checks for new versions of
+ *                the app on the App Store, compares it with the current
+ *                version, and alerts the user if an update is necessary.
  * - Remark: What if a user doesn't want to update and there is no other option than to update?
  * - Remark: If the app always show popup when getting focus. Then activate flight-mode. Launch the app again.
  * - Remark: Title and message are optional, default values are used if nil etc
@@ -18,13 +21,21 @@ public final class UpgradeAlert {}
 extension UpgradeAlert {
    /**
     * Check for updates
-    * - Description: Initiates a check for new versions of the app available on the App Store. If a newer version is found, it prompts the user with an update alert.
+    * - Description: Initiates a check for new versions of the app available
+    *                on the App Store. If a newer version is found, it prompts
+    *                the user with an update alert.
     * - Remark: shows alert with one or two btns
-    * - Parameter: withConfirmation You can force the update by calling, Or the user can choose if they want to update now or later by calling
-    * - Remark: Version of the app you want to mark for the update. For example, 1.0.0 // This is the version you want the user to force upgrade to a newer version.
+    * - Remark: Version of the app you want to mark for the update.
+    *           For example, 1.0.0 // This is the version you want the user
+    *           to force upgrade to a newer version.
     * - Fixme: ⚠️️ Add onAppStoreOpenComplete -> ability to track how many update etc
     * - Fixme: ⚠️️ Use Result instead etc
-    * - Parameter complete: A closure that is called when the update check is complete. It returns an optional AppInfo object and an optional NSError object. If an error occurs during the update check, the NSError object describes the error. If the update check is successful, the AppInfo object contains information about the app.
+    * - Parameter complete: A closure that is called when the update check
+    *                       is complete. It returns an optional AppInfo object
+    *                       and an optional NSError object. If an error occurs
+    *                       during the update check, the NSError object describes
+    *                       the error. If the update check is successful, the
+    *                       AppInfo object contains information about the app.
     */
 	public static func checkForUpdates(complete: Complete? = defaultComplete) { // complete: (_ appInfo: AppInfo?, error: NSError?)
 		// Perform network calls on a background thread

Sources/UpgradeAlert/ext/Bundle+Ext.swift

@@ -30,7 +30,9 @@ extension Bundle {
    /**
     * Tests if an app is in beta
     * - Abstract: determines if beta from receipt
-    * - Description: Determines if the application is a beta version by checking the app store receipt URL for specific substrings that identify simulator or TestFlight environments.
+    * - Description: Determines if the application is a beta version by
+    *               checking the app store receipt URL for specific substrings that
+    *               identify simulator or TestFlight environments.
     * - Note: From here: https://stackoverflow.com/a/38984554/5389500
     * - Note: More complex example: https://stackoverflow.com/a/33830605/5389500
     * - Note: Another example: https://stackoverflow.com/a/59047187/5389500

Sources/UpgradeAlert/ext/NSAlert+Ext.swift

@@ -4,7 +4,9 @@ import Cocoa
 extension NSAlert {
    /**
     * Presents a warning alert to the user with customizable text, buttons, and completion handler.
-    * - Description: Displays a modal alert dialog on macOS with customizable titles for the buttons and a completion handler to capture the user's response.
+    * - Description: Displays a modal alert dialog on macOS with customizable
+    *                titles for the buttons and a completion handler to capture
+    *                the user's response.
     * ## Examples:
     * NSAlert.present(question: "Ok?", text: "Choose your answer.") { answer in
     *   print(answer)
@@ -15,8 +17,11 @@ extension NSAlert {
     *   - text: The informative text of the alert.
     *   - okTitle: The text for the OK button. Defaults to "OK".
     *   - cancelTitle: The text for the cancel button. Defaults to "Cancel".
-    *   - view: The view to present the alert from. If nil, the alert is presented from the first window of the application.
-    *   - complete: A closure that is called when the user dismisses the alert. The closure takes a single Boolean parameter that is true if the user clicked the OK button and false otherwise.
+    *   - view: The view to present the alert from. If nil, the alert is
+    *           presented from the first window of the application.
+    *   - complete: A closure that is called when the user dismisses the alert.
+    *               The closure takes a single Boolean parameter that is true if
+    *               the user clicked the OK button and false otherwise.
     */
    internal static func present(question: String, text: String, okTitle: String? = "OK", cancelTitle: String? = "Cancel", view: NSView? = nil, complete: ((_ answer: Bool) -> Void)?) {
       let alert: NSAlert = .init() // Initializes a new NSAlert object.

Sources/UpgradeAlert/ext/UIAlertController+Ext.swift

@@ -4,7 +4,9 @@ import UIKit
 extension UIAlertController {
    /**
     * Present alert
-    * - Description: Presents the alert controller modally on the currently active view controller or the root view controller if no other controllers are presented.
+    * - Description: Presents the alert controller modally on the currently
+    *                active view controller or the root view controller if no other
+    *                controllers are presented.
     * Fix: throw error if vc is not available?
     */
    internal func present() {
@@ -17,7 +19,9 @@ extension UIAlertController {
 extension UIAlertController {
    /**
     * Presented or root view-controller
-    * - Description: Retrieves the currently presented view controller or the root view controller if no other view controller is presented.
+    * - Description: Retrieves the currently presented view controller or the
+    *                root view controller if no other view controller is
+    *                presented.
     * - Note: Sometimes there is no vc: https://stackoverflow.com/a/30509569/5389500
     */
    fileprivate static var presentedOrRootVC: UIViewController? {

Sources/UpgradeAlert/ext/UIApplication+Ext.swift

@@ -6,7 +6,8 @@ import UIKit
 extension UIApplication {
    /**
     * Key window property.
-    * - Description: Retrieves the primary window of the application that is currently receiving user events.
+    * - Description: Retrieves the primary window of the application that is
+    *                currently receiving user events.
     * - Remark: The key scene can be found by accessing `keyWin.windowScene`.
     * - Returns: The key window if it exists, otherwise nil.
     */

Sources/UpgradeAlert/helper/AppInfo.swift

@@ -2,27 +2,38 @@ import Foundation
 
 /**
  * This struct represents the basic information about an application.
- * It includes the current version of the application and the URL to the application's page on the App Store.
- * - Description: This struct encapsulates essential details about the application, such as its current version and the URL to its App Store page, facilitating easy access to its public listing for update and review purposes.
- * - Remark: More information such as rating, release date, release notes etc. can be fetched. For more details, see: https://github.com/amebalabs/AppVersion/blob/master/AppVersion/Source/AppStoreVersion.swift
+ * - Abstract: It includes the current version of the application and the URL
+ *             to the application's page on the App Store.
+ * - Description: This struct encapsulates essential details about the
+ *                application, such as its current version and the URL to its App Store
+ *                page, facilitating easy access to its public listing for update and
+ *                review purposes.
+ * - Remark: More information such as rating, release date, release notes etc.
+ *           can be fetched. For more details, see:
+ *           https://github.com/amebalabs/AppVersion/blob/master/AppVersion/Source/AppStoreVersion.swift
  * - Fixme: ⚠️️  Consider renaming this struct to UAAppInfo for better clarity.
  * - Fixme: ⚠️️ Add more detailed documentation for this struct and its properties.
  */
 public struct AppInfo: Decodable {
    /**
     * The current version of the application.
-    * - Description: Specifies the version of the application as a string, which is used to determine if an update is needed.
+    * - Description: Specifies the version of the application as a string,
+    *                which is used to determine if an update is needed.
     */
    public let version: String
    /**
     * The URL to the application's page on the App Store.
-    * This might be optional for macOS applications as they might not have an App Store page.
-    * - Description: Specifies the URL to the application's page on the App Store, which can be used to direct users to update or review the app.
+    * - Abstract: This might be optional for macOS applications as they might
+    *             not have an App Store page.
+    * - Description: Specifies the URL to the application's page on the App
+    *                Store, which can be used to direct users to update or
+    *                review the app.
     */
    public let trackViewUrl: String
    /**
     * Initializes a new instance of `AppInfo`.
-    * - Description: Initializes a new instance of `AppInfo` with the specified version and App Store URL.
+    * - Description: Initializes a new instance of `AppInfo` with the specified
+    *                version and App Store URL.
     * - Parameters:
     *   - version: The current version of the application.
     *   - trackViewUrl: The URL to the application's page on the App Store.

Sources/UpgradeAlert/helper/LookupResult.swift

@@ -1,9 +1,10 @@
 import Foundation
 /**
  * `LookupResult` is a struct that conforms to the `Decodable` protocol.
- * - Description: Represents the result of a lookup operation in the Apple App Store API, encapsulating the relevant app information fetched.
- * It is used to parse the JSON response from the Apple App Store API.
- * The parsed data is stored in the `results` array, which contains instances of `AppInfo`.
+ * - Description: Represents the result of a lookup operation in the Apple App
+ *                Store API, encapsulating the relevant app information fetched.
+ * - Note: It is used to parse the JSON response from the Apple App Store API.
+ * - Note: The parsed data is stored in the `results` array, which contains instances of `AppInfo`.
  * - Note: This struct is part of the `UpgradeAlert` module, specifically under the `helper` directory.
  */
 struct LookupResult: Decodable {

Sources/UpgradeAlert/helper/UAConfig.swift

@@ -55,7 +55,10 @@ extension UAConfig {
    /**
     * Provides a default configuration for the alert.
     * This can be used when no specific configuration is provided.
-    * - Description: Returns a default `UAConfig` instance with predefined values for alert title, message, and button titles, suitable for general use cases where a specific configuration is not necessary.
+    * - Description: Returns a default `UAConfig` instance with predefined
+    *                values for alert title, message, and button titles,
+    *                suitable for general use cases where a specific
+    *                configuration is not necessary.
     */
    public static let defaultConfig: UAConfig = {
       .init(

Sources/UpgradeAlert/helper/UAError.swift

@@ -2,29 +2,39 @@ import Foundation
 /**
  * Error type. So we can track if bundle id etc faults.
  * This enum is used to handle errors in a more structured way, allowing for better error handling and debugging.
- * - Description: Enumerates the various errors that can occur within the UpgradeAlert system, providing specific types for different error scenarios to facilitate precise error handling.
+ * - Description: Enumerates the various errors that can occur within the
+ *                UpgradeAlert system, providing specific types for different
+ *                error scenarios to facilitate precise error handling.
  */
 public enum UAError: Error {
    /**
     * This error is thrown when the URL for the App Store is invalid.
-    * - Description: Occurs when the URL intended to direct to the App Store is malformed or not properly formatted, preventing navigation to the App Store page.
+    * - Description: Occurs when the URL intended to direct to the App Store
+    *                is malformed or not properly formatted, preventing
+    *                navigation to the App Store page.
     */
    case invalidAppStoreURL
    /**
     * This error is thrown when a general URL is invalid.
-    * - Description: Occurs when a general URL that is not specifically for the App Store is malformed or not properly formatted, preventing proper URL navigation or usage.
+    * - Description: Occurs when a general URL that is not specifically for
+    *                the App Store is malformed or not properly formatted,
+    *                preventing proper URL navigation or usage.
     */
    case invalideURL
    /**
     * This error is thrown when the response from a request is invalid.
     * - Parameter description: Provides more details about the error.
-    * - Description: Provides a detailed explanation of what went wrong with the response, including specifics that can help in debugging the issue.
+    * - Description: Provides a detailed explanation of what went wrong
+    *                with the response, including specifics that can help
+    *                in debugging the issue.
     */
    case invalidResponse(description: String)
    /**
     * This error is thrown when there is an issue with the bundle.
     * The desc parameter provides more details about the error.
-    * - Description: Indicates an error related to the application's bundle, such as missing required resources or incorrect configuration settings.
+    * - Description: Indicates an error related to the application's bundle,
+    *                such as missing required resources or incorrect
+    *                configuration settings.
     */
    case bundleErr(desc: String)
 }