mirror of
https://github.com/realm/SwiftLint.git
synced 2026-06-06 20:18:40 +00:00
Zev Eisenberg
fcf848608e
* 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.
79 lines
3.5 KiB
Swift
79 lines
3.5 KiB
Swift
import SwiftLintFramework
|
|
import XCTest
|
|
|
|
private func funcWithBody(_ body: String,
|
|
violates: Bool = false,
|
|
file: StaticString = #file,
|
|
line: UInt = #line) -> Example {
|
|
let marker = violates ? "↓" : ""
|
|
return Example("func \(marker)abc() {\nvar x = 0\n\(body)}\n", file: file, line: line)
|
|
}
|
|
|
|
private func violatingFuncWithBody(_ body: String, file: StaticString = #file, line: UInt = #line) -> Example {
|
|
return funcWithBody(body, violates: true, file: file, line: line)
|
|
}
|
|
|
|
class FunctionBodyLengthRuleTests: XCTestCase {
|
|
func testWithDefaultConfiguration() {
|
|
verifyRule(FunctionBodyLengthRule.description)
|
|
}
|
|
|
|
func testFunctionBodyLengths() {
|
|
let longFunctionBody = funcWithBody(repeatElement("x = 0\n", count: 39).joined())
|
|
XCTAssertEqual(self.violations(longFunctionBody), [])
|
|
|
|
let longerFunctionBody = violatingFuncWithBody(repeatElement("x = 0\n", count: 40).joined())
|
|
XCTAssertEqual(self.violations(longerFunctionBody), [StyleViolation(
|
|
ruleDescription: FunctionBodyLengthRule.description,
|
|
location: Location(file: nil, line: 1, character: 1),
|
|
reason: "Function body should span 40 lines or less excluding comments and " +
|
|
"whitespace: currently spans 41 lines")])
|
|
|
|
let longerFunctionBodyWithEmptyLines = funcWithBody(
|
|
repeatElement("\n", count: 100).joined()
|
|
)
|
|
XCTAssertEqual(self.violations(longerFunctionBodyWithEmptyLines), [])
|
|
}
|
|
|
|
func testFunctionBodyLengthsWithComments() {
|
|
let longFunctionBodyWithComments = funcWithBody(
|
|
repeatElement("x = 0\n", count: 39).joined() +
|
|
"// comment only line should be ignored.\n"
|
|
)
|
|
XCTAssertEqual(violations(longFunctionBodyWithComments), [])
|
|
|
|
let longerFunctionBodyWithComments = violatingFuncWithBody(
|
|
repeatElement("x = 0\n", count: 40).joined() +
|
|
"// comment only line should be ignored.\n"
|
|
)
|
|
XCTAssertEqual(self.violations(longerFunctionBodyWithComments), [StyleViolation(
|
|
ruleDescription: FunctionBodyLengthRule.description,
|
|
location: Location(file: nil, line: 1, character: 1),
|
|
reason: "Function body should span 40 lines or less excluding comments and " +
|
|
"whitespace: currently spans 41 lines")])
|
|
}
|
|
|
|
func testFunctionBodyLengthsWithMultilineComments() {
|
|
let longFunctionBodyWithMultilineComments = funcWithBody(
|
|
repeatElement("x = 0\n", count: 39).joined() +
|
|
"/* multi line comment only line should be ignored.\n*/\n"
|
|
)
|
|
XCTAssertEqual(self.violations(longFunctionBodyWithMultilineComments), [])
|
|
|
|
let longerFunctionBodyWithMultilineComments = violatingFuncWithBody(
|
|
repeatElement("x = 0\n", count: 40).joined() +
|
|
"/* multi line comment only line should be ignored.\n*/\n"
|
|
)
|
|
XCTAssertEqual(self.violations(longerFunctionBodyWithMultilineComments), [StyleViolation(
|
|
ruleDescription: FunctionBodyLengthRule.description,
|
|
location: Location(file: nil, line: 1, character: 1),
|
|
reason: "Function body should span 40 lines or less excluding comments and " +
|
|
"whitespace: currently spans 41 lines")])
|
|
}
|
|
|
|
private func violations(_ example: Example) -> [StyleViolation] {
|
|
let config = makeConfig(nil, FunctionBodyLengthRule.description.identifier)!
|
|
return SwiftLintFrameworkTests.violations(example, config: config)
|
|
}
|
|
}
|