wnagrodzki/SwiftLogger
1
0
Fork 0
mirror of https://github.com/wnagrodzki/SwiftLogger.git synced 2025-04-06 12:31:51 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'feature/message_as_string' into develop

Browse source
This commit is contained in:
Wojciech Nagrodzki 2018-08-22 20:00:00 +02:00
commit 0429d58fdc
Signed by: wnagrodzki
GPG key ID: E9D0EB0302264569
5 changed files with 12 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
Logger/Logger.swift
View file

@ -35,8 +35,8 @@ public protocol Logger {
/// - time: The date log method was called.
/// - level: The log level.
/// - location: Part of the log message provided by `description(for file: String, line: Int, function: String)` method.
/// - object: Part of the log message provided by `description(for object: Any)` method.
func log(time: Date, level: LogLevel, location: String, object: String)
/// - message: The message to be logged.
func log(time: Date, level: LogLevel, location: String, message: @autoclosure () -> String)
/// Transforms passed parameters into location textual representation which will be a part of the log message.
///
@ -47,14 +47,6 @@ public protocol Logger {
/// - line: The line number log method was called at.
/// - function: The name of the declaration log method was called within.
func description(for file: String, line: Int, function: String) -> String
/// Transforms `object` into textual representation which will be a part of the log message.
///
/// Customization point. Default implementation returns `logDescription` for objects implementing `LogStringConvertible`,
/// or `String(describing:object)` otherwise.
///
/// - Parameter object: The object to be logged.
func description(for object: Any) -> String
}
/// Log level controls the conditions under which a message should be logged.
@ -107,16 +99,15 @@ extension Logger {
/// Sends object to the logging system, optionally specifying a custom log level.
///
/// - Parameters:
/// - object: The object to be logged.
/// - message: The message to be logged.
/// - level: The log level.
/// - file: **Do not provide a custom value.** The path to the file log method is called from.
/// - line: **Do not provide a custom value.** The line number log method is called at.
/// - function: **Do not provide a custom value.** The name of the declaration log method is called within.
public func log(_ object: Any, level: LogLevel, file: String = #file, line: Int = #line, function: String = #function) {
public func log(_ message: @autoclosure () -> String, level: LogLevel, file: String = #file, line: Int = #line, function: String = #function) {
let now = Date()
let location = description(for: file, line: line, function: function)
let objectDescription = description(for: object)
log(time: now, level: level, location: location, object: objectDescription)
log(time: now, level: level, location: location, message: message)
}
/// Returns location in format `"<file name>:<line> <function>"`.
@ -124,14 +115,6 @@ extension Logger {
return filename(fromFilePath: file) + ":\(line) \(function)"
}
/// Returns `logDescription` for objects implementing `LogStringConvertible`, or `String(describing:object)` otherwise.
public func description(for object: Any) -> String {
if let logStringConvertible = object as? LogStringConvertible {
return logStringConvertible.logDescription
}
return String(describing: object)
}
private func filename(fromFilePath path: String) -> String {
return URL(fileURLWithPath: path).deletingPathExtension().lastPathComponent
}

4
Logger/Loggers/AgregateLogger.swift
View file

@ -36,9 +36,9 @@ public final class AgregateLogger: Logger {
self.loggers = loggers
}
public func log(time: Date, level: LogLevel, location: String, object: String) {
public func log(time: Date, level: LogLevel, location: String, message: @autoclosure () -> String) {
for logger in self.loggers {
logger.log(time: time, level: level, location: location, object: object)
logger.log(time: time, level: level, location: location, message: message)
}
}
}

4
Logger/Loggers/ConsoleLogger.swift
View file

@ -35,7 +35,7 @@ public final class ConsoleLogger: Logger {
formatter.timeZone = TimeZone(secondsFromGMT: 0)
}
public func log(time: Date, level: LogLevel, location: String, object: String) {
print(formatter.string(from: time) + " <" + level.logDescription + "> " + location + " " + object)
public func log(time: Date, level: LogLevel, location: String, message: @autoclosure () -> String) {
print(formatter.string(from: time) + " <" + level.logDescription + "> " + location + " " + message())
}
}

4
Logger/Loggers/DiskLogger/DiskLogger.swift
View file

@ -50,8 +50,8 @@ public final class DiskLogger: Logger {
formatter.timeZone = TimeZone(secondsFromGMT: 0)
}
public func log(time: Date, level: LogLevel, location: String, object: String) {
let message = formatter.string(from: time) + " <" + level.logDescription + "> " + location + " " + object + "\n"
public func log(time: Date, level: LogLevel, location: String, message: @autoclosure () -> String) {
let message = formatter.string(from: time) + " <" + level.logDescription + "> " + location + " " + message() + "\n"
log(message)
}

7
Logger/Loggers/NullLogger.swift
View file

@ -29,7 +29,7 @@ public class NullLogger: Logger {
public init() {
}
public func log(time: Date, level: LogLevel, location: String, object: String) {
public func log(time: Date, level: LogLevel, location: String, message: @autoclosure () -> String) {
// noop
}
@ -37,9 +37,4 @@ public class NullLogger: Logger {
public func description(for file: String, line: Int, function: String) -> String {
return ""
}
/// Returns empty string to minimize observer effect.
public func description(for object: Any) -> String {
return ""
}
}