route_translator 6.0.0 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 453269553066b53ab821eb7c4aa8bce1d9ad4aca1d34d1bc212dc7ca9d70e76a
-  data.tar.gz: '087901c13e29e93f71dc374755afb08f4376d6a4e0c43ccf06bc4a1640325dcf'
+  metadata.gz: b48ef0fed8291cf19c3f8bbbc03276061bbebfeca5ebe69f7cec013e1ec2e41c
+  data.tar.gz: 7601140f98d82f866b9f32a801c1057f0949390df7a0832f8cf8331e1c54c2fd
 SHA512:
-  metadata.gz: 6c43b4217c536688e249f2669c4c814514f5d753caca7fd4185a4b83b8695be73aded8ae39864b59fcc2dfee60007c731bb38df7e52a1c71105d2a6388b1b5b0
-  data.tar.gz: 96cb347e03fcd211d9ba41ee90e2b6d36db6f7b1881d65a609787bc73c17cb1cdddd017cd413c5230f58c9a02f23eebafe7f09de79a996ca65757057f9f5e57b
+  metadata.gz: 823890c7d82fe2918f5eef719ecd3ba204875d68f25dc5659f29870e80db5246926225c47dc79f2af46e64b936a82d9d508bcdfa2eeb1e7be8b0bf63a1ad3414
+  data.tar.gz: 3a0b3401cedb34b0fe9884cbc15f26a3decea8c3984152512869b00ea0cf9d3f26c2db7c275ec110db94338774796cee1417eba97e8b7837ebb045e0ef3856f4

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 7.0.0 / 2019-07-30
+
+* [FEATURE] Add Rails > 6.0.0.rc1 compatibility
+* [FEATURE] Do not set locale from url by default
+* [FEATURE] Do not raise InvalidLocale errors
+* [ENHANCEMENT] Update development dependencies
+
 ## 6.0.0 / 2019-05-16
 
 * [FEATURE] Drop Ruby 2.2 support

data/README.md

@@ -133,14 +133,16 @@ Right now it works with Rails 5.x and Rails 6.0
 
     In :production environment, you should either set `config.i18n.fallbacks = false` or set up translations for your routes in every languages.
 
-5.  Your I18n.locale will be set up automatically from the url param when it's available.
-
-    To disable it add this to your controller:
+5.  If you want to set `I18n.locale` from the url parameter locale, add
+    the following line in your `ApplicationController` or in the controllers
+    that have translated content:
 
     ```ruby
-    skip_around_action :set_locale_from_url
+    around_action :set_locale_from_url
     ```
 
+    Note: you might be tempted to use `before_action` instead of `around_action`: just don't. That could lead to [thread-related issues](https://github.com/enriclluelles/route_translator/issues/44).
+
 
 ### Namespaces
 
@@ -252,50 +254,28 @@ end
 
 ### Available Configurations
 
