.gitignore
@@ -1,3 +1,6 @@
+-- 0.96 (Jun 10th 2008)
+ * Added update_yaml task, suggested by Francesc Esplugas
+
-- 0.95 (Jan 21st 2008)
* Still beta version
* Added yaml files support for dictionaries
ChangeLog
@@ -83,7 +83,13 @@ We can see that resource controllers and actions are translated as well:
new_person_es GET /es/gente/crear {:lang=>"es", :controller=>"people", :action=>"new"}
new_person GET /people/new {:lang=>"en", :controller=>"people", :action=>"new"}
-We can get rid of that verbose translation hashes by using yaml files. Create a file inside your <tt>/config</tt> directory, called <tt>routes_es.yml</tt> and fill it with your desired translations, e.g:
+We can get rid of that verbose translation hashes by using yaml files, which can be generated/updated with the <tt>translate_routes:update_yaml</tt> rake task.
+Let's create a spanish and french translation files with <tt>translate_routes:update_yaml["es fr"]</tt>
+
+If it's the first time that we run the task, the files will contain a yaml skeleton with the strings to translate.
+If we already have translated some strings they will remain on the file after executing the task, so you can run it after any <tt>routes.rb</tt> edition.
+
+We can now translate the strings for any language
# /config/routes_es.yml
person: persona
README.rdoc
@@ -0,0 +1,3 @@
+edit:
+new:
+users:
SampleApp/config/routes_en.yml
@@ -1,4 +1,3 @@
edit: editar
new: crear
users: usuarios
-show: mostrar
\ No newline at end of file
SampleApp/config/routes_es.yml
@@ -15,6 +15,8 @@ module ActionController
mattr_accessor :lang_param_key
@@lang_param_key = :lang # e.g: :lang generates params[:lang] and @lang controller variable
+ mattr_accessor :original_routes
+
def self.translate
dictionaries = Hash.new
yield dictionaries
@@ -34,11 +36,22 @@ module ActionController
Translator.translate_current_routes dictionaries
end
+ def self.original_static_segments
+ static_segments = []
+ (@@original_routes || Routes.routes).each do |r|
+ r.segments.select do |s|
+ static_segments << s.value if s.instance_of?(ActionController::Routing::StaticSegment)
+ end
+ end
+ static_segments.uniq.sort
+ end
+
private
def self.translate_current_routes(dictionaries)
# reset routes
+ @@original_routes ||= Routes.routes.dup
old_routes = Routes.routes.dup # Array [routeA, routeB, ...]
old_names = Routes.named_routes.routes.dup # Hash {:name => :route}
Routes.clear!
@@ -51,11 +64,11 @@ module ActionController
old_routes.each do |old_route|
old_name = old_names.index(old_route)
-
+
# process and add the translated ones
trans_routes, trans_named_routes = translate_route(old_route, dictionaries, old_name)
new_routes.concat(trans_routes)
-
+
# process the old route:
new_old_route = clone_with_deeply_copied_static_segments(old_route) # we need a fresh route to apply requirements
@@ -63,10 +76,10 @@ module ActionController
add_language_requirements(new_old_route, default_lang)
add_language_segment(new_old_route, default_lang) if prefix_on_default_lang
new_routes << new_old_route
-
+
# if it's a named one we append the lang suffix and replace the old helper by a language-based call
if old_name
-
+
trans_named_routes["#{old_name}_#{default_lang}"] = new_old_route
trans_named_routes[old_name] = new_old_route # keep the old name to use the helper on integration tests
@@ -83,19 +96,19 @@ module ActionController
end
end
DEF_NEW_HELPER
-
+
[ActionController::Base, ActionView::Base].each { |d| d.module_eval(def_new_helper) }
ActionController::Routing::Routes.named_routes.helpers << new_helper_name.to_sym
end
end
-
- end
+ end
+
# apply all new routes
Routes.routes = new_routes
new_named_routes.each { |name, r| Routes.named_routes.add name, r }
-
+
end
def self.clone_with_deeply_copied_static_segments(route)
SampleApp/vendor/plugins/translate_routes/lib/translate_routes.rb
@@ -1,4 +1,42 @@
-# desc "Explaining what the task does"
-# task :translate_routes do
-# # Task goes here
-# end
+config_path = File.expand_path(File.join(RAILS_ROOT, 'config'))
+require File.join(config_path, 'environment')
+
+namespace :translate_routes do
+
+ desc "Updates yaml translation files for the given languages"
+ task :update_yaml, :langs do |task, args|
+
+ segments = ActionController::Routing::Translator.original_static_segments
+
+ if args[:langs].is_a?(String)
+ langs = args[:langs] + ' ' + ActionController::Routing::Translator.default_lang
+ langs.split.each do |lang|
+
+ file_path = File.join(config_path, "routes_#{lang}.yml");
+
+ if File.exists?(file_path)
+ puts "Updating #{file_path}"
+ translations = YAML.load_file(file_path)
+ f = File.open(file_path,'w')
+ else
+ puts "Creating #{file_path}"
+ translations = {}
+ f = File.new(file_path, 'w')
+ end
+
+ segments.each do |s|
+ translation = translations[s] rescue ''
+ f.write "#{s}: #{translation}\n"
+ end
+ f.close
+
+ end
+
+ else
+ puts 'Missing parameters, usage example: rake translate_routes:update_yaml["fr de es"]'
+ end
+
+ end
+
+end
+
SampleApp/vendor/plugins/translate_routes/tasks/translate_routes_tasks.rake
@@ -1 +1 @@
-Fri, 06 Jun 2008 16:34:03 +0200
+Tue, 10 Jun 2008 09:26:35 +0200
doc/created.rid
@@ -56,7 +56,7 @@
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
- <td>Fri Jun 06 16:25:58 +0200 2008</td>
+ <td>Tue Jun 10 09:26:30 +0200 2008</td>
</tr>
</table>
</div>
@@ -208,9 +208,20 @@ We can see that resource controllers and actions are translated as well:
new_person GET /people/new {:lang=>"en", :controller=>"people", :action=>"new"}
</pre>
<p>
-We can get rid of that verbose translation hashes by using yaml files.
-Create a file inside your <tt>/config</tt> directory, called
-<tt>routes_es.yml</tt> and fill it with your desired translations, e.g:
+We can get rid of that verbose translation hashes by using yaml files,
+which can be generated/updated with the
+<tt>translate_routes:update_yaml</tt> rake task. Let‘s create a
+spanish and french translation files with
+<tt>translate_routes:update_yaml["es fr"]</tt>
+</p>
+<p>
+If it‘s the first time that we run the task, the files will contain a
+yaml skeleton with the strings to translate. If we already have translated
+some strings they will remain on the file after executing the task, so you
+can run it after any <tt>routes.rb</tt> edition.
+</p>
+<p>
+We can now translate the strings for any language
</p>
<pre>
# /config/routes_es.yml
doc/files/README_rdoc.html
@@ -15,6 +15,8 @@ module ActionController
mattr_accessor :lang_param_key
@@lang_param_key = :lang # e.g: :lang generates params[:lang] and @lang controller variable
+ mattr_accessor :original_routes
+
def self.translate
dictionaries = Hash.new
yield dictionaries
@@ -34,11 +36,22 @@ module ActionController
Translator.translate_current_routes dictionaries
end
+ def self.original_static_segments
+ static_segments = []
+ (@@original_routes || Routes.routes).each do |r|
+ r.segments.select do |s|
+ static_segments << s.value if s.instance_of?(ActionController::Routing::StaticSegment)
+ end
+ end
+ static_segments.uniq.sort
+ end
+
private
def self.translate_current_routes(dictionaries)
# reset routes
+ @@original_routes ||= Routes.routes.dup
old_routes = Routes.routes.dup # Array [routeA, routeB, ...]
old_names = Routes.named_routes.routes.dup # Hash {:name => :route}
Routes.clear!
@@ -51,11 +64,11 @@ module ActionController
old_routes.each do |old_route|
old_name = old_names.index(old_route)
-
+
# process and add the translated ones
trans_routes, trans_named_routes = translate_route(old_route, dictionaries, old_name)
new_routes.concat(trans_routes)
-
+
# process the old route:
new_old_route = clone_with_deeply_copied_static_segments(old_route) # we need a fresh route to apply requirements
@@ -63,10 +76,10 @@ module ActionController
add_language_requirements(new_old_route, default_lang)
add_language_segment(new_old_route, default_lang) if prefix_on_default_lang
new_routes << new_old_route
-
+
# if it's a named one we append the lang suffix and replace the old helper by a language-based call
if old_name
-
+
trans_named_routes["#{old_name}_#{default_lang}"] = new_old_route
trans_named_routes[old_name] = new_old_route # keep the old name to use the helper on integration tests
@@ -83,19 +96,19 @@ module ActionController
end
end
DEF_NEW_HELPER
-
+
[ActionController::Base, ActionView::Base].each { |d| d.module_eval(def_new_helper) }
ActionController::Routing::Routes.named_routes.helpers << new_helper_name.to_sym
end
end
-
- end
+ end
+
# apply all new routes
Routes.routes = new_routes
new_named_routes.each { |name, r| Routes.named_routes.add name, r }
-
+
end
def self.clone_with_deeply_copied_static_segments(route)
lib/translate_routes.rb
@@ -1,4 +1,42 @@
-# desc "Explaining what the task does"
-# task :translate_routes do
-# # Task goes here
-# end
+config_path = File.expand_path(File.join(RAILS_ROOT, 'config'))
+require File.join(config_path, 'environment')
+
+namespace :translate_routes do
+
+ desc "Updates yaml translation files for the given languages"
+ task :update_yaml, :langs do |task, args|
+
+ segments = ActionController::Routing::Translator.original_static_segments
+
+ if args[:langs].is_a?(String)
+ langs = args[:langs] + ' ' + ActionController::Routing::Translator.default_lang
+ langs.split.each do |lang|
+
+ file_path = File.join(config_path, "routes_#{lang}.yml");
+
+ if File.exists?(file_path)
+ puts "Updating #{file_path}"
+ translations = YAML.load_file(file_path)
+ f = File.open(file_path,'w')
+ else
+ puts "Creating #{file_path}"
+ translations = {}
+ f = File.new(file_path, 'w')
+ end
+
+ segments.each do |s|
+ translation = translations[s] rescue ''
+ f.write "#{s}: #{translation}\n"
+ end
+ f.close
+
+ end
+
+ else
+ puts 'Missing parameters, usage example: rake translate_routes:update_yaml["fr de es"]'
+ end
+
+ end
+
+end
+
tasks/translate_routes_tasks.rake
doc/files/README.html
ba1fb1d5af0c9ec21133edc7872d7daefd882080
Raul Murciano
raul@murciano.net
http://github.com/raul/translate_routes/commit/1b62e9ac918dfeb150058ad4155eaf156e44956b
1b62e9ac918dfeb150058ad4155eaf156e44956b
2008-06-10T00:38:39-07:00
2008-06-10T00:38:39-07:00
Added update_yaml task to create/update yaml files, suggested by Francesc Esplugas
Added .gitignore
0369d0c282392c6067a838bb439d5ea43b416b84
Raul Murciano
raul@murciano.net