doubledrones-i18n_routing 0.3.6.1

data/CHANGELOG.rdoc

@@ -0,0 +1,55 @@
+0.3.6 (June 13, 2010)
+
+* Works even if translations are the same as the translated name
+
+0.3.5 (June 9, 2010)
+
+* Clean up some .to_sym in order to avoid unnecessary symbols during runtime
+* Works with both I18n.locale as string or as symbol
+* Try to fix a Pathname instead of string issue
+
+0.3.4 (June 3, 2010)
+
+* Fix Rails3 issue with nested single resource again and pluralize controller name as it should be
+
+0.3.3 (June 2, 2010)
+
+* Fix Rails3 issue with nested single resource
+
+0.3.2 (June 2, 2010)
+
+* Add automatically config/locales/*.yml in the i18n load path in order to fix Rails3 issue
+
+0.3.1 (May 27, 2010)
+
+* Add a small Rails3 verification
+
+0.3.0 (May 27, 2010)
+
+* Add support for translating path_names, member and collection
+* Fix Rails3 nested resources
+* All specs are now passing under both Rails 2.3.5 and Rails 3
+
+0.2.4 (Apr 21, 2010)
+
+* Fix latest Rails3 edge compatibility (previous rails3 beta version not supported any more)
+
+0.2.3 (Apr 21, 2010)
+
+* Works on ruby 1.9.2-head
+
+0.2.2 (Apr 21, 2010)
+
+* Add I18n gem dependency
+
+0.2.1 (Apr 09, 2010)
+
+* Minor Rails3 modification, added gemspec and pushed gem on gemcutter
+
+0.2.0 (Apr 07, 2010)
+
+* All specs pass for Rails2, including nested deep resources
+
+0.1.0 (Mar 22, 2010)
+
+* Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Guillaume Luccisano - g-mai|: guillaume.luccisano
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,28 @@
+= I18nRouting
+
+I18n_routing is a plugin for Ruby on Rails that lets you easily translate your routes trough the I18n api included in Rails since version 2.2
+
+All necessary informations are available on the wiki: http://wiki.github.com/kwi/i18n_routing
+
+For any question, use the i18_routing google group: http://groups.google.com/group/i18n-routing
+
+Works with Rails 2.3 and Rails3 beta4 !
+
+== TODO for next releases (written the 9th of June)
+
+* Handle multiple translations for same resources name (Example: nested and not nested resources)
+* Handle namespace translation
+
+== I18n gem version warning
+
+Be careful when running Rails 2.3 with the shipped i18n gem: this is an old i18n version and i18_routing will install the latest i18n version as a gem.
+This latest version may be incompatible with some old usages.
+Furthermore, if the i18n gem is present on your system, Rails will load it and skip the shipped version; Keep that in mind.
+
+== Contributors
+
+* kwi (Guillaume Luccisano)
+* bigtiger (Jim Remsik)
+* mixr (Reiner Dieterich)
+
+Copyright (c) 2010 Guillaume Luccisano - g-mai|: guillaume.luccisano, released under the MIT license

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+
+spec_files = Rake::FileList["spec/**/*_spec.rb"]
+
+
+desc "Run specs for current Rails version"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = spec_files
+  t.spec_opts = lambda {
+    @rails_spec_version ? ["-c --format specdoc -- rails_spec_version=#{@rails_spec_version}"] : ["-c --format specdoc"]
+  }
+end
+
+task :default => :spec
+
+desc "Run Rails 2.x specs"
+task :rails2_spec do
+  @rails_spec_version = 2
+  Rake::Task['spec'].invoke
+end
+
+desc "Run Rails 3.x specs"
+task :rails3_spec do
+  @rails_spec_version = 3
+  Rake::Task['spec'].invoke
+end

data/init.rb

@@ -0,0 +1,2 @@
+# encoding: utf-8
+require 'i18n_routing'

data/lib/i18n_routing.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+require 'i18n_routing_common'
+
+if Rails.version < '3'
+  require 'i18n_routing_rails2'
+else
+  require 'i18n_routing_rails3'
+end

data/lib/i18n_routing_common.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+# I18nRouting module for common usage methods
+module I18nRouting
+  # Return the correct translation for given values
+  def self.translation_for(name, type = :resources, option = nil)
+
+    # First, if an option is given, try to get the translation in the routes scope
+    if option
+      default = "{option}Noi18nRoutingTranslation"
+      t = I18n.t(option, :scope => "routes.#{name}.#{type}", :default => default)
+      return (t == default ? nil : t)
+    else
+      default = "{name}Noi18nRoutingTranslation"
+
+      # Try to get the translation in routes namescope first      
+      t = I18n.t(:as, :scope => "routes.#{name}", :default => default)
+
+      return t if t and t != default
+
+      t = I18n.t(name.to_s, :scope => type, :default => default)
+      return (t == default ? nil : t)
+    end
+  end
+
+  DefaultPathNames = [:new, :edit]
+  PathNamesKeys = [:path_names, :member, :collection]
+
+  # Return path names hash for given resource
+  def self.path_names(name, options)
+    h = (options[:path_names] || {}).dup
+    
+    path_names = DefaultPathNames
+    PathNamesKeys.each do |v|
+      path_names += options[v].keys if options[v] and Hash === options[v]
+    end
+    
+    path_names.each do |pn|
+      n = translation_for(name, :path_names, pn)
+      n = nil if n == pn.to_s
+      # Get default path_names in path_names scope if no path_names found
+      n ||= I18n.t(pn, :scope => :path_names, :default => name.to_s)
+
+      h[pn] = n if n and n != name.to_s
+    end
+
+    return h
+  end
+
+end

