route_translator 14.1.2 → 15.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b83ad5a7f021e3075faab30ba9b41a666ac151d57f0d8bd6d8656f3c16d451a
-  data.tar.gz: e00dd5992f16425a6b85e84cd6d1781d7ab6aaa700b3fe2892fd197af5210460
+  metadata.gz: 13e7ca36c52b904acf706a63b2cc0b352ed0206010b69dbf65eba016ab2fefdb
+  data.tar.gz: 6721c17d101b7528a9a603ff196c0fabdc49d4b0ca54a42e3b842213ef585ead
 SHA512:
-  metadata.gz: 9ac6359f07f206dd559fda1bb5e56ef3ceb22bda5c9f973449cd7963a6a14d9604ca94d87e31fd29cb926bafe54c5b825f8ed378e7f2d363433671d7e4e6b8af
-  data.tar.gz: 27c0b19f09b9c6835aafaf14ded61499b7f1c9f0821d753c6ace7ca228e154f2f8e04cafd22fb0060debe7e65cf25b57827ae5bc1cf99f8fc1c16995a88b16af
+  metadata.gz: 4837bc35c697c191a1219d42c5e8a6a05241aaa2cce847dfee6e000acfb460335b6007c1d499c1a049ece53cbff466a3647385e1a5b85c8ff9e6b65f7da98cbc
+  data.tar.gz: 2fe7754133ec168a03208316f98ea24696700dc03766d9b86bbbee25785e77f85d0445f82fedebc45fd43a8b51f4fc28bbae57d817d0f1bb206a0bc0b82fcb9b

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changelog
 
