rails-translate-routes 0.0.1 → 0.0.2

data/Gemfile.lock

@@ -39,13 +39,13 @@ GEM
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    json (1.6.4)
+    json (1.6.5)
     mail (2.3.0)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     mime-types (1.17.2)
-    minitest (2.10.0)
+    minitest (2.10.1)
     multi_json (1.0.4)
     polyglot (0.3.3)
     rack (1.3.6)

data/README.rdoc

@@ -4,7 +4,7 @@ Rails 3.x routes translations based on Raul's translate_routes (https://github.c
 
 It's currently a stripped down version of the forked gem, adding some bugfixes for rails 3.1 and features I needed for my project. See doc below to see what it can do.
 
-translate_routes & i18n_routes seems to be unmaintained projects so I decided to start a fork of the first one for my own projects, I can't promise high dedication but I'll to maintain it for my own use and take care all patches & bugs submitted, help is welcome!
+translate_routes & i18n_routes seems to be unmaintained projects so I decided to start a fork of the first one for my own projects, I can't promise high dedication but I'll try to maintain it for my own use and take care all patches & bugs submitted, help is welcome!
 
 == Installation
 
@@ -68,29 +68,32 @@ Also remember to include language detection to your app, a simple example of an
 
 And that's it! Now if we execute 'rake routes':
 
-    products_en GET    /products(.:format)              {:action=>"index", :controller=>"products"}
-    products_es GET    /es/productos(.:format)          {:action=>"index", :controller=>"products"}
-                POST   /products(.:format)              {:action=>"create", :controller=>"products"}
-                POST   /es/productos(.:format)          {:action=>"create", :controller=>"products"}
- new_product_en GET    /products/new(.:format)          {:action=>"new", :controller=>"products"}
- new_product_es GET    /es/productos/new(.:format)      {:action=>"new", :controller=>"products"}
-edit_product_en GET    /products/:id/edit(.:format)     {:action=>"edit", :controller=>"products"}
-edit_product_es GET    /es/productos/:id/edit(.:format) {:action=>"edit", :controller=>"products"}
-     product_en GET    /products/:id(.:format)          {:action=>"show", :controller=>"products"}
-     product_es GET    /es/productos/:id(.:format)      {:action=>"show", :controller=>"products"}
-                PUT    /products/:id(.:format)          {:action=>"update", :controller=>"products"}
-                PUT    /es/productos/:id(.:format)      {:action=>"update", :controller=>"products"}
-                DELETE /products/:id(.:format)          {:action=>"destroy", :controller=>"products"}
-                DELETE /es/productos/:id(.:format)      {:action=>"destroy", :controller=>"products"}
-     contact_en        /contact(.:format)               {:action=>"contact", :controller=>"pages"}
-     contact_es        /es/contacto(.:format)           {:action=>"contact", :controller=>"pages"}
-
+      products_en GET    /products(.:format)              {:action=>"index", :controller=>"products"}
+      products_es GET    /es/productos(.:format)          {:action=>"index", :controller=>"products"}
+                  POST   /products(.:format)              {:action=>"create", :controller=>"products"}
+                  POST   /es/productos(.:format)          {:action=>"create", :controller=>"products"}
+   new_product_en GET    /products/new(.:format)          {:action=>"new", :controller=>"products"}
+   new_product_es GET    /es/productos/new(.:format)      {:action=>"new", :controller=>"products"}
+  edit_product_en GET    /products/:id/edit(.:format)     {:action=>"edit", :controller=>"products"}
+  edit_product_es GET    /es/productos/:id/edit(.:format) {:action=>"edit", :controller=>"products"}
+       product_en GET    /products/:id(.:format)          {:action=>"show", :controller=>"products"}
+       product_es GET    /es/productos/:id(.:format)      {:action=>"show", :controller=>"products"}
+                  PUT    /products/:id(.:format)          {:action=>"update", :controller=>"products"}
+                  PUT    /es/productos/:id(.:format)      {:action=>"update", :controller=>"products"}
+                  DELETE /products/:id(.:format)          {:action=>"destroy", :controller=>"products"}
+                  DELETE /es/productos/:id(.:format)      {:action=>"destroy", :controller=>"products"}
+       contact_en        /contact(.:format)               {:action=>"contact", :controller=>"pages"}
+       contact_es        /es/contacto(.:format)           {:action=>"contact", :controller=>"pages"}
+          root_en        /                                {:controller=>"public", :action=>"index"}
+          root_es        /es                              {:controller=>"public", :action=>"index"}
 
 The application recognizes the different routes and sets the 'I18n.locale' value in controllers, but what about the routes generation? As you can see on the previous rake routes execution, the 'contact_es_path' and 'contact_en_path' routing helpers have been generated and are available in your controllers and views. Additionally, a 'contact_path' helper has been generated, which generates the routes according to the current request's locale. This means that if you use named routes you don't need to modify your application links because the routing helpers are automatically adapted to the current locale.
 
