TouchInstinct
/
LeadKit
306
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

make cursors thread safe and add some tests

This commit is contained in:
Ivan Smolin 2017-03-30 18:13:42 +03:00
parent cb07c482d1
commit 908ea53d3e
8 changed files with 234 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
LeadKit/LeadKit.xcodeproj/project.pbxproj
View File

@ -14,6 +14,8 @@
67B3057D1E8A8735008169CA /* TestView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 67B3057C1E8A8735008169CA /* TestView.swift */; };
67B3057F1E8A8804008169CA /* LoadFromNibTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 67B3057E1E8A8804008169CA /* LoadFromNibTests.swift */; };
67B305841E8A92E8008169CA /* XibView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 67B305831E8A92E8008169CA /* XibView.swift */; };
67EF144C1E8BEACB00D6E0DD /* StubCursor.swift in Sources */ = {isa = PBXBuildFile; fileRef = 67EF144B1E8BEACB00D6E0DD /* StubCursor.swift */; };
67EF144E1E8BED4E00D6E0DD /* CursorTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 67EF144D1E8BED4E00D6E0DD /* CursorTests.swift */; };
78011A641D47ABC500EA16A2 /* UIView+DefaultReuseIdentifier.swift in Sources */ = {isa = PBXBuildFile; fileRef = 78011A631D47ABC500EA16A2 /* UIView+DefaultReuseIdentifier.swift */; };
78011AB31D48B53600EA16A2 /* ApiRequestParameters.swift in Sources */ = {isa = PBXBuildFile; fileRef = 78011AB21D48B53600EA16A2 /* ApiRequestParameters.swift */; };
780D23431DA412470084620D /* CGImage+Alpha.swift in Sources */ = {isa = PBXBuildFile; fileRef = 780D23421DA412470084620D /* CGImage+Alpha.swift */; };
@ -102,6 +104,8 @@
67B3057C1E8A8735008169CA /* TestView.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = TestView.swift; sourceTree = "<group>"; };
67B3057E1E8A8804008169CA /* LoadFromNibTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = LoadFromNibTests.swift; sourceTree = "<group>"; };
67B305831E8A92E8008169CA /* XibView.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = XibView.swift; sourceTree = "<group>"; };
67EF144B1E8BEACB00D6E0DD /* StubCursor.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = StubCursor.swift; sourceTree = "<group>"; };
67EF144D1E8BED4E00D6E0DD /* CursorTests.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = CursorTests.swift; sourceTree = "<group>"; };
78011A631D47ABC500EA16A2 /* UIView+DefaultReuseIdentifier.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "UIView+DefaultReuseIdentifier.swift"; sourceTree = "<group>"; };
78011AB21D48B53600EA16A2 /* ApiRequestParameters.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ApiRequestParameters.swift; sourceTree = "<group>"; };
780D23421DA412470084620D /* CGImage+Alpha.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = "CGImage+Alpha.swift"; sourceTree = "<group>"; };
@ -231,6 +235,14 @@
path = Views;
sourceTree = "<group>";
};
67EF144A1E8BEA9C00D6E0DD /* Cursors */ = {
isa = PBXGroup;
children = (
67EF144B1E8BEACB00D6E0DD /* StubCursor.swift */,
);
path = Cursors;
sourceTree = "<group>";
};
78011A651D47AF3000EA16A2 /* Enums */ = {
isa = PBXGroup;
children = (
@ -449,9 +461,11 @@
children = (
67B305791E8A8727008169CA /* Views */,
6727419E1E65BF3C0075836A /* Models */,
67EF144A1E8BEA9C00D6E0DD /* Cursors */,
78CFEE3B1C5C456B00F50370 /* Info.plist */,
6727419C1E65B99E0075836A /* MappableUserDefaultsTests.swift */,
67B3057E1E8A8804008169CA /* LoadFromNibTests.swift */,
67EF144D1E8BED4E00D6E0DD /* CursorTests.swift */,
);
path = LeadKitTests;
sourceTree = "<group>";
@ -910,6 +924,8 @@
buildActionMask = 2147483647;
files = (
67B3057D1E8A8735008169CA /* TestView.swift in Sources */,
67EF144E1E8BED4E00D6E0DD /* CursorTests.swift in Sources */,
67EF144C1E8BEACB00D6E0DD /* StubCursor.swift in Sources */,
67B3057F1E8A8804008169CA /* LoadFromNibTests.swift in Sources */,
6727419D1E65B99E0075836A /* MappableUserDefaultsTests.swift in Sources */,
672741A01E65C1E00075836A /* Post.swift in Sources */,

17
LeadKit/LeadKit/Classes/Cursors/FixedPageCursor.swift
View File

@ -31,6 +31,8 @@ public class FixedPageCursor<Cursor: CursorType>: CursorType where Cursor.LoadRe
private let pageSize: Int
private let semaphore = DispatchSemaphore(value: 1)
/// Initializer with enclosed cursor
///
/// - Parameters:
@ -52,7 +54,13 @@ public class FixedPageCursor<Cursor: CursorType>: CursorType where Cursor.LoadRe
}
public func loadNextBatch() -> Observable<LoadResultType> {
return loadNextBatch(withSemaphore: semaphore)
}
private func loadNextBatch(withSemaphore semaphore: DispatchSemaphore?) -> Observable<LoadResultType> {
return Observable.deferred {
semaphore?.wait()
if self.exhausted {
throw CursorError.exhausted
}
@ -67,8 +75,15 @@ public class FixedPageCursor<Cursor: CursorType>: CursorType where Cursor.LoadRe
}
return self.cursor.loadNextBatch()
.flatMap { _ in self.loadNextBatch() }
.flatMap { _ in
self.loadNextBatch(withSemaphore: nil)
}
}
.do(onNext: { [weak semaphore] _ in
semaphore?.signal()
}, onError: { [weak semaphore] _ in
semaphore?.signal()
})
}
}

