route_translator 13.1.0 → 13.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 773a40298cd3819de8d7801f3ae31b0dc5fcb4c3db65f809570adb1ae0a25e7e
-  data.tar.gz: 9176264924cade856a3c1e2e6b811bb744ca132f4382a377afb45aa4dd79061c
+  metadata.gz: 7cdedc4080c8163372dc065026e2084f00cd8436cb49bbbf0bf9fd3a5624a0b7
+  data.tar.gz: 9b1d8e9b07c2c04e10ce89a976f1cda42efac59a23dabb375361f9ec570418ae
 SHA512:
-  metadata.gz: d20204dae597c1d97111bf3f75d2079dd027bd71f8c36918d65be770daed4c5eb695d7802977b0650d9bd394861e93b5293d512f6dbc29d3e766ad9619ce5145
-  data.tar.gz: 87155014e01709f6418964b4278b699b2009371e03c69eb6b75d0ac32f1d579a6f415f3437fb77b08b0044fb954aefcb02e03cfe2f387b703fe9a94d40f38729
+  metadata.gz: 657a89132bee2d9d8b28a1d4940c36e2326b736ec1edb2815756108fae10e69b55b1d166c7b56ec77a0ad271ce54aad9928fe9624152d5de7b51bb8e342a900a
+  data.tar.gz: fbb5fec9b9443e5e2d6eee402a2394248742dbe7a47d144791670aefd3880319e2e1203ab4a4fde3fb38c4ead477ec64baddd460d066abe4033240e68eb08587

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 13.2.0 / 2023-07-28
+
+* [FEATURE] Add option for standard nested separator ([#285](https://github.com/enriclluelles/route_translator/pull/285))
+* [ENHANCEMENT] Update development dependencies
+
+## 13.1.1 / 2023-07-01
+
+* [ENHANCEMENT] Better integration with ActionController::TestCase
+* [ENHANCEMENT] Remove Rails 5.1 code
+* [ENHANCEMENT] Update development dependencies
+
 ## 13.1.0 / 2022-12-26
 
 * [ENHANCEMENT] Test against Ruby 3.1 and Ruby 3.2

data/README.md

@@ -280,7 +280,13 @@ end
 | `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` |
+| `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
 

data/lib/route_translator/route.rb

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

data/lib/route_translator/translator/route_helpers.rb

@@ -3,17 +3,9 @@
 module RouteTranslator
   module Translator
     module RouteHelpers
-      class << self
-        private
-
-        def add_helpers_to_test_cases(helper_container)
-          %w[ActionController ActionMailer ActionView].each do |klass_name|
-            next unless Module.const_defined?(klass_name)
-
-            klass_name.constantize::TestCase.__send__(:include, helper_container)
-          end
-        end
-      end
+      TEST_CASE_HOOKS = %i[
+        action_controller_test_case action_mailer_test_case action_view_test_case
+      ].freeze
 
       module_function
 
@@ -27,15 +19,19 @@ module RouteTranslator
 
         %w[path url].each do |suffix|
           helper_container = named_route_collection.send(:"#{suffix}_helpers_module")
-          new_helper_name = "#{old_name}_#{suffix}"
+          new_helper_name = :"#{old_name}_#{suffix}"
 
-          helper_list.push(new_helper_name.to_sym) unless helper_list.include?(new_helper_name.to_sym)
+          helper_list.push(new_helper_name) unless helper_list.include?(new_helper_name)
 
           helper_container.__send__(:define_method, new_helper_name) do |*args|
             __send__(Translator.route_name_for(args, old_name, suffix, self), *args)
           end
 
-          add_helpers_to_test_cases(helper_container) if ENV.fetch('RAILS_ENV', nil) == 'test'
+          TEST_CASE_HOOKS.each do |test_case_hook|
+            ActiveSupport.on_load(test_case_hook) do
+              include helper_container
+            end
+          end
         end
       end
     end

data/lib/route_translator/version.rb

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

data/lib/route_translator.rb

@@ -20,7 +20,8 @@ module RouteTranslator
     hide_locale:                         false,
     host_locales:                        {},
     locale_param_key:                    :locale,
-    locale_segment_proc:                 false
+    locale_segment_proc:                 false,
+    i18n_use_slash_separator:            false
   }.freeze
 
   Configuration = Struct.new(*DEFAULT_CONFIGURATION.keys)
@@ -34,6 +35,18 @@ module RouteTranslator
       @config.generate_unnamed_unlocalized_routes = false
       @config.hide_locale                         = true
     end
+
+    def check_deprecations
+      return if @config.i18n_use_slash_separator
+
+      ActiveSupport::Deprecation.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
   end
 
   module_function
@@ -48,6 +61,7 @@ module RouteTranslator
     yield @config if block_given?
 
     resolve_host_locale_config_conflicts if @config.host_locales.present?
+    check_deprecations
 
     @config
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: route_translator
 version: !ruby/object:Gem::Version
-  version: 13.1.0
+  version: 13.2.0
 platform: ruby
 authors:
 - Geremia Taglialatela
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-26 00:00:00.000000000 Z
+date: 2023-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -52,110 +52,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '7.1'
-- !ruby/object:Gem::Dependency
-  name: appraisal
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.4'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.1'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.16'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.16'
-- !ruby/object:Gem::Dependency
-  name: rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '7.1'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.22.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.22.0
-- !ruby/object:Gem::Dependency
-  name: simplecov-lcov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.8.0
 description: Translates the Rails routes of your application into the languages defined
   in your locale files
 email:
@@ -204,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: Translate your Rails routes in a simple manner