locale_rails 0.1.0

data/lib/locale_rails/action_view.rb

@@ -0,0 +1,43 @@
+=begin
+  locale_rails/lib/action_view.rb - Ruby/Locale for "Ruby on Rails"
+
+  Copyright (C) 2008  Masao Mutoh
+
+  You may redistribute it and/or modify it under the same
+  license terms as Ruby.
+
+  Original: Ruby-GetText-Package-1.92.0
+
+  $Id: action_view.rb 23 2008-11-24 09:22:35Z mutoh $
+=end
+
+require 'action_view'
+
+module ActionView #:nodoc:
+  class Base
+    def _pick_template_with_locale_main(template_path, tags)
+      path = template_path.sub(/^\//, '')
+      if m = path.match(/(.*)\.(\w+)$/)
+        template_file_name, template_file_extension = m[1], m[2]
+      else
+        template_file_name = path
+      end
+ 
+      tags.each do |v|
+        file_name = "#{template_file_name}_#{v}"
+	begin
+          return _pick_template_without_locale(file_name)
+        rescue MissingTemplate => e
+	end
+      end
+      _pick_template_without_locale(template_path)
+    end
+    memoize :_pick_template_with_locale_main
+
+    def _pick_template_with_locale(template_path) #: shouldn't memoize.
+      _pick_template_with_locale_main(template_path, I18n.candidates)
+    end
+    alias_method_chain :_pick_template, :locale
+  end
+end
+

data/lib/locale_rails/i18n.rb

@@ -0,0 +1,56 @@
+=begin
+  locale_rails/lib/i18n.rb - Ruby/Locale for "Ruby on Rails"
+
+  Copyright (C) 2008  Masao Mutoh
+
+  You may redistribute it and/or modify it under the same
+  license terms as Ruby.
+
+  $Id: i18n.rb 25 2008-11-30 15:44:24Z mutoh $
+=end
+
+module I18n
+  @@supported_locales = nil
+  module_function
+
+  # Gets the supported locales.
+  def supported_locales 
+    @@supported_locales
+  end
+
+  # Sets the supported locales as an Array.
+  #  I18n.supported_locales = ["ja-JP", "ko-KR"]
+  def supported_locales=(tags)
+    @@supported_locales = tags
+  end
+
+  # Sets the locale.
+  #  I18n.locale = "ja-JP"
+  def locale=(tag)
+    Locale.clear
+    Locale.current = tag
+    Thread.current[:locale] = candidates(:rfc)[0]
+  end
+  
+  # Get the locale candidates as a Locale::TagList.
+  # This is the utility function which calls Locale.candidates with
+  # supported_language_tags.
+  #
+  # I18n.locale is also overrided by Ruby-Locale and it returns 
+  # the result of this method with :rfc option.
+  # 
+  # +type+ :simple, :common(default), :rfc, :cldr.
+  # 
+  # This is used by Rails application, but it may be better not to
+  # use this method in Rails plugins/libraries, because they have their
+  # own supported languages. 
+  def candidates(type = :common)
+    default = [I18n.default_locale.to_s]
+    default = ["en-US", "en"] if default[0] == "en-US"
+    Locale.candidates(:type => type, 
+                      :supported_language_tags => supported_locales,
+                      :default_language_tags => default)
+  end
+
+end
+

data/lib/locale_rails/version.rb

@@ -0,0 +1,4 @@
+module Locale
+  SUPPORTED_RAILS_VERSION = "2.2.0"
+  LOCALE_RAILS_VERSION = "0.1.0"
+end

data/sample/README

@@ -0,0 +1,22 @@
+== Ruby-Locale for Ruby on Rails sample application
+This is the sample application for localization.
+
+=== Includes
+1. How to get current language.
+2. Auto-Detect the locale from the WWW browser
+3. Set locale as the "lang" parameter
+4. Set "lang" as the cookie value
+5. Localized Routes
+6. Action caching
+7. Separate Localized View template file
+
+== Installation
+
+1. Instal rails-2.2.x.
+2. Install sqlite3-ruby
+   gem install sqlite3-ruby
+3. Install locale_rails
+   gem install locale_rails
+4. rake db:create 
+5. ruby script/server
+6. Access http://localhost:3000/ from the WWW browser.

data/sample/Rakefile

@@ -0,0 +1,10 @@
+# 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.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'

data/sample/app/controllers/application.rb

@@ -0,0 +1,41 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+
+  # See ActionController::RequestForgeryProtection for details
+  # Uncomment the :secret if you're not using the cookie session store
+  protect_from_forgery # :secret => '639df270d82028344f5a50f543530c57'
+  
+  # See ActionController::Base for details 
+  # Uncomment this to filter the contents of submitted sensitive data parameters
+  # from your application log (in this case, all fields with names like "password"). 
+  # filter_parameter_logging :password
+
+  # Set the charset of Content-Type.
+  # This is not Ruby-Locale method but useful.
+#  self.default_charset = "iso8859-1"
+
+=begin
+  def before_init_i18n
+    # Initialize other i18n libraries before init_locale if you need.
+    # Or set "lang" to it's own value before initializing Locale.
+    if (cookies["lang"].nil? or cookies["lang"].empty?)
+      params["lang"] = "ko_KR"
+    end
+  end
+  before_init_locale :before_init_i18n
+
+  def after_init_i18n
+    # Initialize other i18n libraries after init_locale if you need.
+    #
+    # LocalizeFoo.locale = Locale.current
+    # I18n.locale is set in init_locale, but other I18n features
+    # is not set by Ruby-Locale. So you may need to add the code to work your
+    # Rails i18n plugins.
+  end
+  after_init_locale :after_init_i18n
+=end
+
+end

data/sample/app/controllers/samples_controller.rb

@@ -0,0 +1,30 @@
+class SamplesController < ApplicationController
+  caches_action :cached_action
+
+  def index
+  end
+
+  def set_cookie
+    flash[:notice] = "Cookie lang value is: " + params[:id]
+
+    cookies["lang"] = params[:id]
+
+    respond_to do |format|
+      format.html { redirect_to :action => "index" }
+    end
+  end
+
+  def clear_cookie
+    cookies["lang"] = nil
+
+    flash[:notice] = "Cookie lang value is cleared. "
+    respond_to do |format|
+      format.html { redirect_to :action => "index" }
+    end
+  end
+
+  def cached_action
+    p "cached_action. This is shown first time only."
+  end
+end
+

data/sample/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/sample/app/views/layouts/samples.html.erb

@@ -0,0 +1,20 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+       "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="<%= Locale.current.to_rfc %>" lang="<%= Locale.current.to_rfc %>">
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=<%= Locale.charset %>" />
+  <title>Ruby-Locale Sample on Ruby on Rails: <%= controller.action_name %></title>
+  <%= stylesheet_link_tag 'scaffold' %>
+  <%= stylesheet_link_tag 'locale' %>
+</head>
+<body>
+ <p style="color: red"><%= flash[:notice] %></p>
+
+ <%= yield  %>
+
+ <div class="copyright">
+ Copyright (C) 2008 Masao Mutoh
+ </div>
+</body>
+</html>

data/sample/app/views/samples/#cookie.rb#

@@ -0,0 +1,3 @@
+<p>
+  
+</p>

data/sample/app/views/samples/_part.html.erb

@@ -0,0 +1,68 @@
+<%
+  app_lang_tags = ["ja_JP", "fr", "pt_BR", "zh_CN", "en_Latn_US_NYNORSK", "uz_UZ", "nl"]
+%>
+
+<h2>Get the current locale</h2>
+<h3>I18n.candidates(with no option)</h3>
+<p>Requested Locales order by the priority. This method is added by Ruby-Locale for Ruby on Rails.</p>
+<div class="result">
+<%=h I18n.candidates.inspect %>
+</div>
+
+<h3>I18n.locale (with inspect)</h3>
+<p>I18n.locale is set the result(Locale::TagList) of locale_candidates(:type => :rfc).<br/>
+This method is extended by Ruby-Locale for Ruby on Rails and returns all candidates as the Locale::TagList.
+</p>
+<div class="result">
+<%=h I18n.locale.inspect %>
+</div>
+
+<h3>I18n.locale (without inspect)</h3>
+<p>Locale::TagList(the result of I18n.locale) can behave like a single tag string to follow I18n.locale specification.</p>
+<div class="result">
+<%=h I18n.locale %>
+</div>
+
+<h2>Auto-Detect the locale from the WWW browser</h2>
+<p><a href="<%= samples_path %>">Reload this URL</a></p>
+
+<h2>Set locale as the "lang" parameter</h2>
+
+<ol>
+<% (app_lang_tags - ["uz_UZ", "nl"]).each do |lang|
+     url = samples_path(:lang => lang) %>
+    <li><%= link_to h(url), url %> [<%= lang %>]</li>
+<% end %>
+</ol>
+
+<h2>Set "lang" as the cookie value.</h2>
+<p>Click one of the link below, and then click "Auto-Detect the locale from the WWW browser".</p>
+
+<ol>
+<% (app_lang_tags - ["uz_UZ", "nl"]).each do |lang|
+     url = url_for(:controller => :samples, :action => :set_cookie, :id => lang) %>
+    <li><%= link_to h(url), {:action => :set_cookie, :id => lang} %> [<%= lang %>]</li>
+<% end %>
+    <li><%= link_to "Clear cookie", :action => :clear_cookie %> </li>
+</ol>
+
+<h2>Localized Routes</h2>
+<p>See config/routes.rb</p>
+
+<ol>
+<% (app_lang_tags - ["uz_UZ", "nl"]).each do |lang|
+     url = url_for(:controller => :samples, :lang => lang, :action => :index) %>
+   <li><%= link_to h(url),:controller => :samples, :lang => lang, :action => :index %> [<%= lang %>]</li>
+<% end %>
+</ol>
+
+<h2>Caching</h2>
+<p>Fragment/Action caching is supported. Here is the sample for action caching. <br/>
+Click the links then check %{RAILS_ROOT}/tmp/cache/ where Cached file is stored.
+</p>
+<ol>
+<% (app_lang_tags - ["uz_UZ", "nl"]).each do |lang|
+     url = url_for(:controller => :samples, :action => :cached_action, :lang => lang) %>
+    <li><%= link_to h(url), {:controller => :samples, :action => :cached_action, :lang => lang} %> [<%= lang %>]</li>
+<% end %>
+</ol>

data/sample/app/views/samples/_part_nl.html.erb

@@ -0,0 +1,2 @@
+<p style="color:red">This page is for nl only. See app/views/samples/_part_nl.html.erb.</p>
+<p><%= link_to "[BACK]", samples_path %></p>

data/sample/app/views/samples/cached_action.html.erb

@@ -0,0 +1,6 @@
+<h1>Ruby-Locale and Ruby on Rails 2.2 sample</h1>
+<p><a href ="http://locale.rubyforge.org/svn/trunk/locale_rails/sample">[source code]</a></p>
+
+<p style="color:red">This page is cached for [<%= I18n.locale %>]. <br/>
+See %{RAILS_ROOT}/tmp/cache/*.</p>
+<p><%= link_to "[BACK]", samples_path %></p>

data/sample/app/views/samples/index.html.erb

@@ -0,0 +1,24 @@
+<h1>Ruby-Locale and Ruby on Rails 2.2 sample</h1>
+<p><a href ="http://locale.rubyforge.org/svn/trunk/locale_rails/sample">[source code]</a></p>
+
+<h2>The values from Rails</h2>
+<table border="1" cellspacing="0" cellpadding="2">
+  <tr><th>Variables</th><th>Values</th></tr>
+  <tr><td>HTTP_ACCEPT_LANGUAGE</td><td> <%= request.cgi.accept_language %></td></tr>
+  <tr><td>HTTP_ACCEPT_CHARSET</td><td> <%= request.cgi.accept_charset %></td></tr>
+  <tr><td>QUERY_STRING</td><td> <%= request.cgi.query_string %></td></tr>
+  <tr><td>params[:lang]</td><td><%= params[:lang] %></td></tr>
+  <tr><td>cookies[:lang]</td><td> <%= cookies[:lang] %></td></tr>
+</table>
+
+<%= render :partial => 'part' %>
+
+<h2>Separate Localized View template file in each languages</h2>
+<p>View template can be separeted with language tags.</p> 
+<ol>
+  <li><%= link_to "uz_UZ has special index page(index_uz_UZ.html.erb)", :controller => :samples, :action => :index, :lang => "uz_UZ" %></li>
+  <li><%= link_to "uz uses normal index page", :controller => :samples, :action => :index, :lang => "uz" %></li>
+  <li><%= link_to "nl has special _part page(_part_nl.html.erb)", :controller => :samples, :action => :index, :lang => "nl" %></li>
+  <li><%= link_to "nl_BE also uses the special _part page(_part_nl.html.erb)", :controller => :samples, :action => :index, :lang => "nl_BE" %></li>
+</ol>
+

data/sample/app/views/samples/index_uz_UZ.html.erb

@@ -0,0 +1,15 @@
+<h1>Ruby-Locale and Ruby on Rails 2.2 sample</h1>
+<p><a href ="http://locale.rubyforge.org/svn/trunk/locale_rails/sample">[source code]</a></p>
+
+<h2>The values from Rails</h2>
+<table border="1" cellspacing="0" cellpadding="2">
+  <tr><th>Variables</th><th>Values</th></tr>
+  <tr><td>HTTP_ACCEPT_LANGUAGE</td><td> <%= request.cgi.accept_language %></td></tr>
+  <tr><td>HTTP_ACCEPT_CHARSET</td><td> <%= request.cgi.accept_charset %></td></tr>
+  <tr><td>QUERY_STRING</td><td> <%= request.cgi.query_string %></td></tr>
+  <tr><td>params[:lang]</td><td><%= params[:lang] %></td></tr>
+  <tr><td>cookies[:lang]</td><td> <%= cookies[:lang] %></td></tr>
+</table>
+
+<p style="color:red">This page is for uz_UZ only. See app/views/samples/index_uz_UZ.html.erb.</p>
+<p><%= link_to "[BACK]", samples_path %></p>

data/sample/config/boot.rb

@@ -0,0 +1,109 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion if defined? Gem::RubyGemsVersion
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.1.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!