Merge branch 'develop'

Author: alexanderwe

.github/workflows/main.yml

@@ -1,12 +1,6 @@
 name: CI
 
-on:
-  push:
-    branches:
-    - master
-    - develop
-    - /^hotfix.*$/
-    - /^feature.*$/
+on: [push]
 
 jobs:
   tests:
@@ -22,4 +16,4 @@ jobs:
     steps:
     - uses: actions/checkout@v1
     - name: fastlane ios compatibilityTests
-      run: fastlane ios compatibilityTests
+      run: fastlane ios compatibilityTests

.gitignore

@@ -29,7 +29,7 @@ Icon
 ._*
 
 # Documentation
-Documentation
+#Documentation
 
 # Files that might appear in the root of a volume
 .DocumentRevisions-V100
@@ -107,3 +107,4 @@ fastlane/test_output
 .bundle/**
 .vendor/**
 .swiftpm/**
+.vendor/**

.jazzy.yaml

@@ -4,4 +4,4 @@ copyright: Copyright 2020 Alexander Weiß
 author: Alexander Weiß
 xcodebuild_arguments: [-target, LoggingKit-iOS]
 clean: true
-output: ./Documentation
+output: ./docs

Configs/LoggingKit.plist

@@ -17,7 +17,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.0.0</string>
+	<string>2.0.0</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>

Configs/LoggingKitTests.plist

@@ -15,7 +15,7 @@
 	<key>CFBundlePackageType</key>
 	<string>BNDL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.0.0</string>
+	<string>2.0.0</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>

Example/AppDelegate.swift

@@ -7,6 +7,7 @@
 //
 
 import UIKit
+import LoggingKit
 
 // MARK: - AppDelegate
 
@@ -30,12 +31,18 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
     /// - Returns: The launch result
     func application(_ application: UIApplication,
                      didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
+        
+        
+        LogService.register(logProviders: MyTestLogProvider())
+        
+        
         // Initialize UIWindow
         self.window = .init(frame: UIScreen.main.bounds)
         // Set RootViewController
         self.window?.rootViewController = self.rootViewController
         // Make Key and Visible
         self.window?.makeKeyAndVisible()
+    
         // Return positive launch
         return true
     }

Example/MyTestLogProvider.swift

@@ -0,0 +1,36 @@
+//
+//  MyTestLogProvider.swift
+//  Example
+//
+//  Created by Alexander Weiß on 13.06.20.
+//  Copyright © 2020 Alexander Weiß. All rights reserved.
+//
+
+import Foundation
+import LoggingKit
+
+class MyTestLogProvider: LogProvider {
+    
+    static var dateFormatter: DateFormatter = {
+        let df = DateFormatter()
+        df.dateFormat = "yyyy-MM-dd HH:mm:ssSSS"
+        df.locale = Locale.current
+        df.timeZone = TimeZone.current
+        return df
+    }()
+    
+    
+    func log(_ event: LogType, _ message: @autoclosure () -> Any?, logCategory: KeyPath<LogCategories, LogCategory>, fileName: StaticString, functionName: StaticString, lineNumber: Int) {
+        
+        guard let message = message() else {
+            return
+        }
+        
+        let category = LoggingCategories[logCategory]
+        let timeString = MyTestLogProvider.dateFormatter.string(from: Date())
+        let fileString = "[\((String(describing: fileName) as NSString).lastPathComponent):\(lineNumber)] \(functionName)"
+        
+        print("\(timeString) [\(event.rawValue)] - [\(category._key)] - \(fileString) > \(message)")
+        
+    }
+}

Example/Resources/Info.plist

@@ -17,7 +17,7 @@
 	<key>CFBundlePackageType</key>
 	<string>APPL</string>
 	<key>CFBundleShortVersionString</key>
-	<string>1.0.0</string>
+	<string>2.0.0</string>
 	<key>CFBundleVersion</key>
 	<string>1</string>
 	<key>LSRequiresIPhoneOS</key>

Example/ViewController.swift

@@ -43,10 +43,12 @@ class ViewController: UIViewController {
         self.view.backgroundColor = .white
 
         // Traditional methods
-        logger.debug("Hello Debug", logCategory: \.viewControllers)
-        logger.info("Hello Info", logCategory: \.viewControllers)
-        logger.fault("Hello Fault", logCategory: \.viewControllers)
-        logger.error("Hello Error", logCategory: \.viewControllers)
+        LogService.shared.debug("Hello Debug", logCategory: \.viewControllers)
+        LogService.shared.verbose("Hello Verbose", logCategory: \.viewControllers)
+        LogService.shared.info("Hello Info", logCategory: \.viewControllers)
+        LogService.shared.warning("Hello Warning", logCategory: \.viewControllers)
+        LogService.shared.error("Hello Error", logCategory: \.viewControllers)
+
 
         // Combine publishers
         sub = Result<Int, NumberError>.Publisher(5)

LoggingKit.xcodeproj/project.pbxproj

@@ -16,20 +16,19 @@
    </a>   
 </p>
 
-
-
 <p align="center">
-LoggingKit is a micro framework for logging in which uses `os_log` under the hood. 
+LoggingKit is a micro framework for logging based on log providers 
 </p>
 
 ## Features
 
-- [x] Uses `os_log` under the hood
+- [x] Define your own log providers
 - [x] `Combine` ready
+- [x] Comes with pre-defined `OSLogProvider` which uses `os_log` under the hood
 
 ## Example
 
-The example application is the best way to see `LoggingKit` in action. Simply open the `LoggingKit.xcodeproj` and run the `Example` scheme. 
+The example application is the best way to see `LoggingKit` in action. Simply open the `LoggingKit.xcodeproj` and run the `Example` scheme.
 
 After the application has started you should see several log messages in your Xcode terminal and the `Console.app` for the device you ran the app on.
 
@@ -41,11 +40,11 @@ After the application has started you should see several log messages in your Xc
 
 To integrate LoggingKit into your Xcode project using Carthage, specify it in your `Cartfile`:
 
-```ogdl
+```
 github "alexanderwe/LoggingKit"
 ```
 
-Run `carthage update` to build the framework and drag the built `LoggingKit.framework` into your Xcode project. 
+Run `carthage update` to build the framework and drag the built `LoggingKit.framework` into your Xcode project.
 
 On your application targets’ “Build Phases” settings tab, click the “+” icon and choose “New Run Script Phase” and add the Framework path as mentioned in [Carthage Getting started Step 4, 5 and 6](https://github.com/Carthage/Carthage/blob/master/README.md#if-youre-building-for-ios-tvos-or-watchos)
 
@@ -55,7 +54,7 @@ To integrate using Apple's [Swift Package Manager](https://swift.org/package-man
 
 ```swift
 dependencies: [
-    .package(url: "https://github.com/alexanderwe/LoggingKit.git", from: "1.0.0")
+    .package(url: "https://github.com/alexanderwe/LoggingKit.git", from: "2.0.0")
 ]
 ```
 
@@ -67,8 +66,7 @@ If you prefer not to use any of the aforementioned dependency managers, you can
 
 ## Usage
 
-
-At first it makes sense to create an extensions on `LogCategories` to define your own categories. 
+At first it makes sense to create an extensions on `LogCategories` to define your own categories.
 
 ```swift
 import LoggingKit
@@ -80,24 +78,46 @@ extension LogCategories {
 }
 ```
 
-After that Simply import `LoggingKit` in the files you want to use the logging methods and use them accordingly 
+Then register your log providers in the `application(application:didFinishLaunchingWithOptions:)`.
 
 ```swift
-import LoggingKit 
+import LoggingKit
+
+class AppDelegate: UIResponder, UIApplicationDelegate {
 
-logger.debug("Hello Debug", logCategory: \.viewControllers)
-logger.info("Hello Info", logCategory: \.viewControllers)
-logger.fault("Hello Fault", logCategory: \.viewControllers)
-logger.error("Hello Error", logCategory: \.viewControllers)
+    ...
 
+    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions:[UIApplication.LaunchOptionsKey: Any]?) -> Bool {
+
+        LogService.register(logProviders: LogProvider, LogProvider ...)
+
+    }
+
+    ...
+}
 ```
 
-### Combine 
+After that Simply import `LoggingKit` in the files you want to use the logging methods and use them accordingly
 
-If you are using combine `LoggingKit` offers some extensions on the `Publisher` type to log `Self.Output` and `Self.Failure`. 
+```swift
+import LoggingKit
+
+LogService.shared.debug("Hello Debug", logCategory: \.viewControllers)
+LogService.shared.verbose("Hello Verbose", logCategory: \.viewControllers)
+LogService.shared.info("Hello Info", logCategory: \.viewControllers)
+LogService.shared.warning("Hello Warning", logCategory: \.viewControllers)
+LogService.shared.error("Hello Error", logCategory: \.viewControllers)
+
+```
+
+### Combine
+
+If you are using combine, `LoggingKit` offers some extensions on the `Publisher` type to log `Self.Output` and `Self.Failure`.
+
+You can choose whichever category you want. The `\.combine` category is a custom defined one.
 
 ```swift
-import LoggingKit 
+import LoggingKit
 
 // logs `Self.Output`
 myPublisher.logValue(logType: .info, logCategory: \.combine) {
@@ -113,15 +133,24 @@ myPublisher.logError(logCategory: \.combine) {
 myPublisher.log()
 ```
 
+### Providers
+
+The idea behind this small framework is, that you can extend it by writing your own log providers by conforming to the `LogProvider` protocol. These implementations then can be registered in the `LogService.register(providers:)` method.
 
-### Console App
+You can find an example `LogProvider` implementation in [./Example/MyTestLogProvider.swift](./Example/MyTestLogProvider.swift)
 
-Now can open `Console.App` on your mac, select the device from which you want to view the log messages.
+#### OSLogProvider
 
+LoggingKit comes with one pre-defined `OSLogProvider` . It uses `os_log` under the hood to log your messages. These messages can then be viewed in the `Console.app` application of your mac and on the console in Xcode.
+
+##### Console App
+
+Open `Console.App` on your mac, select the device from which you want to view the log messages, to view the messages printed by the `OSLogProvider`
 
 ![Console App Screenshot](./assets/console_screenshot.png)
 
 ## Contributing
+
 Contributions are very welcome 🙌
 
 ## License

README.md

@@ -32,16 +32,16 @@ extension Publisher {
 
         return self
             .mapError {
-                logger.doLog(message($0),
-                             logType: .error,
-                             logCategory: logCategory,
-                             functionName: functionName,
-                             fileName: fileName,
-                             lineNumber: lineNumber
+                LogService.shared.error(
+                    message($0),
+                    logCategory: logCategory,
+                    fileName: fileName,
+                    functionName: functionName,
+                    lineNumber: lineNumber
                 )
                 return $0
-            }
-            .eraseToAnyPublisher()
+        }
+        .eraseToAnyPublisher()
     }
 
     /// Publisher which logs the ouput value of the preceding publisher
@@ -54,7 +54,7 @@ extension Publisher {
     ///   - lineNumber: Line number in which the message is logged
     ///   - message: Message to log
     /// - Returns: Returns an AnyPublisher with `AnyPublisher<Self.Output, Self.Failure>`
-    public func logValue(logType: OSLogType = .default,
+    public func logValue(logType: LogType = .verbose,
                          logCategory: KeyPath<LogCategories, LogCategory> = \.default,
                          functionName: StaticString = #function,
                          fileName: StaticString = #file,
@@ -64,16 +64,16 @@ extension Publisher {
 
         return self
             .map {
-                logger.doLog(message($0),
-                             logType: logType,
-                             logCategory: logCategory,
-                             functionName: functionName,
-                             fileName: fileName,
-                             lineNumber: lineNumber
+                LogService.shared.log(logType,
+                                      message($0),
+                                      logCategory: logCategory,
+                                      fileName: fileName,
+                                      functionName: functionName,
+                                      lineNumber: lineNumber
                 )
                 return $0
-            }
-            .eraseToAnyPublisher()
+        }
+        .eraseToAnyPublisher()
     }
 
     /// Publisher which both logs the Self.Failure value and the Self.Output value of the preceding publisher
@@ -89,7 +89,7 @@ extension Publisher {
     public func log(
         messageValue: @escaping (Self.Output) -> Any? = { (output: Self.Output) in return output },
         messageError: @escaping (Self.Failure) -> Any? = { (output: Self.Failure) in return output },
-        valuelogType: OSLogType = .default,
+        valuelogType: LogType = .verbose,
         logCategory: KeyPath<LogCategories, LogCategory> = \.default,
         functionName: StaticString = #function,
         fileName: StaticString = #file,
@@ -103,13 +103,13 @@ extension Publisher {
                           fileName: fileName,
                           lineNumber: lineNumber,
                           messageValue
-                )
+            )
                 .logError(logCategory: logCategory,
                           functionName: functionName,
                           fileName: fileName,
                           lineNumber: lineNumber,
                           messageError
-                )
+            )
                 .eraseToAnyPublisher()
     }
 }

Sources/Combine+LoggingKit.swift renamed to Sources/Combine/Combine+LoggingKit.swift

@@ -19,7 +19,7 @@ public var LoggingCategories = LogCategories()
 /// Container for holding different log categories
 public struct LogCategories {
 
-    subscript(keyPath: KeyPath<LogCategories, LogCategory>) -> LogCategory {
+    public subscript(keyPath: KeyPath<LogCategories, LogCategory>) -> LogCategory {
           return self[keyPath: keyPath]
     }
 }
@@ -38,7 +38,7 @@ public struct LogCategory {
     //swiftlint:enable identifier_name
 
     var logger: OSLog {
-        return OSLog(subsystem: Bundle.main.bundleIdentifier ?? "dev.teabye.loggingkit", category: _key)
+        return OSLog(subsystem: Bundle.main.bundleIdentifier ?? "dev.teabyte.loggingkit", category: _key)
     }
 
     public init(_ key: String) {