+## 15.2.0 / 2025-07-06
+
+* [FEATURE] Rails 8.1 edge support ([#344](https://github.com/enriclluelles/route_translator/pull/344))
+
+## 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 ([#340](https://github.com/enriclluelles/route_translator/pull/340))
+
+## 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
+
 ## 14.1.2 / 2024-05-27
 
 * [ENHANCEMENT] Test against Ruby 3.3

data/README.md

@@ -9,7 +9,7 @@ RouteTranslator is a gem to allow you to manage the translations of your app rou
 
 It started as a fork of the awesome [translate_routes](https://github.com/raul/translate_routes) plugin by [Raúl Murciano](https://github.com/raul).
 
-Right now it works with Rails 6.1 and 7.x
+Right now it works with Rails 6.1, 7.x, and 8.0
 
 ## Quick Start
 
@@ -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/legacy/mapper.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module ActionDispatch
+  module Routing
+    class Mapper
+      def localized
+        @localized = true
+        yield
+      ensure
+        @localized = false
+      end
+
+      # rubocop:disable Lint/UnderscorePrefixedVariableName, Metrics/PerceivedComplexity
+      def add_route(action, controller, options, _path, to, via, formatted, anchor, options_constraints) # :nodoc:
+        return super unless @localized
+
+        path = path_for_action(action, _path)
+        raise ArgumentError, 'path is required' if path.blank?
+
+        action = action.to_s
+
+        default_action = options.delete(:action) || @scope[:action]
+
+        if %r{^[\w\-\/]+$}.match?(action)
+          default_action ||= action.tr('-', '_') unless action.include?('/')
+        else
+          action = nil
+        end
+
+        as = if options.fetch(:as, true)
+               name_for_action(options.delete(:as), action)
+             else
+               options.delete(:as)
+             end
+
+        path = Mapping.normalize_path URI::DEFAULT_PARSER.escape(path), formatted
+        ast = Journey::Parser.parse path
+
+        mapping = Mapping.build(@scope, @set, ast, controller, default_action, to, via, formatted, options_constraints, anchor, options)
+        @set.add_localized_route(mapping, as, anchor, @scope, path, controller, default_action, to, via, formatted, options_constraints, options)
+      end
+      # rubocop:enable Lint/UnderscorePrefixedVariableName, Metrics/PerceivedComplexity
+
+      private
+
+      def define_generate_prefix(app, name)
+        return super unless @localized
+
+        RouteTranslator::Translator.available_locales.each do |locale|
+          super(app, "#{name}_#{locale.to_s.underscore}")
+        end
+      end
+    end
+  end
+end

data/lib/route_translator/extensions/legacy/route_set.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ActionDispatch
+  module Routing
+    class RouteSet
+      def add_localized_route(mapping, name, anchor, scope, path, controller, default_action, to, via, formatted, options_constraints, options)
+        route = RouteTranslator::Route.new(self, path, name, options_constraints, options, mapping)
+
+        RouteTranslator::Translator.translations_for(route) do |locale, translated_name, translated_path, translated_options_constraints, translated_options|
+          translated_path_ast = ::ActionDispatch::Journey::Parser.parse(translated_path)
+          translated_mapping  = translate_mapping(locale, self, translated_options, translated_path_ast, scope, controller, default_action, to, formatted, via, translated_options_constraints, anchor)
+
+          add_route translated_mapping, translated_name
+        end
+
+        if RouteTranslator.config.generate_unnamed_unlocalized_routes
+          add_route mapping, nil
+        elsif RouteTranslator.config.generate_unlocalized_routes
+          add_route mapping, name
+        end
+      end
+
+      private
+
+      def translate_mapping(locale, route_set, translated_options, translated_path_ast, scope, controller, default_action, to, formatted, via, translated_options_constraints, anchor)
+        scope_params = {
+          blocks:      (scope[:blocks] || []).dup,
+          constraints: scope[:constraints] || {},
+          defaults:    scope[:defaults] || {},
+          module:      scope[:module],
+          options:     scope[:options] ? scope[:options].merge(translated_options) : translated_options
+        }
+
+        if RouteTranslator.config.host_locales.present?
+          scope_params[:blocks].push RouteTranslator::Host.lambdas_for_locale(locale)
+        end
+
+        ::ActionDispatch::Routing::Mapper::Mapping.build scope_params, route_set, translated_path_ast, controller, default_action, to, via, formatted, translated_options_constraints, anchor, translated_options
+      end
+    end
+  end
+end

data/lib/route_translator/extensions/mapper.rb

@@ -1,18 +1,17 @@
 # frozen_string_literal: true
 
-require 'action_dispatch'
-
 module ActionDispatch
   module Routing
     class Mapper
       def localized
         @localized = true
         yield
+      ensure
         @localized = false
       end
 
       # rubocop:disable Lint/UnderscorePrefixedVariableName, Metrics/PerceivedComplexity
-      def add_route(action, controller, options, _path, to, via, formatted, anchor, options_constraints) # :nodoc:
+      def add_route(action, controller, as, options_action, _path, to, via, formatted, anchor, options_constraints, internal, options_mapping) # :nodoc:
         return super unless @localized
 
         path = path_for_action(action, _path)
@@ -20,25 +19,20 @@ module ActionDispatch
 
         action = action.to_s
 
-        default_action = options.delete(:action) || @scope[:action]
+        default_action = options_action || @scope[:action]
 
-        if %r{^[\w\-\/]+$}.match?(action)
+        if %r{^[\w\-/]+$}.match?(action)
           default_action ||= action.tr('-', '_') unless action.include?('/')
         else
           action = nil
         end
 
-        as = if options.fetch(:as, true)
-               name_for_action(options.delete(:as), action)
-             else
-               options.delete(:as)
-             end
-
-        path = Mapping.normalize_path URI::DEFAULT_PARSER.escape(path), formatted
-        ast = Journey::Parser.parse path
+        as   = name_for_action(as, action) if as
+        path = Mapping.normalize_path URI::RFC2396_PARSER.escape(path), formatted
+        ast  = Journey::Parser.parse path
 
-        mapping = Mapping.build(@scope, @set, ast, controller, default_action, to, via, formatted, options_constraints, anchor, options)
-        @set.add_localized_route(mapping, as, anchor, @scope, path, controller, default_action, to, via, formatted, options_constraints, options)
+        mapping = Mapping.build(@scope, @set, ast, controller, default_action, to, via, formatted, options_constraints, anchor, internal, options_mapping)
+        @set.add_localized_route(mapping, as, anchor, @scope, path, controller, default_action, to, via, formatted, options_constraints, internal, options_mapping)
       end
       # rubocop:enable Lint/UnderscorePrefixedVariableName, Metrics/PerceivedComplexity
 

data/lib/route_translator/extensions/route_set.rb

@@ -1,16 +1,14 @@
 # frozen_string_literal: true
 
-require 'action_dispatch'
-
 module ActionDispatch
   module Routing
     class RouteSet
-      def add_localized_route(mapping, name, anchor, scope, path, controller, default_action, to, via, formatted, options_constraints, options)
-        route = RouteTranslator::Route.new(self, path, name, options_constraints, options, mapping)
+      def add_localized_route(mapping, name, anchor, scope, path, controller, default_action, to, via, formatted, options_constraints, internal, options_mapping)
+        route = RouteTranslator::Route.new(self, path, name, options_constraints, options_mapping, mapping)
 
         RouteTranslator::Translator.translations_for(route) do |locale, translated_name, translated_path, translated_options_constraints, translated_options|
           translated_path_ast = ::ActionDispatch::Journey::Parser.parse(translated_path)
-          translated_mapping  = translate_mapping(locale, self, translated_options, translated_path_ast, scope, controller, default_action, to, formatted, via, translated_options_constraints, anchor)
+          translated_mapping  = translate_mapping(locale, self, translated_options, translated_path_ast, scope, controller, default_action, to, formatted, via, translated_options_constraints, anchor, internal)
 
           add_route translated_mapping, translated_name
         end
@@ -24,7 +22,7 @@ module ActionDispatch
 
       private
 
-      def translate_mapping(locale, route_set, translated_options, translated_path_ast, scope, controller, default_action, to, formatted, via, translated_options_constraints, anchor)
+      def translate_mapping(locale, route_set, translated_options, translated_path_ast, scope, controller, default_action, to, formatted, via, translated_options_constraints, anchor, internal)
         scope_params = {
           blocks:      (scope[:blocks] || []).dup,
           constraints: scope[:constraints] || {},
@@ -37,7 +35,7 @@ module ActionDispatch
           scope_params[:blocks].push RouteTranslator::Host.lambdas_for_locale(locale)
         end
 
-        ::ActionDispatch::Routing::Mapper::Mapping.build scope_params, route_set, translated_path_ast, controller, default_action, to, via, formatted, translated_options_constraints, anchor, translated_options
+        ::ActionDispatch::Routing::Mapper::Mapping.build scope_params, route_set, translated_path_ast, controller, default_action, to, via, formatted, translated_options_constraints, anchor, internal, translated_options
       end
     end
   end

data/lib/route_translator/extensions.rb

@@ -1,5 +1,14 @@
 # frozen_string_literal: true
 
-require 'route_translator/extensions/mapper'
-require 'route_translator/extensions/route_set'
-require 'route_translator/extensions/action_controller'
+require 'action_dispatch'
+
+# TODO: Remove `else` branch when dropping Rails < 8.1 support
+if ActionDispatch::Routing::Mapper.instance_method(:add_route).arity == 12
+  require_relative 'extensions/mapper'
+  require_relative 'extensions/route_set'
+else
+  require_relative 'extensions/legacy/mapper'
+  require_relative 'extensions/legacy/route_set'
+end
+
+require_relative 'extensions/action_controller'

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/path/segment.rb

@@ -24,8 +24,8 @@ module RouteTranslator
             handler = proc { |exception| exception }
             opts    = { locale: locale, scope: scope }
 
-            if I18n.t(str, **opts.merge(exception_handler: handler)).is_a?(I18n::MissingTranslation)
-              I18n.t! str, **opts.merge(fallback_options(str, locale))
+            if I18n.t(str, **opts, exception_handler: handler).is_a?(I18n::MissingTranslation)
+              I18n.t! str, **opts, **fallback_options(str, locale)
             else
               I18n.t str, **opts
             end

data/lib/route_translator/translator/path.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'route_translator/translator/path/segment'
+require_relative 'path/segment'
 
 module RouteTranslator
   module Translator

data/lib/route_translator/translator.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'route_translator/translator/route_helpers'
-require 'route_translator/translator/path'
-require 'route_translator/route'
+require_relative 'translator/route_helpers'
+require_relative 'translator/path'
+require_relative 'route'
 
 module RouteTranslator
   module Translator
@@ -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.1.2'
+  VERSION = '15.2.0'
 end

data/lib/route_translator.rb

@@ -2,15 +2,15 @@
 
 require 'active_support'
 
-require 'route_translator/extensions'
-require 'route_translator/translator'
-require 'route_translator/host'
-require 'route_translator/version'
+require_relative 'route_translator/extensions'
+require_relative 'route_translator/translator'
+require_relative 'route_translator/host'
+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.1.2
+  version: 15.2.0
 platform: ruby
 authors:
 - Geremia Taglialatela
 - Enric Lluelles
 - Raul Murciano
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -19,9 +18,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,9 +25,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -39,9 +32,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,9 +39,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '6.1'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '8.0'
 description: Translates the Rails routes of your application into the languages defined
   in your locale files
 email:
@@ -69,6 +56,8 @@ files:
 - lib/route_translator.rb
 - lib/route_translator/extensions.rb
 - lib/route_translator/extensions/action_controller.rb
+- lib/route_translator/extensions/legacy/mapper.rb
+- lib/route_translator/extensions/legacy/route_set.rb
 - lib/route_translator/extensions/mapper.rb
 - lib/route_translator/extensions/route_set.rb
 - lib/route_translator/extensions/test_case.rb
@@ -87,7 +76,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
@@ -95,15 +83,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.9
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Translate your Rails routes in a simple manner
 test_files: []