Add tooltips to admin calculators

[codykaup]

Description

This change adds tooltips for some calculators in the admin panel. I tried to create some basic text based on the guides so they can easily be changed in the future. If you have further ideas on what these should say, I'm all ears!!

Side Note: Since this is just changing a small piece of the frontend view, I wasn't totally sure on tests as there's no real extra functionality. As always, if you feel there should be some, don't hesitate to let me know!

This PR is in reference to: issue #3363

Thanks in advance!

Quick view of how these look

Checklist:

• I have followed Pull Request guidelines
• I have added a detailed description into each commit message
• I have updated Guides and README accordingly to this change (if needed)
• I have added tests to cover this change (if needed)

[codykaup]

I couldn't find a great way to grab the parent module of the calculator without it getting hacky so I figured an instance method in the controller would be a decent alternative!

[kennyadsl]

Hey @codykaup, thanks a lot for the PR. I think this issue was more to explain what every single calculator does, rather than the generic calculator type. Anyway, I think this is still an improvement, and I'd like to go ahead.

What about passing the tooltip content as a partial variable from the outside, for example here, so we don't have to set the instance variable in the controller? This variable could be optional so, when we need to call the partial without the tooltip, we can still do that. What do you think?

[codykaup]

Hey @codykaup, thanks a lot for the PR. I think this issue was more to explain what every single calculator does, rather than the generic calculator type. Anyway, I think this is still an improvement, and I'd like to go ahead.

What about passing the tooltip content as a partial variable from the outside, for example here, so we don't have to set the instance variable in the controller? This variable could be optional so, when we need to call the partial without the tooltip, we can still do that. What do you think?

Definitely not a bad idea. Do you have a suggestion that would prevent hardcoding the calculator names?

Right now, I'm assuming it would be a new partial that defaults to base_controller unless supplied like promotions:

<%= admin_hint t('spree.adjustment_type'), t(:promotions, scope: [:spree, :hints, "spree/calculator"]), locals: { calculator: "promotions" } %>

[kennyadsl]

I mean more something like adding the hint we want to show where we call the partial:

<%= render partial: 'spree/admin/shared/calculator_fields', locals: { f: f, hint: : shipping_methods } %>

and into that partial:

<% if local_assigns.has_key? :hint %>
  <%= admin_hint t("spree.#{hint}"), t(hint, scope: [:spree, :hints, "spree/calculator"]) %>
<% end %>

WDYT?

[codykaup]

I mean more something like adding the hint we want to show where we call the partial:

<%= render partial: 'spree/admin/shared/calculator_fields', locals: { f: f, hint: : shipping_methods } %>

and into that partial:

<% if local_assigns.has_key? :hint %>
  <%= admin_hint t("spree.#{hint}"), t(hint, scope: [:spree, :hints, "spree/calculator"]) %>
<% end %>

WDYT?

I like that idea a lot. It's essentially the same concept without including an instance variable. I just updated my commit to the new version and it works the exact same!

[codykaup]

Hey @kennyadsl, not sure if you saw or not but the PR has been updated! 🎉

[kennyadsl]

Thanks! @solidusio/core-team can we have a second review, please?

[tvdeyen]

Thats nice. Thanks