nulogy-gettext_i18n_rails 0.4.6.1

data/Gemfile

@@ -0,0 +1,16 @@
+source :rubygems
+
+gem 'fast_gettext'
+
+group :dev do
+  gem 'haml'
+  gem 'slim'
+  gem 'hamlet'
+  gem 'ruby_parser'
+  gem 'gettext'
+  gem 'sqlite3', '~>1.3.4'
+  gem 'rails', ENV['RAILS'] || '~>3'
+  gem 'rake'
+  gem 'rspec', '~>2'
+  gem 'jeweler'
+end

data/Gemfile.lock

@@ -0,0 +1,126 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionmailer (3.1.0)
+      actionpack (= 3.1.0)
+      mail (~> 2.3.0)
+    actionpack (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.2)
+      rack-cache (~> 1.0.3)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.0)
+    activemodel (3.1.0)
+      activesupport (= 3.1.0)
+      bcrypt-ruby (~> 3.0.0)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activerecord (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+      arel (~> 2.2.1)
+      tzinfo (~> 0.3.29)
+    activeresource (3.1.0)
+      activemodel (= 3.1.0)
+      activesupport (= 3.1.0)
+    activesupport (3.1.0)
+      multi_json (~> 1.0)
+    arel (2.2.1)
+    bcrypt-ruby (3.0.1)
+    builder (3.0.0)
+    diff-lcs (1.1.2)
+    erubis (2.7.0)
+    fast_gettext (0.5.13)
+    gettext (2.1.0)
+      locale (>= 2.0.5)
+    git (1.2.5)
+    haml (3.1.4)
+    hamlet (0.1)
+      slim (~> 1.0)
+    hike (1.2.1)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    locale (2.0.5)
+    mail (2.3.0)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    multi_json (1.0.3)
+    polyglot (0.3.2)
+    rack (1.3.2)
+    rack-cache (1.0.3)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.2)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rails (3.1.0)
+      actionmailer (= 3.1.0)
+      actionpack (= 3.1.0)
+      activerecord (= 3.1.0)
+      activeresource (= 3.1.0)
+      activesupport (= 3.1.0)
+      bundler (~> 1.0)
+      railties (= 3.1.0)
+    railties (3.1.0)
+      actionpack (= 3.1.0)
+      activesupport (= 3.1.0)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.6)
+    rake (0.9.2)
+    rdoc (3.9.4)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    ruby_parser (2.3.1)
+      sexp_processor (~> 3.0)
+    sexp_processor (3.0.10)
+    slim (1.1.0)
+      temple (~> 0.3.5)
+      tilt (~> 1.3.2)
+    sprockets (2.0.0)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.4)
+    temple (0.3.5)
+    thor (0.14.6)
+    tilt (1.3.3)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.29)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fast_gettext
+  gettext
+  haml
+  hamlet
+  jeweler
+  rails (~> 3)
+  rake
+  rspec (~> 2)
+  ruby_parser
+  slim
+  sqlite3 (~> 1.3.4)

data/Rakefile

@@ -0,0 +1,24 @@
+task :spec do
+  sh "rspec spec"
+end
+
+task :default do
+  sh "RAILS=2.3.14 && (bundle || bundle install) && bundle exec rake spec"
+  sh "RAILS=3.0.9 && (bundle || bundle install) && bundle exec rake spec"
+  sh "RAILS=3.1.0 && (bundle || bundle install) && bundle exec rake spec"
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = 'gettext_i18n_rails'
+    gem.summary = "Simple FastGettext Rails integration."
+    gem.email = "grosser.michael@gmail.com"
+    gem.homepage = "http://github.com/grosser/#{gem.name}"
+    gem.authors = ["Michael Grosser"]
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler"
+end

data/Readme.md

