route_translator 5.4.1 → 5.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 60e00314bcf617c8a2865378a33cbb4c70326a96
-  data.tar.gz: 7b35a7735c096861591f11136a42253f7777f686
+  metadata.gz: 31c45f4f07f63d37b9cdcf3d3d03e4fa1b59c2dd
+  data.tar.gz: 6ef546c5332a49738627d17945dc4885d27ff0d3
 SHA512:
-  metadata.gz: 4af68cb388091bccbd13b5fc2f1f601ba7327cd80fce37d575741068e6688e2d778fc6b2b154cd13a1706c528bd2b59d24310b69f9571054d9f94cc9bf0640a3
-  data.tar.gz: d2a04e4d7b66e25be8759ec8a3d95bbec903379138a48667c59f4da7415408058b785e4ffaabb412e4dea5ae997e501a1d68a5cb925256f4486b51d5142c8483
+  metadata.gz: 1db0724276af9860e0625f4658c5ed52cf8636e4367d6238f0386ac3bfa4cd9d94fcc51021cb171916f3d3887ed893cba4c445b4964e3e39bedb651437926614
+  data.tar.gz: a0d0a239715a71ac417ebfaef82be0cbfa32ad0042afdcd45d22dd4fe434ef9bbf18002104f531a46a06eaa4a1d0ee39fd4e9533ec7ce0f89cb4990d6c6b8c6a

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 5.5.0 / 2017-06-29
+
+* [FEATURE] Add an option to verify host path consistency (#167)
+* [ENHANCHEMENT] Minor improvements
+
 ## 5.4.1 / 2017-06-01
 
 * [ENHANCEMENT] Update development dependencies

data/README.md

@@ -284,7 +284,10 @@ end
 * **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`.
 
 ### Host-based Locale
 

data/lib/route_translator.rb

@@ -2,9 +2,11 @@
 
 require 'active_support'
 
-require File.expand_path('../route_translator/extensions', __FILE__)
-require File.expand_path('../route_translator/translator', __FILE__)
-require File.expand_path('../route_translator/host', __FILE__)
+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
@@ -14,7 +16,7 @@ module RouteTranslator
   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)
+                             :locale_segment_proc, :verify_host_path_consistency)
 
   class << self
     private
@@ -40,6 +42,7 @@ module RouteTranslator
     @config.generate_unnamed_unlocalized_routes ||= false
     @config.locale_param_key                    ||= :locale
     @config.locale_segment_proc                 ||= nil
+    @config.verify_host_path_consistency        ||= false
 
     yield @config if block
 

data/lib/route_translator/extensions.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-require File.expand_path('../extensions/mapper', __FILE__)
-require File.expand_path('../extensions/route_set', __FILE__)
-require File.expand_path('../extensions/action_controller', __FILE__)
+require 'route_translator/extensions/mapper'
+require 'route_translator/extensions/route_set'
+require 'route_translator/extensions/action_controller'

data/lib/route_translator/extensions/route_set.rb

@@ -8,9 +8,9 @@ module ActionDispatch
       def add_localized_route(mapping, path_ast, 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 |translated_name, translated_path, translated_options_constraints, translated_options|
+        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  = ::ActionDispatch::Routing::Mapper::Mapping.build(scope, self, translated_path_ast, controller, default_action, to, via, formatted, translated_options_constraints, anchor, translated_options)
+          translated_mapping  = translate_mapping(locale, self, translated_options, translated_path_ast, scope, controller, default_action, to, formatted, via, translated_options_constraints, anchor)
 
           add_route_to_set translated_mapping, translated_path_ast, translated_name, anchor
         end
@@ -24,6 +24,21 @@ 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 : []
+
+        if RouteTranslator.config.verify_host_path_consistency
+          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)
+      end
+
       def add_route_to_set(mapping, path_ast, name, anchor)
         if method(:add_route).arity == 4
           add_route mapping, path_ast, name, anchor

data/lib/route_translator/host_path_consistency_lambdas.rb

@@ -0,0 +1,21 @@
+# 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

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

data/lib/route_translator/translator.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require File.expand_path('../translator/route_helpers', __FILE__)
-require File.expand_path('../translator/path', __FILE__)
-require File.expand_path('../route', __FILE__)
+require 'route_translator/translator/route_helpers'
+require 'route_translator/translator/path'
+require 'route_translator/route'
 
 module RouteTranslator
   module Translator
@@ -25,7 +25,7 @@ module RouteTranslator
         translated_options = options.dup
 
         if translated_options.exclude?(RouteTranslator.locale_param_key)
-          translated_options[RouteTranslator.locale_param_key] = locale.to_s.gsub('native_', '')
+          translated_options[RouteTranslator.locale_param_key] = RouteTranslator::LocaleSanitizer.sanitize(locale)
         end
 
         translated_options
@@ -71,7 +71,7 @@ module RouteTranslator
         translated_options_constraints = translate_options_constraints(route.options_constraints, locale)
         translated_options             = translate_options(route.options, locale)
 
-        yield translated_name, translated_path, translated_options_constraints, translated_options
+        yield locale, translated_name, translated_path, translated_options_constraints, translated_options
       end
     end
 

data/lib/route_translator/translator/path.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require File.expand_path('../path/segment', __FILE__)
+require 'route_translator/translator/path/segment'
 
 module RouteTranslator
   module Translator

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

@@ -32,8 +32,8 @@ module RouteTranslator
           end
 
           def translate_string(str, locale, scope)
-            locale = locale.to_s.gsub('native_', '')
-            translated_resource = translate_resource(str, locale, scope)
+            sanitized_locale = RouteTranslator::LocaleSanitizer.sanitize(locale)
+            translated_resource = translate_resource(str, sanitized_locale, scope)
 
             URI.escape translated_resource
           end

data/lib/route_translator/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RouteTranslator
-  VERSION = '5.4.1'.freeze
+  VERSION = '5.5.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: route_translator
 version: !ruby/object:Gem::Version
-  version: 5.4.1
+  version: 5.5.0
 platform: ruby
 authors:
 - Geremia Taglialatela
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-01 00:00:00.000000000 Z
+date: 2017-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -188,6 +188,8 @@ files:
 - lib/route_translator/extensions/mapper.rb
 - lib/route_translator/extensions/route_set.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