route_translator 3.1.0 → 3.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmZkNDU4NGVlZjk3YWQ5ZmNmYjlmNTZiNjczNzcxODNmYzIxNTNiZQ==
+  data.tar.gz: !binary |-
+    MGFlZTZiYWVkZWFkZTU0YzdjZjlmYjRkM2U5NTFjODI4NWVjYzljZA==
+SHA512:
+  metadata.gz: !binary |-
+    MmM4ZTQwNzZhMmIxNjM2NzA5NGY2YTMyMjkzOTZjZWI0M2FkY2I1MjEyMGNl
+    OTAxYjMyOTBmNjY2ZDQ4YmZmYzE2ZWU4YjZkZWUwOTM0YWFmZTkzMzI2MTQ4
+    NGI5MmFjMmRjNmMyYjU0YjkyYjM5NDAzNmM0MjI5MGJhYjMyYzY=
+  data.tar.gz: !binary |-
+    MjkyZjZlODExMTFhZThiZGY0NWE2M2YzZjllZWVlOTViYjg5MzAxZTYwOGUy
+    MTAxNTkzODI0ZDkzODQ5Mjg0OThhYWYzZGMwNWQ5ZDNkOGNhNmQ1OWY5NzY3
+    OGVkMjA5ZjBkOTU0MmE1YzI0YzBiZmFiNzE4ZDQwYmY4OTI2NzE=

data/lib/route_translator.rb

