r18n-desktop 0.3.2 → 0.4

data/README.rdoc

@@ -1,23 +1,22 @@
 = R18n Desktop
 
-A tool to translate your desktop application in several languages.
+A tool to translate your desktop application to several languages.
 
-It is just a wrap for R18n core library. See R18n documentation for more 
+It is just a wrapper for R18n core library. See R18n documentation for more 
 information.
 
 == Features
 
-* It has special support for countries with two official languages. 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 format numbers and time 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”) or create you own filters.
+* Nice Ruby-style syntax.
+* Filters.
+* Flexible locales.
+* Custom translations loaders.
+* Translation support for any classes.
+* Time and number localization.
+* Several user language support.
 
 == How To
+
 1. Create translations dir. For example: <tt>./i18n/</tt>.
 2. Add file with translation in some language. For example
    <tt>./i18n/en.yml</tt>:
@@ -30,8 +29,6 @@ information.
        0: No files
        1: One file
        n: %1 files
-     
-     author: !!proc |name| "This file was created by #{name.capitalize}"
    
 3. Add R18n to your application:
    
@@ -39,33 +36,42 @@ information.
    
 4. Load I18n object:
    
-     i18n = R18n.from_env 'i18n/'
+     R18n.from_env 'i18n/'
    
    Or, if user can optional set locale manually:
    
-     i18n = R18n.from_env 'i18n/', manual_locale
+     R18n.from_env 'i18n/', manual_locale
+
+5. Include mixin to use helpers:
    
-5. Use translation messages to user. For example:
+     include R18n::Helpers
+      
+6. Use translation messages to user. For example:
    
-     i18n.file.add             #=> "Add file"
-     i18n.file.delete('Test')  #=> "Delete file Test"
-     i18n.files(1)             #=> "One file"
-     i18n.files(12)            #=> "12 files"
-     i18n.author('user')       #=> "This file was created by User"
-     
-     i18n.l -12000.5           #=> "−12,000.5"
+     t.file.add            #=> "Add file"
+     t.file.delete('Test') #=> "Delete file Test"
+     t.files(1)            #=> "One file"
+     t.files(12)           #=> "12 files"
      
-     i18n.l Time.now           #=> "08/09/2009 21:41"
-     i18n.l Time.now, :human   #=> "now"
-     i18n.l Time.now, :full    #=> "August 9th, 2009 21:41"
+     l -12000.5          #=> "−12,000.5"
+     l Time.now          #=> "08/09/2009 21:41"
+     l Time.now, :human  #=> "now"
+     l Time.now, :full   #=> "August 9th, 2009 21:41"
      
      # Base translation
-     i18n.ok                   #=> "OK"
-     i18n.cancel               #=> "Cancel"
+     t.ok     #=> "OK"
+     t.cancel #=> "Cancel"
+
+7. You can print user locale or available locales:
+   
+     "Your locale: " + r18n.locale.title
+     "Select another: " + r18n.available_locales.map { |i| i.title }.join(', ')
 
 == 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-desktop.rb

@@ -35,12 +35,36 @@ end
 module R18n
   class << self
     # Get user locale from system environment and load I18n object with locale
-    # information and translations from +translations_dir+. If user set locale
-    # +manual+ put it as last argument.
-    def from_env(translations_dir = nil, manual = nil)
+    # information and translations from +translations_places+. If user set
+    # locale +manual+ put it as last argument.
+    def from_env(translations_places = nil, manual = nil)
       locales = Array(R18n::I18n.system_locale)
       locales.insert(0, manual) if not manual.nil?
-      self.set I18n.new(locales, translations_dir)
+      self.set I18n.new(locales, translations_places)
+    end
+  end
+  
+  # Useful aliases. Set I18n object before use them:
+  # 
+  #   R18n.from_env('./i18n/')
+  #   
+  #   t.ok               #=> "OK"
+  #   l Time.now, :human #=> "now"
+  module Helpers
+    # Get current I18n object.
+    def r18n
+      R18n.get
+    end
+    alias i18n r18n
+    
+    # Translate message. Alias for <tt>r18n.t</tt>.
+    def t(*params)
+      R18n.get.t(*params)
+    end
+    
+    # Localize object. Alias for <tt>r18n.l</tt>.
+    def l(*params)
+      R18n.get.l(*params)
     end
   end
 end

data/spec/r18n-desktop_spec.rb

@@ -2,6 +2,7 @@
 require File.join(File.dirname(__FILE__), 'spec_helper')
 
 describe "r18n-desktop" do
+  include R18n::Helpers
 
   it "should return array of system locales" do
     locale = R18n::I18n.system_locale
@@ -10,14 +11,18 @@ describe "r18n-desktop" do
   end
 
   it "should load I18n from system environment" do
-    i18n = R18n.from_env('')
-    i18n.class.should == R18n::I18n
-    i18n.locale.should_not be_empty if String == i18n.locale.class
+    R18n.from_env('')
+    r18n.class.should == R18n::I18n
+    r18n.locale.should_not be_empty if String == r18n.locale.class
     
-    i18n = R18n.from_env('', 'en')
-    i18n.locale.should == R18n::Locale.load('en')
+    R18n.from_env('', 'en')
+    r18n.locale.should == R18n::Locale.load('en')
+    
+    R18n.get.should == r18n
+  end
+  
+  it "should add helpers" do
     
-    R18n.get.should == i18n
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: r18n-desktop
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: "0.4"
 platform: ruby
 authors: 
 - Andrey "A.I." Sitnik
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-29 00:00:00 +03:00
+date: 2010-01-03 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,9 +20,9 @@ dependencies:
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
-        version: 0.3.2
+        version: "0.4"
     version: 
-description: "    A tool to translate your desktop application in several languages.\n    It is just a wrap for R18n core library.\n    It can format numbers and time to the rules of the user locale,\n    has translation for common words, storage translation in YAML format with\n    pluralization, procedures and user filters and has special support for\n    countries with two official languages.\n"
+description: "    A i18n tool to translate your desktop application in several languages.\n    It is just a wrapper for R18n core library.\n    It has nice Ruby-style syntax, filters, flexible locales, custom loaders,\n    translation support for any classes, time and number localization, several\n    user language support, agnostic core package with out-of-box support for\n    Rails, Sinatra, Merb and desktop applications.\n"
 email: andrey@sitnik.ru
 executables: []
 
@@ -65,7 +65,7 @@ rubyforge_project: r18n-desktop
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: A tool to translate your Ruby desktop application.
+summary: A i18n tool to translate your Ruby desktop application.
 test_files: 
 - spec/r18n-desktop_spec.rb
 - spec/spec_helper.rb