Decouple shipping location in interface between Rewards carousel and Location picker

This is another piece of prep work for MBL-2832.

Author: amy-at-kickstarter

Kickstarter-iOS/Features/PledgeShippingLocation/PledgeShippingLocationViewController.swift

@@ -8,7 +8,7 @@ import UIKit
 protocol PledgeShippingLocationViewControllerDelegate: AnyObject {
   func pledgeShippingLocationViewController(
     _ viewController: PledgeShippingLocationViewController,
-    didSelect shippingRule: ShippingRule
+    didSelect location: Location
   )
   func pledgeShippingLocationViewControllerLayoutDidUpdate(
     _ viewController: PledgeShippingLocationViewController,
@@ -128,7 +128,7 @@ final class PledgeShippingLocationViewController: UIViewController {
       .observeValues { [weak self] shippingRule in
         guard let self = self else { return }
 
-        self.delegate?.pledgeShippingLocationViewController(self, didSelect: shippingRule)
+        self.delegate?.pledgeShippingLocationViewController(self, didSelect: shippingRule.location)
       }
 
     self.viewModel.outputs.presentShippingRules

Kickstarter-iOS/Features/RewardsCollection/Controller/RewardsCollectionViewController.swift

@@ -106,7 +106,7 @@ final class RewardsCollectionViewController: UICollectionViewController {
     )
 
     self.setupConstraints()
-    self.viewModel.inputs.shippingRuleSelected(nil)
+    self.viewModel.inputs.shippingLocationSelected(nil)
 
     self.viewModel.inputs.viewDidLoad()
   }
@@ -386,9 +386,9 @@ extension RewardsCollectionViewController: RewardCellDelegate {
 extension RewardsCollectionViewController: PledgeShippingLocationViewControllerDelegate {
   func pledgeShippingLocationViewController(
     _: PledgeShippingLocationViewController,
-    didSelect shippingRule: ShippingRule
+    didSelect location: Location
   ) {
-    self.viewModel.inputs.shippingRuleSelected(shippingRule)
+    self.viewModel.inputs.shippingLocationSelected(location)
   }
 
   func pledgeShippingLocationViewControllerLayoutDidUpdate(

Kickstarter-iOS/Features/RewardsCollection/Views/RewardCardContainerViewTests.swift

@@ -447,7 +447,12 @@ private func rewardCardInViewController(
     view.bottomAnchor.constraint(lessThanOrEqualTo: controller.view.layoutMarginsGuide.bottomAnchor)
   ])
 
-  view.configure(with: (project: project, reward: reward, context: .pledge, currentShippingRule: nil))
+  view.configure(with: RewardCardViewData(
+    project: project,
+    reward: reward,
+    context: .pledge,
+    currentShippingLocation: nil
+  ))
 
   return parent
 }

Library/ViewModels/RewardCardViewModel.swift

@@ -19,7 +19,7 @@ public typealias RewardCardViewData = (
   project: Project,
   reward: Reward,
   context: RewardCardViewContext,
-  currentShippingRule: ShippingRule?
+  currentShippingLocation: Location?
 )
 
 public protocol RewardCardViewModelInputs {
@@ -66,7 +66,7 @@ public final class RewardCardViewModel: RewardCardViewModelType, RewardCardViewM
 
     let project: Signal<Project, Never> = configData.map(\.project)
     let reward: Signal<Reward, Never> = configData.map(\.reward)
-    let currentShippingRule: Signal<ShippingRule?, Never> = configData.map(\.currentShippingRule)
+    let currentShippingLocation: Signal<Location?, Never> = configData.map(\.currentShippingLocation)
 
     let projectAndReward = Signal.zip(project, reward)
 
@@ -134,9 +134,9 @@ public final class RewardCardViewModel: RewardCardViewModelType, RewardCardViewM
     self.rewardLocationStackViewHidden = reward
       .map { !isRewardLocalPickup($0) }
 
-    self.estimatedShippingLabelText = Signal.combineLatest(reward, project, currentShippingRule)
-      .map { reward, project, shippingRule in
-        guard let locationId = shippingRule?.location.id else { return nil }
+    self.estimatedShippingLabelText = Signal.combineLatest(reward, project, currentShippingLocation)
+      .map { reward, project, location in
+        guard let locationId = location?.id else { return nil }
 
         return estimatedShippingText(for: [reward], project: project, locationId: locationId)
       }

Library/ViewModels/RewardsCollectionViewModel.swift

@@ -20,7 +20,7 @@ public protocol RewardsCollectionViewModelInputs {
   func rewardCellShouldShowDividerLine(_ show: Bool)
   func rewardSelected(with rewardId: Int)
   func shippingLocationViewDidFailToLoad()
-  func shippingRuleSelected(_ shippingRule: ShippingRule?)
+  func shippingLocationSelected(_ location: Location?)
   func traitCollectionDidChange(_ traitCollection: UITraitCollection)
   func viewDidAppear()
   func viewDidLayoutSubviews()
@@ -72,7 +72,7 @@ public final class RewardsCollectionViewModel: RewardsCollectionViewModelType,
     let rewards = project
       .map(allowableSortedProjectRewards)
 
-    let filteredByLocationRewards = Signal.combineLatest(rewards, self.shippingRuleSelectedSignal)
+    let filteredByLocationRewards = Signal.combineLatest(rewards, self.shippingLocationSelectedSignal)
       .map(filteredRewardsByLocation)
 
     self.title = configData
@@ -98,17 +98,23 @@ public final class RewardsCollectionViewModel: RewardsCollectionViewModelType,
     .skipNil()
     .take(first: 1)
 
+    let selectedShippingRule: Signal<ShippingRule?, Never> = self.selectedRewardProperty.signal.skipNil()
+      .combineLatest(with: self.shippingLocationSelectedSignal.signal)
+      .map { reward, location in
+        shippingRule(forReward: reward, selectedLocation: location)
+      }
+
     self.reloadDataWithValues = Signal.combineLatest(
       project,
       rewards,
       filteredByLocationRewards,
-      self.shippingRuleSelectedSignal.signal
+      self.shippingLocationSelectedSignal.signal
     )
-    .map { project, rewards, filteredByLocationRewards, shippingRule in
+    .map { project, rewards, filteredByLocationRewards, location in
       if !filteredByLocationRewards.isEmpty {
         filteredByLocationRewards
           .filter { reward in isStartDateBeforeToday(for: reward) }
-          .map { reward in (project, reward, .pledge, shippingRule) }
+          .map { reward in (project, reward, .pledge, location) }
       } else {
         rewards
           .filter { reward in isStartDateBeforeToday(for: reward) }
@@ -155,7 +161,7 @@ public final class RewardsCollectionViewModel: RewardsCollectionViewModelType,
       project,
       selectedRewardFromId,
       refTag,
-      self.shippingRuleSelectedSignal.signal
+      selectedShippingRule
     )
     .takeWhen(self.rewardSelectedWithRewardIdProperty.signal)
     .filter { project, reward, _, _ in
@@ -402,9 +408,10 @@ public final class RewardsCollectionViewModel: RewardsCollectionViewModelType,
     self.shippingLocationViewDidFailToLoadProperty.value = ()
   }
 
-  private let (shippingRuleSelectedSignal, shippingRuleSelectedObserver) = Signal<ShippingRule?, Never>.pipe()
-  public func shippingRuleSelected(_ shippingRule: ShippingRule?) {
-    self.shippingRuleSelectedObserver.send(value: shippingRule)
+  private let (shippingLocationSelectedSignal, shippingLocationSelectedObserver) = Signal<Location?, Never>
+    .pipe()
+  public func shippingLocationSelected(_ location: Location?) {
+    self.shippingLocationSelectedObserver.send(value: location)
   }
 
   private let traitCollectionChangedProperty = MutableProperty<UITraitCollection?>(nil)
@@ -555,9 +562,10 @@ private func allowableSortedProjectRewards(from project: Project) -> [Reward] {
 
 private func filteredRewardsByLocation(
   _ rewards: [Reward],
-  shippingRule: ShippingRule?
+  location: Location?
 ) -> [Reward] {
   return rewards.filter { reward in
+
     var shouldDisplayReward = false
 
     let isRewardLocalOrDigital = isRewardDigital(reward) || isRewardLocalPickup(reward)
@@ -570,7 +578,7 @@ private func filteredRewardsByLocation(
 
       // If restricted shipping, compare against selected shipping location.
     } else if isRestrictedShippingReward {
-      shouldDisplayReward = rewardShipsTo(selectedLocation: shippingRule?.location.id, reward)
+      shouldDisplayReward = rewardShipsTo(selectedLocation: location?.id, reward)
     }
 
     return shouldDisplayReward
@@ -592,3 +600,17 @@ private func rewardShipsTo(
 
   return shippingLocationIds.contains(selectedLocationId)
 }
+
+private func shippingRule(forReward reward: Reward, selectedLocation location: Location?) -> ShippingRule? {
+  guard let rules = reward.shippingRulesExpanded else {
+    let hasShipping = reward.isRestrictedShippingPreference || reward.isUnRestrictedShippingPreference
+    assert(
+      !hasShipping,
+      "This reward is shippable, but no shipping rules were set. The backer may not be charged correctly for shipping."
+    )
+
+    return nil
+  }
+
+  return rules.first(where: { $0.location.id == location?.id })
+}

Library/ViewModels/RewardsCollectionViewModelTests.swift

@@ -4,10 +4,12 @@ import Foundation
 import Prelude
 import ReactiveExtensions
 import ReactiveExtensions_TestHelpers
+import XCTest
 
 final class RewardsCollectionViewModelTests: TestCase {
   private let reloadDataWithValues = TestObserver<[Reward], Never>()
   private let scrollToRewardIndex = TestObserver<Int, Never>()
+  private let goToCustomizeYourReward = TestObserver<PledgeViewData, Never>()
 
   private let vm = RewardsCollectionViewModel()
 
@@ -18,6 +20,8 @@ final class RewardsCollectionViewModelTests: TestCase {
       .observe(self.reloadDataWithValues.observer)
 
     self.vm.outputs.scrollToRewardIndexPath.map { $0.row }.observe(self.scrollToRewardIndex.observer)
+
+    self.vm.outputs.goToCustomizeYourReward.observe(self.goToCustomizeYourReward.observer)
   }
 
   func testRewardsOrdered() {
@@ -37,7 +41,7 @@ final class RewardsCollectionViewModelTests: TestCase {
       |> Project.lens.rewardData.rewards .~ rewards
 
     self.vm.configure(with: testProject, refTag: nil, context: .createPledge, secretRewardToken: "34342")
-    self.vm.shippingRuleSelected(nil)
+    self.vm.shippingLocationSelected(nil)
     self.vm.viewDidLoad()
 
     let rewardsOrdered = [
@@ -67,7 +71,7 @@ final class RewardsCollectionViewModelTests: TestCase {
       |> Project.lens.rewardData.rewards .~ rewards
 
     self.vm.configure(with: testProject, refTag: nil, context: .createPledge, secretRewardToken: "34342")
-    self.vm.shippingRuleSelected(nil)
+    self.vm.shippingLocationSelected(nil)
     self.vm.viewDidLoad()
     self.vm.viewDidLayoutSubviews()
 
@@ -106,7 +110,7 @@ final class RewardsCollectionViewModelTests: TestCase {
       |> Project.lens.personalization.backing .~ backing
 
     self.vm.configure(with: testProject, refTag: nil, context: .createPledge, secretRewardToken: nil)
-    self.vm.shippingRuleSelected(nil)
+    self.vm.shippingLocationSelected(nil)
     self.vm.viewDidLoad()
     self.vm.viewDidLayoutSubviews()
 
@@ -138,10 +142,124 @@ final class RewardsCollectionViewModelTests: TestCase {
       |> Project.lens.rewardData.rewards .~ rewards
 
     self.vm.configure(with: testProject, refTag: nil, context: .createPledge, secretRewardToken: nil)
-    self.vm.shippingRuleSelected(nil)
+    self.vm.shippingLocationSelected(nil)
     self.vm.viewDidLoad()
     self.vm.viewDidLayoutSubviews()
 
     self.scrollToRewardIndex.assertDidNotEmitValue()
   }
+
+  func test_selectLocation_outputsShippingRule_forRewardWithShipping() {
+    let location1 = Location(
+      country: "Country 1",
+      displayableName: "Country 1",
+      id: 1,
+      localizedName: "Country 1",
+      name: "Country 1"
+    )
+    let location2 = Location(
+      country: "Country 2",
+      displayableName: "Country 2",
+      id: 2,
+      localizedName: "Country 2",
+      name: "Country 2"
+    )
+
+    let shippingRule1 = ShippingRule(
+      cost: 10,
+      id: 1,
+      location: location1,
+      estimatedMin: nil,
+      estimatedMax: nil
+    )
+    let shippingRule2 = ShippingRule(
+      cost: 72,
+      id: 2,
+      location: location2,
+      estimatedMin: nil,
+      estimatedMax: nil
+    )
+
+    let reward = Reward.template
+      |> Reward.lens.isAvailable .~ true
+      |> Reward.lens.shippingRulesExpanded .~ [shippingRule1, shippingRule2]
+      |> Reward.lens.shipping .~ Reward.Shipping(
+        enabled: true,
+        location: nil,
+        preference: .restricted,
+        summary: "Restricted shipping",
+        type: .multipleLocations
+      )
+
+    let rewards = [
+      reward
+    ]
+
+    let testProject = Project.template
+      |> Project.lens.rewardData.rewards .~ rewards
+
+    self.vm.configure(with: testProject, refTag: nil, context: .createPledge, secretRewardToken: nil)
+    self.vm.inputs.shippingLocationSelected(nil)
+    self.vm.viewDidLoad()
+    self.vm.viewDidLayoutSubviews()
+
+    self.vm.inputs.shippingLocationSelected(location2)
+    self.vm.inputs.rewardSelected(with: reward.id)
+
+    self.goToCustomizeYourReward.assertDidEmitValue()
+
+    if let pledgeData = self.goToCustomizeYourReward.lastValue {
+      XCTAssertEqual(
+        pledgeData.selectedShippingRule,
+        shippingRule2,
+        "Pledge data should include shipping rule for location 2"
+      )
+    }
+  }
+
+  func test_selectLocation_outputsNilShippingRule_forRewardWithoutShipping() {
+    let location1 = Location(
+      country: "Country 1",
+      displayableName: "Country 1",
+      id: 1,
+      localizedName: "Country 1",
+      name: "Country 1"
+    )
+
+    let reward = Reward.template
+      |> Reward.lens.isAvailable .~ true
+      |> Reward.lens.shippingRulesExpanded .~ []
+      |> Reward.lens.shipping .~ Reward.Shipping(
+        enabled: true,
+        location: nil,
+        preference: Reward.Shipping.Preference.none,
+        summary: "Digital reward",
+        type: .noShipping
+      )
+
+    let rewards = [
+      reward
+    ]
+
+    let testProject = Project.template
+      |> Project.lens.rewardData.rewards .~ rewards
+
+    self.vm.configure(with: testProject, refTag: nil, context: .createPledge, secretRewardToken: nil)
+    self.vm.inputs.shippingLocationSelected(nil)
+    self.vm.viewDidLoad()
+    self.vm.viewDidLayoutSubviews()
+
+    self.vm.inputs.shippingLocationSelected(location1)
+    self.vm.inputs.rewardSelected(with: reward.id)
+
+    self.goToCustomizeYourReward.assertDidEmitValue()
+
+    if let pledgeData = self.goToCustomizeYourReward.lastValue {
+      XCTAssertEqual(
+        pledgeData.selectedShippingRule,
+        nil,
+        "Pledge data should have no shipping rule, because the reward is digital"
+      )
+    }
+  }
 }