Gettext i18n

[serpent213]

A simple wrapper to invoke gettext if available.

Would solve #110, #559.

What you think of this implementation?

Missing: Tests, default .pot, maybe .po files, docs

[zachdaniel]

Looks great to me, I think this is pretty much the only way (and definitely the most standard way) to do it. @jimsynz what do you think?

[serpent213]

One variation might be to let the user inject a generic translate(msg) function instead of a Gettext backend. Would allow for other translation libraries to be used.

[serpent213]

Would suggest to go the latter route and not have Gettext as dependency. Instead extend the Igniter installer to check for Gettext availability and in case offer to setup the translate function and copy the language files.

[zachdaniel]

🤔 I hadn't considered it, but yeah it's a good point. The implementation would look roughly the same except you'd be fetching a translation function from config for the app in question (probably best at the app config level, i.e config :my_app, ...), instead of using gettext directly. We can then revisit for next steps, i.e to adjust the installer/provide pot/po files.

[clifinger]

Hello guys,

Do you need some help?

[serpent213]

Hello guys,

Do you need some help?

Sure! 🙂

Manual testing: There might be some pieces of text left that need to be wrapped in _gettext() invocations to get translated (just added some more). Also, for manual tests I only have password strategy set up, so visual inspection of the other strategies would be great.

Language files: A number of untranslated strings are missing from the .pot file, would be great to complete those. Next step would be to collect translations to various languages.

[serpent213]

🤔 I hadn't considered it, but yeah it's a good point. The implementation would look roughly the same except you'd be fetching a translation function from config for the app in question (probably best at the app config level, i.e config :my_app, ...), instead of using gettext directly. We can then revisit for next steps, i.e to adjust the installer/provide pot/po files.

I left the config under :ash_authentication_phoenix for now. How would you name the key under :my_app?

This variant requires a config like

config :ash_authentication_phoenix, gettext_fn: {MyAppWeb.Gettext, :translate}

with a translate fn in MyAppWeb.Gettext like

  def translate(msgid, bindings \\ []), do: Gettext.dgettext(__MODULE__, "auth", msgid, bindings)

[serpent213]

Hello guys,

Do you need some help?

In general: just try it out and see if it works for you! 🙂

Apply the above config, copy the language files, point the dep to this branch:

{:ash_authentication_phoenix, git: "https://github.com/serpent213/ash_authentication_phoenix.git", branch: "gettext", override: true},

[zachdaniel]

Small note: this should include #562 before being released.

[zachdaniel]

IIRC we pass the :otp_app in as an assign in the on mount hook

[jimsynz]

Hey folks. Thank you for this!

🙌

The reason I didn't address it when building AAP was because I've never actually worked on an app with translations in place, so wanted to leave it until someone with more knowledge shows up rather than just getting it wrong based on my english-based assumptions.

I'm afraid I couldn't say whether this is the right approach or not - I'm just going to leave it up to you folks to decide amongst yourselves and let me know when to merge it 😄

[serpent213]

Refactored it again: We carry around the gettext_fn (is there a better name?) in parallel to overrides now to every single component, so it can be set on component invocation or as well using the router macro. Feels like a more clean and flexible approach.

sign_in_route register_path: "/register",
  reset_path: "/reset",
  auth_routes_prefix: "/auth",
  gettext_fn: {AshAuthentication.Phoenix.Test.Helper, :gettext}

Will polish it a little, add some docs and we should be good to go.

[serpent213]

Ready from my side.

[zachdaniel]

🔥

[zachdaniel]

Looks great to me!

[zachdaniel]

@jimsynz mind giving it a once over?

[zachdaniel]

🚀 Thank you for your contribution! 🚀

[clifinger]

Thank you bro, it' s was really needed.
You did it too fast for me ...