-<b>URL structure options</b>
+== URL structure options
+
+<b>Default URL structure</b>
 
-As you can see by default it generates the following url structure:
+By default it generates the following url structure:
 
   /
   /es
@@ -99,6 +102,9 @@ As you can see by default it generates the following url structure:
   /contact/
   /es/contactos/
 
+
+<b>All languages prefixed</b>
+
 In case you want the default languages to be scoped resulting in the following structure:
 
   /en
@@ -123,12 +129,51 @@ A simple example of a redirection to user locale in index method:
   def index
     unless params[ :locale]
       # it takes I18n.locale from the previous example set_locale as before_filter in application controller
-      redirect_to eval("root_#{I18n.locale}_path
+      redirect_to eval("root_#{I18n.locale}_path")
     end
 
     # rest of the controller logic ...
   end
 
+<b>No prefixed languages</b>
+
+In case you don't want the language prefix in the url path because you have a domain or subdomain per language (or any other reason). Resulting in this structure:
+
+  /
+  /products/
+  /productos/
+  /contact/
+  /contactos/
+
+You can specify the following option:
+
+  ActionDispatch::Routing::Translator.translate_from_file('config/locales/routes.yml', { :no_prefixes => true })
+
+Note that the 'no_prefixes' option will override the 'prefix_on_default_locale' option.
+
+<b>Namespaced backends</b>
+
+I usually build app backend in namespaced controllers, routes, ... using 'prefix_on_default_locale' will result in having several routes for backend too, for example:
+
+  /en/admin/products
+  /es/admin/productos
+
+In most cases you won't want to have the backend in several languages, you can set 'routes.rb' this way:
+
+  SampleApp::Application.routes.draw do
+    resources :products
+    match 'contact', :to => 'pages#contact'
+  end
+
+  ActionDispatch::Routing::Translator.translate_from_file('config/locales/routes.yml', { :prefix_on_default_locale => true })
+
+  SampleApp::Application.routes.draw do
+    namespace :admin do
+      resources :products
+      root :to => "admin_products#index"
+    end
+  end
+
 == TODO
 
 Help is welcome ;)
@@ -140,6 +185,10 @@ Help is welcome ;)
 
 Thanks to:
 