data/lib/i18n_routing_rails2.rb

@@ -0,0 +1,239 @@
+# encoding: utf-8
+
+#
+# WARNING : Old and dirty Rails 2.x code
+# Need clean up and intensive refactoring
+#
+
+module ActionController
+  module Routing
+    class Route #:nodoc:
+
+      alias_method :mkd_initialize, :initialize
+      def initialize(segments = [], requirements = {}, conditions = {})
+        @glang = requirements.delete(:glang)
+        mkd_initialize(segments, requirements, conditions)
+      end
+
+      private
+        alias_method :mkd_generation_requirements, :generation_requirements
+        # Add locale requirements to ensure good route is used when using url_for
+        def generation_requirements
+          r = mkd_generation_requirements
+          if @glang and !r.blank?
+            r << " and I18n.locale.to_sym == :#{@glang}"
+          end
+
+          return r
+        end
+    end
+  end
+end
+
+module ActionController
+  module Routing
+    class RouteSet #:nodoc:
+
+      attr :locales, true
+      attr :i18n_verbose, true
+
+      class Mapper
+        def localized(locales = I18n.available_locales, opts = {})
+          old_value = @set.locales
+          @set.locales = locales
+          @set.i18n_verbose ||= opts.delete(:verbose)
+          yield
+        ensure
+          @set.locales = old_value
+        end
+
+      end
+
+      class NamedRouteCollection #:nodoc:
+
+        alias_method :mkd_define_url_helper, :define_url_helper
+        def define_url_helper(route, name, kind, options)
+          gl = Thread.current[:globalized]
+
+          mkd_define_url_helper(route, name, kind, options)
+
+          if gl
+            selector = url_helper_name(name, kind)
+
+            rlang = if i = name.to_s.rindex("_#{gl}")
+              "#{selector.to_s[0, i]}_glang_#{gl}#{selector.to_s[i + "_#{gl}".size, selector.to_s.size]}"
+            elsif (gls = Thread.current[:globalized_s]) and i = name.to_s.rindex("_#{gls}")
+              "#{selector.to_s[0, i]}_glang_#{gls}#{selector.to_s[i + "_#{gls}".size, selector.to_s.size]}"
+            else
+              "glang_#{selector}"
+            end
+
+            # surcharge de l'helper
+            @module.module_eval <<-end_eval # We use module_eval to avoid leaks
+              alias_method :gl#{selector}, :#{selector}
+
+              def #{selector}(*args)
+                selector_g = '#{rlang}'.gsub('glang', I18n.locale.to_s).to_sym
+
+                #logger.debug "Call routes : #{selector} => \#{selector_g} (#{rlang}) "
+                #puts "Call routes : #{selector} => \#{selector_g} (#{rlang}) Found:\#{respond_to? selector_g and selector_g != :#{selector}}"
+                if respond_to? selector_g and selector_g != :#{selector}
+                  send(selector_g, *args)
+                else
+                  gl#{selector}(*args)
+                end
+              end
+              protected :gl#{selector}
+            end_eval
+
+          end
+        end
+      end
+
+      alias_method :gl_add_named_route, :add_named_route
+      def add_named_route(name, path, options = {}) #:nodoc:
+        if @locales and !path.blank? and !Thread.current[:i18n_no_named_localization]
+          # Here, try to translate standard named routes
+          name = name.to_s
+
+          @locales.each do |l|
+            I18n.locale = l
+            nt = "#{l}_#{name}"
+            if nt != name and (t = I18nRouting.translation_for(path, :named_routes_path))
+              gl_add_named_route(nt, t, options.merge(:glang => l))
+              puts("[I18n] > localize %-10s: %40s (%s) => %s" % ['route', name, l, t]) if @i18n_verbose
+            end
+          end
+
+          old_v = Thread.current[:globalized]
+          Thread.current[:globalized] = true
+          gl_add_named_route(name, path, options)
+          Thread.current[:globalized] = old_v
+          return
+        end
+
+        gl_add_named_route(name, path, options)
+      end
+
+    end
+  end
+end
+
+module ActionController
+  module Resources
+    class Resource
+      alias_method :mkd_initialize, :initialize
+      def initialize(entities, options)
+        @real_path = options.delete(:real_path)
+        @real_path = @real_path.to_s.singularize if @real_path
+
+        mkd_initialize(entities, options)
+      end
+
+      def nesting_name_prefix
+        @real_path ? "#{shallow_name_prefix}#{@real_path}_" : "#{shallow_name_prefix}#{singular}_"
+      end
+
+      def nesting_path_prefix
+        @nesting_path_prefix ||= (@real_path ? "#{shallow_path_prefix}/#{path_segment}/:#{@real_path}_id" : "#{shallow_path_prefix}/#{path_segment}/:#{singular}_id")
+      end
+    end
+
+    def switch_globalized_state(state)
+      old_g = Thread.current[:globalized]
+      Thread.current[:globalized] = state
+      yield
+      Thread.current[:globalized] = old_g
+    end
+
+    def switch_no_named_localization(state)
+      old_g = Thread.current[:i18n_no_named_localization]
+      Thread.current[:i18n_no_named_localization] = state
+      yield
+      Thread.current[:i18n_no_named_localization] = old_g
+    end
+
+    def create_globalized_resources(type, namespace, *entities, &block)
+
+      Thread.current[:i18n_nested_deep] ||= 0
+      Thread.current[:i18n_nested_deep] += 1
+
+      if @set.locales
+        name = entities.dup.shift.to_s
+
+        options = entities.extract_options!
+        opts = options.dup
+
+        locales = @set.locales
+        localized(nil) do
+          locales.each do |l|
+            I18n.locale = l
+            nt = "#{l}_#{name}"
+            if nt != name and (t = I18nRouting.translation_for(name, namespace))
+              nt = "#{l}_#{name}"
+              opts[:as] = t
+              opts[:glang] = l
+              opts[:controller] ||= name.to_s.pluralize
+              opts[:real_path] = opts[:singular] || name
+              opts[:path_names] = I18nRouting.path_names(name, options)
+              path_prefix_t = I18n.t(:path_prefix, :scope => :"routes.#{name}", :default => "NoPathPrefixTranslation")
+              opts[:path_prefix] = path_prefix_t unless path_prefix_t == "NoPathPrefixTranslation"
+
+              localized([l]) do
+                switch_no_named_localization(true) do
+                  send(type, nt.to_sym, opts, &block)
+                end
+              end
+              puts("[I18n] > localize %-10s: %40s (%s) => %s" % [namespace, nt, l, t]) if @set.i18n_verbose
+            end
+          end
+
+          if Thread.current[:i18n_nested_deep] < 2
+            switch_no_named_localization(nil) do
+              switch_globalized_state(true) do
+                send(type, *(entities << options), &block)
+              end
+            end
+          end
+        end
+
+      else
+        send(type, *entities, &block)
+      end
+
+      Thread.current[:i18n_nested_deep] -= 1
+    end
+
+    alias_method :gl_resources, :resources
+    def resources(*entities, &block)
+      create_globalized_resources(:gl_resources, :resources, *entities, &block)
+    end
+
+    alias_method :gl_resource, :resource
+    def resource(*entities, &block)
+      create_globalized_resources(:gl_resource, :resource, *entities, &block)
+    end
+
+    private
+    alias_method :gl_action_options_for, :action_options_for
+    def action_options_for(action, resource, method = nil, resource_options = {})
+      opts = gl_action_options_for(action, resource, method, resource_options)
+
+      if Thread.current[:globalized]
+        Thread.current[:globalized] = resource.plural
+        if resource.uncountable?
+          Thread.current[:globalized] = resource.plural.to_s + '_index'
+        end
+        Thread.current[:globalized_s] = resource.singular
+      else
+        Thread.current[:globalized] = nil
+        Thread.current[:globalized_s] = nil
+      end
+      if resource.options[:glang]
+        opts[:glang] = resource.options[:glang]
+      end
+
+      opts
+    end
+  end
+end

