updates/tests detectShortlink method (#1971)

* updates/tests detectShortlink

* Updates Int character check

* deleted redundant Unit Tests

Author: BrianLitwin

Classes/Issues/Comments/Markdown/String+DetectShortlink.swift

@@ -16,7 +16,7 @@ extension NSRange {
     }
 }
 
-private let regex = try! NSRegularExpression(pattern: "(^|\\s)((\\w+)/(\\w+))?#([0-9]+)", options: [])
+private let regex = try! NSRegularExpression(pattern: "(^|\\s|[^a-zA-Z])((\\w+)/(\\w+))?#([0-9]+)([^a-zA-Z0-9]|$)", options: [])
 extension String {
     func detectAndHandleShortlink(owner: String, repo: String, builder: StyledTextBuilder) {
         let matches = regex.matches(in: self, options: [], range: nsrange)
@@ -59,6 +59,13 @@ extension String {
                     )
                     ])
                 .restore()
+            
+            //if match's trailing character is not a number, include that
+            if let right = substring(with: NSRange(location: match.range.right - 1, length: 1)) {
+                if Int(right) == nil {
+                    builder.add(text: right)
+                }
+            }
 
             currentRight = match.range.right
         }

FreetimeTests/DetectShortlinkTests.swift

@@ -0,0 +1,133 @@
+//
+//  DetectShortlinkTests.swift
+//  FreetimeTests
+//
+//  Created by B_Litwin on 7/22/18.
+//  Copyright © 2018 Ryan Nystrom. All rights reserved.
+//
+import XCTest
+@testable import Freetime
+import StyledTextKit
+
+class DetectShortlinkTests: XCTestCase {
+    // Test the String method detectAndHandleShortlink()
+    
+    func setupBuilder(with text: String) -> StyledTextString {
+        let builder = StyledTextBuilder(text: "")
+        text.detectAndHandleShortlink(
+            owner: "rnystrom",
+            repo: "GitHawk",
+            builder: builder
+        )
+        return builder.build()
+    }
+    
+    func checkForIssueLink(_ styledTexts: [StyledText]) -> (linkText: String, issueNumber: Int)? {
+        // scanning for a styledText unit that has been formatted with blue font and
+        // contains an Issue MarkdownAttribute
+        for styledText in styledTexts {
+            let style = styledText.style
+            guard style.attributes[.foregroundColor] != nil,
+                style.attributes[MarkdownAttribute.issue] != nil else { continue }
+            let correctTextColor = style.attributes[.foregroundColor] as! UIColor == Styles.Colors.Blue.medium.color
+            if correctTextColor {
+                if case let .text(text) = styledText.storage {
+                    let issueModel = style.attributes[MarkdownAttribute.issue] as! IssueDetailsModel
+                    let issueNumber = issueModel.number
+                    return (text, issueNumber)
+                }
+            }
+        }
+        return nil
+    }
+    
+    
+    func test_positiveMatches() {
+        // test 4 things:
+        // 1) for positive text match
+        // 2) that the correct text is blue/linked (eg the parentheses aren't blue also)
+        // 3) that the MarkdownIssue is linked correctly with an issue number
+        // 4) that the string displayed after reformatting == the original string
+        
+        var testString = "#1234"
+        var builder: StyledTextString = setupBuilder(with: testString)
+        var containsLink = checkForIssueLink(builder.styledTexts)!
+        XCTAssertEqual(containsLink.linkText, "#1234")
+        XCTAssertEqual(containsLink.issueNumber, 1234)
+        XCTAssertEqual(builder.allText, testString)
+        
+        testString = "with a space preceding #1235"
+        builder = setupBuilder(with: testString)
+        containsLink = checkForIssueLink(builder.styledTexts)!
+        XCTAssertEqual(containsLink.linkText, "#1235")
+        XCTAssertEqual(containsLink.issueNumber, 1235)
+        XCTAssertEqual(builder.allText, testString)
+        
+        testString = "with a newline preceding \n#345"
+        builder = setupBuilder(with: testString)
+        containsLink = checkForIssueLink(builder.styledTexts)!
+        XCTAssertEqual(containsLink.linkText, "#345")
+        XCTAssertEqual(containsLink.issueNumber, 345)
+        XCTAssertEqual(builder.allText, testString)
+        
+        testString = "embedded in parentheses (#1900)"
+        builder = setupBuilder(with: testString)
+        containsLink = checkForIssueLink(builder.styledTexts)!
+        XCTAssertEqual(containsLink.linkText, "#1900")
+        XCTAssertEqual(containsLink.issueNumber, 1900)
+        XCTAssertEqual(builder.allText, testString)
+        
+        testString = "with owner and repo preceding rnystrom/githawk#4321"
+        builder = setupBuilder(with: testString)
+        containsLink = checkForIssueLink(builder.styledTexts)!
+        XCTAssertEqual(containsLink.linkText, "rnystrom/githawk#4321")
+        XCTAssertEqual(containsLink.issueNumber, 4321)
+        XCTAssertEqual(builder.allText, testString)
+        
+        testString = "Fixes (#1"
+        builder = setupBuilder(with: testString)
+        containsLink = checkForIssueLink(builder.styledTexts)!
+        XCTAssertEqual(containsLink.linkText, "#1")
+        XCTAssertEqual(containsLink.issueNumber, 1)
+        XCTAssertEqual(builder.allText, testString)
+        
+        testString = "Fixes #12)"
+        builder = setupBuilder(with: testString)
+        containsLink = checkForIssueLink(builder.styledTexts)!
+        XCTAssertEqual(containsLink.linkText, "#12")
+        XCTAssertEqual(containsLink.issueNumber, 12)
+        XCTAssertEqual(builder.allText, testString)
+        
+        testString = "Fixes(#432)"
+        builder = setupBuilder(with: testString)
+        containsLink = checkForIssueLink(builder.styledTexts)!
+        XCTAssertEqual(containsLink.linkText, "#432")
+        XCTAssertEqual(containsLink.issueNumber, 432)
+        XCTAssertEqual(builder.allText, testString)
+
+        testString = "!#4 yada yada"
+        builder = setupBuilder(with: testString)
+        containsLink = checkForIssueLink(builder.styledTexts)!
+        XCTAssertEqual(containsLink.linkText, "#4")
+        XCTAssertEqual(containsLink.issueNumber, 4)
+        XCTAssertEqual(builder.allText, testString)
+    }
+    
+    func test_negativeMatches() {
+        var builder = setupBuilder(with: "!1234")
+        var containsLink = checkForIssueLink(builder.styledTexts)
+        XCTAssertNil(containsLink)
+        
+        builder = setupBuilder(with: "imo the best pr so far is prob # 1906")
+        containsLink = checkForIssueLink(builder.styledTexts)
+        XCTAssertNil(containsLink)
+        
+        builder = setupBuilder(with: "#123F")
+        containsLink = checkForIssueLink(builder.styledTexts)
+        XCTAssertNil(containsLink)
+        
+        builder = setupBuilder(with: "f#123")
+        containsLink = checkForIssueLink(builder.styledTexts)
+        XCTAssertNil(containsLink)
+    }
+}