-
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 #1966 from joseprl89/feature/explicit_acl_rule
Add explicit acl rule to satisfy Issue #1649
- Loading branch information
Showing
6 changed files
with
267 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
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,154 @@ | ||
| // | ||
| // ExplicitACLRule.swift | ||
| // SwiftLint | ||
| // | ||
| // Created by Josep Rodriguez on 02/12/17. | ||
| // Copyright © 2017 Realm. All rights reserved. | ||
| // | ||
|
|
||
| import Foundation | ||
| import SourceKittenFramework | ||
|
|
||
| private typealias SourceKittenElement = [String: SourceKitRepresentable] | ||
|
|
||
| public struct ExplicitACLRule: OptInRule, ConfigurationProviderRule { | ||
|
|
||
| public var configuration = SeverityConfiguration(.warning) | ||
|
|
||
| public init() {} | ||
|
|
||
| public static let description = RuleDescription( | ||
| identifier: "explicit_acl", | ||
| name: "Explicit ACL", | ||
| description: "All declarations should specify Access Control Level keywords explicitly.", | ||
| kind: .idiomatic, | ||
| nonTriggeringExamples: [ | ||
| "internal enum A {}\n", | ||
| "public final class B {}\n", | ||
| "private struct C {}\n", | ||
| "internal enum A {\n internal enum B {}\n}", | ||
| "internal final class Foo {}", | ||
| "internal\nclass Foo { private let bar = 5 }", | ||
| "internal func a() { let a = }\n", | ||
| "private func a() { func innerFunction() { } }", | ||
| "private enum Foo { enum Bar { } }", | ||
| "private struct C { let d = 5 }" | ||
| ], | ||
| triggeringExamples: [ | ||
| "enum A {}\n", | ||
| "final class B {}\n", | ||
| "internal struct C { let d = 5 }\n", | ||
| "public struct C { let d = 5 }\n", | ||
| "func a() {}\n", | ||
| "internal let a = 0\nfunc b() {}\n" | ||
| ] | ||
| ) | ||
|
|
||
| private func findAllExplicitInternalTokens(in file: File) -> [NSRange] { | ||
| let contents = file.contents.bridge() | ||
| return file.match(pattern: "internal", with: [.attributeBuiltin]).flatMap { | ||
| contents.NSRangeToByteRange(start: $0.location, length: $0.length) | ||
| } | ||
| } | ||
|
|
||
| private func offsetOfElements(from elements: [SourceKittenElement], in file: File, | ||
| thatAreNotInRanges ranges: [NSRange]) -> [Int] { | ||
| return elements.flatMap { element in | ||
| guard let typeOffset = element.offset else { | ||
| return nil | ||
| } | ||
|
|
||
| // find the last "internal" token before the type | ||
| guard let previousInternalByteRange = lastInternalByteRange(before: typeOffset, | ||
| in: ranges) else { | ||
| return typeOffset | ||
| } | ||
|
|
||
| // the "internal" token correspond to the type if there're only | ||
| // attributeBuiltin (`final` for example) tokens between them | ||
| let length = typeOffset - previousInternalByteRange.location | ||
| let range = NSRange(location: previousInternalByteRange.location, length: length) | ||
| let internalDoesntBelongToType = Set(file.syntaxMap.kinds(inByteRange: range)) != [.attributeBuiltin] | ||
|
|
||
| return internalDoesntBelongToType ? typeOffset : nil | ||
| } | ||
| } | ||
|
|
||
| public func validate(file: File) -> [StyleViolation] { | ||
| let implicitAndExplicitInternalElements = internalTypeElements(in: file.structure.dictionary) | ||
|
|
||
| guard !implicitAndExplicitInternalElements.isEmpty else { | ||
| return [] | ||
| } | ||
|
|
||
| let explicitInternalRanges = findAllExplicitInternalTokens(in: file) | ||
|
|
||
| let violations = offsetOfElements(from: implicitAndExplicitInternalElements, in: file, | ||
| thatAreNotInRanges: explicitInternalRanges) | ||
|
|
||
| return violations.map { | ||
| StyleViolation(ruleDescription: type(of: self).description, | ||
| severity: configuration.severity, | ||
| location: Location(file: file, byteOffset: $0)) | ||
| } | ||
| } | ||
|
|
||
| private func lastInternalByteRange(before typeOffset: Int, in ranges: [NSRange]) -> NSRange? { | ||
| let firstPartition = ranges.prefix(while: { typeOffset > $0.location }) | ||
| return firstPartition.last | ||
| } | ||
|
|
||
| private func internalTypeElements(in element: SourceKittenElement) -> [SourceKittenElement] { | ||
| return element.substructure.flatMap { element -> [SourceKittenElement] in | ||
| guard let elementKind = SwiftDeclarationKind(rawValue: element.kind ?? "") else { | ||
| return [] | ||
| } | ||
|
|
||
| let internalTypeElementsInSubstructure = elementKind.childsAreExemptFromACL ? [] : | ||
| internalTypeElements(in: element) | ||
|
|
||
| if element.accessibility.flatMap(AccessControlLevel.init(identifier:)) == .internal { | ||
| return internalTypeElementsInSubstructure + [element] | ||
| } | ||
|
|
||
| return internalTypeElementsInSubstructure | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private extension SwiftDeclarationKind { | ||
|
|
||
| var childsAreExemptFromACL: Bool { | ||
| switch self { | ||
| case .`associatedtype`, .enumcase, .enumelement, .functionAccessorAddress, | ||
| .functionAccessorDidset, .functionAccessorGetter, .functionAccessorMutableaddress, | ||
| .functionAccessorSetter, .functionAccessorWillset, .genericTypeParam, .module, | ||
| .precedenceGroup, .varLocal, .varParameter, .varClass, | ||
| .varGlobal, .varInstance, .varStatic, .`typealias`, .functionConstructor, .functionDestructor, | ||
| .functionFree, .functionMethodClass, .functionMethodInstance, .functionMethodStatic, | ||
| .functionOperator, .functionOperatorInfix, .functionOperatorPostfix, .functionOperatorPrefix, | ||
| .functionSubscript: | ||
| return true | ||
| case .`class`, .`enum`, .`extension`, .`extensionClass`, .`extensionEnum`, | ||
| .extensionProtocol, .extensionStruct, .`protocol`, .`struct`: | ||
| return false | ||
| } | ||
| } | ||
|
|
||
| var shouldContainExplicitACL: Bool { | ||
| switch self { | ||
| case .`associatedtype`, .enumcase, .enumelement, .functionAccessorAddress, | ||
| .functionAccessorDidset, .functionAccessorGetter, .functionAccessorMutableaddress, | ||
| .functionAccessorSetter, .functionAccessorWillset, .genericTypeParam, .module, | ||
| .precedenceGroup, .varLocal, .varParameter: | ||
| return false | ||
| case .`class`, .`enum`, .`extension`, .`extensionClass`, .`extensionEnum`, | ||
| .extensionProtocol, .extensionStruct, .functionConstructor, .functionDestructor, | ||
| .functionFree, .functionMethodClass, .functionMethodInstance, .functionMethodStatic, | ||
| .functionOperator, .functionOperatorInfix, .functionOperatorPostfix, .functionOperatorPrefix, | ||
| .functionSubscript, .`protocol`, .`struct`, .`typealias`, .varClass, | ||
| .varGlobal, .varInstance, .varStatic: | ||
| return true | ||
| } | ||
| } | ||
| } |
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