-* **force_locale**
-  Set this options to `true` to force the locale to be added to all generated route paths, even for the default locale.
-  Defaults to `false`.
-* **hide_locale**
-  Set this options to `true` to force the locale to be hidden on generated route paths.
-  Defaults to `false`.
-* **generate_unlocalized_routes**
-  Set this option to `true` to add translated routes without deleting original unlocalized versions.
-  Autosets `force_locale=true`.
-  Defaults to `false`.
-* **generate_unnamed_unlocalized_routes**
-  Set this option to `true` to 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`.
-  Defaults to `false`.
-* **locale_param_key**
-  The param key that will be used to set the locale to the newly generated routes.
-  Defaults to `:locale`
-* **host_locales**
-  Optional hash to set `I18n.default_locale` based on `request.host`.
-  Useful for apps accepting requests from more than one domain.
-  See below for more details.
-* **disable_fallback**
-  Set this option to `true` to create only the routes for each locale that have translations.
-  For example if we have `/examples` and a translation is not provided for ES, a route helper of `examples_es` will not be created.
-  Defaults to `false`.
-  Useful when one uses this with a locale route constraint, so non-ES routes can 404 on a Spanish website.
-* **available_locales**
-  Use this to limit the locales for which URLs should be generated for. Accepts an array of strings or symbols.
-* **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. `config.locale_segment_proc = ->(locale) { locale.to_s.upcase }`
-* **verify_host_path_consistency**
-  By default, if you use different hosts to translate your application, all translated paths will work on all hosts. Set this option to `true` to force
-  a matching of the host associated locale with the translated path locale as part of the route definition.
-  Defaults to `false`.
+| Option | Description | Default |
+| ------ | ----------- |-------- |
+| `available_locales` | Limits the locales for which URLs should be generated for. Accepts an array of strings or symbols. When empty, translations will be generated for all `I18n.available_locales` | `[]` |
+| `disable_fallback` | Creates routes only for locales that have translations. For example, if we have `/examples` and a translation is not provided for `es`, the route helper of `examples_es` will not be created. Useful when one uses this with a locale route constraint, so non-`es` routes can return a `404` on a Spanish website | `false` |
+| `force_locale` |  Forces the locale to be added to all generated route paths, even for the default locale |  `false` |
+| `generate_unlocalized_routes` | Adds translated routes without deleting original unlocalized versions. **Note:** Autosets `force_locale` to `true` | `false` |
+| `generate_unnamed_unlocalized_routes` | Adds 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` | Forces the locale to be hidden on generated route paths | `false` |
+| `host_locales` | Sets `I18n.locale` based on `request.host`. Useful for apps accepting requests from more than one domain. See below for more details | `{}` |
+| `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` |
+| `verify_host_path_consistency` | Forces a matching of the host associated locale with the translated path locale as part of the route definition. By default, if you use different hosts to translate your application, all translated paths will work on all hosts | `false` |
+
 
 ### Host-based Locale
 
-If you have an application serving requests from more than one domain, you might want to set `I18n.default_locale` dynamically based on which domain the request is coming from.
+If you have an application serving requests from more than one domain, you might want to set `I18n.locale` dynamically based on which domain the request is coming from.
 
 The `host_locales` option is a hash mapping hosts to locales, with full wildcard support to allow matching multiple domains/subdomains/tlds.
 Host matching is case insensitive.
 
-When a request hits your app from a domain matching one of the wild-card matchers defined in `host_locales`, the default_locale will be set to the specified locale.
+When a request hits your app from a domain matching one of the wild-card matchers defined in `host_locales`, the locale will be set to the specified locale.
 Unless you specified the `force_locale` configuration option to `true`, that locale will be hidden from routes (acting like a dynamic `hide_locale` option).
 
 Here are a few examples of possible mappings:
@@ -320,14 +300,16 @@ RouteTranslator.config.host_locales = { '*.com'    => :en, 'russia.*' => :ru } #
 If `host_locales` option is set, the following options will be forced (even if you set to true):
 
 ```ruby
+@config.force_locale                        = false
 @config.generate_unlocalized_routes         = false
 @config.generate_unnamed_unlocalized_routes = false
-@config.force_locale                        = false
 @config.hide_locale                         = false
 ```
 
 This is to avoid odd behaviour brought about by route conflicts and because `host_locales` forces and hides the host-locale dynamically.
 
+NOTE: locale from parameters has priority over the one from hosts.
+
 
 ### Translations for similar routes with different namespaces
 

data/lib/route_translator.rb

