Skip to content

Commit 77ff1e3

Browse files
aaronbrethorstaaronbrethorst
authoredAug 28, 2024··
Merge pull request #65 from OneBusAway/add-custom-region-onboarding
Add onboarding for otpkitdemo
2 parents c724fa5 + a36551e commit 77ff1e3

File tree

7 files changed

+170
-42
lines changed

7 files changed

+170
-42
lines changed
 

‎.github/pull_request_template.md

+7-12
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,17 @@
11
## Description
2-
3-
Please include a summary of the changes and the related issue. Please also include relevant motivation and context.
2+
(Please include a summary of the changes and the related issue. Please also include relevant motivation and context.)
43

54
## Related Issues
6-
7-
Mention your issue by typing the issue number: #(issue number)
5+
(Mention your issue by typing the issue number: #(issue number))
86

97
## Media
10-
11-
Please include the media if applicable. For UI changes, it is recommended to provide screen record or screenshots
8+
(Please include the media if applicable. For UI changes, it is recommended to provide screen record or screenshots)
129

1310
## Test Instructions
11+
(Please describe the tests that you ran to verify your changes. Provide instructions so others can reproduce.)
1412

15-
Please describe the tests that you ran to verify your changes. Provide instructions so others can reproduce.
16-
17-
1. Test A
18-
2. Test B
13+
1. (Test A)
14+
2. (Test B)
1915

2016
## Additional Context
21-
22-
Add any other context about the pull request here.
17+
(Add any other context about the pull request here.)

‎Examples/OTPKitDemo/OTPKitDemo.xcodeproj/project.pbxproj

+30
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
/* Begin PBXBuildFile section */
1010
0111FD712C6CFBE400B4472E /* OTPKit in Frameworks */ = {isa = PBXBuildFile; productRef = 0111FD702C6CFBE400B4472E /* OTPKit */; };
1111
014316DF2C6B6F2C00B33240 /* OTPKit in Frameworks */ = {isa = PBXBuildFile; productRef = 014316DE2C6B6F2C00B33240 /* OTPKit */; };
12+
015364702C7E93BE00146182 /* OnboardingView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 0153646F2C7E93BE00146182 /* OnboardingView.swift */; };
1213
01AA23162C758E62008F484E /* LaunchScreen.storyboard in Resources */ = {isa = PBXBuildFile; fileRef = 01AA23152C758E62008F484E /* LaunchScreen.storyboard */; };
1314
01AA80542C6B6A7500D4038A /* OTPKitDemoApp.swift in Sources */ = {isa = PBXBuildFile; fileRef = 01AA80532C6B6A7500D4038A /* OTPKitDemoApp.swift */; };
1415
01AA80562C6B6A7500D4038A /* MapView.swift in Sources */ = {isa = PBXBuildFile; fileRef = 01AA80552C6B6A7500D4038A /* MapView.swift */; };
@@ -18,6 +19,7 @@
1819

1920
/* Begin PBXFileReference section */
2021
014316E02C6B713D00B33240 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist; path = Info.plist; sourceTree = "<group>"; };
22+
0153646F2C7E93BE00146182 /* OnboardingView.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OnboardingView.swift; sourceTree = "<group>"; };
2123
01AA23152C758E62008F484E /* LaunchScreen.storyboard */ = {isa = PBXFileReference; lastKnownFileType = file.storyboard; path = LaunchScreen.storyboard; sourceTree = "<group>"; };
2224
01AA80502C6B6A7500D4038A /* OTPKitDemo.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = OTPKitDemo.app; sourceTree = BUILT_PRODUCTS_DIR; };
2325
01AA80532C6B6A7500D4038A /* OTPKitDemoApp.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = OTPKitDemoApp.swift; sourceTree = "<group>"; };
@@ -62,6 +64,7 @@
6264
014316E02C6B713D00B33240 /* Info.plist */,
6365
01AA80532C6B6A7500D4038A /* OTPKitDemoApp.swift */,
6466
01AA80552C6B6A7500D4038A /* MapView.swift */,
67+
0153646F2C7E93BE00146182 /* OnboardingView.swift */,
6568
01AA80572C6B6A7600D4038A /* Assets.xcassets */,
6669
01AA80592C6B6A7600D4038A /* Preview Content */,
6770
);
@@ -86,6 +89,7 @@
8689
01AA804C2C6B6A7500D4038A /* Sources */,
8790
01AA804D2C6B6A7500D4038A /* Frameworks */,
8891
01AA804E2C6B6A7500D4038A /* Resources */,
92+
933C43692C7EC6B600DEB5B7 /* SwiftLint */,
8993
);
9094
buildRules = (
9195
);
@@ -149,11 +153,35 @@
149153
};
150154
/* End PBXResourcesBuildPhase section */
151155

