Skip to content

Commit b8dcdb9

Browse files
committed
Rename AddEditCouponViewModel onCompletion closure to onSuccess
1 parent 0b26575 commit b8dcdb9

File tree

5 files changed

+30
-30
lines changed

5 files changed

+30
-30
lines changed

WooCommerce/Classes/ViewRelated/Coupons/Add and Edit Coupons/AddEditCoupon.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -404,7 +404,7 @@ struct AddEditCoupon_Previews: PreviewProvider {
404404

405405
/// Edit Coupon
406406
///
407-
let editingViewModel = AddEditCouponViewModel(existingCoupon: Coupon.sampleCoupon, onCompletion: { _ in })
407+
let editingViewModel = AddEditCouponViewModel(existingCoupon: Coupon.sampleCoupon, onSuccess: { _ in })
408408
AddEditCoupon(editingViewModel)
409409
}
410410
}

WooCommerce/Classes/ViewRelated/Coupons/Add and Edit Coupons/AddEditCouponViewModel.swift

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ final class AddEditCouponViewModel: ObservableObject {
1414
///
1515
private let editingOption: EditingOption
1616

17-
private let onCompletion: ((Result<Coupon, Error>) -> Void)
17+
private let onSuccess: ((Result<Coupon, Error>) -> Void)
1818

1919
/// Defines the current notice that should be shown.
2020
/// Defaults to `nil`.
@@ -191,15 +191,15 @@ final class AddEditCouponViewModel: ObservableObject {
191191
storageManager: StorageManagerType = ServiceLocator.storageManager,
192192
currencySettings: CurrencySettings = ServiceLocator.currencySettings,
193193
timezone: TimeZone = .siteTimezone,
194-
onCompletion: @escaping ((Result<Coupon, Error>) -> Void)) {
194+
onSuccess: @escaping ((Result<Coupon, Error>) -> Void)) {
195195
self.siteID = siteID
196196
editingOption = .creation
197197
self.discountType = discountType
198198
self.stores = stores
199199
self.storageManager = storageManager
200200
self.currencySettings = currencySettings
201201
self.timezone = timezone
202-
self.onCompletion = onCompletion
202+
self.onSuccess = onSuccess
203203

204204
amountField = String()
205205
codeField = String()
@@ -219,7 +219,7 @@ final class AddEditCouponViewModel: ObservableObject {
219219
storageManager: StorageManagerType = ServiceLocator.storageManager,
220220
currencySettings: CurrencySettings = ServiceLocator.currencySettings,
221221
timezone: TimeZone = .siteTimezone,
222-
onCompletion: @escaping ((Result<Coupon, Error>) -> Void)) {
222+
onSuccess: @escaping ((Result<Coupon, Error>) -> Void)) {
223223
siteID = existingCoupon.siteID
224224
coupon = existingCoupon
225225
editingOption = .editing
@@ -228,7 +228,7 @@ final class AddEditCouponViewModel: ObservableObject {
228228
self.storageManager = storageManager
229229
self.currencySettings = currencySettings
230230
self.timezone = timezone
231-
self.onCompletion = onCompletion
231+
self.onSuccess = onSuccess
232232

233233
// Populate fields
234234
amountField = existingCoupon.amount
@@ -273,7 +273,7 @@ final class AddEditCouponViewModel: ObservableObject {
273273
if let validationError = validateCouponLocally(coupon) {
274274
notice = NoticeFactory.createCouponErrorNotice(validationError,
275275
editingOption: editingOption)
276-
onCompletion(.failure(validationError))
276+
onSuccess(.failure(validationError))
277277
return
278278
}
279279

@@ -285,7 +285,7 @@ final class AddEditCouponViewModel: ObservableObject {
285285
case .success(let coupon):
286286
ServiceLocator.analytics.track(.couponCreationSuccess)
287287
self.coupon = coupon
288-
self.onCompletion(result)
288+
self.onSuccess(result)
289289
self.showingCouponCreationSuccess = true
290290
case .failure(let error):
291291
DDLogError("⛔️ Error creating the coupon: \(error)")
@@ -303,7 +303,7 @@ final class AddEditCouponViewModel: ObservableObject {
303303
if let validationError = validateCouponLocally(coupon) {
304304
notice = NoticeFactory.createCouponErrorNotice(validationError,
305305
editingOption: editingOption)
306-
onCompletion(.failure(validationError))
306+
onSuccess(.failure(validationError))
307307
return
308308
}
309309

@@ -314,7 +314,7 @@ final class AddEditCouponViewModel: ObservableObject {
314314
switch result {
315315
case .success(_):
316316
ServiceLocator.analytics.track(.couponUpdateSuccess)
317-
self.onCompletion(result)
317+
self.onSuccess(result)
318318
onUpdateFinished()
319319
case .failure(let error):
320320
DDLogError("⛔️ Error updating the coupon: \(error)")

WooCommerce/Classes/ViewRelated/Coupons/CouponDetails/CouponDetailsViewModel.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ private extension CouponDetailsViewModel {
280280
}
281281

282282
func createAddEditCouponViewModel(with coupon: Coupon) -> AddEditCouponViewModel {
283-
.init(existingCoupon: coupon, onCompletion: { [weak self] result in
283+
.init(existingCoupon: coupon, onSuccess: { [weak self] result in
284284
guard let self = self else { return }
285285
switch result {
286286
case .success(let updatedCoupon):

WooCommerce/Classes/ViewRelated/Coupons/CouponListViewController.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ private extension CouponListViewController {
198198
/// Triggers the coupon creation flow
199199
///
200200
func startCouponCreation(discountType: Coupon.DiscountType) {
201-
let viewModel = AddEditCouponViewModel(siteID: siteID, discountType: discountType, onCompletion: {_ in })
201+
let viewModel = AddEditCouponViewModel(siteID: siteID, discountType: discountType, onSuccess: {_ in })
202202
let addEditHostingController = AddEditCouponHostingController(viewModel: viewModel, onDisappear: { [weak self] in
203203
guard let self = self else { return }
204204
self.dismiss(animated: true)

WooCommerce/WooCommerceTests/ViewRelated/Coupons/AddEditCouponViewModelTests.swift

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@ import XCTest
55
final class AddEditCouponViewModelTests: XCTestCase {
66

77
func test_titleView_property_return_expected_values_on_creation() {
8-
let viewModel1 = AddEditCouponViewModel(siteID: 123, discountType: .percent, onCompletion: { _ in })
8+
let viewModel1 = AddEditCouponViewModel(siteID: 123, discountType: .percent, onSuccess: { _ in })
99
XCTAssertEqual(viewModel1.title, NSLocalizedString("Create coupon", comment: ""))
1010
}
1111

1212
func test_titleView_property_return_expected_values_on_editing() {
13-
let viewModel1 = AddEditCouponViewModel(existingCoupon: Coupon.sampleCoupon.copy(discountType: .percent), onCompletion: { _ in })
13+
let viewModel1 = AddEditCouponViewModel(existingCoupon: Coupon.sampleCoupon.copy(discountType: .percent), onSuccess: { _ in })
1414
XCTAssertEqual(viewModel1.title, NSLocalizedString("Edit coupon", comment: ""))
1515
}
1616

1717
func test_generateRandomCouponCode_populate_correctly_the_codeField() {
1818
// Given
19-
let viewModel = AddEditCouponViewModel(existingCoupon: Coupon.sampleCoupon.copy(code: ""), onCompletion: { _ in })
19+
let viewModel = AddEditCouponViewModel(existingCoupon: Coupon.sampleCoupon.copy(code: ""), onSuccess: { _ in })
2020
XCTAssertEqual(viewModel.codeField, "")
2121

2222
// When
@@ -35,7 +35,7 @@ final class AddEditCouponViewModelTests: XCTestCase {
3535
let expiryDate = Date().startOfDay(timezone: timeZone)
3636
let viewModel = AddEditCouponViewModel(existingCoupon: Coupon.sampleCoupon.copy(discountType: .percent, dateExpires: expiryDate),
3737
timezone: timeZone,
38-
onCompletion: { _ in })
38+
onSuccess: { _ in })
3939
assertEqual(viewModel.populatedCoupon, Coupon.sampleCoupon.copy(discountType: .percent,
4040
dateExpires: expiryDate))
4141

@@ -82,7 +82,7 @@ final class AddEditCouponViewModelTests: XCTestCase {
8282

8383
func test_populatedCoupon_return_expected_coupon_during_creation() {
8484
// Given
85-
let viewModel = AddEditCouponViewModel(siteID: 0, discountType: .fixedCart, onCompletion: { _ in })
85+
let viewModel = AddEditCouponViewModel(siteID: 0, discountType: .fixedCart, onSuccess: { _ in })
8686

8787
// When
8888
let populatedCoupon = viewModel.populatedCoupon
@@ -117,7 +117,7 @@ final class AddEditCouponViewModelTests: XCTestCase {
117117
func test_validateCouponLocally_return_expected_error_if_coupon_code_is_empty() {
118118
// Given
119119
let coupon = Coupon.sampleCoupon.copy(code: "")
120-
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onCompletion: { _ in })
120+
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onSuccess: { _ in })
121121

122122
// When
123123
let result = viewModel.validateCouponLocally(coupon)
@@ -129,7 +129,7 @@ final class AddEditCouponViewModelTests: XCTestCase {
129129
func test_validateCouponLocally_return_nil_if_coupon_code_is_not_empty() {
130130
// Given
131131
let coupon = Coupon.sampleCoupon.copy(code: "ABCDEF")
132-
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onCompletion: { _ in })
132+
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onSuccess: { _ in })
133133

134134
// When
135135
let result = viewModel.validateCouponLocally(coupon)
@@ -141,7 +141,7 @@ final class AddEditCouponViewModelTests: XCTestCase {
141141
func test_hasChangesMade_is_correct_for_discount_type() {
142142
// Given
143143
let coupon = Coupon.sampleCoupon.copy(discountType: .percent)
144-
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onCompletion: { _ in })
144+
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onSuccess: { _ in })
145145
XCTAssertFalse(viewModel.hasChangesMade) // confidence check
146146

147147
// When
@@ -154,7 +154,7 @@ final class AddEditCouponViewModelTests: XCTestCase {
154154
func test_hasChangesMade_is_correct_for_coupon_code() {
155155
// Given
156156
let coupon = Coupon.sampleCoupon.copy(code: "ABCDEF")
157-
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onCompletion: { _ in })
157+
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onSuccess: { _ in })
158158
XCTAssertFalse(viewModel.hasChangesMade) // confidence check
159159

160160
// When
@@ -167,7 +167,7 @@ final class AddEditCouponViewModelTests: XCTestCase {
167167
func test_hasChangesMade_is_correct_for_amount() {
168168
// Given
169169
let coupon = Coupon.sampleCoupon.copy(amount: "11.22")
170-
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onCompletion: { _ in })
170+
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onSuccess: { _ in })
171171
XCTAssertFalse(viewModel.hasChangesMade) // confidence check
172172

173173
// When
@@ -180,7 +180,7 @@ final class AddEditCouponViewModelTests: XCTestCase {
180180
func test_hasChangesMade_is_correct_for_expiry_date() {
181181
// Given
182182
let coupon = Coupon.sampleCoupon.copy(dateExpires: Date())
183-
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onCompletion: { _ in })
183+
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onSuccess: { _ in })
184184
XCTAssertFalse(viewModel.hasChangesMade) // confidence check
185185

186186
// When
@@ -193,7 +193,7 @@ final class AddEditCouponViewModelTests: XCTestCase {
193193
func test_hasChangesMade_is_correct_for_nil_expiry_date() {
194194
// Given
195195
let coupon = Coupon.sampleCoupon.copy(dateExpires: Date())
196-
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onCompletion: { _ in })
196+
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onSuccess: { _ in })
197197
XCTAssertFalse(viewModel.hasChangesMade) // confidence check
198198

199199
// When
@@ -206,7 +206,7 @@ final class AddEditCouponViewModelTests: XCTestCase {
206206
func test_hasChangesMade_is_correct_for_updated_product_restrictions() {
207207
// Given
208208
let coupon = Coupon.sampleCoupon
209-
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onCompletion: { _ in })
209+
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onSuccess: { _ in })
210210
XCTAssertFalse(viewModel.hasChangesMade) // confidence check
211211

212212
// When
@@ -219,7 +219,7 @@ final class AddEditCouponViewModelTests: XCTestCase {
219219
func test_hasChangesMade_is_correct_for_updated_category_restrictions() {
220220
// Given
221221
let coupon = Coupon.sampleCoupon
222-
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onCompletion: { _ in })
222+
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onSuccess: { _ in })
223223
XCTAssertFalse(viewModel.hasChangesMade) // confidence check
224224

225225
// When
@@ -232,7 +232,7 @@ final class AddEditCouponViewModelTests: XCTestCase {
232232
func test_hasChangesMade_is_correct_for_description() {
233233
// Given
234234
let coupon = Coupon.sampleCoupon
235-
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onCompletion: { _ in })
235+
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onSuccess: { _ in })
236236
XCTAssertFalse(viewModel.hasChangesMade) // confidence check
237237

238238
// When
@@ -245,7 +245,7 @@ final class AddEditCouponViewModelTests: XCTestCase {
245245
func test_hasChangesMade_is_correct_for_free_shipping() {
246246
// Given
247247
let coupon = Coupon.sampleCoupon.copy(freeShipping: false)
248-
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onCompletion: { _ in })
248+
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onSuccess: { _ in })
249249
XCTAssertFalse(viewModel.hasChangesMade) // confidence check
250250

251251
// When
@@ -258,7 +258,7 @@ final class AddEditCouponViewModelTests: XCTestCase {
258258
func test_hasChangesMade_is_correct_for_updated_usage_restrictions() {
259259
// Given
260260
let coupon = Coupon.sampleCoupon.copy(usageLimit: 100)
261-
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onCompletion: { _ in })
261+
let viewModel = AddEditCouponViewModel(existingCoupon: coupon, onSuccess: { _ in })
262262
XCTAssertFalse(viewModel.hasChangesMade) // confidence check
263263

264264
// When
@@ -270,7 +270,7 @@ final class AddEditCouponViewModelTests: XCTestCase {
270270

271271
func test_hasChangesMade_is_always_true_when_is_in_creation_mode() {
272272
// Given
273-
let viewModel = AddEditCouponViewModel(siteID: 123, discountType: .percent, onCompletion: {_ in })
273+
let viewModel = AddEditCouponViewModel(siteID: 123, discountType: .percent, onSuccess: {_ in })
274274

275275
// Then
276276
XCTAssertTrue(viewModel.hasChangesMade)

0 commit comments

Comments
 (0)