[CM-997] Add linter rules, fix violations

Author: Mark Pospesel

.swiftlint.yml

@@ -9,6 +9,8 @@ opt_in_rules: # some rules are turned off by default, so you need to opt-in
   - empty_count
   - first_where
   - force_unwrapping
+  - implicit_return
+  - missing_docs
   - multiline_arguments
   - multiline_arguments_brackets
   - multiline_function_chains
@@ -24,6 +26,8 @@ opt_in_rules: # some rules are turned off by default, so you need to opt-in
 
 excluded: # paths to ignore during linting. Takes precedence over `included`.
   - Pods
+  - docs
+  - .build
 
 # configurable rules can be customized from this configuration file
 # binary rules can set their severity level

Sources/YNetwork/Core/Extensions/String+regex.swift

@@ -14,7 +14,7 @@ extension String {
     /// - Parameter pattern: the regular expression pattern to evaluate
     /// - Returns: `true` if the string matches the pattern, otherwise `false`.
     public func matches(regex pattern: String) -> Bool {
-        return self.range(
+        range(
             of: pattern,
             options: .regularExpression,
             range: nil,

Sources/YNetwork/Extensions/String+isAbsoluteURLPath.swift

@@ -15,6 +15,6 @@ let kUrlSchemaRegex = "^(ht|f)tp(s?)\\:\\/\\/"
 extension String {
     /// Determines whether the string begins with `http://`, `https://`, `ftp://`, or `ftps://`
     public var isAbsoluteURLPath: Bool {
-        return self.matches(regex: kUrlSchemaRegex)
+        matches(regex: kUrlSchemaRegex)
     }
 }

Sources/YNetwork/Models/JWT/JWTToken.swift

@@ -10,9 +10,13 @@ import Foundation
 
 /// JWT token.
 public struct JWTToken {
+    /// JWT token header
     public let header: [String: Any]
+    /// JWT token body
     public let body: [String: Any]
+    /// JWT token signature
     public let signature: String?
+    /// Original JWT token string
     public let string: String
 
     /// public init method

Sources/YNetwork/NetworkManager/NetworkManager.swift

@@ -30,7 +30,7 @@ open class NetworkManager: NSObject {
     @available(iOS 14.0, tvOS 14.0, *)
     open var logger: Logger? {
         get {
-            return _logger as? Logger
+            _logger as? Logger
         } set {
             _logger = newValue
         }

Sources/YNetwork/Protocols/MultipartRequest.swift

@@ -18,9 +18,14 @@ public protocol MultipartRequest: NetworkRequest {
 
 /// Default implementation for Multipart Request properties.
 public extension MultipartRequest {
+    /// Uses `.POST` HTTP method
     var method: HttpMethod { .POST }
+
+    /// Sets `.multipart` as request content type
     var requestType: RequestContentType {
         .multipart(boundary: multipart.boundary)
     }
+
+    /// Sets the `multipart` builder as the body
     var body: BodyBuilder? { multipart }
 }

Sources/YNetwork/Protocols/NetworkRequest.swift

@@ -79,25 +79,36 @@ public protocol NetworkRequest {
 /// Default implementation for Network Request properties.
 /// The only required property to implement is `path`. Everything else has default values.
 public extension NetworkRequest {
+    /// Uses no base path
     var basePath: PathRepresentable? { nil }
 
+    /// Uses `.GET` HTTP method
     var method: HttpMethod { .GET }
 
+    /// Includes no additional headers
     var headers: HttpHeaders? { nil }
 
+    /// Sets `.JSON` as request content type
     var requestType: RequestContentType { .JSON }
 
+    /// Sets `.JSON` as response content type
     var responseType: ResponseContentType { .JSON }
 
+    /// No query parameters
     var queryParameters: ParametersBuilder? { nil }
 
+    /// No body
     var body: BodyBuilder? { nil }
 
+    /// Uses the default timeout interval
     var timeoutInterval: TimeInterval { 0 }
 
+    /// Uses the default cache policy
     var cachePolicy: URLRequest.CachePolicy? { nil }
-    
+
+    /// Uses the default parser factory
     var parserFactory: DataParserFactory? { nil }
 
+    /// Uses session tokens (if `NetworkManager.sessionManager` is specified)
     var usesSession: Bool { true }
 }

Tests/YNetworkTests/NetworkManager/Helpers/MockURLNetworkEngine.swift

@@ -37,11 +37,11 @@ final class MockURLNetworkEngine: URLNetworkEngine {
     }
 
     override func submitBackgroundDownload(_ request: URLRequest) throws -> Cancelable {
-        return MockURLSessionTask()
+        MockURLSessionTask()
     }
 
     override func submitBackgroundUpload(_ request: URLRequest, fileUrl: URL) throws -> Cancelable {
-        return MockURLSessionTask()
+        MockURLSessionTask()
     }
 }
 

Tests/YNetworkTests/NetworkManager/URLBuilderTests.swift

@@ -9,6 +9,9 @@
 import XCTest
 @testable import YNetwork
 
+// Large tuples help us build unit test expectations concisely
+// swiftlint:disable large_tuple
+
 typealias PathTestCase = (basePath: PathTestUrl?, path: String, output: String)
 typealias FormUrlTestCase = (key: String, value: Any, output: String?)
 typealias QueryTestCase = (params: Parameters, output: String)