Merge pull request #15 from appunite/feature_decorated_levels

Feature decorated levels

CHANGELOG.md

@@ -5,7 +5,9 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
-- Add colored formatter
+- Add decorated formatter
+- Add decorator for level color changing
+- Add decorator for level emoji prefixes
 
 ## [0.1.0]
 - Add .travis.yml for CI support

Example/Environment.swift

@@ -11,8 +11,11 @@ import Spy
 public struct Environment {
     public static var spy: AnySpy<SpyLevel, SpyChannel> = {
         return CompositeSpy()
-            .add(spy: ConsoleSpy<SpyLevel, SpyChannel, RawSpyFormatter>(
-                spyFormatter: RawSpyFormatter(),
+            .add(spy: ConsoleSpy<SpyLevel, SpyChannel, DecoratedSpyFormatter>(
+                spyFormatter: DecoratedSpyFormatter(
+                    levelNameBuilder: DecoratedLevelNameBuilder<SpyLevel>()
+                        .add(decorator: EmojiPrefixedSpyLevelNameDecorator().toAnyDecorator())
+                        ),
                 timestampProvider: CurrentTimestampProvider(),
                 configuration: SpyConfigurationBuilder()
                     .add(levels: SpyLevel.levelsFrom(loggingLevel))

README.md

@@ -120,15 +120,32 @@ Logging is performed with **log** method as follows:
 spy.log(level: .severe, channel: .foo, message: "Something bad happened")
 ```
 
+#### ConsoleSpy
+ConsoleSpy comes with two available output formatters **RawSpyFormatter** and **DecoratedSpyFormatter** with the later being extendable with decorators. You can always define your own output formatter.
+Example output for *RawSpyFormatter* will look like:
+```
+info::foo::Hello Spy
+```
+And example output for *DecoratedSpyFormatter* may look like:
+```
+ℹ️ info::foo::Hello Spy
+```
+<p align="center">
+  <img src="resources/log.png" alt="Log example"/>
+</p>
+
 ## Example
 This is an example definition of the spies.
 It utilizes *CompositeSpy* to allow you to log onto multiple destinations (*Console* and *Network*). Please note that *ConsoleSpy* is shipped with the *Spy* and *NetworkSpy* is not.
 ```swift
 public struct Environment {
     public static var spy: AnySpy<SpyLevel, SpyChannel> = {
         return CompositeSpy()
-            .add(spy: ConsoleSpy<SpyLevel, SpyChannel, RawSpyFormatter>(
-                spyFormatter: RawSpyFormatter(),
+            .add(spy: ConsoleSpy<SpyLevel, SpyChannel, DecoratedSpyFormatter>(
+                spyFormatter: DecoratedSpyFormatter(
+                    levelNameBuilder: DecoratedLevelNameBuilder<SpyLevel>()
+                        .add(decorator: EmojiPrefixedSpyLevelNameDecorator().toAnyDecorator())
+                        ),
                 timestampProvider: CurrentTimestampProvider(),
                 configuration: SpyConfigurationBuilder()
                     .add(levels: SpyLevel.levelsFrom(loggingLevel))

Spy/Common/Formatters/Decorated/AnyLevelDecorator.swift

@@ -0,0 +1,38 @@
+//
+//  AnyLevelDecorator.swift
+//  Spy
+//
+//  Created by Tomasz Lewandowski on 24/01/2020.
+//  Copyright © 2020 AppUnite Sp. z o.o. All rights reserved.
+//
+
+public final class AnyLevelDecorator<Level: PSpyLevel>: PSpyLevelDecorator {
+    private let decorator: _AnyLevelDecoratorBase<Level>
+
+    public init<Decorator: PSpyLevelDecorator>(_ decorator: Decorator) where Decorator.Level == Level {
+        self.decorator = _AnyLevelDecoratorBox(decorator)
+    }
+
+    public func decorate(level: Level, value: String) -> String {
+        return decorator.decorate(level: level, value: value)
+    }
+}
+
+private final class _AnyLevelDecoratorBox<Decorator: PSpyLevelDecorator>: _AnyLevelDecoratorBase<Decorator.Level> {
+    let decorator: Decorator
+
+    init(_ decorator: Decorator) {
+        self.decorator = decorator
+        super.init()
+    }
+
+    override func decorate(level: Level, value: String) -> String {
+        return decorator.decorate(level: level, value: value)
+    }
+}
+
+private class _AnyLevelDecoratorBase<Level: PSpyLevel>: PSpyLevelDecorator {
+    func decorate(level: Level, value: String) -> String {
+        fatalError("Must be overriden")
+    }
+}

Spy/Common/Formatters/Decorated/ColoredSpyLevelNameDecorator.swift

@@ -0,0 +1,33 @@
+//
+//  ColoredSpyLevelNameDecorator.swift
+//  Spy
+//
+//  Created by Tomasz Lewandowski on 24/01/2020.
+//  Copyright © 2020 AppUnite Sp. z o.o. All rights reserved.
+//
+
+public final class ColoredSpyLevelNameDecorator: PSpyLevelDecorator {
+    public typealias Level = SpyLevel
+
+    public init() {
+
+    }
+
+    public func decorate(level: SpyLevel, value: String) -> String {
+        return value.colored(with: level.color)
+    }
+}
+
+private extension SpyLevel {
+    var color: SpyColor {
+        switch self {
+        case .finest: return .white
+        case .finer: return .cyan
+        case .fine: return .blue
+        case .config: return .magenta
+        case .info: return .green
+        case .warning: return .yellow
+        case .severe: return .red
+        }
+    }
+}

Spy/Common/Formatters/Decorated/DecoratedLevelBuilder.swift

@@ -0,0 +1,28 @@
+//
+//  DecoratedLevelNameBuilder.swift
+//  Spy
+//
+//  Created by Tomasz Lewandowski on 24/01/2020.
+//  Copyright © 2020 AppUnite Sp. z o.o. All rights reserved.
+//
+
+public final class DecoratedLevelNameBuilder<Level: PSpyLevel> {
+    private var decorators: [AnyLevelDecorator<Level>] = []
+
+    public init() {
+        add(decorator: PlainLevelNameDecorator().toAnyDecorator())
+    }
+
+    @discardableResult public func add(decorator: AnyLevelDecorator<Level>) -> DecoratedLevelNameBuilder<Level> {
+        decorators.append(decorator)
+        return self
+    }
+
+    public func build(withLevel level: Level) -> String {
+        var decoratedLevelName = ""
+        for decorator in decorators {
+            decoratedLevelName = decorator.decorate(level: level, value: decoratedLevelName)
+        }
+        return decoratedLevelName
+    }
+}

Spy/Common/Formatters/Decorated/DecoratedSpyFormatter.swift

@@ -0,0 +1,21 @@
+//
+//  DecoratedSpyFormatter.swift
+//  Spy
+//
+//  Created by Tomasz Lewandowski on 24/01/2020.
+//  Copyright © 2020 AppUnite Sp. z o.o. All rights reserved.
+//
+
+import Foundation
+
+public final class DecoratedSpyFormatter<Level: PSpyLevel, Channel: PSpyChannel>: PSpyFormatter {
+    let levelNameBuilder: DecoratedLevelNameBuilder<Level>
+
+    public init(levelNameBuilder: DecoratedLevelNameBuilder<Level>) {
+        self.levelNameBuilder = levelNameBuilder
+    }
+
+    public func format(timestamp: TimeInterval, level: Level, channel: Channel, message: PSpyable) -> String {
+        return "\(Date(timeIntervalSince1970: timestamp)) \(levelNameBuilder.build(withLevel: level))::\(channel.channelName)::\(message.spyMessage)"
+    }
+}

Spy/Common/Formatters/Decorated/EmojiPrefixedSpyLevelDecorator.swift

@@ -0,0 +1,33 @@
+//
+//  EmojiPrefixedSpyLevelNameDecorator.swift
+//  Spy
+//
+//  Created by Tomasz Lewandowski on 24/01/2020.
+//  Copyright © 2020 AppUnite Sp. z o.o. All rights reserved.
+//
+
+public final class EmojiPrefixedSpyLevelNameDecorator: PSpyLevelDecorator {
+    public init() {
+
+    }
+
+    public func decorate(level: SpyLevel, value: String) -> String {
+        return level.prefix + " " + value
+    }
+
+    public typealias Level = SpyLevel
+}
+
+private extension SpyLevel {
+    var prefix: String {
+        switch self {
+        case .finest: return "💬"
+        case .finer: return "🔊"
+        case .fine: return "📣"
+        case .config: return "✅"
+        case .info: return "ℹ️"
+        case .warning: return "⚠️"
+        case .severe: return "⛔"
+        }
+    }
+}

Spy/Common/Formatters/Decorated/PSpyLevelDecorator.swift

@@ -0,0 +1,18 @@
+//
+//  PSpyLevelDecorator.swift
+//  Spy
+//
+//  Created by Tomasz Lewandowski on 24/01/2020.
+//  Copyright © 2020 AppUnite Sp. z o.o. All rights reserved.
+//
+
+public protocol PSpyLevelDecorator {
+    associatedtype Level: PSpyLevel
+    func decorate(level: Level, value: String) -> String
+}
+
+public extension PSpyLevelDecorator {
+    func toAnyDecorator() -> AnyLevelDecorator<Level> {
+        return AnyLevelDecorator(self)
+    }
+}

Spy/Common/Formatters/Decorated/PlainLevelNameDecorator.swift

@@ -0,0 +1,16 @@
+//
+//  PlainLevelNameDecorator.swift
+//  Spy
+//
+//  Created by Tomasz Lewandowski on 24/01/2020.
+//  Copyright © 2020 AppUnite Sp. z o.o. All rights reserved.
+//
+
+public final class PlainLevelNameDecorator<Level: PSpyLevel>: PSpyLevelDecorator {
+    public init() {
+
+    }
+    public func decorate(level: Level, value: String) -> String {
+        return level.levelName
+    }
+}

Spy/Common/SpyLevel.swift

@@ -6,7 +6,7 @@
 //  Copyright © 2020 AppUnite Sp. z o.o. All rights reserved.
 //
 
-public enum SpyLevel: Int, PColoredSpyLevel {
+public enum SpyLevel: Int, PSpyLevel {
     case finest = 0
     case finer = 1
     case fine = 2
@@ -34,16 +34,4 @@ public enum SpyLevel: Int, PColoredSpyLevel {
     public static func levelsFrom(_ level: SpyLevel) -> Set<SpyLevel> {
         return Set([SpyLevel.finest, .finer, .fine, .config, .info, .warning, .severe]).filter { $0.levelPriority >= level.levelPriority }
     }
-
-    public var color: SpyColor {
-        switch self {
-        case .finest: return .white
-        case .finer: return .cyan
-        case .fine: return .blue
-        case .config: return .magenta
-        case .info: return .green
-        case .warning: return .yellow
-        case .severe: return .red
-        }
-    }
 }

SpyTests/DecoratedSpyFormatterTests.swift

@@ -0,0 +1,33 @@
+//
+//  DecoratedSpyFormatterTests.swift
+//  Spy
+//
+//  Created by Tomasz Lewandowski on 24/01/2020.
+//  Copyright © 2020 AppUnite Sp. z o.o. All rights reserved.
+//
+
+import XCTest
+import Spy
+
+final class DecoratedSpyFormatterTests: XCTestCase {
+    func testFormat_WhenCreatedWithBuilderWithColorDecorator_ShouldReturnStringInCorrectFormat() {
+        let sut = DecoratedSpyFormatter<SpyLevel, SpyChannel>(levelNameBuilder: DecoratedLevelNameBuilder<SpyLevel>().add(decorator: ColoredSpyLevelNameDecorator().toAnyDecorator()))
+        let formattedLog = sut.format(timestamp: 0, level: .info, channel: .defaultChannel, message: "message")
+        XCTAssertEqual("1970-01-01 00:00:00 +0000 \u{001B}[0;32minfo\u{001B}[0;0m::default_channel::message", formattedLog)
+    }
+
+    func testFormat_WhenCreatedWithBuilderWithEmijiDecorator_ShouldReturnStringInCorrectFormat() {
+        let sut = DecoratedSpyFormatter<SpyLevel, SpyChannel>(levelNameBuilder: DecoratedLevelNameBuilder<SpyLevel>().add(decorator: EmojiPrefixedSpyLevelNameDecorator().toAnyDecorator()))
+        let formattedLog = sut.format(timestamp: 0, level: .info, channel: .defaultChannel, message: "message")
+        XCTAssertEqual("1970-01-01 00:00:00 +0000 ℹ️ info::default_channel::message", formattedLog)
+    }
+
+    func testFormat_WhenCreatedWithBuilderWithTwoDecorators_ShouldReturnStringInCorrectFormat() {
+        let sut = DecoratedSpyFormatter<SpyLevel, SpyChannel>(levelNameBuilder: DecoratedLevelNameBuilder<SpyLevel>()
+            .add(decorator: ColoredSpyLevelNameDecorator().toAnyDecorator())
+            .add(decorator: EmojiPrefixedSpyLevelNameDecorator().toAnyDecorator())
+        )
+        let formattedLog = sut.format(timestamp: 0, level: .info, channel: .defaultChannel, message: "message")
+        XCTAssertEqual("1970-01-01 00:00:00 +0000 ℹ️ \u{001B}[0;32minfo\u{001B}[0;0m::default_channel::message", formattedLog)
+    }
+}

SpyTests/EmojiPrefixedSpyLevelNameDecoratorTests.swift

@@ -0,0 +1,25 @@
+//
+//  EmojiPrefixedSpyLevelNameDecoratorTests.swift
+//  Spy
+//
+//  Created by Tomasz Lewandowski on 24/01/2020.
+//  Copyright © 2020 AppUnite Sp. z o.o. All rights reserved.
+//
+
+import XCTest
+import Spy
+
+public final class EmojiPrefixedSpyLevelNameDecoratorTests: XCTestCase {
+    func testDecorate_WhenCalledWithLevel_ShouldReturnCorrectString() {
+        // given
+        let sut = EmojiPrefixedSpyLevelNameDecorator()
+        // then
+        XCTAssertEqual("💬 name", sut.decorate(level: .finest, value: "name"))
+        XCTAssertEqual("🔊 name", sut.decorate(level: .finer, value: "name"))
+        XCTAssertEqual("📣 name", sut.decorate(level: .fine, value: "name"))
+        XCTAssertEqual("✅ name", sut.decorate(level: .config, value: "name"))
+        XCTAssertEqual("ℹ️ name", sut.decorate(level: .info, value: "name"))
+        XCTAssertEqual("⚠️ name", sut.decorate(level: .warning, value: "name"))
+        XCTAssertEqual("⛔ name", sut.decorate(level: .severe, value: "name"))
+    }    
+}

SpyTests/SpyColorTests.swift

@@ -11,6 +11,7 @@ import Spy
 
 public final class SpyColorTests: XCTestCase {
     func testModificator_WhenCalledForColor_ShouldReturnCorrectString() {
+        // then
         XCTAssertEqual("\u{001B}[0;0m", SpyColor.`default`.modificator)
         XCTAssertEqual("\u{001B}[0;30m", SpyColor.black.modificator)
         XCTAssertEqual("\u{001B}[0;31m", SpyColor.red.modificator)