Merge pull request #5 from monstar-lab-oss/feature/utilities

Author: Mohammed Rokon Uddin

{{cookiecutter.app_name}}/NetworkPlatform/Package.swift

@@ -13,6 +13,7 @@ let package = Package(
 
  dependencies: [
  .package(path: "../Domain"),
+ .package(path: "../Utilities"),
  .package(
  url: "https://github.com/Moya/Moya.git",
  from: "15.0.0"
@@ -37,6 +38,7 @@ let package = Package(
  dependencies: [
  "BuildConfiguration",
  .product(name: "Domain", package: "Domain"),
+ .product(name: "Utilities", package: "Utilities"),
  .product(name: "Moya", package: "Moya"),
  .product(name: "CombineMoya", package: "Moya")
  ]

{{cookiecutter.app_name}}/NetworkPlatform/Sources/NetworkPlatform/Network/Networking.swift

@@ -11,6 +11,7 @@ import Combine
 import CombineMoya
 import Foundation
 import Moya
+import Utilities
 
 class OnlineProvider<Target> where Target: Moya.TargetType {
  private let online: AnyPublisher<Bool, Never>
@@ -52,16 +53,14 @@ class OnlineProvider<Target> where Target: Moya.TargetType {
  // TODO: investigate
  .mapError { $0 as! MoyaError }
  .handleEvents(receiveOutput: { response in
- print(response.statusCode)
+ Logger.info("Status Code: \(response.statusCode)")
  }, receiveCompletion: { completion in
- print(completion)
  switch completion {
  case .finished:
- break
+ Logger.success("Request Finished")
  case let .failure(error):
- print(error.localizedDescription)
  // TODO: handle network error
- // self.networkPopup(error.localizedDescription)
+ Logger.error(error.localizedDescription)
  }
  })
  .receive(on: DispatchQueue.main)
@@ -79,7 +78,7 @@ class OnlineProvider<Target> where Target: Moya.TargetType {
  // TODO: Update new tokens
  break
  case let .failure(error):
- print("error: \(error)")
+ Logger.error(error.localizedDescription)
  // TODO: delete existing token and logout from app
  }
 

{{cookiecutter.app_name}}/NetworkPlatform/Sources/NetworkPlatform/Network/NetworkingType.swift

@@ -10,6 +10,7 @@ import Alamofire
 import Combine
 import Foundation
 import Moya
+import Utilities
 
 protocol ProductAPIType {
  var addXAuth: Bool { get }
@@ -24,11 +25,10 @@ protocol NetworkingType {
 }
 
 extension NetworkingType {
- static func endpointsClosure<T>(_: String? = nil) -> (T) -> Endpoint where T: TargetType, T: ProductAPIType
- {
+ static func endpointsClosure<T>(_: String? = nil) -> (T) -> Endpoint where T: TargetType, T: ProductAPIType {
  return { target in
  let endpoint = MoyaProvider.defaultEndpointMapping(for: target)
- print(endpoint.url)
+ Logger.info("Endpoint URL: \(endpoint.url)")
  // Sign all non-XApp, non-XAuth token requests
  return endpoint
  }
@@ -52,8 +52,7 @@ extension NetworkingType {
  request.httpShouldHandleCookies = false
  closure(.success(request))
  } catch {
- // TODO: print error
-// logError(error.localizedDescription)
+ Logger.error(error.localizedDescription)
  }
  }
  }

{{cookiecutter.app_name}}/NetworkPlatform/Sources/NetworkPlatform/Utility/VerbosePlugin.swift

@@ -6,43 +6,41 @@
 // Copyright © {% now 'utc', '%Y' %} {{cookiecutter.company_name}}. All rights reserved.
 //
 
-import Combine
 import Foundation
+import Combine
 import Moya
+import Utilities
 
 struct VerbosePlugin: PluginType {
  let verbose: Bool
-
+ 
  func prepare(_ request: URLRequest, target _: TargetType) -> URLRequest {
- #if DEBUG
- if let body = request.httpBody,
- let str = String(data: body, encoding: .utf8)
- {
- if verbose {
- print("request to send: \(str))")
- }
+#if DEBUG
+ if let body = request.httpBody,
+ let string = String(data: body, encoding: .utf8) {
+ if verbose {
+ Logger.info("Request Body: \(string))")
  }
- #endif
+ }
+#endif
  return request
  }
-
+ 
  func didReceive(_ result: Result<Response, MoyaError>, target _: TargetType) {
- #if DEBUG
- switch result {
- case let .success(body):
- if verbose {
- print("Response:")
- if let json = try? JSONSerialization.jsonObject(with: body.data, options: .mutableContainers)
- {
- print(json)
- } else {
- let response = String(data: body.data, encoding: .utf8)!
- print(response)
- }
+#if DEBUG
+ switch result {
+ case let .success(body):
+ if verbose {
+ if let json = try? JSONSerialization.jsonObject(with: body.data, options: .mutableContainers) {
+ Logger.info("Response: \(json))")
+ } else {
+ let response = String(data: body.data, encoding: .utf8)!
+ Logger.info("Response: \(response))")
  }
- case .failure:
- break
  }
- #endif
+ case .failure:
+ break
+ }
+#endif
  }
 }

{{cookiecutter.app_name}}/Utilities/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+/.build
+/Packages
+/*.xcodeproj
+xcuserdata/
+DerivedData/
+.swiftpm/config/registries.json
+.swiftpm/xcode/package.xcworkspace/contents.xcworkspacedata
+.netrc

{{cookiecutter.app_name}}/Utilities/Package.swift

@@ -0,0 +1,21 @@
+// swift-tools-version: 5.7
+// The swift-tools-version declares the minimum version of Swift required to build this package.
+
+import PackageDescription
+
+let package = Package(
+ name: "Utilities",
+ products: [
+ .library(
+ name: "Utilities",
+ targets: ["Utilities"]),
+ ],
+ dependencies: [
+ 
+ ],
+ targets: [
+ .target(
+ name: "Utilities",
+ dependencies: [])
+ ]
+)

{{cookiecutter.app_name}}/Utilities/README.md

@@ -0,0 +1,3 @@
+# Utilities
+
+A description of this package.

{{cookiecutter.app_name}}/Utilities/Sources/Utilities/Logger.swift

@@ -0,0 +1,49 @@
+//
+// VerbosePlugin.swift
+// NetworkPlatform
+//
+// Created by {{ cookiecutter.creator }} on {% now 'utc', '%d/%m/%Y' %}.
+// Copyright © {% now 'utc', '%Y' %} {{cookiecutter.company_name}}. All rights reserved.
+//
+
+import Foundation
+
+public enum Logger {
+ 
+ private static let dateFormatter: DateFormatter = {
+ let formatter = DateFormatter()
+ formatter.dateFormat = "yyyy-MM-dd HH:mm:ss"
+ return formatter
+ }()
+ 
+ public static func info(_ messages: Any?..., file: String = #file, function: String = #function, line: Int = #line) {
+ printMessage(messages, state: "ℹ️ INFO", file: file, function: function, line: line)
+ }
+ 
+ public static func error(_ messages: Any?..., file: String = #file, function: String = #function, line: Int = #line) {
+ printMessage(messages, state: "💥 ERROR", file: file, function: function, line: line)
+ }
+ 
+ public static func warning(_ messages: Any?..., file: String = #file, function: String = #function, line: Int = #line) {
+ printMessage(messages, state: "⚠️ WARNING", file: file, function: function, line: line)
+ }
+ 
+ public static func success(_ messages: Any?..., file: String = #file, function: String = #function, line: Int = #line) {
+ printMessage(messages, state: "✅ SUCCESS", file: file, function: function, line: line)
+ }
+ 
+ private static func printMessage(_ messages: Any?..., state: String, file: String, function: String, line: Int) {
+#if RELEASE
+ return
+#endif
+ 
+ let dateString = dateFormatter.string(from: Date())
+ print("\(dateString) - \(state) \(sourceFileName(file)).\(function):\(line)", messages)
+ 
+ }
+ 
+ private static func sourceFileName(_ filePath: String) -> String {
+ let components = filePath.components(separatedBy: "/")
+ return components.isEmpty ? "" : (components.last ?? "")
+ }
+}

{{cookiecutter.app_name}}/{{cookiecutter.app_name}}.xcodeproj/project.pbxproj

@@ -62,6 +62,7 @@
 2F7B0E70273AD7AD00C68B1F /* {{cookiecutter.app_name}}UITests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = "{{cookiecutter.app_name}}UITests.xctest"; sourceTree = BUILT_PRODUCTS_DIR; };
 2F7B0E74273AD7AD00C68B1F /* __cookiecutter_app_name__UITests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = __cookiecutter_app_name__UITests.swift; sourceTree = "<group>"; };
 2F7B0E76273AD7AD00C68B1F /* __cookiecutter_app_name__UITestsLaunchTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = __cookiecutter_app_name__UITestsLaunchTests.swift; sourceTree = "<group>"; };
+2F9DFD462990EA1800611A47 /* Utilities */ = {isa = PBXFileReference; lastKnownFileType = wrapper; path = Utilities; sourceTree = "<group>"; };
 6782D5572912526F0015FCBB /* Preview Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = "Preview Assets.xcassets"; sourceTree = "<group>"; };
 6782D558291252700015FCBB /* Assets.xcassets */ = {isa = PBXFileReference; lastKnownFileType = folder.assetcatalog; path = Assets.xcassets; sourceTree = "<group>"; };
 67B2B5BD29127D3A00B2E0AC /* Staging.xcconfig */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.xcconfig; path = Staging.xcconfig; sourceTree = "<group>"; };
@@ -115,6 +116,7 @@
 2F7B0E4D273AD7AC00C68B1F = {
 isa = PBXGroup;
 children = (
+2F9DFD462990EA1800611A47 /* Utilities */,
 2F28C5F82942162600B7E601 /* NetworkPlatform */,
 2F4989C3298E8F470007A245 /* Domain */,
 2F4989C4298E8F6F0007A245 /* Commons */,