@@ -0,0 +1,226 @@
+[FastGettext](http://github.com/grosser/fast_gettext) / Rails integration.
+
+Translate via FastGettext, use any other I18n backend as extension/fallback.
+
+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
+
+#### Rails 3
+
+##### As plugin:
+
+    rails plugin install git://github.com/grosser/gettext_i18n_rails.git
+
+    # Gemfile
+    gem 'fast_gettext', '>=0.4.8'
+
+##### As gem:
+
+    # Gemfile
+    gem 'gettext_i18n_rails'
+
+##### Optional:
+Add `gettext` if you want to find translations or build .mo files<br/>
+Add `ruby_parser` if you want to find translations inside haml/slim/hamlet files (does not support ruby 1.9 syntax)
+
+
+    # Gemfile
+    gem 'gettext', '>=1.9.3', :require => false, :group => :development
+    gem 'ruby_parser', :require => false, :group => :development
+
+#### 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'
+
+##### As gem:
+
+    gem install gettext_i18n_rails
+
+    # config/environment.rb
+    config.gem 'gettext_i18n_rails'
+
+    #Rakefile
+    begin
+      require "gettext_i18n_rails/tasks"
+    rescue LoadError
+      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', :type => :po
+    FastGettext.default_available_locales = ['en','de'] #all you want to allow
+    FastGettext.default_text_domain = 'app'
+
+And in your application:
+
+    # app/controllers/application_controller.rb
+    class ApplicationController < ...
+      before_filter :set_gettext_locale
+
+Translating
+===========
+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.
+Obsolete translations are marked with ~#, they usually can be removed since they are no longer needed
+
+#### 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)))
+
+### 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`
+
+    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'
+
+Any call to I18n that matches a gettext key will be translated through FastGettext.
+
+Namespaces
+==========
+Car|Model means Model in namespace Car.
+You do not have to translate this into english "Model", if you use the
+namespace-aware translation
+    s_('Car|Model') == 'Model' #when no translation was found
+
+XSS / html_safe
+===============
+If you trust your translators and all your usages of % on translations:<br/>
+    # config/environment.rb
+    GettextI18nRails.translations_are_html_safe = true
+
+String % vs html_safe is buggy (can be used for XSS on 1.8 and is always non-safe in 1.9)<br/>
+My recommended fix is: `require 'gettext_i18n_rails/string_interpolate_fix'`
+
+ - safe stays safe (escape added strings)
+ - unsafe stays unsafe (do not escape added strings)
+
+ActiveRecord - error messages
+=============================
+ActiveRecord error messages are translated through Rails::I18n, but
+model names and model attributes are translated through FastGettext.
+Therefore a validation error on a BigCar's wheels_size needs `_('big car')` and `_('BigCar|Wheels size')`
+to display localized.
+
+The model/attribute translations can be found through `rake gettext:store_model_attributes`,
+(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.
+
+####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:
+    validates_inclusion_of :rating, :in=>1..5
+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
+    en:
+      activerecord:
+        errors:
+          models:
+            rating:
+              attributes:
+                rating:
+                  inclusion: " -- please choose!"
+The [rails I18n guide](http://guides.rubyonrails.org/i18n.html) can help with Option B and C.
+
+Plurals
+=======
+FastGettext supports pluralization
+    n_('Apple','Apples',3) == 'Apples'
+
+Abnormal plurals like e.g. Polish that has 4 different can also be addressed, see [FastGettext Readme](http://github.com/grosser/fast_gettext)
+
+Customizing list of translatable files
+======================================
+When you run
+
+    rake gettext:find
+
+by default the following files are going to be scanned for translations: {app,lib,config,locale}/**/*.{rb,erb,haml,slim}. If
+you want to specify a different list, you can redefine files_to_translate in the gettext namespace in a file like
+lib/tasks/gettext.rake:
+
+    namespace :gettext do
+      def files_to_translate
+        Dir.glob("{app,lib,config,locale}/**/*.{rb,erb,haml,slim,rhtml}")
+      end
+    end
+
+[Contributors](http://github.com/grosser/gettext_i18n_rails/contributors)
+======
+ - [ruby gettext extractor](http://github.com/retoo/ruby_gettext_extractor/tree/master) from [retoo](http://github.com/retoo)
+ - [Paul McMahon](http://github.com/pwim)
+ - [Duncan Mac-Vicar P](http://duncan.mac-vicar.com/blog)
+ - [Ramihajamalala Hery](http://my.rails-royce.org)
+ - [J. Pablo Fernández](http://pupeno.com)
+ - [Anh Hai Trinh](http://blog.onideas.ws)
+ - [ed0h](http://github.com/ed0h)
+ - [Nikos Dimitrakopoulos](http://blog.nikosd.com)
+ - [Ben Tucker](http://btucker.net/)
+ - [Kamil Śliwak](https://github.com/cameel)
+ - [Paul McMahon](https://github.com/pwim)
+ - [Rainux Luo](https://github.com/rainux)
+ - [Lucas Hills](https://github.com/2potatocakes)
+ - [Ladislav Slezák](https://github.com/lslezak)
+ - [Greg Weber](https://github.com/gregwebs)
+
+[Michael Grosser](http://grosser.it)<br/>
+grosser.michael@gmail.com<br/>
+Hereby placed under public domain, do what you want, just do not hold me accountable...

data/VERSION

@@ -0,0 +1 @@
+0.4.6

data/gettext_i18n_rails.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "gettext_i18n_rails"
+  s.version = "0.4.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Michael Grosser"]
+  s.date = "2012-04-05"
+  s.email = "grosser.michael@gmail.com"
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "Rakefile",
+    "Readme.md",
+    "VERSION",
+    "gettext_i18n_rails.gemspec",
+    "init.rb",
+    "lib/gettext_i18n_rails.rb",
+    "lib/gettext_i18n_rails/action_controller.rb",
+    "lib/gettext_i18n_rails/active_record.rb",
+    "lib/gettext_i18n_rails/backend.rb",
+    "lib/gettext_i18n_rails/base_parser.rb",
+    "lib/gettext_i18n_rails/haml_parser.rb",
+    "lib/gettext_i18n_rails/hamlet_parser.rb",
+    "lib/gettext_i18n_rails/html_safe_translations.rb",
+    "lib/gettext_i18n_rails/i18n_hacks.rb",
+    "lib/gettext_i18n_rails/model_attributes_finder.rb",
+    "lib/gettext_i18n_rails/railtie.rb",
+    "lib/gettext_i18n_rails/ruby_gettext_extractor.rb",
+    "lib/gettext_i18n_rails/slim_parser.rb",
+    "lib/gettext_i18n_rails/string_interpolate_fix.rb",
+    "lib/gettext_i18n_rails/tasks.rb",
+    "lib/tasks/gettext_rails_i18n.rake",
+    "spec/gettext_i18n_rails/action_controller_spec.rb",
+    "spec/gettext_i18n_rails/active_record_spec.rb",
+    "spec/gettext_i18n_rails/backend_spec.rb",
+    "spec/gettext_i18n_rails/haml_parser_spec.rb",
+    "spec/gettext_i18n_rails/hamlet_parser_spec.rb",
+    "spec/gettext_i18n_rails/slim_parser_spec.rb",
+    "spec/gettext_i18n_rails/string_interpolate_fix_spec.rb",
+    "spec/gettext_i18n_rails_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/grosser/gettext_i18n_rails"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "Simple FastGettext Rails integration."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<fast_gettext>, [">= 0"])
+    else
+      s.add_dependency(%q<fast_gettext>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<fast_gettext>, [">= 0"])
+  end
+end
+