gettext_i18n_rails 0.2.6 → 0.2.7

data/Readme.md

@@ -1,46 +1,52 @@
-Simple [FastGettext](http://github.com/grosser/fast_gettext) / Rails integration.
+[FastGettext](http://github.com/grosser/fast_gettext) / Rails integration.
 
-Do all translations you want with FastGettext, use any other I18n backend as extension/fallback.
+Translate via FastGettext, use any other I18n backend as extension/fallback.
 
-Rails does: `I18n.t('weir.rails.syntax.i.hate')`  
-We do: `_('Just translate my damn text!')`  
-To use I18n calls define a `weir.rails.syntax.i.hate` translation.
+Rails does: `I18n.t('syntax.with.lots.of.dots')` with nested yml files  
+We do: `_('Just translate my damn text!')` with simple, flat mo/po/yml files or directly from db  
+To use I18n calls add a `syntax.with.lots.of.dots` translation.
 
 [See it working in the example application.](https://github.com/grosser/gettext_i18n_rails_example)
 
 Setup
 =====
-###Installation
-As plugin: `  script/plugin install git://github.com/grosser/gettext_i18n_rails.git  `
-Or Gem: ` sudo gem install gettext_i18n_rails `
+### Installation
 
-[FastGettext](http://github.com/grosser/fast_gettext): `  sudo gem install fast_gettext  `
+#### Rails 3
 
-### Want to find used messages in your ruby files ?
-GetText 1.93 or GetText 2.0: `  sudo gem install gettext  `  
-GetText 2.0 will render 1.93 unusable, so only install if you do not have apps that use 1.93!
+##### As plugin:
 
-`  sudo gem install ruby_parser  `
+    rails plugin install git://github.com/grosser/gettext_i18n_rails.git
 
-### Locales & initialisation
-Copy default locales with dates/sentence-connectors/AR-errors you want from e.g.
-[rails i18n](http://github.com/svenfuchs/rails-i18n/tree/master/rails/locale/) into 'config/locales'
+    # Gemfile
+    gem 'fast_gettext', '>=0.4.8'
+
+##### As gem:
+
+    # Gemfile
+    gem 'gettext_i18n_rails'
+
+##### Optional:
+If you want to find translations or build .mo files
+    # Gemfile
+    gem 'gettext', '>=1.9.3', :require => false, :group => :development
+
+#### Rails 2
 
-Rails 2:
+##### As plugin:
+
+    script/plugin install git://github.com/grosser/gettext_i18n_rails.git
+    sudo gem install fast_gettext
 
     # config/environment.rb
     config.gem "fast_gettext", :version => '>=0.4.8'
 
-    # only needed for mo/po file generation in development
-    config.gem "gettext", :version => '>=1.9.3', :lib => false
-
-With bundler:
+##### As gem:
 
-    # Gemfile
-    gem 'fast_gettext', '>=0.4.8'
-    gem 'gettext', '>=1.9.3', :require => false
+    gem install gettext_i18n_rails
 
-Installed as gem and on Rails 2? Add to your Rakefile:
+    # config/environment.rb
+    config.gem 'gettext_i18n_rails'
 
     #Rakefile
     begin
@@ -49,10 +55,19 @@ Installed as gem and on Rails 2? Add to your Rakefile:
       puts "gettext_i18n_rails is not installed, you probably should run 'rake gems:install' or 'bundle install'."
     end
 
+##### Optional:
+If you want to find translations or build .mo files
+    # config/environments/development.rb
+    config.gem "gettext", :version => '>=1.9.3', :lib => false
+
+### Locales & initialisation
+Copy default locales with dates/sentence-connectors/AR-errors you want from e.g.
+[rails i18n](http://github.com/svenfuchs/rails-i18n/tree/master/rails/locale/) into 'config/locales'
+
 To initialize:
 
     # config/initializers/fast_gettext.rb
-    FastGettext.add_text_domain 'app', :path => 'locale'
+    FastGettext.add_text_domain 'app', :path => 'locale', :type => :po
     FastGettext.default_available_locales = ['en','de'] #all you want to allow
     FastGettext.default_text_domain = 'app'
 
@@ -62,31 +77,49 @@ And in your application:
     class ApplicationController < ...
       before_filter :set_gettext_locale
 
-
 Translating
 ===========
-###Getting started
-####Option A: Traditional mo/po files
+Performance is almost the same for all backends since translations are cached after first use.
+
+### Option A: .po files
+
+    FastGettext.add_text_domain 'app', :path => 'locale', :type => :po
+
  - use some _('translations')
  - run `rake gettext:find`, to let GetText find all translations used
  - (optional) run `rake gettext:store_model_attributes`, to parse the database for columns that can be translated
  - if this is your first translation: `cp locale/app.pot locale/de/app.po` for every locale you want to use
- - translate messages in 'locale/de/app.po' (leave msgstr blank and msgstr == msgid)  
-new translations will be marked "fuzzy", search for this and remove it, so that they will be used.
+ - translate messages in 'locale/de/app.po' (leave msgstr blank and msgstr == msgid)
+
+New translations will be marked "fuzzy", search for this and remove it, so that they will be used.
 Obsolete translations are marked with ~#, they usually can be removed since they are no longer needed
- - run `rake gettext:pack` to write GetText format translation files
 
-####Option B: Database
-This is the most scalable method, since all translators can work simultanousely and online.
+#### Unfound translations with rake gettext:find
+Dynamic translations like `_("x"+"u")` cannot be fond. You have 4 options:
+
+ - add `N_('xu')` somewhere else in the code, so the parser sees it
+ - add `N_('xu')` in a totally separate file like `locale/unfound_translations.rb`, so the parser sees it
+ - use the [gettext_test_log rails plugin ](http://github.com/grosser/gettext_test_log) to find all translations that where used while testing
+ - add a Logger to a translation Chain, so every unfound translations is logged ([example]((http://github.com/grosser/fast_gettext)))
 
-Most easy to use with the [translation database Rails engine](http://github.com/grosser/translation_db_engine).
-FastGettext setup would look like:
-    include FastGettext::TranslationRepository::Db.require_models #load and include default models
-    FastGettext.add_text_domain 'app', :type=>:db, :model=>TranslationKey
+### Option B: Traditional .po/.mo files
+
+    FastGettext.add_text_domain 'app', :path => 'locale'
+
+ - follow Option A
+ - run `rake gettext:pack` to write binary GetText .mo files
+
+### Option C: Database
+Most scalable method, all translators can work simultaneously and online.
+
+Easiest to use with the [translation database Rails engine](http://github.com/grosser/translation_db_engine).  
 Translations can be edited under `/translation_keys`
 
-###I18n
+    FastGettext::TranslationRepository::Db.require_models
+    FastGettext.add_text_domain 'app', :type => :db, :model => TranslationKey
 
+I18n
+====
     I18n.locale <==> FastGettext.locale.to_sym
     I18n.locale = :de <==> FastGettext.locale = 'de'
 
@@ -117,16 +150,14 @@ The model/attribute translations can be found through `rake gettext:store_model_
 (which ignores some commonly untranslated columns like id,type,xxx_count,...).
 
 Error messages can be translated through FastGettext, if the ':message' is a translation-id or the matching Rails I18n key is translated.
-In any other case they go through the SimpleBackend.
 
 ####Option A:
 Define a translation for "I need my rating!" and use it as message.
     validates_inclusion_of :rating, :in=>1..5, :message=>N_('I need my rating!')
 
 ####Option B:
-Do not use :message
     validates_inclusion_of :rating, :in=>1..5
-and make a translation for the I18n key: `activerecord.errors.models.rating.attributes.rating.inclusion`
+Make a translation for the I18n key: `activerecord.errors.models.rating.attributes.rating.inclusion`
 
 ####Option C:
 Add a translation to each config/locales/*.yml files
@@ -145,20 +176,11 @@ Plurals
 FastGettext supports pluralization
     n_('Apple','Apples',3) == 'Apples'
 
-Unfound translations
-====================
-Sometimes translations like `_("x"+"u")` cannot be fond. You have 4 options:
-
- - add `N_('xu')` somewhere else in the code, so the parser sees it
- - add `N_('xu')` in a totally seperate file like `locale/unfound_translations.rb`, so the parser sees it
- - use the [gettext_test_log rails plugin ](http://github.com/grosser/gettext_test_log) to find all translations that where used while testing
- - add a Logger to a translation Chain, so every unfound translations is logged ([example]((http://github.com/grosser/fast_gettext)))
-
+Abnormal plurals like e.g. Polish that has 4 different can also be addressed, see [FastGettext Readme](http://github.com/grosser/fast_gettext)
 
 TODO
 =====
  - fix % on string to respect html_safe: `("<a>%{x}</a>".html_safe % {:x=>'<script>y</script>'})` should escape the `<script>y</script>` part) 
- - refactor Readme
 
 Contributors
 ======
@@ -169,6 +191,6 @@ Contributors
  - [J. Pablo Fernández](http://pupeno.com)
  - [Anh Hai Trinh](http://blog.onideas.ws)
 
-[Michael Grosser](http://pragmatig.wordpress.com)  
+[Michael Grosser](http://grosser.it)  
 grosser.michael@gmail.com  
 Hereby placed under public domain, do what you want, just do not hold me accountable...

data/VERSION

@@ -1 +1 @@
-0.2.6
+0.2.7

data/gettext_i18n_rails.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gettext_i18n_rails}
-  s.version = "0.2.6"
+  s.version = "0.2.7"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Grosser"]
-  s.date = %q{2010-09-27}
+  s.date = %q{2010-10-13}
   s.email = %q{grosser.michael@gmail.com}
   s.files = [
     ".gitignore",

data/lib/gettext_i18n_rails/ruby_gettext_extractor.rb

@@ -109,7 +109,7 @@ module RubyGettextExtractor
     def new_call recv, meth, args = nil
       # we dont care if the method is called on a a object
       if recv.nil?
-        if (meth == :_ || meth == :p_ || meth == :N_ || meth == :pgettext)
+        if (meth == :_ || meth == :p_ || meth == :N_ || meth == :pgettext || meth == :s_)
           key = extract_key(args, "\004")
         elsif meth == :n_
           key = extract_key(args, "\000")

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 6
-  version: 0.2.6
+  - 7
+  version: 0.2.7
 platform: ruby
 authors: 
 - Michael Grosser
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-27 00:00:00 +02:00
+date: 2010-10-13 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency