Skip to content

Commit

Permalink
#17: Picking up where We left off
Browse files Browse the repository at this point in the history 
- Addressing PR comments
- Cleaning up the code & docs a bit
- Adding SwiftUI-style extension statics
  • Loading branch information
@KyNorthstar
KyNorthstar committed Jun 9, 2023
1 parent 5792ee6 commit f12794c
Show file tree
Hide file tree
Showing 11 changed files with 252 additions and 125 deletions.
2 changes: 1 addition & 1 deletion Sources/SimpleLogging/CombinedLoggable.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import LazyContainers



/// Two lazily-combined loggables
/// Two lazily-combined ``Loggable``s
@usableFromInline
internal struct CombinedLoggable: Loggable {

Expand Down
104 changes: 30 additions & 74 deletions Sources/SimpleLogging/LogChannel/LogChannel.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,16 @@ public struct LogChannel<Location: UnreliableLogChannelLocation>: AnyLogChannel
public var severityFilter: LogSeverityFilter

/// The style of the severity part of a log line in this channel
public let logSeverityNameStyle: SeverityNameStyle
@inline(__always)
public var logSeverityNameStyle: SeverityNameStyle {
get { options.severityStyle }

@available(*, unavailable, message: """
Ability to change a channel's log severity was removed in SimpleLogging 0.6 to reduce complexity and improve performance.
See PR #17: https://github.com/RougeWare/Swift-Simple-Logging/pull/17
""")
set { }
}


/// The logging options to use with each message
Expand All @@ -54,10 +63,8 @@ public struct LogChannel<Location: UnreliableLogChannelLocation>: AnyLogChannel
/// - Parameters:
/// - name: The human-readable name of the channel
/// - location: The location where the logs are channeled to
/// - severityFilter: _optional_ - The filter which decides which messages appear in this channel's logs. Defaults to allowing `info` and higher, since `info` is the lowest built-in severity which users might care about if they're looking at logs, but not debugging the code itself.
/// - severityFilter: _optional_ - The filter which decides which messages appear in this channel's logs. Defaults to `.default`
/// - logSeverityNameStyle: _optional_ - The style of the severity names that appear in the log. Defaults to `.default`.
///
/// - Throws: Any error which occurs while trying to create the channel
public init(
name: String,
location: Location,
Expand All @@ -67,7 +74,6 @@ public struct LogChannel<Location: UnreliableLogChannelLocation>: AnyLogChannel
self.name = name
self.location = location
self.severityFilter = severityFilter
self.logSeverityNameStyle = logSeverityNameStyle
self.options = LoggingOptions(severityStyle: logSeverityNameStyle)
}

Expand All @@ -79,8 +85,6 @@ public struct LogChannel<Location: UnreliableLogChannelLocation>: AnyLogChannel
/// - location: The location to which this channel sends its log messages
/// - lowestAllowedSeverity: _optional_ - The lowest severity which will appear in this channel's logs. Defaults to `defaultFilter`, since that's the lowest built-in severity which users might care about if they're looking at logs, but not debugging the code itself.
/// - logSeverityNameStyle: _optional_ - The style of the severity names that appear in the log. Defaults to `.default`.
///
/// - Throws: Any error which occurs while trying to create the channel
public init(
name: String,
location: Location,
Expand All @@ -97,12 +101,16 @@ public struct LogChannel<Location: UnreliableLogChannelLocation>: AnyLogChannel



// MARK: - Appending

public extension LogChannel {

/// Appends the given log message to this channel. If that can't be done, (for example, if the channel's location
/// is a file on a read-only volume) a semantic error is thrown.
/// Appends the given log message to this channel if the severity filter allows. If that can't be done, (for example, if the channel's location
/// is a file on a read-only volume) a description of the problem, along with the logged message,is printed to the destination of Swift's built-in ``print(_:)``.
///
/// - Note: The channel might choose to hold this log message in a buffer, for instance while it waits for a log file to be created
/// Of course, if the severity filter does not allow this message, then no action is taken.
///
/// - Note: The channel might choose to hold this log message in a buffer, for instance while it waits for a log file to be created, or a network call to complete.
///
/// - Parameter message: The message to append to this channel
func append(_ message: LogMessageProtocol) {
Expand All @@ -121,74 +129,22 @@ public extension LogChannel {
""")
}
}
}



// MARK: - LogSeverityFilter

/// A filter which can be applied to a log channel to specify which messages are allowed through, based on their severities
//@dynamicMemberLookup // Would love this, but doesn't seem it works quite yet
public enum LogSeverityFilter {

/// All messages are allowed
case allowAll

/// No messages are allowed
case allowNone

/// Only allow messages of this severity
case only(LogSeverity)

/// Only allow messages whose severity is in this range of severities
case range(ClosedRange<LogSeverity>)

/// Allow messages with this severity and higher
case specificAndHigher(lowest: LogSeverity)



// static subscript(dynamicMember keyPath: KeyPath<LogSeverity.Type, LogSeverity>) -> LogSeverityFilter {
// return .specificAndHigher(lowest: LogSeverity.self[keyPath: keyPath])
// }


/// The filter that's used by default, if none is specified
public static var `default`: Self { specificAndHigher(lowest: .info) }
}



public extension LogSeverityFilter {

/// Whether or not this filter allows the given message to be logged
/// Appends the given log message to this channel if the severity filter allows.
///
/// - Parameter message: The message which might be allowed through this filter
/// - Returns: `true` iff the given message is allowed through this filter
@inline(__always)
func allows(_ message: LogMessageProtocol) -> Bool {
allows(message.severity)
}


/// Whether or not this fitler allows messages with the given severity to be logged
/// Of course, if the severity filter does not allow this message, then no action is taken.
///
/// - Parameter severity: A severity to check against this filter
/// - Returns: `true` iff messages with the given severity are allowed through this filter
@inlinable
func allows(_ severity: LogSeverity) -> Bool {
switch self {
case .allowAll: return true
case .allowNone: return false

case .only(severity): return true
case .only(_): return false

case .range(let range):
return range.contains(severity)

case .specificAndHigher(lowest: let lowest):
return lowest <= severity
/// - Note: The channel might choose to hold this log message in a buffer, for instance while it waits for a log file to be created, or a network call to complete.
///
/// - Parameter message: The message to append to this channel
func append(_ message: LogMessageProtocol)
where Location: LogChannelLocation
{
guard severityFilter.allows(message) else {
return
}

location.append(message, options: options)
}
}
8 changes: 8 additions & 0 deletions Sources/SimpleLogging/LogChannel/LogChannelLocation + Swift.print.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,14 @@ public struct SwiftPrintDefaultLogChannelLocation: SingletonLogChannelLocation {



public extension UnreliableLogChannelLocation where Self == SwiftPrintDefaultLogChannelLocation {

/// The default place to which Swift's `print` function is directed
static var swiftPrint: Self { .shared }
}



public extension LogChannel
where Location == SwiftPrintDefaultLogChannelLocation {

Expand Down
20 changes: 18 additions & 2 deletions Sources/SimpleLogging/LogChannel/LogChannelLocation + custom.swift
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public struct CustomLogChannelLocation: LogChannelLocation {
/// Create a new custom log channel location
///
/// The function is passed the fully-rendered log line, like
/// `2020-11-20 05:26:49.178Z ⚠️ LogToFileTests.swift:144 testLogOnlyCriticalSeveritiesToFile() This message is a warning`
/// `"2020-11-20 05:26:49.178Z ⚠️ LogToFileTests.swift:144 testLogOnlyCriticalSeveritiesToFile() This message is a warning"`
///
/// - Parameter logger: Passed the fully-rendered log line
init(loggingTo logger: @escaping Callback<String>) {
Expand All @@ -37,12 +37,27 @@ public struct CustomLogChannelLocation: LogChannelLocation {



public extension UnreliableLogChannelLocation where Self == CustomLogChannelLocation {

/// Log to a function, so you can implement some custom logging channel without defining a new `struct`.
///
/// The function is passed the fully-rendered log line, like
/// `"2020-11-20 05:26:49.178Z ⚠️ LogToFileTests.swift:144 testLogOnlyCriticalSeveritiesToFile() This message is a warning"`
///
/// - Parameter logger: Passed the fully-rendered log line
static func custom(loggingTo logger: @escaping Callback<String>) -> Self {
.init(loggingTo: logger)
}
}



public extension LogChannel where Location == CustomLogChannelLocation {

/// Log to a function, so you can implement some custom logging channel without defining a new `struct`.
///
/// The function is passed the fully-rendered log line, like
/// `2020-11-20 05:26:49.178Z ⚠️ LogToFileTests.swift:144 testLogOnlyCriticalSeveritiesToFile() This message is a warning`
/// `"2020-11-20 05:26:49.178Z ⚠️ LogToFileTests.swift:144 testLogOnlyCriticalSeveritiesToFile() This message is a warning"`
///
/// - Parameters:
/// - logger: Passed the fully-rendered log line
Expand All @@ -61,6 +76,7 @@ public extension LogChannel where Location == CustomLogChannelLocation {
logSeverityNameStyle: logSeverityNameStyle)
}


/// Log to a function, so you can implement some custom logging channel without defining a new `struct`.
///
/// The function is passed the fully-rendered log line, like
Expand Down
Loading

0 comments on commit f12794c

Please sign in to comment.