Refactor MergeableOrdersFinder

Changes the MergeableOrdersFinder interface to accept a single `context:`
parameter instead of individual `user:`, `store:`, and `current_order:`
parameters.

Changes include:

- Update MergeableOrdersFinder to extract user/store/order from context
- Modify set_current_order to pass `context: self` to finder
- Update documentation examples to reflect new context-based interface
- Refactor specs to use context doubles with spree_current_user
- Add frontend_viewable filter to maintain existing behavior

Signed-off-by: Thukten Singye <[email protected]>

Author: ThuktenSingye

core/app/helpers/spree/core/controller_helpers/order.rb

@@ -42,11 +42,7 @@ def associate_user
         end
 
         def set_current_order
-          Spree::Config.mergeable_orders_finder_class.new(
-            user: spree_current_user,
-            store: current_store,
-            current_order: current_order
-          ).call.find_each do |order|
+          Spree::Config.mergeable_orders_finder_class.new(context: self).call.find_each do |order|
             current_order.merge!(order, spree_current_user)
           end
         end

core/app/models/spree/mergeable_orders_finder.rb

@@ -8,10 +8,10 @@ module Spree
   #
   # @example Custom finder for recent orders only
   #   class RecentOrdersFinder
-  #     def initialize(user:, store:, current_order:)
-  #       @user = user
-  #       @store = store
-  #       @current_order = current_order
+  #     def initialize(context:)
+  #       @user = context.spree_current_user
+  #       @store = context.current_store
+  #       @current_order = context.current_order
   #     end
   #
   #     def call
@@ -23,21 +23,20 @@ module Spree
   #
   #   Spree::Config.mergeable_orders_finder_class = RecentOrdersFinder
   class MergeableOrdersFinder
-    # @param user [Spree::User] the user whose orders to find
-    # @param store [Spree::Store] the current store
-    # @param current_order [Spree::Order] the current session order
-    def initialize(user:, store:, current_order:)
-      @user = user
-      @store = store
-      @current_order = current_order
+    # @param context [Object] an object that responds to spree_current_user,
+    #   current_store, and current_order (typically a controller)
+    def initialize(context:)
+      @user = context.spree_current_user
+      @store = context.current_store
+      @current_order = context.current_order
     end
 
     # Returns orders that should be merged into the current order
     #
     # @return [ActiveRecord::Relation<Spree::Order>] incomplete orders from the
     # same store
     def call
-      @user.orders.by_store(@store).incomplete.where.not(id: @current_order.id)
+      @user.orders.by_store(@store).incomplete.where(frontend_viewable: true).where.not(id: @current_order.id)
     end
   end
 end

core/spec/models/spree/mergeable_orders_finder_spec.rb

@@ -7,7 +7,8 @@ module Spree
     let(:user) { create(:user) }
     let(:store) { create(:store) }
     let(:current_order) { create(:order, user: user, store: store) }
-    let(:subject) { Spree::MergeableOrdersFinder.new(user: user, store: store, current_order: current_order) }
+    let(:context) { double('context', spree_current_user: user, current_store: store, current_order: current_order) }
+    let(:subject) { Spree::MergeableOrdersFinder.new(context: context) }
 
     describe '#call' do
       let!(:incomplete_order1) { create(:order, user: user, store: store, state: 'cart') }

core/spec/models/spree/order_spec.rb

@@ -427,30 +427,27 @@ def merge!(other_order, user = nil)
       let(:user) { create(:user) }
       let(:store) { create(:store) }
       let(:current_order) { create(:order, user: user, store: store) }
-
-      before do
-        class TestMergeableOrdersFinder
-          def initialize(user:, store:, current_order:)
-            @user = user
-            @store = store
-            @current_order = current_order
+      let(:context) { double('context', spree_current_user: user, current_store: store, current_order: current_order) }
+      let(:test_mergeable_orders_finder_class) do
+        Class.new do
+          def initialize(context:)
+            @user = context.spree_current_user
+            @store = context.current_store
+            @current_order = context.current_order
           end
 
           def call
             @user.orders.by_store(@store).where.not(id: @current_order.id).where('created_at > ?', 7.days.ago)
           end
         end
-        Spree::Config.mergeable_orders_finder_class = TestMergeableOrdersFinder
       end
 
-      subject(:finder) do
-        Spree::Config.mergeable_orders_finder_class.new(
-          user: user,
-          store: store,
-          current_order: current_order
-        )
+      before do
+        stub_spree_preferences(mergeable_orders_finder_class: test_mergeable_orders_finder_class)
       end
 
+      subject(:finder) { Spree::Config.mergeable_orders_finder_class.new(context: context) }
+
       it 'uses the configured mergeable orders finder' do
         old_order = create(:order, user: user, store: store, created_at: 8.days.ago)
         recent_order = create(:order, user: user, store: store, created_at: 3.days.ago)