r18n-rails 0.4

data/LICENSE

@@ -0,0 +1,166 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.
+

data/README.rdoc

@@ -0,0 +1,223 @@
+= R18n for Rails
+
+R18n-rails is a gem to add out-of-box R18n support to Rails I18n.
+
+It is just a wrapper for R18n Rails API and R18n core libraries. See R18n core
+documentation for more information.
+
+== Features
+
+R18n for Rails has full compatibility with Rails I18n, but add extra features:
+
+=== R18n Syntax
+
+You can use more compact, explicit and ruby-style syntax.
+
+Translations in R18n format will be loaded from <tt>app/i18n/_locale_.yml</tt>:
+
+  user:
+    name: User name is %1
+    count: !!pl
+      0: No users
+      1: 1 user
+      n: %1 users
+
+R18n extend +t+ helper to add optional R18n syntax:
+
+  t.user.name('John')      #=> "User name is John"
+  t.user.count(5)          #=> "5 users"
+  t.not.exists | 'default' #=> "default"
+
+=== Filters
+
+R18n has flexible architecture based on filters. Variables, pluralization,
+untranslated are a common filters, and you can change all of them. For example,
+write untranslated keys to file:
+
+  R18n::Filters.add(::R18n::Untranslated, :write_untranslated) do
+  |v, c, translated, untranslated, path|
+    File.open('untranslated.list', 'w') do |io|
+      io.puts(path)
+    end
+  end
+
+R18n already has filters for HTML escaping, lambdas, Textile and Markdown:
+
+  hi: !!markdown
+    **Hi**, people!
+  greater: !!escape
+    1 < 2 is true
+
+  i18n.hi      #=> "<p><strong>Hi</strong>, people!</p>"
+  i18n.greater #=> "1 &lt; 2 is true"
+
+=== Model Translation
+
+R18n can add i18n support for your ActiveRecord model and any other class:
+
+1. Add separated column for all supported translations:
+   
+     def self.up
+       create_table :posts do |t|
+         t.string :title_en
+         t.string :title_ru
+       end
+     end
+   
+2. Add virtual method +title+, which will use <tt>title_<i>locale</i></tt>
+   methods to find actual translation:
+   
+     class Post < ActiveRecord::Base
+       include R18n::Translated
+       translations :title
+     end
+     
+     # For Russian user
+     post = Post.new
+     post.title_en = 'Post'
+     post.title_ru = 'Запись'
+     post.title = 'Запись'
+     
+     post.title = 'Другая' # will user title_ru, by user first locale
+
+=== Time Fomatters
+
+R18n add +full+ time formatter based on locale info:
+
+  # English
+  l Time.now, :full #=> "1st of December, 2009 12:00"
+  
+  # French
+  l Time.now, :full #=> "1er décembre 2009 12:00"
+
+=== Locales
+
+R18n contain locales info, so it out-of-box support locale plural and fallback
+rules for non-English locales:
+
+  # Russian have different plural rules:
+  user:
+    count: !!pl
+      0: Нет пользователей
+      1: %1 пользователь
+      2: %1 пользователя
+      n: %1 пользователей
+  
+  t.user.count(2)  #=> "2 пользователя"
+  t.user.count(21) #=> "21 пользователь"
+
+=== Autodetect User Locales
+
+R18n automatically generate fallback for current user, based on
+user locales list from HTTP_ACCEPT_LANGUAGE, locale info (in some country people
+know several languages) and default locale.
+
+For example, if user know Kazakh and German, R18n will try find translations in:
+Kazakh → German → Russian (second language in Kazakhstan) → English (default
+locale).
+
+=== Separated I18n
+
+You can create another R18n I18n instance with another languages. For example,
+to send e-mail for English admin on error with French user:
+
+  puts I18n.t :error # Show error on French
+  
+  admin_i18n = R18n::I18n.new(@admin_locales, Rails.root + 'app/i18n')
+  send_email(admin_i18n.error_messages)
+
+== How To
+
+1. Add <tt>r18n-rails</tt> gem to your <tt>config/environment.rb</tt>:
+   
+     config.gem 'r18n-rails'
+   
+   Now R18n will be autodetect user locales.
+2. Add your way to set locale manually. R18n will find it in
+   <tt>params[:locale]</tt> or <tt>session[:locale]</tt>. Best way is a put
+   optional locale prefix to URLs:
+   
+       map.connect ':controller/:action'
+       map.connect ':locale/:controller/:action'
+   
+3. Print available translations, to choise it manually (and to search engines):
+
+     <ul>
+     <% r18n.available_locales.each do |locale| %>
+         <li>
+           <a href="/<%= locale.code %>/"><%= locale.title %></a>
+         </li>
+     <% end %>
+     </ul>
+   
+4. Translations with I18n format put to <tt>config/locales/_locale_.yml</tt>:
+   
+     en:
+       user:
+         name: "User name is {{name}}"
+         count:
+           zero: "No users"
+           one:  "One user"
+           many: "{{count}} users"
+   
+   Translations with R18n format put to <tt>app/i18n/_locale_.yml</tt>:
+   
+     user:
+       name: User name is %1
+       count: !!pl
+         0: No users
+         1: 1 user
+         n: %1 users
+   
+5. Use translated messages in views. You can use Rails I18n syntax:
+   
+     t 'user.name', :name => 'John'
+     t 'user.count', :count => 5
+   
+   Or R18n syntax:
+   
+     t.user.name(:name => 'John') # for Rails I18n named variables
+     t.user.name('John')          # for R18n variables
+     t.user.count(5)
+   
+6. Print dates and numbers in user tradition:
+   
+     l Date.today, :standard #=> "20/12/2009"
+     l Time.now,   :full     #=> "20th of December, 2009 12:00"
+     l 1234.5                #=> "1,234.5"
+
+7. Translate models:
+   
+   1. Add to migration columns for each supported locales, with name
+      <tt><i>name</i>_<i>locale</i></tt>:
+      
+         t.string :title_en
+         t.string :title_ru
+         
+         t.string :text_en
+         t.string :text_ru
+      
+   2. Add <tt>R18n::Translated</tt> mixin to model:
+      
+        class Post < ActiveRecord::Base
+          include R18n::Translated
+      
+   3. Call +translations+ method in model with all columns to translated:
+      
+          translations :title, :text
+   
+      Now model will be have virtual methods +title+, +text+, <tt>title=</tt>
+      and <tt>text=</tt>, which will call +title_ru+ or +title_en+ and etc based
+      on current user locales.
+   
+   You can use <tt>R18n::Translated</tt> mixin for any Ruby class, not only for
+   ActiveRecord models.
+
+== License
+
+R18n is licensed under the GNU Lesser General Public License version 3.
+You can read it in LICENSE file or in http://www.gnu.org/licenses/lgpl.html.
+
+== Author
+
+Andrey “A.I.” Sitnik <andrey@sitnik.ru>

