route_translator 3.2.4 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5d1c42a43f7afa3aa88301f402d64e0fbe60ebdf
-  data.tar.gz: c873187b33ca3327f482276c780b30e6999e246b
+  metadata.gz: 077e37f57ea89aa141aa2e271ba08e832cd85ef5
+  data.tar.gz: d6d9c89e7c57dcf22975bdc9e2194107ddf0b290
 SHA512:
-  metadata.gz: 93d3bb5f6ff06529a3d986a90574925d353e4882c472ca3254c405cd4c3736ac9737ae7fb933066b1e7cecd720d6eca211908d311ee2d6e471b774a39a2296e5
-  data.tar.gz: aa225c315b5a2afe93ec29e3a80253d840a5191f9031575933ca67231985522b162d0709601a76c68c31959c7e411ea53571bae65b44acbe53f6eb6dc760cb2f
+  metadata.gz: 554ab0400cbdffbfc854c3de668d892513bf1195598d6611df9057bfaa26f764682fc25a370531366ba8e4b1ac06620ee49138cd2584e695516a228303297168
+  data.tar.gz: d5e661b4a03807afe05d7ba8c066fde6979b656b949464cccf667f75855ec083aab15301fdb92c5ee5d3b03f36bf1d4f2bf73a59beeceba18bf13f722f93129f

data/lib/route_translator.rb

@@ -1,7 +1,4 @@
 require 'active_support'
-require 'action_controller'
-require 'action_mailer'
-require 'action_dispatch'
 
 require File.expand_path('../route_translator/extensions', __FILE__)
 require File.expand_path('../route_translator/translator', __FILE__)
@@ -24,7 +21,7 @@ module RouteTranslator
     @config.generate_unlocalized_routes         ||= false
     @config.locale_param_key                    ||= :locale
     @config.generate_unnamed_unlocalized_routes ||= false
-    @config.host_locales                        ||= {}.with_indifferent_access
+    @config.host_locales                        ||= ActiveSupport::OrderedHash.new
     yield @config if block
     resolve_config_conflicts
     @config
@@ -36,7 +33,10 @@ module RouteTranslator
       @config.generate_unnamed_unlocalized_routes = false
       @config.force_locale                        = false
       @config.hide_locale                         = false
-      @config.host_locales                        = @config.host_locales.with_indifferent_access
     end
   end
+
+  def self.locale_param_key
+    self.config.locale_param_key
+  end
 end

data/lib/route_translator/extensions/action_controller.rb

@@ -4,30 +4,24 @@ module ActionController
   class Base
     around_filter :set_locale_from_url
 
-    def set_locale_from_url(&block)
-      with_host_locale { I18n.with_locale(params[RouteTranslator.locale_param_key], &block) }
-    end
-
-    private
-
-    def with_host_locale(&block)
-      host_locale = RouteTranslator::Host.locale_from_host(request.host)
-      begin
-        if host_locale
-          original_default         = I18n.default_locale
-          original_locale          = I18n.locale
+    def set_locale_from_url
+      tmp_default_locale = RouteTranslator::Host.locale_from_host(request.host)
+      if tmp_default_locale
+        current_default_locale = I18n.default_locale
+        I18n.default_locale    = tmp_default_locale
+      end
 
-          I18n.default_locale = host_locale
-          I18n.locale         = host_locale
-        end
+      tmp_locale = params[RouteTranslator.locale_param_key] || tmp_default_locale
+      if tmp_locale
+        current_locale = I18n.locale
+        I18n.locale    = tmp_locale
+      end
 
-        yield
+      yield
 
-      ensure
-        I18n.default_locale = original_default if host_locale
-        I18n.locale         = original_locale  if host_locale
-      end
+    ensure
+      I18n.default_locale = current_default_locale if tmp_default_locale
+      I18n.locale = current_locale if tmp_locale
     end
-
   end
 end

data/lib/route_translator/extensions/mapper.rb

@@ -25,7 +25,12 @@ module ActionDispatch
             options[:as] = name_for_action(options[:as], action)
           end
 
-          mapping = Mapping.new(@set, @scope, path, options)
+          begin
+            mapping = Mapping.new(@set, @scope, path, options)
+          rescue ArgumentError => e
+            mapping = Mapping.build(@scope, @set, URI.parser.escape(path), options.delete(:as), options)
+          end
+
           if @localized
             @set.add_localized_route(*mapping.to_route)
           else

data/lib/route_translator/host.rb

@@ -1,12 +1,12 @@
 module RouteTranslator
   module Host
     def self.locale_from_host(host)
