Setup linting (#16)

gwhelanLD · web-flow · commit 9c2a1c40434f · 2021-02-09T14:44:31.000-08:00
diff --git a/.swiftlint.yml b/.swiftlint.yml
@@ -1,70 +1,92 @@
-disabled_rules: # rule identifiers to exclude from running
-  - line_length
-  - trailing_whitespace
-  - todo # temporarily disabled. In general they should be treated as warnings
-#   - type_body_length # temporarily disabled.
-#   - file_length # temporarily disabled
-  - statement_position # wish we could support both uncuddled_else and default (but not others)
-  - trailing_comma
-  - syntactic_sugar
-  - redundant_optional_initialization
-  - redundant_void_return
-  - large_tuple # this is flagging closure argument declarations, seems like a mistake
-opt_in_rules: # some rules are only opt-in
-  - empty_count
-  # - missing_docs
-  # - force_unwrapping
-  # Find all the available rules by running:
-  # swiftlint rules
-# included: # paths to include during linting. `--path` is ignored if present.
-# #   - Source
-excluded: # paths to ignore during linting. Takes precedence over `included`.
-#   - Carthage
-  - LaunchDarkly/GeneratedCode
-  - Pods
-  - _iOS/Pods
-#   - Source/ExcludedFolder
-#   - Source/ExcludedFile.swift
+# See sub-configurations at `Source/.swiftlint.yml` and `Tests/.swiftlint.yml`.
 
-# configurable rules can be customized from this configuration file
-# binary rules can set their severity level
+disabled_rules:
+  - identifier_name
+  - weak_delegate
 
-# force_cast: warning # implicitly
-# force_try:
-#   severity: warning # explicitly
-# # rules that have both warning and error levels, can set just the warning level
-# # implicitly
-# # line_length: 110
-# # they can set both implicitly with an array
-#
+opt_in_rules:
+  - anyobject_protocol
+  - array_init
+  - attributes
+  - closure_body_length
+  - closure_end_indentation
+  - closure_spacing
+  - collection_alignment
+  - conditional_returns_on_newline
+  - contains_over_filter_count
+  - contains_over_filter_is_empty
+  - contains_over_first_not_nil
+  - contains_over_range_nil_comparison
+  - discouraged_object_literal
+  - discouraged_optional_boolean
+  - discouraged_optional_collection
+  - empty_collection_literal
+  - empty_count
+  - empty_string
+  - empty_xctest_method
+  - enum_case_associated_values_count
+  - expiring_todo
+  - explicit_init
+  - explicit_self
+  - extension_access_modifier
+  - fallthrough
+  - fatal_error_message
+  - file_header
+  - file_name_no_space
+  - first_where
+  - flatmap_over_map_reduce
+  - function_default_parameter_at_end
+  - identical_operands
+  - implicit_return
+  - joined_default_parameter
+  - last_where
+  - legacy_multiple
+  - legacy_random
+  - let_var_whitespace
+  - literal_expression_end_indentation
+  - missing_docs
+  - modifier_order
+  - no_grouping_extension
+  - nslocalizedstring_key
+  - nslocalizedstring_require_bundle
+  - number_separator
+  - object_literal
+  - operator_usage_whitespace
+  - optional_enum_case_matching
+  - overridden_super_call
+  - override_in_extension
+  - pattern_matching_keywords
+  - prefer_self_type_over_type_of_self
+  - prefixed_toplevel_constant
+  - private_action
+  - private_outlet
+  - prohibited_interface_builder
+  - prohibited_super_call
+  - raw_value_for_camel_cased_codable_enum
+  - reduce_into
+  - redundant_nil_coalescing
+  - required_enum_case
+  - single_test_class
+  - sorted_first_last
+  - static_operator
+  - strict_fileprivate
+  - strong_iboutlet
+  - switch_case_on_newline
+  - toggle_bool
+  - trailing_closure
+  - unavailable_function
+  - unneeded_parentheses_in_closure_argument
+  - unowned_variable_capture
+  - untyped_error_in_catch
+  - unused_declaration
+  - unused_import
+  - vertical_parameter_alignment_on_call
+  - vertical_whitespace_closing_braces
+  - vertical_whitespace_opening_braces
+  - yoda_condition
 
-# Set doesn't have isEmpty so using count seems to be our ownly option
-empty_count: warning
+included:
+  - Source
+  - Tests
 
-function_body_length:
-  warning: 50
-  error: 70
-type_body_length:
-  - 300 # warning
-  - 500 # error
-# or they can set both explicitly
-file_length:
-  warning: 1000
-  error: 1500
-identifier_name:
-  min_length: # only min_length
-    error: 3 # only error
-  max_length: # warning and error
-    warning: 50
-    error: 60
-  excluded: # excluded via string array
-    - id
-    - URL
-    - url
-    - obj
-    - key
-    - all
-    - tag
-    - lhs
-    - rhs
-reporter: "xcode" # reporter type (xcode, json, csv, checkstyle)
+reporter: "xcode"
diff --git a/LDSwiftEventSource.xcodeproj/project.pbxproj b/LDSwiftEventSource.xcodeproj/project.pbxproj
@@ -143,6 +143,7 @@
 			isa = PBXNativeTarget;
 			buildConfigurationList = B49B5E0D24667D42008BF867 /* Build configuration list for PBXNativeTarget "LDSwiftEventSource" */;
 			buildPhases = (
+				B46C1C6B24CF348B00283630 /* Linter Script */,
 				B49B5DF724667D41008BF867 /* Headers */,
 				B49B5DF824667D41008BF867 /* Sources */,
 				B49B5DF924667D41008BF867 /* Frameworks */,
@@ -229,6 +230,28 @@
 		};
 /* End PBXResourcesBuildPhase section */
 
+/* Begin PBXShellScriptBuildPhase section */
+		B46C1C6B24CF348B00283630 /* Linter Script */ = {
+			isa = PBXShellScriptBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+			);
+			inputFileListPaths = (
+			);
+			inputPaths = (
+			);
+			name = "Linter Script";
+			outputFileListPaths = (
+			);
+			outputPaths = (
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+			shellPath = /bin/sh;
+			shellScript = "echo `pwd`\nif which mint >/dev/null; then\n  /usr/bin/xcrun --sdk macosx mint run realm/SwiftLint\nelse\n  echo \"warning: mint not installed, available from https://github.com/yonaskolb/Mint\"\nfi\n";
+			showEnvVarsInLog = 0;
+		};
+/* End PBXShellScriptBuildPhase section */
+
 /* Begin PBXSourcesBuildPhase section */
 		B49B5DF824667D41008BF867 /* Sources */ = {
 			isa = PBXSourcesBuildPhase;
diff --git a/Mintfile b/Mintfile
@@ -0,0 +1 @@
+realm/SwiftLint@0.39.2
diff --git a/Package.swift b/Package.swift
@@ -11,7 +11,6 @@ let package = Package(
         .tvOS(.v10)
     ],
     products: [
-        // Products define the executables and libraries produced by a package, and make them visible to other packages.
         .library(
             name: "LDSwiftEventSource",
             type: .dynamic,
@@ -23,8 +22,6 @@ let package = Package(
     ],
     dependencies: [],
     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 which this package depends on.
         .target(
             name: "LDSwiftEventSource",
             path: "Source"),
diff --git a/Source/.swiftlint.yml b/Source/.swiftlint.yml
@@ -0,0 +1,5 @@
+disabled_rules:
+
+opt_in_rules:
+  - force_unwrapping
+  - implicitly_unwrapped_optional
diff --git a/Source/EventParser.swift b/Source/EventParser.swift
@@ -1,6 +1,6 @@
 import Foundation
 
-typealias ConnectionHandler = (setReconnectionTime: (TimeInterval) -> (), setLastEventId: (String) -> ())
+typealias ConnectionHandler = (setReconnectionTime: (TimeInterval) -> Void, setLastEventId: (String) -> Void)
 
 class EventParser {
     private struct Constants {
@@ -58,7 +58,8 @@ class EventParser {
             if value.allSatisfy(("0"..."9").contains), let reconnectionTime = Int64(value) {
                 connectionHandler.setReconnectionTime(Double(reconnectionTime) * 0.001)
             }
-        default: break
+        default:
+            break
         }
     }
 
@@ -78,6 +79,6 @@ class EventParser {
 private extension Array {
     /// Returns the element at the specified index if it is within bounds, otherwise nil.
     subscript (safe index: Index) -> Element? {
-        return index >= startIndex && index < endIndex ? self[index] : nil
+        index >= startIndex && index < endIndex ? self[index] : nil
     }
 }
diff --git a/Source/LDSwiftEventSource.swift b/Source/LDSwiftEventSource.swift
@@ -8,6 +8,11 @@ import FoundationNetworking
 import os.log
 #endif
 
+/**
+ Provides an EventSource client for consuming Server-Sent Events.
+
+ See the [Server-Sent Events spec](https://html.spec.whatwg.org/multipage/server-sent-events.html) for more details.
+ */
 public class EventSource {
     private let esDelegate: EventSourceDelegate
 
@@ -42,17 +47,19 @@ public class EventSource {
 
     /// Struct describing the configuration of the EventSource
     public struct Config {
+        /// The EventHandler called in response to activity on the stream.
         public let handler: EventHandler
+        /// The URL of the request used when connecting to the EventSource API.
         public let url: URL
 
         /// The method to use for the EventSource connection
         public var method: String = "GET"
         /// Optional body to be sent with the initial request
-        public var body: Data? = nil
+        public var body: Data?
         /// Error handler that can determine whether to proceed or shutdown.
         public var connectionErrorHandler: ConnectionErrorHandler = { _ in .proceed }
         /// An initial value for the last-event-id to be set on the initial request
-        public var lastEventId: String? = nil
+        public var lastEventId: String?
         /// Additional headers to be set on the request
         public var headers: [String: String] = [:]
         /// Provides the ability to add conditional headers
@@ -77,7 +84,6 @@ public class EventSource {
 }
 
 class EventSourceDelegate: NSObject, URLSessionDataDelegate {
-
     #if !os(Linux)
     private let logger: OSLog = OSLog(subsystem: "com.launchdarkly.swift-eventsource", category: "LDEventSource")
     #endif
@@ -93,8 +99,9 @@ class EventSourceDelegate: NSObject, URLSessionDataDelegate {
     private var connectedTime: Date?
 
     private var reconnectionAttempts: Int = 0
-    private var errorHandlerAction: ConnectionErrorAction? = nil
+    private var errorHandlerAction: ConnectionErrorAction?
     private let utf8LineParser: UTF8LineParser = UTF8LineParser()
+    // swiftlint:disable:next implicitly_unwrapped_optional
     private var eventParser: EventParser!
     private var sessionTask: URLSessionDataTask?
 
@@ -109,7 +116,7 @@ class EventSourceDelegate: NSObject, URLSessionDataDelegate {
             guard self.readyState == .raw
             else {
                 #if !os(Linux)
-                os_log("Start method called on this already-started EventSource object. Doing nothing", log: self.logger, type: .info)
+                os_log("start() called on already-started EventSource object. Returning", log: self.logger, type: .info)
                 #endif
                 return
             }
@@ -139,7 +146,7 @@ class EventSourceDelegate: NSObject, URLSessionDataDelegate {
         let sessionConfig = URLSessionConfiguration.default
         sessionConfig.httpAdditionalHeaders = ["Accept": "text/event-stream", "Cache-Control": "no-cache"]
         sessionConfig.timeoutIntervalForRequest = self.config.idleTimeout
-        let session = URLSession.init(configuration: sessionConfig, delegate: self, delegateQueue: nil)
+        let session = URLSession(configuration: sessionConfig, delegate: self, delegateQueue: nil)
         var urlRequest = URLRequest(url: self.config.url,
                                     cachePolicy: URLRequest.CachePolicy.reloadIgnoringLocalAndRemoteCacheData,
                                     timeoutInterval: self.config.idleTimeout)
@@ -194,7 +201,7 @@ class EventSourceDelegate: NSObject, URLSessionDataDelegate {
         self.connectedTime = nil
 
         let maxSleep = min(config.maxReconnectTime, reconnectTime * pow(2.0, Double(reconnectionAttempts)))
-        let sleep = maxSleep / 2 + Double.random(in: 0...(maxSleep/2))
+        let sleep = maxSleep / 2 + Double.random(in: 0...(maxSleep / 2))
 
         #if !os(Linux)
         os_log("Waiting %.3f seconds before reconnecting...", log: logger, type: .info, sleep)
@@ -239,6 +246,7 @@ class EventSourceDelegate: NSObject, URLSessionDataDelegate {
         os_log("initial reply received", log: logger, type: .debug)
         #endif
 
+        // swiftlint:disable:next force_cast
         let httpResponse = response as! HTTPURLResponse
         if (200..<300).contains(httpResponse.statusCode) {
             connectedTime = Date()
diff --git a/Source/UTF8LineParser.swift b/Source/UTF8LineParser.swift
@@ -37,8 +37,8 @@ class UTF8LineParser {
 
         Decode: while true {
             switch utf8Parser.parseScalar(from: &dataIter) {
-            case .valid(let v):
-                let scalar = Unicode.UTF8.decode(v)
+            case .valid(let scalarResult):
+                let scalar = Unicode.UTF8.decode(scalarResult)
                 if seenCr {
                     lines.append(currentString)
                     currentString = ""
diff --git a/Tests/.swiftlint.yml b/Tests/.swiftlint.yml
@@ -0,0 +1,13 @@
+disabled_rules:
+
+opt_in_rules:
+  # Must specify even though enabled by default to update configuration of rule below.
+  - line_length
+
+# Provide a little extra lenience for test code line length.
+line_length:
+  warning: 140
+
+excluded:
+  # Autogenerated manifest of tests
+  - XCTestManifests.swift
diff --git a/Tests/EventParserTests.swift b/Tests/EventParserTests.swift
@@ -28,14 +28,15 @@ class MockEventHandler: EventHandler {
 }
 
 final class EventParserTests: XCTestCase {
-    var receivedReconnectionTime: TimeInterval? = nil
-    var receivedLastEventId: String? = nil
+    var receivedReconnectionTime: TimeInterval?
+    var receivedLastEventId: String?
     lazy var connectionHandler: ConnectionHandler = { (setReconnectionTime: { self.receivedReconnectionTime = $0 },
                                                        setLastEventId: { self.receivedLastEventId = $0 }) }()
     let eventHandler = MockEventHandler()
     var parser: EventParser!
 
     override func setUp() {
+        super.setUp()
         receivedReconnectionTime = nil
         receivedLastEventId = nil
         eventHandler.reset()
diff --git a/Tests/LDSwiftEventSourceTests.swift b/Tests/LDSwiftEventSourceTests.swift
diff --git a/Tests/UTF8LineParserTests.swift b/Tests/UTF8LineParserTests.swift

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`import Foundation`
`2`	`2`
`3`		`-typealias ConnectionHandler = (setReconnectionTime: (TimeInterval) -> (), setLastEventId: (String) -> ())`
	`3`	`+typealias ConnectionHandler = (setReconnectionTime: (TimeInterval) -> Void, setLastEventId: (String) -> Void)`
`4`	`4`
`5`	`5`	`class EventParser {`
`6`	`6`	`private struct Constants {`
`@@ -58,7 +58,8 @@ class EventParser {`
`58`	`58`	`if value.allSatisfy(("0"..."9").contains), let reconnectionTime = Int64(value) {`
`59`	`59`	`connectionHandler.setReconnectionTime(Double(reconnectionTime) * 0.001)`
`60`	`60`	`}`
`61`		`- default: break`
	`61`	`+ default:`
	`62`	`+ break`
`62`	`63`	`}`
`63`	`64`	`}`
`64`	`65`
`@@ -78,6 +79,6 @@ class EventParser {`
`78`	`79`	`private extension Array {`
`79`	`80`	`/// Returns the element at the specified index if it is within bounds, otherwise nil.`
`80`	`81`	`subscript (safe index: Index) -> Element? {`
`81`		`- return index >= startIndex && index < endIndex ? self[index] : nil`
	`82`	`+ index >= startIndex && index < endIndex ? self[index] : nil`
`82`	`83`	`}`
`83`	`84`	`}`