@@ -13,36 +13,40 @@ module RouteTranslator
 
   TRANSLATABLE_SEGMENT = /^([-_a-zA-Z0-9]+)(\()?/.freeze
 
-  Configuration = Struct.new(:available_locales, :disable_fallback, :force_locale,
-                             :hide_locale, :host_locales, :generate_unlocalized_routes,
-                             :generate_unnamed_unlocalized_routes, :locale_param_key,
-                             :locale_segment_proc, :verify_host_path_consistency)
+  DEFAULT_CONFIGURATION = {
+    available_locales:                   [],
+    disable_fallback:                    false,
+    force_locale:                        false,
+    generate_unlocalized_routes:         false,
+    generate_unnamed_unlocalized_routes: false,
+    hide_locale:                         false,
+    host_locales:                        {},
+    locale_param_key:                    :locale,
+    locale_segment_proc:                 false,
+    verify_host_path_consistency:        false
+  }.freeze
+
+  Configuration = Struct.new(*DEFAULT_CONFIGURATION.keys)
 
   class << self
     private
 
     def resolve_host_locale_config_conflicts
       @config.force_locale                        = false
-      @config.hide_locale                         = false
       @config.generate_unlocalized_routes         = false
       @config.generate_unnamed_unlocalized_routes = false
+      @config.hide_locale                         = false
     end
   end
 
   module_function
 
   def config(&block)
-    @config                                     ||= Configuration.new
-    @config.available_locales                   ||= []
-    @config.disable_fallback                    ||= false
-    @config.force_locale                        ||= false
-    @config.hide_locale                         ||= false
-    @config.host_locales                        ||= ActiveSupport::OrderedHash.new
-    @config.generate_unlocalized_routes         ||= false
-    @config.generate_unnamed_unlocalized_routes ||= false
-    @config.locale_param_key                    ||= :locale
-    @config.locale_segment_proc                 ||= nil
-    @config.verify_host_path_consistency        ||= false
+    @config ||= Configuration.new
+
+    DEFAULT_CONFIGURATION.each do |option, value|
+      @config[option] ||= value
+    end
 
     yield @config if block
 
@@ -64,4 +68,9 @@ module RouteTranslator
   def locale_param_key
     config.locale_param_key
   end
+
+  def locale_from_params(params)
+    locale = params[config.locale_param_key]&.to_sym
+    locale if I18n.available_locales.include?(locale)
+  end
 end

data/lib/route_translator/extensions/action_controller.rb

@@ -7,22 +7,18 @@ module RouteTranslator
   module Controller
     extend ActiveSupport::Concern
 
-    included do
-      around_action :set_locale_from_url
-    end
-
     private
 
     def set_locale_from_url
-      tmp_locale = params[RouteTranslator.locale_param_key] || RouteTranslator::Host.locale_from_host(request.host)
-      if tmp_locale
-        current_locale = I18n.locale
-        I18n.locale    = tmp_locale
+      locale_from_url = RouteTranslator.locale_from_params(params) || RouteTranslator::Host.locale_from_host(request.host)
+      if locale_from_url
+        old_locale  = I18n.locale
+        I18n.locale = locale_from_url
       end
 
       yield
     ensure
-      I18n.locale = current_locale if tmp_locale
+      I18n.locale = old_locale if locale_from_url
     end
   end
 

data/lib/route_translator/extensions/route_set.rb

@@ -25,18 +25,19 @@ 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)
-        options = scope[:options] ? scope[:options].merge(translated_options) : translated_options
-
-        defaults          = (scope[:defaults] || {}).dup
-        scope_constraints = scope[:constraints] || {}
-
-        blocks = scope[:blocks] ? scope[:blocks].dup : []
+        scope_params = {
+          blocks:      scope[:blocks] || [],
+          constraints: scope[:constraints] || {},
+          defaults:    (scope[:defaults] || {}).dup,
+          module:      scope[:module],
+          options:     scope[:options] ? scope[:options].merge(translated_options) : translated_options
+        }
 
         if RouteTranslator.config.verify_host_path_consistency
-          blocks.push RouteTranslator::HostPathConsistencyLambdas.for_locale(locale)
+          scope_params[:blocks].push RouteTranslator::HostPathConsistencyLambdas.for_locale(locale)
         end
 
-        ::ActionDispatch::Routing::Mapper::Mapping.new(route_set, translated_path_ast, defaults, controller, default_action, scope[:module], to, formatted, scope_constraints, blocks, via, translated_options_constraints, anchor, options)
+        ::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
 
       def add_route_to_set(mapping, path_ast, name, anchor)

data/lib/route_translator/host.rb

@@ -26,7 +26,7 @@ module RouteTranslator
         result << locale.to_sym if host =~ regex_for(pattern)
       end
       locales &= I18n.available_locales
-      (locales.first || I18n.default_locale).to_sym
+      locales.first&.to_sym
     end
   end
 end

data/lib/route_translator/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: route_translator
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 7.0.0
 platform: ruby
 authors:
 - Geremia Taglialatela
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-16 00:00:00.000000000 Z
+date: 2019-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -92,14 +92,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.13.2
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -154,42 +154,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.69.0
+        version: 0.73.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.69.0
+        version: 0.73.0
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: 0.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: 0.17.0
 description: Translates the Rails routes of your application into the languages defined
   in your locale files
 email: