Library for localized/multilingual routes in Phoenix

Hi @BartOtten , here’s some feedback since you are looking for one:

1. Is this library is a drop-in replacement to Phoenix Routes? Routing — Phoenix v1.8.8 in which case aspect such as security (like token decoding, cross browser validation, etc.)
2. What is the intended usage of the library? Why would people consider using AltRoutes rather than the standard Phoenix Routes? it’s not clear to me, right now it seems AltRoutes looks like a smaller codegen of standard Phoenix Route.

1 - I see PhxMultiLangRoutes as more descriptive of what the library does. PhxLocalizedRoutes could also be an idea.

2 - Would :short differ from :slug in many cases? If not, having one key less could be desirable. Even in europe/eu case, if the slug is europe, I would find it much more intuitively that the helper uses it as well (europe_product_index_path).

4 - A far alley, maybe even out of the scope of the library, could be the support of different domains/subdomains:

  "en" => "example.com",
  "nl" => "nl.example.com",
  "be" => "be.example.com",

1. Great suggestion, was already done (just not pushed yet)
2. I chose to call it rename it to prefix, but not include it in the example config as it’s just an option for then needed.
3. As the assigns are freeform (you define the struct yourself), one can just add key :domain. Or did you have something else in mind?

My idea was regarding sites that run each localized version on different subdomains entirely. So, the french version on fr.example.com, the english/default on example.com etc, thus the path helpers/router macros will need to generate the paths differently and I suppose it would also involve different endpoint/router for each locale. Again, a very var away alley

Major refactoring in progress; will soon push a revised edition.

Changelog (pushed so far, refactoring in progress)

- renamed lib
- restructured config
- less dynamic, more compiled; the config is extended with generated values during compilation time.
- use native :assigns for the scopes
- simplified Plug
- fixed compilation issues
- removed (dev) helper function clutter
- added assigned_values(key or list of keys)

I hope the linked README will now anwer those questions. If not, please let me know.

Afaik this can be done by pointing all subdomains to the same location (with all routes) and use a SetLocale plug (see README) to steer people to the correct localized route.

I have a conversation with @kip from ex_cldr to streamline/align libs and efforts.

Update

• replace live_session with on_mount/1
• add option to get flattened config with composite keys
• use dedicated loc_scope_helper
• add loc_scope_helper to assigns during config compilation

BROKE A FEW THINGS, so use commit 8d2c608208af06e2edd75a0c45f4022f967193e9 to a checkout a working example

Next stop: Add example how to list all alternative routes on a page.
I had this working but the syntax was evil. Will probably add a loc_link macro or patch the native Phoenix link, live_redirect, etc

Update

• The public API is becoming stable
• Localized Routes on Phoenix 0.16 was easier than on Phoenix 0.17. Ah well, got lot’s of goodies in return.
• Lots of refactoring still to do

THE BRAVE MAY START TO USE IT IN AN HOBBY PROJECT

Changelog

• Add example how to list all alternative routes on a page: http://localhost:4000/products

# the original route is wrapped in `PhxLocalizedRoutes.Helpers.loc_route` which receives a scope config (opts).

<%= for {slug, opts} <- ExampleWeb.LocalizedRoutes.local_scopes!(flat: true) do %>
   <span>
       <%= live_redirect " [#{slug}] ", to: PhxLocalizedRoutes.Helpers.loc_route(Routes.product_index_path(@socket, :index), opts) %>
   </span>
<% end %>