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

Merge pull request #723 from daniel-beard/dbeard_fix_force_unwrap_false_positive

Browse Source 
Fix force unwrap false positive. Fixes #721
This commit is contained in:
JP Simard
2016-07-12 14:47:21 -04:00
committed by GitHub
parent 02a7fb1c0b b30a63bde3
commit cccfef7d9d
2 changed files with 37 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CHANGELOG.md
+4
View File
@@ -19,6 +19,10 @@
[Sarr Blaise](https://github.com/bsarr007)
[#646](https://github.com/realm/SwiftLint/issues/646)
* Fix force_unwrapping false positive inside strings.
[Daniel Beard](https://github.com/daniel-beard)
[#721](https://github.com/realm/SwiftLint/issues/721)
## 0.11.1: Cuddles... Or Else!
##### Breaking
Source/SwiftLintFramework/Rules/ForceUnwrappingRule.swift
+33 -19
View File
@@ -31,6 +31,7 @@ public struct ForceUnwrappingRule: OptInRule, ConfigurationProviderRule {
"navigationBarHidden, animated: true)",
"if addedToPlaylist && (!self.selectedFilters.isEmpty || " +
"self.searchBar?.text?.isEmpty == false) {}",
"print(\"\\(xVar)!\")"
],
triggeringExamples: [
"let url = NSURL(string: query)↓!",
@@ -51,15 +52,18 @@ public struct ForceUnwrappingRule: OptInRule, ConfigurationProviderRule {
// capture previous and next of "!"
// http://userguide.icu-project.org/strings/regexp
private static let pattern = "(\\S)!(.?)"
private static let pattern = "(\\S)(!)(.?)"
// swiftlint:disable:next force_try
private static let regularExpression = try! NSRegularExpression(pattern: pattern,
options: [.DotMatchesLineSeparators])
private static let excludingSyntaxKindsForFirstCapture = SyntaxKind
.commentKeywordStringAndTypeidentifierKinds().map { $0.rawValue }
private static let excludingSyntaxKindsForSecondCapture = [SyntaxKind.Identifier.rawValue]
private static let excludingSyntaxKindsForSecondCapture = SyntaxKind
.commentAndStringKinds().map { $0.rawValue }
private static let excludingSyntaxKindsForThirdCapture = [SyntaxKind.Identifier.rawValue]
// swiftlint:disable:next function_body_length
private func violationRangesInFile(file: File) -> [NSRange] {
let contents = file.contents
let nsstring = contents as NSString
@@ -68,49 +72,59 @@ public struct ForceUnwrappingRule: OptInRule, ConfigurationProviderRule {
return ForceUnwrappingRule.regularExpression
.matchesInString(contents, options: [], range: range)
.flatMap { match -> NSRange? in
if match.numberOfRanges < 2 { return nil }
if match.numberOfRanges < 3 { return nil }
// check first captured range
let firstRange = match.rangeAtIndex(1)
let secondRange = match.rangeAtIndex(2)
let violationRange = NSRange(location: NSMaxRange(firstRange), length: 0)
guard let matchByteFirstRange = contents
.NSRangeToByteRange(start: firstRange.location, length: firstRange.length)
.NSRangeToByteRange(start: firstRange.location, length: firstRange.length),
matchByteSecondRange = contents
.NSRangeToByteRange(start: secondRange.location, length: secondRange.length)
else { return nil }
let tokensInFirstRange = syntaxMap.tokensIn(matchByteFirstRange)
let tokensInSecondRange = syntaxMap.tokensIn(matchByteSecondRange)
// check first captured range
// If not empty, first captured range is comment, string, keyword or typeidentifier.
// We checks "not empty" because tokens may empty without filtering.
let tokensInFirstRangeExcludingSyntaxKindsOnly = tokensInFirstRange.filter({
guard tokensInFirstRange.filter({
ForceUnwrappingRule.excludingSyntaxKindsForFirstCapture.contains($0.type)
})
if !tokensInFirstRangeExcludingSyntaxKindsOnly.isEmpty { return nil }
}).isEmpty else { return nil }
// if first captured range is identifier, generate violation
if tokensInFirstRange.map({ $0.type }).contains(SyntaxKind.Identifier.rawValue) {
return violationRange
}
// check firstCapturedString is ")"
let firstCapturedString = nsstring.substringWithRange(firstRange)
if firstCapturedString == ")" { return violationRange }
// check second capture '!'
let forceUnwrapNotInCommentOrString = tokensInSecondRange.filter({
ForceUnwrappingRule.excludingSyntaxKindsForSecondCapture.contains($0.type)
}).isEmpty
// check second capture
// check firstCapturedString is ")" and '!' is not within comment or string
let firstCapturedString = nsstring.substringWithRange(firstRange)
if firstCapturedString == ")" &&
forceUnwrapNotInCommentOrString { return violationRange }
// check third capture
if match.numberOfRanges == 3 {
// check second captured range
let secondRange = match.rangeAtIndex(2)
guard let matchByteSecondRange = contents
// check third captured range
let secondRange = match.rangeAtIndex(3)
guard let matchByteThirdRange = contents
.NSRangeToByteRange(start: secondRange.location, length: secondRange.length)
else { return nil }
let tokensInSecondRange = syntaxMap.tokensIn(matchByteSecondRange).filter {
ForceUnwrappingRule.excludingSyntaxKindsForSecondCapture.contains($0.type)
let tokensInThirdRange = syntaxMap.tokensIn(matchByteThirdRange).filter {
ForceUnwrappingRule.excludingSyntaxKindsForThirdCapture.contains($0.type)
}
// If not empty, second captured range is identifier.
// If not empty, third captured range is identifier.
// "!" is "operator prefix !".
if !tokensInSecondRange.isEmpty { return nil }
if !tokensInThirdRange.isEmpty { return nil }
}
// check structure