Only use custom routes

[elia]

Summary

Using both devise generated routes and custom ones is confusing.

As an example: when failing authentication, the devise route would
send the user to "new_spree_user_session_path", however we want our
users to be redirected to "/login." This commit deprecates the route
and sends users to "/login."

This PR maintains full support for existing routes allowing stores to copy them in their routes file if they want to continue using them.

Visiting /user/spree_user/sign_up the logs will show this deprecation message:

DEPRECATION WARNING: This route is deprecated: "/user/spree_user/sign_up".
It will be removed in solidus_auth_devise v3.
If you want to continue using this route please define it in your application code:

Spree::Core::Engine.routes.draw do
  devise_scope :spree_user do
    get "/user/spree_user/sign_up", to: spree/user_registrations#new, ...
  end
end

Please check your application for places in which this route was generated.

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 (cross them out if they are not):

• I have added automated tests to cover my changes.
• I have attached screenshots to demo visual changes.
• I have opened a PR to update the guides.
• I have updated the README to account for my changes.

[kennyadsl]

I'm not convinced by where this file is placed. Why it's in app/controllers? This kind of helper is more something for libs IMO, similar to what we do in core.

[elia]

I put it there because it plays nice with autoload, maybe we could put it in app/controllers/concerns/solidus_auth_devise/deprecated_routes.rb instead?

[kennyadsl]

Yep, better!

[kennyadsl]

This works only for the frontend right? For backend routes it will also have the namespace :admin do part. Not that we need it now, just wanted to be sure.

[elia]

For backend we already skip: :all so it should be already streamlined, luckily 🍀

[kennyadsl]

Can't find this skip: app for backend routes, can you please point it here?

[elia]

here https://github.com/nebulab/solidus_auth_devise/blob/elia%2Bkennyadsl/fix-routes/config/routes.rb#L75

[kennyadsl]

Ah, got what you mean now. Still, the with_options deprecated_route: true do could be used in the future on a backend route. I'm just saying that if that happens, this concern will be printing a non-accurate message, because it only works with frontend routes.

[elia]

That's true, but I trust we'll remove everything when releasing v3.0