Merge pull request #6 from VishwaiOSDev/fix/vishwa/renamed-log-to-logger

Author: srihaari

Package.swift

@@ -4,11 +4,11 @@
 import PackageDescription
 
 let package = Package(
-    name: "LogKit",
+    name: "LoggerKit",
     platforms: [.iOS(.v13), .watchOS(.v6), .macOS(.v10_15), .tvOS(.v13)],
     products: [
         // Products define the executables and libraries a package produces, and make them visible to other packages.
-        .library(name: "LogKit", targets: ["LogKit"]),
+        .library(name: "LoggerKit", targets: ["LoggerKit"]),
     ],
     dependencies: [
         // Dependencies declare other packages that this package depends on.
@@ -17,7 +17,7 @@ let package = Package(
     targets: [
         // Targets are the basic building blocks of a package. A target can define a module or a test suite.
         // Targets can depend on other targets in this package, and on products in packages this package depends on.
-        .target(name: "LogKit", dependencies: []),
-        .testTarget(name: "LogKitTests", dependencies: ["LogKit"]),
+        .target(name: "LoggerKit", dependencies: []),
+        .testTarget(name: "LoggerKitTests", dependencies: ["LoggerKit"]),
     ]
 )

README.md

@@ -1,10 +1,10 @@
-![LogKit](https://user-images.githubusercontent.com/71421776/182191029-877eeb22-282c-482a-8d89-6118dd150dbb.jpg)
+![LoggerKit](https://user-images.githubusercontent.com/71421776/182191029-877eeb22-282c-482a-8d89-6118dd150dbb.jpg)
 
-# LogKit
+# LoggerKit
 A logger for Xcode
 
 ## Motivation
-LogKit is designed to be a simple and universal logging library with support for multiple Xcode projects. LogKit will have different types of log level.
+LoggerKit is designed to be a simple and universal logging library with support for multiple Xcode projects. LogKit will have different types of log level.
 
 ## Features
 
@@ -19,6 +19,8 @@ LogKit is designed to be a simple and universal logging library with support for
  - Debug
  - Warning
  - Error
+ - Initialize (init)
+ - Teardown (deinit)
 
 ## 📦 Installation
 
@@ -27,40 +29,40 @@ The [Swift Package Manager](https://swift.org/package-manager/) is a tool for au
 
 Add this Swift package in Xcode using its Github repository url. (File > Swift Packages > Add Package Dependency...)
 
-Add this URL https://github.com/VishwaiOSDev/LogKit.git and select **Add Package**.
+Add this URL https://github.com/VishwaiOSDev/LoggerKit.git and select **Add Package**.
 
 After adding it select LogKit.
 
 <img width="648" alt="Screenshot 2022-08-01 at 9 14 56 PM" src="https://user-images.githubusercontent.com/71421776/182190544-0dbdd51a-df00-44f2-9064-cd33e44d192b.png">
 
 ### 🚀  How to use
 
-LogKit makes your life easier
+LoggerKit makes your life easier
 
-Firstly, import the LogKit
+Firstly, import the LoggerKit
 
 ```swift
-import LogKit
+import LoggerKit
 ```
 
 For logging,
 
 ```swift
-Log.verbose("Example of verbose log.")
-Log.info("Something went wrong")
-Log.debug("Debug mode enabled")
-Log.warning("Warning, duplication warning.")
-Log.error("Error, data didn't fetch properly.")
+LoggerKit.verbose("Example of verbose log.")
+LoggerKit.info("Something went wrong")
+LoggerKit.debug("Debug mode enabled")
+LoggerKit.warning("Warning, duplication warning.")
+LoggerKit.error("Error, data didn't fetch properly.")
 ```
 
-LogKit will provide clean information for you. Output for above code as follows:
+LoggerKit will provide clean information for you. Output for above code as follows:
 
 ```
-[VERBOSE ✏️✏️] Example of verbose log. → LogKitTests.swift:7 testVerboseLog()
-[INFO ℹ️ℹ️] Something went wrong. → LogKitTests.swift:12 testInfoLog()
-[DEBUG 🚀🚀] Debug mode enabled → LogKitTests.swift:17 testDebugLog()
-[WARN ⚠️⚠️] Warning, duplication warning. → LogKitTests.swift:22 testWarningLog()
-[ERROR ❌❌] Error, data didn't fetch properly. → LogKitTests.swift:27 testErrorLog()
+💜💜 LoggerKitTests.swift: 49 - Something went wrong! Dependency Error.
+💚💚 LoggerKitTests.swift: 46 - Something went wrong! Dependency Error.
+💛💛 LoggerKitTests.swift: 19 - Debug mode enabled
+🧡🧡 LoggerKitTests.swift: 23 - Warning, duplication warning.
+❤️❤️ LoggerKitTests.swift: 45 - Something went wrong! Dependency Error.
 ```
 # License
-LogKit is released under the MIT license.
+LoggerKit is released under the MIT license.

Sources/LogKit/LogKit+Extension.swift renamed to Sources/LoggerKit/LoggerKit+Extension.swift

@@ -17,40 +17,40 @@ protocol Loggable {
     static func teardown(_ message: Any?..., shouldLogContext: Bool, file: String, line: Int)
 }
 
-public extension Log {
+public extension Logger {
 
     static func info(_ message: Any?..., shouldLogContext: Bool = true, file: String = #file, line: Int = #line) {
         let context = Context(file: file, line: line)
-        Log.handleLog(level: .info, message: message, shouldLogContext: shouldLogContext, context: context)
+        Logger.handleLog(level: .info, message: message, shouldLogContext: shouldLogContext, context: context)
     }
 
     static func verbose(_ message: Any?..., shouldLogContext: Bool = true, file: String = #file, line: Int = #line) {
         let context = Context(file: file, line: line)
-        Log.handleLog(level: .verbose, message: message, shouldLogContext: shouldLogContext, context: context)
+        Logger.handleLog(level: .verbose, message: message, shouldLogContext: shouldLogContext, context: context)
     }
 
-    static func debug(_ message: Any?..., shouldLogContext: Bool = false, file: String = #file, line: Int = #line) {
+    static func debug(_ message: Any?..., shouldLogContext: Bool = true, file: String = #file, line: Int = #line) {
         let context = Context(file: file, line: line)
-        Log.handleLog(level: .debug, message: message, shouldLogContext: shouldLogContext, context: context)
+        Logger.handleLog(level: .debug, message: message, shouldLogContext: shouldLogContext, context: context)
     }
 
     static func warning(_ message: Any?..., shouldLogContext: Bool = true, file: String = #file, line: Int = #line) {
         let context = Context(file: file, line: line)
-        Log.handleLog(level: .warning, message: message, shouldLogContext: shouldLogContext, context: context)
+        Logger.handleLog(level: .warning, message: message, shouldLogContext: shouldLogContext, context: context)
     }
 
     static func error(_ message: Any?..., shouldLogContext: Bool = true, file: String = #file, line: Int = #line) {
         let context = Context(file: file, line: line)
-        Log.handleLog(level: .error, message: message, shouldLogContext: shouldLogContext, context: context)
+        Logger.handleLog(level: .error, message: message, shouldLogContext: shouldLogContext, context: context)
     }
 
     static func initialize(_ message: Any?..., shouldLogContext: Bool = true, file: String = #file, line: Int = #line) {
         let context = Context(file: file, line: line)
-        Log.handleLog(level: .`init`, message: message, shouldLogContext: shouldLogContext, context: context)
+        Logger.handleLog(level: .`init`, message: message, shouldLogContext: shouldLogContext, context: context)
     }
 
     static func teardown(_ message: Any?..., shouldLogContext: Bool = true, file: String = #file, line: Int = #line) {
         let context = Context(file: file, line: line)
-        Log.handleLog(level: .deinit, message: message, shouldLogContext: shouldLogContext, context: context)
+        Logger.handleLog(level: .deinit, message: message, shouldLogContext: shouldLogContext, context: context)
     }
 }

Sources/LogKit/LogKit.swift renamed to Sources/LoggerKit/LoggerKit.swift

@@ -1,13 +1,13 @@
 //
-//  LogKit.swift
+//  LoggerKit.swift
 //  
 //
 //  Created by Vishweshwaran on 01/08/22.
 //
 
 import Foundation
 
-public enum Log: Loggable {
+public enum Logger: Loggable {
 
     enum LogLevel {
 

Tests/LogKitTests/LogKitTests.swift

@@ -0,0 +1,81 @@
+import XCTest
+@testable import LoggerKit
+
+final class LogKitTests: XCTestCase {
+    
+    func testInitLog() {
+        Logger.initialize("LogKitTest Init")
+    }
+    
+    func testVerboseLog() {
+        Logger.verbose("Example of verbose log.")
+    }
+    
+    func testInfoLog() {
+        Logger.info("Something went wrong.")
+    }
+    
+    func testDebugLog() {
+        Logger.debug("Debug mode enabled")
+    }
+    
+    func testWarningLog() {
+        Logger.warning("Warning, duplication warning.")
+    }
+    
+    func testErrorLog() {
+        Logger.error("Error, data didn't fetch properly.")
+    }
+    
+    func testWithVariables() {
+        let intTest: Int = 01
+        let floatTest: Float = 30.01
+        let doubleTest: Double = 30.0001
+        let stringTest: String = "StringTest"
+        
+        Logger.error(intTest)
+        Logger.info(floatTest)
+        Logger.warning(doubleTest)
+        Logger.debug(stringTest)
+    }
+    
+    func testLogWithParameter() {
+        let errorMessage: String = "Dependency Error."
+        
+        Logger.error("Something went wrong! \(errorMessage)")
+        Logger.info("Something went wrong! \(errorMessage)")
+        Logger.debug("Something went wrong! \(errorMessage)")
+        Logger.warning("Something went wrong! \(errorMessage)")
+        Logger.verbose("Something went wrong! \(errorMessage)")
+    }
+    
+    func testLogWithoutParameter() {
+        Logger.error()
+        Logger.info()
+        Logger.debug()
+        Logger.warning()
+        Logger.verbose()
+    }
+    
+    func testWithComplexObjects() {
+        
+        struct LogTest {
+            var id: Int
+            var message: String
+        }
+        
+        let testObj01 = LogTest(id: 1, message: "Something went wrong")
+        let testObj02 = LogTest(id: 2, message: "404, Error")
+        let testObj03 = LogTest(id: 3, message: "200 Status Ok!")
+        
+        Logger.error(testObj01, testObj02, testObj03)
+        Logger.info(testObj01, testObj02, testObj03)
+        Logger.debug(testObj01, testObj02, testObj03)
+        Logger.warning(testObj01, testObj02, testObj03)
+        Logger.verbose(testObj01, testObj02, testObj03)
+    }
+    
+    func testDeinitLog() {
+        Logger.teardown("LogKitTest deinit")
+    }
+}