Implement Logging

.swiftlint.yml

@@ -3,6 +3,7 @@ excluded:
   - Package.swift
   - Package@swift-5.7.swift
   - Package@swift-5.8.swift
+  - Sources/Flare/Classes/Generated/Strings.swift
   - .build
 
 # Rules

CHANGELOG.md

@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
 ## [Unreleased]
 
 ## Added
+- Implement Logging Functionality
+  - Added in Pull Request [#17](https://github.com/space-code/flare/pull/17).
+
 - Implement Support for Promotional Offers
   - Added in Pull Request [#16](https://github.com/space-code/flare/pull/16).
 

Makefile

@@ -16,10 +16,19 @@ lint:
 fmt:
 	mint run swiftformat Sources Tests
 
+strings:
+	swiftgen 
+
 generate:
 	xcodegen generate
 
 setup_build_tools:
 	sh scripts/setup_build_tools.sh
 
-.PHONY: all bootstrap hook mint lint fmt generate setup_build_tools
+build:
+	swift build -c release --target Flare
+
+test:
+	xcodebuild test -scheme "Flare" -destination "$(destination)" -testPlan AllTests clean -enableCodeCoverage YES
+
+.PHONY: all bootstrap hook mint lint fmt generate setup_build_tools strings build test

Package.resolved

@@ -9,6 +9,15 @@
         "version" : "0.0.1"
       }
     },
