From ce402d769c8bcfabf646aaa5c8660527a9951452 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Tue, 14 Aug 2018 08:21:45 +0200 Subject: [PATCH 01/37] Created initial Xcode project --- Logger.xcodeproj/project.pbxproj | 293 ++++++++++++++++++ .../contents.xcworkspacedata | 7 + .../xcshareddata/IDEWorkspaceChecks.plist | 8 + Logger/Logger.swift | 27 ++ 4 files changed, 335 insertions(+) create mode 100644 Logger.xcodeproj/project.pbxproj create mode 100644 Logger.xcodeproj/project.xcworkspace/contents.xcworkspacedata create mode 100644 Logger.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist create mode 100644 Logger/Logger.swift diff --git a/Logger.xcodeproj/project.pbxproj b/Logger.xcodeproj/project.pbxproj new file mode 100644 index 0000000..232e149 --- /dev/null +++ b/Logger.xcodeproj/project.pbxproj @@ -0,0 +1,293 @@ +// !$*UTF8*$! +{ + archiveVersion = 1; + classes = { + }; + objectVersion = 50; + objects = { + +/* Begin PBXBuildFile section */ + 2EBF4B3E2122AA34008E4117 /* Logger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B3D2122AA34008E4117 /* Logger.swift */; }; +/* End PBXBuildFile section */ + +/* Begin PBXCopyFilesBuildPhase section */ + 2EBF4B382122AA34008E4117 /* CopyFiles */ = { + isa = PBXCopyFilesBuildPhase; + buildActionMask = 2147483647; + dstPath = "include/$(PRODUCT_NAME)"; + dstSubfolderSpec = 16; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXCopyFilesBuildPhase section */ + +/* Begin PBXFileReference section */ + 2EBF4B3A2122AA34008E4117 /* libLogger.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = libLogger.a; sourceTree = BUILT_PRODUCTS_DIR; }; + 2EBF4B3D2122AA34008E4117 /* Logger.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Logger.swift; sourceTree = ""; }; +/* End PBXFileReference section */ + +/* Begin PBXFrameworksBuildPhase section */ + 2EBF4B372122AA34008E4117 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXFrameworksBuildPhase section */ + +/* Begin PBXGroup section */ + 2EBF4B312122AA34008E4117 = { + isa = PBXGroup; + children = ( + 2EBF4B3C2122AA34008E4117 /* Logger */, + 2EBF4B3B2122AA34008E4117 /* Products */, + ); + sourceTree = ""; + }; + 2EBF4B3B2122AA34008E4117 /* Products */ = { + isa = PBXGroup; + children = ( + 2EBF4B3A2122AA34008E4117 /* libLogger.a */, + ); + name = Products; + sourceTree = ""; + }; + 2EBF4B3C2122AA34008E4117 /* Logger */ = { + isa = PBXGroup; + children = ( + 2EBF4B3D2122AA34008E4117 /* Logger.swift */, + ); + path = Logger; + sourceTree = ""; + }; +/* End PBXGroup section */ + +/* Begin PBXNativeTarget section */ + 2EBF4B392122AA34008E4117 /* Logger */ = { + isa = PBXNativeTarget; + buildConfigurationList = 2EBF4B412122AA34008E4117 /* Build configuration list for PBXNativeTarget "Logger" */; + buildPhases = ( + 2EBF4B362122AA34008E4117 /* Sources */, + 2EBF4B372122AA34008E4117 /* Frameworks */, + 2EBF4B382122AA34008E4117 /* CopyFiles */, + ); + buildRules = ( + ); + dependencies = ( + ); + name = Logger; + productName = Logger; + productReference = 2EBF4B3A2122AA34008E4117 /* libLogger.a */; + productType = "com.apple.product-type.library.static"; + }; +/* End PBXNativeTarget section */ + +/* Begin PBXProject section */ + 2EBF4B322122AA34008E4117 /* Project object */ = { + isa = PBXProject; + attributes = { + LastSwiftUpdateCheck = 1000; + LastUpgradeCheck = 1000; + ORGANIZATIONNAME = "Wojciech Nagrodzki"; + TargetAttributes = { + 2EBF4B392122AA34008E4117 = { + CreatedOnToolsVersion = 10.0; + }; + }; + }; + buildConfigurationList = 2EBF4B352122AA34008E4117 /* Build configuration list for PBXProject "Logger" */; + compatibilityVersion = "Xcode 9.3"; + developmentRegion = en; + hasScannedForEncodings = 0; + knownRegions = ( + en, + ); + mainGroup = 2EBF4B312122AA34008E4117; + productRefGroup = 2EBF4B3B2122AA34008E4117 /* Products */; + projectDirPath = ""; + projectRoot = ""; + targets = ( + 2EBF4B392122AA34008E4117 /* Logger */, + ); + }; +/* End PBXProject section */ + +/* Begin PBXSourcesBuildPhase section */ + 2EBF4B362122AA34008E4117 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 2EBF4B3E2122AA34008E4117 /* Logger.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXSourcesBuildPhase section */ + +/* Begin XCBuildConfiguration section */ + 2EBF4B3F2122AA34008E4117 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_ENABLE_OBJC_WEAK = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_COMMA = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_STRICT_PROTOTYPES = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CLANG_WARN_UNGUARDED_AVAILABILITY = YES_AGGRESSIVE; + CLANG_WARN_UNREACHABLE_CODE = YES; + CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; + CODE_SIGN_IDENTITY = "iPhone Developer"; + COPY_PHASE_STRIP = NO; + DEBUG_INFORMATION_FORMAT = dwarf; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_TESTABILITY = YES; + GCC_C_LANGUAGE_STANDARD = gnu11; + GCC_DYNAMIC_NO_PIC = NO; + GCC_NO_COMMON_BLOCKS = YES; + GCC_OPTIMIZATION_LEVEL = 0; + GCC_PREPROCESSOR_DEFINITIONS = ( + "DEBUG=1", + "$(inherited)", + ); + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNDECLARED_SELECTOR = YES; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + IPHONEOS_DEPLOYMENT_TARGET = 12.0; + MTL_ENABLE_DEBUG_INFO = INCLUDE_SOURCE; + MTL_FAST_MATH = YES; + ONLY_ACTIVE_ARCH = YES; + SDKROOT = iphoneos; + SWIFT_ACTIVE_COMPILATION_CONDITIONS = DEBUG; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + }; + name = Debug; + }; + 2EBF4B402122AA34008E4117 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_ENABLE_OBJC_WEAK = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_COMMA = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_STRICT_PROTOTYPES = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CLANG_WARN_UNGUARDED_AVAILABILITY = YES_AGGRESSIVE; + CLANG_WARN_UNREACHABLE_CODE = YES; + CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; + CODE_SIGN_IDENTITY = "iPhone Developer"; + COPY_PHASE_STRIP = NO; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + GCC_C_LANGUAGE_STANDARD = gnu11; + GCC_NO_COMMON_BLOCKS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNDECLARED_SELECTOR = YES; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + IPHONEOS_DEPLOYMENT_TARGET = 12.0; + MTL_ENABLE_DEBUG_INFO = NO; + MTL_FAST_MATH = YES; + SDKROOT = iphoneos; + SWIFT_COMPILATION_MODE = wholemodule; + SWIFT_OPTIMIZATION_LEVEL = "-O"; + VALIDATE_PRODUCT = YES; + }; + name = Release; + }; + 2EBF4B422122AA34008E4117 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Automatic; + OTHER_LDFLAGS = "-ObjC"; + PRODUCT_NAME = "$(TARGET_NAME)"; + SKIP_INSTALL = YES; + SWIFT_VERSION = 4.2; + TARGETED_DEVICE_FAMILY = "1,2"; + }; + name = Debug; + }; + 2EBF4B432122AA34008E4117 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Automatic; + OTHER_LDFLAGS = "-ObjC"; + PRODUCT_NAME = "$(TARGET_NAME)"; + SKIP_INSTALL = YES; + SWIFT_VERSION = 4.2; + TARGETED_DEVICE_FAMILY = "1,2"; + }; + name = Release; + }; +/* End XCBuildConfiguration section */ + +/* Begin XCConfigurationList section */ + 2EBF4B352122AA34008E4117 /* Build configuration list for PBXProject "Logger" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 2EBF4B3F2122AA34008E4117 /* Debug */, + 2EBF4B402122AA34008E4117 /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 2EBF4B412122AA34008E4117 /* Build configuration list for PBXNativeTarget "Logger" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 2EBF4B422122AA34008E4117 /* Debug */, + 2EBF4B432122AA34008E4117 /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; +/* End XCConfigurationList section */ + }; + rootObject = 2EBF4B322122AA34008E4117 /* Project object */; +} diff --git a/Logger.xcodeproj/project.xcworkspace/contents.xcworkspacedata b/Logger.xcodeproj/project.xcworkspace/contents.xcworkspacedata new file mode 100644 index 0000000..0ca1195 --- /dev/null +++ b/Logger.xcodeproj/project.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,7 @@ + + + + + diff --git a/Logger.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/Logger.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 0000000..18d9810 --- /dev/null +++ b/Logger.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/Logger/Logger.swift b/Logger/Logger.swift new file mode 100644 index 0000000..518ad44 --- /dev/null +++ b/Logger/Logger.swift @@ -0,0 +1,27 @@ +// +// MIT License +// +// Copyright (c) 2018 Wojciech Nagrodzki +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. +// + +class Logger { + +} From b65fbcee400a67bd702dc25d35b97ab2fcd9e0bc Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Tue, 14 Aug 2018 08:28:44 +0200 Subject: [PATCH 02/37] Added Logger and LogStringConvertible protocols --- Logger.xcodeproj/project.pbxproj | 4 +++ Logger/LogStringConvertible.swift | 37 ++++++++++++++++++++++ Logger/Logger.swift | 52 ++++++++++++++++++++++++++++++- 3 files changed, 92 insertions(+), 1 deletion(-) create mode 100644 Logger/LogStringConvertible.swift diff --git a/Logger.xcodeproj/project.pbxproj b/Logger.xcodeproj/project.pbxproj index 232e149..13420fd 100644 --- a/Logger.xcodeproj/project.pbxproj +++ b/Logger.xcodeproj/project.pbxproj @@ -8,6 +8,7 @@ /* Begin PBXBuildFile section */ 2EBF4B3E2122AA34008E4117 /* Logger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B3D2122AA34008E4117 /* Logger.swift */; }; + 2EBF4B452122ACD6008E4117 /* LogStringConvertible.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B442122ACD6008E4117 /* LogStringConvertible.swift */; }; /* End PBXBuildFile section */ /* Begin PBXCopyFilesBuildPhase section */ @@ -25,6 +26,7 @@ /* Begin PBXFileReference section */ 2EBF4B3A2122AA34008E4117 /* libLogger.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = libLogger.a; sourceTree = BUILT_PRODUCTS_DIR; }; 2EBF4B3D2122AA34008E4117 /* Logger.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Logger.swift; sourceTree = ""; }; + 2EBF4B442122ACD6008E4117 /* LogStringConvertible.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = LogStringConvertible.swift; sourceTree = ""; }; /* End PBXFileReference section */ /* Begin PBXFrameworksBuildPhase section */ @@ -57,6 +59,7 @@ 2EBF4B3C2122AA34008E4117 /* Logger */ = { isa = PBXGroup; children = ( + 2EBF4B442122ACD6008E4117 /* LogStringConvertible.swift */, 2EBF4B3D2122AA34008E4117 /* Logger.swift */, ); path = Logger; @@ -120,6 +123,7 @@ buildActionMask = 2147483647; files = ( 2EBF4B3E2122AA34008E4117 /* Logger.swift in Sources */, + 2EBF4B452122ACD6008E4117 /* LogStringConvertible.swift in Sources */, ); runOnlyForDeploymentPostprocessing = 0; }; diff --git a/Logger/LogStringConvertible.swift b/Logger/LogStringConvertible.swift new file mode 100644 index 0000000..87bab24 --- /dev/null +++ b/Logger/LogStringConvertible.swift @@ -0,0 +1,37 @@ +// +// MIT License +// +// Copyright (c) 2018 Wojciech Nagrodzki +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. +// + +import Foundation + +public protocol LogStringConvertible { + var logDescription: String { get } +} + +extension Array: LogStringConvertible where Element: LogStringConvertible { + public var logDescription: String { + let descriptions = map { $0.logDescription } + let joinedDescriptions = descriptions.joined(separator: ", ") + return "[" + joinedDescriptions + "]" + } +} diff --git a/Logger/Logger.swift b/Logger/Logger.swift index 518ad44..5e229bd 100644 --- a/Logger/Logger.swift +++ b/Logger/Logger.swift @@ -22,6 +22,56 @@ // SOFTWARE. // -class Logger { +import Foundation +public protocol Logger { + func log(time: String, level: LogLevel, location: String, object: String) + + func description(for date: Date) -> String + func description(for file: String, line: Int, function: String) -> String + func description(for object: Any) -> String } + +public enum LogLevel: String { + case `default` = "Default" + case info = "Info" + case debug = "Debug" + case error = "Error" + case fault = "Fault" +} + +extension Logger { + public func log(_ object: Any, level: LogLevel = .default, file: String = #file, line: Int = #line, function: String = #function) { + let now = Date() + let time = description(for: now) + let location = description(for: file, line: line, function: function) + let objectDescription = description(for: object) + log(time: time, level: level, location: location, object: objectDescription) + } + + public func description(for date: Date) -> String { + return dateFormatter.string(from: date) + } + + public func description(for file: String, line: Int, function: String) -> String { + return filename(fromFilePath: file) + ":\(line) \(function)" + } + + 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 + } +} + +private let dateFormatter: DateFormatter = { + let formatter = DateFormatter() + formatter.dateFormat = "yyyy-MM-dd HH:mm:ss.SSS" + formatter.timeZone = TimeZone(secondsFromGMT: 0) + return formatter +}() From 9ebabca38b01db16a7088a209b97fb0b123dd0b3 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Tue, 14 Aug 2018 08:35:56 +0200 Subject: [PATCH 03/37] Added ConsoleLogger, NullLogger and AgregateLogger --- Logger.xcodeproj/project.pbxproj | 20 +++++++++++++ Logger/Loggers/AgregateLogger.swift | 39 ++++++++++++++++++++++++ Logger/Loggers/ConsoleLogger.swift | 34 +++++++++++++++++++++ Logger/Loggers/NullLogger.swift | 46 +++++++++++++++++++++++++++++ 4 files changed, 139 insertions(+) create mode 100644 Logger/Loggers/AgregateLogger.swift create mode 100644 Logger/Loggers/ConsoleLogger.swift create mode 100644 Logger/Loggers/NullLogger.swift diff --git a/Logger.xcodeproj/project.pbxproj b/Logger.xcodeproj/project.pbxproj index 13420fd..c3b2fad 100644 --- a/Logger.xcodeproj/project.pbxproj +++ b/Logger.xcodeproj/project.pbxproj @@ -9,6 +9,9 @@ /* Begin PBXBuildFile section */ 2EBF4B3E2122AA34008E4117 /* Logger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B3D2122AA34008E4117 /* Logger.swift */; }; 2EBF4B452122ACD6008E4117 /* LogStringConvertible.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B442122ACD6008E4117 /* LogStringConvertible.swift */; }; + 2EBF4B4A2122AF53008E4117 /* AgregateLogger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B472122AF53008E4117 /* AgregateLogger.swift */; }; + 2EBF4B4B2122AF53008E4117 /* ConsoleLogger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B482122AF53008E4117 /* ConsoleLogger.swift */; }; + 2EBF4B4C2122AF53008E4117 /* NullLogger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B492122AF53008E4117 /* NullLogger.swift */; }; /* End PBXBuildFile section */ /* Begin PBXCopyFilesBuildPhase section */ @@ -27,6 +30,9 @@ 2EBF4B3A2122AA34008E4117 /* libLogger.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = libLogger.a; sourceTree = BUILT_PRODUCTS_DIR; }; 2EBF4B3D2122AA34008E4117 /* Logger.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Logger.swift; sourceTree = ""; }; 2EBF4B442122ACD6008E4117 /* LogStringConvertible.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = LogStringConvertible.swift; sourceTree = ""; }; + 2EBF4B472122AF53008E4117 /* AgregateLogger.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AgregateLogger.swift; sourceTree = ""; }; + 2EBF4B482122AF53008E4117 /* ConsoleLogger.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ConsoleLogger.swift; sourceTree = ""; }; + 2EBF4B492122AF53008E4117 /* NullLogger.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = NullLogger.swift; sourceTree = ""; }; /* End PBXFileReference section */ /* Begin PBXFrameworksBuildPhase section */ @@ -61,10 +67,21 @@ children = ( 2EBF4B442122ACD6008E4117 /* LogStringConvertible.swift */, 2EBF4B3D2122AA34008E4117 /* Logger.swift */, + 2EBF4B462122AF53008E4117 /* Loggers */, ); path = Logger; sourceTree = ""; }; + 2EBF4B462122AF53008E4117 /* Loggers */ = { + isa = PBXGroup; + children = ( + 2EBF4B472122AF53008E4117 /* AgregateLogger.swift */, + 2EBF4B482122AF53008E4117 /* ConsoleLogger.swift */, + 2EBF4B492122AF53008E4117 /* NullLogger.swift */, + ); + path = Loggers; + sourceTree = ""; + }; /* End PBXGroup section */ /* Begin PBXNativeTarget section */ @@ -122,7 +139,10 @@ isa = PBXSourcesBuildPhase; buildActionMask = 2147483647; files = ( + 2EBF4B4C2122AF53008E4117 /* NullLogger.swift in Sources */, 2EBF4B3E2122AA34008E4117 /* Logger.swift in Sources */, + 2EBF4B4B2122AF53008E4117 /* ConsoleLogger.swift in Sources */, + 2EBF4B4A2122AF53008E4117 /* AgregateLogger.swift in Sources */, 2EBF4B452122ACD6008E4117 /* LogStringConvertible.swift in Sources */, ); runOnlyForDeploymentPostprocessing = 0; diff --git a/Logger/Loggers/AgregateLogger.swift b/Logger/Loggers/AgregateLogger.swift new file mode 100644 index 0000000..5bedb00 --- /dev/null +++ b/Logger/Loggers/AgregateLogger.swift @@ -0,0 +1,39 @@ +// +// MIT License +// +// Copyright (c) 2018 Wojciech Nagrodzki +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. +// + +import Foundation + +public final class AgregateLogger: Logger { + private let loggers: [Logger] + + public init(loggers: [Logger]) { + self.loggers = loggers + } + + public func log(time: String, level: LogLevel, location: String, object: String) { + for logger in self.loggers { + logger.log(time: time, level: level, location: location, object: object) + } + } +} diff --git a/Logger/Loggers/ConsoleLogger.swift b/Logger/Loggers/ConsoleLogger.swift new file mode 100644 index 0000000..5d1745e --- /dev/null +++ b/Logger/Loggers/ConsoleLogger.swift @@ -0,0 +1,34 @@ +// +// MIT License +// +// Copyright (c) 2018 Wojciech Nagrodzki +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. +// + +import Foundation + +public final class ConsoleLogger: Logger { + public init() { + } + + public func log(time: String, level: LogLevel, location: String, object: String) { + print(time + " <" + level.rawValue + "> " + location + " " + object) + } +} diff --git a/Logger/Loggers/NullLogger.swift b/Logger/Loggers/NullLogger.swift new file mode 100644 index 0000000..7c3160d --- /dev/null +++ b/Logger/Loggers/NullLogger.swift @@ -0,0 +1,46 @@ +// +// MIT License +// +// Copyright (c) 2018 Wojciech Nagrodzki +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. +// + +import Foundation + +public class NullLogger: Logger { + public init() { + } + + public func log(time: String, level: LogLevel, location: String, object: String) { + // noop + } + + public func description(for date: Date) -> String { + return "" + } + + public func description(for file: String, line: Int, function: String) -> String { + return "" + } + + public func description(for object: Any) -> String { + return "" + } +} From 1994ca3b4decbbd4e9b02b1144352ba1cff252c1 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Tue, 14 Aug 2018 09:00:03 +0200 Subject: [PATCH 04/37] Added NSFileHandle category and bridging header --- Logger.xcodeproj/project.pbxproj | 32 ++++++++++++++ Logger/Logger-Bridging-Header.h | 5 +++ .../Loggers/DiskLogger/NSFileHandle+Swift.h | 35 +++++++++++++++ .../Loggers/DiskLogger/NSFileHandle+Swift.m | 44 +++++++++++++++++++ 4 files changed, 116 insertions(+) create mode 100644 Logger/Logger-Bridging-Header.h create mode 100644 Logger/Loggers/DiskLogger/NSFileHandle+Swift.h create mode 100644 Logger/Loggers/DiskLogger/NSFileHandle+Swift.m diff --git a/Logger.xcodeproj/project.pbxproj b/Logger.xcodeproj/project.pbxproj index c3b2fad..b9e551a 100644 --- a/Logger.xcodeproj/project.pbxproj +++ b/Logger.xcodeproj/project.pbxproj @@ -12,6 +12,7 @@ 2EBF4B4A2122AF53008E4117 /* AgregateLogger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B472122AF53008E4117 /* AgregateLogger.swift */; }; 2EBF4B4B2122AF53008E4117 /* ConsoleLogger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B482122AF53008E4117 /* ConsoleLogger.swift */; }; 2EBF4B4C2122AF53008E4117 /* NullLogger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B492122AF53008E4117 /* NullLogger.swift */; }; + 2EBF4B512122B06E008E4117 /* NSFileHandle+Swift.m in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B502122B06E008E4117 /* NSFileHandle+Swift.m */; }; /* End PBXBuildFile section */ /* Begin PBXCopyFilesBuildPhase section */ @@ -33,6 +34,9 @@ 2EBF4B472122AF53008E4117 /* AgregateLogger.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = AgregateLogger.swift; sourceTree = ""; }; 2EBF4B482122AF53008E4117 /* ConsoleLogger.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ConsoleLogger.swift; sourceTree = ""; }; 2EBF4B492122AF53008E4117 /* NullLogger.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = NullLogger.swift; sourceTree = ""; }; + 2EBF4B4F2122B06E008E4117 /* NSFileHandle+Swift.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "NSFileHandle+Swift.h"; sourceTree = ""; }; + 2EBF4B502122B06E008E4117 /* NSFileHandle+Swift.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "NSFileHandle+Swift.m"; sourceTree = ""; }; + 2EBF4B532122B2AA008E4117 /* Logger-Bridging-Header.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "Logger-Bridging-Header.h"; sourceTree = ""; }; /* End PBXFileReference section */ /* Begin PBXFrameworksBuildPhase section */ @@ -65,6 +69,7 @@ 2EBF4B3C2122AA34008E4117 /* Logger */ = { isa = PBXGroup; children = ( + 2EBF4B532122B2AA008E4117 /* Logger-Bridging-Header.h */, 2EBF4B442122ACD6008E4117 /* LogStringConvertible.swift */, 2EBF4B3D2122AA34008E4117 /* Logger.swift */, 2EBF4B462122AF53008E4117 /* Loggers */, @@ -78,10 +83,20 @@ 2EBF4B472122AF53008E4117 /* AgregateLogger.swift */, 2EBF4B482122AF53008E4117 /* ConsoleLogger.swift */, 2EBF4B492122AF53008E4117 /* NullLogger.swift */, + 2EBF4B4D2122B034008E4117 /* DiskLogger */, ); path = Loggers; sourceTree = ""; }; + 2EBF4B4D2122B034008E4117 /* DiskLogger */ = { + isa = PBXGroup; + children = ( + 2EBF4B4F2122B06E008E4117 /* NSFileHandle+Swift.h */, + 2EBF4B502122B06E008E4117 /* NSFileHandle+Swift.m */, + ); + path = DiskLogger; + sourceTree = ""; + }; /* End PBXGroup section */ /* Begin PBXNativeTarget section */ @@ -114,6 +129,7 @@ TargetAttributes = { 2EBF4B392122AA34008E4117 = { CreatedOnToolsVersion = 10.0; + LastSwiftMigration = 1000; }; }; }; @@ -141,6 +157,7 @@ files = ( 2EBF4B4C2122AF53008E4117 /* NullLogger.swift in Sources */, 2EBF4B3E2122AA34008E4117 /* Logger.swift in Sources */, + 2EBF4B512122B06E008E4117 /* NSFileHandle+Swift.m in Sources */, 2EBF4B4B2122AF53008E4117 /* ConsoleLogger.swift in Sources */, 2EBF4B4A2122AF53008E4117 /* AgregateLogger.swift in Sources */, 2EBF4B452122ACD6008E4117 /* LogStringConvertible.swift in Sources */, @@ -269,10 +286,18 @@ 2EBF4B422122AA34008E4117 /* Debug */ = { isa = XCBuildConfiguration; buildSettings = { + CLANG_ENABLE_MODULES = YES; CODE_SIGN_STYLE = Automatic; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/Frameworks", + "@loader_path/Frameworks", + ); OTHER_LDFLAGS = "-ObjC"; PRODUCT_NAME = "$(TARGET_NAME)"; SKIP_INSTALL = YES; + SWIFT_OBJC_BRIDGING_HEADER = "Logger/Logger-Bridging-Header.h"; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; SWIFT_VERSION = 4.2; TARGETED_DEVICE_FAMILY = "1,2"; }; @@ -281,10 +306,17 @@ 2EBF4B432122AA34008E4117 /* Release */ = { isa = XCBuildConfiguration; buildSettings = { + CLANG_ENABLE_MODULES = YES; CODE_SIGN_STYLE = Automatic; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/Frameworks", + "@loader_path/Frameworks", + ); OTHER_LDFLAGS = "-ObjC"; PRODUCT_NAME = "$(TARGET_NAME)"; SKIP_INSTALL = YES; + SWIFT_OBJC_BRIDGING_HEADER = "Logger/Logger-Bridging-Header.h"; SWIFT_VERSION = 4.2; TARGETED_DEVICE_FAMILY = "1,2"; }; diff --git a/Logger/Logger-Bridging-Header.h b/Logger/Logger-Bridging-Header.h new file mode 100644 index 0000000..886bed2 --- /dev/null +++ b/Logger/Logger-Bridging-Header.h @@ -0,0 +1,5 @@ +// +// Use this file to import your target's public headers that you would like to expose to Swift. +// + +#import "NSFileHandle+Swift.h" diff --git a/Logger/Loggers/DiskLogger/NSFileHandle+Swift.h b/Logger/Loggers/DiskLogger/NSFileHandle+Swift.h new file mode 100644 index 0000000..23f3d4e --- /dev/null +++ b/Logger/Loggers/DiskLogger/NSFileHandle+Swift.h @@ -0,0 +1,35 @@ +// +// MIT License +// +// Copyright (c) 2018 Wojciech Nagrodzki +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. +// + +#import + +NS_ASSUME_NONNULL_BEGIN + +@interface NSFileHandle (Swift) + +- (BOOL)swift_writeData:(NSData *)data error:(NSError **)error; + +@end + +NS_ASSUME_NONNULL_END diff --git a/Logger/Loggers/DiskLogger/NSFileHandle+Swift.m b/Logger/Loggers/DiskLogger/NSFileHandle+Swift.m new file mode 100644 index 0000000..994e667 --- /dev/null +++ b/Logger/Loggers/DiskLogger/NSFileHandle+Swift.m @@ -0,0 +1,44 @@ +// +// MIT License +// +// Copyright (c) 2018 Wojciech Nagrodzki +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. +// + +#import "NSFileHandle+Swift.h" + +@implementation NSFileHandle (Swift) + +- (BOOL)swift_writeData:(NSData *)data error:(NSError **)error { + @try { + [self writeData:data]; + return YES; + } + @catch (NSException *exception) { + if (error == nil) { + return NO; + } + NSDictionary * userInfo = @{NSLocalizedFailureReasonErrorKey: exception.reason}; + *error = [NSError errorWithDomain:@"NSFileHandleException" code:1 userInfo:userInfo]; + return NO; + } +} + +@end From 6369a5508890bb8633b412f0244d4b4a7e9c796a Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Tue, 14 Aug 2018 09:18:03 +0200 Subject: [PATCH 05/37] Added DiskLogger and it's helper classes: FileWriter and Logrotate --- Logger.xcodeproj/project.pbxproj | 12 +++ Logger/Loggers/DiskLogger/DiskLogger.swift | 91 ++++++++++++++++++++++ Logger/Loggers/DiskLogger/FileWriter.swift | 54 +++++++++++++ Logger/Loggers/DiskLogger/Logrotate.swift | 54 +++++++++++++ 4 files changed, 211 insertions(+) create mode 100644 Logger/Loggers/DiskLogger/DiskLogger.swift create mode 100644 Logger/Loggers/DiskLogger/FileWriter.swift create mode 100644 Logger/Loggers/DiskLogger/Logrotate.swift diff --git a/Logger.xcodeproj/project.pbxproj b/Logger.xcodeproj/project.pbxproj index b9e551a..7355162 100644 --- a/Logger.xcodeproj/project.pbxproj +++ b/Logger.xcodeproj/project.pbxproj @@ -13,6 +13,9 @@ 2EBF4B4B2122AF53008E4117 /* ConsoleLogger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B482122AF53008E4117 /* ConsoleLogger.swift */; }; 2EBF4B4C2122AF53008E4117 /* NullLogger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B492122AF53008E4117 /* NullLogger.swift */; }; 2EBF4B512122B06E008E4117 /* NSFileHandle+Swift.m in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B502122B06E008E4117 /* NSFileHandle+Swift.m */; }; + 2EBF4B572122B598008E4117 /* DiskLogger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B542122B598008E4117 /* DiskLogger.swift */; }; + 2EBF4B582122B598008E4117 /* FileWriter.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B552122B598008E4117 /* FileWriter.swift */; }; + 2EBF4B592122B598008E4117 /* Logrotate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B562122B598008E4117 /* Logrotate.swift */; }; /* End PBXBuildFile section */ /* Begin PBXCopyFilesBuildPhase section */ @@ -37,6 +40,9 @@ 2EBF4B4F2122B06E008E4117 /* NSFileHandle+Swift.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "NSFileHandle+Swift.h"; sourceTree = ""; }; 2EBF4B502122B06E008E4117 /* NSFileHandle+Swift.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = "NSFileHandle+Swift.m"; sourceTree = ""; }; 2EBF4B532122B2AA008E4117 /* Logger-Bridging-Header.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "Logger-Bridging-Header.h"; sourceTree = ""; }; + 2EBF4B542122B598008E4117 /* DiskLogger.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = DiskLogger.swift; sourceTree = ""; }; + 2EBF4B552122B598008E4117 /* FileWriter.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = FileWriter.swift; sourceTree = ""; }; + 2EBF4B562122B598008E4117 /* Logrotate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Logrotate.swift; sourceTree = ""; }; /* End PBXFileReference section */ /* Begin PBXFrameworksBuildPhase section */ @@ -91,6 +97,9 @@ 2EBF4B4D2122B034008E4117 /* DiskLogger */ = { isa = PBXGroup; children = ( + 2EBF4B542122B598008E4117 /* DiskLogger.swift */, + 2EBF4B552122B598008E4117 /* FileWriter.swift */, + 2EBF4B562122B598008E4117 /* Logrotate.swift */, 2EBF4B4F2122B06E008E4117 /* NSFileHandle+Swift.h */, 2EBF4B502122B06E008E4117 /* NSFileHandle+Swift.m */, ); @@ -155,11 +164,14 @@ isa = PBXSourcesBuildPhase; buildActionMask = 2147483647; files = ( + 2EBF4B582122B598008E4117 /* FileWriter.swift in Sources */, + 2EBF4B572122B598008E4117 /* DiskLogger.swift in Sources */, 2EBF4B4C2122AF53008E4117 /* NullLogger.swift in Sources */, 2EBF4B3E2122AA34008E4117 /* Logger.swift in Sources */, 2EBF4B512122B06E008E4117 /* NSFileHandle+Swift.m in Sources */, 2EBF4B4B2122AF53008E4117 /* ConsoleLogger.swift in Sources */, 2EBF4B4A2122AF53008E4117 /* AgregateLogger.swift in Sources */, + 2EBF4B592122B598008E4117 /* Logrotate.swift in Sources */, 2EBF4B452122ACD6008E4117 /* LogStringConvertible.swift in Sources */, ); runOnlyForDeploymentPostprocessing = 0; diff --git a/Logger/Loggers/DiskLogger/DiskLogger.swift b/Logger/Loggers/DiskLogger/DiskLogger.swift new file mode 100644 index 0000000..49e6441 --- /dev/null +++ b/Logger/Loggers/DiskLogger/DiskLogger.swift @@ -0,0 +1,91 @@ +// +// MIT License +// +// Copyright (c) 2018 Wojciech Nagrodzki +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. +// + +import Foundation + +public final class DiskLogger: Logger { + private let fileURL: URL + private let fileSizeLimit: UInt64 + private let rotations: Int + private let queue = DispatchQueue(label: "com.wnagrodzki.DiskLogger", qos: .background, attributes: [], autoreleaseFrequency: .workItem, target: nil) + private var buffer = Data() + private var fileWriter: FileWriter! + + public init(fileURL: URL, fileSizeLimit: UInt64, rotations: Int) { + self.fileURL = fileURL + self.fileSizeLimit = fileSizeLimit + self.rotations = rotations + } + + public func log(time: String, level: LogLevel, location: String, object: String) { + let message = time + " <" + level.rawValue + "> " + location + " " + object + "\n" + log(message) + } + + private func log(_ message: String) { + guard let data = message.data(using: .utf8) else { + log("Message failed to convert to UTF8") + return + } + queue.async { + self.buffer.append(data) + + do { + try self.openFileWriter() + try self.writeBuffer() + } + catch is FileWriter.FileSizeLimitReached { + self.closeFileWriter() + try? self.rotateLogFiles() + } + catch { + let message = String(describing: error) + self.log(message) + } + } + } + + private func openFileWriter() throws { + guard fileWriter == nil else { return } + if FileManager.default.fileExists(atPath: fileURL.path) == false { + FileManager.default.createFile(atPath: fileURL.path, contents: nil, attributes: nil) + } + fileWriter = try FileWriter(fileURL: fileURL, fileSizeLimit: fileSizeLimit) + } + + private func writeBuffer() throws { + try fileWriter.write(buffer) + buffer.removeAll() + } + + private func closeFileWriter() { + self.fileWriter.synchronizeAndCloseFile() + self.fileWriter = nil + } + + private func rotateLogFiles() throws { + let logrotate = Logrotate(fileURL: fileURL, rotations: rotations) + try logrotate.rotate() + } +} diff --git a/Logger/Loggers/DiskLogger/FileWriter.swift b/Logger/Loggers/DiskLogger/FileWriter.swift new file mode 100644 index 0000000..0a624f1 --- /dev/null +++ b/Logger/Loggers/DiskLogger/FileWriter.swift @@ -0,0 +1,54 @@ +// +// MIT License +// +// Copyright (c) 2018 Wojciech Nagrodzki +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. +// + +import Foundation + +final class FileWriter { + + struct FileSizeLimitReached: Error {} + + private let handle: FileHandle + private let sizeLimit: UInt64 + private var currentSize: UInt64 + + init(fileURL: URL, fileSizeLimit: UInt64) throws { + handle = try FileHandle(forWritingTo: fileURL) + self.sizeLimit = fileSizeLimit + currentSize = handle.seekToEndOfFile() + } + + func write(_ data: Data) throws { + let dataSize = UInt64(data.count) + guard currentSize + dataSize <= sizeLimit else { + throw FileSizeLimitReached() + } + try handle.swift_write(data) + currentSize += dataSize + } + + func synchronizeAndCloseFile() { + handle.synchronizeFile() + handle.closeFile() + } +} diff --git a/Logger/Loggers/DiskLogger/Logrotate.swift b/Logger/Loggers/DiskLogger/Logrotate.swift new file mode 100644 index 0000000..4d177e5 --- /dev/null +++ b/Logger/Loggers/DiskLogger/Logrotate.swift @@ -0,0 +1,54 @@ +// +// MIT License +// +// Copyright (c) 2018 Wojciech Nagrodzki +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. +// + +import Foundation + +final class Logrotate { + private let fileURL: URL + private let rotations: Int + + init(fileURL: URL, rotations: Int) { + precondition(rotations > 0) + self.fileURL = fileURL + self.rotations = rotations + } + + func rotate() throws { + let range = 1...rotations + let pathExtensions = range.map { "\($0)" } + let rotatedURLs = pathExtensions.map { fileURL.appendingPathExtension($0) } + let allURLs = [fileURL] + rotatedURLs + + let toDelete = rotatedURLs.last! + let toMove = zip(allURLs, rotatedURLs).reversed() + + if FileManager.default.fileExists(atPath: toDelete.path) { + try FileManager.default.removeItem(at: toDelete) + } + for (oldURL, newURL) in toMove { + guard FileManager.default.fileExists(atPath: oldURL.path) else { continue } + try FileManager.default.moveItem(at: oldURL, to: newURL) + } + } +} From 9986812c98745639f8e38d1149b75d6db405927c Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Tue, 14 Aug 2018 16:20:52 +0200 Subject: [PATCH 06/37] Fixed compilation error in projects where Logger was added as dependency --- Logger/Logger-Bridging-Header.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Logger/Logger-Bridging-Header.h b/Logger/Logger-Bridging-Header.h index 886bed2..6a5bec0 100644 --- a/Logger/Logger-Bridging-Header.h +++ b/Logger/Logger-Bridging-Header.h @@ -2,4 +2,4 @@ // Use this file to import your target's public headers that you would like to expose to Swift. // -#import "NSFileHandle+Swift.h" +#import "Loggers/DiskLogger/NSFileHandle+Swift.h" From fd7edb0c0dcc86d625c679e47b430909f7e6c49c Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Wed, 15 Aug 2018 13:02:41 +0200 Subject: [PATCH 07/37] Added comments --- Logger/LogStringConvertible.swift | 4 ++ Logger/Logger.swift | 55 ++++++++++++++++++++++ Logger/Loggers/AgregateLogger.swift | 5 ++ Logger/Loggers/ConsoleLogger.swift | 1 + Logger/Loggers/DiskLogger/DiskLogger.swift | 8 ++++ Logger/Loggers/DiskLogger/FileWriter.swift | 14 ++++++ Logger/Loggers/DiskLogger/Logrotate.swift | 15 ++++++ Logger/Loggers/NullLogger.swift | 4 ++ 8 files changed, 106 insertions(+) diff --git a/Logger/LogStringConvertible.swift b/Logger/LogStringConvertible.swift index 87bab24..99745c6 100644 --- a/Logger/LogStringConvertible.swift +++ b/Logger/LogStringConvertible.swift @@ -24,11 +24,15 @@ import Foundation +/// A type with a customized textual representation suitable for logging purposes. public protocol LogStringConvertible { + + /// A textual representation of this instance, suitable for logging. var logDescription: String { get } } extension Array: LogStringConvertible where Element: LogStringConvertible { + public var logDescription: String { let descriptions = map { $0.logDescription } let joinedDescriptions = descriptions.joined(separator: ", ") diff --git a/Logger/Logger.swift b/Logger/Logger.swift index 5e229bd..b952d4e 100644 --- a/Logger/Logger.swift +++ b/Logger/Logger.swift @@ -24,23 +24,75 @@ import Foundation +/// A type able to build custom log message and send it to a logging system. public protocol Logger { + + /// Builds log a message from passed parameters and sends it to the logging system. + /// + /// Do not call this method directly. + /// + /// - Parameters: + /// - time: Part of the log message provided by `description(for date: Date)` method. + /// - 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: String, level: LogLevel, location: String, object: String) + /// Transforms `date` into textual representation which will be a part of the log message. + /// + /// Customization point. Default implementation returns date in format `"yyyy-MM-dd HH:mm:ss.SSS"`. + /// + /// - Parameter date: The date log method was called. func description(for date: Date) -> String + + /// Transforms passed parameters into location textual representation which will be a part of the log message. + /// + /// Customization point. Default implementation returns location in format `": "`, + /// + /// - Parameters: + /// - file: The path to the file log method was called from. + /// - 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. public enum LogLevel: String { + + /// Use this level to capture information about things that might result a failure. case `default` = "Default" + + /// Use this level to capture information that may be helpful, but isn’t essential, for troubleshooting errors. case info = "Info" + + /// Use this level to capture information that may be useful during development or while troubleshooting a specific problem. case debug = "Debug" + + /// Use this log level to capture process-level information to report errors in the process. case error = "Error" + + /// Use this level to capture system-level or multi-process information to report system errors. case fault = "Fault" } extension Logger { + + /// Sends object to the logging system, optionally specifying a custom log level. + /// + /// - Parameters: + /// - object: The object to be logged. + /// - level: The log level. If unspecified, the `default` log level is used. + /// - 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 = .default, file: String = #file, line: Int = #line, function: String = #function) { let now = Date() let time = description(for: now) @@ -49,14 +101,17 @@ extension Logger { log(time: time, level: level, location: location, object: objectDescription) } + /// Returns date in format `"yyyy-MM-dd HH:mm:ss.SSS"`. public func description(for date: Date) -> String { return dateFormatter.string(from: date) } + /// Returns location in format `": "`. public func description(for file: String, line: Int, function: String) -> String { 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 diff --git a/Logger/Loggers/AgregateLogger.swift b/Logger/Loggers/AgregateLogger.swift index 5bedb00..d2e1a78 100644 --- a/Logger/Loggers/AgregateLogger.swift +++ b/Logger/Loggers/AgregateLogger.swift @@ -24,9 +24,14 @@ import Foundation +/// Logger that forwards messages to all the loggers it is intialized with. public final class AgregateLogger: Logger { + private let loggers: [Logger] + /// Initializes new AgregateLogger instance. + /// + /// - Parameter loggers: Array of loggers all messages will be forwarded to. public init(loggers: [Logger]) { self.loggers = loggers } diff --git a/Logger/Loggers/ConsoleLogger.swift b/Logger/Loggers/ConsoleLogger.swift index 5d1745e..d4eed49 100644 --- a/Logger/Loggers/ConsoleLogger.swift +++ b/Logger/Loggers/ConsoleLogger.swift @@ -24,6 +24,7 @@ import Foundation +/// Logger that writes messages into the standard output. public final class ConsoleLogger: Logger { public init() { } diff --git a/Logger/Loggers/DiskLogger/DiskLogger.swift b/Logger/Loggers/DiskLogger/DiskLogger.swift index 49e6441..b51b9f4 100644 --- a/Logger/Loggers/DiskLogger/DiskLogger.swift +++ b/Logger/Loggers/DiskLogger/DiskLogger.swift @@ -24,7 +24,9 @@ import Foundation +/// Logger that writes messages into the file at specified URL with log rotation support. public final class DiskLogger: Logger { + private let fileURL: URL private let fileSizeLimit: UInt64 private let rotations: Int @@ -32,6 +34,12 @@ public final class DiskLogger: Logger { private var buffer = Data() private var fileWriter: FileWriter! + /// Initializes new DiskLogger instance. + /// + /// - Parameters: + /// - fileURL: URL of the log file. + /// - fileSizeLimit: Maximum size log file can reach in bytes. Attempt to exceeding that limit triggers log files rotation. + /// - rotations: Number of times log files are rotated before being removed. public init(fileURL: URL, fileSizeLimit: UInt64, rotations: Int) { self.fileURL = fileURL self.fileSizeLimit = fileSizeLimit diff --git a/Logger/Loggers/DiskLogger/FileWriter.swift b/Logger/Loggers/DiskLogger/FileWriter.swift index 0a624f1..1083812 100644 --- a/Logger/Loggers/DiskLogger/FileWriter.swift +++ b/Logger/Loggers/DiskLogger/FileWriter.swift @@ -24,20 +24,33 @@ import Foundation +/// Allows writing to a file while respecting allowed size limit. final class FileWriter { + /// Write failed as allowed size limit would be exceeded for the file. struct FileSizeLimitReached: Error {} private let handle: FileHandle private let sizeLimit: UInt64 private var currentSize: UInt64 + /// Initializes new FileWriter instance. + /// + /// - Parameters: + /// - fileURL: URL of the file. + /// - fileSizeLimit: Maximum size the file can reach in bytes. + /// - Throws: An error that may occur while the file is being opened for writing. init(fileURL: URL, fileSizeLimit: UInt64) throws { handle = try FileHandle(forWritingTo: fileURL) self.sizeLimit = fileSizeLimit currentSize = handle.seekToEndOfFile() } + /// Synchronously writes `data` at the end of the file. + /// + /// - Parameter data: The data to be written. + /// - Throws: Throws an error if no free space is left on the file system, or if any other writing error occurs. + /// Throws `FileSizeLimitReached` if allowed size limit would be exceeded for the file. func write(_ data: Data) throws { let dataSize = UInt64(data.count) guard currentSize + dataSize <= sizeLimit else { @@ -47,6 +60,7 @@ final class FileWriter { currentSize += dataSize } + /// Writes all in-memory data to permanent storage and closes the file. func synchronizeAndCloseFile() { handle.synchronizeFile() handle.closeFile() diff --git a/Logger/Loggers/DiskLogger/Logrotate.swift b/Logger/Loggers/DiskLogger/Logrotate.swift index 4d177e5..c377d2e 100644 --- a/Logger/Loggers/DiskLogger/Logrotate.swift +++ b/Logger/Loggers/DiskLogger/Logrotate.swift @@ -24,16 +24,31 @@ import Foundation +/// Allows log files rotation. final class Logrotate { + private let fileURL: URL private let rotations: Int + /// Initializes new Logrotate instance. + /// + /// - Parameters: + /// - fileURL: URL of the log file. + /// - rotations: Number of times log files are rotated before being removed. init(fileURL: URL, rotations: Int) { precondition(rotations > 0) self.fileURL = fileURL self.rotations = rotations } + /// Rotates log files `rotations` number of times. + /// + /// First deletes file at `.`. + /// Next moves files located at: + /// + /// `, .1, .2 ... .` + /// + /// to `.1, .2 ... .` func rotate() throws { let range = 1...rotations let pathExtensions = range.map { "\($0)" } diff --git a/Logger/Loggers/NullLogger.swift b/Logger/Loggers/NullLogger.swift index 7c3160d..0787a99 100644 --- a/Logger/Loggers/NullLogger.swift +++ b/Logger/Loggers/NullLogger.swift @@ -24,6 +24,7 @@ import Foundation +/// Logger that ignores all messages with the intention to minimize observer effect. public class NullLogger: Logger { public init() { } @@ -32,14 +33,17 @@ public class NullLogger: Logger { // noop } + /// Returns empty string to minimize observer effect. public func description(for date: Date) -> String { return "" } + /// Returns empty string to minimize observer effect. 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 "" } From 1803e1dc584927a3ed196c6c825c9a8dc31f29b2 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Tue, 21 Aug 2018 19:37:36 +0200 Subject: [PATCH 08/37] Removed date formatting from Logger protocol extension --- Logger/Logger.swift | 28 ++++------------------ Logger/Loggers/AgregateLogger.swift | 2 +- Logger/Loggers/ConsoleLogger.swift | 10 ++++++-- Logger/Loggers/DiskLogger/DiskLogger.swift | 8 +++++-- Logger/Loggers/NullLogger.swift | 7 +----- 5 files changed, 20 insertions(+), 35 deletions(-) diff --git a/Logger/Logger.swift b/Logger/Logger.swift index b952d4e..5872896 100644 --- a/Logger/Logger.swift +++ b/Logger/Logger.swift @@ -32,18 +32,11 @@ public protocol Logger { /// Do not call this method directly. /// /// - Parameters: - /// - time: Part of the log message provided by `description(for date: Date)` method. + /// - 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: String, level: LogLevel, location: String, object: String) - - /// Transforms `date` into textual representation which will be a part of the log message. - /// - /// Customization point. Default implementation returns date in format `"yyyy-MM-dd HH:mm:ss.SSS"`. - /// - /// - Parameter date: The date log method was called. - func description(for date: Date) -> String + func log(time: Date, level: LogLevel, location: String, object: String) /// Transforms passed parameters into location textual representation which will be a part of the log message. /// @@ -95,17 +88,11 @@ extension Logger { /// - function: **Do not provide a custom value.** The name of the declaration log method is called within. public func log(_ object: Any, level: LogLevel = .default, file: String = #file, line: Int = #line, function: String = #function) { let now = Date() - let time = description(for: now) let location = description(for: file, line: line, function: function) let objectDescription = description(for: object) - log(time: time, level: level, location: location, object: objectDescription) + log(time: now, level: level, location: location, object: objectDescription) } - - /// Returns date in format `"yyyy-MM-dd HH:mm:ss.SSS"`. - public func description(for date: Date) -> String { - return dateFormatter.string(from: date) - } - + /// Returns location in format `": "`. public func description(for file: String, line: Int, function: String) -> String { return filename(fromFilePath: file) + ":\(line) \(function)" @@ -123,10 +110,3 @@ extension Logger { return URL(fileURLWithPath: path).deletingPathExtension().lastPathComponent } } - -private let dateFormatter: DateFormatter = { - let formatter = DateFormatter() - formatter.dateFormat = "yyyy-MM-dd HH:mm:ss.SSS" - formatter.timeZone = TimeZone(secondsFromGMT: 0) - return formatter -}() diff --git a/Logger/Loggers/AgregateLogger.swift b/Logger/Loggers/AgregateLogger.swift index d2e1a78..d8cb547 100644 --- a/Logger/Loggers/AgregateLogger.swift +++ b/Logger/Loggers/AgregateLogger.swift @@ -36,7 +36,7 @@ public final class AgregateLogger: Logger { self.loggers = loggers } - public func log(time: String, level: LogLevel, location: String, object: String) { + public func log(time: Date, level: LogLevel, location: String, object: String) { for logger in self.loggers { logger.log(time: time, level: level, location: location, object: object) } diff --git a/Logger/Loggers/ConsoleLogger.swift b/Logger/Loggers/ConsoleLogger.swift index d4eed49..dd96f37 100644 --- a/Logger/Loggers/ConsoleLogger.swift +++ b/Logger/Loggers/ConsoleLogger.swift @@ -26,10 +26,16 @@ import Foundation /// Logger that writes messages into the standard output. public final class ConsoleLogger: Logger { + + private let formatter: DateFormatter + public init() { + formatter = DateFormatter() + formatter.dateFormat = "yyyy-MM-dd HH:mm:ss.SSS" + formatter.timeZone = TimeZone(secondsFromGMT: 0) } - public func log(time: String, level: LogLevel, location: String, object: String) { - print(time + " <" + level.rawValue + "> " + location + " " + object) + public func log(time: Date, level: LogLevel, location: String, object: String) { + print(formatter.string(from: time) + " <" + level.rawValue + "> " + location + " " + object) } } diff --git a/Logger/Loggers/DiskLogger/DiskLogger.swift b/Logger/Loggers/DiskLogger/DiskLogger.swift index b51b9f4..33270b5 100644 --- a/Logger/Loggers/DiskLogger/DiskLogger.swift +++ b/Logger/Loggers/DiskLogger/DiskLogger.swift @@ -30,6 +30,7 @@ public final class DiskLogger: Logger { private let fileURL: URL private let fileSizeLimit: UInt64 private let rotations: Int + private let formatter: DateFormatter private let queue = DispatchQueue(label: "com.wnagrodzki.DiskLogger", qos: .background, attributes: [], autoreleaseFrequency: .workItem, target: nil) private var buffer = Data() private var fileWriter: FileWriter! @@ -44,10 +45,13 @@ public final class DiskLogger: Logger { self.fileURL = fileURL self.fileSizeLimit = fileSizeLimit self.rotations = rotations + formatter = DateFormatter() + formatter.dateFormat = "yyyy-MM-dd HH:mm:ss.SSS" + formatter.timeZone = TimeZone(secondsFromGMT: 0) } - public func log(time: String, level: LogLevel, location: String, object: String) { - let message = time + " <" + level.rawValue + "> " + location + " " + object + "\n" + public func log(time: Date, level: LogLevel, location: String, object: String) { + let message = formatter.string(from: time) + " <" + level.rawValue + "> " + location + " " + object + "\n" log(message) } diff --git a/Logger/Loggers/NullLogger.swift b/Logger/Loggers/NullLogger.swift index 0787a99..8c8dcb8 100644 --- a/Logger/Loggers/NullLogger.swift +++ b/Logger/Loggers/NullLogger.swift @@ -29,15 +29,10 @@ public class NullLogger: Logger { public init() { } - public func log(time: String, level: LogLevel, location: String, object: String) { + public func log(time: Date, level: LogLevel, location: String, object: String) { // noop } - /// Returns empty string to minimize observer effect. - public func description(for date: Date) -> String { - return "" - } - /// Returns empty string to minimize observer effect. public func description(for file: String, line: Int, function: String) -> String { return "" From e6f513852383b3c45c6170f987b44f2fbe026630 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Tue, 21 Aug 2018 19:46:08 +0200 Subject: [PATCH 09/37] Converted LogLevel to Int based enum --- Logger/Logger.swift | 25 ++++++++++++++++------ Logger/Loggers/ConsoleLogger.swift | 2 +- Logger/Loggers/DiskLogger/DiskLogger.swift | 2 +- 3 files changed, 21 insertions(+), 8 deletions(-) diff --git a/Logger/Logger.swift b/Logger/Logger.swift index 5872896..128ba6a 100644 --- a/Logger/Logger.swift +++ b/Logger/Logger.swift @@ -58,22 +58,35 @@ public protocol Logger { } /// Log level controls the conditions under which a message should be logged. -public enum LogLevel: String { +public enum LogLevel: Int { /// Use this level to capture information about things that might result a failure. - case `default` = "Default" + case `default` /// Use this level to capture information that may be helpful, but isn’t essential, for troubleshooting errors. - case info = "Info" + case info /// Use this level to capture information that may be useful during development or while troubleshooting a specific problem. - case debug = "Debug" + case debug /// Use this log level to capture process-level information to report errors in the process. - case error = "Error" + case error /// Use this level to capture system-level or multi-process information to report system errors. - case fault = "Fault" + case fault +} + +extension LogLevel: LogStringConvertible { + + public var logDescription: String { + switch self { + case .default: return "Default" + case .info: return "Info" + case .debug: return "Debug" + case .error: return "Error" + case .fault: return "Fault" + } + } } extension Logger { diff --git a/Logger/Loggers/ConsoleLogger.swift b/Logger/Loggers/ConsoleLogger.swift index dd96f37..a103bd8 100644 --- a/Logger/Loggers/ConsoleLogger.swift +++ b/Logger/Loggers/ConsoleLogger.swift @@ -36,6 +36,6 @@ public final class ConsoleLogger: Logger { } public func log(time: Date, level: LogLevel, location: String, object: String) { - print(formatter.string(from: time) + " <" + level.rawValue + "> " + location + " " + object) + print(formatter.string(from: time) + " <" + level.logDescription + "> " + location + " " + object) } } diff --git a/Logger/Loggers/DiskLogger/DiskLogger.swift b/Logger/Loggers/DiskLogger/DiskLogger.swift index 33270b5..7e5c944 100644 --- a/Logger/Loggers/DiskLogger/DiskLogger.swift +++ b/Logger/Loggers/DiskLogger/DiskLogger.swift @@ -51,7 +51,7 @@ public final class DiskLogger: Logger { } public func log(time: Date, level: LogLevel, location: String, object: String) { - let message = formatter.string(from: time) + " <" + level.rawValue + "> " + location + " " + object + "\n" + let message = formatter.string(from: time) + " <" + level.logDescription + "> " + location + " " + object + "\n" log(message) } From 41462ded26121b68f5360015e534416308e9dc47 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Tue, 21 Aug 2018 22:11:09 +0200 Subject: [PATCH 10/37] Redesign LogLevel to conform to syslog severity levels --- Logger/Logger.swift | 47 +++++++++++++++++++++++++++++---------------- 1 file changed, 30 insertions(+), 17 deletions(-) diff --git a/Logger/Logger.swift b/Logger/Logger.swift index 128ba6a..2f76349 100644 --- a/Logger/Logger.swift +++ b/Logger/Logger.swift @@ -58,33 +58,46 @@ public protocol Logger { } /// Log level controls the conditions under which a message should be logged. +/// - note: [RFC5424](https://www.rfc-editor.org/info/rfc5424) public enum LogLevel: Int { - /// Use this level to capture information about things that might result a failure. - case `default` + /// System is unusable. + case emergency = 0 - /// Use this level to capture information that may be helpful, but isn’t essential, for troubleshooting errors. - case info + /// Action must be taken immediately. + case alert = 1 - /// Use this level to capture information that may be useful during development or while troubleshooting a specific problem. - case debug + /// Critical conditions. + case critical = 2 - /// Use this log level to capture process-level information to report errors in the process. - case error + /// Error conditions. + case error = 3 - /// Use this level to capture system-level or multi-process information to report system errors. - case fault + /// Warning conditions. + case warning = 4 + + /// Normal but significant conditions. + case notice = 5 + + /// Informational messages. + case informational = 6 + + /// Debug-level messages. + case debug = 7 } extension LogLevel: LogStringConvertible { public var logDescription: String { switch self { - case .default: return "Default" - case .info: return "Info" - case .debug: return "Debug" - case .error: return "Error" - case .fault: return "Fault" + case .emergency: return "emerg" + case .alert: return "alert" + case .critical: return "crit" + case .error: return "err" + case .warning: return "warning" + case .notice: return "notice" + case .informational: return "info" + case .debug: return "debug" } } } @@ -95,11 +108,11 @@ extension Logger { /// /// - Parameters: /// - object: The object to be logged. - /// - level: The log level. If unspecified, the `default` log level is used. + /// - 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 = .default, file: String = #file, line: Int = #line, function: String = #function) { + public func log(_ object: Any, 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) From fab84b153baad73afb8f52ed39d5d6d8c9ac1848 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Tue, 21 Aug 2018 22:12:43 +0200 Subject: [PATCH 11/37] Made DiskLogger to log it's own errors on warning level --- Logger/Loggers/DiskLogger/DiskLogger.swift | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Logger/Loggers/DiskLogger/DiskLogger.swift b/Logger/Loggers/DiskLogger/DiskLogger.swift index 7e5c944..f4b1005 100644 --- a/Logger/Loggers/DiskLogger/DiskLogger.swift +++ b/Logger/Loggers/DiskLogger/DiskLogger.swift @@ -57,7 +57,7 @@ public final class DiskLogger: Logger { private func log(_ message: String) { guard let data = message.data(using: .utf8) else { - log("Message failed to convert to UTF8") + log("Message failed to convert to UTF8", level: .warning) return } queue.async { @@ -73,7 +73,7 @@ public final class DiskLogger: Logger { } catch { let message = String(describing: error) - self.log(message) + self.log(message, level: .warning) } } } From 35cbb3dfb1998d080cb27fad96da89aa98a5690c Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Wed, 22 Aug 2018 19:58:34 +0200 Subject: [PATCH 12/37] Changed log(_:level:) method to accept String message instead of Any --- Logger/Logger.swift | 11 +++++------ Logger/Loggers/AgregateLogger.swift | 4 ++-- Logger/Loggers/ConsoleLogger.swift | 4 ++-- Logger/Loggers/DiskLogger/DiskLogger.swift | 4 ++-- Logger/Loggers/NullLogger.swift | 7 +------ 5 files changed, 12 insertions(+), 18 deletions(-) diff --git a/Logger/Logger.swift b/Logger/Logger.swift index 2f76349..30d9cd4 100644 --- a/Logger/Logger.swift +++ b/Logger/Logger.swift @@ -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. /// @@ -107,16 +107,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 `": "`. diff --git a/Logger/Loggers/AgregateLogger.swift b/Logger/Loggers/AgregateLogger.swift index d8cb547..d9bffe4 100644 --- a/Logger/Loggers/AgregateLogger.swift +++ b/Logger/Loggers/AgregateLogger.swift @@ -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) } } } diff --git a/Logger/Loggers/ConsoleLogger.swift b/Logger/Loggers/ConsoleLogger.swift index a103bd8..ef8696a 100644 --- a/Logger/Loggers/ConsoleLogger.swift +++ b/Logger/Loggers/ConsoleLogger.swift @@ -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()) } } diff --git a/Logger/Loggers/DiskLogger/DiskLogger.swift b/Logger/Loggers/DiskLogger/DiskLogger.swift index f4b1005..f06a404 100644 --- a/Logger/Loggers/DiskLogger/DiskLogger.swift +++ b/Logger/Loggers/DiskLogger/DiskLogger.swift @@ -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) } diff --git a/Logger/Loggers/NullLogger.swift b/Logger/Loggers/NullLogger.swift index 8c8dcb8..64adf30 100644 --- a/Logger/Loggers/NullLogger.swift +++ b/Logger/Loggers/NullLogger.swift @@ -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 "" - } } From f31ac6183983791d0acc31c6815a6e5d92e7b177 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Wed, 22 Aug 2018 19:58:52 +0200 Subject: [PATCH 13/37] Removed unused methods --- Logger/Logger.swift | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/Logger/Logger.swift b/Logger/Logger.swift index 30d9cd4..7953f48 100644 --- a/Logger/Logger.swift +++ b/Logger/Logger.swift @@ -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. @@ -123,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 } From c83f341d6d9efa3b8c8cf4bec0d6d95fc55f319c Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Fri, 24 Aug 2018 21:58:08 +0200 Subject: [PATCH 14/37] Improved DiskLogger so rotateLogFiles() method's errors are caught instead of being ignored --- Logger/Loggers/DiskLogger/DiskLogger.swift | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/Logger/Loggers/DiskLogger/DiskLogger.swift b/Logger/Loggers/DiskLogger/DiskLogger.swift index f06a404..e77b940 100644 --- a/Logger/Loggers/DiskLogger/DiskLogger.swift +++ b/Logger/Loggers/DiskLogger/DiskLogger.swift @@ -65,11 +65,13 @@ public final class DiskLogger: Logger { do { try self.openFileWriter() - try self.writeBuffer() - } - catch is FileWriter.FileSizeLimitReached { - self.closeFileWriter() - try? self.rotateLogFiles() + do { + try self.writeBuffer() + } + catch is FileWriter.FileSizeLimitReached { + self.closeFileWriter() + try self.rotateLogFiles() + } } catch { let message = String(describing: error) From ec980424209f08ea11613f965335d0a025c957c6 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Sat, 25 Aug 2018 11:41:19 +0200 Subject: [PATCH 15/37] Dropped NSFoundation's string to data conversion method in favor to Swift's one --- Logger/Loggers/DiskLogger/DiskLogger.swift | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/Logger/Loggers/DiskLogger/DiskLogger.swift b/Logger/Loggers/DiskLogger/DiskLogger.swift index e77b940..d54f31b 100644 --- a/Logger/Loggers/DiskLogger/DiskLogger.swift +++ b/Logger/Loggers/DiskLogger/DiskLogger.swift @@ -56,10 +56,7 @@ public final class DiskLogger: Logger { } private func log(_ message: String) { - guard let data = message.data(using: .utf8) else { - log("Message failed to convert to UTF8", level: .warning) - return - } + let data = Data(message.utf8) queue.async { self.buffer.append(data) From c3e246210416ad68e1757c2707d8c253513dfa91 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Sat, 25 Aug 2018 12:27:10 +0200 Subject: [PATCH 16/37] Made DiskLogger errors to be appended to buffer instead of being logged to avoid potential infinite loop. --- Logger/Loggers/DiskLogger/DiskLogger.swift | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Logger/Loggers/DiskLogger/DiskLogger.swift b/Logger/Loggers/DiskLogger/DiskLogger.swift index d54f31b..d4cb80f 100644 --- a/Logger/Loggers/DiskLogger/DiskLogger.swift +++ b/Logger/Loggers/DiskLogger/DiskLogger.swift @@ -71,8 +71,9 @@ public final class DiskLogger: Logger { } } catch { - let message = String(describing: error) - self.log(message, level: .warning) + let message = self.formatter.string(from: Date()) + " <" + LogLevel.warning.logDescription + "> " + String(describing: error) + let data = Data(message.utf8) + self.buffer.append(data) } } } From 27c9599502f28bc0655f869a5765fb16f0e07d65 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Sat, 25 Aug 2018 12:54:42 +0200 Subject: [PATCH 17/37] Added UnitTest target --- Logger.xcodeproj/project.pbxproj | 125 +++++++++++++++++++++++++++++++ UnitTests/Info.plist | 22 ++++++ UnitTests/UnitTests.swift | 33 ++++++++ 3 files changed, 180 insertions(+) create mode 100644 UnitTests/Info.plist create mode 100644 UnitTests/UnitTests.swift diff --git a/Logger.xcodeproj/project.pbxproj b/Logger.xcodeproj/project.pbxproj index 7355162..2b38cbb 100644 --- a/Logger.xcodeproj/project.pbxproj +++ b/Logger.xcodeproj/project.pbxproj @@ -7,6 +7,8 @@ objects = { /* Begin PBXBuildFile section */ + 2E58D35D21316C3500BEF81A /* UnitTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2E58D35C21316C3500BEF81A /* UnitTests.swift */; }; + 2E58D35F21316C3500BEF81A /* libLogger.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 2EBF4B3A2122AA34008E4117 /* libLogger.a */; }; 2EBF4B3E2122AA34008E4117 /* Logger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B3D2122AA34008E4117 /* Logger.swift */; }; 2EBF4B452122ACD6008E4117 /* LogStringConvertible.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B442122ACD6008E4117 /* LogStringConvertible.swift */; }; 2EBF4B4A2122AF53008E4117 /* AgregateLogger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B472122AF53008E4117 /* AgregateLogger.swift */; }; @@ -18,6 +20,16 @@ 2EBF4B592122B598008E4117 /* Logrotate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B562122B598008E4117 /* Logrotate.swift */; }; /* End PBXBuildFile section */ +/* Begin PBXContainerItemProxy section */ + 2E58D36021316C3500BEF81A /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 2EBF4B322122AA34008E4117 /* Project object */; + proxyType = 1; + remoteGlobalIDString = 2EBF4B392122AA34008E4117; + remoteInfo = Logger; + }; +/* End PBXContainerItemProxy section */ + /* Begin PBXCopyFilesBuildPhase section */ 2EBF4B382122AA34008E4117 /* CopyFiles */ = { isa = PBXCopyFilesBuildPhase; @@ -31,6 +43,9 @@ /* End PBXCopyFilesBuildPhase section */ /* Begin PBXFileReference section */ + 2E58D35A21316C3500BEF81A /* UnitTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = UnitTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; + 2E58D35C21316C3500BEF81A /* UnitTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UnitTests.swift; sourceTree = ""; }; + 2E58D35E21316C3500BEF81A /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; }; 2EBF4B3A2122AA34008E4117 /* libLogger.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = libLogger.a; sourceTree = BUILT_PRODUCTS_DIR; }; 2EBF4B3D2122AA34008E4117 /* Logger.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Logger.swift; sourceTree = ""; }; 2EBF4B442122ACD6008E4117 /* LogStringConvertible.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = LogStringConvertible.swift; sourceTree = ""; }; @@ -46,6 +61,14 @@ /* End PBXFileReference section */ /* Begin PBXFrameworksBuildPhase section */ + 2E58D35721316C3500BEF81A /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + 2E58D35F21316C3500BEF81A /* libLogger.a in Frameworks */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; 2EBF4B372122AA34008E4117 /* Frameworks */ = { isa = PBXFrameworksBuildPhase; buildActionMask = 2147483647; @@ -56,10 +79,20 @@ /* End PBXFrameworksBuildPhase section */ /* Begin PBXGroup section */ + 2E58D35B21316C3500BEF81A /* UnitTests */ = { + isa = PBXGroup; + children = ( + 2E58D35C21316C3500BEF81A /* UnitTests.swift */, + 2E58D35E21316C3500BEF81A /* Info.plist */, + ); + path = UnitTests; + sourceTree = ""; + }; 2EBF4B312122AA34008E4117 = { isa = PBXGroup; children = ( 2EBF4B3C2122AA34008E4117 /* Logger */, + 2E58D35B21316C3500BEF81A /* UnitTests */, 2EBF4B3B2122AA34008E4117 /* Products */, ); sourceTree = ""; @@ -68,6 +101,7 @@ isa = PBXGroup; children = ( 2EBF4B3A2122AA34008E4117 /* libLogger.a */, + 2E58D35A21316C3500BEF81A /* UnitTests.xctest */, ); name = Products; sourceTree = ""; @@ -109,6 +143,24 @@ /* End PBXGroup section */ /* Begin PBXNativeTarget section */ + 2E58D35921316C3500BEF81A /* UnitTests */ = { + isa = PBXNativeTarget; + buildConfigurationList = 2E58D36221316C3500BEF81A /* Build configuration list for PBXNativeTarget "UnitTests" */; + buildPhases = ( + 2E58D35621316C3500BEF81A /* Sources */, + 2E58D35721316C3500BEF81A /* Frameworks */, + 2E58D35821316C3500BEF81A /* Resources */, + ); + buildRules = ( + ); + dependencies = ( + 2E58D36121316C3500BEF81A /* PBXTargetDependency */, + ); + name = UnitTests; + productName = UnitTests; + productReference = 2E58D35A21316C3500BEF81A /* UnitTests.xctest */; + productType = "com.apple.product-type.bundle.unit-test"; + }; 2EBF4B392122AA34008E4117 /* Logger */ = { isa = PBXNativeTarget; buildConfigurationList = 2EBF4B412122AA34008E4117 /* Build configuration list for PBXNativeTarget "Logger" */; @@ -136,6 +188,9 @@ LastUpgradeCheck = 1000; ORGANIZATIONNAME = "Wojciech Nagrodzki"; TargetAttributes = { + 2E58D35921316C3500BEF81A = { + CreatedOnToolsVersion = 10.0; + }; 2EBF4B392122AA34008E4117 = { CreatedOnToolsVersion = 10.0; LastSwiftMigration = 1000; @@ -155,11 +210,30 @@ projectRoot = ""; targets = ( 2EBF4B392122AA34008E4117 /* Logger */, + 2E58D35921316C3500BEF81A /* UnitTests */, ); }; /* End PBXProject section */ +/* Begin PBXResourcesBuildPhase section */ + 2E58D35821316C3500BEF81A /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXResourcesBuildPhase section */ + /* Begin PBXSourcesBuildPhase section */ + 2E58D35621316C3500BEF81A /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 2E58D35D21316C3500BEF81A /* UnitTests.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; 2EBF4B362122AA34008E4117 /* Sources */ = { isa = PBXSourcesBuildPhase; buildActionMask = 2147483647; @@ -178,7 +252,49 @@ }; /* End PBXSourcesBuildPhase section */ +/* Begin PBXTargetDependency section */ + 2E58D36121316C3500BEF81A /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 2EBF4B392122AA34008E4117 /* Logger */; + targetProxy = 2E58D36021316C3500BEF81A /* PBXContainerItemProxy */; + }; +/* End PBXTargetDependency section */ + /* Begin XCBuildConfiguration section */ + 2E58D36321316C3500BEF81A /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Automatic; + INFOPLIST_FILE = UnitTests/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/Frameworks", + "@loader_path/Frameworks", + ); + PRODUCT_BUNDLE_IDENTIFIER = com.wnagrodzki.UnitTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 4.2; + TARGETED_DEVICE_FAMILY = "1,2"; + }; + name = Debug; + }; + 2E58D36421316C3500BEF81A /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + CODE_SIGN_STYLE = Automatic; + INFOPLIST_FILE = UnitTests/Info.plist; + LD_RUNPATH_SEARCH_PATHS = ( + "$(inherited)", + "@executable_path/Frameworks", + "@loader_path/Frameworks", + ); + PRODUCT_BUNDLE_IDENTIFIER = com.wnagrodzki.UnitTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 4.2; + TARGETED_DEVICE_FAMILY = "1,2"; + }; + name = Release; + }; 2EBF4B3F2122AA34008E4117 /* Debug */ = { isa = XCBuildConfiguration; buildSettings = { @@ -337,6 +453,15 @@ /* End XCBuildConfiguration section */ /* Begin XCConfigurationList section */ + 2E58D36221316C3500BEF81A /* Build configuration list for PBXNativeTarget "UnitTests" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 2E58D36321316C3500BEF81A /* Debug */, + 2E58D36421316C3500BEF81A /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; 2EBF4B352122AA34008E4117 /* Build configuration list for PBXProject "Logger" */ = { isa = XCConfigurationList; buildConfigurations = ( diff --git a/UnitTests/Info.plist b/UnitTests/Info.plist new file mode 100644 index 0000000..6c40a6c --- /dev/null +++ b/UnitTests/Info.plist @@ -0,0 +1,22 @@ + + + + + CFBundleDevelopmentRegion + $(DEVELOPMENT_LANGUAGE) + CFBundleExecutable + $(EXECUTABLE_NAME) + CFBundleIdentifier + $(PRODUCT_BUNDLE_IDENTIFIER) + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + $(PRODUCT_NAME) + CFBundlePackageType + BNDL + CFBundleShortVersionString + 1.0 + CFBundleVersion + 1 + + diff --git a/UnitTests/UnitTests.swift b/UnitTests/UnitTests.swift new file mode 100644 index 0000000..5ff3dfe --- /dev/null +++ b/UnitTests/UnitTests.swift @@ -0,0 +1,33 @@ +// +// UnitTests.swift +// UnitTests +// +// Created by Wojciech Nagrodzki on 25/08/2018. +// Copyright © 2018 Wojciech Nagrodzki. All rights reserved. +// + +import XCTest + +class UnitTests: XCTestCase { + + override func setUp() { + // Put setup code here. This method is called before the invocation of each test method in the class. + } + + override func tearDown() { + // Put teardown code here. This method is called after the invocation of each test method in the class. + } + + func testExample() { + // This is an example of a functional test case. + // Use XCTAssert and related functions to verify your tests produce the correct results. + } + + func testPerformanceExample() { + // This is an example of a performance test case. + self.measure { + // Put the code you want to measure the time of here. + } + } + +} From 0d1abcdb54e57ab540bfa58891f3e88cc01879ff Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Sat, 25 Aug 2018 13:04:05 +0200 Subject: [PATCH 18/37] Removed UnitTests.swift file --- Logger.xcodeproj/project.pbxproj | 4 ---- UnitTests/UnitTests.swift | 33 -------------------------------- 2 files changed, 37 deletions(-) delete mode 100644 UnitTests/UnitTests.swift diff --git a/Logger.xcodeproj/project.pbxproj b/Logger.xcodeproj/project.pbxproj index 2b38cbb..8dc73dd 100644 --- a/Logger.xcodeproj/project.pbxproj +++ b/Logger.xcodeproj/project.pbxproj @@ -7,7 +7,6 @@ objects = { /* Begin PBXBuildFile section */ - 2E58D35D21316C3500BEF81A /* UnitTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2E58D35C21316C3500BEF81A /* UnitTests.swift */; }; 2E58D35F21316C3500BEF81A /* libLogger.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 2EBF4B3A2122AA34008E4117 /* libLogger.a */; }; 2EBF4B3E2122AA34008E4117 /* Logger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B3D2122AA34008E4117 /* Logger.swift */; }; 2EBF4B452122ACD6008E4117 /* LogStringConvertible.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B442122ACD6008E4117 /* LogStringConvertible.swift */; }; @@ -44,7 +43,6 @@ /* Begin PBXFileReference section */ 2E58D35A21316C3500BEF81A /* UnitTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = UnitTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; - 2E58D35C21316C3500BEF81A /* UnitTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = UnitTests.swift; sourceTree = ""; }; 2E58D35E21316C3500BEF81A /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; }; 2EBF4B3A2122AA34008E4117 /* libLogger.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = libLogger.a; sourceTree = BUILT_PRODUCTS_DIR; }; 2EBF4B3D2122AA34008E4117 /* Logger.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Logger.swift; sourceTree = ""; }; @@ -82,7 +80,6 @@ 2E58D35B21316C3500BEF81A /* UnitTests */ = { isa = PBXGroup; children = ( - 2E58D35C21316C3500BEF81A /* UnitTests.swift */, 2E58D35E21316C3500BEF81A /* Info.plist */, ); path = UnitTests; @@ -230,7 +227,6 @@ isa = PBXSourcesBuildPhase; buildActionMask = 2147483647; files = ( - 2E58D35D21316C3500BEF81A /* UnitTests.swift in Sources */, ); runOnlyForDeploymentPostprocessing = 0; }; diff --git a/UnitTests/UnitTests.swift b/UnitTests/UnitTests.swift deleted file mode 100644 index 5ff3dfe..0000000 --- a/UnitTests/UnitTests.swift +++ /dev/null @@ -1,33 +0,0 @@ -// -// UnitTests.swift -// UnitTests -// -// Created by Wojciech Nagrodzki on 25/08/2018. -// Copyright © 2018 Wojciech Nagrodzki. All rights reserved. -// - -import XCTest - -class UnitTests: XCTestCase { - - override func setUp() { - // Put setup code here. This method is called before the invocation of each test method in the class. - } - - override func tearDown() { - // Put teardown code here. This method is called after the invocation of each test method in the class. - } - - func testExample() { - // This is an example of a functional test case. - // Use XCTAssert and related functions to verify your tests produce the correct results. - } - - func testPerformanceExample() { - // This is an example of a performance test case. - self.measure { - // Put the code you want to measure the time of here. - } - } - -} From 3a6c531dad07a6511d12313ba59a690cf0236dc3 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Sat, 25 Aug 2018 13:12:29 +0200 Subject: [PATCH 19/37] Made Logger scheme shared --- .../xcshareddata/xcschemes/Logger.xcscheme | 99 +++++++++++++++++++ 1 file changed, 99 insertions(+) create mode 100644 Logger.xcodeproj/xcshareddata/xcschemes/Logger.xcscheme diff --git a/Logger.xcodeproj/xcshareddata/xcschemes/Logger.xcscheme b/Logger.xcodeproj/xcshareddata/xcschemes/Logger.xcscheme new file mode 100644 index 0000000..1b5258f --- /dev/null +++ b/Logger.xcodeproj/xcshareddata/xcschemes/Logger.xcscheme @@ -0,0 +1,99 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From f032da4ed83eb71668678bbad7a08d2b2b469cc4 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Sat, 25 Aug 2018 13:28:09 +0200 Subject: [PATCH 20/37] Added LogStringConvertibleTests --- Logger.xcodeproj/project.pbxproj | 4 ++ UnitTests/LogStringConvertibleTests.swift | 50 +++++++++++++++++++++++ 2 files changed, 54 insertions(+) create mode 100644 UnitTests/LogStringConvertibleTests.swift diff --git a/Logger.xcodeproj/project.pbxproj b/Logger.xcodeproj/project.pbxproj index 8dc73dd..684a132 100644 --- a/Logger.xcodeproj/project.pbxproj +++ b/Logger.xcodeproj/project.pbxproj @@ -7,6 +7,7 @@ objects = { /* Begin PBXBuildFile section */ + 2E58D35D21316C3500BEF81A /* LogStringConvertibleTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2E58D35C21316C3500BEF81A /* LogStringConvertibleTests.swift */; }; 2E58D35F21316C3500BEF81A /* libLogger.a in Frameworks */ = {isa = PBXBuildFile; fileRef = 2EBF4B3A2122AA34008E4117 /* libLogger.a */; }; 2EBF4B3E2122AA34008E4117 /* Logger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B3D2122AA34008E4117 /* Logger.swift */; }; 2EBF4B452122ACD6008E4117 /* LogStringConvertible.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B442122ACD6008E4117 /* LogStringConvertible.swift */; }; @@ -43,6 +44,7 @@ /* Begin PBXFileReference section */ 2E58D35A21316C3500BEF81A /* UnitTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = UnitTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; + 2E58D35C21316C3500BEF81A /* LogStringConvertibleTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LogStringConvertibleTests.swift; sourceTree = ""; }; 2E58D35E21316C3500BEF81A /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; }; 2EBF4B3A2122AA34008E4117 /* libLogger.a */ = {isa = PBXFileReference; explicitFileType = archive.ar; includeInIndex = 0; path = libLogger.a; sourceTree = BUILT_PRODUCTS_DIR; }; 2EBF4B3D2122AA34008E4117 /* Logger.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Logger.swift; sourceTree = ""; }; @@ -80,6 +82,7 @@ 2E58D35B21316C3500BEF81A /* UnitTests */ = { isa = PBXGroup; children = ( + 2E58D35C21316C3500BEF81A /* LogStringConvertibleTests.swift */, 2E58D35E21316C3500BEF81A /* Info.plist */, ); path = UnitTests; @@ -227,6 +230,7 @@ isa = PBXSourcesBuildPhase; buildActionMask = 2147483647; files = ( + 2E58D35D21316C3500BEF81A /* LogStringConvertibleTests.swift in Sources */, ); runOnlyForDeploymentPostprocessing = 0; }; diff --git a/UnitTests/LogStringConvertibleTests.swift b/UnitTests/LogStringConvertibleTests.swift new file mode 100644 index 0000000..58bc9b2 --- /dev/null +++ b/UnitTests/LogStringConvertibleTests.swift @@ -0,0 +1,50 @@ +// +// MIT License +// +// Copyright (c) 2018 Wojciech Nagrodzki +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. +// + +import XCTest +@testable import Logger + +class LogStringConvertibleTests: XCTestCase { + + func testZeroObjectsDescription() { + let objects = [Int]() + XCTAssertEqual(objects.logDescription, "[]") + } + + func testOneObjectDescription() { + let objects = [1] + XCTAssertEqual(objects.logDescription, "[1]") + } + + func testTwoObjectsDescription() { + let objects = [1, 2] + XCTAssertEqual(objects.logDescription, "[1, 2]") + } +} + +extension Int: LogStringConvertible { + public var logDescription: String { + return String(describing: self) + } +} From 4df5b125a80bc70bfc1a43845e13abc364006c91 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Sun, 26 Aug 2018 10:51:36 +0200 Subject: [PATCH 21/37] Added LoggerTests --- Logger.xcodeproj/project.pbxproj | 4 +++ UnitTests/LoggetTests.swift | 55 ++++++++++++++++++++++++++++++++ 2 files changed, 59 insertions(+) create mode 100644 UnitTests/LoggetTests.swift diff --git a/Logger.xcodeproj/project.pbxproj b/Logger.xcodeproj/project.pbxproj index 684a132..14a8da4 100644 --- a/Logger.xcodeproj/project.pbxproj +++ b/Logger.xcodeproj/project.pbxproj @@ -18,6 +18,7 @@ 2EBF4B572122B598008E4117 /* DiskLogger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B542122B598008E4117 /* DiskLogger.swift */; }; 2EBF4B582122B598008E4117 /* FileWriter.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B552122B598008E4117 /* FileWriter.swift */; }; 2EBF4B592122B598008E4117 /* Logrotate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B562122B598008E4117 /* Logrotate.swift */; }; + 2ED077D721329CA30058EEFC /* LoggetTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED077D621329CA30058EEFC /* LoggetTests.swift */; }; /* End PBXBuildFile section */ /* Begin PBXContainerItemProxy section */ @@ -58,6 +59,7 @@ 2EBF4B542122B598008E4117 /* DiskLogger.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = DiskLogger.swift; sourceTree = ""; }; 2EBF4B552122B598008E4117 /* FileWriter.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = FileWriter.swift; sourceTree = ""; }; 2EBF4B562122B598008E4117 /* Logrotate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Logrotate.swift; sourceTree = ""; }; + 2ED077D621329CA30058EEFC /* LoggetTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LoggetTests.swift; sourceTree = ""; }; /* End PBXFileReference section */ /* Begin PBXFrameworksBuildPhase section */ @@ -83,6 +85,7 @@ isa = PBXGroup; children = ( 2E58D35C21316C3500BEF81A /* LogStringConvertibleTests.swift */, + 2ED077D621329CA30058EEFC /* LoggetTests.swift */, 2E58D35E21316C3500BEF81A /* Info.plist */, ); path = UnitTests; @@ -231,6 +234,7 @@ buildActionMask = 2147483647; files = ( 2E58D35D21316C3500BEF81A /* LogStringConvertibleTests.swift in Sources */, + 2ED077D721329CA30058EEFC /* LoggetTests.swift in Sources */, ); runOnlyForDeploymentPostprocessing = 0; }; diff --git a/UnitTests/LoggetTests.swift b/UnitTests/LoggetTests.swift new file mode 100644 index 0000000..a753ca7 --- /dev/null +++ b/UnitTests/LoggetTests.swift @@ -0,0 +1,55 @@ +// +// MIT License +// +// Copyright (c) 2018 Wojciech Nagrodzki +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. +// + +import XCTest +@testable import Logger + +class LoggetTests: XCTestCase { + + func testLocation() { + let mock = LoggerMock() + mock.log("", level: .critical) + XCTAssertEqual(mock.location, "LoggetTests:32 testLocation()") + } + + func testLogLevelLogDescription() { + XCTAssertEqual(LogLevel.emergency.logDescription, "emerg") + XCTAssertEqual(LogLevel.alert.logDescription, "alert") + XCTAssertEqual(LogLevel.critical.logDescription, "crit") + XCTAssertEqual(LogLevel.error.logDescription, "err") + XCTAssertEqual(LogLevel.warning.logDescription, "warning") + XCTAssertEqual(LogLevel.notice.logDescription, "notice") + XCTAssertEqual(LogLevel.informational.logDescription, "info") + XCTAssertEqual(LogLevel.debug.logDescription, "debug") + } +} + +private class LoggerMock: Logger { + + var location: String? + + func log(time: Date, level: LogLevel, location: String, message: @autoclosure () -> String) { + self.location = location + } +} From ce546d00726b5fbe89454cde0d8fd15f48099e2c Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Sun, 26 Aug 2018 11:24:15 +0200 Subject: [PATCH 22/37] Added AgregateLoggerTests --- Logger.xcodeproj/project.pbxproj | 4 ++ UnitTests/AgregateLoggerTests.swift | 68 +++++++++++++++++++++++++++++ 2 files changed, 72 insertions(+) create mode 100644 UnitTests/AgregateLoggerTests.swift diff --git a/Logger.xcodeproj/project.pbxproj b/Logger.xcodeproj/project.pbxproj index 14a8da4..69657b4 100644 --- a/Logger.xcodeproj/project.pbxproj +++ b/Logger.xcodeproj/project.pbxproj @@ -19,6 +19,7 @@ 2EBF4B582122B598008E4117 /* FileWriter.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B552122B598008E4117 /* FileWriter.swift */; }; 2EBF4B592122B598008E4117 /* Logrotate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B562122B598008E4117 /* Logrotate.swift */; }; 2ED077D721329CA30058EEFC /* LoggetTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED077D621329CA30058EEFC /* LoggetTests.swift */; }; + 2ED077D92132A4820058EEFC /* AgregateLoggerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED077D82132A4820058EEFC /* AgregateLoggerTests.swift */; }; /* End PBXBuildFile section */ /* Begin PBXContainerItemProxy section */ @@ -60,6 +61,7 @@ 2EBF4B552122B598008E4117 /* FileWriter.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = FileWriter.swift; sourceTree = ""; }; 2EBF4B562122B598008E4117 /* Logrotate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Logrotate.swift; sourceTree = ""; }; 2ED077D621329CA30058EEFC /* LoggetTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LoggetTests.swift; sourceTree = ""; }; + 2ED077D82132A4820058EEFC /* AgregateLoggerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AgregateLoggerTests.swift; sourceTree = ""; }; /* End PBXFileReference section */ /* Begin PBXFrameworksBuildPhase section */ @@ -86,6 +88,7 @@ children = ( 2E58D35C21316C3500BEF81A /* LogStringConvertibleTests.swift */, 2ED077D621329CA30058EEFC /* LoggetTests.swift */, + 2ED077D82132A4820058EEFC /* AgregateLoggerTests.swift */, 2E58D35E21316C3500BEF81A /* Info.plist */, ); path = UnitTests; @@ -234,6 +237,7 @@ buildActionMask = 2147483647; files = ( 2E58D35D21316C3500BEF81A /* LogStringConvertibleTests.swift in Sources */, + 2ED077D92132A4820058EEFC /* AgregateLoggerTests.swift in Sources */, 2ED077D721329CA30058EEFC /* LoggetTests.swift in Sources */, ); runOnlyForDeploymentPostprocessing = 0; diff --git a/UnitTests/AgregateLoggerTests.swift b/UnitTests/AgregateLoggerTests.swift new file mode 100644 index 0000000..c3c2704 --- /dev/null +++ b/UnitTests/AgregateLoggerTests.swift @@ -0,0 +1,68 @@ +// +// MIT License +// +// Copyright (c) 2018 Wojciech Nagrodzki +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. +// + +import XCTest +@testable import Logger + +class AgregateLoggerTests: XCTestCase { + + func testCallForwarding() { + let loggerA = LoggerMock() + let loggerB = LoggerMock() + let agregateLogger = AgregateLogger(loggers: [loggerA, loggerB]) + agregateLogger.log("0", level: .emergency) + agregateLogger.log("1", level: .alert) + agregateLogger.log("2", level: .critical) + agregateLogger.log("3", level: .error) + agregateLogger.log("4", level: .warning) + agregateLogger.log("5", level: .notice) + agregateLogger.log("6", level: .informational) + agregateLogger.log("7", level: .debug) + XCTAssertEqual(loggerA, loggerB) + } +} + +private class LoggerMock: Logger { + + struct Log: Equatable { + let time: Date + let level: LogLevel + let location: String + let message: String + } + + private var logs = [Log]() + + func log(time: Date, level: LogLevel, location: String, message: @autoclosure () -> String) { + let log = Log(time: time, level: level, location: location, message: message()) + logs.append(log) + } +} + +extension LoggerMock: Equatable { + + static func == (lhs: LoggerMock, rhs: LoggerMock) -> Bool { + return lhs.logs == rhs.logs + } +} From 11cdd72a04db9c0932831118f613f3f946ab1f28 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Sun, 26 Aug 2018 12:00:10 +0200 Subject: [PATCH 23/37] Uncoupled Logrotate from FileManager --- Logger.xcodeproj/project.pbxproj | 4 +++ Logger/Loggers/DiskLogger/DiskLogger.swift | 2 +- Logger/Loggers/DiskLogger/FileSystem.swift | 38 ++++++++++++++++++++++ Logger/Loggers/DiskLogger/Logrotate.swift | 12 ++++--- 4 files changed, 50 insertions(+), 6 deletions(-) create mode 100644 Logger/Loggers/DiskLogger/FileSystem.swift diff --git a/Logger.xcodeproj/project.pbxproj b/Logger.xcodeproj/project.pbxproj index 69657b4..11a519e 100644 --- a/Logger.xcodeproj/project.pbxproj +++ b/Logger.xcodeproj/project.pbxproj @@ -20,6 +20,7 @@ 2EBF4B592122B598008E4117 /* Logrotate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B562122B598008E4117 /* Logrotate.swift */; }; 2ED077D721329CA30058EEFC /* LoggetTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED077D621329CA30058EEFC /* LoggetTests.swift */; }; 2ED077D92132A4820058EEFC /* AgregateLoggerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED077D82132A4820058EEFC /* AgregateLoggerTests.swift */; }; + 2ED077DB2132B0320058EEFC /* FileSystem.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED077DA2132B0320058EEFC /* FileSystem.swift */; }; /* End PBXBuildFile section */ /* Begin PBXContainerItemProxy section */ @@ -62,6 +63,7 @@ 2EBF4B562122B598008E4117 /* Logrotate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Logrotate.swift; sourceTree = ""; }; 2ED077D621329CA30058EEFC /* LoggetTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LoggetTests.swift; sourceTree = ""; }; 2ED077D82132A4820058EEFC /* AgregateLoggerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AgregateLoggerTests.swift; sourceTree = ""; }; + 2ED077DA2132B0320058EEFC /* FileSystem.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileSystem.swift; sourceTree = ""; }; /* End PBXFileReference section */ /* Begin PBXFrameworksBuildPhase section */ @@ -142,6 +144,7 @@ 2EBF4B562122B598008E4117 /* Logrotate.swift */, 2EBF4B4F2122B06E008E4117 /* NSFileHandle+Swift.h */, 2EBF4B502122B06E008E4117 /* NSFileHandle+Swift.m */, + 2ED077DA2132B0320058EEFC /* FileSystem.swift */, ); path = DiskLogger; sourceTree = ""; @@ -252,6 +255,7 @@ 2EBF4B3E2122AA34008E4117 /* Logger.swift in Sources */, 2EBF4B512122B06E008E4117 /* NSFileHandle+Swift.m in Sources */, 2EBF4B4B2122AF53008E4117 /* ConsoleLogger.swift in Sources */, + 2ED077DB2132B0320058EEFC /* FileSystem.swift in Sources */, 2EBF4B4A2122AF53008E4117 /* AgregateLogger.swift in Sources */, 2EBF4B592122B598008E4117 /* Logrotate.swift in Sources */, 2EBF4B452122ACD6008E4117 /* LogStringConvertible.swift in Sources */, diff --git a/Logger/Loggers/DiskLogger/DiskLogger.swift b/Logger/Loggers/DiskLogger/DiskLogger.swift index d4cb80f..20e864e 100644 --- a/Logger/Loggers/DiskLogger/DiskLogger.swift +++ b/Logger/Loggers/DiskLogger/DiskLogger.swift @@ -97,7 +97,7 @@ public final class DiskLogger: Logger { } private func rotateLogFiles() throws { - let logrotate = Logrotate(fileURL: fileURL, rotations: rotations) + let logrotate = Logrotate(fileURL: fileURL, rotations: rotations, fileSystem: FileManager.default) try logrotate.rotate() } } diff --git a/Logger/Loggers/DiskLogger/FileSystem.swift b/Logger/Loggers/DiskLogger/FileSystem.swift new file mode 100644 index 0000000..d78c5f4 --- /dev/null +++ b/Logger/Loggers/DiskLogger/FileSystem.swift @@ -0,0 +1,38 @@ +// +// MIT License +// +// Copyright (c) 2018 Wojciech Nagrodzki +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. +// + +import Foundation + +protocol FileSystem { + func itemExists(at URL: URL) -> Bool + func removeItem(at URL: URL) throws + func moveItem(at srcURL: URL, to dstURL: URL) throws +} + +extension FileManager: FileSystem { + + func itemExists(at URL: URL) -> Bool { + return fileExists(atPath: URL.path) + } +} diff --git a/Logger/Loggers/DiskLogger/Logrotate.swift b/Logger/Loggers/DiskLogger/Logrotate.swift index c377d2e..d2a97e4 100644 --- a/Logger/Loggers/DiskLogger/Logrotate.swift +++ b/Logger/Loggers/DiskLogger/Logrotate.swift @@ -29,16 +29,18 @@ final class Logrotate { private let fileURL: URL private let rotations: Int + private let fileSystem: FileSystem /// Initializes new Logrotate instance. /// /// - Parameters: /// - fileURL: URL of the log file. /// - rotations: Number of times log files are rotated before being removed. - init(fileURL: URL, rotations: Int) { + init(fileURL: URL, rotations: Int, fileSystem: FileSystem) { precondition(rotations > 0) self.fileURL = fileURL self.rotations = rotations + self.fileSystem = fileSystem } /// Rotates log files `rotations` number of times. @@ -58,12 +60,12 @@ final class Logrotate { let toDelete = rotatedURLs.last! let toMove = zip(allURLs, rotatedURLs).reversed() - if FileManager.default.fileExists(atPath: toDelete.path) { - try FileManager.default.removeItem(at: toDelete) + if fileSystem.itemExists(at: toDelete) { + try fileSystem.removeItem(at: toDelete) } for (oldURL, newURL) in toMove { - guard FileManager.default.fileExists(atPath: oldURL.path) else { continue } - try FileManager.default.moveItem(at: oldURL, to: newURL) + guard fileSystem.itemExists(at: oldURL) else { continue } + try fileSystem.moveItem(at: oldURL, to: newURL) } } } From 7c58a507787a58cc3541f31ceea4b2d6819902a8 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Sun, 26 Aug 2018 12:08:07 +0200 Subject: [PATCH 24/37] Uncoupled DiskLogger from FileManager --- Logger/Loggers/DiskLogger/DiskLogger.swift | 10 ++++++---- Logger/Loggers/DiskLogger/FileSystem.swift | 9 +++++++-- 2 files changed, 13 insertions(+), 6 deletions(-) diff --git a/Logger/Loggers/DiskLogger/DiskLogger.swift b/Logger/Loggers/DiskLogger/DiskLogger.swift index 20e864e..dfc6859 100644 --- a/Logger/Loggers/DiskLogger/DiskLogger.swift +++ b/Logger/Loggers/DiskLogger/DiskLogger.swift @@ -30,6 +30,7 @@ public final class DiskLogger: Logger { private let fileURL: URL private let fileSizeLimit: UInt64 private let rotations: Int + private let fileSystem: FileSystem private let formatter: DateFormatter private let queue = DispatchQueue(label: "com.wnagrodzki.DiskLogger", qos: .background, attributes: [], autoreleaseFrequency: .workItem, target: nil) private var buffer = Data() @@ -41,10 +42,11 @@ public final class DiskLogger: Logger { /// - fileURL: URL of the log file. /// - fileSizeLimit: Maximum size log file can reach in bytes. Attempt to exceeding that limit triggers log files rotation. /// - rotations: Number of times log files are rotated before being removed. - public init(fileURL: URL, fileSizeLimit: UInt64, rotations: Int) { + public init(fileURL: URL, fileSizeLimit: UInt64, rotations: Int, fileSystem: FileSystem) { self.fileURL = fileURL self.fileSizeLimit = fileSizeLimit self.rotations = rotations + self.fileSystem = fileSystem formatter = DateFormatter() formatter.dateFormat = "yyyy-MM-dd HH:mm:ss.SSS" formatter.timeZone = TimeZone(secondsFromGMT: 0) @@ -80,8 +82,8 @@ public final class DiskLogger: Logger { private func openFileWriter() throws { guard fileWriter == nil else { return } - if FileManager.default.fileExists(atPath: fileURL.path) == false { - FileManager.default.createFile(atPath: fileURL.path, contents: nil, attributes: nil) + if fileSystem.itemExists(at: fileURL) == false { + _ = fileSystem.createFile(at: fileURL) } fileWriter = try FileWriter(fileURL: fileURL, fileSizeLimit: fileSizeLimit) } @@ -97,7 +99,7 @@ public final class DiskLogger: Logger { } private func rotateLogFiles() throws { - let logrotate = Logrotate(fileURL: fileURL, rotations: rotations, fileSystem: FileManager.default) + let logrotate = Logrotate(fileURL: fileURL, rotations: rotations, fileSystem: fileSystem) try logrotate.rotate() } } diff --git a/Logger/Loggers/DiskLogger/FileSystem.swift b/Logger/Loggers/DiskLogger/FileSystem.swift index d78c5f4..b47b316 100644 --- a/Logger/Loggers/DiskLogger/FileSystem.swift +++ b/Logger/Loggers/DiskLogger/FileSystem.swift @@ -24,15 +24,20 @@ import Foundation -protocol FileSystem { +public protocol FileSystem { func itemExists(at URL: URL) -> Bool func removeItem(at URL: URL) throws func moveItem(at srcURL: URL, to dstURL: URL) throws + func createFile(at URL: URL) -> Bool } extension FileManager: FileSystem { - func itemExists(at URL: URL) -> Bool { + public func itemExists(at URL: URL) -> Bool { return fileExists(atPath: URL.path) } + + public func createFile(at URL: URL) -> Bool { + return createFile(atPath: URL.path, contents: nil, attributes: nil) + } } From d333992ca6bdcfebac58d33f264ac45656ecd4ab Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Sun, 26 Aug 2018 13:24:48 +0200 Subject: [PATCH 25/37] Renamed Logrotate to FileRotate --- Logger.xcodeproj/project.pbxproj | 8 ++++---- Logger/Loggers/DiskLogger/DiskLogger.swift | 2 +- .../DiskLogger/{Logrotate.swift => Filerotate.swift} | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) rename Logger/Loggers/DiskLogger/{Logrotate.swift => Filerotate.swift} (99%) diff --git a/Logger.xcodeproj/project.pbxproj b/Logger.xcodeproj/project.pbxproj index 11a519e..a26581b 100644 --- a/Logger.xcodeproj/project.pbxproj +++ b/Logger.xcodeproj/project.pbxproj @@ -17,7 +17,7 @@ 2EBF4B512122B06E008E4117 /* NSFileHandle+Swift.m in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B502122B06E008E4117 /* NSFileHandle+Swift.m */; }; 2EBF4B572122B598008E4117 /* DiskLogger.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B542122B598008E4117 /* DiskLogger.swift */; }; 2EBF4B582122B598008E4117 /* FileWriter.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B552122B598008E4117 /* FileWriter.swift */; }; - 2EBF4B592122B598008E4117 /* Logrotate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B562122B598008E4117 /* Logrotate.swift */; }; + 2EBF4B592122B598008E4117 /* FileRotate.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2EBF4B562122B598008E4117 /* FileRotate.swift */; }; 2ED077D721329CA30058EEFC /* LoggetTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED077D621329CA30058EEFC /* LoggetTests.swift */; }; 2ED077D92132A4820058EEFC /* AgregateLoggerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED077D82132A4820058EEFC /* AgregateLoggerTests.swift */; }; 2ED077DB2132B0320058EEFC /* FileSystem.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED077DA2132B0320058EEFC /* FileSystem.swift */; }; @@ -60,7 +60,7 @@ 2EBF4B532122B2AA008E4117 /* Logger-Bridging-Header.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "Logger-Bridging-Header.h"; sourceTree = ""; }; 2EBF4B542122B598008E4117 /* DiskLogger.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = DiskLogger.swift; sourceTree = ""; }; 2EBF4B552122B598008E4117 /* FileWriter.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = FileWriter.swift; sourceTree = ""; }; - 2EBF4B562122B598008E4117 /* Logrotate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = Logrotate.swift; sourceTree = ""; }; + 2EBF4B562122B598008E4117 /* FileRotate.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = FileRotate.swift; sourceTree = ""; }; 2ED077D621329CA30058EEFC /* LoggetTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LoggetTests.swift; sourceTree = ""; }; 2ED077D82132A4820058EEFC /* AgregateLoggerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AgregateLoggerTests.swift; sourceTree = ""; }; 2ED077DA2132B0320058EEFC /* FileSystem.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileSystem.swift; sourceTree = ""; }; @@ -141,7 +141,7 @@ children = ( 2EBF4B542122B598008E4117 /* DiskLogger.swift */, 2EBF4B552122B598008E4117 /* FileWriter.swift */, - 2EBF4B562122B598008E4117 /* Logrotate.swift */, + 2EBF4B562122B598008E4117 /* FileRotate.swift */, 2EBF4B4F2122B06E008E4117 /* NSFileHandle+Swift.h */, 2EBF4B502122B06E008E4117 /* NSFileHandle+Swift.m */, 2ED077DA2132B0320058EEFC /* FileSystem.swift */, @@ -257,7 +257,7 @@ 2EBF4B4B2122AF53008E4117 /* ConsoleLogger.swift in Sources */, 2ED077DB2132B0320058EEFC /* FileSystem.swift in Sources */, 2EBF4B4A2122AF53008E4117 /* AgregateLogger.swift in Sources */, - 2EBF4B592122B598008E4117 /* Logrotate.swift in Sources */, + 2EBF4B592122B598008E4117 /* FileRotate.swift in Sources */, 2EBF4B452122ACD6008E4117 /* LogStringConvertible.swift in Sources */, ); runOnlyForDeploymentPostprocessing = 0; diff --git a/Logger/Loggers/DiskLogger/DiskLogger.swift b/Logger/Loggers/DiskLogger/DiskLogger.swift index dfc6859..89e46b8 100644 --- a/Logger/Loggers/DiskLogger/DiskLogger.swift +++ b/Logger/Loggers/DiskLogger/DiskLogger.swift @@ -99,7 +99,7 @@ public final class DiskLogger: Logger { } private func rotateLogFiles() throws { - let logrotate = Logrotate(fileURL: fileURL, rotations: rotations, fileSystem: fileSystem) + let logrotate = FileRotate(fileURL: fileURL, rotations: rotations, fileSystem: fileSystem) try logrotate.rotate() } } diff --git a/Logger/Loggers/DiskLogger/Logrotate.swift b/Logger/Loggers/DiskLogger/Filerotate.swift similarity index 99% rename from Logger/Loggers/DiskLogger/Logrotate.swift rename to Logger/Loggers/DiskLogger/Filerotate.swift index d2a97e4..bda34b9 100644 --- a/Logger/Loggers/DiskLogger/Logrotate.swift +++ b/Logger/Loggers/DiskLogger/Filerotate.swift @@ -25,7 +25,7 @@ import Foundation /// Allows log files rotation. -final class Logrotate { +final class FileRotate { private let fileURL: URL private let rotations: Int From 1144d6a90fbad06e9da0fa545e5e6f5a9186282e Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Sun, 26 Aug 2018 13:30:53 +0200 Subject: [PATCH 26/37] Uncoupled DiskLogger from FileRotate --- Logger/Loggers/DiskLogger/DiskLogger.swift | 40 ++++++++++++++++++++-- Logger/Loggers/DiskLogger/Filerotate.swift | 12 ++----- 2 files changed, 41 insertions(+), 11 deletions(-) diff --git a/Logger/Loggers/DiskLogger/DiskLogger.swift b/Logger/Loggers/DiskLogger/DiskLogger.swift index 89e46b8..4088a62 100644 --- a/Logger/Loggers/DiskLogger/DiskLogger.swift +++ b/Logger/Loggers/DiskLogger/DiskLogger.swift @@ -24,6 +24,30 @@ import Foundation +/// Allows log files rotation. +protocol Logrotate { + + /// Rotates log files `rotations` number of times. + /// + /// First deletes file at `.`. + /// Next moves files located at: + /// + /// `, .1, .2 ... .` + /// + /// to `.1, .2 ... .` + func rotate() throws +} + +protocol LogrotateFactory { + + /// Returns newly initialized Logrotate instance. + /// + /// - Parameters: + /// - fileURL: URL of the log file. + /// - rotations: Number of times log files are rotated before being removed. + func makeInstance(fileURL: URL, rotations: Int) -> Logrotate +} + /// Logger that writes messages into the file at specified URL with log rotation support. public final class DiskLogger: Logger { @@ -31,6 +55,7 @@ public final class DiskLogger: Logger { private let fileSizeLimit: UInt64 private let rotations: Int private let fileSystem: FileSystem + private let logrotateFactory: LogrotateFactory private let formatter: DateFormatter private let queue = DispatchQueue(label: "com.wnagrodzki.DiskLogger", qos: .background, attributes: [], autoreleaseFrequency: .workItem, target: nil) private var buffer = Data() @@ -42,11 +67,16 @@ public final class DiskLogger: Logger { /// - fileURL: URL of the log file. /// - fileSizeLimit: Maximum size log file can reach in bytes. Attempt to exceeding that limit triggers log files rotation. /// - rotations: Number of times log files are rotated before being removed. - public init(fileURL: URL, fileSizeLimit: UInt64, rotations: Int, fileSystem: FileSystem) { + public convenience init(fileURL: URL, fileSizeLimit: UInt64, rotations: Int) { + self.init(fileURL: fileURL, fileSizeLimit: fileSizeLimit, rotations: rotations, fileSystem: FileManager.default, logrotateFactory: FileRotateFactory()) + } + + init(fileURL: URL, fileSizeLimit: UInt64, rotations: Int, fileSystem: FileSystem, logrotateFactory: LogrotateFactory) { self.fileURL = fileURL self.fileSizeLimit = fileSizeLimit self.rotations = rotations self.fileSystem = fileSystem + self.logrotateFactory = logrotateFactory formatter = DateFormatter() formatter.dateFormat = "yyyy-MM-dd HH:mm:ss.SSS" formatter.timeZone = TimeZone(secondsFromGMT: 0) @@ -99,7 +129,13 @@ public final class DiskLogger: Logger { } private func rotateLogFiles() throws { - let logrotate = FileRotate(fileURL: fileURL, rotations: rotations, fileSystem: fileSystem) + let logrotate = logrotateFactory.makeInstance(fileURL: fileURL, rotations: rotations) try logrotate.rotate() } } + +private class FileRotateFactory: LogrotateFactory { + func makeInstance(fileURL: URL, rotations: Int) -> Logrotate { + return FileRotate(fileURL: fileURL, rotations: rotations, fileSystem: FileManager.default) + } +} diff --git a/Logger/Loggers/DiskLogger/Filerotate.swift b/Logger/Loggers/DiskLogger/Filerotate.swift index bda34b9..0963cfa 100644 --- a/Logger/Loggers/DiskLogger/Filerotate.swift +++ b/Logger/Loggers/DiskLogger/Filerotate.swift @@ -24,7 +24,6 @@ import Foundation -/// Allows log files rotation. final class FileRotate { private let fileURL: URL @@ -42,15 +41,10 @@ final class FileRotate { self.rotations = rotations self.fileSystem = fileSystem } +} + +extension FileRotate: Logrotate { - /// Rotates log files `rotations` number of times. - /// - /// First deletes file at `.`. - /// Next moves files located at: - /// - /// `, .1, .2 ... .` - /// - /// to `.1, .2 ... .` func rotate() throws { let range = 1...rotations let pathExtensions = range.map { "\($0)" } From 74fe9ba0d2ec276adcfdf0d7d13491469b9a9b5c Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Tue, 28 Aug 2018 19:14:55 +0200 Subject: [PATCH 27/37] Uncoupled DiskLogger from FileWriter --- Logger/Loggers/DiskLogger/DiskLogger.swift | 62 +++++++++++++++++----- Logger/Loggers/DiskLogger/FileWriter.swift | 14 ++--- 2 files changed, 53 insertions(+), 23 deletions(-) diff --git a/Logger/Loggers/DiskLogger/DiskLogger.swift b/Logger/Loggers/DiskLogger/DiskLogger.swift index 4088a62..5eebbb5 100644 --- a/Logger/Loggers/DiskLogger/DiskLogger.swift +++ b/Logger/Loggers/DiskLogger/DiskLogger.swift @@ -24,6 +24,34 @@ import Foundation +/// Write failed as allowed size limit would be exceeded. +public struct SizeLimitedFileQuotaReached: Error {} + +/// Allows writing to a file while respecting allowed size limit. +protocol SizeLimitedFile { + + /// Synchronously writes `data` at the end of the file. + /// + /// - Parameter data: The data to be written. + /// - Throws: Throws an error if no free space is left on the file system, or if any other writing error occurs. + /// Throws `SizeLimitedFileQuotaReached` if allowed size limit would be exceeded. + func write(_ data: Data) throws + + /// Writes all in-memory data to permanent storage and closes the file. + func synchronizeAndCloseFile() +} + +protocol SizeLimitedFileFactory { + + /// Returns newly initialized SizeLimitedFile instance. + /// + /// - Parameters: + /// - fileURL: URL of the file. + /// - fileSizeLimit: Maximum size the file can reach in bytes. + /// - Throws: An error that may occur while the file is being opened for writing. + func makeInstance(fileURL: URL, fileSizeLimit: UInt64) throws -> SizeLimitedFile +} + /// Allows log files rotation. protocol Logrotate { @@ -55,11 +83,12 @@ public final class DiskLogger: Logger { private let fileSizeLimit: UInt64 private let rotations: Int private let fileSystem: FileSystem + private let sizeLimitedFileFactory: SizeLimitedFileFactory private let logrotateFactory: LogrotateFactory private let formatter: DateFormatter private let queue = DispatchQueue(label: "com.wnagrodzki.DiskLogger", qos: .background, attributes: [], autoreleaseFrequency: .workItem, target: nil) private var buffer = Data() - private var fileWriter: FileWriter! + private var sizeLimitedFile: SizeLimitedFile! /// Initializes new DiskLogger instance. /// @@ -68,14 +97,15 @@ public final class DiskLogger: Logger { /// - fileSizeLimit: Maximum size log file can reach in bytes. Attempt to exceeding that limit triggers log files rotation. /// - rotations: Number of times log files are rotated before being removed. public convenience init(fileURL: URL, fileSizeLimit: UInt64, rotations: Int) { - self.init(fileURL: fileURL, fileSizeLimit: fileSizeLimit, rotations: rotations, fileSystem: FileManager.default, logrotateFactory: FileRotateFactory()) + self.init(fileURL: fileURL, fileSizeLimit: fileSizeLimit, rotations: rotations, fileSystem: FileManager.default, sizeLimitedFileFactory: FileWriterFactory(), logrotateFactory: FileRotateFactory()) } - init(fileURL: URL, fileSizeLimit: UInt64, rotations: Int, fileSystem: FileSystem, logrotateFactory: LogrotateFactory) { + init(fileURL: URL, fileSizeLimit: UInt64, rotations: Int, fileSystem: FileSystem, sizeLimitedFileFactory: SizeLimitedFileFactory, logrotateFactory: LogrotateFactory) { self.fileURL = fileURL self.fileSizeLimit = fileSizeLimit self.rotations = rotations self.fileSystem = fileSystem + self.sizeLimitedFileFactory = sizeLimitedFileFactory self.logrotateFactory = logrotateFactory formatter = DateFormatter() formatter.dateFormat = "yyyy-MM-dd HH:mm:ss.SSS" @@ -93,12 +123,12 @@ public final class DiskLogger: Logger { self.buffer.append(data) do { - try self.openFileWriter() + try self.openSizeLimitedFile() do { try self.writeBuffer() } - catch is FileWriter.FileSizeLimitReached { - self.closeFileWriter() + catch is SizeLimitedFileQuotaReached { + self.closeSizeLimitedFile() try self.rotateLogFiles() } } @@ -110,22 +140,22 @@ public final class DiskLogger: Logger { } } - private func openFileWriter() throws { - guard fileWriter == nil else { return } + private func openSizeLimitedFile() throws { + guard sizeLimitedFile == nil else { return } if fileSystem.itemExists(at: fileURL) == false { _ = fileSystem.createFile(at: fileURL) } - fileWriter = try FileWriter(fileURL: fileURL, fileSizeLimit: fileSizeLimit) + sizeLimitedFile = try sizeLimitedFileFactory.makeInstance(fileURL: fileURL, fileSizeLimit: fileSizeLimit) } private func writeBuffer() throws { - try fileWriter.write(buffer) + try sizeLimitedFile.write(buffer) buffer.removeAll() } - private func closeFileWriter() { - self.fileWriter.synchronizeAndCloseFile() - self.fileWriter = nil + private func closeSizeLimitedFile() { + self.sizeLimitedFile.synchronizeAndCloseFile() + self.sizeLimitedFile = nil } private func rotateLogFiles() throws { @@ -139,3 +169,9 @@ private class FileRotateFactory: LogrotateFactory { return FileRotate(fileURL: fileURL, rotations: rotations, fileSystem: FileManager.default) } } + +private class FileWriterFactory: SizeLimitedFileFactory { + func makeInstance(fileURL: URL, fileSizeLimit: UInt64) throws -> SizeLimitedFile { + return try FileWriter(fileURL: fileURL, fileSizeLimit: fileSizeLimit) + } +} diff --git a/Logger/Loggers/DiskLogger/FileWriter.swift b/Logger/Loggers/DiskLogger/FileWriter.swift index 1083812..471703d 100644 --- a/Logger/Loggers/DiskLogger/FileWriter.swift +++ b/Logger/Loggers/DiskLogger/FileWriter.swift @@ -27,9 +27,6 @@ import Foundation /// Allows writing to a file while respecting allowed size limit. final class FileWriter { - /// Write failed as allowed size limit would be exceeded for the file. - struct FileSizeLimitReached: Error {} - private let handle: FileHandle private let sizeLimit: UInt64 private var currentSize: UInt64 @@ -45,22 +42,19 @@ final class FileWriter { self.sizeLimit = fileSizeLimit currentSize = handle.seekToEndOfFile() } +} + +extension FileWriter: SizeLimitedFile { - /// Synchronously writes `data` at the end of the file. - /// - /// - Parameter data: The data to be written. - /// - Throws: Throws an error if no free space is left on the file system, or if any other writing error occurs. - /// Throws `FileSizeLimitReached` if allowed size limit would be exceeded for the file. func write(_ data: Data) throws { let dataSize = UInt64(data.count) guard currentSize + dataSize <= sizeLimit else { - throw FileSizeLimitReached() + throw SizeLimitedFileQuotaReached() } try handle.swift_write(data) currentSize += dataSize } - /// Writes all in-memory data to permanent storage and closes the file. func synchronizeAndCloseFile() { handle.synchronizeFile() handle.closeFile() From ab7ec33418fe89cf0f07d82ac1b26d8fca58b810 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Tue, 28 Aug 2018 20:01:26 +0200 Subject: [PATCH 28/37] Uncoupled FileWriter from FileHandle --- Logger/Loggers/DiskLogger/DiskLogger.swift | 12 ++++++++++- Logger/Loggers/DiskLogger/FileWriter.swift | 25 ++++++++++++++++------ 2 files changed, 29 insertions(+), 8 deletions(-) diff --git a/Logger/Loggers/DiskLogger/DiskLogger.swift b/Logger/Loggers/DiskLogger/DiskLogger.swift index 5eebbb5..6718d09 100644 --- a/Logger/Loggers/DiskLogger/DiskLogger.swift +++ b/Logger/Loggers/DiskLogger/DiskLogger.swift @@ -172,6 +172,16 @@ private class FileRotateFactory: LogrotateFactory { private class FileWriterFactory: SizeLimitedFileFactory { func makeInstance(fileURL: URL, fileSizeLimit: UInt64) throws -> SizeLimitedFile { - return try FileWriter(fileURL: fileURL, fileSizeLimit: fileSizeLimit) + return try FileWriter(fileURL: fileURL, fileSizeLimit: fileSizeLimit, fileFactory: FileHandleFactory()) } } + +private class FileHandleFactory: FileFactory { + func makeInstance(forWritingTo: URL) throws -> File { + return try FileHandle(forWritingTo: forWritingTo) + } +} + +extension FileHandle: File { + +} diff --git a/Logger/Loggers/DiskLogger/FileWriter.swift b/Logger/Loggers/DiskLogger/FileWriter.swift index 471703d..be1ff30 100644 --- a/Logger/Loggers/DiskLogger/FileWriter.swift +++ b/Logger/Loggers/DiskLogger/FileWriter.swift @@ -24,10 +24,21 @@ import Foundation +protocol File { + func seekToEndOfFile() -> UInt64 + func swift_write(_ data: Data) throws + func synchronizeFile() + func closeFile() +} + +protocol FileFactory { + func makeInstance(forWritingTo: URL) throws -> File +} + /// Allows writing to a file while respecting allowed size limit. final class FileWriter { - private let handle: FileHandle + private let file: File private let sizeLimit: UInt64 private var currentSize: UInt64 @@ -37,10 +48,10 @@ final class FileWriter { /// - fileURL: URL of the file. /// - fileSizeLimit: Maximum size the file can reach in bytes. /// - Throws: An error that may occur while the file is being opened for writing. - init(fileURL: URL, fileSizeLimit: UInt64) throws { - handle = try FileHandle(forWritingTo: fileURL) + init(fileURL: URL, fileSizeLimit: UInt64, fileFactory: FileFactory) throws { + file = try fileFactory.makeInstance(forWritingTo: fileURL) self.sizeLimit = fileSizeLimit - currentSize = handle.seekToEndOfFile() + currentSize = file.seekToEndOfFile() } } @@ -51,12 +62,12 @@ extension FileWriter: SizeLimitedFile { guard currentSize + dataSize <= sizeLimit else { throw SizeLimitedFileQuotaReached() } - try handle.swift_write(data) + try file.swift_write(data) currentSize += dataSize } func synchronizeAndCloseFile() { - handle.synchronizeFile() - handle.closeFile() + file.synchronizeFile() + file.closeFile() } } From 9253166f1dddb11a88ec9f732054837075224367 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Tue, 28 Aug 2018 21:02:51 +0200 Subject: [PATCH 29/37] Added FileRotateTests --- Logger.xcodeproj/project.pbxproj | 4 + UnitTests/FileRotateTests.swift | 181 +++++++++++++++++++++++++++++++ 2 files changed, 185 insertions(+) create mode 100644 UnitTests/FileRotateTests.swift diff --git a/Logger.xcodeproj/project.pbxproj b/Logger.xcodeproj/project.pbxproj index a26581b..076fc31 100644 --- a/Logger.xcodeproj/project.pbxproj +++ b/Logger.xcodeproj/project.pbxproj @@ -21,6 +21,7 @@ 2ED077D721329CA30058EEFC /* LoggetTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED077D621329CA30058EEFC /* LoggetTests.swift */; }; 2ED077D92132A4820058EEFC /* AgregateLoggerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED077D82132A4820058EEFC /* AgregateLoggerTests.swift */; }; 2ED077DB2132B0320058EEFC /* FileSystem.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED077DA2132B0320058EEFC /* FileSystem.swift */; }; + 2ED103E12135C61100EB3683 /* FileRotateTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED103E02135C61100EB3683 /* FileRotateTests.swift */; }; /* End PBXBuildFile section */ /* Begin PBXContainerItemProxy section */ @@ -64,6 +65,7 @@ 2ED077D621329CA30058EEFC /* LoggetTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = LoggetTests.swift; sourceTree = ""; }; 2ED077D82132A4820058EEFC /* AgregateLoggerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AgregateLoggerTests.swift; sourceTree = ""; }; 2ED077DA2132B0320058EEFC /* FileSystem.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileSystem.swift; sourceTree = ""; }; + 2ED103E02135C61100EB3683 /* FileRotateTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileRotateTests.swift; sourceTree = ""; }; /* End PBXFileReference section */ /* Begin PBXFrameworksBuildPhase section */ @@ -91,6 +93,7 @@ 2E58D35C21316C3500BEF81A /* LogStringConvertibleTests.swift */, 2ED077D621329CA30058EEFC /* LoggetTests.swift */, 2ED077D82132A4820058EEFC /* AgregateLoggerTests.swift */, + 2ED103E02135C61100EB3683 /* FileRotateTests.swift */, 2E58D35E21316C3500BEF81A /* Info.plist */, ); path = UnitTests; @@ -241,6 +244,7 @@ files = ( 2E58D35D21316C3500BEF81A /* LogStringConvertibleTests.swift in Sources */, 2ED077D92132A4820058EEFC /* AgregateLoggerTests.swift in Sources */, + 2ED103E12135C61100EB3683 /* FileRotateTests.swift in Sources */, 2ED077D721329CA30058EEFC /* LoggetTests.swift in Sources */, ); runOnlyForDeploymentPostprocessing = 0; diff --git a/UnitTests/FileRotateTests.swift b/UnitTests/FileRotateTests.swift new file mode 100644 index 0000000..13ca7c0 --- /dev/null +++ b/UnitTests/FileRotateTests.swift @@ -0,0 +1,181 @@ +// +// MIT License +// +// Copyright (c) 2018 Wojciech Nagrodzki +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. +// + +import XCTest +@testable import Logger + +class FileRotateTests: XCTestCase { + + let logURL = URL(fileURLWithPath: "/var/log/application.log") + let log1URL = URL(fileURLWithPath: "/var/log/application.log.1") + let log2URL = URL(fileURLWithPath: "/var/log/application.log.2") + let log3URL = URL(fileURLWithPath: "/var/log/application.log.3") + + func test_1rotation_0files() { + let fileSystem = FileSystemMock(files: []) + let logrotate = FileRotate(fileURL: logURL, rotations: 1, fileSystem: fileSystem) + try? logrotate.rotate() + + let actual = fileSystem.files + let expected = Set() + XCTAssertEqual(actual, expected) + } + + func test_1rotation_1file() { + let fileSystem = FileSystemMock(files: [logURL]) + let logrotate = FileRotate(fileURL: logURL, rotations: 1, fileSystem: fileSystem) + try? logrotate.rotate() + + let actual = fileSystem.files + let expected = Set([log1URL]) + XCTAssertEqual(actual, expected) + } + + func test_1rotation_2files() { + let fileSystem = FileSystemMock(files: [logURL, log1URL]) + let logrotate = FileRotate(fileURL: logURL, rotations: 1, fileSystem: fileSystem) + try? logrotate.rotate() + + let actual = fileSystem.files + let expected = Set([log1URL]) + XCTAssertEqual(actual, expected) + } + + func test_1rotation_3files() { + let fileSystem = FileSystemMock(files: [logURL, log1URL, log2URL]) + let logrotate = FileRotate(fileURL: logURL, rotations: 1, fileSystem: fileSystem) + try? logrotate.rotate() + + let actual = fileSystem.files + let expected = Set([log1URL, log2URL]) + XCTAssertEqual(actual, expected) + } + + func test_2rotations_0files() { + let fileSystem = FileSystemMock(files: []) + let logrotate = FileRotate(fileURL: logURL, rotations: 2, fileSystem: fileSystem) + try? logrotate.rotate() + + let actual = fileSystem.files + let expected = Set() + XCTAssertEqual(actual, expected) + } + + func test_2rotations_1file() { + let fileSystem = FileSystemMock(files: [logURL]) + let logrotate = FileRotate(fileURL: logURL, rotations: 2, fileSystem: fileSystem) + try? logrotate.rotate() + + let actual = fileSystem.files + let expected = Set([log1URL]) + XCTAssertEqual(actual, expected) + } + + func test_2rotations_2files() { + let fileSystem = FileSystemMock(files: [logURL, log1URL]) + let logrotate = FileRotate(fileURL: logURL, rotations: 2, fileSystem: fileSystem) + try? logrotate.rotate() + + let actual = fileSystem.files + let expected = Set([log1URL, log2URL]) + XCTAssertEqual(actual, expected) + } + + func test_2rotations_3files() { + let fileSystem = FileSystemMock(files: [logURL, log1URL, log2URL]) + let logrotate = FileRotate(fileURL: logURL, rotations: 2, fileSystem: fileSystem) + try? logrotate.rotate() + + let actual = fileSystem.files + let expected = Set([log1URL, log2URL]) + XCTAssertEqual(actual, expected) + } + + func test_2rotations_4files() { + let fileSystem = FileSystemMock(files: [logURL, log1URL, log2URL, log3URL]) + let logrotate = FileRotate(fileURL: logURL, rotations: 2, fileSystem: fileSystem) + try? logrotate.rotate() + + let actual = fileSystem.files + let expected = Set([log1URL, log2URL, log3URL]) + XCTAssertEqual(actual, expected) + } + + func testErrorPropagation() { + let fileSystem = BrokenFileSystem() + let logrotate = FileRotate(fileURL: logURL, rotations: 1, fileSystem: fileSystem) + + XCTAssertThrowsError(try logrotate.rotate(), "An error when removing or moving an item") { (error) in + XCTAssertTrue(error is BrokenFileSystem.IOError) + } + } +} + +private class FileSystemMock: FileSystem { + + private(set) var files = Set() + + init(files: Set) { + self.files = files + } + + func itemExists(at URL: URL) -> Bool { + return files.contains(URL) + } + + func removeItem(at URL: URL) throws { + files.remove(URL) + } + + func moveItem(at srcURL: URL, to dstURL: URL) throws { + files.remove(srcURL) + files.insert(dstURL) + } + + func createFile(at URL: URL) -> Bool { + files.insert(URL) + return true + } +} + +private class BrokenFileSystem: FileSystem { + + struct IOError: Error { } + + func itemExists(at URL: URL) -> Bool { + return true + } + + func removeItem(at URL: URL) throws { + throw IOError() + } + + func moveItem(at srcURL: URL, to dstURL: URL) throws { + throw IOError() + } + + func createFile(at URL: URL) -> Bool { + return false + } +} From b224674222ea3114f9411956db960aebc3e64565 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Thu, 30 Aug 2018 18:38:53 +0200 Subject: [PATCH 30/37] Added FileWriterTests --- Logger.xcodeproj/project.pbxproj | 4 ++ UnitTests/FileWriterTests.swift | 107 +++++++++++++++++++++++++++++++ 2 files changed, 111 insertions(+) create mode 100644 UnitTests/FileWriterTests.swift diff --git a/Logger.xcodeproj/project.pbxproj b/Logger.xcodeproj/project.pbxproj index 076fc31..6a86dba 100644 --- a/Logger.xcodeproj/project.pbxproj +++ b/Logger.xcodeproj/project.pbxproj @@ -22,6 +22,7 @@ 2ED077D92132A4820058EEFC /* AgregateLoggerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED077D82132A4820058EEFC /* AgregateLoggerTests.swift */; }; 2ED077DB2132B0320058EEFC /* FileSystem.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED077DA2132B0320058EEFC /* FileSystem.swift */; }; 2ED103E12135C61100EB3683 /* FileRotateTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED103E02135C61100EB3683 /* FileRotateTests.swift */; }; + 2ED103E32135D3FB00EB3683 /* FileWriterTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED103E22135D3FB00EB3683 /* FileWriterTests.swift */; }; /* End PBXBuildFile section */ /* Begin PBXContainerItemProxy section */ @@ -66,6 +67,7 @@ 2ED077D82132A4820058EEFC /* AgregateLoggerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = AgregateLoggerTests.swift; sourceTree = ""; }; 2ED077DA2132B0320058EEFC /* FileSystem.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileSystem.swift; sourceTree = ""; }; 2ED103E02135C61100EB3683 /* FileRotateTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileRotateTests.swift; sourceTree = ""; }; + 2ED103E22135D3FB00EB3683 /* FileWriterTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileWriterTests.swift; sourceTree = ""; }; /* End PBXFileReference section */ /* Begin PBXFrameworksBuildPhase section */ @@ -93,6 +95,7 @@ 2E58D35C21316C3500BEF81A /* LogStringConvertibleTests.swift */, 2ED077D621329CA30058EEFC /* LoggetTests.swift */, 2ED077D82132A4820058EEFC /* AgregateLoggerTests.swift */, + 2ED103E22135D3FB00EB3683 /* FileWriterTests.swift */, 2ED103E02135C61100EB3683 /* FileRotateTests.swift */, 2E58D35E21316C3500BEF81A /* Info.plist */, ); @@ -243,6 +246,7 @@ buildActionMask = 2147483647; files = ( 2E58D35D21316C3500BEF81A /* LogStringConvertibleTests.swift in Sources */, + 2ED103E32135D3FB00EB3683 /* FileWriterTests.swift in Sources */, 2ED077D92132A4820058EEFC /* AgregateLoggerTests.swift in Sources */, 2ED103E12135C61100EB3683 /* FileRotateTests.swift in Sources */, 2ED077D721329CA30058EEFC /* LoggetTests.swift in Sources */, diff --git a/UnitTests/FileWriterTests.swift b/UnitTests/FileWriterTests.swift new file mode 100644 index 0000000..cb3ebc7 --- /dev/null +++ b/UnitTests/FileWriterTests.swift @@ -0,0 +1,107 @@ +// +// MIT License +// +// Copyright (c) 2018 Wojciech Nagrodzki +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. +// + +import XCTest +@testable import Logger + +class FileWriterTests: XCTestCase { + + let logURL = URL(fileURLWithPath: "/var/log/application.log") + + func testFileOpeningFailure() { + let factory = UnopenableFileFactory() + XCTAssertThrowsError(try FileWriter(fileURL: logURL, fileSizeLimit: 0, fileFactory: factory), "file open failure") { (error) in + XCTAssertTrue(error is UnopenableFileFactory.OpenFileError) + } + } + + func testKeepingFileSizeLimit() throws { + let factory = FileMockFactory() + let writer = try FileWriter(fileURL: logURL, fileSizeLimit: 1, fileFactory: factory) + let data = Data(bytes: [0]) + try writer.write(data) + + XCTAssertEqual(factory.mock.writtenData, data) + } + + func testExceedingFileSizeLimit() throws { + let factory = FileMockFactory() + let writer = try FileWriter(fileURL: logURL, fileSizeLimit: 1, fileFactory: factory) + let data = Data(bytes: [0, 0]) + + XCTAssertThrowsError(try writer.write(data), "file size limit exceeded") { (error) in + XCTAssertTrue(error is SizeLimitedFileQuotaReached) + } + + XCTAssertEqual(factory.mock.writtenData.count, 0) + } + + func testSynchronizingAndClosingFile() throws { + let factory = FileMockFactory() + let writer = try FileWriter(fileURL: logURL, fileSizeLimit: 1, fileFactory: factory) + writer.synchronizeAndCloseFile() + XCTAssertTrue(factory.mock.synchronizeFileCallCount == 1 && factory.mock.closeFileCallCount == 1) + } +} + +private class UnopenableFileFactory: FileFactory { + + struct OpenFileError: Error {} + + func makeInstance(forWritingTo: URL) throws -> File { + throw OpenFileError() + } +} + +private class FileMockFactory: FileFactory { + + let mock = FileMock() + + func makeInstance(forWritingTo: URL) throws -> File { + return mock + } +} + +private class FileMock: File { + + private(set) var writtenData = Data() + private(set) var synchronizeFileCallCount = 0 + private(set) var closeFileCallCount = 0 + + func seekToEndOfFile() -> UInt64 { + return 0 + } + + func swift_write(_ data: Data) throws { + self.writtenData.append(data) + } + + func synchronizeFile() { + synchronizeFileCallCount += 1 + } + + func closeFile() { + closeFileCallCount += 1 + } +} From cedf3a2b52472cd5d6c75284a6c83f0d9835629b Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Sat, 1 Sep 2018 08:57:49 +0200 Subject: [PATCH 31/37] Added DiskLoggerTests --- Logger.xcodeproj/project.pbxproj | 4 + UnitTests/DiskLoggerTests.swift | 241 +++++++++++++++++++++++++++++++ 2 files changed, 245 insertions(+) create mode 100644 UnitTests/DiskLoggerTests.swift diff --git a/Logger.xcodeproj/project.pbxproj b/Logger.xcodeproj/project.pbxproj index 6a86dba..0b36d05 100644 --- a/Logger.xcodeproj/project.pbxproj +++ b/Logger.xcodeproj/project.pbxproj @@ -23,6 +23,7 @@ 2ED077DB2132B0320058EEFC /* FileSystem.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED077DA2132B0320058EEFC /* FileSystem.swift */; }; 2ED103E12135C61100EB3683 /* FileRotateTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED103E02135C61100EB3683 /* FileRotateTests.swift */; }; 2ED103E32135D3FB00EB3683 /* FileWriterTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED103E22135D3FB00EB3683 /* FileWriterTests.swift */; }; + 2ED103E52138553B00EB3683 /* DiskLoggerTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2ED103E42138553B00EB3683 /* DiskLoggerTests.swift */; }; /* End PBXBuildFile section */ /* Begin PBXContainerItemProxy section */ @@ -68,6 +69,7 @@ 2ED077DA2132B0320058EEFC /* FileSystem.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileSystem.swift; sourceTree = ""; }; 2ED103E02135C61100EB3683 /* FileRotateTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileRotateTests.swift; sourceTree = ""; }; 2ED103E22135D3FB00EB3683 /* FileWriterTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileWriterTests.swift; sourceTree = ""; }; + 2ED103E42138553B00EB3683 /* DiskLoggerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DiskLoggerTests.swift; sourceTree = ""; }; /* End PBXFileReference section */ /* Begin PBXFrameworksBuildPhase section */ @@ -95,6 +97,7 @@ 2E58D35C21316C3500BEF81A /* LogStringConvertibleTests.swift */, 2ED077D621329CA30058EEFC /* LoggetTests.swift */, 2ED077D82132A4820058EEFC /* AgregateLoggerTests.swift */, + 2ED103E42138553B00EB3683 /* DiskLoggerTests.swift */, 2ED103E22135D3FB00EB3683 /* FileWriterTests.swift */, 2ED103E02135C61100EB3683 /* FileRotateTests.swift */, 2E58D35E21316C3500BEF81A /* Info.plist */, @@ -247,6 +250,7 @@ files = ( 2E58D35D21316C3500BEF81A /* LogStringConvertibleTests.swift in Sources */, 2ED103E32135D3FB00EB3683 /* FileWriterTests.swift in Sources */, + 2ED103E52138553B00EB3683 /* DiskLoggerTests.swift in Sources */, 2ED077D92132A4820058EEFC /* AgregateLoggerTests.swift in Sources */, 2ED103E12135C61100EB3683 /* FileRotateTests.swift in Sources */, 2ED077D721329CA30058EEFC /* LoggetTests.swift in Sources */, diff --git a/UnitTests/DiskLoggerTests.swift b/UnitTests/DiskLoggerTests.swift new file mode 100644 index 0000000..aaededc --- /dev/null +++ b/UnitTests/DiskLoggerTests.swift @@ -0,0 +1,241 @@ +// +// MIT License +// +// Copyright (c) 2018 Wojciech Nagrodzki +// +// Permission is hereby granted, free of charge, to any person obtaining a copy +// of this software and associated documentation files (the "Software"), to deal +// in the Software without restriction, including without limitation the rights +// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +// copies of the Software, and to permit persons to whom the Software is +// furnished to do so, subject to the following conditions: +// +// The above copyright notice and this permission notice shall be included in all +// copies or substantial portions of the Software. +// +// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +// SOFTWARE. +// + +import XCTest +@testable import Logger + +class DiskLoggerTests: XCTestCase { + + let logURL = URL(fileURLWithPath: "/var/log/application.log") + + func testLoggingMessageToFile() { + let expectation = XCTestExpectation(description: "write(_:) was called on SizeLimitedFile") + expectation.expectedFulfillmentCount = 1 + + let filesystem = FileSystemStub() + let sizeLimitedFileFactory = SizeLimitedFileMockFactory(writeCall: expectation) + let logrotateFactory = LogrotateMockFactory() + let logger = DiskLogger(fileURL: logURL, + fileSizeLimit: 1024, + rotations: 1, + fileSystem: filesystem, + sizeLimitedFileFactory: sizeLimitedFileFactory, + logrotateFactory: logrotateFactory) + + logger.log("message", level: .critical) + + let result = XCTWaiter().wait(for: [expectation], timeout: 1.0) + XCTAssertEqual(result, .completed) + + XCTAssertEqual(sizeLimitedFileFactory.files.count, 1) + + // "2018-08-30 17:23:11.514 DiskLoggerTests:46 testWritingMessageToFile() a message\n" + let loggedMessage = String(decoding: sizeLimitedFileFactory.files[0].data, as: UTF8.self) + let expectedSuffix = " DiskLoggerTests:46 testLoggingMessageToFile() message\n" + + XCTAssertTrue(loggedMessage.hasSuffix(expectedSuffix)) + } + + func testExceedingFileSizeLimit() { + let expectation = XCTestExpectation(description: "write(_:) was called on SizeLimitedFile") + expectation.expectedFulfillmentCount = 2 + + let filesystem = FileSystemStub() + let sizeLimitedFileFactory = SizeLimitedFileMockFactory(writeCall: expectation) + let logrotateFactory = LogrotateMockFactory() + let logger = DiskLogger(fileURL: logURL, + fileSizeLimit: 91, + rotations: 1, + fileSystem: filesystem, + sizeLimitedFileFactory: sizeLimitedFileFactory, + logrotateFactory: logrotateFactory) + + logger.log("1st message", level: .critical) + logger.log("2st message", level: .critical) + + let result = XCTWaiter().wait(for: [expectation], timeout: 1.0) + XCTAssertEqual(result, .completed) + + XCTAssertEqual(sizeLimitedFileFactory.files.count, 2) + + // "2018-08-31 18:29:34.748 DiskLoggerTests:75 testExceedingFileSizeLimit() 2st message\n" + let loggedMessage = String(decoding: sizeLimitedFileFactory.files[1].data, as: UTF8.self) + let expectedSuffix = " DiskLoggerTests:75 testExceedingFileSizeLimit() 2st message\n" + + XCTAssertTrue(loggedMessage.hasSuffix(expectedSuffix)) + } + + func testErrorDuringLogProcess() { + let expectation = XCTestExpectation(description: "write(_:) was called on SizeLimitedFile") + expectation.expectedFulfillmentCount = 2 + + let filesystem = FileSystemStub() + let sizeLimitedFileFactory = UnwritableFileStubFactory(writeCall: expectation) + let logrotateFactory = LogrotateMockFactory() + let logger = DiskLogger(fileURL: logURL, + fileSizeLimit: 91, + rotations: 1, + fileSystem: filesystem, + sizeLimitedFileFactory: sizeLimitedFileFactory, + logrotateFactory: logrotateFactory) + + logger.log("1st message", level: .critical) + logger.log("2st message", level: .critical) + + let result = XCTWaiter().wait(for: [expectation], timeout: 1.0) + XCTAssertEqual(result, .completed) + + XCTAssertEqual(sizeLimitedFileFactory.files.count, 1) + + // "2018-08-31 18:29:34.748 DiskLoggerTests:75 testExceedingFileSizeLimit() 2st message\n" + let loggedMessage = String(decoding: sizeLimitedFileFactory.files[0].data, as: UTF8.self) + let expectedOccurence = " WriteFailed()" + + XCTAssertTrue(loggedMessage.contains(expectedOccurence)) + } +} + +private class FileSystemStub: FileSystem { + func itemExists(at URL: URL) -> Bool { + return false + } + + func removeItem(at URL: URL) throws { + + } + + func moveItem(at srcURL: URL, to dstURL: URL) throws { + + } + + func createFile(at URL: URL) -> Bool { + return true + } +} + +private class SizeLimitedFileMockFactory: SizeLimitedFileFactory { + + private(set) var files = [SizeLimitedFileMock]() + private let writeCall: XCTestExpectation + + init(writeCall: XCTestExpectation) { + self.writeCall = writeCall + } + + func makeInstance(fileURL: URL, fileSizeLimit: UInt64) throws -> SizeLimitedFile { + let mock = SizeLimitedFileMock(writeCall: writeCall, fileSizeLimit: fileSizeLimit) + files.append(mock) + return mock + } +} + +private class SizeLimitedFileMock: SizeLimitedFile { + + private(set) var data = Data() + private(set) var synchronizeAndCloseFileCallCount = 0 + private let writeCall: XCTestExpectation + private let fileSizeLimit: UInt64 + + init(writeCall: XCTestExpectation, fileSizeLimit: UInt64) { + self.writeCall = writeCall + self.fileSizeLimit = fileSizeLimit + } + + func write(_ data: Data) throws { + guard data.count + self.data.count <= fileSizeLimit else { + throw SizeLimitedFileQuotaReached() + } + self.data.append(data) + writeCall.fulfill() + } + + func synchronizeAndCloseFile() { + synchronizeAndCloseFileCallCount += 1 + } +} + +private class UnwritableFileStubFactory: SizeLimitedFileFactory { + + private(set) var files = [UnwritableFileStub]() + private let writeCall: XCTestExpectation + + init(writeCall: XCTestExpectation) { + self.writeCall = writeCall + } + + func makeInstance(fileURL: URL, fileSizeLimit: UInt64) throws -> SizeLimitedFile { + let file = UnwritableFileStub(writeCall: writeCall, fileSizeLimit: fileSizeLimit) + files.append(file) + return file + } +} + +private class UnwritableFileStub: SizeLimitedFile { + + struct WriteFailed: Error {} + + private(set) var data = Data() + private let writeCall: XCTestExpectation + private var didThrowError = false + + init(writeCall: XCTestExpectation, fileSizeLimit: UInt64) { + self.writeCall = writeCall + } + + func write(_ data: Data) throws { + if didThrowError { + self.data.append(data) + writeCall.fulfill() + } + else { + didThrowError = true + writeCall.fulfill() + throw WriteFailed() + } + } + + func synchronizeAndCloseFile() { + + } +} + +private class LogrotateMockFactory: LogrotateFactory { + + private(set) var logrotates = [LogrotateMock]() + + func makeInstance(fileURL: URL, rotations: Int) -> Logrotate { + let mock = LogrotateMock() + logrotates.append(mock) + return mock + } +} + +private class LogrotateMock: Logrotate { + + private(set) var rotateCallCount = 0 + + func rotate() throws { + rotateCallCount += 1 + } +} From 677db8a73a8d7266564f74f517fb9b6380a58367 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Sat, 1 Sep 2018 08:59:25 +0200 Subject: [PATCH 32/37] Fixed two bugs caught by unit tests in DiskLogger --- Logger/Loggers/DiskLogger/DiskLogger.swift | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Logger/Loggers/DiskLogger/DiskLogger.swift b/Logger/Loggers/DiskLogger/DiskLogger.swift index 6718d09..c2a44d0 100644 --- a/Logger/Loggers/DiskLogger/DiskLogger.swift +++ b/Logger/Loggers/DiskLogger/DiskLogger.swift @@ -130,10 +130,12 @@ public final class DiskLogger: Logger { catch is SizeLimitedFileQuotaReached { self.closeSizeLimitedFile() try self.rotateLogFiles() + try self.openSizeLimitedFile() + try self.writeBuffer() } } catch { - let message = self.formatter.string(from: Date()) + " <" + LogLevel.warning.logDescription + "> " + String(describing: error) + let message = self.formatter.string(from: Date()) + " <" + LogLevel.warning.logDescription + "> " + String(describing: error) + "\n" let data = Data(message.utf8) self.buffer.append(data) } From c7eae4e3e9e81ace9f006e7f69bddbdc8b6f2744 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Sun, 2 Sep 2018 11:22:20 +0200 Subject: [PATCH 33/37] Updated readme file --- Logger.xcodeproj/project.pbxproj | 2 ++ README.md | 44 ++++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+) diff --git a/Logger.xcodeproj/project.pbxproj b/Logger.xcodeproj/project.pbxproj index 0b36d05..bc89d56 100644 --- a/Logger.xcodeproj/project.pbxproj +++ b/Logger.xcodeproj/project.pbxproj @@ -70,6 +70,7 @@ 2ED103E02135C61100EB3683 /* FileRotateTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileRotateTests.swift; sourceTree = ""; }; 2ED103E22135D3FB00EB3683 /* FileWriterTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = FileWriterTests.swift; sourceTree = ""; }; 2ED103E42138553B00EB3683 /* DiskLoggerTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = DiskLoggerTests.swift; sourceTree = ""; }; + 2EDA8AE8213ACCFF00FE5840 /* README.md */ = {isa = PBXFileReference; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = ""; }; /* End PBXFileReference section */ /* Begin PBXFrameworksBuildPhase section */ @@ -108,6 +109,7 @@ 2EBF4B312122AA34008E4117 = { isa = PBXGroup; children = ( + 2EDA8AE8213ACCFF00FE5840 /* README.md */, 2EBF4B3C2122AA34008E4117 /* Logger */, 2E58D35B21316C3500BEF81A /* UnitTests */, 2EBF4B3B2122AA34008E4117 /* Products */, diff --git a/README.md b/README.md index dfa4ac4..599ffcf 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,46 @@ # SwiftLogger Dependency free Logger API for Swift. + +## Motivation +Beside obvious benefit for unit testing (see `NullLogger`), having loose coupling to a logging framework makes it easy to log messages into multiple logging systems at once (see `AgregateLogger`). + +## Usage +`Logger` protocol provides simple interface utilizing log levels defined by [The Syslog Protocol - RFC5424](https://www.rfc-editor.org/info/rfc5424). + +```swift +logger.log("message", level: .emergency) +logger.log("message", level: .alert) +logger.log("message", level: .critical) +logger.log("message", level: .error) +logger.log("message", level: .warning) +logger.log("message", level: .notice) +logger.log("message", level: .informational) +logger.log("message", level: .debug) +``` + +Log calls capture time, file name, method name and line number automatically. This way it is possible to compose log messages similar to the one presented below. + +``` +2018-08-31 18:29:34.748 SwiftFile:75 method() message +``` + +## Integration with logger frameworks +You need to provide implementation for one method. + +```swift +final class CustomLogger: Logger { + + public func log(time: Date, level: LogLevel, location: String, message: @autoclosure () -> String) { + /// compose message and forward it to a logging framework + } +} +``` + +## Provided loggers +`ConsoleLogger` writes messages into the standard output. + +`NullLogger` ignores all messages with the intention to minimize observer effect. Useful for unit testing. + +`DiskLogger` writes messages into the file at specified URL with log rotation support. + +`AgregateLogger` forwards messages to all the loggers it is initialized with. From 264781a711659cac02ceb5a48238154fce7ebd1b Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Wed, 19 Sep 2018 17:58:23 +0200 Subject: [PATCH 34/37] Added travis-ci configuration file --- .travis.yml | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .travis.yml diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..5a352f2 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,5 @@ +language: swift +osx_image: xcode10 +xcode_project: Logger.xcodeproj +script: xcodebuild test -project Logger.xcodeproj -scheme Logger -destination 'platform=iOS Simulator,name=iPhone XS,OS=12.0' + From 4420b0e7ee2b161fd6ab618bac13a79981a33344 Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Wed, 19 Sep 2018 18:52:58 +0200 Subject: [PATCH 35/37] Added codecov.io integration --- .travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.travis.yml b/.travis.yml index 5a352f2..02fda5c 100644 --- a/.travis.yml +++ b/.travis.yml @@ -2,4 +2,4 @@ language: swift osx_image: xcode10 xcode_project: Logger.xcodeproj script: xcodebuild test -project Logger.xcodeproj -scheme Logger -destination 'platform=iOS Simulator,name=iPhone XS,OS=12.0' - +after_success: bash <(curl -s https://codecov.io/bash) \ No newline at end of file From 3fa5c0b9b22a7d6261979f3faace7ca2d839817f Mon Sep 17 00:00:00 2001 From: Wojciech Nagrodzki <278594+wnagrodzki@users.noreply.github.com> Date: Wed, 19 Sep 2018 19:43:41 +0200 Subject: [PATCH 36/37] Turned code coverage on --- Logger.xcodeproj/xcshareddata/xcschemes/Logger.xcscheme | 1 + 1 file changed, 1 insertion(+) diff --git a/Logger.xcodeproj/xcshareddata/xcschemes/Logger.xcscheme b/Logger.xcodeproj/xcshareddata/xcschemes/Logger.xcscheme index 1b5258f..3fdcd78 100644 --- a/Logger.xcodeproj/xcshareddata/xcschemes/Logger.xcscheme +++ b/Logger.xcodeproj/xcshareddata/xcschemes/Logger.xcscheme @@ -26,6 +26,7 @@ buildConfiguration = "Debug" selectedDebuggerIdentifier = "Xcode.DebuggerFoundation.Debugger.LLDB" selectedLauncherIdentifier = "Xcode.DebuggerFoundation.Launcher.LLDB" + codeCoverageEnabled = "YES" shouldUseLaunchSchemeArgsEnv = "YES"> Date: Wed, 19 Sep 2018 20:50:11 +0200 Subject: [PATCH 37/37] Added build status and code coverage badges --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 599ffcf..a2cffd4 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,8 @@ # SwiftLogger + +[![Build Status](https://travis-ci.org/wnagrodzki/SwiftLogger.svg?branch=master)](https://travis-ci.org/wnagrodzki/SwiftLogger) +[![codecov](https://codecov.io/gh/wnagrodzki/SwiftLogger/branch/master/graph/badge.svg)](https://codecov.io/gh/wnagrodzki/SwiftLogger) + Dependency free Logger API for Swift. ## Motivation