Allow strikethrough prices to be calculated for variants

[mamhoff]

Summary

Currently, the promotions system acts on the customer's Spree::Order record when it changes. Spree::Order#recalculate will compute promotion eligibility and apply any discounts.

This change allows "previewing" what promotions would do to the price of a variant, before putting it into the cart. This allows for the popular "strikethrough" prices one sees on many sites. For example, Amazon:

The result of these calculcations depend on the current order (with the current user attached as order.user) so that any promotions that are active for the current order apply. The order can be nil.

Prices are display ads - so the class that changes the price display to include discounts is called an "advertiser".

That means we cannot persist the discounts on variant prices, but instead need to calculate them before display. I've opted - for now, this is up for debate - to run a SolidusPromotions::ProductAdvertiser on a product before displaying. Other services classes that would be able to compute strikethrough prices for taxons ("Hoovers - up to 39% off!") would have a similar implementation.

Currently this works as follows:

# PDP controller
def show
   @product = Spree::Product.find_by(params[:slug])

   SolidusPromotions::ProductAdvertiser.new(product: @product, order: current_order, quantity: 1).call
end

<-- products/show.html.erb -->
<% price = product.master.price_for_options(current_pricing_options) %>
<span class="pill strikethrough">
  <%= price.display_amount.to_html %>
</span>
<span class="price">
  <%= price.display_discounted_amount.to_html %>
</span> 

The main implementation idea is that line items, shipments and shipping rates have an amount column that all the calculations in the promotions module apply to, and that we can leverage Spree::Price#amount in the same way for variants.

This kind of previewing can be done with the new promotion benefit SolidusPromotions::Benefit::AdvertisePrice. Only three calculators are supported right now: FlatRate, Percent and FlexiRate. I'm pretty sure these are by far the most popular calculators for promotions and carry 90% of the load.

Because the logic is the same as with line items and shipments, this should take into account the whole complexity of the promotion system - lanes, stackable discounts, and so on.

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 used clear, explanatory commit messages.

The following are not always needed:

• 📖 I have updated the README to account for my changes.
• 📑 I have documented new code with YARD.
• 🛣️ I have opened a PR to update the guides.
• ✅ I have added automated tests to cover my changes.
• 📸 I have attached screenshots to demo visual changes.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.59%. Comparing base (997f46a) to head (0fc1423).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6287      +/-   ##
==========================================
+ Coverage   89.51%   89.59%   +0.07%     
==========================================
  Files         981      987       +6     
  Lines       20504    20651     +147     
==========================================
+ Hits        18355    18502     +147     
  Misses       2149     2149              

☔ 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.

[tvdeyen]

This is amazing! I have a few nits, but can't wait to have this supported :)

[tvdeyen]

Exciting!