-      matches = RouteTranslator.config.host_locales.detect {|key, locale| host =~ regex_for(key) }
-      matched_locale = if matches && host_match = matches.first
-                         locale   = RouteTranslator.config.host_locales[host_match].to_sym
-                         locale if I18n.available_locales.include?(locale)
-                       end
-      matched_locale || I18n.default_locale
+      locales = RouteTranslator.config.host_locales.reduce([]) do |locales, (pattern, locale)|
+        locales << locale.to_sym if host =~ regex_for(pattern)
+        locales
+      end
+      locales &= I18n.available_locales
+      (locales.first || I18n.default_locale).to_sym
     end
 
     def self.regex_for(host_string)
@@ -21,9 +21,5 @@ module RouteTranslator
     def native_locales
       config.host_locales.values.map {|locale| :"native_#{locale}" }
     end
-
-    def locale_param_key
-      self.config.locale_param_key
-    end
   end
 end

data/lib/route_translator/translator.rb

@@ -5,38 +5,40 @@ module RouteTranslator
     #   people_path -> people_de_path
     #   I18n.locale = :fr
     #   people_path -> people_fr_path
-    def self.add_untranslated_helpers_to_controllers_and_views(old_name, helper_container, helper_list)
-      ['path', 'url'].each do |suffix|
+    def self.add_untranslated_helpers_to_controllers_and_views(old_name, named_route_collection)
+      if (named_route_collection.respond_to?(:url_helpers_module))
+        url_helpers_module = named_route_collection.url_helpers_module
+        path_helpers_module = named_route_collection.path_helpers_module
+        url_helpers_list = named_route_collection.helper_names
+        path_helpers_list = named_route_collection.helper_names
+      else
+        url_helpers_module = named_route_collection.module
+        path_helpers_module = named_route_collection.module
+        url_helpers_list = named_route_collection.helpers
+        path_helpers_list = named_route_collection.helpers
+      end
+
+      [
+        ['path', path_helpers_module, path_helpers_list],
+        ['url', url_helpers_module, url_helpers_list]
+      ].each do |suffix, helper_container, helper_list|
         new_helper_name = "#{old_name}_#{suffix}"
 
         helper_list.push(new_helper_name.to_sym) unless helper_list.include?(new_helper_name.to_sym)
 
         helper_container.__send__(:define_method, new_helper_name) do |*args|
-          locale_suffix         = I18n.locale.to_s.underscore
-          default_locale_suffix = I18n.default_locale.to_s.underscore
-          args_hash             = args.select {|arg| arg.is_a?(Hash) }.first
-          args_locale_suffix    = args_hash[:locale].to_s.underscore if args_hash.present?
-          if RouteTranslator.config.host_locales.present?
-            if args.blank? || args_locale_suffix == default_locale_suffix
-            __send__("#{old_name}_native_#{default_locale_suffix}_#{suffix}", *args)
-            elsif args_locale_suffix
-            __send__("#{old_name}_#{args_locale_suffix}_#{suffix}", *args)
-            end
-          elsif respond_to?("#{old_name}_#{locale_suffix}_#{suffix}")
-            __send__("#{old_name}_#{locale_suffix}_#{suffix}", *args)
-          else
-            __send__("#{old_name}_#{I18n.default_locale.to_s.underscore}_#{suffix}", *args)
-          end
+          __send__(Translator.route_name_for(args, old_name, suffix, self), *args)
         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, route_set.named_routes.helpers)
+      add_untranslated_helpers_to_controllers_and_views(route_name, route_set.named_routes)
 
       available_locales.each do |locale|
         new_conditions = conditions.dup
         new_conditions[:path_info] = translate_path(conditions[:path_info], locale)
+        new_conditions[:parsed_path_info] = ActionDispatch::Journey::Parser.new.parse(new_conditions[:path_info]) if conditions[:parsed_path_info]
         if new_conditions[:required_defaults] && !new_conditions[:required_defaults].include?(RouteTranslator.locale_param_key)
           new_conditions[:required_defaults] << RouteTranslator.locale_param_key if new_conditions[:required_defaults]
         end
@@ -56,7 +58,7 @@ module RouteTranslator
     private
     def self.available_locales
       available_locales = I18n.available_locales.dup