156+
/* Begin PBXShellScriptBuildPhase section */
157+
933C43692C7EC6B600DEB5B7 /* SwiftLint */ = {
158+
isa = PBXShellScriptBuildPhase;
159+
alwaysOutOfDate = 1;
160+
buildActionMask = 2147483647;
161+
files = (
162+
);
163+
inputFileListPaths = (
164+
);
165+
inputPaths = (
166+
);
167+
name = SwiftLint;
168+
outputFileListPaths = (
169+
);
170+
outputPaths = (
171+
);
172+
runOnlyForDeploymentPostprocessing = 0;
173+
shellPath = /bin/sh;
174+
shellScript = "if [[ \"$(uname -m)\" == arm64 ]]; then\n export PATH=\"/opt/homebrew/bin:$PATH\"\nfi\n\nif which swiftlint > /dev/null; then\n swiftlint\nelse\n echo \"warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint\"\nfi\n";
175+
showEnvVarsInLog = 0;
176+
};
177+
/* End PBXShellScriptBuildPhase section */
178+
152179
/* Begin PBXSourcesBuildPhase section */
153180
01AA804C2C6B6A7500D4038A /* Sources */ = {
154181
isa = PBXSourcesBuildPhase;
155182
buildActionMask = 2147483647;
156183
files = (
184+
015364702C7E93BE00146182 /* OnboardingView.swift in Sources */,
157185
01AA80562C6B6A7500D4038A /* MapView.swift in Sources */,
158186
01AA80542C6B6A7500D4038A /* OTPKitDemoApp.swift in Sources */,
159187
);
@@ -291,6 +319,7 @@
291319
DEVELOPMENT_ASSET_PATHS = "\"OTPKitDemo/Preview Content\"";
292320
DEVELOPMENT_TEAM = 4ZQCMA634J;
293321
ENABLE_PREVIEWS = YES;
322+
ENABLE_USER_SCRIPT_SANDBOXING = NO;
294323
GENERATE_INFOPLIST_FILE = YES;
295324
INFOPLIST_FILE = OTPKitDemo/Info.plist;
296325
INFOPLIST_KEY_CFBundleDisplayName = "OTPKit Demo";
@@ -324,6 +353,7 @@
324353
DEVELOPMENT_ASSET_PATHS = "\"OTPKitDemo/Preview Content\"";
325354
DEVELOPMENT_TEAM = 4ZQCMA634J;
326355
ENABLE_PREVIEWS = YES;
356+
ENABLE_USER_SCRIPT_SANDBOXING = NO;
327357
GENERATE_INFOPLIST_FILE = YES;
328358
INFOPLIST_FILE = OTPKitDemo/Info.plist;
329359
INFOPLIST_KEY_CFBundleDisplayName = "OTPKit Demo";

‎Examples/OTPKitDemo/OTPKitDemo/MapView.swift

+14-17
Original file line numberDiff line numberDiff line change
@@ -13,28 +13,25 @@ struct MapView: View {
1313
@Environment(TripPlannerService.self) private var tripPlanner
1414

1515
var body: some View {
16-
TripPlannerExtensionView {
17-
Map(position: tripPlanner.currentCameraPositionBinding, interactionModes: .all) {
18-
tripPlanner.generateMarkers()
19-
tripPlanner.generateMapPolyline()
20-
.stroke(.blue, lineWidth: 5)
21-
}
22-
.mapControls {
23-
if !tripPlanner.isMapMarkingMode {
24-
MapUserLocationButton()
25-
MapPitchToggle()
16+
ZStack {
17+
TripPlannerExtensionView {
18+
Map(position: tripPlanner.currentCameraPositionBinding, interactionModes: .all) {
19+
tripPlanner.generateMarkers()
20+
tripPlanner.generateMapPolyline()
21+
.stroke(.blue, lineWidth: 5)
22+
}
23+
.mapControls {
24+
if !tripPlanner.isMapMarkingMode {
25+
MapUserLocationButton()
26+
MapPitchToggle()
27+
}
2628
}
2729
}
2830
}
31+
2932
}
3033
}
3134

3235
#Preview {
33-
let planner = TripPlannerService(
34-
apiClient: RestAPI(baseURL: URL(string: "https://otp.prod.sound.obaweb.org/otp/routers/default/")!),
35-
locationManager: CLLocationManager(),
36-
searchCompleter: MKLocalSearchCompleter()
37-
)
38-
39-
return MapView()
36+
MapView()
4037
}

‎Examples/OTPKitDemo/OTPKitDemo/OTPKitDemoApp.swift

+14-10
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,23 @@ import SwiftUI
2121

2222
@main
2323
struct OTPKitDemoApp: App {
24-
let tripPlannerService = TripPlannerService(
25-
apiClient: RestAPI(baseURL: URL(string: "https://otp.prod.sound.obaweb.org/otp/routers/default/")!),
26-
locationManager: CLLocationManager(),
27-
searchCompleter: MKLocalSearchCompleter()
28-
)
29-
30-
let sheetEnvironment = OriginDestinationSheetEnvironment()
24+
@State private var hasCompletedOnboarding = false
25+
@State private var selectedRegionURL: URL?
26+
@State private var tripPlannerService: TripPlannerService?
3127

3228
var body: some Scene {
3329
WindowGroup {
34-
MapView()
35-
.environment(tripPlannerService)
36-
.environment(sheetEnvironment)
30+
if hasCompletedOnboarding, let service = tripPlannerService {
31+
MapView()
32+
.environment(service)
33+
.environment(OriginDestinationSheetEnvironment())
34+
} else {
35+
OnboardingView(
36+
hasCompletedOnboarding: $hasCompletedOnboarding,
37+
selectedRegionURL: $selectedRegionURL,
38+
tripPlannerService: $tripPlannerService
39+
)
40+
}
3741
}
3842
}
3943
}

‎Examples/OTPKitDemo/OTPKitDemo/OnboardingView.swift

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
import SwiftUI
2+
import OTPKit
3+
import MapKit
4+
5+
/// View to select region for demo purposes
6+
struct OnboardingView: View {
7+
@Binding var hasCompletedOnboarding: Bool
8+
@Binding var selectedRegionURL: URL?
9+
@Binding var tripPlannerService: TripPlannerService?
10+
@State private var selectedRegion: String = "Puget Sound"
11+
12+
private let regions = [
13+
"Puget Sound": [
14+
"url": URL(string: "https://otp.prod.sound.obaweb.org/otp/routers/default/")!,
15+
"center": CLLocationCoordinate2D(latitude: 47.64585, longitude: -122.2963)
16+
],
17+
"San Diego": [
18+
"url": URL(string: "https://realtime.sdmts.com:9091/otp/routers/default/")!,
19+
"center": CLLocationCoordinate2D(latitude: 32.731591, longitude: -117.1896335)
20+
],
21+
"Tampa": [
22+
"url": URL(string: "https://otp.prod.obahart.org/otp/routers/default/")!,
23+
"center": CLLocationCoordinate2D(latitude: 27.9769105, longitude: -82.445851)
24+
]
25+
]
26+
27+
var body: some View {
28+
VStack {
29+
Spacer(minLength: 20)
30+
Text("Welcome to OTPKitDemo!")
31+
.bold()
32+
.font(.title)
33+
34+
Text("Please choose your region.")
35+
36+
List(Array(regions.keys.sorted()), id: \.self) { key in
37+
Button {
38+
selectedRegion = key
39+
} label: {
40+
HStack {
41+
Text(key)
42+
Spacer()
43+
if selectedRegion == key {
44+
Image(systemName: "checkmark")
45+
.foregroundColor(.blue)
46+
}
47+
}
48+
}
49+
.foregroundColor(.primary)
50+
}
51+
52+
Button {
53+
let selection = regions[selectedRegion]!
54+
55+
// swiftlint:disable force_cast
56+
let url = selection["url"] as! URL
57+
let center = selection["center"] as! CLLocationCoordinate2D
58+
// swiftlint:enable force_cast
59+
60+
selectedRegionURL = url
61+
62+
tripPlannerService = TripPlannerService(
63+
apiClient: RestAPI(baseURL: url),
64+
locationManager: CLLocationManager(),
65+
searchCompleter: MKLocalSearchCompleter()
66+
)
67+
68+
tripPlannerService?.changeMapCamera(to: center)
69+
hasCompletedOnboarding = true
70+
71+
} label: {
72+
Text("OK")
73+
.frame(maxWidth: .infinity, minHeight: 44)
74+
}
75+
.buttonStyle(BorderedProminentButtonStyle())
76+
.padding()
77+
}
78+
.background(Color(UIColor.systemGroupedBackground))
79+
}
80+
}
81+
82+
#Preview {
83+
let planner = TripPlannerService(
84+
apiClient: RestAPI(baseURL: URL(string: "https://otp.prod.sound.obaweb.org/otp/routers/default/")!),
85+
locationManager: CLLocationManager(),
86+
searchCompleter: MKLocalSearchCompleter()
87+
)
88+
89+
return OnboardingView(
90+
hasCompletedOnboarding: .constant(true),
91+
selectedRegionURL: .constant(nil),
92+
tripPlannerService: .constant(planner)
93+
)
94+
}

‎README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ This project was created by Hilmy Veradin with Aaron Brethorst as part of the [G
2121

2222
We make extensive use of unit testing in this project to ensure that our code works as expected and our changes do not cause regressions. All PR merges are gated on unit tests passing in GitHub Actions. Please be sure to run tests locally before opening a pull request. Also, please add or update unit tests to account for changes to your code.
2323

24-
### Swiftlint
24+
### SwiftLint
2525

26-
We make extensive use of [Swiflint](https://github.com/realm/SwiftLint) in order to ensure that our code adheres to standard styles and conventions. Please install Swiftlint locally via Homebrew:
26+
We make extensive use of [SwiftLint](https://github.com/realm/SwiftLint) in order to ensure that our code adheres to standard styles and conventions. Please install Swiftlint locally via Homebrew:
2727

2828
```
2929
brew install swiftlint
3030
```
3131

32-
A clean bill of health from Swiftlint is required for merging pull requests.
32+
A clean bill of health from SwiftLint is required for merging pull requests.
3333

3434
## License
3535

‎Sources/OTPKit/Services/TripPlannerService.swift

+8
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,14 @@ public final class TripPlannerService: NSObject {
194194
public func changeMapCamera(_ item: MKMapItem) {
195195
currentCameraPosition = MapCameraPosition.item(item)
196196
}
197+
198+
/// Changes the map camera to focus on the given coordinate
199+
///
200+
/// - Parameter to coordinate: Add the CLLocationCoordinate2D object
201+
public func changeMapCamera(to coordinate: CLLocationCoordinate2D) {
202+
let region = MKCoordinateRegion(center: coordinate, latitudinalMeters: 1000, longitudinalMeters: 1000)
203+
currentCameraPosition = .region(region)
204+
}
197205

198206
/// Generates markers for the map based on selected points
199207
///

0 commit comments

Comments
 (0)
Please sign in to comment.