-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1788 from Mazyod/master
Explicit Enum Raw Value Rule
- Loading branch information
Showing
7 changed files
with
202 additions
and
0 deletions.
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
89 changes: 89 additions & 0 deletions
89
Source/SwiftLintFramework/Rules/ExplicitEnumRawValueRule.swift
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,89 @@ | ||
| // | ||
| // ExplicitEnumRawValueRule.swift | ||
| // SwiftLint | ||
| // | ||
| // Created by Mazyad Alabduljaleel on 8/19/17. | ||
| // Copyright © 2017 Realm. All rights reserved. | ||
| // | ||
|
|
||
| import Foundation | ||
| import SourceKittenFramework | ||
|
|
||
| public struct ExplicitEnumRawValueRule: ASTRule, OptInRule, ConfigurationProviderRule { | ||
| public var configuration = SeverityConfiguration(.warning) | ||
|
|
||
| public init() {} | ||
|
|
||
| public static let description = RuleDescription( | ||
| identifier: "explicit_enum_raw_value", | ||
| name: "Explicit Enum Raw Value", | ||
| description: "Enums should be explicitly assigned their raw values.", | ||
| kind: .idiomatic, | ||
| nonTriggeringExamples: [ | ||
| "enum Numbers {\n case int(Int)\n case short(Int16)\n}\n", | ||
| "enum Numbers: Int {\n case one = 1\n case two = 2\n}\n", | ||
| "enum Numbers: Double {\n case one = 1.1\n case two = 2.2\n}\n", | ||
| "enum Numbers: String {\n case one = \"one\"\n case two = \"two\"\n}\n", | ||
| "protocol Algebra {}\nenum Numbers: Algebra {\n case one\n}\n" | ||
| ], | ||
| triggeringExamples: [ | ||
| "enum Numbers: Int {\n case one = 10, ↓two, three = 30\n}\n", | ||
| "enum Numbers: NSInteger {\n case ↓one\n}\n", | ||
| "enum Numbers: String {\n case ↓one\n case ↓two\n}\n", | ||
| "enum Numbers: String {\n case ↓one, two = \"two\"\n}\n", | ||
| "enum Numbers: Decimal {\n case ↓one, ↓two\n}\n" | ||
| ] | ||
| ) | ||
|
|
||
| public func validate(file: File, kind: SwiftDeclarationKind, | ||
| dictionary: [String: SourceKitRepresentable]) -> [StyleViolation] { | ||
| guard kind == .enum else { | ||
| return [] | ||
| } | ||
|
|
||
| // Check if it's an enum which supports raw values | ||
| let implicitRawValueTypes: [Any] = [ | ||
| Int.self, Int8.self, Int16.self, Int32.self, Int64.self, | ||
| UInt.self, UInt8.self, UInt16.self, UInt32.self, UInt64.self, | ||
| Double.self, Float.self, Float80.self, Decimal.self, NSNumber.self, | ||
| NSDecimalNumber.self, "NSInteger", String.self | ||
| ] | ||
|
|
||
| let implicitRawValueSet = Set(implicitRawValueTypes.map(String.init(describing:))) | ||
| let enumInheritedTypesSet = Set(dictionary.inheritedTypes) | ||
|
|
||
| guard !implicitRawValueSet.isDisjoint(with: enumInheritedTypesSet) else { | ||
| return [] | ||
| } | ||
|
|
||
| let violations = violatingOffsetsForEnum(dictionary: dictionary) | ||
| return violations.map { | ||
| StyleViolation(ruleDescription: type(of: self).description, | ||
| severity: configuration.severity, | ||
| location: Location(file: file, byteOffset: $0)) | ||
| } | ||
| } | ||
|
|
||
| private func violatingOffsetsForEnum(dictionary: [String: SourceKitRepresentable]) -> [Int] { | ||
|
|
||
| let locs = substructureElements(of: dictionary, matching: .enumcase) | ||
| .flatMap { substructureElements(of: $0, matching: .enumelement) } | ||
| .flatMap(enumElementsMissingInitExpr) | ||
| .flatMap { $0.offset } | ||
|
|
||
| return locs | ||
| } | ||
|
|
||
| private func substructureElements(of dict: [String: SourceKitRepresentable], | ||
| matching kind: SwiftDeclarationKind) -> [[String: SourceKitRepresentable]] { | ||
| return dict.substructure | ||
| .filter { $0.kind.flatMap(SwiftDeclarationKind.init) == kind } | ||
| } | ||
|
|
||
| private func enumElementsMissingInitExpr( | ||
| _ enumElements: [[String: SourceKitRepresentable]]) -> [[String: SourceKitRepresentable]] { | ||
|
|
||
| return enumElements | ||
| .filter { !$0.elements.contains { $0.kind == "source.lang.swift.structure.elem.init_expr" } } | ||
| } | ||
| } |
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