route_translator 5.0.6 → 5.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2e5491f7135951007ef950f929f41ce035e327e5
-  data.tar.gz: c92a06d7f82220a625e9efca1efce38630429759
+  metadata.gz: db2eb895765c0bc6d9331fb86fa65f36ad1e2f11
+  data.tar.gz: 34389bc82a4bed4c1b7fac7e4588710ca4316cac
 SHA512:
-  metadata.gz: 0a67bc52ece0fa4a69c7d4b5ccb0407b92104f53182fb0e87a5a143f9fb2c9753772ae763ae1e9f49e756214c91da93f769845022cba850fe2be50dae5f749e2
-  data.tar.gz: c06d96a8c9a72f6dab4b6258ee0062f774ca31a4bc24cedab06ba8346ff5afc61e697ac62915b7ab33e6015478753b0d1532ddeeee5cb4c020fb0394cbc70965
+  metadata.gz: da58eb381c0ec9f894e5b54457ea3b172902fe778c4d52ceacc708a7a410192552bffc2bc4a3a28ab55963635e82f9cc5df212ede87d2c254411763c40bc7460
+  data.tar.gz: f29622f458c5781277d3835c396f325b13973aec2f5c49496fb23a4bef29b64ce10041301a997f55bfc345c8ccf01887f59720c6bb8ef624de7c225a6bbc0e7e

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 5.1.0 (2017-01-24)
+
+* Add: Translate controllers with namespaces (#120)
+* Update development dependencies
+
 ## 5.0.6 (2017-01-17)
 
 * Test against Ruby 2.4.0

data/README.md

@@ -327,6 +327,38 @@ If `host_locales` option is set, the following options will be forced (even if y
 This is to avoid odd behaviour brought about by route conflicts and because `host_locales` forces and hides the host-locale dynamically.
 
 
+### Translations for similar routes with different namespaces
+
+If you have routes that (partially) share names in one locale, but must be translated differently in another locale, for example:
+
+```ruby
+get 'people/favourites', to: 'people/products#favourites'
+get 'favourites',        to: 'products#favourites'
+```
+
+Then it is possible to provide different translations for common parts of those routes by
+scoping translations by a controller's namespace:
+
+```yml
+es:
+  routes:
+    favourites: favoritos
+    controllers:
+      people:
+        products:
+          favourites: fans
+```
+
+Routes will be translated as in:
+
+```
+people_products_favourites_es GET  /people/products/fans(.:format)       people/products#favourites {:locale=>"es"}
+       products_favourites_es GET  /products/favoritos(.:format)         products#favourites {:locale=>"es"}
+```
+
+The gem will lookup translations under `controllers` scope first and then lookup translations under `routes` scope.
+
+
 
 ## Testing
 Testing your controllers with routes-translator is easy, just add a locale parameter for your localized routes. Otherwise, an ActionController::UrlGenerationError will raise.

data/lib/route_translator/extensions/route_set.rb

@@ -4,7 +4,9 @@ module ActionDispatch
   module Routing
     class RouteSet
       def add_localized_route(mapping, path_ast, name, anchor, scope, path, controller, default_action, to, via, formatted, options_constraints, options)
-        RouteTranslator::Translator.translations_for(self, path, name, options_constraints, options) do |translated_name, translated_path, translated_options_constraints, translated_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|
           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)
 

data/lib/route_translator/route.rb

@@ -0,0 +1,23 @@
+module RouteTranslator
+  class Route
+    attr_reader :route_set, :path, :name, :options_constraints, :options, :mapping
+
+    def initialize(route_set, path, name, options_constraints, options, mapping)
+      @route_set           = route_set
+      @path                = path
+      @name                = name
+      @options_constraints = options_constraints
+      @options             = options
+      @mapping             = mapping
+    end
+
+    def scope
+      @scope ||=
+        if mapping.defaults[:controller]
+          [:routes, :controllers].concat mapping.defaults[:controller].split('/').map(&:to_sym)
+        else
+          [:routes, :controllers]
+        end
+    end
+  end
+end

data/lib/route_translator/translator.rb

@@ -2,6 +2,7 @@
 
 require File.expand_path('../translator/route_helpers', __FILE__)
 require File.expand_path('../translator/path', __FILE__)
+require File.expand_path('../route', __FILE__)
 
 module RouteTranslator
   module Translator
@@ -39,8 +40,8 @@ module RouteTranslator
         translated_options_constraints
       end
 
-      def translate_path(path, locale)
-        RouteTranslator::Translator::Path.translate(path, locale)
+      def translate_path(path, locale, scope)
+        RouteTranslator::Translator::Path.translate(path, locale, scope)
       rescue I18n::MissingTranslationData => e
         raise e unless RouteTranslator.config.disable_fallback
       end
@@ -58,16 +59,16 @@ module RouteTranslator
       locales.push I18n.default_locale
     end
 
-    def translations_for(route_set, path, name, options_constraints, options)
-      RouteTranslator::Translator::RouteHelpers.add name, route_set.named_routes
+    def translations_for(route)
+      RouteTranslator::Translator::RouteHelpers.add route.name, route.route_set.named_routes
 
       available_locales.each do |locale|
-        translated_path = translate_path(path, locale)
+        translated_path = translate_path(route.path, locale, route.scope)
         next unless translated_path
 
-        translated_name                = translate_name(name, locale, route_set.named_routes.names)
-        translated_options_constraints = translate_options_constraints(options_constraints, locale)
-        translated_options             = translate_options(options, locale)
+        translated_name                = translate_name(route.name, locale, route.route_set.named_routes.names)
+        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
       end

data/lib/route_translator/translator/path.rb

@@ -38,11 +38,11 @@ module RouteTranslator
       module_function
 
       # Translates a path and adds the locale prefix.
-      def translate(path, locale)
+      def translate(path, locale, scope)
         new_path = path.dup
         final_optional_segments = new_path.slice!(%r{(\([^\/]+\))$})
         translated_segments = new_path.split('/').map do |seg|
-          seg.split('.').map { |phrase| Segment.translate(phrase, locale) }.join('.')
+          seg.split('.').map { |phrase| Segment.translate(phrase, locale, scope) }.join('.')
         end
         translated_segments.reject!(&:empty?)
 

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

@@ -5,16 +5,29 @@ module RouteTranslator
         class << self
           private
 
-          def translate_string(str, locale)
-            locale = locale.to_s.gsub('native_', '')
-            opts = { scope: :routes, locale: locale }
+          def fallback_options(str, locale)
             if RouteTranslator.config.disable_fallback && locale.to_s != I18n.default_locale.to_s
-              opts[:fallback] = true
+              { scope: :routes, fallback: true }
+            else
+              { scope: :routes, default: str }
+            end
+          end
+
+          def translate_resource(str, locale, opts)
+            handler = proc { |exception| exception }
+
+            if I18n.translate(str, opts.merge(exception_handler: handler)).is_a?(I18n::MissingTranslation)
+              I18n.translate(str, opts.merge(fallback_options(str, locale)))
             else
-              opts[:default] = str
+              I18n.translate(str, opts)
             end
-            res = I18n.translate(str, opts)
-            URI.escape(res)
+          end
+
+          def translate_string(str, locale, scope)
+            locale = locale.to_s.gsub('native_', '')
+            translated_resource = translate_resource(str, locale, scope: scope, locale: locale)
+
+            URI.escape translated_resource
           end
         end
 
@@ -26,16 +39,16 @@ module RouteTranslator
         # "people(.:format)", only "people" will be translated.
         # If there is no translation, the path segment is blank, begins with a
         # ":" (param key) or "*" (wildcard), the segment is returned untouched.
-        def translate(segment, locale)
+        def translate(segment, locale, scope)
           return segment if segment.empty?
           named_param, hyphenized = segment.split('-'.freeze, 2) if segment.starts_with?(':'.freeze)
-          return "#{named_param}-#{translate(hyphenized.dup, locale)}" if hyphenized
+          return "#{named_param}-#{translate(hyphenized.dup, locale, scope)}" if hyphenized
           return segment if segment.starts_with?('('.freeze) || segment.starts_with?('*'.freeze) || segment.include?(':'.freeze)
 
           appended_part = segment.slice!(/(\()$/)
           match = TRANSLATABLE_SEGMENT.match(segment)[1] if TRANSLATABLE_SEGMENT.match(segment)
 
-          (translate_string(match, locale) || segment) + appended_part.to_s
+          (translate_string(match, locale, scope) || segment) + appended_part.to_s
         end
       end
     end

data/lib/route_translator/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module RouteTranslator
-  VERSION = '5.0.6'.freeze
+  VERSION = '5.1.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: route_translator
 version: !ruby/object:Gem::Version
-  version: 5.0.6
+  version: 5.1.0
 platform: ruby
 authors:
 - Geremia Taglialatela
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-17 00:00:00.000000000 Z
+date: 2017-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -74,34 +74,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.18
+        version: 0.8.19
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.18
+        version: 0.8.19
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.7.5
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: '5.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.7.5
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: '5.10'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -136,14 +130,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.47.0
+        version: 0.47.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.47.0
+        version: 0.47.1
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -176,6 +170,7 @@ files:
 - lib/route_translator/extensions/mapper.rb
 - lib/route_translator/extensions/route_set.rb
 - lib/route_translator/host.rb
+- lib/route_translator/route.rb
 - lib/route_translator/translator.rb
 - lib/route_translator/translator/path.rb
 - lib/route_translator/translator/path/segment.rb
@@ -201,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.9
 signing_key: 
 specification_version: 4
 summary: Translate your Rails routes in a simple manner