route_translator 13.2.1 → 14.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6fce16b25f253c530a462e14251479236768723b507359e93db129274ab14ae
-  data.tar.gz: 0fb41bf9534c717748acc18bd61213998a3648b7808b20ced17132694f84f135
+  metadata.gz: 92c7961768c35baf18cf30e3316b8224ecad45a76e7b0c262f39e9f8945787e9
+  data.tar.gz: 156b961c7893072a233cc8954e7fac1e640bec44ac76681de4611be48191b5ec
 SHA512:
-  metadata.gz: 067e8efc0ef38001c0dee08bf2b7640f497edf0f69448448a0c596b63ac32c0110f906160d2fe34991d0c9f50895ef0f775e903f382c54748fedfae6de8df6eb
-  data.tar.gz: b5b62f4644dc3fd6ad6401927ce4af0b897572467d86ffaabb444254680e9adaf97194a2c3cc17b6bf9abdfdad1213bd350ddeb73c5e9c242c53baef93590387
+  metadata.gz: 9cc77e8f966037a9d7a1b38b04215ca9ba2b0c6ca7d5bd2e2c1252d390c2ba60c4b8cf58f221ed7915a82eee131fe22500d20149f51bfefc78cfa8292d3bacf0
+  data.tar.gz: 1f35cb097d1c2eed38b8b1650d5d05c0b9f8d42e5281d2b5a6dd963786224107337c34651fc0f62176bfb766e961a8acc96646d55fa9b90d9d1b71e84adc43c6

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 14.0.0 / 2023-09-02
+
+* [FEATURE] BREAKING CHANGE: Force standard nested separator (Upgrade guide at [#285](https://github.com/enriclluelles/route_translator/pull/285))
+* [FEATURE] Drop Ruby 2.6 compatibility
+* [FEATURE] Drop Rails < 6.1 compatibility
+* [FEATURE] Add initializer generator
+* [ENHANCEMENT] Update development dependencies
+
 ## 13.2.1 / 2023-07-28
 
 * [BUGFIX] Fix deprecation on Rails Edge

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 5.2, 6.x, and 7.x
+Right now it works with Rails 6.1 and 7.x
 
 
 
@@ -54,7 +54,13 @@ Right now it works with Rails 5.2, 6.x, and 7.x
 
     And execute `bundle install`
 
-3.  Wrap the groups of routes that you want to translate inside a `localized` block:
+3.  Generate the default initializer:
+
+    ```sh
+    bundle exec rails g route_translator:install
+    ```
+
+4.  Wrap the groups of routes that you want to translate inside a `localized` block:
 
     ```ruby
     Rails.application.routes.draw do
@@ -85,7 +91,7 @@ Right now it works with Rails 5.2, 6.x, and 7.x
         pricing: prix
     ```
 
-4.  Your routes are translated! Here's the output of your `rake routes` now:
+5.  Your routes are translated! Here's the output of your `rake routes` now:
 
     ```
             Prefix Verb   URI Pattern                     Controller#Action
@@ -133,7 +139,7 @@ Right now it works with Rails 5.2, 6.x, and 7.x
 
     In :production environment, you should either set `config.i18n.fallbacks = false` or set up translations for your routes in every languages.
 
-5.  If you want to set `I18n.locale` from the url parameter locale, add
+6.  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:
 
@@ -271,22 +277,15 @@ end
 
 | 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 | `{}` |
+| `available_locales` | Limit 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` | Create 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` |  Force the locale to be added to all generated route paths, even for the default locale |  `false` |
+| `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 | `{}` |
 | `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` |
-| `i18n_use_slash_separator` | Use the exact controller path `account/foo` for looking up translations instead of nested keys `account.foo` | `false` |
-
-#### Deprecated options
-
-- `i18n_use_slash_separator` is deprecated and will be forced to `true` in the next major release of Route Translator. This only
-  affects application with nested routes. Please set this option to `true` to remove the deprecation message and ensure
-  to convert nested routes like `people.products` to the new `people/products`.
 
 ### Host-based Locale
 
@@ -348,9 +347,8 @@ es:
   routes:
     favourites: favoritos
     controllers:
-      people:
-        products:
-          favourites: fans
+      people/products:
+        favourites: fans
 ```
 
 Routes will be translated as in:
@@ -362,13 +360,18 @@ people_products_favourites_es GET  /people/products/fans(.:format)       people/
 
 It is also possible to translated resources scoped into a namespace. Example:
 
+```ruby
+namespace :people do
+  resources :products, only: :index
+end
+```
+
 ```yml
 es:
   routes:
     controllers:
-      people:
-        products:
-          products: productos_favoritos
+      people/products:
+        products: productos_favoritos
 ```
 
 Routes will be translated as in:

data/lib/generators/route_translator/install_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RouteTranslator
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Copy RouteTranslator default files'
+      source_root File.expand_path('templates', __dir__)
+
+      def copy_config
+        template 'config/initializers/route_translator.rb'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+# Use this setup block to configure all options available in RouteTranslator.
+RouteTranslator.config do |config|
+  # Limit 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`
+  # config.available_locales = []
+
+  # Create 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
+  # config.disable_fallback = false
+
+  # Force the locale to be added to all generated route paths, even for the
+  # default locale
+  # config.force_locale = false
+
+  # Add translated routes without deleting original unlocalized versions.
+  # Note: Autosets `force_locale` to `true`
+  # config.generate_unlocalized_routes = false
+
+  # 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`
+  # config.generate_unnamed_unlocalized_routes = false
+
+  # Force the locale to be hidden on generated route paths
+  # 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
+  # config.host_locales = {}
+
+  # The param key used to set the locale to the newly generated routes
+  # config.locale_param_key = :locale
+
+  # 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 }`
+  # config.locale_segment_proc = false
+end

data/lib/route_translator/railtie.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module RouteTranslator
+  class Railtie < Rails::Railtie
+    config.eager_load_namespaces << RouteTranslator
+  end
+end

data/lib/route_translator/route.rb

@@ -16,11 +16,7 @@ module RouteTranslator
     def scope
       @scope ||=
         if mapping.defaults[:controller]
-          if RouteTranslator.config.i18n_use_slash_separator
-            %i[routes controllers].push mapping.defaults[:controller]
-          else
-            %i[routes controllers].concat mapping.defaults[:controller].split('/').map(&:to_sym)
-          end
+          %i[routes controllers].push mapping.defaults[:controller]
         else
           %i[routes controllers]
         end

data/lib/route_translator/version.rb

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

data/lib/route_translator.rb

@@ -21,8 +21,7 @@ module RouteTranslator
     hide_locale:                         false,
     host_locales:                        {},
     locale_param_key:                    :locale,
-    locale_segment_proc:                 false,
-    i18n_use_slash_separator:            false
+    locale_segment_proc:                 false
   }.freeze
 
   Configuration = Struct.new(*DEFAULT_CONFIGURATION.keys)
@@ -37,17 +36,7 @@ module RouteTranslator
       @config.hide_locale                         = true
     end
 
-    def check_deprecations
-      return if @config.i18n_use_slash_separator
-
-      deprecator.warn <<~MSG
-        `i18n_use_slash_separator` set to `false` is deprecated and will be
-        removed in the next major release of Route Translator to match
-        Rails' ActiveRecord nested model syntax.
-
-        More information at https://github.com/enriclluelles/route_translator/pull/285
-      MSG
-    end
+    def check_deprecations; end
   end
 
   module_function
@@ -96,3 +85,5 @@ module RouteTranslator
     @deprecator ||= ActiveSupport::Deprecation.new(RouteTranslator::VERSION, 'RouteTranslator')
   end
 end
+
+require 'route_translator/railtie' if defined?(Rails)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: route_translator
 version: !ruby/object:Gem::Version
-  version: 13.2.1
+  version: 14.0.0
 platform: ruby
 authors:
 - Geremia Taglialatela
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-28 00:00:00.000000000 Z
+date: 2023-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.1'
@@ -28,7 +28,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.1'
@@ -38,7 +38,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.1'
@@ -48,7 +48,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.2'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.1'
@@ -64,6 +64,8 @@ files:
 - CHANGELOG.md
 - LICENSE
 - README.md
+- lib/generators/route_translator/install_generator.rb
+- lib/generators/route_translator/templates/config/initializers/route_translator.rb
 - lib/route_translator.rb
 - lib/route_translator/extensions.rb
 - lib/route_translator/extensions/action_controller.rb
@@ -71,6 +73,7 @@ files:
 - lib/route_translator/extensions/route_set.rb
 - lib/route_translator/extensions/test_case.rb
 - lib/route_translator/host.rb
+- lib/route_translator/railtie.rb
 - lib/route_translator/route.rb
 - lib/route_translator/translator.rb
 - lib/route_translator/translator/path.rb
@@ -93,14 +96,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Translate your Rails routes in a simple manner