data/lib/r18n-rails.rb

@@ -0,0 +1,37 @@
+=begin
+R18n support for Rails.
+
+Copyright (C) 2009 Andrey “A.I.” Sitnik <andrey@sitnik.ru>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+require 'pathname'
+require 'r18n-core'
+require 'r18n-core/translated'
+require 'r18n-rails-api'
+
+dir = Pathname(__FILE__).dirname.expand_path + 'r18n-rails'
+require dir + 'helpers'
+require dir + 'controller'
+
+R18n::Filters.off(:untranslated)
+R18n::Filters.add(::R18n::Untranslated, :untranslated_html) do
+|v, c, translated, untranslated, path|
+  "#{translated}<span style='color: red'>#{untranslated}</span>"
+end
+
+ActionController::Base.helper(R18n::Rails::Helpers)
+ActionController::Base.send(:include, R18n::Rails::Controller)
+ActionController::Base.send(:before_filter, :set_r18n)

data/lib/r18n-rails/controller.rb

@@ -0,0 +1,52 @@
+=begin
+Methods and filters to controllers.
+
+Copyright (C) 2009 Andrey “A.I.” Sitnik <andrey@sitnik.ru>
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+=end
+
+require 'r18n-rails-api'
+
+module R18n
+  module Rails
+    module Controller
+      private
+      
+      # Return current R18n instance.
+      def r18n
+        R18n.get
+      end
+      
+      # Auto detect user locales and change backend.
+      def set_r18n
+        R18n.set do
+          locales = R18n::I18n.parse_http(request.env['HTTP_ACCEPT_LANGUAGE'])
+          
+          if params[:locale]
+            locales.insert(0, params[:locale])
+          elsif session[:locale]
+            locales.insert(0, session[:locale])
+          end
+          
+          places = [::Rails.root.join('app/i18n'), R18n::Loader::Rails.new]
+          
+          R18n::I18n.new(locales, places)
+        end
+      
+        ::I18n.backend = R18n::Backend.new
+      end
+    end
+  end
+end