Migrate to use SourceKitten's new ByteCount/ByteRange types

CHANGELOG.md

@@ -2,7 +2,12 @@
 
 #### Breaking
 
-* None.
+* Replace all uses of `Int`/`Int64`/`NSRange` representing byte offsets
+  to use newly introduced `ByteCount` and `ByteRange` values instead.
+  This will minimize the risk of accidentally using a byte-based offset
+  in character-based contexts.  
+  [Paul Taykalo](https://github.com/PaulTaykalo)
+  [JP Simard](https://github.com/jpsim)
 
 #### Experimental
 

Cartfile

@@ -1,2 +1,2 @@
-github "jpsim/SourceKitten" ~> 0.28.0
+github "jpsim/SourceKitten" ~> 0.29.0
 github "scottrhoyt/SwiftyTextTable" ~> 0.9.0

Cartfile.resolved

@@ -1,6 +1,6 @@
 github "Carthage/Commandant" "0.17.0"
 github "drmohundro/SWXMLHash" "5.0.1"
-github "jpsim/SourceKitten" "0.28.0"
+github "jpsim/SourceKitten" "0.29.0"
 github "jpsim/Yams" "2.0.0"
 github "jspahrsummers/xcconfigs" "0.12"
 github "scottrhoyt/SwiftyTextTable" "0.9.0"

Package.resolved

@@ -51,8 +51,8 @@
         "repositoryURL": "https://github.com/jpsim/SourceKitten.git",
         "state": {
           "branch": null,
-          "revision": "97b5848e5692150d75b5cf0b81d7ebef5f4d5071",
-          "version": "0.28.0"
+          "revision": "77a4dbbb477a8110eb8765e3c44c70fb4929098f",
+          "version": "0.29.0"
         }
       },
       {

Package.swift

@@ -15,7 +15,7 @@ let package = Package(
     ],
     dependencies: [
         .package(url: "https://github.com/Carthage/Commandant.git", .upToNextMinor(from: "0.17.0")),
-        .package(url: "https://github.com/jpsim/SourceKitten.git", from: "0.28.0"),
+        .package(url: "https://github.com/jpsim/SourceKitten.git", .upToNextMinor(from: "0.29.0")),
         .package(url: "https://github.com/jpsim/Yams.git", from: "2.0.0"),
         .package(url: "https://github.com/scottrhoyt/SwiftyTextTable.git", from: "0.9.0"),
     ] + (addCryptoSwift ? [.package(url: "https://github.com/krzyzanowskim/CryptoSwift.git", .upToNextMinor(from: "1.0.0"))] : []),

Source/SwiftLintFramework/Extensions/Dictionary+SwiftLint.swift

@@ -38,13 +38,19 @@ public struct SourceKittenDictionary {
     }
 
     /// Body length
-    var bodyLength: Int? {
-        return (value["key.bodylength"] as? Int64).flatMap({ Int($0) })
+    var bodyLength: ByteCount? {
+        return (value["key.bodylength"] as? Int64).map(ByteCount.init)
     }
 
     /// Body offset.
-    var bodyOffset: Int? {
-        return (value["key.bodyoffset"] as? Int64).flatMap({ Int($0) })
+    var bodyOffset: ByteCount? {
+        return (value["key.bodyoffset"] as? Int64).map(ByteCount.init)
+    }
+
+    /// Body byte range.
+    var bodyByteRange: ByteRange? {
+        guard let offset = bodyOffset, let length = bodyLength else { return nil }
+        return ByteRange(location: offset, length: length)
     }
 
     /// Kind.
@@ -53,33 +59,39 @@ public struct SourceKittenDictionary {
     }
 
     /// Length.
-    var length: Int? {
-        return (value["key.length"] as? Int64).flatMap({ Int($0) })
+    var length: ByteCount? {
+        return (value["key.length"] as? Int64).map(ByteCount.init)
     }
     /// Name.
     var name: String? {
         return value["key.name"] as? String
     }
 
     /// Name length.
-    var nameLength: Int? {
-        return (value["key.namelength"] as? Int64).flatMap({ Int($0) })
+    var nameLength: ByteCount? {
+        return (value["key.namelength"] as? Int64).map(ByteCount.init)
     }
 
     /// Name offset.
-    var nameOffset: Int? {
-        return (value["key.nameoffset"] as? Int64).flatMap({ Int($0) })
+    var nameOffset: ByteCount? {
+        return (value["key.nameoffset"] as? Int64).map(ByteCount.init)
+    }
+
+    /// Byte range of name.
+    var nameByteRange: ByteRange? {
+        guard let offset = nameOffset, let length = nameLength else { return nil }
+        return ByteRange(location: offset, length: length)
     }
 
     /// Offset.
-    var offset: Int? {
-        return (value["key.offset"] as? Int64).flatMap({ Int($0) })
+    var offset: ByteCount? {
+        return (value["key.offset"] as? Int64).map(ByteCount.init)
     }
 
     /// Returns byte range starting from `offset` with `length` bytes
-    var byteRange: NSRange? {
+    var byteRange: ByteRange? {
         guard let offset = offset, let length = length else { return nil }
-        return NSRange(location: offset, length: length)
+        return ByteRange(location: offset, length: length)
     }
 
     /// Setter accessibility.
@@ -93,13 +105,13 @@ public struct SourceKittenDictionary {
     }
 
     /// Documentation offset.
-    var docOffset: Int? {
-        return (value["key.docoffset"] as? Int64).flatMap({ Int($0) })
+    var docOffset: ByteCount? {
+        return (value["key.docoffset"] as? Int64).flatMap(ByteCount.init)
     }
 
     /// Documentation length.
-    var docLength: Int? {
-        return (value["key.doclength"] as? Int64).flatMap({ Int($0) })
+    var docLength: ByteCount? {
+        return (value["key.doclength"] as? Int64).flatMap(ByteCount.init)
     }
 
     /// The attribute for this dictionary, as returned by SourceKit.

Source/SwiftLintFramework/Extensions/SourceKittenDictionary+Swiftlint.swift

@@ -1,4 +1,4 @@
-import Foundation
+import SourceKittenFramework
 
 extension SourceKittenDictionary {
     /// Returns array of tuples containing "key.kind" and "byteRange" from Structure
@@ -7,35 +7,32 @@ extension SourceKittenDictionary {
     /// - parameter byteOffset: Int?
     ///
     /// - returns: The kinds and byte ranges.
-    internal func kinds(forByteOffset byteOffset: Int? = nil)
-        -> [(kind: String, byteRange: NSRange)] {
-        var results = [(kind: String, byteRange: NSRange)]()
+    internal func kinds(forByteOffset byteOffset: ByteCount? = nil)
+        -> [(kind: String, byteRange: ByteRange)] {
+        var results = [(kind: String, byteRange: ByteRange)]()
 
         func parse(_ dictionary: SourceKittenDictionary) {
-            guard let offset = dictionary.offset,
-                let byteRange = dictionary.length.map({ NSRange(location: offset, length: $0) }) else {
-                    return
+            guard let range = dictionary.byteRange else {
+                return
             }
-            if let byteOffset = byteOffset, !NSLocationInRange(byteOffset, byteRange) {
+            if let byteOffset = byteOffset, !range.contains(byteOffset) {
                 return
             }
             if let kind = dictionary.kind {
-                results.append((kind: kind, byteRange: byteRange))
+                results.append((kind: kind, byteRange: range))
             }
             dictionary.substructure.forEach(parse)
         }
         parse(self)
         return results
     }
 
-    internal func structures(forByteOffset byteOffset: Int) -> [SourceKittenDictionary] {
+    internal func structures(forByteOffset byteOffset: ByteCount) -> [SourceKittenDictionary] {
         var results = [SourceKittenDictionary]()
 
         func parse(_ dictionary: SourceKittenDictionary) {
-            guard let offset = dictionary.offset,
-                let byteRange = dictionary.length.map({ NSRange(location: offset, length: $0) }),
-                NSLocationInRange(byteOffset, byteRange) else {
-                    return
+            guard let byteRange = dictionary.byteRange, byteRange.contains(byteOffset) else {
+                return
             }
 
             results.append(dictionary)

Source/SwiftLintFramework/Extensions/SwiftLintFile+Regex.swift

@@ -105,13 +105,11 @@ extension SwiftLintFile {
     internal func matchesAndTokens(matching pattern: String,
                                    range: NSRange? = nil) -> [(NSTextCheckingResult, [SwiftLintSyntaxToken])] {
         let contents = stringView
-        let range = range ?? stringView.range
+        let range = range ?? contents.range
         let syntax = syntaxMap
-        return regex(pattern).matches(in: contents, options: [], range: range).map { match in
-            let matchByteRange = contents.NSRangeToByteRange(start: match.range.location,
-                                                             length: match.range.length) ?? match.range
-            let tokensInRange = syntax.tokens(inByteRange: matchByteRange)
-            return (match, tokensInRange)
+        return regex(pattern).matches(in: contents, options: [], range: range).compactMap { match in
+            let matchByteRange = contents.NSRangeToByteRange(start: match.range.location, length: match.range.length)
+            return matchByteRange.map { (match, syntax.tokens(inByteRange: $0)) }
         }
     }
 
@@ -143,12 +141,11 @@ extension SwiftLintFile {
         var maybeLine = lineIterator.next()
         var maybeStructure = structureIterator.next()
         while let line = maybeLine, let structure = maybeStructure {
-            if NSLocationInRange(structure.byteRange.location, line.byteRange),
+            if line.byteRange.contains(structure.byteRange.location),
                let swiftDeclarationKind = SwiftDeclarationKind(rawValue: structure.kind) {
                 results[line.index].append(swiftDeclarationKind)
             }
-            let lineEnd = NSMaxRange(line.byteRange)
-            if structure.byteRange.location >= lineEnd {
+            if structure.byteRange.location >= line.byteRange.upperBound {
                 maybeLine = lineIterator.next()
             } else {
                 maybeStructure = structureIterator.next()
@@ -168,12 +165,12 @@ extension SwiftLintFile {
         var maybeToken = tokenGenerator.next()
         while let line = maybeLine, let token = maybeToken {
             let tokenRange = token.range
-            if NSLocationInRange(token.offset, line.byteRange) ||
-                NSLocationInRange(line.byteRange.location, tokenRange) {
+            if line.byteRange.contains(token.offset) ||
+                tokenRange.contains(line.byteRange.location) {
                     results[line.index].append(token)
             }
-            let tokenEnd = NSMaxRange(tokenRange)
-            let lineEnd = NSMaxRange(line.byteRange)
+            let tokenEnd = tokenRange.upperBound
+            let lineEnd = line.byteRange.upperBound
             if tokenEnd < lineEnd {
                 maybeToken = tokenGenerator.next()
             } else if tokenEnd > lineEnd {
@@ -337,6 +334,6 @@ extension SwiftLintFile {
     }
 
     internal func contents(for token: SwiftLintSyntaxToken) -> String? {
-        return stringView.substringWithByteRange(start: token.offset, length: token.length)
+        return stringView.substringWithByteRange(token.range)
     }
 }

Source/SwiftLintFramework/Helpers/NamespaceCollector.swift

@@ -4,7 +4,7 @@ struct NamespaceCollector {
     struct Element {
         let name: String
         let kind: SwiftDeclarationKind
-        let offset: Int
+        let offset: ByteCount
         let dictionary: SourceKittenDictionary
 
         init?(dictionary: SourceKittenDictionary, namespace: [String]) {

Source/SwiftLintFramework/Models/Location.swift

@@ -37,11 +37,11 @@ public struct Location: CustomStringConvertible, Comparable, Codable {
     }
 
     /// Creates a `Location` based on a `SwiftLintFile` and a byte-offset into the file.
-    /// Fails if tthe specified offset was not a valid location in the file.
+    /// Fails if the specified offset was not a valid location in the file.
     ///
     /// - parameter file:   The file for this location.
     /// - parameter offset: The offset in bytes into the file for this location.
-    public init(file: SwiftLintFile, byteOffset offset: Int) {
+    public init(file: SwiftLintFile, byteOffset offset: ByteCount) {
         self.file = file.path
         if let lineAndCharacter = file.stringView.lineAndCharacter(forByteOffset: offset) {
             line = lineAndCharacter.line

Source/SwiftLintFramework/Models/SwiftLintSyntaxMap.swift

@@ -1,4 +1,3 @@
-import Foundation
 import SourceKittenFramework
 
 /// Represents a Swift file's syntax information.
@@ -22,7 +21,7 @@ public struct SwiftLintSyntaxMap {
     /// - parameter byteRange: Byte-based NSRange.
     ///
     /// - returns: The array of syntax tokens intersecting with byte range.
-    internal func tokens(inByteRange byteRange: NSRange) -> [SwiftLintSyntaxToken] {
+    internal func tokens(inByteRange byteRange: ByteRange) -> [SwiftLintSyntaxToken] {
         func intersect(_ token: SwiftLintSyntaxToken) -> Bool {
             return token.range.intersects(byteRange)
         }
@@ -46,10 +45,10 @@ public struct SwiftLintSyntaxMap {
 
     /// Returns the syntax kinds in the specified byte range.
     ///
-    /// - parameter byteRange: Byte-based NSRange.
+    /// - parameter byteRange: Byte range.
     ///
     /// - returns: The syntax kinds in the specified byte range.
-    internal func kinds(inByteRange byteRange: NSRange) -> [SyntaxKind] {
+    internal func kinds(inByteRange byteRange: ByteRange) -> [SyntaxKind] {
         return tokens(inByteRange: byteRange).compactMap { $0.kind }
     }
 }

Source/SwiftLintFramework/Models/SwiftLintSyntaxToken.swift

@@ -1,4 +1,3 @@
-import Foundation
 import SourceKittenFramework
 
 /// A SwiftLint-aware Swift syntax token.
@@ -18,17 +17,17 @@ public struct SwiftLintSyntaxToken {
     }
 
     /// The byte range in a source file for this token.
-    public var range: NSRange {
-        return NSRange(location: value.offset, length: value.length)
+    public var range: ByteRange {
+        return value.range
     }
 
     /// The starting byte offset in a source file for this token.
-    public var offset: Int {
+    public var offset: ByteCount {
         return value.offset
     }
 
     /// The length in bytes for this token.
-    public var length: Int {
+    public var length: ByteCount {
         return value.length
     }
 }

Source/SwiftLintFramework/Models/SwiftVersion.swift

@@ -111,7 +111,8 @@ public extension SwiftVersion {
             let decl = file.structureDictionary.kinds()
                 .first(where: { $0.kind == SwiftDeclarationKind.varGlobal.rawValue }),
             let token = file.syntaxMap.tokens(inByteRange: decl.byteRange).first(where: { $0.kind == .string }) {
-            return .init(rawValue: file.contents.substring(from: token.offset + 1, length: token.length - 2))
+            let offsetRange = ByteRange(location: token.offset + 1, length: token.length - 2)
+            return .init(rawValue: file.stringView.substringWithByteRange(offsetRange)!)
         }
 
         return .three

Source/SwiftLintFramework/Protocols/CallPairRule.swift

@@ -36,7 +36,7 @@ extension CallPairRule {
         let stringView = file.stringView
         let dictionary = file.structureDictionary
 
-        let violatingLocations: [Int] = firstRanges.compactMap { range in
+        let violatingLocations: [ByteCount] = firstRanges.compactMap { range in
             guard let bodyByteRange = stringView.NSRangeToByteRange(start: range.location, length: range.length),
                 case let firstLocation = range.location + range.length - 1,
                 let firstByteRange = stringView.NSRangeToByteRange(start: firstLocation, length: 1) else {
@@ -63,18 +63,14 @@ extension CallPairRule {
         }
     }
 
-    private func methodCall(forByteOffset byteOffset: Int, excludingOffset: Int,
+    private func methodCall(forByteOffset byteOffset: ByteCount, excludingOffset: ByteCount,
                             dictionary: SourceKittenDictionary,
-                            predicate: (SourceKittenDictionary) -> Bool) -> Int? {
-        if dictionary.expressionKind == .call,
-            let bodyOffset = dictionary.offset,
-            let bodyLength = dictionary.length,
-            let offset = dictionary.offset {
-            let byteRange = NSRange(location: bodyOffset, length: bodyLength)
-
-            if NSLocationInRange(byteOffset, byteRange) &&
-                !NSLocationInRange(excludingOffset, byteRange) && predicate(dictionary) {
-                return offset
+                            predicate: (SourceKittenDictionary) -> Bool) -> ByteCount? {
+        if dictionary.expressionKind == .call, let byteRange = dictionary.byteRange {
+            if byteRange.contains(byteOffset) &&
+                !byteRange.contains(excludingOffset) &&
+                predicate(dictionary) {
+                return dictionary.offset
             }
         }
 

Source/SwiftLintFramework/Rules/Idiomatic/ConvenienceTypeRule.swift

@@ -97,9 +97,9 @@ public struct ConvenienceTypeRule: ASTRule, OptInRule, ConfigurationProviderRule
     private func isFunctionUnavailable(file: SwiftLintFile, dictionary: SourceKittenDictionary) -> Bool {
         return dictionary.swiftAttributes.contains { dict -> Bool in
             guard dict.attribute.flatMap(SwiftDeclarationAttributeKind.init(rawValue:)) == .available,
-                let offset = dict.offset, let length = dict.length,
-                let contents = file.stringView.substringWithByteRange(start: offset, length: length) else {
-                    return false
+                let contents = dict.byteRange.flatMap(file.stringView.substringWithByteRange)
+            else {
+                return false
             }
 
             return contents.contains("unavailable")