i18n_routing 0.2.4 → 0.3.0

data/CHANGELOG.rdoc

@@ -1,3 +1,9 @@
+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)

data/README.rdoc

@@ -4,12 +4,7 @@ I18n_routing is a plugin for Ruby on Rails that lets you easily translate your r
 
 All necessary informations are available on the wiki : http://wiki.github.com/kwi/i18n_routing
 
-Warning: The plugin is not currently running well with deep nesting resources for Rails3. This will be fixed soon
-
-== TODO
-
-* Do nested resources for Rails3  
-* Another bug fix ?
+Works with Rails 2.3 and Rails3 !
 
 == Contributors
 

data/lib/i18n_routing.rb

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

data/lib/i18n_routing_common.rb

@@ -0,0 +1,46 @@
+# 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
+      t = I18n.t(option.to_sym, :scope => "routes.#{name}.#{type}".to_sym, :default => option.to_s)
+
+      return (t || name)
+    else
+      # Try to get the translation in routes namescope first      
+      t = I18n.t(:as, :scope => "routes.#{name}".to_sym, :default => name.to_s)
+      return t if t and t != name.to_s
+
+      I18n.t(name.to_s, :scope => type, :default => name.to_s)      
+    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

@@ -93,13 +93,13 @@ module ActionController
       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]