-      available_locales.push *RouteTranslator.native_locales if RouteTranslator.native_locales.present?
+      available_locales.push(*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.
@@ -120,5 +122,25 @@ module RouteTranslator
     def self.locale_param_present?(path)
       !(path.split('/').detect { |segment| segment.to_s == ":#{RouteTranslator.locale_param_key.to_s}" }.nil?)
     end
+
+    def self.host_locales_option?
+      RouteTranslator.config.host_locales.present?
+    end
+
+    def self.route_name_for(args, old_name, suffix, kaller)
+      args_hash          = args.detect{|arg| arg.is_a?(Hash)}
+      args_locale = host_locales_option? && args_hash && args_hash[:locale]
+      current_locale_name = I18n.locale.to_s.underscore
+
+      locale = if args_locale
+                 args_locale.to_s.underscore
+               elsif kaller.respond_to?("#{old_name}_#{current_locale_name}_#{suffix}")
+                 current_locale_name
+               else
+                 I18n.default_locale.to_s.underscore
+               end
+
+      "#{old_name}_#{locale}_#{suffix}"
+    end
   end
 end

data/lib/route_translator/version.rb

@@ -1,3 +1,3 @@
 module RouteTranslator
-  VERSION = '3.2.4'
+  VERSION = '4.0.0'
 end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/test/dummy/app/controllers/dummy_controller.rb

@@ -1,5 +1,11 @@
 class DummyController < ActionController::Base
+
   def dummy
     render :text => I18n.locale
   end
+
+  def show
+    # Pass
+  end
+
 end

data/test/dummy/app/views/dummy/show.html.erb

@@ -0,0 +1 @@
+<%= link_to "Show [#{I18n.locale}]", show_path %>

data/test/dummy/config/application.rb

@@ -1,3 +1,10 @@
+
+require 'i18n'
+begin
+  I18n.enforce_available_locales = true
+rescue NoMethodError
+end
+
 require "action_controller/railtie"
 begin
 require "active_resource/railtie"

data/test/dummy/config/locales/all.yml

@@ -4,9 +4,12 @@
 en:
   routes:
     dummy: dummy
+    show: show
 es:
   routes:
     dummy: dummy
+    show: mostrar
 ru:
   routes:
     dummy: манекен
+    show: показывать

data/test/dummy/config/routes.rb

@@ -1,6 +1,9 @@
+require File.join(Dummy::Application.root, 'dummy_mounted_app.rb')
+
 Dummy::Application.routes.draw do
   localized do
-    get 'dummy', :to => 'dummy#dummy'
+    get 'dummy',  :to => 'dummy#dummy'
+    get 'show',   :to => 'dummy#show'
   end
 
   root :to => 'dummy#dummy'

data/test/host_test.rb

@@ -1,24 +1,28 @@
 #encoding: utf-8
-require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper'))
+require File.expand_path('../test_helper', __FILE__)
 
 class TestHostsFromLocale < MiniTest::Unit::TestCase
-  include RouteTranslator::TestHelper
+
+  include RouteTranslator::ConfigurationHelper
+  include RouteTranslator::I18nHelper
+  include RouteTranslator::RoutesHelper
+
   def setup
-    I18n.backend        = I18n::Backend::Simple.new
-    I18n.load_path      = [ File.expand_path('../locales/routes.yml', __FILE__) ]
-    I18n.reload!
-
-    config_host_locales({
-      '*.something.es'           => :es,
-      '*.ru.subdomain.domain.*'  => :ru,
-      'russia.something.net'     => :ru,
-      '*.com'                    => :en
-    })
+    setup_config
+    setup_i18n
+
+    config = host_locales_config_hash
+    config['*.something.es']          = :es
+    config['*.ru.subdomain.domain.*'] = :ru
+    config['russia.something.net']    = :ru
+    config['*.com']                   = :en
+
+    config_host_locales(config)
   end
 
   def teardown
-    config_host_locales({})
-    I18n.default_locale = :en
+    teardown_i18n
+    teardown_config
   end
 
   def test_wildcard_at_beginning_matches
@@ -54,10 +58,16 @@ class TestHostsFromLocale < MiniTest::Unit::TestCase
   end
 
   def test_precedence_if_more_than_one_match
-    config_host_locales({ 'russia.*'  => :ru, '*.com' => :en })
+    config = host_locales_config_hash
+    config['russia.*'] = :ru
+    config['*.com'] = :en
+    config_host_locales(config)
     assert_equal :ru, RouteTranslator::Host.locale_from_host('russia.com')
 
-    config_host_locales({ '*.com' => :en, 'russia.*'  => :ru })
+    config = host_locales_config_hash
+    config['*.com'] = :en
+    config['russia.*'] = :ru
+    config_host_locales(config)
     assert_equal :en, RouteTranslator::Host.locale_from_host('russia.com')
   end
 
@@ -66,14 +76,13 @@ class TestHostsFromLocale < MiniTest::Unit::TestCase
   end
 
   def test_readme_examples_work
-    config_host_locales(
-      {
-        '*.es'                  => :es, # matches ['domain.es', 'subdomain.domain.es', 'www.long.string.of.subdomains.es'] etc.
-        'ru.wikipedia.*'        => :ru, # matches ['ru.wikipedia.org', 'ru.wikipedia.net', 'ru.wikipedia.com'] etc.
-        '*.subdomain.domain.*'  => :ru, # matches ['subdomain.domain.org', 'www.subdomain.domain.net'] etc.
-        'news.bbc.co.uk'        => :en, # matches ['news.bbc.co.uk'] only
-      }
-    )
+    config = host_locales_config_hash
+    config['*.es']                  = :es # matches ['domain.es', 'subdomain.domain.es', 'www.long.string.of.subdomains.es'] etc.
+    config['ru.wikipedia.*']        = :ru # matches ['ru.wikipedia.org', 'ru.wikipedia.net', 'ru.wikipedia.com'] etc.
+    config['*.subdomain.domain.*']  = :ru # matches ['subdomain.domain.org', 'www.subdomain.domain.net'] etc.
+    config['news.bbc.co.uk']        = :en # matches ['news.bbc.co.uk'] only
+
+    config_host_locales(config)
 
     examples_1 = ['domain.es', 'subdomain.domain.es', 'www.long.string.of.subdomains.es']
     examples_2 = ['ru.wikipedia.org', 'ru.wikipedia.net', 'ru.wikipedia.com']

data/test/integration/generated_path_test.rb

@@ -0,0 +1,37 @@
+#encoding: utf-8
+require File.expand_path('../../test_helper', __FILE__)
+
+class GeneratedPathTest < integration_test_suite_parent_class
+
+  include RouteTranslator::ConfigurationHelper
+
+  def test_path_generated
+    get '/show'
+    assert_response :success
+    assert_tag :tag => "a", :attributes => { :href => "/show" }
+  end
+
+  def test_path_translated
+    get '/es/mostrar'
+    assert_response :success
+    assert_tag :tag => "a", :attributes => { :href => "/es/mostrar" }
+  end
+
+  def test_path_translated_after_force
+    config_force_locale true
+
+    get '/es/mostrar'
+    assert_response :success
+    assert_tag :tag => "a", :attributes => { :href => "/es/mostrar" }
+  end
+
+  def test_path_translated_while_generate_unlocalized_routes
+    config_default_locale_settings 'en'
+    config_generate_unlocalized_routes true
+
+    get '/es/mostrar'
+    assert_response :success
+    assert_tag :tag => "a", :attributes => { :href => "/es/mostrar" }
+  end
+
+end

data/test/{integration_test.rb → integration/host_locales_test.rb}

@@ -1,42 +1,36 @@
 #encoding: utf-8
-require File.expand_path('../test_helper', __FILE__)
+require File.expand_path('../../test_helper', __FILE__)
 
-require File.expand_path('../dummy/dummy_mounted_app', __FILE__)
-require File.expand_path('../dummy/config/environment', __FILE__)
+class HostLocalesTest < integration_test_suite_parent_class
 
-class_to_inherit = defined?(ActionDispatch::IntegrationTest) ? ActionDispatch::IntegrationTest : ActionController::IntegrationTest
-class IntegrationTest < class_to_inherit
-  include RouteTranslator::TestHelper
+  include RouteTranslator::ConfigurationHelper
 
-  def test_set_locale_from_params
-    config_default_locale_settings 'en'
-
-    get '/es/dummy'
-    assert_equal 'es', @response.body
-    assert_response :success
+  def setup
+    config_host_locales('*.es' => 'es', 'ru.*.com' => 'ru')
+    Dummy::Application.reload_routes!
   end
 
-  def test_mounted_apps_work_with_correct_path
-    get 'dummy_mounted_app'
-    assert_equal "Good", @response.body
-    assert_response :success
+  def teardown
+    config_host_locales({})
+    Dummy::Application.reload_routes!
   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
 
-  def test_host_locales
+  def test_root_path
     ## root of es com
     host! 'www.testapp.es'
     get '/'
     assert_equal 'es', @response.body
     assert_response :success
 
+    ## root of ru com
+    host! 'ru.testapp.com'
+    get '/'
+    assert_equal 'ru', @response.body
+    assert_response :success
+  end
+
+  def test_explicit_path
     ## native es route on es com
     host! 'www.testapp.es'
     get '/dummy'
@@ -49,12 +43,6 @@ class IntegrationTest < class_to_inherit
     assert_equal 'ru', @response.body
     assert_response :success
 
-    ## root of ru com
-    host! 'ru.testapp.com'
-    get '/'
-    assert_equal 'ru', @response.body
-    assert_response :success
-
     ## native ru route on ru com
     host! 'ru.testapp.com'
     get URI.escape('/манекен')
@@ -67,4 +55,5 @@ class IntegrationTest < class_to_inherit
     assert_equal 'es', @response.body
     assert_response :success
   end
+
 end