summaryrefslogtreecommitdiff
path: root/SoraTests/ViewDerivedDataTests.swift
blob: d8760e7f374d1ea94614a6d9545c5b23aae13842 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
import XCTest

final class ViewDerivedDataTests: XCTestCase {
  func testGenericListViewDerivedCollectionsAreReferencedOncePerRenderPass() throws {
    let source = try loadSource(at: "Sora/Views/Generic/GenericListView.swift")
    let normalizedSource = strippingCommentsAndStrings(from: source)

    let filteredItemsUsages = referenceCount(
      for: "filteredItems",
      in: normalizedSource
    )
    let sortedFilteredItemsUsages = referenceCount(
      for: "sortedFilteredItems",
      in: normalizedSource
    )

    // swiftlint:disable:next prefer_nimble
    XCTAssertLessThanOrEqual(
      filteredItemsUsages,
      1,
      "filteredItems should be consumed once per dependency change."
    )
    // swiftlint:disable:next prefer_nimble
    XCTAssertLessThanOrEqual(
      sortedFilteredItemsUsages,
      1,
      "sortedFilteredItems should be consumed once per dependency change."
    )
  }

  func testPostGridViewDerivedCollectionsAreReferencedOncePerRenderPass() throws {
    let source = try loadSource(at: "Sora/Views/Post/Grid/PostGridView.swift")
    let normalizedSource = strippingCommentsAndStrings(from: source)

    let activePostsUsages = referenceCount(
      for: "activePosts",
      in: normalizedSource
    )
    let getColumnsDataUsages = invocationCount(
      forFunction: "getColumnsData",
      in: normalizedSource
    )

    // swiftlint:disable:next prefer_nimble
    XCTAssertLessThanOrEqual(
      activePostsUsages,
      1,
      "activePosts-derived data should be consumed once per dependency change."
    )
    // swiftlint:disable:next prefer_nimble
    XCTAssertLessThanOrEqual(
      getColumnsDataUsages,
      1,
      "getColumnsData should be invoked once per dependency change."
    )
  }

  func testFavoritesViewDerivedCollectionsAreReferencedOncePerRenderPass() throws {
    let source = try loadSource(at: "Sora/Views/FavoritesView.swift")
    let normalizedSource = strippingCommentsAndStrings(from: source)

    let filteredFavoritesUsages = referenceCount(
      for: "filteredFavorites",
      in: normalizedSource
    )
    let sortedFilteredFavoritesUsages = referenceCount(
      for: "sortedFilteredFavorites",
      in: normalizedSource
    )
    let inlinePostMappingCount = tokenCount(
      matching: #"\bsortedFilteredFavorites\s*\.\s*map\s*\{"#,
      in: normalizedSource
    )
    let columnsSplitterUsages = invocationCount(
      forFunction: "getColumnsData",
      in: normalizedSource
    )

    // swiftlint:disable:next prefer_nimble
    XCTAssertLessThanOrEqual(
      filteredFavoritesUsages,
      1,
      "filteredFavorites should be consumed once per dependency change."
    )
    // swiftlint:disable:next prefer_nimble
    XCTAssertLessThanOrEqual(
      sortedFilteredFavoritesUsages,
      1,
      "sortedFilteredFavorites should be consumed once per dependency change."
    )
    // swiftlint:disable:next prefer_nimble
    XCTAssertEqual(
      inlinePostMappingCount,
      0,
      "Favorites grid should not remap sorted favorites to posts inline on each cell render."
    )
    // swiftlint:disable:next prefer_nimble
    XCTAssertLessThanOrEqual(
      columnsSplitterUsages,
      1,
      "Favorites grid column distribution should be derived once per dependency change."
    )
  }

  func testFolderMenuHierarchyIsSharedAcrossConsumers() throws {
    let consumerPaths = [
      "Sora/Views/Generic/GenericListView.swift",
      "Sora/Views/FavoritesView.swift",
      "Sora/Views/Post/Grid/PostGridView.swift",
      "Sora/Views/BookmarkMenuButtonView.swift",
      "Sora/Views/FavoriteMenuButtonView.swift",
    ]

    for consumerPath in consumerPaths {
      let source = try loadSource(at: consumerPath)
      let sharedMenuUsages = tokenCount(
        matching: #"\bFolderMenuView\s*\("#,
        in: source
      )

      // swiftlint:disable:next prefer_nimble
      XCTAssertGreaterThan(
        sharedMenuUsages,
        0,
        "\(consumerPath) should use FolderMenuView for folder hierarchy rendering."
      )
    }
  }

