route_translator 8.0.0 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d4b8e7e2caf751b79880c5798d2d2572f97785421d51eb44100498b9bc242f7
-  data.tar.gz: 0b3ec104b2ce65767306a5a9407aa011e12ebdf5c7567d9b158730be010896bc
+  metadata.gz: 6ba0fdafb1a82378946c98b7c75a8c659fa83daba8254def31c34a73d8ac243c
+  data.tar.gz: dd8f448c13448b158d5511e36ebba28bbfd6a2a8eaa2f1f7b387d803d735b654
 SHA512:
-  metadata.gz: 3a82c507227121a3a084da6677c020f2f491c1997cf5d685f720e03435df6fb4b121b212b2e9abb93a27f3aa084882eabace774ae9cd80c9a8febf4b4574d347
-  data.tar.gz: a974a9f997cdf34cc5e8c359673454356bef88213e318aab3b8e83ac0d7e4af0cf1ee82637f7105c8d740a2c298fb92f4ed3d47c50b2fb296c2485c78343b004
+  metadata.gz: 9cb4821500c0ca720fb8dac607c8d349f67e54fa2b9424b5418241e29526bcc6632fd19b8420ab4ff52195eb61cbb0adc6cb9084b43005a17d8f2bc0ab177e47
+  data.tar.gz: 56ddc940436e550ed783bd0b83ced6418ecb06ff1a5a5332218b1d4f1e02e051c825c7020aa22eca795477d1c7d250bd2a064de94bd61f76e5393d790e73ee58

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## 10.0.0 / 2021-01-16
+
+* [BUGFIX] Verify host path consistency by default ([#91](https://github.com/enriclluelles/route_translator/issues/91), [#171](https://github.com/enriclluelles/route_translator/issues/171))
+* [FEATURE] Remove the option to verify host path consistency
+* [ENHANCEMENT] Avoid duplicate routes when using host_locales ([#87](https://github.com/enriclluelles/route_translator/issues/87), [#171](https://github.com/enriclluelles/route_translator/issues/171))
+* [ENHANCEMENT] Test against Ruby 3.0.0
+* [ENHANCEMENT] Update development dependencies
+
+## 9.0.0 / 2020-11-07
+
+* [ENHANCEMENT] Check for `empty?` instead of `any?` on available_locales array
+* [ENHANCEMENT] Update development dependencies
+
+## 8.2.1 / 2020-11-03
+
+* [ENHANCEMENT] Fix deprecation with URI.parser ([#234](https://github.com/enriclluelles/route_translator/pull/234))
+
+## 8.2.0 / 2020-11-03
+
+* [FEATURE] Add Rails 6.1 compatibility
+* [ENHANCEMENT] Update development dependencies
+
+## 8.1.0 / 2020-08-10
+
+* [FEATURE] Allow Ruby 3.0.0
+* [ENHANCEMENT] Test against latest Ruby versions
+* [ENHANCEMENT] Update development dependencies
+
 ## 8.0.0 / 2020-04-17
 
 * [FEATURE] Drop Ruby 2.3 support

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2007 Raul Murciano [http://raul.murciano.net], Domestika INTERNET S.L. [http://domestika.org], 2015 Enric Lluelles [http://enric.lluell.es], 2020 Geremia Taglialatela
+Copyright (c) 2007 Raul Murciano [http://raul.murciano.net], Domestika INTERNET S.L. [http://domestika.org], 2015 Enric Lluelles [http://enric.lluell.es], 2021 Geremia Taglialatela
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,6 +1,7 @@
 # RouteTranslator
 
 [![Gem Version](https://badge.fury.io/rb/route_translator.svg)](https://badge.fury.io/rb/route_translator)
+[![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=route_translator&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=route_translator&package-manager=bundler&version-scheme=semver)
 [![Build Status](https://travis-ci.org/enriclluelles/route_translator.svg?branch=master)](https://travis-ci.org/enriclluelles/route_translator)
 [![Maintainability](https://api.codeclimate.com/v1/badges/1c369ce6147724b353fc/maintainability)](https://codeclimate.com/github/enriclluelles/route_translator/maintainability)
 [![Coverage Status](https://coveralls.io/repos/github/enriclluelles/route_translator/badge.svg?branch=master)](https://coveralls.io/github/enriclluelles/route_translator?branch=master)
@@ -9,7 +10,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.x and Rails 6.0
+Right now it works with Rails 5.x and Rails 6.x
 
 
 
@@ -144,6 +145,21 @@ Right now it works with Rails 5.x and Rails 6.0
     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).
 
 
+### Changing the Language
+
+To change the language and reload the appropriate route while staying on the same page, use the following code snippet:
+
+```ruby
+link_to url_for(locale: 'es'), hreflang: 'es', rel: 'alternate'
+```
+
+Although locales are stored by Rails as a symbol (`:es`), when linking to a page in a different locale you need to use a string (`'es'`). Otherwise, instead of a namespaced route (`/es/my-route`) you will get a parameterized route (`/my-route?locale=es`).
+
+If the page contains a localized slug, the above snippet does not work and a custom implementation is neede.
+
+More information at [Generating translated URLs](https://github.com/enriclluelles/route_translator/wiki/Generating-translated-URLs)
+
+
 ### Namespaces
 
 You can translate a namespace route by either its `name` or `path` option:
@@ -265,7 +281,6 @@ 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` |
-| `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
@@ -297,13 +312,13 @@ RouteTranslator.config.host_locales = { 'russia.*' => :ru, '*.com'    => :en } #
 RouteTranslator.config.host_locales = { '*.com'    => :en, 'russia.*' => :ru } # 'russia.com' will have locale :en
 ```
 
-If `host_locales` option is set, the following options will be forced (even if you set to true):
+If `host_locales` option is set, the following options will be forced:
 
 ```ruby
 @config.force_locale                        = false
 @config.generate_unlocalized_routes         = false
 @config.generate_unnamed_unlocalized_routes = false
-@config.hide_locale                         = false
+@config.hide_locale                         = true
 ```
 
 This is to avoid odd behaviour brought about by route conflicts and because `host_locales` forces and hides the host-locale dynamically.

data/lib/route_translator.rb

@@ -6,8 +6,6 @@ require 'addressable/uri'
 require 'route_translator/extensions'
 require 'route_translator/translator'
 require 'route_translator/host'
-require 'route_translator/host_path_consistency_lambdas'
-require 'route_translator/locale_sanitizer'
 
 module RouteTranslator
   extend RouteTranslator::Host
@@ -23,8 +21,7 @@ module RouteTranslator
     hide_locale:                         false,
     host_locales:                        {},
     locale_param_key:                    :locale,
-    locale_segment_proc:                 false,
-    verify_host_path_consistency:        false
+    locale_segment_proc:                 false
   }.freeze
 
   Configuration = Struct.new(*DEFAULT_CONFIGURATION.keys)
@@ -36,7 +33,7 @@ module RouteTranslator
       @config.force_locale                        = false
       @config.generate_unlocalized_routes         = false
       @config.generate_unnamed_unlocalized_routes = false
-      @config.hide_locale                         = false
+      @config.hide_locale                         = true
     end
   end
 
@@ -65,10 +62,10 @@ module RouteTranslator
   def available_locales
     locales = config.available_locales
 
-    if locales.any?
-      locales.map(&:to_sym)
-    else
+    if locales.empty?
       I18n.available_locales.dup
+    else
+      locales.map(&:to_sym)
     end
   end
 

data/lib/route_translator/extensions/mapper.rb

@@ -11,7 +11,7 @@ module ActionDispatch
         @localized = false
       end
 
-      # rubocop:disable Lint/UnderscorePrefixedVariableName
+      # rubocop:disable Lint/UnderscorePrefixedVariableName, Metrics/PerceivedComplexity
       def add_route(action, controller, options, _path, to, via, formatted, anchor, options_constraints) # :nodoc:
         return super unless @localized
 
@@ -28,19 +28,19 @@ module ActionDispatch
           action = nil
         end
 
-        as = if !options.fetch(:as, true) # if it's set to nil or false
-               options.delete(:as)
-             else
+        as = if options.fetch(:as, true)
                name_for_action(options.delete(:as), action)
+             else
+               options.delete(:as)
              end
 
-        path = Mapping.normalize_path URI.parser.escape(path), formatted
+        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, ast, as, anchor, @scope, path, controller, default_action, to, via, formatted, options_constraints, options)
       end
-      # rubocop:enable Lint/UnderscorePrefixedVariableName
+      # rubocop:enable Lint/UnderscorePrefixedVariableName, Metrics/PerceivedComplexity
 
       private
 

data/lib/route_translator/extensions/route_set.rb

@@ -33,8 +33,8 @@ module ActionDispatch
           options:     scope[:options] ? scope[:options].merge(translated_options) : translated_options
         }
 
-        if RouteTranslator.config.verify_host_path_consistency
-          scope_params[:blocks].push RouteTranslator::HostPathConsistencyLambdas.for_locale(locale)
+        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

data/lib/route_translator/host.rb

@@ -5,20 +5,16 @@ module RouteTranslator
     class << self
       private
 
+      def lambdas
+        @lambdas ||= {}
+      end
+
       def regex_for(host_string)
         escaped = Regexp.escape(host_string).gsub('\*', '.*?').gsub('\.', '\.?')
         Regexp.new("^#{escaped}$", Regexp::IGNORECASE)
       end
     end
 
-    def native_locale?(locale)
-      locale.to_s.match(/native_/).present?
-    end
-
-    def native_locales
-      config.host_locales.values.map { |locale| :"native_#{locale}" }
-    end
-
     module_function
 
     def locale_from_host(host)
@@ -28,5 +24,9 @@ module RouteTranslator
       locales &= I18n.available_locales
       locales.first&.to_sym
     end
+
+    def lambdas_for_locale(locale)
+      lambdas[locale] ||= ->(req) { locale == RouteTranslator::Host.locale_from_host(req.host) }
+    end
   end
 end

data/lib/route_translator/translator.rb

@@ -26,7 +26,7 @@ module RouteTranslator
         translated_options = options.dup
 
         if translated_options.exclude?(RouteTranslator.locale_param_key)
-          translated_options[RouteTranslator.locale_param_key] = RouteTranslator::LocaleSanitizer.sanitize(locale)
+          translated_options[RouteTranslator.locale_param_key] = locale.to_s
         end
 
         translated_options
@@ -53,7 +53,6 @@ module RouteTranslator
 
     def available_locales
       locales = RouteTranslator.available_locales
-      locales.concat(RouteTranslator.native_locales) if RouteTranslator.native_locales.present?
       # Make sure the default locale is translated in last place to avoid
       # problems with wildcards when default locale is omitted in paths. The
       # default routes will catch all paths like wildcard if it is translated first.
@@ -82,8 +81,6 @@ module RouteTranslator
 
       locale = if args_locale
                  args_locale.to_s.underscore
-               elsif kaller.respond_to?("#{old_name}_native_#{current_locale_name}_#{suffix}")
-                 "native_#{current_locale_name}"
                elsif kaller.respond_to?("#{old_name}_#{current_locale_name}_#{suffix}")
                  current_locale_name
                else

data/lib/route_translator/translator/path.rb

@@ -9,8 +9,7 @@ module RouteTranslator
         private
 
         def display_locale?(locale)
-          !RouteTranslator.config.hide_locale && !RouteTranslator.native_locale?(locale) &&
-            (!default_locale?(locale) || config_requires_locale?)
+          !RouteTranslator.config.hide_locale && (!default_locale?(locale) || config_requires_locale?)
         end
 
         def config_requires_locale?

data/lib/route_translator/translator/path/segment.rb

@@ -24,16 +24,15 @@ module RouteTranslator
             handler = proc { |exception| exception }
             opts    = { locale: locale, scope: scope }
 
-            if I18n.translate(str, **opts.merge(exception_handler: handler)).is_a?(I18n::MissingTranslation)
-              I18n.translate str, **opts.merge(fallback_options(str, locale))
+            if I18n.t(str, **opts.merge(exception_handler: handler)).is_a?(I18n::MissingTranslation)
+              I18n.t str, **opts.merge(fallback_options(str, locale))
             else
-              I18n.translate str, **opts
+              I18n.t str, **opts
             end
           end
 
           def translate_string(str, locale, scope)
-            sanitized_locale = RouteTranslator::LocaleSanitizer.sanitize(locale)
-            translated_resource = translate_resource(str, sanitized_locale, scope)
+            translated_resource = translate_resource(str, locale.to_s, scope)
 
             Addressable::URI.normalize_component translated_resource
           end
@@ -51,12 +50,12 @@ module RouteTranslator
         def translate(segment, locale, scope)
           return segment if segment.empty?
 
-          if segment.starts_with?(':')
+          if segment.start_with?(':')
             named_param, hyphenized = segment.split('-', 2)
             return "#{named_param}-#{translate(hyphenized, locale, scope)}" if hyphenized
           end
 
-          return segment if segment.starts_with?('(', '*') || segment.include?(':')
+          return segment if segment.start_with?('(', '*') || segment.include?(':')
 
           appended_part = segment.slice!(/(\()$/)
           str = translatable_segment(segment)

data/lib/route_translator/version.rb

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

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: route_translator
 version: !ruby/object:Gem::Version
-  version: 8.0.0
+  version: 10.0.0
 platform: ruby
 authors:
 - Geremia Taglialatela
 - Enric Lluelles
 - Raul Murciano
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-17 00:00:00.000000000 Z
+date: 2021-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -21,7 +21,7 @@ dependencies:
         version: 5.0.0.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -31,7 +31,7 @@ dependencies:
         version: 5.0.0.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -41,7 +41,7 @@ dependencies:
         version: 5.0.0.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -51,7 +51,7 @@ dependencies:
         version: 5.0.0.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.3'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -106,14 +106,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: 0.20.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: 0.20.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +137,7 @@ dependencies:
         version: 5.0.0.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -147,7 +147,7 @@ dependencies:
         version: 5.0.0.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '6.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -168,56 +168,90 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.82.0
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.82.0
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.3
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.5'
+        version: '2.9'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.5
+        version: 0.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.18.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.18.5
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.22'
 description: Translates the Rails routes of your application into the languages defined
   in your locale files
 email:
@@ -237,8 +271,6 @@ files:
 - lib/route_translator/extensions/route_set.rb
 - lib/route_translator/extensions/test_case.rb
 - lib/route_translator/host.rb
-- lib/route_translator/host_path_consistency_lambdas.rb
-- lib/route_translator/locale_sanitizer.rb
 - lib/route_translator/route.rb
 - lib/route_translator/translator.rb
 - lib/route_translator/translator/path.rb
@@ -252,13 +284,13 @@ 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: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -267,8 +299,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Translate your Rails routes in a simple manner
 test_files: []

data/lib/route_translator/host_path_consistency_lambdas.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module RouteTranslator
-  module HostPathConsistencyLambdas
-    class << self
-      private
-
-      def lambdas
-        @lambdas ||= {}
-      end
-    end
-
-    module_function
-
-    def for_locale(locale)
-      sanitized_locale = RouteTranslator::LocaleSanitizer.sanitize(locale)
-
-      lambdas[sanitized_locale] ||= ->(req) { sanitized_locale == RouteTranslator::Host.locale_from_host(req.host).to_s }
-    end
-  end
-end

data/lib/route_translator/locale_sanitizer.rb

@@ -1,11 +0,0 @@
-# frozen_string_literal: true
-
-module RouteTranslator
-  module LocaleSanitizer
-    module_function
-
-    def sanitize(locale)
-      locale.to_s.gsub('native_', '')
-    end
-  end
-end