Merge pull request #1 from maksimn/release-1.0.0

Release 1.0.0.

Author: maksimn

Package.swift

@@ -1,28 +1,22 @@
-// swift-tools-version: 5.7
-// The swift-tools-version declares the minimum version of Swift required to build this package.
+// swift-tools-version:5.7
 
 import PackageDescription
 
 let package = Package(
     name: "CoreModule",
+    platforms: [
+        .iOS(.v14)
+    ],
     products: [
-        // Products define the executables and libraries a package produces, and make them visible to other packages.
         .library(
             name: "CoreModule",
-            targets: ["CoreModule"]),
-    ],
-    dependencies: [
-        // Dependencies declare other packages that this package depends on.
-        // .package(url: /* package url */, from: "1.0.0"),
+            targets: ["CoreModule"]
+        )
     ],
     targets: [
-        // Targets are the basic building blocks of a package. A target can define a module or a test suite.
-        // Targets can depend on other targets in this package, and on products in packages this package depends on.
         .target(
             name: "CoreModule",
-            dependencies: []),
-        .testTarget(
-            name: "CoreModuleTests",
-            dependencies: ["CoreModule"]),
+            path: "Source"
+        )
     ]
 )

README.md

@@ -1,3 +1,11 @@
 # CoreModule
 
-A description of this package.
+Core module for iOS projects.
+
+Contents
+
+* Core protocols
+* Logging framework
+* Some extensions for basic Swift types
+* Some UIKit extensions
+* HTTP client

Source/Array+Core.swift

@@ -0,0 +1,17 @@
+//
+//  Array+Core.swift
+//  ReTodoList
+//
+//  Created by Maksim Ivanov on 21.02.2023.
+//
+
+extension Array {
+
+    public subscript(safeIndex index: Int) -> Element? {
+        guard index >= 0, index < endIndex else {
+            return nil
+        }
+
+        return self[index]
+    }
+}

Source/Builder.swift

@@ -0,0 +1,23 @@
+//
+//  Builder.swift
+//  PersonalDictionary
+//
+//  Created by Maxim Ivanov on 27.10.2022.
+//
+
+import UIKit
+
+public protocol ViewBuilder {
+
+    func build() -> UIView
+}
+
+public protocol ViewControllerBuilder {
+
+    func build() -> UIViewController
+}
+
+public protocol SearchControllerBuilder {
+
+    func build() -> UISearchController
+}

Source/CoreRouter.swift

@@ -0,0 +1,11 @@
+//
+//  CoreRouter.swift
+//  CoreModule
+//
+//  Created by Maxim Ivanov on 16.12.2021.
+//
+
+public protocol CoreRouter {
+
+    func navigate()
+}

Source/Date+Core.swift

@@ -0,0 +1,22 @@
+//
+//  Date+Core.swift
+//  ReTodoList
+//
+//  Created by Maksim Ivanov on 12.08.2022.
+//
+
+import Foundation
+
+extension Date {
+
+    public var dMMMMyyyy: String {
+        let dateFormatter = DateFormatter()
+        dateFormatter.dateFormat = "d MMMM yyyy"
+
+        return dateFormatter.string(from: self)
+    }
+
+    public var integer: Int {
+        Int(timeIntervalSince1970)
+    }
+}

Source/Logger/LogLevel.swift

@@ -0,0 +1,13 @@
+//
+//  CoreRouter.swift
+//  CoreModule
+//
+//  Created by Maxim Ivanov on 16.12.2021.
+//
+
+public enum LogLevel: String {
+    case debug = "DEBUG"
+    case info = "INFO"
+    case warn =  "WARN ⚠️"
+    case error = "ALERT ❌"
+}

Source/Logger/Logger+Extension.swift

@@ -0,0 +1,81 @@
+//
+//  CoreRouter.swift
+//  CoreModule
+//
+//  Created by Maxim Ivanov on 16.12.2021.
+//
+
+import Foundation
+
+extension Logger {
+
+    public func debug(_ message: String) {
+        log(message, level: .debug)
+    }
+
+    public func logWithContext(_ message: String,
+                               level: LogLevel = .info,
+                               file: String = #file,
+                               function: String = #function,
+                               line: Int = #line) {
+        guard isDevelopment() else { return }
+
+        log(message, level: level, file: file, function: function, line: line)
+    }
+
+    public func errorWithContext(_ error: Error,
+                                 file: String = #file,
+                                 function: String = #function,
+                                 line: Int = #line) {
+        guard isDevelopment() else { return }
+
+        log("\(error)", level: .error, file: file, function: function, line: line)
+    }
+
+    public func logState<State>(actionName: String,
+                                _ state: State,
+                                file: String = #file,
+                                function: String = #function,
+                                line: Int = #line) {
+        guard isDevelopment() else { return }
+        let text = "\(actionName) result:\n\(state)"
+
+        log(text, level: .info, file: file, function: function, line: line)
+    }
+
+    public func logSending<T>(_ object: T,
+                              toModelStream modelStreamName: String,
+                              file: String = #file,
+                              function: String = #function,
+                              line: Int = #line) {
+        guard isDevelopment() else { return }
+        let text = "Sending \(type(of: object)) = \(object) to the \(modelStreamName) model stream."
+
+        log(text, level: .info, file: file, function: function, line: line)
+    }
+
+    public func logReceiving<T>(_ object: T,
+                                fromModelStream modelStreamName: String,
+                                file: String = #file,
+                                function: String = #function,
+                                line: Int = #line) {
+        guard isDevelopment() else { return }
+        let text = "Received \(type(of: object)) = \(object) from the \(modelStreamName) model stream."
+
+        log(text, level: .info, file: file, function: function, line: line)
+    }
+
+    public func log(installedFeatureName: String) {
+        debug("The \(installedFeatureName) feature has been installed.")
+    }
+
+    public func log(dismissedFeatureName: String) {
+        debug("The \(dismissedFeatureName) feature has been dismissed.")
+    }
+
+    private func log(_ text: String, level: LogLevel, file: String, function: String, line: Int) {
+        let description = "\((file as NSString).lastPathComponent) line:\(line) \(function)"
+
+        log("\(text) -> \(description)", level: level)
+    }
+}

Source/Logger/Logger.swift

@@ -0,0 +1,11 @@
+//
+//  Logger.swift
+//  CoreModule
+//
+//  Created by Maxim Ivanov on 24.03.2023.
+//
+
+public protocol Logger {
+
+    func log(_ message: String, level: LogLevel)
+}

Source/Logger/LoggerImpl.swift

@@ -0,0 +1,42 @@
+//
+//  LoggerImpl.swift
+//  CoreModule
+//
+//  Created by Maxim Ivanov on 24.03.2023.
+//
+
+import os
+
+public final class LoggerImpl: CoreModule.Logger {
+
+    private let logger: os.Logger
+
+    public init(category: String) {
+        logger = os.Logger(subsystem: "General", category: category)
+    }
+
+    public func log(_ message: String, level: LogLevel) {
+        guard isDevelopment() else { return }
+
+        logger.log(level: level.getOsLogLevel(), "[\(level.rawValue)] \(message)")
+    }
+}
+
+extension LogLevel {
+
+    func getOsLogLevel() -> OSLogType {
+        switch self {
+        case .debug:
+            return .debug
+            
+        case .info:
+            return .default
+            
+        case .warn:
+            return .error
+            
+        case .error:
+            return .fault
+        }
+    }
+}