@@ -10,13 +10,15 @@ module RouteTranslator
 
   TRANSLATABLE_SEGMENT = /^([-_a-zA-Z0-9]+)(\()?/.freeze
 
-  Configuration = Struct.new(:force_locale, :generate_unlocalized_routes, :translation_file, :locale_param_key)
+  Configuration = Struct.new(:force_locale, :hide_locale, :generate_unlocalized_routes, :locale_param_key, :generate_unnamed_unlocalized_routes)
 
   def self.config(&block)
     @config ||= Configuration.new
     @config.force_locale ||= false
+    @config.hide_locale ||= false
     @config.generate_unlocalized_routes ||= false
     @config.locale_param_key ||= :locale
+    @config.generate_unnamed_unlocalized_routes ||= false
     yield @config if block
     @config
   end

data/lib/route_translator/extensions/action_controller.rb

@@ -2,10 +2,17 @@ require 'action_controller'
 
 module ActionController
   class Base
-    before_filter :set_locale_from_url
+    around_filter :set_locale_from_url
 
-    def set_locale_from_url
-      I18n.locale = params[RouteTranslator.locale_param_key]
+    def set_locale_from_url(&block)
+      I18n.with_locale params[RouteTranslator.locale_param_key], &block
     end
   end
+
+  class TestCase
+    include ActionController::UrlFor
+
+    delegate :env, :request, :to => :@controller
+    def _routes; @routes; end
+  end
 end

data/lib/route_translator/extensions/mapper.rb

@@ -26,11 +26,10 @@ module ActionDispatch
           end
 
           mapping = Mapping.new(@set, @scope, path, options)
-          app, conditions, requirements, defaults, as, anchor = mapping.to_route
           if @localized
-            @set.add_localized_route(app, conditions, requirements, defaults, as, anchor)
+            @set.add_localized_route(*mapping.to_route)
           else
-            @set.add_route(app, conditions, requirements, defaults, as, anchor)
+            @set.add_route(*mapping.to_route)
           end
         end
       else

data/lib/route_translator/extensions/route_set.rb

@@ -10,4 +10,4 @@ module ActionDispatch
       end
     end
   end
-end
+end

data/lib/route_translator/translator.rb

@@ -17,12 +17,23 @@ module RouteTranslator
             __send__("#{old_name}_#{I18n.default_locale.to_s.underscore}_#{suffix}", *args)
           end
         end
+
+        # Including the named routes helpers module
+        [ActionController::TestCase, ActionView::TestCase, ActionMailer::TestCase].each do |klass|
+          klass.__send__(:include, helper_container)
+        end
       end
     end
 
     def self.translations_for(app, conditions, requirements, defaults, route_name, anchor, route_set, &block)
       add_untranslated_helpers_to_controllers_and_views(route_name, route_set.named_routes.module)
-      I18n.available_locales.each do |locale|
+      # 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
+      available_locales = I18n.available_locales.dup
+      available_locales.delete I18n.default_locale
+      available_locales.push I18n.default_locale
+      available_locales.each do |locale|
         new_conditions = conditions.dup
         new_conditions[:path_info] = translate_path(conditions[:path_info], locale)
         if new_conditions[:required_defaults] && !new_conditions[:required_defaults].include?(RouteTranslator.locale_param_key)
@@ -34,25 +45,30 @@ module RouteTranslator
         new_route_name = nil if new_route_name && route_set.named_routes.routes[new_route_name.to_sym] #TODO: Investigate this :(
         block.call(app, new_conditions, new_requirements, new_defaults, new_route_name, anchor)
       end
-      block.call(app, conditions, requirements, defaults, route_name, anchor) if RouteTranslator.config.generate_unlocalized_routes
+      if RouteTranslator.config.generate_unnamed_unlocalized_routes
+        block.call(app, conditions, requirements, defaults, nil, anchor)
+      elsif RouteTranslator.config.generate_unlocalized_routes
+        block.call(app, conditions, requirements, defaults, route_name, anchor)
+      end
     end
 
     # Translates a path and adds the locale prefix.
     def self.translate_path(path, locale)
       new_path = path.dup
-      final_optional_segments = new_path.slice!(/(\(.+\))$/)
-      new_path = new_path.split("/").map{|seg| translate_path_segment(seg, locale)}.join('/')
+      final_optional_segments = new_path.slice!(/(\([^\/]+\))$/)
+      translated_segments = new_path.split("/").map{ |seg| translate_path_segment(seg, locale) }.select{ |seg| !seg.blank? }
 
-      # Add locale prefix if it's not the default locale,
+      # if not hiding locale then
+      # add locale prefix if it's not the default locale,
       # or forcing locale to all routes,
       # or already generating actual unlocalized routes
-      if !default_locale?(locale) || RouteTranslator.config.force_locale || RouteTranslator.config.generate_unlocalized_routes
-        new_path = "/#{locale.to_s.downcase}#{new_path}"
+      if !RouteTranslator.config.hide_locale && (!default_locale?(locale) || RouteTranslator.config.force_locale || RouteTranslator.config.generate_unlocalized_routes || RouteTranslator.config.generate_unnamed_unlocalized_routes)
+        if !locale_param_present?(new_path)
+          translated_segments.unshift locale.to_s.downcase
+        end
       end
 
-      new_path = "/" if new_path.blank?
-
-      "#{new_path}#{final_optional_segments}"
+      "/#{translated_segments.join('/')}#{final_optional_segments}".gsub(/\/\(\//, '(/')
     end
 
     def self.translate_name(n, locale)
@@ -66,19 +82,24 @@ module RouteTranslator
     # Tries to translate a single path segment. If the path segment
     # contains sth. like a optional format "people(.:format)", only
     # "people" will be translated, if there is no translation, the path
-    # segment is blank or begins with a ":" (param key), the segment
-    # is returned untouched
+    # segment is blank, begins with a ":" (param key) or "*" (wildcard),
+    # the segment is returned untouched
     def self.translate_path_segment segment, locale
-      return segment if segment.blank? or segment.starts_with?(":")
+      return segment if segment.blank? or segment.starts_with?(":") or segment.starts_with?("(") or segment.starts_with?("*")
 
+      appended_part = segment.slice!(/(\()$/)
       match = TRANSLATABLE_SEGMENT.match(segment)[1] rescue nil
 
-      (translate_string(match, locale) || segment)
+      (translate_string(match, locale) || segment) + appended_part.to_s
     end
 
     def self.translate_string(str, locale)
       res = I18n.translate(str, :scope => :routes, :locale => locale, :default => str)
       URI.escape(res)
     end
+
+    def self.locale_param_present?(path)
+      !(path.split('/').detect { |segment| segment.to_s == ":#{RouteTranslator.locale_param_key.to_s}" }.nil?)
+    end
   end
 end

data/lib/route_translator/version.rb

@@ -1,3 +1,3 @@
 module RouteTranslator
-  VERSION = '3.1.0'
+  VERSION = '3.2.0'
 end

data/test/dummy/config/application.rb

@@ -9,5 +9,6 @@ module Dummy
   class Application < Rails::Application
     # config.logger = Logger.new(File.new("/dev/null", 'w'))
     config.active_support.deprecation = :log
+    config.eager_load = false
   end
 end

data/test/dummy/config/routes.rb

@@ -2,5 +2,5 @@ Dummy::Application.routes.draw do
   localized do
     get 'dummy', :to => 'dummy#dummy'
   end
-  mount DummyMountedApp => '/dummy_mounted_app'
+  mount DummyMountedApp.new => '/dummy_mounted_app'
 end

data/test/dummy/dummy_mounted_app.rb

@@ -1,6 +1,5 @@
-require 'sinatra'
-class DummyMountedApp < Sinatra::Base
-  get "/" do
-    "Good"
+class DummyMountedApp
+  def call(env)
+    [200, {"Content-Type" => "text/plain"}, ["Good"]]
   end
 end

data/test/integration_test.rb

@@ -20,4 +20,13 @@ class IntegrationTest < class_to_inherit
     assert_equal "Good", @response.body
     assert_response :success
   end
+  
+  def test_i18n_locale_thread_safe
+    config_default_locale_settings 'en'
+    
+    get '/es/dummy'
+    assert_equal 'es', @response.body
+    
+    assert_equal :en, I18n.locale
+  end
 end

data/test/locales/routes.yml

@@ -3,6 +3,7 @@ es:
     people: gente
     products: productos
     tr_param: tr_parametro
+    blank: ""
 
 ru:
   routes:

data/test/routing_test.rb

@@ -18,8 +18,10 @@ class TranslateRoutesTest < ActionController::TestCase
 
   def teardown
     config_force_locale false
+    config_hide_locale false
     config_generate_unlocalized_routes false
     config_default_locale_settings("en")
+    config_generate_unnamed_unlocalized_routes false
   end
 
   def test_unnamed_root_route
@@ -55,6 +57,17 @@ class TranslateRoutesTest < ActionController::TestCase
     assert_routing '/es/productos/a/b', :controller => 'products', :action => 'index', :locale => 'es', :non_optional_param => 'b', :optional_param => 'a'
   end
 
+  def test_translations_after_optional_segments
+    draw_routes do
+      localized do
+        get '(/:optional_param)/products', :to => 'products#index'
+      end
+    end
+
+    assert_routing '/es/productos', :controller => 'products', :action => 'index', :locale => 'es'
+    assert_routing '/es/a/productos', :controller => 'products', :action => 'index', :locale => 'es', :optional_param => 'a'
+  end
+
   def test_dynamic_segments_dont_get_translated
     draw_routes do
       localized do
@@ -64,6 +77,15 @@ class TranslateRoutesTest < ActionController::TestCase
     assert_routing '/es/productos/a', :controller => 'products', :action => 'index', :locale => 'es', :tr_param => 'a'
   end
 
+  def test_wildcards_dont_get_translated
+    draw_routes do
+      localized do
+        get 'products/*tr_param', :to => 'products#index'
+      end
+    end
+    assert_routing '/es/productos/a/b', :controller => 'products', :action => 'index', :locale => 'es', :tr_param => 'a/b'
+  end
+
   def test_resources
     config_default_locale_settings 'es'
 
@@ -227,7 +249,7 @@ class TranslateRoutesTest < ActionController::TestCase
     assert_routing '/en/people', :controller => 'people', :action => 'index', :locale => 'en'
     assert_routing 'gente', :controller => 'people', :action => 'index', :locale => 'es'
 
-    
+
     assert_helpers_include :people_en, :people_es, :people
   end
 
@@ -243,7 +265,7 @@ class TranslateRoutesTest < ActionController::TestCase
     assert_routing '/people', :controller => 'people', :action => 'index', :locale => 'en'
     assert_routing '/es/gente', :controller => 'people', :action => 'index', :locale => 'es'
 
-    
+
     assert_helpers_include :people_en, :people_es, :people
   end
 
@@ -275,7 +297,7 @@ class TranslateRoutesTest < ActionController::TestCase
     assert_routing '/es/gente', :controller => 'people', :action => 'index', :locale => 'es'
     assert_routing '/people', :controller => 'people', :action => 'index', :locale => 'en'
 
-    
+
     assert_helpers_include :people_en, :people_es, :people
   end
 
@@ -326,6 +348,7 @@ class TranslateRoutesTest < ActionController::TestCase
   end
 
   def test_force_locale
+    I18n.locale = 'en'
     config_default_locale_settings 'en'
     config_force_locale true
 
@@ -337,9 +360,15 @@ class TranslateRoutesTest < ActionController::TestCase
 
     assert_routing '/en/people', :controller => 'people', :action => 'index', :locale => 'en'
     assert_unrecognized_route '/people', :controller => 'people', :action => 'index'
+    assert_equal '/en/people', @routes.url_helpers.people_en_path
+    assert_equal '/en/people', @routes.url_helpers.people_path
+    I18n.locale = 'es'
+    # The dynamic route maps to the current locale
+    assert_equal '/es/gente', @routes.url_helpers.people_path
   end
 
   def test_generate_unlocalized_routes
+    I18n.locale = 'en'
     config_default_locale_settings 'en'
     config_generate_unlocalized_routes true
 
@@ -351,22 +380,82 @@ class TranslateRoutesTest < ActionController::TestCase
 
     assert_routing '/en/people', :controller => 'people', :action => 'index', :locale => 'en'
     assert_routing '/people', :controller => 'people', :action => 'index'
+    assert_equal '/en/people', @routes.url_helpers.people_en_path
+    assert_equal '/people', @routes.url_helpers.people_path
+    I18n.locale = 'es'
+    # The dynamic route maps to the default locale, not the current
+    assert_equal '/people', @routes.url_helpers.people_path
   end
 
-  def test_config_translation_file
-    config_default_locale_settings 'es'
+  def test_generate_unnamed_unlocalized_routes
+    I18n.locale = 'en'
+    config_default_locale_settings 'en'
+    config_generate_unnamed_unlocalized_routes true
 
     draw_routes do
       localized do
-        root :to => 'people#index'
+        get 'people', :to => 'people#index', :as => 'people'
       end
     end
 
-    assert_routing '/', :controller => 'people', :action => 'index', :locale => 'es'
-    assert_routing '/en', :controller => 'people', :action => 'index', :locale => 'en'
-    assert_unrecognized_route '/es', :controller => 'people', :action => 'index', :locale => 'es'
+    assert_routing '/en/people', :controller => 'people', :action => 'index', :locale => 'en'
+    assert_routing '/people', :controller => 'people', :action => 'index'
+    assert_equal '/en/people', @routes.url_helpers.people_en_path
+    assert_equal '/en/people', @routes.url_helpers.people_path
+
+    I18n.locale = 'es'
+    # The dynamic route maps to the current locale
+    assert_equal '/es/gente', @routes.url_helpers.people_path
+  end
+  
+  def test_blank_localized_routes
+    I18n.locale = 'en'
+    config_default_locale_settings 'en'
+
+    draw_routes do
+      localized do
+        get 'people/blank', :to => 'people#index', :as => 'people'
+      end
+    end
+    
+    I18n.locale = 'en'
+    assert_routing '/people/blank', :controller => 'people', :action => 'index', :locale => 'en'
+    assert_equal '/people/blank', @routes.url_helpers.people_en_path
+    
+    I18n.locale = 'es'
+    assert_routing '/es/gente', :controller => 'people', :action => 'index', :locale => 'es'
+    assert_equal '/es/gente', @routes.url_helpers.people_es_path
+  end
+
+  def test_dont_add_locale_to_routes_if_local_param_present
+    config_default_locale_settings 'es'
+    config_force_locale true
+
+    draw_routes do
+      scope 'segment/:locale' do
+        localized do
+          resources :products
+        end
+      end
+    end
+
+    assert_routing '/segment/es/productos/product_slug', :controller => 'products', :action => 'show', :locale => 'es', :id => 'product_slug'
+    assert_routing '/segment/en/products/product_slug', :controller => 'products', :action => 'show', :locale => 'en', :id => 'product_slug'
   end
 
+  def test_config_hide_locale
+    config_default_locale_settings 'en'
+    config_hide_locale true
+
+    draw_routes do
+      localized do
+        resources :people
+      end
+    end
+
+    assert_routing '/gente', :controller => 'people', :action => 'index', :locale => 'es'
+    assert_routing '/people', :controller => 'people', :action => 'index', :locale => 'en'
+  end
 
   def test_action_controller_gets_locale_setter
     ActionController::Base.instance_methods.include?('set_locale_from_url')
@@ -379,4 +468,37 @@ class TranslateRoutesTest < ActionController::TestCase
   def test_action_view_gets_locale_suffix_helper
     ActionView::Base.instance_methods.include?('locale_suffix')
   end
+
+  def test_action_controller_test_case_reads_default_urls
+    test_case_reads_default_urls(ActionController::TestCase)
+  end
+
+  def test_action_view_test_case_reads_default_urls
+    test_case_reads_default_urls(ActionView::TestCase)
+  end
+
+  def test_action_mailer_test_case_reads_default_urls
+    test_case_reads_default_urls(ActionMailer::TestCase)
+  end
+
+  private
+  def test_case_reads_default_urls(klass)
+    config_default_locale_settings 'en'
+
+    draw_routes do
+      localized do
+        resources :person
+      end
+    end
+
+    test_case = klass.new(:respond_to?)
+
+    # Not localized
+    assert test_case.respond_to?(:people_path)
+    assert test_case.respond_to?(:new_person_path)
+
+    # Localized
+    assert test_case.respond_to?(:people_en_path)
+    assert test_case.respond_to?(:new_person_en_path)
+  end
 end

data/test/test_helper.rb

@@ -2,6 +2,9 @@ require 'test/unit'
 require 'minitest/mock'
 require 'minitest/unit'
 
+require 'i18n'
+I18n.enforce_available_locales = true
+
 require "rails"
 require "action_controller/railtie"
 
@@ -24,7 +27,7 @@ module RouteTranslator
     def draw_routes(&block)
       @routes.draw(&block)
       if @routes.respond_to?(:install_helpers)
-        @routes.install_helpers 
+        @routes.install_helpers
       else
         ActionView::Base.send(:include, @routes.url_helpers)
         ActionController::Base.send(:include, @routes.url_helpers)
@@ -39,12 +42,16 @@ module RouteTranslator
       RouteTranslator.config.force_locale = boolean
     end
 
+    def config_hide_locale(boolean)
+      RouteTranslator.config.hide_locale = boolean
+    end
+
     def config_generate_unlocalized_routes(boolean)
       RouteTranslator.config.generate_unlocalized_routes = boolean
     end
 
-    def config_translation_file (file)
-      RouteTranslator.config.translation_file = file
+    def config_generate_unnamed_unlocalized_routes(boolean)
+      RouteTranslator.config.generate_unnamed_unlocalized_routes = boolean
     end
 
     def path_string(route)

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: route_translator
 version: !ruby/object:Gem::Version
-  version: 3.1.0
-  prerelease: 
+  version: 3.2.0
 platform: ruby
 authors:
 - Raul Murciano
@@ -10,12 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-25 00:00:00.000000000 Z
+date: 2014-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -23,15 +21,27 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 4.7.0
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -39,7 +49,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -75,27 +84,26 @@ files:
 - test/test_helper.rb
 homepage: http://github.com/enriclluelles/route_translator
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Translate your Rails routes in a simple manner
 test_files:
 - test/dummy/app/controllers/dummy_controller.rb