Merge pull request #89 from hartbit/trivia-equatable-hashable

Make Trivia and TriviaPiece Equatable

Author: nkcsgexi

Sources/SwiftSyntax/Trivia.swift.gyb

@@ -109,6 +109,8 @@ public struct Trivia {
 % end
 }
 
+extension Trivia: Equatable {}
+
 /// Conformance for Trivia to the Collection protocol.
 extension Trivia: Collection {
   public var startIndex: Int {
@@ -141,6 +143,8 @@ public func +(lhs: Trivia, rhs: Trivia) -> Trivia {
   return Trivia(pieces: lhs.pieces + rhs.pieces)
 }
 
+extension TriviaPiece: Equatable {}
+
 extension TriviaPiece {
   public var sourceLength: SourceLength {
     switch self {

Tests/LinuxMain.swift

@@ -15,6 +15,7 @@ XCTMain({ () -> [XCTestCaseEntry] in
     testCase(SyntaxVisitorTestCase.allTests),
     testCase(TokenSyntaxTestCase.allTests),
     testCase(SyntaxTreeModifierTests.allTests),
+    testCase(TriviaTests.allTests),
   ]
   return testCases
 }())

Tests/SwiftSyntaxTest/TriviaTests.swift

@@ -0,0 +1,69 @@
+import XCTest
+import SwiftSyntax
+
+public class TriviaTestCase: XCTestCase {
+
+  public static let allTests = [
+    ("testTriviaEquatable", testTriviaEquatable),
+    ("testTriviaPieceEquatable", testTriviaPieceEquatable)
+  ]
+
+  func testTriviaEquatable() {
+    XCTAssertEqual([.spaces(2), .tabs(1)] as Trivia, [.spaces(2), .tabs(1)])
+    XCTAssertNotEqual([.spaces(2), .tabs(1)] as Trivia, [.spaces(2), .tabs(2)])
+    XCTAssertNotEqual([.spaces(5)] as Trivia, [.spaces(2), .spaces(3)])
+  }
+
+  func testTriviaPieceEquatable() {
+    XCTAssertEqual(TriviaPiece.spaces(1), .spaces(1))
+    XCTAssertNotEqual(TriviaPiece.spaces(2), .spaces(4))
+    XCTAssertNotEqual(TriviaPiece.spaces(2), .tabs(2))
+
+    XCTAssertEqual(TriviaPiece.tabs(2), .tabs(2))
+    XCTAssertNotEqual(TriviaPiece.tabs(1), .tabs(2))
+    XCTAssertNotEqual(TriviaPiece.tabs(1), .verticalTabs(1))
+
+    XCTAssertEqual(TriviaPiece.verticalTabs(3), .verticalTabs(3))
+    XCTAssertNotEqual(TriviaPiece.verticalTabs(5), .verticalTabs(1))
+    XCTAssertNotEqual(TriviaPiece.verticalTabs(5), .formfeeds(5))
+
+    XCTAssertEqual(TriviaPiece.formfeeds(2), .formfeeds(2))
+    XCTAssertNotEqual(TriviaPiece.formfeeds(1), .formfeeds(2))
+    XCTAssertNotEqual(TriviaPiece.formfeeds(1), .newlines(1))
+
+    XCTAssertEqual(TriviaPiece.newlines(3), .newlines(3))
+    XCTAssertNotEqual(TriviaPiece.newlines(2), .newlines(1))
+    XCTAssertNotEqual(TriviaPiece.newlines(2), .carriageReturns(2))
+
+    XCTAssertEqual(TriviaPiece.carriageReturns(2), .carriageReturns(2))
+    XCTAssertNotEqual(TriviaPiece.carriageReturns(1), .carriageReturns(3))
+    XCTAssertNotEqual(TriviaPiece.carriageReturns(1), .carriageReturnLineFeeds(3))
+
+    XCTAssertEqual(TriviaPiece.carriageReturnLineFeeds(3), .carriageReturnLineFeeds(3))
+    XCTAssertNotEqual(TriviaPiece.carriageReturnLineFeeds(4), .carriageReturnLineFeeds(2))
+
+    XCTAssertEqual(TriviaPiece.backticks(2), .backticks(2))
+    XCTAssertNotEqual(TriviaPiece.backticks(3), .backticks(4))
+    XCTAssertNotEqual(TriviaPiece.backticks(3), .spaces(3))
+
+    XCTAssertEqual(TriviaPiece.lineComment("a"), .lineComment("a"))
+    XCTAssertNotEqual(TriviaPiece.lineComment("a"), .lineComment("b"))
+    XCTAssertNotEqual(TriviaPiece.lineComment("a"), .blockComment("a"))
+
+    XCTAssertEqual(TriviaPiece.blockComment("b"), .blockComment("b"))
+    XCTAssertNotEqual(TriviaPiece.blockComment("b"), .blockComment("c"))
+    XCTAssertNotEqual(TriviaPiece.blockComment("b"), .docLineComment("b"))
+
+    XCTAssertEqual(TriviaPiece.docLineComment("c"), .docLineComment("c"))
+    XCTAssertNotEqual(TriviaPiece.docLineComment("c"), .docLineComment("d"))
+    XCTAssertNotEqual(TriviaPiece.docLineComment("c"), .docBlockComment("c"))
+
+    XCTAssertEqual(TriviaPiece.docBlockComment("d"), .docBlockComment("d"))
+    XCTAssertNotEqual(TriviaPiece.docBlockComment("d"), .docBlockComment("e"))
+    XCTAssertNotEqual(TriviaPiece.docBlockComment("d"), .garbageText("d"))
+
+    XCTAssertEqual(TriviaPiece.garbageText("e"), .garbageText("e"))
+    XCTAssertNotEqual(TriviaPiece.garbageText("e"), .garbageText("f"))
+    XCTAssertNotEqual(TriviaPiece.garbageText("e"), .lineComment("e"))
+  }
+}