Configurable Order Mergeable Scope

[ThuktenSingye]

Summary

This PR makes the mergeable order finding logic in set_current_order configurable by introducing a new mergeable_orders_finder_class configuration option and Spree::MergeableOrdersFinder class.

Fixes #6366

Checklist

Check out our PR guidelines for more details.

The following are mandatory for all PRs:

• I agree that my PR will be published under the same license as Solidus.
• I have written a thorough PR description.
• I have kept my commits small and atomic.
• I have localized any and all user-facing strings that I added to the source code.
• I have used clear, explanatory commit messages.

The following are not always needed:

• 📑 I have documented new code with YARD.
• ✅ I have added automated tests to cover my changes.

[mamhoff]

There's a conflict in the order.rb controller helper, and you'll have to manually rebase this from the current main branch.

[mamhoff]

I think the linter will complain here "Don't define constants this way in a block".

suggestion:

let(:test_mergeable_orders_class) do
  Class.new do 
    # test class implementation
  end
end

before do
  stub_spree_preferences(mergeable_orders_finder_class: test_mergeable_orders_class)
end

[mamhoff]

This is nice, but what about passing in the current context instead? Since we're in helper/view/serializer territory, stores might have other needs than the current store/user as independent variables.

Suggestion:

# calling code
Spree::Config.mergeable_orders_finder_class.new(context: self)

# implementation
class MergeableOrdersFinder
  def initialize(context:)
    @user = context.current_user
    @store = context.current_store
    @current_order = context.current_order
  end
 
  # more implementation
end

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.45%. Comparing base (fc3adf7) to head (d912145).
⚠️ Report is 27 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #6384   +/-   ##
=======================================
  Coverage   89.45%   89.45%           
=======================================
  Files         974      975    +1     
  Lines       20322    20331    +9     
=======================================
+ Hits        18179    18188    +9     
  Misses       2143     2143           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[ThuktenSingye]

@mamhoff,Thanks for the feedback. I have made changes accordingly. Let me know if there is any changes required. Thank you

[mamhoff]

I think this is looking good. Please rebase the commits so they're all one commit. We don't really need to remember how the sausage was made :)

[adammathys]

Looks good to me!

[tvdeyen]

Great work. Thanks