GitHub/SwiftLint
1
0
Fork 0
mirror of https://github.com/realm/SwiftLint.git synced 2026-06-06 20:18:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

made adjustments per PR feedback, added tests for cyclomatic complexity configuration class

Browse Source
This commit is contained in:
Michael Welles
2017-02-15 11:17:06 -05:00
parent f7ac3f168f
commit a6175faad0
3 changed files with 126 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Source/SwiftLintFramework/Rules/RuleConfigurations/CyclomaticComplexityConfiguration.swift
+4 -15
View File
@@ -12,17 +12,6 @@ private enum ConfigurationKey: String {
case warning = "warning"
case error = "error"
case ignoresCaseStatements = "ignores_case_statements"
static func all() -> [ConfigurationKey] {
return [
.warning,
.error,
.ignoresCaseStatements
]
}
static func allValues() -> [String] {
return all().map { $0.rawValue }
}
}
public struct CyclomaticComplexityConfiguration: RuleConfiguration, Equatable {
@@ -30,7 +19,7 @@ public struct CyclomaticComplexityConfiguration: RuleConfiguration, Equatable {
return length.consoleDescription + ", ignores switch statements: \(ignoresCaseStatements)"
}
public static let defaultComplexityStatements: Set<StatementKind> = Set([
public static let defaultComplexityStatements: Set<StatementKind> = [
.forEach,
.if,
.guard,
@@ -38,13 +27,13 @@ public struct CyclomaticComplexityConfiguration: RuleConfiguration, Equatable {
.repeatWhile,
.while,
.case
])
]
var length: SeverityLevelsConfiguration
private(set) public var length: SeverityLevelsConfiguration
private(set) public var complexityStatements: Set<StatementKind>
var ignoresCaseStatements: Bool {
private(set) public var ignoresCaseStatements: Bool {
didSet {
if ignoresCaseStatements {
complexityStatements.remove(.case)
SwiftLint.xcodeproj/project.pbxproj
+6 -2
View File
@@ -53,6 +53,7 @@
4DB7815E1CAD72BA00BC4723 /* LegacyCGGeometryFunctionsRule.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4DB7815C1CAD690100BC4723 /* LegacyCGGeometryFunctionsRule.swift */; };
4DCB8E7F1CBE494E0070FCF0 /* RegexHelpers.swift in Sources */ = {isa = PBXBuildFile; fileRef = 4DCB8E7D1CBE43640070FCF0 /* RegexHelpers.swift */; };
57ED827B1CF656E3002B3513 /* JUnitReporter.swift in Sources */ = {isa = PBXBuildFile; fileRef = 57ED82791CF65183002B3513 /* JUnitReporter.swift */; };
67932E2D1E54AF4B00CB0629 /* CyclomaticComplexityConfigurationTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 67932E2C1E54AF4B00CB0629 /* CyclomaticComplexityConfigurationTests.swift */; };
67EB4DFA1E4CC111004E9ACD /* CyclomaticComplexityConfiguration.swift in Sources */ = {isa = PBXBuildFile; fileRef = 67EB4DF81E4CC101004E9ACD /* CyclomaticComplexityConfiguration.swift */; };
67EB4DFC1E4CD7F5004E9ACD /* CyclomaticComplexityRuleTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 67EB4DFB1E4CD7F5004E9ACD /* CyclomaticComplexityRuleTests.swift */; };
69F88BF71BDA38A6005E7CAE /* OpeningBraceRule.swift in Sources */ = {isa = PBXBuildFile; fileRef = 692B1EB11BD7E00F00EAABFF /* OpeningBraceRule.swift */; };
@@ -96,8 +97,8 @@
D286EC021E02DF6F0003CF72 /* SortedImportsRule.swift in Sources */ = {isa = PBXBuildFile; fileRef = D286EC001E02DA190003CF72 /* SortedImportsRule.swift */; };
D40AD08A1E032F9700F48C30 /* UnusedClosureParameterRule.swift in Sources */ = {isa = PBXBuildFile; fileRef = D40AD0891E032F9700F48C30 /* UnusedClosureParameterRule.swift */; };
D40F83881DE9179200524C62 /* TrailingCommaConfiguration.swift in Sources */ = {isa = PBXBuildFile; fileRef = D40F83871DE9179200524C62 /* TrailingCommaConfiguration.swift */; };
D4130D991E16CC1300242361 /* TypeNameRuleExamples.swift in Sources */ = {isa = PBXBuildFile; fileRef = D4130D981E16CC1300242361 /* TypeNameRuleExamples.swift */; };
D4130D971E16183F00242361 /* IdentifierNameRuleExamples.swift in Sources */ = {isa = PBXBuildFile; fileRef = D4130D961E16183F00242361 /* IdentifierNameRuleExamples.swift */; };
D4130D991E16CC1300242361 /* TypeNameRuleExamples.swift in Sources */ = {isa = PBXBuildFile; fileRef = D4130D981E16CC1300242361 /* TypeNameRuleExamples.swift */; };
D41E7E0B1DF9DABB0065259A /* RedundantStringEnumValueRule.swift in Sources */ = {isa = PBXBuildFile; fileRef = D41E7E0A1DF9DABB0065259A /* RedundantStringEnumValueRule.swift */; };
D42D2B381E09CC0D00CD7A2E /* FirstWhereRule.swift in Sources */ = {isa = PBXBuildFile; fileRef = D42D2B371E09CC0D00CD7A2E /* FirstWhereRule.swift */; };
D4348EEA1C46122C007707FB /* FunctionBodyLengthRuleTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = D4348EE91C46122C007707FB /* FunctionBodyLengthRuleTests.swift */; };
@@ -315,6 +316,7 @@
5499CA971A2394B700783309 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
57ED82791CF65183002B3513 /* JUnitReporter.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = JUnitReporter.swift; sourceTree = "<group>"; };
65454F451B14D73800319A6C /* ControlStatementRule.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ControlStatementRule.swift; sourceTree = "<group>"; };
67932E2C1E54AF4B00CB0629 /* CyclomaticComplexityConfigurationTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = CyclomaticComplexityConfigurationTests.swift; sourceTree = "<group>"; };
67EB4DF81E4CC101004E9ACD /* CyclomaticComplexityConfiguration.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = CyclomaticComplexityConfiguration.swift; sourceTree = "<group>"; };
67EB4DFB1E4CD7F5004E9ACD /* CyclomaticComplexityRuleTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = CyclomaticComplexityRuleTests.swift; sourceTree = "<group>"; };
692B1EB11BD7E00F00EAABFF /* OpeningBraceRule.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = OpeningBraceRule.swift; sourceTree = "<group>"; };
@@ -372,8 +374,8 @@
D286EC001E02DA190003CF72 /* SortedImportsRule.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = SortedImportsRule.swift; sourceTree = "<group>"; };
D40AD0891E032F9700F48C30 /* UnusedClosureParameterRule.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = UnusedClosureParameterRule.swift; sourceTree = "<group>"; };
D40F83871DE9179200524C62 /* TrailingCommaConfiguration.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TrailingCommaConfiguration.swift; sourceTree = "<group>"; };
D4130D981E16CC1300242361 /* TypeNameRuleExamples.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TypeNameRuleExamples.swift; sourceTree = "<group>"; };
D4130D961E16183F00242361 /* IdentifierNameRuleExamples.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = IdentifierNameRuleExamples.swift; sourceTree = "<group>"; };
D4130D981E16CC1300242361 /* TypeNameRuleExamples.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TypeNameRuleExamples.swift; sourceTree = "<group>"; };
D41E7E0A1DF9DABB0065259A /* RedundantStringEnumValueRule.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = RedundantStringEnumValueRule.swift; sourceTree = "<group>"; };
D42D2B371E09CC0D00CD7A2E /* FirstWhereRule.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = FirstWhereRule.swift; sourceTree = "<group>"; };
D4348EE91C46122C007707FB /* FunctionBodyLengthRuleTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = FunctionBodyLengthRuleTests.swift; sourceTree = "<group>"; };
@@ -750,6 +752,7 @@
C9802F2E1E0C8AEE008AB27F /* TrailingCommaRuleTests.swift */,
006204DD1E1E4E0A00FFFBE1 /* VerticalWhitespaceRuleTests.swift */,
67EB4DFB1E4CD7F5004E9ACD /* CyclomaticComplexityRuleTests.swift */,
67932E2C1E54AF4B00CB0629 /* CyclomaticComplexityConfigurationTests.swift */,
);
name = SwiftLintFrameworkTests;
path = Tests/SwiftLintFrameworkTests;
@@ -1335,6 +1338,7 @@
D4998DE71DF191380006E05D /* AttributesRuleTests.swift in Sources */,
E88198631BEA9A5400333A11 /* RulesTests.swift in Sources */,
D46202211E16002A0027AAD1 /* Swift2RulesTests.swift in Sources */,
67932E2D1E54AF4B00CB0629 /* CyclomaticComplexityConfigurationTests.swift in Sources */,
C9802F2F1E0C8AEE008AB27F /* TrailingCommaRuleTests.swift in Sources */,
3B63D46F1E1F09DF0057BE35 /* LineLengthRuleTests.swift in Sources */,
3BCC04D41C502BAB006073C3 /* RuleConfigurationTests.swift in Sources */,
Tests/SwiftLintFrameworkTests/CyclomaticComplexityConfigurationTests.swift
+116
View File
@@ -0,0 +1,116 @@
//
// CyclomaticComplexityConfigurationTests.swift
// SwiftLint
//
// Created by Michael Welles on 2/15/17.
// Copyright © 2017 Realm. All rights reserved.
//
import SourceKittenFramework
@testable import SwiftLintFramework
import XCTest
class CyclomaticComplexityConfigurationTests: XCTestCase {
func testCyclomaticComplexityConfigurationInitializerSetsLevels() {
let warning = 10
let error = 30
let level = SeverityLevelsConfiguration(warning: warning, error: error)
let configuration1 = CyclomaticComplexityConfiguration(warning: warning,
error: error)
XCTAssertEqual(configuration1.length, level)
let length2 = SeverityLevelsConfiguration(warning: warning, error: nil)
let configuration2 = CyclomaticComplexityConfiguration(warning: warning,
error: nil)
XCTAssertEqual(configuration2.length, length2)
}
func testCyclomaticComplexityConfigurationInitializerSetsIgnoresCaseStatements() {
let configuration1 = CyclomaticComplexityConfiguration(warning: 10,
error: 30,
ignoresCaseStatements: true)
XCTAssertTrue(configuration1.ignoresCaseStatements)
let configuration2 = CyclomaticComplexityConfiguration(warning:0,
error: 30)
XCTAssertFalse(configuration2.ignoresCaseStatements)
}
func testCyclomaticComplexityConfigurationApplyConfigurationWithDictionary() {
var configuration = CyclomaticComplexityConfiguration(warning: 0, error: 0)
let warning1 = 10
let error1 = 30
let length1 = SeverityLevelsConfiguration(warning: warning1, error: error1)
let config1: [String: Any] = ["warning": warning1,
"error": error1,
"ignores_case_statements": true]
let warning2 = 20
let error2 = 40
let length2 = SeverityLevelsConfiguration(warning: warning2, error: error2)
let config2: [String: Int] = ["warning": warning2, "error": error2]
let config3: [String: Bool] = ["ignores_case_statements": false]
do {
try configuration.apply(configuration: config1)
XCTAssertEqual(configuration.length, length1)
XCTAssertTrue(configuration.ignoresCaseStatements)
try configuration.apply(configuration: config2)
XCTAssertEqual(configuration.length, length2)
XCTAssertTrue(configuration.ignoresCaseStatements)
try configuration.apply(configuration: config3)
XCTAssertEqual(configuration.length, length2)
XCTAssertFalse(configuration.ignoresCaseStatements)
} catch {
XCTFail()
}
}
func testCyclomaticComplexityConfigurationThrowsOnBadConfigValues() {
let badConfigs: [[String: Any]] = [
["warning": true],
["ignores_case_statements": 300],
["unsupported_key": "unsupported key is unsupported"]
]
for badConfig in badConfigs {
var configuration = CyclomaticComplexityConfiguration(warning: 100, error: 150)
checkError(ConfigurationError.unknownConfiguration) {
try configuration.apply(configuration: badConfig)
}
}
}
func testCyclomaticComplexityConfigurationCompares() {
let config1 = CyclomaticComplexityConfiguration(warning: 10, error: 30)
let config2 = CyclomaticComplexityConfiguration(warning: 10, error: 30, ignoresCaseStatements: true)
let config3 = CyclomaticComplexityConfiguration(warning: 10, error: 30, ignoresCaseStatements: false)
let config4 = CyclomaticComplexityConfiguration(warning: 10, error: 40)
let config5 = CyclomaticComplexityConfiguration(warning: 20, error: 30)
XCTAssertFalse(config1 == config2)
XCTAssertTrue(config1 == config3)
XCTAssertFalse(config1 == config4)
XCTAssertFalse(config1 == config5)
}
}
extension CyclomaticComplexityConfigurationTests {
static var allTests: [(String, (CyclomaticComplexityConfigurationTests) -> () throws -> Void)] {
return [
("testCyclomaticComplexityConfigurationInitializerSetsLevels",
testCyclomaticComplexityConfigurationInitializerSetsLevels),
("testCyclomaticComplexityConfigurationInitializerSetsIgnoresCaseStatements",
testCyclomaticComplexityConfigurationInitializerSetsIgnoresCaseStatements),
("testCyclomaticComplexityConfigurationThrowsOnBadConfigValues",
testCyclomaticComplexityConfigurationThrowsOnBadConfigValues),
("testCyclomaticComplexityConfigurationApplyConfigurationWithDictionary",
testCyclomaticComplexityConfigurationApplyConfigurationWithDictionary),
("testCyclomaticComplexityConfigurationCompares",
testCyclomaticComplexityConfigurationCompares)
]
}
}