  func testSearchSuggestionsCacheIsBuiltFromItemsChanges() throws {
    let source = try loadSource(at: "Sora/Views/SearchSuggestionsView.swift")
    let normalizedSource = strippingCommentsAndStrings(from: source)

    let stateCacheCount = tokenCount(
      matching: #"\@State\s+private\s+var\s+cachedTags"#,
      in: normalizedSource
    )
    let itemsMapCount = tokenCount(
      matching: #"\bcachedTags\s*=\s*items\s*\.\s*map"#,
      in: normalizedSource
    )
    let itemsChangeObserverCount = tokenCount(
      matching: #"\.onChange\s*\(\s*of:\s*itemsCacheKey\s*\)"#,
      in: normalizedSource
    )

    // swiftlint:disable:next prefer_nimble
    XCTAssertGreaterThan(
      stateCacheCount,
      0,
      "Search suggestions should keep preprocessed tags in view state."
    )
    // swiftlint:disable:next prefer_nimble
    XCTAssertGreaterThan(
      itemsMapCount,
      0,
      "Search suggestions should build cached tags from items."
    )
    // swiftlint:disable:next prefer_nimble
    XCTAssertGreaterThan(
      itemsChangeObserverCount,
      0,
      "Search suggestions should refresh cached tags only when items change."
    )
  }

  func testPostDetailsImageActionsUseAsyncCachedImageLoading() throws {
    let source = try loadSource(at: "Sora/Views/Post/Details/PostDetailsImageView.swift")
    let normalizedSource = strippingCommentsAndStrings(from: source)

    let synchronousLoadCount = tokenCount(
      matching: #"\bNSData\s*\(\s*contentsOf:"#,
      in: normalizedSource
    )
    let cachedLoaderCount = tokenCount(
      matching: #"\bImageCacheManager\s*\.\s*shared\s*\.\s*loadImageData\s*\("#,
      in: normalizedSource
    )

    // swiftlint:disable:next prefer_nimble
    XCTAssertEqual(
      synchronousLoadCount,
      0,
      "Post details image actions should avoid synchronous NSData file or network loads."
    )
    // swiftlint:disable:next prefer_nimble
    XCTAssertGreaterThan(
      cachedLoaderCount,
      0,
      "Post details image actions should use cache-backed async image loading."
    )
  }

  func testListViewsAvoidComparatorRandomShuffleSorting() throws {
    let listViewSource = try loadSource(at: "Sora/Views/Generic/GenericListView.swift")
    let favoritesViewSource = try loadSource(at: "Sora/Views/FavoritesView.swift")
    let normalizedListViewSource = strippingCommentsAndStrings(from: listViewSource)
    let normalizedFavoritesViewSource = strippingCommentsAndStrings(from: favoritesViewSource)

    let listViewComparatorRandomCount = tokenCount(
      matching: #"\bBool\s*\.\s*random\s*\("#,
      in: normalizedListViewSource
    )
    let favoritesViewComparatorRandomCount = tokenCount(
      matching: #"\bBool\s*\.\s*random\s*\("#,
      in: normalizedFavoritesViewSource
    )

    // swiftlint:disable:next prefer_nimble
    XCTAssertEqual(
      listViewComparatorRandomCount,
      0,
      "Generic list sorting should not use comparator-based random ordering."
    )
    // swiftlint:disable:next prefer_nimble
    XCTAssertEqual(
      favoritesViewComparatorRandomCount,
      0,
      "Favorites sorting should not use comparator-based random ordering."
    )
  }

  func testBooruManagerRemovesUnusedXMLParserPoolPaths() throws {
    let source = try loadSource(at: "Sora/Data/Booru/BooruManager.swift")
    let normalizedSource = strippingCommentsAndStrings(from: source)

    let poolStorageCount = tokenCount(
      matching: #"\bxmlParserPool\b"#,
      in: normalizedSource
    )
    let lockStorageCount = tokenCount(
      matching: #"\bparserPoolLock\b"#,
      in: normalizedSource
    )
    let parserFactoryCount = invocationCount(
      forFunction: "xmlParser",
      in: normalizedSource
    )
    let parserReturnCount = invocationCount(
      forFunction: "returnXMLParser",
      in: normalizedSource
    )

    // swiftlint:disable:next prefer_nimble
    XCTAssertEqual(
      poolStorageCount,
      0,
      "BooruManager should not keep an unused XML parser pool."
    )
    // swiftlint:disable:next prefer_nimble
    XCTAssertEqual(
      lockStorageCount,
      0,
      "BooruManager should not keep an unused parser pool lock."
    )
    // swiftlint:disable:next prefer_nimble
    XCTAssertEqual(
      parserFactoryCount,
      0,
      "BooruManager should not expose unused xml parser factory paths."
    )
    // swiftlint:disable:next prefer_nimble
    XCTAssertEqual(
      parserReturnCount,
      0,
      "BooruManager should not expose unused xml parser return paths."
    )
  }

  private func referenceCount(for symbol: String, in source: String) -> Int {
    let totalMatches = tokenCount(
      matching: #"\b\#(symbol)\b"#,
      in: source
    )
    let declarationMatches = tokenCount(
      matching: #"\b(?:var|let)\s+\#(symbol)\b"#,
      in: source
    )

    return max(0, totalMatches - declarationMatches)
  }

  private func invocationCount(forFunction name: String, in source: String) -> Int {
    let totalMatches = tokenCount(
      matching: #"\b\#(name)\s*\("#,
      in: source
    )
    let declarationMatches = tokenCount(
      matching: #"\bfunc\s+\#(name)\s*\("#,
      in: source
    )

    return max(0, totalMatches - declarationMatches)
  }
}