data/lib/i18n_routing_rails3.rb

@@ -0,0 +1,376 @@
+# encoding: utf-8
+require 'rack/mount'
+require 'action_dispatch'
+require 'active_support/core_ext/module'
+
+module I18nRouting
+  module Mapper
+
+    private
+    
+    # Just create a Mapper:Resource with given parameters
+    def resource_from_params(type, *resources)
+      res = resources.clone
+
+      options = res.extract_options!
+      r = res.first
+
+      type == :resource ? ActionDispatch::Routing::Mapper::SingletonResource.new(r, options.dup) : ActionDispatch::Routing::Mapper::Resource.new(r, options.dup)
+    end
+    
+    # Localize a resources or a resource
+    def localized_resources(type = :resources, *resources, &block)
+      localizable_route = nil
+
+      if @locales
+        res = resources.clone
+
+        options = res.extract_options!
+        r = res.first
+
+        resource = type == :resource ? ActionDispatch::Routing::Mapper::SingletonResource.new(r, options.dup) : ActionDispatch::Routing::Mapper::Resource.new(r, options.dup)
+
+        # Check for translated resource
+        @locales.each do |locale|
+          I18n.locale = locale
+          localized_path = I18nRouting.translation_for(resource.name, type)
+
+          # A translated route exists :
+          if localized_path and String === localized_path
+            puts("[I18n] > localize %-10s: %40s (%s) => /%s" % [type, resource.name, locale, localized_path]) if @i18n_verbose
+            opts = options.dup
+            opts[:path] = localized_path
+            opts[:controller] ||= r.to_s.pluralize
+
+            res = ["#{locale}_#{r}".to_sym, opts]
+
+            constraints = opts[:constraints] ? opts[:constraints].dup : {}
+            constraints[:i18n_locale] = locale.to_s
+
+            scope(:constraints => constraints, :path_names => I18nRouting.path_names(resource.name, @scope)) do
+              localized_branch(locale) do
+                send(type, *res) do
+                  # In the resource(s) block, we need to keep and restore some context :
+
+                  if block
+                    old_name = @scope[:i18n_real_resource_name]
+                    old = @scope[:scope_level_resource]
+
+                    @scope[:i18n_real_resource_name] = resource.name
+                    @scope[:i18n_scope_level_resource] = old
+                    @scope[:scope_level_resource] = resource
+
+                    if type == :resource and @scope[:name_prefix]
+                      # Need to fake name_prefix for singleton resource
+                      @scope[:name_prefix] = @scope[:name_prefix].gsub(Regexp.new("#{old.name}$"), resource.name)
+                    end
+
+                    block.call if block
+
+                    @scope[:scope_level_resource] = old
+                    @scope[:i18n_real_resource_name] = old_name
+                  end
+
+                  @scope[:i18n_scope_level_resource] = nil
+
+                end
+              end
+            end
+
+            localizable_route = resource
+          end
+        end
+      end
+      return localizable_route
+    end
+
+    # Set if the next route created will be a localized route or not
+    # If yes, localizable is a name, or a Mapper::Resource
+    # Can take a block, if so, save the current context, set the new
+    # Call the block, then restore the old context and return the block return
+    def set_localizable_route(localizable)      
+      if block_given?
+        old = @set.named_routes.localizable
+        @set.named_routes.set_localizable_route(localizable)
+        r = yield
+        @set.named_routes.set_localizable_route(old)
+        return r
+      else
+        @set.named_routes.set_localizable_route(localizable)
+      end
+    end
+    
+    def localizable_route
+      @set.named_routes.localizable
+    end
+    
+    # Return the aproximate deep in scope level
+    def nested_deep
+      (@scope and Array === @scope[:blocks] and @scope[:scope_level]) ? @scope[:blocks].size : 0
+    end
+
+    public
+
+    # On Routing::Mapper initialization (when doing Application.routes.draw do ...)
+    # prepare routing system to be i18n ready
+    def initialize(*args)
+      super
+
+      # Add i18n as valid conditions for Rack::Mount
+      @valid_conditions = @set.instance_eval { @set }.instance_eval { @valid_conditions }
+      @valid_conditions << :i18n_locale if !@valid_conditions.include?(:i18n_locale)
+
+      # Extends the current RouteSet in order to define localized helper for named routes
+      # When calling define_url_helper, it calls define_localized_url_helper too.
+      if !@set.named_routes.respond_to?(:define_localized_url_helper)
+        @set.named_routes.class_eval <<-END_EVAL, __FILE__, __LINE__ + 1
+          alias_method :localized_define_url_helper, :define_url_helper
+          def define_url_helper(route, name, kind, options)
+            localized_define_url_helper(route, name, kind, options)
+            define_localized_url_helper(route, name, kind, options)
+          end
+        END_EVAL
+
+        @set.named_routes.extend I18nRouting::NamedRouteCollection
+      end
+    end
+
+    # Rails 3 routing system
+    # Create a block for localized routes, in your routes.rb :
+    #
+    # localized do
+    #   resources :users
+    #   match 'about' => 'contents#about', :as => :about
+    # end
+    #
+    def localized(locales = I18n.available_locales, opts = {})
+      # Add if not added Rails.root/config/locales/*.yml in the I18n.load_path
+      if !@i18n_routing_path_set and defined?(Rails) and Rails.respond_to?(:root) and Rails.root
+        I18n.load_path = (I18n.load_path << Dir[Rails.root.join('config', 'locales', '*.yml').to_s]).uniq
+        @i18n_routing_path_set = true
+      end
+      
+      
+      old_value = @locales
+      @locales = locales
+      @i18n_verbose ||= opts.delete(:verbose)
+      yield
+    ensure
+      @locales = old_value
+    end
+    
+    # Create a branch for create routes in the specified locale
+    def localized_branch(locale)
+      set_localizable_route(nil) do
+        old = @localized_branch
+        @localized_branch = locale
+        localized([locale]) do
+          yield
+        end
+        @localized_branch = old
+      end
+    end
+    
+    # Set we do not want to localize next resource
+    def skip_localization
+      old = @skip_localization
+      @skip_localization = @localized_branch ? nil : true
+      yield
+      @skip_localization = old
+    end
+    
+    def match(*args)
+      # Localize simple match only if there is no resource scope.
+      if args.size == 1 and @locales and !parent_resource and args.first[:as]
+        @locales.each do |locale|
+          mapping = LocalizedMapping.new(locale, @set, @scope, Marshal.load(Marshal.dump(args))) # Dump is dirty but how to make deep cloning easily ? :/
+          if mapping.localizable?
+            puts("[I18n] > localize %-10s: %40s (%s) => %s" % ['route', args.first[:as], locale, mapping.path]) if @i18n_verbose
+            @set.add_route(*mapping.to_route)
+          end
+        end
+
+        # Now, create the real match :
+        return set_localizable_route(args.first[:as]) do
+          super
+        end
+      end
+
+      super
+    end
+    
+    def create_globalized_resources(type, *resources, &block)
+
+      #puts "#{' ' * nested_deep}Call #{type} : #{resources.inspect} (#{@locales.inspect}) (#{@localized_branch}) (#{@skip_localization})"
+
+      cur_scope = nil
+      if @locales
+        localized = localized_resources(type, *resources, &block) if !@skip_localization
+
+        ## We do not translate if we are in a translations branch :
+        return if localized and nested_deep > 0
+
+        # Set the current standard resource in order to customize url helper :
+        if !@localized_branch
+          r = resource_from_params(type, *resources)
+          cur_scope = (parent_resource and parent_resource.name == r.name) ? parent_resource : r
+        end
+      end
+
+      set_localizable_route(cur_scope) do
+        skip_localization do
+          #puts "#{' ' * nested_deep} \\- Call original #{type} : for #{resources.inspect}}"
+          send("#{type}_without_i18n_routing".to_sym, *resources, &block)
+        end
+      end
+
+    end
+    
+    # Alias methods in order to handle i18n routes
+    def self.included(mod)
+      mod.send :alias_method_chain, :resource, :i18n_routing
+      mod.send :alias_method_chain, :resources, :i18n_routing
+      
+      # Here we redefine some methods, in order to handle
+      # correct path_names translation on the fly
+      [:map_method, :member, :collection].each do |m|
+        rfname = "#{m}_without_i18n_routing".to_sym
+        mod.send :define_method, "#{m}_with_i18n_routing".to_sym do |*args, &block|
+          
+          if @localized_branch and @scope[:i18n_scope_level_resource] and @scope[:i18n_real_resource_name]
+            o = @scope[:scope_level_resource]
+            @scope[:scope_level_resource] = @scope[:i18n_scope_level_resource]
+
+            pname = @scope[:path_names] || {}
+            pname[args[1]] = args[1]
+            scope(:path_names => I18nRouting.path_names(@scope[:i18n_real_resource_name], {:path_names => pname})) do
+              send(rfname, *args, &block)
+            end
+            @scope[:scope_level_resource] = o
+            return
+          end
+
+          send(rfname, *args, &block)
+          
+        end
+
+        mod.send :alias_method_chain, m, :i18n_routing
+      end
+    end
+    
+    def resource_with_i18n_routing(*resources, &block)
+      create_globalized_resources(:resource, *resources, &block)
+    end
+    
+    def resources_with_i18n_routing(*resources, &block)
+      create_globalized_resources(:resources, *resources, &block)
+    end
+
+  end
+
+  # Used for localize simple named routes
+  class LocalizedMapping < ActionDispatch::Routing::Mapper::Mapping
+
+    attr_reader :path
+
+    def initialize(locale, set, scope, args)
+      super(set, scope, args.clone)
+
+      # try to get translated path :
+      I18n.locale = locale
+      ts = @path.gsub(/^\//, '')
+      @localized_path = '/' + (I18nRouting.translation_for(ts, :named_routes_path) || ts)
+
+      # If a translated path exists, set localized infos
+      if @localized_path and @localized_path != @path
+        #@options[:controller] ||= @options[:as]
+        @options[:as] = "#{locale}_#{@options[:as]}"
+        @path = @localized_path
+        @options[:constraints] = @options[:constraints] ? @options[:constraints].dup : {}
+        @options[:constraints][:i18n_locale] = locale.to_s
+        @options[:anchor] = true
+      else
+        @localized_path = nil
+      end
+
+    end
+
+    # Return true if this route is localizable
+    def localizable?
+      @localized_path != nil
+    end
+
+  end
+
+  module NamedRouteCollection
+
+    attr_reader :localizable
+
+    def set_localizable_route(localizable)
+      @localizable = localizable
+    end
+
+    # Alias named route helper in order to check if a localized helper exists
+    # If not use the standard one.
+    def define_localized_url_helper(route, name, kind, options)
+      if n = localizable
+        selector = url_helper_name(name, kind)
+
+        rlang = if n.kind_of?(ActionDispatch::Routing::Mapper::Resources::Resource) and i = name.to_s.rindex("_#{n.plural}")
+                  "#{selector.to_s[0, i]}_glang_#{n.plural}#{selector.to_s[i + "_#{n.plural}".size, selector.to_s.size]}"
+                elsif n.kind_of?(ActionDispatch::Routing::Mapper::Resources::Resource) and i = name.to_s.rindex("_#{n.singular}")
+                  "#{selector.to_s[0, i]}_glang_#{n.singular}#{selector.to_s[i + "_#{n.singular}".size, selector.to_s.size]}"
+                else
+                  "glang_#{selector}"
+                end
+
+        @module.module_eval <<-end_eval # We use module_eval to avoid leaks
+          alias_method :localized_#{selector}, :#{selector}
+
+          def #{selector}(*args)
+            selector_g = '#{rlang}'.gsub('glang', I18n.locale.to_s).to_sym
+
+            #puts "Call routes : #{selector} => \#{selector_g} (\#{I18n.locale}) "
+            if respond_to? selector_g and selector_g != :#{selector}
+              send(selector_g, *args)
+            else
+              localized_#{selector}(*args)
+            end
+          end
+
+        end_eval
+
+      end
+    end
+  end
+
+  # Rack::Mount::Route module
+  # Exists in order to use apropriate localized route when using url_for
+  module RackMountRoute
+    
+    # Alias methods in order to handle i18n routes
+    def self.included(mod)
+      mod.send :alias_method_chain, :generate, :i18n_routing
+      mod.send :alias_method_chain, :initialize, :i18n_routing
+    end
+
+    # During route initialization, if a condition i18n_locale is present
+    # Delete it, and store it in @locale
+    def initialize_with_i18n_routing(app, conditions, defaults, name)
+      @locale = conditions[:i18n_locale] ? conditions.delete(:i18n_locale).source.to_sym : nil
+      initialize_without_i18n_routing(app, conditions, defaults, name)
+    end
+
+    # Called for dynamic route generation
+    # If a @locale is present and if this locale is not the current one
+    #  => return nil and refuse to generate the route
+    def generate_with_i18n_routing(method, params = {}, recall = {}, options = {})
+      return nil if @locale and @locale != I18n.locale.to_sym
+      generate_without_i18n_routing(method, params, recall, options)
+    end
+
+  end
+end
+
+ActionDispatch::Routing::Mapper.send  :include, I18nRouting::Mapper
+Rack::Mount::Route.send               :include, I18nRouting::RackMountRoute

data/spec/i18n_routing/i18n_spec.rb

@@ -0,0 +1,309 @@
+require 'spec_helper'
+
+describe :localized_routes do
+
+  $r = nil # Global routes in order to speed up testing
+  
+  before(:all) do
+
+    if !$r
+      if !rails3?
+        ActionController::Routing::Routes.clear!
+        ActionController::Routing::Routes.draw do |map|
+          map.not_about 'not_about', :controller => 'not_about'
+          map.resources :not_users
+          map.resource  :not_contact
+
+          map.localized(I18n.available_locales, :verbose => false) do
+            map.about 'about', :controller => 'about', :action => :show
+
+            map.resources :users, :member => {:level => :get}, :collection => {:groups => :get}
+            map.resource  :contact
+
+            map.resources :authors do |m|
+              m.resources :books
+            end
+            
+            map.resource :foo do |m|
+              m.resources :bars
+              m.resource :foofoo do |mm|
+                mm.resources :bars
+              end
+            end
+
+            map.resources :universes do |m|
+              m.resources :galaxies do |mm|
+                mm.resources :planets do |mmm|
+                  mmm.resources :countries
+                end
+              end
+            end
+
+            map.resources :drones, :path_prefix => 'doubledrones/unimatrix/zero'
+          end
+        end
+      
+        $r = ActionController::Routing::Routes
+      
+        class UrlTester
+          include ActionController::UrlWriter
+        end
+
+      else
+
+        $r = ActionDispatch::Routing::RouteSet.new
+        $r.draw do
+          match 'not_about' => "not_about#show", :as => :not_about
+          resources :not_users
+          resource  :not_contact
+
+          localized(I18n.available_locales, :verbose => false) do
+            match 'about' => "about#show", :as => :about
+
+            resources :users do
+              member do
+                get :level
+              end
+              get :groups, :on => :collection
+            end
+            resource  :contact
+
+            resources :authors do
+              resources :books
+            end
+
+            resource :foo do
+              resources :bars
+              resource :foofoo do
+                resources :bars
+              end
+            end
+
+            resources :universes do
+              resources :galaxies do
+                resources :planets do
+                  scope do
+                    resources :countries
+                  end
+                end
+              end
+            end
+
+          end
+        end
+           
+        class UrlTester; end
+        UrlTester.send :include, $r.url_helpers
+
+      end
+    end
+
+  end
+
+  let(:nested_routes) { $r.named_routes.instance_eval { routes } }
+  let(:routes) { UrlTester.new }
+
+  def url_for(opts)
+    $r.generate_extras(opts).first
+  end
+
+  context "do not break existing behavior" do
+
+    it "of named_routes" do
+      routes.send(:not_about_path).should == "/not_about"
+    end
+
+    it "of a singular resource" do
+      routes.send(:not_contact_path).should == "/not_contact"
+    end
+
+    it "of resources" do
+      routes.send(:not_users_path).should == "/not_users"
+    end
+
+  end
+
+  context "for default routes" do
+
+    before do
+      I18n.locale = :de # Not localized
+    end
+
+    it "named_route uses default values" do
+      routes.send(:about_path).should == "/about"
+    end
+
+    it "resource generates routes using default values" do
+      routes.send(:contact_path).should == "/contact"
+    end
+
+    it "resources generates routes using default values" do
+      routes.send(:users_path).should == "/users"
+    end
+
+    it "url_for generates route using default values" do
+      url_for(:controller => :users).should == "/users"
+    end
+
+    it "nested resources generate routes using default values" do
+      routes.send(:author_books_path, 1).should == "/authors/1/books"
+    end
+
+    it "deep nested resources generate routes using default values" do
+      routes.send(:universes_path).should == "/universes"
+      routes.send(:universe_galaxies_path, 1).should == "/universes/1/galaxies"
+      routes.send(:universe_galaxy_planets_path, 1, 1).should == "/universes/1/galaxies/1/planets"
+    end
+    
+    it "single resource should have by default the pluralized controller" do
+      nested_routes[:foo].defaults[:controller].should == 'foos'
+    end
+
+  end
+
+  context "" do
+
+    before do
+      I18n.locale = :fr
+    end
+
+    it "named_route generates route using localized values" do
+      routes.send(:about_path).should == "/#{I18n.t :about, :scope => :named_routes_path}"
+    end
+
+    it "named_route generates route using localized values and I18n.locale as a string" do
+      o = I18n.locale
+      I18n.locale = "fr"
+      routes.send(:about_path).should == "/#{I18n.t :about, :scope => :named_routes_path}"
+      I18n.locale = o
+    end
+
+    it "resource generates routes using localized values" do
+      routes.send(:contact_path).should == "/#{I18n.t :contact, :scope => :resource}"
+    end
+
+    it "resources generates routes using localized values" do
+      routes.send(:users_path).should == "/#{I18n.t :as, :scope => :'routes.users'}"
+    end
+
+    it "url_for generates routes using localized values" do
+      url_for(:controller => :users).should == "/#{I18n.t :as, :scope => :'routes.users'}"
+      url_for(:controller => :about, :action => :show).should == "/#{I18n.t :about, :scope => :named_routes_path}"
+    end
+
+    it "url_for generates routes for drones with path prefix" do
+      url_for(:controller => :drones).should == "#{I18n.t :path_prefix, :scope => :'routes.drones'}/#{I18n.t :as, :scope => :'routes.drones'}"
+    end
+
+    it "nested resources generate routes using localized values" do
+      routes.send(:author_books_path, 1).should == "/#{I18n.t :authors, :scope => :resources}/1/#{I18n.t :books, :scope => :resources}"
+    end
+
+    it "deep nested resources generate routes using localized values and translate routes even translated name is the same" do
+      routes.send(:universes_path).should == "/#{I18n.t :universes, :scope => :resources}"
+      routes.send(:universe_galaxies_path, 1).should == "/#{I18n.t :universes, :scope => :resources}/1/#{I18n.t :galaxies, :scope => :resources}"
+      routes.send(:universe_galaxy_planets_path, 1, 1).should == "/#{I18n.t :universes, :scope => :resources}/1/#{I18n.t :galaxies, :scope => :resources}/1/#{I18n.t :planets, :scope => :resources}"
+      routes.send(:universe_galaxy_planet_countries_path, 1, 1, 42).should == "/#{I18n.t :universes, :scope => :resources}/1/#{I18n.t :galaxies, :scope => :resources}/1/#{I18n.t :planets, :scope => :resources}/42/#{I18n.t :countries, :scope => :resources}"
+    end
+
+    context "with path_names" do
+      
+      it "default translated path names" do
+        routes.send(:new_universe_path).should == "/#{I18n.t :universes, :scope => :resources}/#{I18n.t :new, :scope => :path_names}"
+        routes.send(:edit_universe_path, 42).should == "/#{I18n.t :universes, :scope => :resources}/42/#{I18n.t :edit, :scope => :path_names}"
+      end
+      
+      it "custom translated path names" do
+        routes.send(:new_user_path).should == "/#{I18n.t :users, :scope => :resources}/#{I18n.t :new, :scope => :'routes.users.path_names'}"
+        routes.send(:edit_user_path, 42).should == "/#{I18n.t :users, :scope => :resources}/42/#{I18n.t :edit, :scope => :'routes.users.path_names'}"
+      end
+      
+    end
+    
+    context "with member and collection" do
+
+      it "custom member" do
+        I18n.locale = :en
+        routes.send(:level_user_path, 42).should == "/#{I18n.t :users, :scope => :resources}/42/level"        
+        I18n.locale = :fr
+        routes.send(:level_user_path, 42).should == "/#{I18n.t :users, :scope => :resources}/42/#{I18n.t :level, :scope => :'routes.users.path_names'}"
+      end
+
+      it "custom collection" do
+        I18n.locale = :en
+        routes.send(:groups_users_path).should == "/#{I18n.t :users, :scope => :resources}/groups"        
+        I18n.locale = :fr
+        routes.send(:groups_users_path).should == "/#{I18n.t :users, :scope => :resources}/#{I18n.t :groups, :scope => :'routes.users.path_names'}"
+      end
+
+    end
+
+    context "when nested" do
+
+      it "named routes should not be nil" do
+        nested_routes[:author_fr_books].should_not be_nil
+      end
+
+      context "in Rails #{Rails.version}" do
+        it "include the correct significant keys" do
+          v = !rails3? ? :significant_keys : :segment_keys
+          nested_routes[:author_books].send(v).should include(:author_id)
+          nested_routes[:author_fr_books].send(v).should include(:author_id)
+        end
+      end
+
+    end
+
+    context "when nested inside a singleton resource" do
+
+      it "named routes should have locale placed at correct position" do
+        nested_routes[:fr_foo_fr_bars].should be_nil
+        nested_routes[:foo_fr_bars].should_not be_nil
+      end
+
+      it "routes for the singleton resource alone should be translated correctly" do
+        routes.send(:foo_path).should == "/#{I18n.t :foo, :scope => :resource}"
+      end
+
+      it "routes should be translated correctly" do
+        routes.send(:foo_bars_path).should == "/#{I18n.t :foo, :scope => :resource}/#{I18n.t :bars, :scope => :resources}"
+      end
+
+      it "routes should be translated correctly also with deep nested singleton resource" do
+        routes.send(:foo_foofoo_bars_path).should == "/#{I18n.t :foo, :scope => :resource}/#{I18n.t :foofoo, :scope => :resource}/#{I18n.t :bars, :scope => :resources}"
+      end
+
+    end
+
+    context "when deeply nested" do
+
+      it "named routes should not be nil" do
+        nested_routes[:universe_galaxy_fr_planet].should_not be_nil
+      end
+
+      context "in Rails #{Rails.version}" do
+        it "include the correct significant keys" do
+          v = !rails3? ? :significant_keys : :segment_keys
+          nested_routes[:universe_galaxy_planet].send(v).should include(:universe_id)
+          nested_routes[:universe_galaxy_fr_planet].send(v).should include(:universe_id)
+          nested_routes[:universe_galaxy_planet].send(v).should include(:galaxy_id)
+          nested_routes[:universe_galaxy_fr_planet].send(v).should include(:galaxy_id)
+        end
+      end
+    end
+
+    it "nested resources do not deep translate with multi helpers" do
+      nested_routes.keys.should_not include(:fr_author_books) # Do not want fr_author_books
+    end    
+
+  end
+
+  # context "just output" do
+  #   it "output all routes properly" do
+  #     nested_routes.keys.collect(&:to_s).sort.each do |k|
+  #       puts("%50s: %.80s" % [k, (nested_routes[k.to_sym].path rescue nested_routes[k.to_sym].to_s)])
+  #     end
+  #   end
+  # end
+
+end

data/spec/locales/en.yml

@@ -0,0 +1,13 @@
+en:
+  resources:
+    users: members
+    authors: 'authors-en'
+    galaxies: 'galaxies-en'
+    planets: 'planets-en'
+    universes: 'universes-en'
+    bars: bars_en
+  resource:
+    foo: foo_en
+    contact: 'contact-us'
+  named_routes_path:
+    about: 'about-our-company'

data/spec/locales/fr.yml

@@ -0,0 +1,30 @@
+fr:
+  routes:
+    users:
+      as: utilisateurs
+      path_names:
+        level: 'niveau'
+        groups: 'groupe'
+        new: 'nouvel_utilisateur'
+        edit: 'edition_utilisateur'
+    drones:
+      as: senord
+      path_prefix: '/senordelbuod/xirtaminu/orez'
+  resources:
+    users: utilisateurs
+    authors: 'auteurs'
+    books: 'livres'
+    galaxies: 'galaxies'
+    planets: 'planetes'
+    universes: 'univers'
+    countries: 'pays'
+    bars: bars_fr
+  resource:
+    foo: foo_fr
+    foofoo: froufrou
+    contact: 'contactez-nous'
+  named_routes_path:
+    about: 'a-propos'
+  path_names:
+    new: 'nouveau'
+    edit: 'edition'

data/spec/spec_helper.rb

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'spec'
+
+$rails_version = ARGV.find { |e| e =~ /rails_spec_version=.*/ }.split('=').last.to_i rescue nil
+
+if !$rails_version
+  begin
+    require 'rails'
+  rescue Exception
+    $rails_version = 2
+  end
+end
+
+if !Module.constants.include?('Rails') and $rails_version
+  module Rails
+    def self.version
+      $rails_version.to_s
+    end
+  end
+end
+
+if Rails.version < '3'
+  gem 'actionpack', '< 2.9.9'
+  require 'action_controller'
+  require 'action_controller/routing'
+else
+  gem 'actionpack', '> 2.9'
+  require 'action_controller'
+  require 'action_dispatch'
+  require 'rack/mount'
+end
+
+def rails3?
+  !(Rails.version < '3')
+end
+
+puts "Launching spec for Rails #{Rails.version}"
+
+# Add I18n load_path
+I18n.load_path = (I18n.load_path << Dir[File.join(File.dirname(__FILE__), 'locales', '*.yml')]).uniq
+
+require File.dirname(__FILE__) + '/../init.rb'

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: doubledrones-i18n_routing
+version: !ruby/object:Gem::Version 
+  hash: 77
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 6
+  - 1
+  version: 0.3.6.1
+platform: ruby
+authors: 
+- Guillaume Luccisano
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-11 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 0
+        - 3
+        - 5
+        version: 0.3.5
+  type: :runtime
+  version_requirements: *id001
+description: I18n_routing is a plugin for Ruby on Rails that lets you easily translate your routes trough the I18n api included in Rails since version 2.2
+email: guillaume.luccisano@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/i18n_routing.rb
+- lib/i18n_routing_common.rb
+- lib/i18n_routing_rails2.rb
+- lib/i18n_routing_rails3.rb
+- spec/i18n_routing/i18n_spec.rb
+- spec/locales/en.yml
+- spec/locales/fr.yml
+- spec/spec_helper.rb
+- CHANGELOG.rdoc
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- init.rb
+has_rdoc: true
+homepage: http://github.com/kwi/i18n_routing
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 19
+      segments: 
+      - 1
+      - 3
+      - 4
+      version: 1.3.4
+requirements: []
+
+rubyforge_project: doubledrones-i18n_routing
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: I18n routing module for Rails 2.3.x and Rails 3. Translate your routes with ease !
+test_files: []
+