-          #puts "ADD NAMED ROUTE : #{path}"
+          # 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 = I18n.t(path.to_s, :scope => :named_routes_path, :default => path.to_s)) != path)
+            if nt != name and ((t = I18nRouting.translation_for(path, :named_routes_path)) != 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
@@ -164,21 +164,20 @@ module ActionController
         options = entities.extract_options!
         opts = options.dup
 
-        opts[:controller] ||= name
-
         locales = @set.locales
-        translated = nil
         localized(nil) do
           locales.each do |l|
             I18n.locale = l
             nt = "#{l}_#{name}"
-            if nt != name and ((t = I18n.t(name, :scope => namespace, :default => name)) != name)
+            if nt != name and ((t = I18nRouting.translation_for(name, namespace)) != name)
               nt = "#{l}_#{name}"
               opts[:as] = t
               opts[:glang] = l
+              opts[:controller] ||= name
               opts[:real_path] = opts[:singular] || name
+              opts[:path_names] = I18nRouting.path_names(name, options)
+
               localized([l]) do
-                translated = true
                 switch_no_named_localization(true) do
                   send(type, nt.to_sym, opts, &block)
                 end

data/lib/i18n_routing_rails3.rb

@@ -7,6 +7,17 @@ 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
@@ -16,12 +27,13 @@ module I18nRouting
 
         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 = I18n.t(resource.name, :scope => type, :default => resource.name.to_s)
+          localized_path = I18nRouting.translation_for(resource.name, type)
 
           # A translated route exists :
           if localized_path and localized_path != resource.name.to_s
@@ -29,14 +41,31 @@ module I18nRouting
             opts = options.dup
             opts[:path] = localized_path.to_sym
             opts[:controller] ||= r
-            opts[:constraints] = opts[:constraints] ? opts[:constraints].dup : {}
-            opts[:constraints][:i18n_locale] = locale.to_s
+
             res = ["#{locale}_#{r}".to_sym, opts]
 
-            # Create the localized resource(s)
-            scope(:constraints => opts[:constraints]) do
-              localized(nil) do
-                send(type, *res, &block)
+            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 :
+
+                  old_name = @scope[:i18n_real_resource_name]
+                  old = @scope[:scope_level_resource]
+                  old_i = @scope[:i18n_scope_level_resource]
+
+                  @scope[:i18n_real_resource_name] = resource.name
+                  @scope[:i18n_scope_level_resource] = old
+                  @scope[:scope_level_resource] = resource
+
+                  block.call if block
+
+                  @scope[:i18n_scope_level_resource] = nil
+                  @scope[:scope_level_resource] = old
+                  @scope[:i18n_real_resource_name] = old_name
+                end
               end
             end
 
@@ -47,11 +76,11 @@ module I18nRouting
       return localizable_route
     end
 
-    # Set if the next route creation will be a localied route or not
+    # 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)
+    def set_localizable_route(localizable)      
       if block_given?
         old = @set.named_routes.localizable
         @set.named_routes.set_localizable_route(localizable)
@@ -62,6 +91,15 @@ module I18nRouting
         @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
 
@@ -100,15 +138,35 @@ module I18nRouting
     def localized(locales = I18n.available_locales, opts = {})
       old_value = @locales
       @locales = locales
-      @i18n_verbose = opts.delete(:verbose)
+      @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 !@scope[:scope_level_resource] and args.first[:as]
+      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?
@@ -125,20 +183,73 @@ module I18nRouting
 
       super
     end
+    
+    def create_globalized_resources(type, *resources, &block)
 
-    def resource(*resources, &block)
-      set_localizable_route(nil) do
-        set_localizable_route(localized_resources(:resource, *resources, &block))
-        super
+      #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
 
-    def resources(*resources, &block)
-      set_localizable_route(nil) do
-        set_localizable_route(localized_resources(:resources, *resources, &block))
-        super
+          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
 
@@ -153,7 +264,7 @@ module I18nRouting
       # try to get translated path :
       I18n.locale = locale
       ts = @path.gsub(/^\//, '')
-      @localized_path = '/' + I18n.t(ts, :scope => :named_routes_path, :default => ts)
+      @localized_path = '/' + I18nRouting.translation_for(ts, :named_routes_path)
 
       # If a translated path exists, set localized infos
       if @localized_path and @localized_path != @path
@@ -222,7 +333,7 @@ module I18nRouting
   # Exists in order to use apropriate localized route when using url_for
   module RackMountRoute
     
-    # Alias method in order to handle i18n routes
+    # 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

data/spec/i18n_routing/i18n_spec.rb

@@ -1,77 +1,94 @@
 require 'spec_helper'
 
 describe :localized_routes do
+
+  @@r = nil # Global routes in order to speed up testing
+  
   before(:all) do
 
-    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
+    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 do
-          map.about 'about', :controller => 'about', :action => :show
+          map.localized(I18n.available_locales, :verbose => false) do
+            map.about 'about', :controller => 'about', :action => :show
 
-          map.resources :users
-          map.resource  :contact
+            map.resources :users, :member => {:level => :get}, :collection => {:groups => :get}
+            map.resource  :contact
 
-          map.resources :authors do |m|
-            m.resources :books
-          end
+            map.resources :authors do |m|
+              m.resources :books
+            end
 
-          map.resources :universes do |m|
-            m.resources :galaxies do |mm|
-              mm.resources :planets
+            map.resources :universes do |m|
+              m.resources :galaxies do |mm|
+                mm.resources :planets do |mmm|
+                  mmm.resources :countries
+                end
+              end
             end
           end
         end
-      end
       
-      @r = ActionController::Routing::Routes
+        @@r = ActionController::Routing::Routes
       
-      class UrlTester
-        include ActionController::UrlWriter
-      end
+        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
+      else
 
-        localized(I18n.available_locales, :verbose => true) do
-          match 'about' => "about#show", :as => :about
+        @@r = ActionDispatch::Routing::RouteSet.new
+        @@r.draw do
+          match 'not_about' => "not_about#show", :as => :not_about
+          resources :not_users
+          resource  :not_contact
 
-          resources :users
-          resource  :contact
+          localized(I18n.available_locales, :verbose => false) do
+            match 'about' => "about#show", :as => :about
 
-          resources :authors do
-            resources :books
-          end
+            resources :users do
+              member do
+                get :level
+              end
+              get :groups, :on => :collection
+            end
+            resource  :contact
 
-          resources :universes do
-            resources :galaxies do
-              resources :planets
+            resources :authors do
+              resources :books
+            end
+            
+            resources :universes do
+              resources :galaxies do
+                resources :planets do
+                  scope do
+                    resources :countries
+                  end
+                end
+              end
             end
-          end
 
+          end
         end
-      end
            
-      class UrlTester; end
-      UrlTester.send :include, @r.url_helpers
+        class UrlTester; end
+        UrlTester.send :include, @@r.url_helpers
 
+      end
     end
 
   end
 
-  let(:nested_routes) { @r.named_routes.instance_eval { routes } }
+  let(:nested_routes) { @@r.named_routes.instance_eval { routes } }
   let(:routes) { UrlTester.new }
 
   def url_for(opts)
-    @r.generate_extras(opts).first
+    @@r.generate_extras(opts).first
   end
 
   context "do not break existing behavior" do
@@ -139,11 +156,11 @@ describe :localized_routes do
     end
 
     it "resources generates routes using localized values" do
-      routes.send(:users_path).should == "/#{I18n.t :users, :scope => :resources}"
+      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 :users, :scope => :resources}"
+      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
 
@@ -155,6 +172,39 @@ describe :localized_routes 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
@@ -191,9 +241,17 @@ describe :localized_routes do
     end
 
     it "nested resources do not deep translate with multi helpers" do
-      nested_routes.keys.should_not include(:fr_author_books) # Want fr_author_books
-    end
+      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/fr.yml

@@ -1,4 +1,12 @@
 fr:
+  routes:
+    users:
+      as: utilisateurs
+      path_names:
+        level: 'niveau'
+        groups: 'groupe'
+        new: 'nouvel_utilisateur'
+        edit: 'edition_utilisateur'
   resources:
     users: utilisateurs
     authors: 'auteurs'
@@ -6,8 +14,11 @@ fr:
     galaxies: 'galaxies-en-francais'
     planets: 'planetes'
     universes: 'univers'
+    countries: 'pays'
   resource:
     contact: 'contactez-nous'
   named_routes_path:
     about: 'a-propos'
-    
+  path_names:
+    new: 'nouveau'
+    edit: 'edition'  

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 4
-  version: 0.2.4
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Guillaume Luccisano
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-30 00:00:00 +02:00
+date: 2010-05-27 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,6 +41,7 @@ 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
@@ -48,12 +49,10 @@ files:
 - spec/locales/fr.yml
 - spec/spec_helper.rb
 - CHANGELOG.rdoc
-- i18n_routing-0.2.4.gem
-- i18n_routing.gemspec
-- init.rb
 - MIT-LICENSE
 - Rakefile
 - README.rdoc
+- init.rb
 has_rdoc: true
 homepage: http://github.com/kwi/i18n_routing
 licenses: []

data/i18n_routing.gemspec

@@ -1,17 +0,0 @@
-Gem::Specification.new do |s|
-  s.name = "i18n_routing"
-  s.version = "0.2.4"
-  s.author = "Guillaume Luccisano"
-  s.email = "guillaume.luccisano@gmail.com"
-  s.homepage = "http://github.com/kwi/i18n_routing"
-  s.summary = "I18n routing module for Rails 2.3.x and Rails 3. Translate your routes with ease !"
-  s.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"
-
-  s.add_dependency('i18n', '> 0.3.5')
-
-  s.files = Dir["{lib,spec}/**/*", "[A-Z]*", "init.rb"]
-  s.require_path = "lib"
-
-  s.rubyforge_project = s.name
-  s.required_rubygems_version = ">= 1.3.4"
-end