-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
10 changed files
with
241 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
89 changes: 89 additions & 0 deletions
89
Source/SwiftLintFramework/Rules/RuleConfigurations/ExplicitTypeInterfaceConfiguration.swift
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| // | ||
| // ExplicitTypeInterfaceConfiguration.swift | ||
| // SwiftLint | ||
| // | ||
| // Created by Rounak Jain on 2/18/18. | ||
| // Copyright © 2018 Realm. All rights reserved. | ||
| // | ||
|
|
||
| import Foundation | ||
| import SourceKittenFramework | ||
|
|
||
| private enum VariableKind: String { | ||
| case instance | ||
| case local | ||
| case `static` | ||
| case `class` | ||
| } | ||
|
|
||
| private extension SwiftDeclarationKind { | ||
| init(variableKind: VariableKind) { | ||
| switch variableKind { | ||
| case .instance: | ||
| self = .varInstance | ||
| case .local: | ||
| self = .varLocal | ||
| case .static: | ||
| self = .varStatic | ||
| case .class: | ||
| self = .varClass | ||
| } | ||
| } | ||
|
|
||
| var variableKind: VariableKind? { | ||
| switch self { | ||
| case .varInstance: | ||
| return .instance | ||
| case .varLocal: | ||
| return .local | ||
| case .varStatic: | ||
| return .static | ||
| case .varClass: | ||
| return .class | ||
| default: | ||
| return nil | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public struct ExplicitTypeInterfaceConfiguration: RuleConfiguration, Equatable { | ||
|
|
||
| private static let variableKinds: Set<SwiftDeclarationKind> = [.varInstance, | ||
| .varLocal, | ||
| .varStatic, | ||
| .varClass] | ||
|
|
||
| public var severityConfiguration = SeverityConfiguration(.warning) | ||
|
|
||
| public var allowedKinds = ExplicitTypeInterfaceConfiguration.variableKinds | ||
|
|
||
| public var consoleDescription: String { | ||
| let excludedKinds = ExplicitTypeInterfaceConfiguration.variableKinds.subtracting(allowedKinds) | ||
| let simplifiedExcludedKinds = excludedKinds.flatMap { $0.variableKind?.rawValue }.sorted() | ||
| return severityConfiguration.consoleDescription + ", excluded: \(simplifiedExcludedKinds)" | ||
| } | ||
|
|
||
| public init() {} | ||
|
|
||
| public mutating func apply(configuration: Any) throws { | ||
| guard let configuration = configuration as? [String: Any] else { | ||
| throw ConfigurationError.unknownConfiguration | ||
| } | ||
| for (key, value) in configuration { | ||
| switch (key, value) { | ||
| case ("severity", let severityString as String): | ||
| try severityConfiguration.apply(configuration: severityString) | ||
| case ("excluded", let excludedStrings as [String]): | ||
| let excludedKinds = excludedStrings.flatMap(VariableKind.init(rawValue:)) | ||
| allowedKinds.subtract(excludedKinds.map(SwiftDeclarationKind.init(variableKind:))) | ||
| default: | ||
| throw ConfigurationError.unknownConfiguration | ||
| } | ||
| } | ||
| } | ||
|
|
||
| public static func == (lhs: ExplicitTypeInterfaceConfiguration, rhs: ExplicitTypeInterfaceConfiguration) -> Bool { | ||
| return lhs.allowedKinds == rhs.allowedKinds && lhs.severityConfiguration == rhs.severityConfiguration | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
54 changes: 54 additions & 0 deletions
54
Tests/SwiftLintFrameworkTests/ExplicitTypeInterfaceConfigurationTests.swift
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| // | ||
| // ExplicitTypeInterfaceConfigurationTests.swift | ||
| // SwiftLint | ||
| // | ||
| // Created by Rounak Jain on 2/24/18. | ||
| // Copyright © 2018 Realm. All rights reserved. | ||
| // | ||
|
|
||
| @testable import SwiftLintFramework | ||
| import XCTest | ||
|
|
||
| class ExplicitTypeInterfaceConfigurationTests: XCTestCase { | ||
|
|
||
| func testDefaultConfiguration() { | ||
| let config = ExplicitTypeInterfaceConfiguration() | ||
| XCTAssertEqual(config.severityConfiguration.severity, .warning) | ||
| XCTAssertEqual(config.allowedKinds, Set([.varInstance, .varClass, .varStatic, .varLocal])) | ||
| } | ||
|
|
||
| func testApplyingCustomConfiguration() throws { | ||
| var config = ExplicitTypeInterfaceConfiguration() | ||
| try config.apply(configuration: ["severity": "error", | ||
| "excluded": ["local"]]) | ||
| XCTAssertEqual(config.severityConfiguration.severity, .error) | ||
| XCTAssertEqual(config.allowedKinds, Set([.varInstance, .varClass, .varStatic])) | ||
| } | ||
|
|
||
| func testInvalidKeyInCustomConfiguration() { | ||
| var config = ExplicitTypeInterfaceConfiguration() | ||
| checkError(ConfigurationError.unknownConfiguration) { | ||
| try config.apply(configuration: ["invalidKey": "error"]) | ||
| } | ||
| } | ||
|
|
||
| func testInvalidTypeOfCustomConfiguration() { | ||
| var config = ExplicitTypeInterfaceConfiguration() | ||
| checkError(ConfigurationError.unknownConfiguration) { | ||
| try config.apply(configuration: "invalidKey") | ||
| } | ||
| } | ||
|
|
||
| func testInvalidTypeOfValueInCustomConfiguration() { | ||
| var config = ExplicitTypeInterfaceConfiguration() | ||
| checkError(ConfigurationError.unknownConfiguration) { | ||
| try config.apply(configuration: ["severity": 1]) | ||
| } | ||
| } | ||
|
|
||
| func testConsoleDescription() throws { | ||
| var config = ExplicitTypeInterfaceConfiguration() | ||
| try config.apply(configuration: ["excluded": ["class", "instance"]]) | ||
| XCTAssertEqual(config.consoleDescription, "warning, excluded: [\"class\", \"instance\"]") | ||
| } | ||
| } |
47 changes: 47 additions & 0 deletions
47
Tests/SwiftLintFrameworkTests/ExplicitTypeInterfaceRuleTests.swift
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| // | ||
| // ExplicitTypeInterfaceRuleTests.swift | ||
| // SwiftLint | ||
| // | ||
| // Created by Rounak Jain on 2/24/18. | ||
| // Copyright © 2018 Realm. All rights reserved. | ||
| // | ||
|
|
||
| import SwiftLintFramework | ||
| import XCTest | ||
|
|
||
| class ExplicitTypeInterfaceRuleTests: XCTestCase { | ||
|
|
||
| func testExplicitTypeInterface() { | ||
| verifyRule(ExplicitTypeInterfaceRule.description) | ||
| } | ||
|
|
||
| func testExcludeLocalVars() { | ||
| let nonTriggeringExamples = ExplicitTypeInterfaceRule.description.nonTriggeringExamples + [ | ||
| "func foo() {\nlet intVal = 1\n}" | ||
| ] | ||
| let triggeringExamples = ExplicitTypeInterfaceRule.description.triggeringExamples | ||
| let description = ExplicitTypeInterfaceRule.description | ||
| .with(triggeringExamples: triggeringExamples) | ||
| .with(nonTriggeringExamples: nonTriggeringExamples) | ||
|
|
||
| verifyRule(description, ruleConfiguration: ["excluded": ["local"]]) | ||
| } | ||
|
|
||
| func testExcludeClassVars() { | ||
| let nonTriggeringExamples = ExplicitTypeInterfaceRule.description.nonTriggeringExamples + [ | ||
| "class Foo {\n static var myStaticVar = 0\n}\n", | ||
| "class Foo {\n static let myStaticLet = 0\n}\n" | ||
| ] | ||
| let triggeringExamples = [ | ||
| "class Foo {\n ↓var myVar = 0\n\n}\n", | ||
| "class Foo {\n ↓let mylet = 0\n\n}\n", | ||
| "class Foo {\n ↓class var myClassVar = 0\n}\n" | ||
| ] | ||
| let description = ExplicitTypeInterfaceRule.description | ||
| .with(triggeringExamples: triggeringExamples) | ||
| .with(nonTriggeringExamples: nonTriggeringExamples) | ||
|
|
||
| verifyRule(description, ruleConfiguration: ["excluded": ["static"]]) | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.