rubi18n 0.3

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

@@ -0,0 +1,177 @@
+= Rubi18n
+
+Rubi18n is a i18n tool to translate your Ruby application in several languages.
+
+== Features
+
+* If there isn’t translation in user locale, it will be found in locales, which
+  user may know (not only in default locale). For example, many people in 
+  Belarus can understand Russian, and locale has information about it.
+* It can localize your application: format numbers to the rules of the user 
+  locale, translate month and week days name and give other locale information.
+* It has translation for commons words, like “OK”, “Cancel”, etc.
+* It storage translation in rich YAML format. You can put procedures and
+  pluralization (“1 comment”, “5 comments”) in your translation.
+
+== How to
+1. Add rubi18n to your application (and rubygems if you didn't do it):
+   
+     require "rubygems"
+     require "rubi18n"
+   
+2. Create translations dir. For exmaple: <tt>_YOUR_APP_/translations/</tt>.
+3. Add file with translation in some language. For example: 
+   <tt>_YOUR_APP_/translations/en.yml</tt>
+   
+     post:
+       add: Add post
+       delete: Delete post %1
+    
+     comments: !!pl
+       0: No comments
+       1: One comment
+       n: %1 comments
+     
+     author: !!proc |name| "This article was written by #{name.capitalize}"
+4. Put auto detection user locale and loading translations:
+   
+     Rubi18n::Locale.current = ENV["LANG"]
+     i18n = Rubi18n::Translation.load(ENV["LANG"], "YOUR_APP/translations/")
+   
+5. Print translation string to user:
+   
+     i18n.post.add                        #=> "Add post"
+     i18n.post.delete("Test")             #=> "Delete post Test"
+     i18n.strftime(post.created_at, "%B") #=> "September"
+     i18n.comments(1)                     #=> "6 comments"
+     i18n.comments(12)                    #=> "12 comments"
+     i18n.author("poet")                  #=> "This article was written by Poet"
+
+== Usage
+
+=== Locale
+All supported locales are storage in Rubi18n gem at +locales+ dir. If you want
+to add your locale, please write me to andrey@sitnik.ru .
+
+To get information about locale create Rubi18n::Locale instance:
+
+  en = Rubi18n::Locale.new("en")
+
+To get first available user locale use Rubi18n::Locale.find methods. It will be
+looking also general language locale for dialect (if Canadian French (+fr_CA+)
+willn't be available it return French (+fr+) locale).
+
+  locale = Rubi18n::Locale.new(locales_array)
+  
+You can get from locale:
+* Locale title and RFC 3066 code:
+  
+    locale["title"] #=> "English"
+    locale["code"] #=> "en"
+  
+* Language direction (left to right, or right to left for Arabic and Hebrew):
+  
+    locale["direction"] #=> "ltr"
+  
+* Week start day ("sunday" or "monday")
+  
+    locale["week_start"] #=> "sunday"
+
+=== Translation
+Translation files use YAML format and has name CODE.yml , where CODE is a
+language/country code (RFC 3066) like en_US. For example: en.yaml is a English 
+translation, en_US.yml is a translation to USA English dialect.
+
+In translation you can use:
+* Strings
+    robot: This is robot
+    percent: "Percent sign (%)"
+* Numbers
+    number: 123
+    float: 12.45
+* Pluralizable messages
+    robots: !!pl
+      0: No robots
+      1: One robot
+      n: %1 robots
+* Procedures
+    sum: !!proc |x, y| x + y
+
+To load translations use Rubi18n::Translation.load method with array with user 
+locales codes. It will load all user locales and sublocales, which people in 
+this locale offten understand.
+
+  i18n = Rubi18n::Translation.load(user_locales, DIR_WITH_TRANSLATIONS)
+
+To get translated string use method with key name or square brackets [] for
+keys, which contain Object methods (+class+, +inspect+, etc):
+
+  i18n.robot    #=> "This is robot"
+  i18n["robot"] #=> "This is robot"
+
+Translation may be hierarchical:
+
+  i18n.post.add       #=> "Add post"
+  i18n["post"]["add"] #=> "Add post"
+
+If locale willn’t be found in user locale Rubi18n will search it in another
+locale, which user know and they sublocales:
+
+  i18n.no.in.english #=> "В английском нет"
+
+Translated string has +locale+ method and you can get it locale (Locale instance
+or code string if locale is’t supported in Rubi18n):
+
+  i18n.no.in.english.locale #=> Locale ru (Русский)
+
+You can replace some parameters in translated string by put it as arguments:
+  
+  name: "My name is %1"
+
+  i18n.name("John") #=> "My name is John"
+
+Pluralizable messages get item count from first argument. Or from next if you
+pluralize several parameters (see spec/translation_spec.rb and 
+spec/translation/general/en.yml for samples).
+
+  i18n.robots(0)  #=> "No robots"
+  i18n.robots(1)  #=> "One robot"
+  i18n.robots(50) #=> "50 robots"
+
+If there isn’t pluralization for some number (for example, 0), translation will
+be use 'n'. If there isn’t locale file for translation for pluralization will be
+using default (English) rule.
+
+Rub18n already has translation for common words for most supported locales. 
+See <tt>base/</tt> in dir in gem.
+
+=== Formatters
+You can print number and float according to the rules of the locale by +to_ls+ 
+method:
+
+  12000.to_ls  #=> "12,000"
+  15.34.to_ls  #=> "15.34"
+
+Number and float formatters will also put real typographic minus and put
+non-break thin spaces (for locale, which use it as digit separator).
+
+To translate month and week day names use Rubi18n::Translation.strftime method:
+
+  i18n.strftime(Time.now, "%A", %d/%B")  #=> "Tuesday, 09 September"
+
+You can put format string to +strftime+ method in translation file to get
+locale specific time:
+
+translations/en.yml
+  published:
+    format: "%A", %d/%B"
+
+application.rb
+  i18n.strftime(Time.now, translation.published.format)
+
+== License
+Rubi18n 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/gpl.html.
+
+== Author
+Andrey “A.I.” Sitnik <andrey@sitnik.ru>

data/Rakefile

@@ -0,0 +1,95 @@
+require "rubygems"
+require "rake"
+require "rake/rdoctask"
+require "spec/rake/spectask"
+require "rake/gempackagetask"
+
+require File.join(File.dirname(__FILE__), "lib", "rubi18n")
+
+PKG_NAME = "rubi18n"
+PKG_VERSION = "0.3"
+
+##############################################################################
+# Tests
+##############################################################################
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new('specs') do |t|
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = Dir['spec/**/*_spec.rb'].sort
+end
+
+desc "Run a specific spec with TASK=xxxx"
+Spec::Rake::SpecTask.new('spec') do |t|
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.libs = ['lib']
+  t.spec_files = ["spec/**/#{ENV['TASK']}_spec.rb"]
+end
+
+desc "Run all specs output html"
+Spec::Rake::SpecTask.new('specs_html') do |t|
+  t.spec_opts = ["--format", "html"]
+  t.libs = ['lib']
+  t.spec_files = Dir['spec/**/*_spec.rb'].sort
+end
+
+desc "RCov"
+Spec::Rake::SpecTask.new('rcov') do |t|
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = Dir['spec/**/*_spec.rb'].sort
+  t.libs = ['lib']
+  t.rcov = true
+end
+
+##############################################################################
+# Documentation and distribution
+##############################################################################
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.main = "README"
+  rdoc.rdoc_files.include("README", "LICENSE", "lib/**/*.rb")
+  rdoc.title = "Rubi18n Documentation"
+  rdoc.rdoc_dir = "doc"
+  rdoc.options << "-c utf-8"
+  rdoc.options << "--all"
+end
+
+spec = Gem::Specification.new do |s|
+  s.platform = Gem::Platform::RUBY
+  s.name = PKG_NAME
+  s.version = PKG_VERSION
+  s.summary = "I18n tool to translate your Ruby application."
+  s.description = <<-EOF
+    Rubi18n is a i18n tool to translate your Ruby application.
+    It can localize your application, has translation for commons words,
+    storage translation in rich YAML format with pluralization and procedures
+    and has sublocales list for each supported locale.
+  EOF
+  
+  s.files = FileList[
+    "base/**/*",
+    "lib/**/*",
+    "locales/**/*",
+    "LICENSE",
+    "Rakefile",
+    "README"]
+  s.test_files = FileList[
+    "spec/**/*"]
+  s.require_path = 'lib'
+  s.has_rdoc = true
+  
+  s.author = 'Andrey "A.I." Sitnik'
+  s.email = "andrey@sitnik.ru"
+  s.homepage = "http://rubi18n.rubyforge.org/"
+  s.rubyforge_project = PKG_NAME
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install Rubi18n as a gem."
+task :install => [:package] do
+  sudo = RUBY_PLATFORM =~ /win32/ ? '' : 'sudo'
+  sh %{#{sudo} gem install pkg/#{PKG_NAME}-#{PKG_VERSION}}
+end

data/base/en.yml

@@ -0,0 +1,15 @@
+ok: OK
+save: Save
+canel: Cancel
+exit: Exit
+delete: Delete
+am: AM
+pm: PM
+
+months:
+  names: [January, February, March, April, May, June, July, August, September, October, November, December]
+  abbr_names: [Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec]
+
+week:
+  days: [Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday]
+  abbr_days: [Sun, Mon, Tue, Wed, Thu, Fri, Sat]

data/base/ru.yml

@@ -0,0 +1,13 @@
+ok: OK
+save: Сохранить
+canel: Отмена
+exit: Выход
+delete: Удалить
+
+months:
+  names: [Январь, Февраль, Март, Апрель, Май, Июнь, Июль, Август, Сентябрь, Октябрь, Ноябрь, Декабрь]
+  abbr_names: [Янв, Фев, Мар, Апр, Май, Июн, Июл, Авг, Сен, Окт, Ноя, Дек]
+  
+week:
+  days: [Воскресенье, Понедельник, Вторник, Среда, Четверг, Пятница, Суббота]
+  abbr_days: [Вск, Пнд, Втр, Срд, Чтв, Птн, Сбт]

data/lib/rubi18n/formatters.rb

@@ -0,0 +1,74 @@
+=begin
+Formatters to i18n support.
+
+Copyright (C) 2008 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
+
+module Rubi18n
+  module Formatters
+    module Integer
+      # Returns the integer in String form, according to the rules of the
+      # locale (default currently active). It will also put real typographic 
+      # minus.
+      def to_ls(locale = Rubi18n::Locale.current)
+        str = self.to_s
+        str[0] = "−" if 0 > self # Real typographic minus
+        group = locale["numbers"]["group_delimiter"]
+        
+        if "indian" == locale["numbers"]["separation"]
+          str.gsub(/(\d)(?=((\d\d\d)(?!\d))|((\d\d)+(\d\d\d)(?!\d)))/) do |match|
+            match + group
+          end
+        else
+          str.gsub(/(\d)(?=(\d\d\d)+(?!\d))/) do |match|
+            match + group
+          end
+        end
+      end
+    end
+    
+    module Float
+      # Returns the integer in String form, according to the rules of the
+      # locale (default currently active). It will also put real typographic 
+      # minus.
+      def to_ls(locale = Rubi18n::Locale.current)
+        int, frac = self.to_s.split('.')
+        int[0] = "−" if 0 > self # Real typographic minus
+        group = locale["numbers"]["group_delimiter"]
+        decimal = locale["numbers"]["decimal_separator"]
+        
+        if "indian" == locale["numbers"]["separation"]
+          int.gsub!(/(\d)(?=((\d\d\d)(?!\d))|((\d\d)+(\d\d\d)(?!\d)))/) do |match|
+            match + group
+          end
+        else
+          int.gsub!(/(\d)(?=(\d\d\d)+(?!\d))/) do |match|
+            match + group
+          end
+        end
+        int + decimal + frac
+      end
+    end
+  end
+end
+
+class Integer
+  include Rubi18n::Formatters::Integer
+end
+
+class Float
+  include Rubi18n::Formatters::Float
+end

data/lib/rubi18n/locale.rb

@@ -0,0 +1,124 @@
+=begin
+Locale to i18n support.
+
+Copyright (C) 2008 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 "yaml"
+
+module Rubi18n
+  # Information about locale (language, country and other special variant
+  # preferences). Locale was named by RFC 3066. For example locale for French 
+  # speaking people in Canada will be +fr_CA+. 
+  #
+  # Locale files is placed in <tt>rubi18n/locales/</tt> dir in YAML files.
+  #
+  # == Usage
+  #
+  # Set system locale to Russian
+  #   Rubi18n::Locale.current = "ru"
+  #
+  # Get locale for USA English and print it title
+  #   locale = Rubi18n::Locale.new("en_US")
+  #   puts locale["title"]
+  #
+  # Set locale to user system locale (in UNIX-like OS) and print it title
+  #   Rubi18n::Locale.current = ENV["LANG"]
+  #   puts "Your locale is #{Rubi18n::Locale.current['code']}"
+  #
+  # == Formatting
+  #
+  # You can print number and float according to the rules of the locale by
+  # +to_ls+ method. See Rubi18n::Formatters.
+  #
+  # For translate month and week day names in Time and Date see 
+  # <tt>Translation.strftime</tt> method.
+  class Locale
+    LOCALES_DIR = Pathname(__FILE__).dirname.expand_path + "../../locales/"
+
+    # Set system locale to use in +to_ls+ methods in another classes
+    def self.current=(locale)
+      if String == locale.class
+        locale = Locale.find(locale)
+      end
+      @@current = locale
+    end
+
+    # Return system locale
+    def self.current
+      @@current
+    end
+
+    # All available locales
+    def self.locales
+      Dir.glob(File.join(LOCALES_DIR, "*.yml")).map do |i|
+        File.basename(i, ".yml")
+      end
+    end
+    
+    # Is +locale+ has info file
+    def self.exists?(locale)
+      File.exists?(File.join(LOCALES_DIR, locale + ".yml"))
+    end
+
+    # Find and load first available locale from +locales+
+    def self.find(locales)
+      locales = locales.to_a if String == locales.class
+      
+      locales.each_with_index do |locale, i|
+        locale = locale[0..4] if locale.length > 5
+        locales.insert(i + 1, locale[0..1]) if locale.length > 2
+        return self.new(locale) if self.exists? locale
+      end
+    end
+
+    # Load locale by in +code+ (RFC 3066)
+    def initialize(code)
+      code.delete!("/", "\\")
+      
+      @locale = {}
+      while code
+        file = File.join(LOCALES_DIR, "#{code}.yml")
+        raise "Locale #{code} isn't exists" if not File.exists? file
+        loaded = YAML.load_file(file)
+        @locale = loaded.merge @locale
+        code = loaded["include"]
+      end
+      
+      eval("def pluralize(n); #{@locale["pluralization"]}; end", binding)
+    end
+
+    # Get information about locale
+    def [](name)
+      @locale[name]
+    end
+
+    # Is another locale has same language code
+    def ==(locale)
+      @locale['code'] == locale['code']
+    end
+
+    # Human readable language code and title
+    def inspect
+      "Locale #{@locale['code']} (#{@locale['title']})"
+    end
+
+    # Return pluralization type for this locale for +n+ items. 
+    # Will be replacing code from locale info file.
+    def pluralize(n); end
+  end
+end