#2079 - Implemented the new sublclass rule. #2081
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| // | ||
| // SubClassRule.swift | ||
| // SwiftLint | ||
| // | ||
| // Created by Mikhail Yakushin on 03/02/18. | ||
| // Copyright © 2018 Realm. All rights reserved. | ||
| // | ||
|
|
||
| import SourceKittenFramework | ||
|
|
||
| public struct SubClassRule: ASTRule, ConfigurationProviderRule, OptInRule { | ||
| public var configuration = SeverityLevelsConfiguration(warning: 0, error: 0) | ||
|
|
||
| public init() {} | ||
|
|
||
| public static let description = RuleDescription( | ||
| identifier: "subclass", | ||
| name: "Subclass", | ||
| description: "Subclassing is prohibited.", | ||
| kind: .style | ||
|
There was a problem hiding this comment. you should provide There was a problem hiding this comment. this would be probably |
||
| ) | ||
|
|
||
| public func validate(file: File, kind: SwiftDeclarationKind, | ||
| dictionary: [String: SourceKitRepresentable]) -> [StyleViolation] { | ||
| guard SwiftDeclarationKind.functionKinds.contains(kind), | ||
| let offset = dictionary.offset, | ||
| case let contentsNSString = file.contents.bridge() | ||
| else { | ||
| return [] | ||
| } | ||
|
|
||
| if contentsNSString.contains("super.") || contentsNSString.contains("super()") { | ||
|
There was a problem hiding this comment. this is not the right way of doing this since you can have subclasses that don't call There was a problem hiding this comment. @marcelofabri What would be the right way in your opinion? The There was a problem hiding this comment. IMO we should have a rule that triggers if you don't add There's not a lot of value (and in fact I'd argue that it's worst) to trigger a violation on cases where you don't have an alternative, usually dealing with dependencies (either system frameworks like UIKit or 3rd party ones). |
||
| return [ | ||
| StyleViolation( | ||
| ruleDescription: type(of: self).description, | ||
| severity: configuration.params.first!.severity, | ||
| location: Location(file: file, byteOffset: offset), | ||
| reason: "Subclassing is prohibited." | ||
| ) | ||
| ] | ||
| } else { | ||
| return [] | ||
| } | ||
|
|
||
| } | ||
|
|
||
| } | ||
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
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,43 @@ | ||
| // | ||
| // SubClassRuleTests.swift | ||
| // SwiftLint | ||
| // | ||
| // Created by Mikhail Yakushin on 03/02/18. | ||
| // Copyright © 2018 Realm. All rights reserved. | ||
| // | ||
|
|
||
| import SwiftLintFramework | ||
| import XCTest | ||
|
|
||
| class SubClassRuleTests: XCTestCase { | ||
|
|
||
| func testSubClassRuleSuperDot() { | ||
| let nonTriggeringExamples = | ||
| "class MyType: SuperType {" + | ||
| "public init() { super.init() }" + | ||
| "}" | ||
| XCTAssertNotEqual(violations(nonTriggeringExamples), []) | ||
| } | ||
|
|
||
| func testSubClassRuleSuper() { | ||
| let nonTriggeringExamples = | ||
| "class MyType: SuperType {" + | ||
| "public init() { super() }" + | ||
| "}" | ||
| XCTAssertNotEqual(violations(nonTriggeringExamples), []) | ||
| } | ||
|
|
||
| func testSubClassRuleTestsValid() { | ||
| let nonTriggeringExamples = | ||
| "class MyType: SuperType {" + | ||
| "public init() { this() }" + | ||
| "}" | ||
| XCTAssertEqual(violations(nonTriggeringExamples), []) | ||
| } | ||
|
|
||
| private func violations(_ string: String) -> [StyleViolation] { | ||
| let config = makeConfig(nil, SubClassRule.description.identifier)! | ||
| return SwiftLintFrameworkTests.violations(string, config: config) | ||
| } | ||
|
|
||
| } |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you should use
SeverityConfiguration