+* Contributors of the current gem:
+  * Martin Carel (https://github.com/cawel)
+  * Johan Gyllenspetz (https://github.com/gyllen)
+
 * Main development of forked gem:
   * Raul Murciano (http://github.com/raul)
 
@@ -160,4 +209,8 @@ Thanks to:
 There are other two projects for translating routes in Rails (which I know of), both of them are unfortunately unmaintained but you may want to check them out if you use Rails 2 or have different needs.
 
 * translate_routes (https://github.com/raul/translate_routes)
-* i18n_routing (https://github.com/kwi/i18n_routing)
+* i18n_routing (https://github.com/kwi/i18n_routing)
+
+== Other i18n related projects
+
+If you also need to translate models check out: https://github.com/francesc/rails-translate-models

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/rails-translate-routes.rb

@@ -1,10 +1,9 @@
 # coding: UTF-8
 
-# This class knows nothing
-# about Rails.root or Rails.application.routes, and therefor is easier to
-# test without an Rails App.
+# This class knows nothing about Rails.root or Rails.application.routes,
+# and therefore is easier to test without a Rails app.
 class RailsTranslateRoutes
-  TRANSLATABLE_SEGMENT = /^(\w+)(\()?/.freeze
+  TRANSLATABLE_SEGMENT = /^([\w-]+)(\()?/.freeze
   LOCALE_PARAM_KEY = :locale.freeze
   ROUTE_HELPER_CONTAINER = [
     ActionController::Base,
@@ -45,6 +44,14 @@ class RailsTranslateRoutes
     @prefix_on_default_locale = locale.to_s
   end
 
+  def no_prefixes
+    @no_prefixes ||= false
+  end
+
+  def no_prefixes= no_prefixes
+    @no_prefixes = no_prefixes
+  end
+
   class << self
     # Default locale suffix generator
     def locale_suffix locale
@@ -228,7 +235,9 @@ class RailsTranslateRoutes
 
     # Add prefix for all non-default locales
     def add_prefix? locale
-      if !default_locale?(locale) || @prefix_on_default_locale
+      if @no_prefixes
+        false
+      elsif !default_locale?(locale) || @prefix_on_default_locale
         true
       else
         false
@@ -247,7 +256,7 @@ class RailsTranslateRoutes
     end
 
     # Tries to translate a single path segment. If the path segment
-    # contains sth. like a optional format "people(.:format)", only
+    # contains sth. like an 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
@@ -256,7 +265,7 @@ class RailsTranslateRoutes
 
       match = TRANSLATABLE_SEGMENT.match(segment)[1] rescue nil
 
-      (translate_string(match, locale) || segment).downcase
+      (translate_string(match, locale) || segment)
     end
 
     def translate_string str, locale
@@ -287,7 +296,7 @@ class RailsTranslateRoutes
   end
 end
 
-# Adapter for Rails 3 Apps
+# Adapter for Rails 3 apps
 module ActionDispatch
   module Routing
     module Translator
@@ -300,6 +309,7 @@ module ActionDispatch
           file_path = %w(config locales routes.yml) if file_path.blank?
           r = RailsTranslateRoutes.init_from_file(File.join(Rails.root, file_path))
           r.prefix_on_default_locale = true if options && options[:prefix_on_default_locale] == true
+          r.no_prefixes = true if options && options[:no_prefixes] == true
           r.translate Rails.application.routes
         end
 
@@ -329,4 +339,4 @@ RailsTranslateRoutes::ROUTE_HELPER_CONTAINER.each do |klass|
       RailsTranslateRoutes.locale_suffix locale
     end
   end
-end
+end

data/rails-translate-routes.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "rails-translate-routes"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Francesc Pla"]
-  s.date = "2012-01-04"
+  s.date = "2012-01-19"
   s.description = "Simple gem to translate routes in Rails 3.x based on translate_routes"
   s.email = "francesc@francesc.net"
   s.extra_rdoc_files = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails-translate-routes
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-04 00:00:00.000000000 Z
+date: 2012-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70118983572120 !ruby/object:Gem::Requirement
+  requirement: &70239182665940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70118983572120
+  version_requirements: *70239182665940
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70118983571560 !ruby/object:Gem::Requirement
+  requirement: &70239182665160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *70118983571560
+  version_requirements: *70239182665160
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70118983570720 !ruby/object:Gem::Requirement
+  requirement: &70239182664360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *70118983570720
+  version_requirements: *70239182664360
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70118983570020 !ruby/object:Gem::Requirement
+  requirement: &70239182663440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70118983570020
+  version_requirements: *70239182663440
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70118983592020 !ruby/object:Gem::Requirement
+  requirement: &70239182662480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70118983592020
+  version_requirements: *70239182662480
 description: Simple gem to translate routes in Rails 3.x based on translate_routes
 email: francesc@francesc.net
 executables: []
@@ -100,7 +100,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1794154583192669933
+      hash: 2656952746989576753
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: