rubi18n 0.3 → 0.4

data/{README → README.rdoc}

@@ -14,13 +14,8 @@ Rubi18n is a i18n tool to translate your Ruby application in several languages.
   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: 
+1. Create translations dir. For exmaple: <tt>_YOUR_APP_/translations/</tt>.
+2. Add file with translation in some language. For example: 
    <tt>_YOUR_APP_/translations/en.yml</tt>
    
      post:
@@ -33,10 +28,24 @@ Rubi18n is a i18n tool to translate your Ruby application in several languages.
        n: %1 comments
      
      author: !!proc |name| "This article was written by #{name.capitalize}"
-4. Put auto detection user locale and loading translations:
+3. Add Rubi18n::Mixin to your application. For example:
+   
+     require "rubygems"
+     require "rubi18n"
+     
+     class Application
+       include Rubi18n::Mixin
+       …
+     end
+4. Set translations dir and autodetect user locale:
    
-     Rubi18n::Locale.current = ENV["LANG"]
-     i18n = Rubi18n::Translation.load(ENV["LANG"], "YOUR_APP/translations/")
+     class Application
+       def initialize
+         translations_dir File.dirname(__FILE__) + "/translations/"
+         set_locales ENV["LANG"]
+       end
+       …
+     end
    
 5. Print translation string to user:
    
@@ -163,11 +172,10 @@ You can put format string to +strftime+ method in translation file to get
 locale specific time:
 
 translations/en.yml
-  published:
-    format: "%A", %d/%B"
+  published: "%A, %d/%B"
 
 application.rb
-  i18n.strftime(Time.now, translation.published.format)
+  i18n.strftime(Time.now, i18n.published)
 
 == License
 Rubi18n is licensed under the GNU Lesser General Public License version 3.

data/Rakefile

@@ -1,13 +1,10 @@
 require "rubygems"
-require "rake"
 require "rake/rdoctask"
-require "spec/rake/spectask"
 require "rake/gempackagetask"
-
-require File.join(File.dirname(__FILE__), "lib", "rubi18n")
+require "spec/rake/spectask"
 
 PKG_NAME = "rubi18n"
-PKG_VERSION = "0.3"
+PKG_VERSION = "0.4"
 
 ##############################################################################
 # Tests
@@ -46,8 +43,8 @@ end
 ##############################################################################
 
 Rake::RDocTask.new do |rdoc|
-  rdoc.main = "README"
-  rdoc.rdoc_files.include("README", "LICENSE", "lib/**/*.rb")
+  rdoc.main = "README.rdoc"
+  rdoc.rdoc_files.include("README.rdoc", "LICENSE", "lib/**/*.rb")
   rdoc.title = "Rubi18n Documentation"
   rdoc.rdoc_dir = "doc"
   rdoc.options << "-c utf-8"
@@ -72,9 +69,10 @@ spec = Gem::Specification.new do |s|
     "locales/**/*",
     "LICENSE",
     "Rakefile",
-    "README"]
+    "README.rdoc"]
   s.test_files = FileList[
     "spec/**/*"]
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE"]
   s.require_path = 'lib'
   s.has_rdoc = true
   

data/lib/rubi18n.rb

@@ -27,3 +27,4 @@ require dir + "locale"
 require dir + "translation"
 require dir + "translated_string"
 require dir + "formatters"
+require dir + "mixin"

data/lib/rubi18n/mixin.rb

@@ -0,0 +1,107 @@
+=begin
+Application mixin for 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
+  # Mixin for application to add i18n support. It just a wrap for Translation
+  # and Locale classes but has more pretty API for i18n.
+  #
+  # To use it you must set before +translations_dir+ and user locales.
+  #
+  # == Usage
+  #
+  # translations/en.yml
+  # 
+  #   hello: Hello, %1
+  # 
+  # application.rb
+  # 
+  #   require "rubi18n"
+  #   
+  #   class Application
+  #     include Rubi18n::Mixin
+  #     
+  #     def initialize
+  #       translations_dir File.dirname(__FILE__) + "/translations/"
+  #       set_locales ENV["LANG"]
+  #       
+  #       puts i18n.hello(ENV["USER"])
+  #     end
+  #   end
+  module Mixin
+    # Set dir with application translations. It must contain YAML files for
+    # each available locale.
+    def translations_dir(dir)
+      @translations_dir = dir
+    end
+    
+    # Return all available translations (all file in +translations_dir+). It
+    # will be a hash with locale code as kay and locale title (in it language) 
+    # as value.
+    def translations
+      Translation.available(@translations_dir).inject({}) do |all, code|
+        all[code] = if Locale.exists? code 
+          Locale.new(code)["title"]
+        else
+          nil
+        end
+        all
+      end
+    end
+    
+    # Set user locales to load translation. You must set a +translations_dir+
+    # before. Use Translation.default to set default locale.
+    def set_locales(locales)
+      locales = locales.to_a if Array != locales.class
+      @locales = locales
+      @translation = Translation.load(locales, @translations_dir)
+      Locale.current = Locale.find(locales + [Translation.default])
+    end
+    
+    # Return user locales
+    def locales
+      @locales
+    end
+    
+    # Return the first available user Locale (or Locale for default_locale)
+    def locale
+      Locale.current
+    end
+    
+    # Return an application Translation.
+    def i18n
+      @translation
+    end
+    
+    # Parse HTTP_ACCEPT_LANGUAGE and return array of users locales
+    def parse_http_accept_language(locales)
+      return locales if locales.nil?
+      locales = locales.split(",")
+      locales.map! do |locale|
+        locale = locale.split ";q="
+        if 1 == locale.size
+          [locale[0], 1.0]
+        else
+          [locale[0], locale[1].to_f]
+        end
+      end
+      locales.sort! { |a, b| b[1] <=> a[1] }
+      locales.map! { |i| i[0] }
+    end
+  end
+end

data/lib/rubi18n/translation.rb

@@ -134,8 +134,8 @@ module Rubi18n
     # next in "ru" and "en" (because many Belarusians know Russian and "be"
     # locale contain in +sublocales+ "ru" and "en").
     def self.load(locales, translations_dir)
-      locales = locales.to_a if String == locales.class
-      locales << @@default
+      locales = locales.to_a if Array != locales.class
+      locales = locales + [@@default]
       
       locales += Locale.find(locales)["sublocales"]
       locales.each_with_index do |locale, i|

data/spec/mixin_spec.rb

@@ -0,0 +1,40 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+class Application
+  include Rubi18n::Mixin
+  
+  def initialize
+    translations_dir Pathname(__FILE__).dirname + "translations/general"
+    set_locales "en"
+  end
+end
+
+describe Rubi18n::Mixin do
+  before :each do
+    @app = Application.new
+  end
+
+  it "should get all available translations" do
+    @app.translations.should == {
+      "en" => "English", "ru" => "Русский", "no_LC" => nil}
+  end
+  
+  it "should return user locales" do
+    @app.locales.should == ["en"]
+  end
+  
+  it "should return user locale info" do
+    @app.locale.should == Rubi18n::Locale.new("en")
+  end
+  
+  it "should return application translation" do
+    @app.i18n.one.should == "One"
+  end
+  
+  it "should parse HTTP_ACCEPT_LANGUAGE" do
+    @app.parse_http_accept_language("").should == []
+    @app.parse_http_accept_language("ru,en;q=0.9").should == ["ru", "en"]
+    @app.parse_http_accept_language("ru;q=0.8,en;q=0.9").should == ["en", "ru"]
+  end
+  
+end

data/spec/spec_helper.rb

@@ -1,3 +1,3 @@
-require File.join(File.dirname(__FILE__), "..", "lib", "rubi18n")
+require "pathname"
 
-$KCODE = "u"
+require Pathname(__FILE__).dirname + "../lib/rubi18n"

data/spec/translation_spec.rb

@@ -1,11 +1,11 @@
 require File.join(File.dirname(__FILE__), "spec_helper")
 
 describe Rubi18n::Translation do
-  DIR = File.join(File.dirname(__FILE__), "translations", "general")
-  EXT = File.join(File.dirname(__FILE__), "translations", "extention")
+  DIR = Pathname(__FILE__).dirname + "translations/general"
+  EXT = Pathname(__FILE__).dirname + "translations/extention"
 
   it "should return all available translations" do
-    Rubi18n::Translation.available(DIR).sort.should == ["en", "fr", "no_LC", "ru"]
+    Rubi18n::Translation.available(DIR).sort.should == ["en", "no_LC", "ru"]
   end
 
   it "should has default locale to use when there aren't any user locales" do
@@ -21,8 +21,8 @@ describe Rubi18n::Translation do
   end
   
   it "should find in subtranslations" do
-    translation = Rubi18n::Translation.load(["fr", "ru"], DIR)
-    translation.one.should == "Un"
+    translation = Rubi18n::Translation.load(["no_LC", "ru"], DIR)
+    translation.one.should == "ONE"
     translation.two.should == "Два"
     translation.three.should == "Three"
   end
@@ -33,8 +33,8 @@ describe Rubi18n::Translation do
   end
   
   it "should search language locale for dialect" do
-    translation = Rubi18n::Translation.load("fr_CA", DIR)
-    translation.one.should == "Un"
+    translation = Rubi18n::Translation.load("ru_RU", DIR)
+    translation.one.should == "Один"
   end
 
   it "should can use params in translation" do
@@ -51,8 +51,8 @@ describe Rubi18n::Translation do
   end
   
   it "should return string with locale info" do
-    translation = Rubi18n::Translation.load(["fr", "ru"], DIR)
-    translation.one.locale.should == "fr"
+    translation = Rubi18n::Translation.load(["no_LC", "ru"], DIR)
+    translation.one.locale.should == "no_LC"
     translation.two.locale.should == Rubi18n::Locale.new("ru")
     translation.three.locale.should == Rubi18n::Locale.new("en")
   end

data/spec/translations/general/no_LC.yml

@@ -1,3 +1,5 @@
+one: ONE
+
 entries: !!pl
   1: ONE
   2: TWO

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rubi18n
 version: !ruby/object:Gem::Version 
-  version: "0.3"
+  version: "0.4"
 platform: ruby
 authors: 
 - Andrey "A.I." Sitnik
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-09-12 00:00:00 +04:00
+date: 2008-09-14 00:00:00 +04:00
 default_executable: 
 dependencies: []
 
@@ -19,8 +19,9 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
 files: 
 - base/en.yml
 - base/ru.yml
@@ -30,12 +31,13 @@ files:
 - lib/rubi18n/locale.rb
 - lib/rubi18n/formatters.rb
 - lib/rubi18n/translated_string.rb
+- lib/rubi18n/mixin.rb
 - locales/en.yml
 - locales/ru.yml
 - locales/en_US.yml
 - LICENSE
 - Rakefile
-- README
+- README.rdoc
 has_rdoc: true
 homepage: http://rubi18n.rubyforge.org/
 post_install_message: 
@@ -69,10 +71,10 @@ test_files:
 - spec/translations/general
 - spec/translations/general/en.yml
 - spec/translations/general/ru.yml
-- spec/translations/general/fr.yml
 - spec/translations/general/no_LC.yml
 - spec/translations/extention
 - spec/translations/extention/en.yml
 - spec/translations/extention/no_TR.yml
 - spec/formatters_spec.rb
 - spec/translation_spec.rb
+- spec/mixin_spec.rb

data/spec/translations/general/fr.yml

@@ -1 +0,0 @@
-one: Un