+    {
+      "identity" : "log",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/space-code/log",
+      "state" : {
+        "revision" : "d99fff5656c31ef7e604965b90a50ec10539c98f",
+        "version" : "1.1.0"
+      }
+    },
     {
       "identity" : "swift-docc-plugin",
       "kind" : "remoteSourceControl",

Package.swift

@@ -21,13 +21,16 @@ let package = Package(
     dependencies: [
         .package(url: "https://github.com/space-code/concurrency.git", .upToNextMajor(from: "0.0.1")),
         .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.1.0"),
+        .package(url: "https://github.com/space-code/log.git", .upToNextMajor(from: "1.1.0")),
     ],
     targets: [
         .target(
             name: "Flare",
             dependencies: [
                 .product(name: "Concurrency", package: "concurrency"),
+                .product(name: "Log", package: "log"),
             ],
+            resources: [.process("Resources")],
             swiftSettings: [visionOSSetting]
         ),
         .testTarget(

Package@swift-5.7.swift

@@ -18,13 +18,16 @@ let package = Package(
     dependencies: [
         .package(url: "https://github.com/space-code/concurrency.git", .upToNextMajor(from: "0.0.1")),
         .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.1.0"),
+        .package(url: "https://github.com/space-code/log.git", .upToNextMajor(from: "1.1.0")),
     ],
     targets: [
         .target(
             name: "Flare",
             dependencies: [
                 .product(name: "Concurrency", package: "concurrency"),
-            ]
+                .product(name: "Log", package: "log"),
+            ],
+            resources: [.process("Resources")]
         ),
         .testTarget(
             name: "FlareTests",

Package@swift-5.8.swift

@@ -18,13 +18,16 @@ let package = Package(
     dependencies: [
         .package(url: "https://github.com/space-code/concurrency.git", .upToNextMajor(from: "0.0.1")),
         .package(url: "https://github.com/apple/swift-docc-plugin", from: "1.1.0"),
+        .package(url: "https://github.com/space-code/log.git", .upToNextMajor(from: "1.1.0")),
     ],
     targets: [
         .target(
             name: "Flare",
             dependencies: [
                 .product(name: "Concurrency", package: "concurrency"),
-            ]
+                .product(name: "Log", package: "log"),
+            ],
+            resources: [.process("Resources")]
         ),
         .testTarget(
             name: "FlareTests",

Sources/Flare/Classes/Common/Logger.swift

@@ -0,0 +1,78 @@
+//
+// Flare
+// Copyright © 2024 Space Code. All rights reserved.
+//
+
+import Foundation
+import Log
+
+// MARK: - Logger
+
+enum Logger {
+    // MARK: Properties
+
+    private static var defaultLogLevel: LogLevel {
+        #if DEBUG
+            return .debug
+        #endif
+        return .info
+    }
+
+    private static let `default`: Log.Logger = .init(
+        printers: [
+            ConsolePrinter(formatters: Self.formatters),
+            OSPrinter(subsystem: .subsystem, category: .category, formatters: Self.formatters),
+        ],
+        logLevel: Self.defaultLogLevel
+    )
+
+    private static var formatters: [ILogFormatter] {
+        [
+            PrefixLogFormatter(name: .subsystem),
+            TimestampLogFormatter(dateFormat: "dd.MM.yyyy hh:mm:ss"),
+        ]
+    }
+
+    static var logLevel: LogLevel {
+        get { Self.default.logLevel }
+        set { Self.default.logLevel = newValue }
+    }
+
+    // MARK: Static Public Methods
+
+    static func debug(message: @autoclosure () -> String) {
+        log(level: .debug, message: message())
+    }
+
+    static func info(message: @autoclosure () -> String) {
+        log(level: .info, message: message())
+    }
+
+    static func error(message: @autoclosure () -> String) {
+        log(level: .fault, message: message())
+    }
+
+    // MARK: Private
+
+    private static func log(level: LogLevel, message: @autoclosure () -> String) {
+        switch level {
+        case .debug:
+            Self.default.debug(message: message())
+        case .info:
+            Self.default.info(message: message())
+        case .fault:
+            Self.default.fault(message: message())
+        case .error:
+            Self.default.error(message: message())
+        default:
+            break
+        }
+    }
+}
+
+// MARK: - Constants
+
+private extension String {
+    static let subsystem = "Flare"
+    static let category = "iap"
+}

Sources/Flare/Classes/Flare.swift

@@ -3,6 +3,7 @@
 // Copyright © 2024 Space Code. All rights reserved.
 //
 
+import struct Log.LogLevel
 import StoreKit
 
 #if os(iOS) || VISION_OS
@@ -27,6 +28,12 @@
     /// Returns a shared `Flare` object.
     public static var shared: IFlare { flare }
 
+    /// The log level.
+    public var logLevel: LogLevel {
+        get { Logger.logLevel }
+        set { Logger.logLevel = newValue }
+    }
+
     // MARK: Initialization
 
     /// Creates a new `Flare` instance.
@@ -66,7 +73,7 @@
         promotionalOffer: PromotionalOffer?,
         completion: @escaping Closure<Result<StoreTransaction, IAPError>>
     ) {
-        guard iapProvider.canMakePayments else {
+        guard checkIfUserCanMakePayments() else {
             completion(.failure(.paymentNotAllowed))
             return
         }
@@ -82,7 +89,7 @@
     }
 
     public func purchase(product: StoreProduct, promotionalOffer: PromotionalOffer?) async throws -> StoreTransaction {
-        guard iapProvider.canMakePayments else { throw IAPError.paymentNotAllowed }
+        guard checkIfUserCanMakePayments() else { throw IAPError.paymentNotAllowed }
         return try await iapProvider.purchase(product: product, promotionalOffer: promotionalOffer)
     }
 
@@ -93,7 +100,7 @@
         promotionalOffer: PromotionalOffer?,
         completion: @escaping SendableClosure<Result<StoreTransaction, IAPError>>
     ) {
-        guard iapProvider.canMakePayments else {
+        guard checkIfUserCanMakePayments() else {
             completion(.failure(.paymentNotAllowed))
             return
         }
@@ -106,7 +113,7 @@
         options: Set<StoreKit.Product.PurchaseOption>,
         promotionalOffer: PromotionalOffer?
     ) async throws -> StoreTransaction {
-        guard iapProvider.canMakePayments else { throw IAPError.paymentNotAllowed }
+        guard checkIfUserCanMakePayments() else { throw IAPError.paymentNotAllowed }
         return try await iapProvider.purchase(product: product, options: options, promotionalOffer: promotionalOffer)
     }
 
@@ -167,4 +174,14 @@
             try await iapProvider.presentOfferCodeRedeemSheet()
         }
     #endif
+
+    // MARK: Private
+
+    private func checkIfUserCanMakePayments() -> Bool {
+        guard iapProvider.canMakePayments else {
+            Logger.error(message: L10n.Purchase.cannotPurcaseProduct)
+            return false
+        }
+        return true
+    }
 }