-
Notifications
You must be signed in to change notification settings - Fork 42
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of github.com:spotify/Mobius.swift into connect…
…able-map
- Loading branch information
Showing
3 changed files
with
201 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| // Copyright (c) 2020 Spotify AB. | ||
| // | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| import MobiusCore | ||
|
|
||
| public extension Mobius { | ||
|
|
||
| /// A simplified version of `Mobius.loop` for use in tutorials. | ||
| /// | ||
| /// This helper simplifies setting up a loop with no effects. | ||
| /// | ||
| /// - Parameter update: A function taking a model and event and returning a new model. | ||
| @inlinable | ||
| static func beginnerLoop<Model, Event>( | ||
| update: @escaping (Model, Event) -> Model | ||
| ) -> Builder<Model, Event, Never> { | ||
| let realUpdate = Update<Model, Event, Never> { model, event in | ||
| return .next(update(model, event)) | ||
| } | ||
|
|
||
| let effectHandler = AnyConnectable<Never, Event> { _ in | ||
| return Connection( | ||
| acceptClosure: { _ in }, | ||
| disposeClosure: {} | ||
| ) | ||
| } | ||
| return loop(update: realUpdate, effectHandler: effectHandler) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| // Copyright (c) 2020 Spotify AB. | ||
| // | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| import MobiusCore | ||
| import MobiusExtras | ||
| import XCTest | ||
|
|
||
| /// Test cases that reproduce the Getting Started section of the GitHub wiki | ||
| class WikiTutorialTest: XCTestCase { | ||
| // swiftlint:disable function_body_length | ||
|
|
||
| func testWikiCreatingALoop() { | ||
| // Dummy implementation of print() | ||
| var printedValues: [String] = [] | ||
| func print(_ value: Any) { | ||
| printedValues.append(String(describing: value)) | ||
| } | ||
|
|
||
| // ---8<--- Wiki content start | ||
| enum MyEvent { | ||
| case up | ||
| case down | ||
| } | ||
|
|
||
| func update(counter: Int, event: MyEvent) -> Int { | ||
| switch event { | ||
| case .up: | ||
| return counter + 1 | ||
| case .down: | ||
| return counter > 0 | ||
| ? counter - 1 | ||
| : counter | ||
| } | ||
| } | ||
|
|
||
| let loop = Mobius.beginnerLoop(update: update) | ||
| .start(from: 2) | ||
|
|
||
| loop.addObserver { counter in print(counter) } | ||
|
|
||
| loop.dispatchEvent(.down) // prints "1" | ||
| loop.dispatchEvent(.down) // prints "0" | ||
| loop.dispatchEvent(.down) // prints "0" | ||
| loop.dispatchEvent(.up) // prints "1" | ||
| loop.dispatchEvent(.up) // prints "2" | ||
| loop.dispatchEvent(.down) // prints "1" | ||
|
|
||
| loop.dispose() | ||
| // ---8<--- Wiki content end | ||
|
|
||
| XCTAssertEqual(printedValues, ["2", "1", "0", "0", "1", "2", "1"]) | ||
| } | ||
|
|
||
| func testWikiCreatingALoop_addingEffects() { | ||
| // Dummy implementation of print() | ||
| var printedValues: [String] = [] | ||
| func print(_ value: Any) { | ||
| printedValues.append(String(describing: value)) | ||
| } | ||
|
|
||
| // Carried over from previous example | ||
| enum MyEvent { | ||
| case up | ||
| case down | ||
| } | ||
|
|
||
| // ---8<--- Wiki content start | ||
| enum MyEffect { | ||
| case reportErrorNegative | ||
| } | ||
|
|
||
| func update1(model: Int, event: MyEvent) -> Next<Int, MyEffect> { | ||
| switch event { | ||
| case .up: | ||
| return .next(model + 1) | ||
| case .down: | ||
| return model > 0 | ||
| ? .next(model - 1) | ||
| : .next(model) | ||
| } | ||
| } | ||
|
|
||
| func update2(model: Int, event: MyEvent) -> Next<Int, MyEffect> { | ||
| switch event { | ||
| case .up: | ||
| return .next(model + 1) | ||
| case .down: | ||
| return model > 0 | ||
| ? .next(model - 1) | ||
| : .next(model, effects: [.reportErrorNegative]) | ||
| } | ||
| } | ||
|
|
||
| func update(model: Int, event: MyEvent) -> Next<Int, MyEffect> { | ||
| switch event { | ||
| case .up: | ||
| return .next(model + 1) | ||
| case .down: | ||
| return model > 0 | ||
| ? .next(model - 1) | ||
| : .dispatchEffects([.reportErrorNegative]) | ||
| } | ||
| } | ||
|
|
||
| func handleReportErrorNegative() { | ||
| print("error!") | ||
| } | ||
|
|
||
| let effectHandler = EffectRouter<MyEffect, MyEvent>() | ||
| .routeCase(MyEffect.reportErrorNegative).to(handleReportErrorNegative) | ||
| .asConnectable | ||
|
|
||
| let loop = Mobius.loop(update: update, effectHandler: effectHandler) | ||
| .start(from: 2) | ||
|
|
||
| loop.addObserver { counter in print(counter) } | ||
|
|
||
| loop.dispatchEvent(.down) // prints "1" | ||
| loop.dispatchEvent(.down) // prints "0" | ||
| loop.dispatchEvent(.down) // followed by "error!" | ||
| loop.dispatchEvent(.up) // prints "1" | ||
| loop.dispatchEvent(.up) // prints "2" | ||
| loop.dispatchEvent(.down) // prints "1" | ||
|
|
||
| loop.dispose() | ||
| // ---8<--- Wiki content end | ||
|
|
||
| XCTAssertEqual(printedValues, ["2", "1", "0", "error!", "1", "2", "1"]) | ||
| } | ||
| } |