route_translator 14.2.0 → 15.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 133d2558351805c54d4d96231a01b9b1c4e5137a42895e8c1d3b2eaff55d03c0
-  data.tar.gz: 648a700ae5378e5e11b94034ae5f43808519cf9f931f52d49c14596cca3c6337
+  metadata.gz: 5cca7e784d193668fe69a3b9eae57116700bc4699c1930a79f720de4ce206fbe
+  data.tar.gz: a852fa9a6c8c00bad0223199b1e3ec8159f5bf70774a5bf7b531519c25ccaf4c
 SHA512:
-  metadata.gz: a3675a5b82eb29c7436d881718fff7cb82452266a40f7c6d6053dd7f912bab544fd4773c2e8c7ce20bfbd76643d72c5be4ab037e3990ddb84ab4b2c4d20d8cb8
-  data.tar.gz: 6cba258743408f08ad05e71d05693af3b29740675f093a047990df258904c539400229c7b74c1c5f4282b26a1eefde1cf4268f9b5b1515f3959ef1206467bd23
+  metadata.gz: d85e32c58543f4ef062777a7257f5377f661acc37e4a003c05076824d487020f0c70742c7256262b824596b4247f88fab3ab3ae2f12edccd1610c3cff3236091
+  data.tar.gz: bc6d14c007375d9e0196f965781431c890793588293a23fe4e8ea95c669eca7afab4488e9a3bee3b0f95be72c044081b68fc1f0c5da4651ad68eca5eac64979f

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 15.1.0 / 2025-06-15
+
+* [BUGFIX] Ensure `@localized` is always reset after yield ([#333](https://github.com/enriclluelles/route_translator/issues/333))
+* [ENHANCEMENT] Optimize host locale detection ([#337](https://github.com/enriclluelles/route_translator/pull/337))
+* [ENHANCEMENT] Add `locale_from_request` method ([#337](https://github.com/enriclluelles/route_translator/pull/337))
+
+## 15.0.0 / 2025-06-12
+
+* [FEATURE] Drop Ruby < 3.1 support
+* [BUGFIX] POTENTIAL BREAKING CHANGE: Route helper locale parameters now work without host_locales configuration ([#329](https://github.com/enriclluelles/route_translator/pull/329))
+
 ## 14.2.0 / 2024-11-08
 
 * [FEATURE] Rails 8.0 compatibility

data/README.md

@@ -275,7 +275,7 @@ end
 | `generate_unlocalized_routes` | Add translated routes without deleting original unlocalized versions. **Note:** Autosets `force_locale` to `true` | `false` |
 | `generate_unnamed_unlocalized_routes` | Add the behavior of `force_locale`, but with a named default route which behaves as if `generate_unlocalized_routes` was `true`. `root_path` will redirect to `/en` or `/es`, depending on the value of `I18n.locale` | `false` |
 | `hide_locale` | Force the locale to be hidden on generated route paths | `false` |
-| `host_locales` | Set `I18n.locale` based on `request.host`. Useful for apps accepting requests from more than one domain. See below for more details | `{}` |
+| `host_locales` | Set `I18n.locale` based on `request.host`. Useful for apps accepting requests from more than one domain. The key is a host pattern (supports wildcards for domains, subdomains, and TLDs), and the value is the locale symbol or string to use. See below for more details and examples. | `{}` |
 | `locale_param_key` | The param key used to set the locale to the newly generated routes | `:locale` |
 | `locale_segment_proc` | The locale segment of the url will by default be `locale.to_s.downcase`. You can supply your own mechanism via a Proc that takes `locale` as an argument, e.g. `->(locale) { locale.to_s.upcase }` | `false` |
 
@@ -385,6 +385,39 @@ scope ':country/:locale' do
 end
 ```
 
+## Using RouteTranslator with Devise
+
+When using RouteTranslator with Devise, you may notice that some authentication-related flash messages (such as errors after failed logins) are shown in the wrong language. This happens because Devise builds some messages in middleware, after your controller’s actions have completed. If you use RouteTranslator’s `around_action` (or legacy `around_filter`) to set the locale, the locale is reset after the controller yields, and middleware like Devise will see the default locale.
+
+This only affects you if Devise is mounted inside a localized block (for example, `localized { devise_for :users }`). If you do not use localized Devise routes, you do not need to change anything.
+
+To ensure Devise’s middleware uses the correct locale, some users suggest replacing RouteTranslator’s `around_action` with a `before_action`. However, this is discouraged, as it can leave your application in the wrong locale after the request and may cause subtle bugs.
+
+A better approach is to explicitly set the locale for Devise’s failure responses. Starting from Devise version 4.9.4, you can customize how Devise determines the locale for error messages, thanks to the ability to override the `i18n_locale` method in the failure app. This allows you to set the locale for Devise’s middleware without changing RouteTranslator’s recommended usage.
+
+Here’s an example:
+
+```rb
+# config/initializers/devise.rb
+
+Devise.setup do |config|
+  # ...
+
+  ActiveSupport.on_load(:devise_failure_app) do
+    def i18n_locale
+      RouteTranslator.locale_from_request(request)
+    end
+  end
+end
+```
+
+### Summary
+
+- You only need this workaround if Devise is mounted in a localized block.
+- Do not replace RouteTranslator’s `around_action` with a `before_action`.
+- Instead, set the locale for Devise failure responses as shown above.
+- The solution above requires Devise version 4.9.4 or higher, which allows customizing the `i18n_locale` method in the failure app.
+
 ## Testing
 Testing your controllers with routes-translator is easy, just add a locale parameter as `String` for your localized routes. Otherwise, an `ActionController::UrlGenerationError` will raise.
 

data/lib/generators/route_translator/templates/config/initializers/route_translator.rb

@@ -31,7 +31,10 @@ RouteTranslator.config do |config|
   # config.hide_locale = false
 
   # Set `I18n.locale` based on `request.host`. Useful for apps accepting
-  # requests from more than one domain. See Readme for more details
+  # requests from more than one domain. This option expects a hash where each
+  # key is a host pattern (as a String, supporting `*` wildcards for subdomains
+  # or TLDs), and each value is a locale (as a Symbol or String).
+  # See the README for more details.
   # config.host_locales = {}
 
   # The param key used to set the locale to the newly generated routes

data/lib/route_translator/extensions/action_controller.rb

@@ -9,7 +9,8 @@ module RouteTranslator
     private
 
     def set_locale_from_url
-      locale_from_url = RouteTranslator.locale_from_params(params) || RouteTranslator::Host.locale_from_host(request.host)
+      locale_from_url = RouteTranslator.locale_from_request(request)
+
       if locale_from_url
         old_locale  = I18n.locale
         I18n.locale = locale_from_url

data/lib/route_translator/extensions/mapper.rb

@@ -8,6 +8,7 @@ module ActionDispatch
       def localized
         @localized = true
         yield
+      ensure
         @localized = false
       end
 

data/lib/route_translator/host.rb

@@ -18,11 +18,11 @@ module RouteTranslator
     module_function
 
     def locale_from_host(host)
-      locales = RouteTranslator.config.host_locales.each_with_object([]) do |(pattern, locale), result|
-        result << locale.to_sym if host&.match?(regex_for(pattern))
-      end
-      locales &= I18n.available_locales
-      locales.first&.to_sym
+      available_locales = I18n.available_locales
+
+      RouteTranslator.config.host_locales.find do |pattern, locale|
+        host&.match?(regex_for(pattern)) && available_locales.include?(locale&.to_sym)
+      end&.last&.to_sym
     end
 
     def lambdas_for_locale(locale)

data/lib/route_translator/translator.rb

@@ -10,8 +10,6 @@ module RouteTranslator
       private
 
       def locale_from_args(args)
-        return if RouteTranslator.config.host_locales.blank?
-
         args_hash = args.find { |arg| arg.is_a?(Hash) }
         args_hash&.fetch(:locale, nil)
       end

data/lib/route_translator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RouteTranslator
-  VERSION = '14.2.0'
+  VERSION = '15.1.0'
 end

data/lib/route_translator.rb

@@ -10,7 +10,7 @@ require_relative 'route_translator/version'
 module RouteTranslator
   extend RouteTranslator::Host
 
-  TRANSLATABLE_SEGMENT = /^([-_a-zA-Z0-9]+)(\()?/.freeze
+  TRANSLATABLE_SEGMENT = /^([-_a-zA-Z0-9]+)(\()?/
 
   DEFAULT_CONFIGURATION = {
     available_locales:                   [],
@@ -81,6 +81,10 @@ module RouteTranslator
     locale if I18n.available_locales.include?(locale)
   end
 
+  def locale_from_request(request)
+    locale_from_params(request.params) || Host.locale_from_host(request.host)
+  end
+
   def deprecator
     @deprecator ||= ActiveSupport::Deprecation.new(RouteTranslator::VERSION, 'RouteTranslator')
   end

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: route_translator
 version: !ruby/object:Gem::Version
-  version: 14.2.0
+  version: 15.1.0
 platform: ruby
 authors:
 - Geremia Taglialatela
 - Enric Lluelles
 - Raul Murciano
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-08 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -75,7 +74,6 @@ metadata:
   bug_tracker_uri: https://github.com/enriclluelles/route_translator/issues
   changelog_uri: https://github.com/enriclluelles/route_translator/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/enriclluelles/route_translator
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,15 +81,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Translate your Rails routes in a simple manner
 test_files: []