19
LeadKit/LeadKit/Classes/Cursors/MapCursor.swift
View File

@ -49,6 +49,8 @@ public class MapCursor<Cursor: CursorType, T>: CursorType where Cursor.LoadResul
private var elements: [T] = []
private let semaphore = DispatchSemaphore(value: 1)
/// Initializer with enclosed cursor
///
/// - Parameters:
@ -72,12 +74,21 @@ public class MapCursor<Cursor: CursorType, T>: CursorType where Cursor.LoadResul
}
public func loadNextBatch() -> Observable<LoadResultType> {
return cursor.loadNextBatch().map { loadedRange in
let startIndex = self.elements.count
self.elements += self.cursor[loadedRange].flatMap(self.transform)
return Observable.deferred {
self.semaphore.wait()
return startIndex..<self.elements.count
return self.cursor.loadNextBatch().map { loadedRange in
let startIndex = self.elements.count
self.elements += self.cursor[loadedRange].flatMap(self.transform)
return startIndex..<self.elements.count
}
}
.do(onNext: { [weak semaphore] _ in
semaphore?.signal()
}, onError: { [weak semaphore] _ in
semaphore?.signal()
})
}
}

9
LeadKit/LeadKit/Classes/Cursors/StaticCursor.swift
View File

@ -29,6 +29,8 @@ public class StaticCursor<Element>: CursorType {
private let content: [Element]
private let semaphore = DispatchSemaphore(value: 1)
/// Initializer for array content type
///
/// - Parameter content: array with elements of Elemet type
@ -46,6 +48,8 @@ public class StaticCursor<Element>: CursorType {
public func loadNextBatch() -> Observable<LoadResultType> {
return Observable.deferred {
self.semaphore.wait()
if self.exhausted {
throw CursorError.exhausted
}
@ -56,6 +60,11 @@ public class StaticCursor<Element>: CursorType {
return Observable.just(0..<self.count)
}
.do(onNext: { [weak semaphore] _ in
semaphore?.signal()
}, onError: { [weak semaphore] _ in
semaphore?.signal()
})
}
}

88
LeadKit/LeadKitTests/CursorTests.swift Normal file
View File

@ -0,0 +1,88 @@
//
// CursorTests.swift
// LeadKit
//
// Created by Ivan Smolin on 29/03/2017.
// Copyright © 2017 Touch Instinct. All rights reserved.
//
import XCTest
import LeadKit
import RxSwift
class CursorTests: XCTestCase {
let disposeBag = DisposeBag()
override func setUp() {
super.setUp()
}
override func tearDown() {
super.tearDown()
}
func testStubCursor() {
let entityCursor = StubCursor()
let cursorExpectation = expectation(description: "Stub cursor expectation")
entityCursor.loadNextBatch()
.subscribe(onNext: { _ in
cursorExpectation.fulfill()
})
.addDisposableTo(disposeBag)
waitForExpectations(timeout: 10, handler: nil)
}
func testFixedPageCursor() {
let stubCursor = StubCursor(maxItemsCount: 15, requestDelay: .milliseconds(100))
let fixedPageCursor = FixedPageCursor(cursor: stubCursor, pageSize: 16)
let cursorExpectation = expectation(description: "Fixed page cursor expectation")
let cursorExpectationError = expectation(description: "Fixed page cursor error expectation")
fixedPageCursor.loadNextBatch()
.subscribe(onNext: { loadedRange in
XCTAssertEqual(fixedPageCursor[loadedRange].count, 15)
cursorExpectation.fulfill()
})
.addDisposableTo(disposeBag)
fixedPageCursor.loadNextBatch()
.subscribe(onNext: { _ in
XCTFail("Cursor should be exhausted!")
}, onError: { error in
switch try? cast(error) as CursorError {
case .exhausted?:
cursorExpectationError.fulfill()
default:
XCTFail("Cursor should be exhausted!")
}
})
.addDisposableTo(disposeBag)
waitForExpectations(timeout: 10, handler: nil)
}
func testMapCursorWithFixedPageCursor() {
let stubCursor = StubCursor(maxItemsCount: 16, requestDelay: .milliseconds(100))
let mapCursor = stubCursor.flatMap { $0.userId > 1 ? nil : $0 }
let fixedPageCursor = FixedPageCursor(cursor: mapCursor, pageSize: 20)
let cursorExpectation = expectation(description: "Fixed page cursor expectation")
fixedPageCursor.loadNextBatch()
.subscribe(onNext: { loadedRange in
XCTAssertEqual(fixedPageCursor[loadedRange].count, 8)
cursorExpectation.fulfill()
})
.addDisposableTo(disposeBag)
waitForExpectations(timeout: 10, handler: nil)
}
}

78
LeadKit/LeadKitTests/Cursors/StubCursor.swift Normal file
View File

@ -0,0 +1,78 @@
//
// Copyright (c) 2017 Touch Instinct
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the Software), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
//
import LeadKit
import RxSwift
class StubCursor: CursorType {
typealias LoadResultType = CountableRange<Int>
typealias Element = Post
private var posts: [Post] = []
private let maxItemsCount: Int
private let requestDelay: DispatchTimeInterval
var count: Int {
return posts.count
}
var exhausted: Bool {
return count >= maxItemsCount
}
subscript(index: Int) -> Post {
return posts[index]
}
init(maxItemsCount: Int = 12, requestDelay: DispatchTimeInterval = .seconds(2)) {
self.maxItemsCount = maxItemsCount
self.requestDelay = requestDelay
}
func loadNextBatch() -> Observable<CountableRange<Int>> {
return Observable.create { observer -> Disposable in
if self.exhausted {
observer.onError(CursorError.exhausted)
} else {
DispatchQueue.global().asyncAfter(deadline: .now() + self.requestDelay, execute: {
let countBefore = self.count
let newPosts = Post.generate()
let maxNewPosts = min(self.maxItemsCount, countBefore + newPosts.count)
self.posts = Array((self.posts + newPosts)[0..<maxNewPosts])
observer.onNext(countBefore..<self.count)
observer.onCompleted()
})
}
return Disposables.create()
}
}
}

7
LeadKit/LeadKitTests/MappableUserDefaultsTests.swift
View File

@ -30,12 +30,7 @@ class MappableUserDefaultsTests: XCTestCase {
return Post(userId: 1, postId: 1, title: "First post", body: "")
}()
lazy var posts: [Post] = {
return [Post(userId: 1, postId: 1, title: "First post", body: ""),
Post(userId: 1, postId: 2, title: "Second post", body: ""),
Post(userId: 2, postId: 3, title: "Third post", body: ""),
Post(userId: 2, postId: 4, title: "Forth post", body: "")]
}()
let posts = Post.generate()
let userDefaults = UserDefaults.standard

11
LeadKit/LeadKitTests/Models/Post.swift
View File

@ -62,3 +62,14 @@ extension Post: Equatable {
}
}
extension Post {
static func generate() -> [Post] {
return [Post(userId: 1, postId: 1, title: "First post", body: ""),
Post(userId: 1, postId: 2, title: "Second post", body: ""),
Post(userId: 2, postId: 3, title: "Third post", body: ""),
Post(userId: 2, postId: 4, title: "Forth post", body: "")]
}
}