[Admin] Open edit and new forms in dialog with turbo frame

[tvdeyen]

Depends on #6048

Summary

Opens new and edit forms of Admin resources in dialogs with Turbo Frames.
Removing the need of rendering the index table again on the form components.

Also handles the layout toggle for all turbo frame requests.

Includes the ground work from #6045

• Shipping Categories
• Adjustment reasons
• Return reasons
• Store credit reasons
• Refund reasons
• Tax categories
• User roles
• Add user store credit
• Edit Stock items

Closes #5944

Checklist

Check out our PR guidelines for more details.

The following are mandatory for all PRs:

• 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

Attention: Patch coverage is 94.87179% with 6 lines in your changes missing coverage. Please review.

Project coverage is 89.59%. Comparing base (9234436) to head (0e5c4dc).

Files with missing lines	Patch %	Lines
...ontrollers/solidus_admin/stock_items_controller.rb	50.00%	2 Missing ⚠️
...rollers/solidus_admin/tax_categories_controller.rb	50.00%	2 Missing ⚠️
...nts/solidus_admin/tax_categories/edit/component.rb	0.00%	1 Missing ⚠️
...rollers/solidus_admin/return_reasons_controller.rb	93.75%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #6046      +/-   ##
==========================================
+ Coverage   87.82%   89.59%   +1.77%     
==========================================
  Files         477      791     +314     
  Lines       11670    18254    +6584     
==========================================
+ Hits        10249    16355    +6106     
- Misses       1421     1899     +478     

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

[chaimann]

@tvdeyen i've checked out your branch and here's the screen recording of the "issues" i mentioned. You can see when I open the edit page in the new tab and click outside, it makes a request to edit url. Also when I click update the modal stays open.

However, I guess I understood it incorrectly what you meant about being able to visit the edit page. In my PR I have done it in a way that the underlying table is still rendered on edit page which I thought was your goal.
So in case we want to have just a modal on the edit page and nothing else, not closing it on all occasions specified above may still be a desired behaviour since we are not rendering anything else other than a modal, so basically there's no need to close it 😄

Screen.Recording.2024-12-20.at.23.38.25.mov

Though there's one more thing I discovered, not related to visiting edit page, but opening a modal with "turbo-framed" link and clicking outside:

Screen.Recording.2024-12-20.at.23.50.35.mov

as you can see it makes a request to index which I'm sure is unnecessary in this circumstance. Probably has something to do with how the clicking outside is implemented, but I have not yet checked how it works so can't tell for sure

[tvdeyen]

@chaimann Now, I understand what you meant. Thanks for the screen recording. This helps to understand the issue.

@tvdeyen i've checked out your branch and here's the screen recording of the "issues" i mentioned. You can see when I open the edit page in the new tab and click outside, it makes a request to edit url. Also when I click update the modal stays open.

However, I guess I understood it incorrectly what you meant about being able to visit the edit page. In my PR I have done it in a way that the underlying table is still rendered on edit page which I thought was your goal. So in case we want to have just a modal on the edit page and nothing else, not closing it on all occasions specified above may still be a desired behaviour since we are not rendering anything else other than a modal, so basically there's no need to close it 😄

Yeah, I think that we do not display the index table on the /new routes is preferable. But we should adopt the layout. Maybe simply remove the dialog when the request is not a turbo-frame request?

The same is true for the redirect after successful form submission.
I will add something that makes the redirect dependent from the kind of request.

Though there's one more thing I discovered, not related to visiting edit page, but opening a modal with "turbo-framed" link and clicking outside:

as you can see it makes a request to index which I'm sure is unnecessary in this circumstance. Probably has something to do with how the clicking outside is implemented, but I have not yet checked how it works so can't tell for sure

This is how @close_path is implemented. I can see if we can change that, but in the end it's something I can live with in this case.