Files
SwiftLint/Source/SwiftLintFramework/Rules/Metrics/ClosureBodyLengthRuleExamples.swift
T
Zev Eisenberg fcf848608e Add Inline test failure messages (#3040)
* Add Example wrapper in order to display test failures inline when running in Xcode.
* Stop using Swift 5.1-only features so we can compile on Xcode 10.2.
* Wrap strings in Example.
* Add Changelog entry.
* Wrap all examples in Example struct.
* Better and more complete capturing of line numbers.
* Fix broken test.
* Better test traceability.
* Address or disable linting warnings.
* Add documentation comments.
* Disable linter for a few cases.
* Limit mutability and add copy-and-mutate utility functions.
* Limit scope of mutability.
2020-02-02 10:35:37 +02:00

111 lines
4.8 KiB
Swift

internal struct ClosureBodyLengthRuleExamples {
static let nonTriggeringExamples: [Example] = [
singleLineClosure(),
trailingClosure(codeLinesCount: 0, commentLinesCount: 0, emptyLinesCount: 0),
trailingClosure(codeLinesCount: 1, commentLinesCount: 10, emptyLinesCount: 10),
trailingClosure(codeLinesCount: 19, commentLinesCount: 0, emptyLinesCount: 0),
trailingClosure(codeLinesCount: 19, commentLinesCount: 10, emptyLinesCount: 10),
argumentClosure(codeLinesCount: 0),
argumentClosure(codeLinesCount: 1),
argumentClosure(codeLinesCount: 19),
labeledArgumentClosure(codeLinesCount: 0),
labeledArgumentClosure(codeLinesCount: 1),
labeledArgumentClosure(codeLinesCount: 19),
multiLabeledArgumentClosures(codeLinesCount: 19),
labeledAndTrailingClosures(codeLinesCount: 19),
lazyInitialization(codeLinesCount: 18)
]
static let triggeringExamples: [Example] = [
trailingClosure("↓", codeLinesCount: 21, commentLinesCount: 0, emptyLinesCount: 0),
trailingClosure("↓", codeLinesCount: 21, commentLinesCount: 10, emptyLinesCount: 10),
argumentClosure("↓", codeLinesCount: 21),
labeledArgumentClosure("↓", codeLinesCount: 21),
multiLabeledArgumentClosures("↓", codeLinesCount: 21),
labeledAndTrailingClosures("↓", codeLinesCount: 21),
lazyInitialization("↓", codeLinesCount: 19)
]
}
// MARK: - Private
private func singleLineClosure(file: StaticString = #file, line: UInt = #line) -> Example {
return Example("foo.bar { $0 }", file: file, line: line)
}
private func trailingClosure(_ violationSymbol: String = "",
codeLinesCount: Int,
commentLinesCount: Int,
emptyLinesCount: Int,
file: StaticString = #file,
line: UInt = #line) -> Example {
return Example("""
foo.bar \(violationSymbol){ toto in
\(repeatElement("\tlet a = 0\n", count: codeLinesCount).joined())\
\(repeatElement("\t// toto\n", count: commentLinesCount).joined())\
\(repeatElement("\t\n", count: emptyLinesCount).joined())\
}
""", file: file, line: line)
}
private func argumentClosure(_ violationSymbol: String = "",
codeLinesCount: Int,
file: StaticString = #file,
line: UInt = #line) -> Example {
return Example("""
foo.bar(\(violationSymbol){ toto in
\(repeatElement("\tlet a = 0\n", count: codeLinesCount).joined())\
})
""", file: file, line: line)
}
private func labeledArgumentClosure(_ violationSymbol: String = "",
codeLinesCount: Int,
file: StaticString = #file,
line: UInt = #line) -> Example {
return Example("""
foo.bar(label: \(violationSymbol){ toto in
\(repeatElement("\tlet a = 0\n", count: codeLinesCount).joined())\
})
""", file: file, line: line)
}
private func multiLabeledArgumentClosures(_ violationSymbol: String = "",
codeLinesCount: Int,
file: StaticString = #file,
line: UInt = #line) -> Example {
return Example("""
foo.bar(label: \(violationSymbol){ toto in
\(repeatElement("\tlet a = 0\n", count: codeLinesCount).joined())\
}, anotherLabel: \(violationSymbol){ toto in
\(repeatElement("\tlet a = 0\n", count: codeLinesCount).joined())\
})
""", file: file, line: line)
}
private func labeledAndTrailingClosures(_ violationSymbol: String = "",
codeLinesCount: Int,
file: StaticString = #file,
line: UInt = #line) -> Example {
return Example("""
foo.bar(label: \(violationSymbol){ toto in
\(repeatElement("\tlet a = 0\n", count: codeLinesCount).joined())\
}) \(violationSymbol){ toto in
\(repeatElement("\tlet a = 0\n", count: codeLinesCount).joined())\
}
""", file: file, line: line)
}
private func lazyInitialization(_ violationSymbol: String = "",
codeLinesCount: Int,
file: StaticString = #file,
line: UInt = #line) -> Example {
return Example("""
let foo: Bar = \(violationSymbol){ toto in
\tlet bar = Bar()
\(repeatElement("\tlet a = 0\n", count: codeLinesCount).joined())\
\treturn bar
}()
""", file: file, line: line)
}