gettext_i18n_rails 0.2.4 → 0.2.5

data/Rakefile

@@ -2,26 +2,17 @@ require 'spec/rake/spectask'
 Spec::Rake::SpecTask.new {|t| t.spec_opts = ['--color']}
 
 task :default do
-  # test with 2.x
-  puts `VERSION='~>2' rake spec RSPEC_COLOR=1`
-
-  # gem 'activerecord', '>=3' did not work for me, but just require gets the right version...
-  require 'active_record'
-  if ActiveRecord::VERSION::MAJOR >= 3
-    puts `rake spec RSPEC_COLOR=1`
-  else
-    'install rails 3 to get full test coverage...'
-  end
+  puts `rake spec VERSION=2.3.9 RSPEC_COLOR=1`
+  puts `rake spec VERSION=3.0.0 RSPEC_COLOR=1`
 end
 
 begin
   require 'jeweler'
-  project_name = 'gettext_i18n_rails'
   Jeweler::Tasks.new do |gem|
-    gem.name = project_name
+    gem.name = 'gettext_i18n_rails'
     gem.summary = "Simple FastGettext Rails integration."
     gem.email = "grosser.michael@gmail.com"
-    gem.homepage = "http://github.com/grosser/#{project_name}"
+    gem.homepage = "http://github.com/grosser/#{gem.name}"
     gem.authors = ["Michael Grosser"]
     gem.add_dependency 'fast_gettext'
   end

data/Readme.md

@@ -26,23 +26,21 @@ GetText 2.0 will render 1.93 unusable, so only install if you do not have apps t
 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'
 
-If you are not using bundler:
-
-    #config/environment.rb
-    Rails::Initializer.run do |config|
-      ...
-      config.gem "fast_gettext", :version => '>=0.4.8'
-      #only used for mo/po file generation in development, !do not load(:lib=>false), will needlessly eat ram!
-      config.gem "gettext", :lib => false, :version => '>=1.9.3'
-    end
+Rails 2:
+
+    # 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
 
-If you are using bundler:
+With bundler:
 
-    #Gemfile
-    gem "fast_gettext", '>=0.4.8'
-    gem '>=1.9.3', "gettext", :require => false
+    # Gemfile
+    gem 'fast_gettext', '>=0.4.8'
+    gem 'gettext', '>=1.9.3', :require => false
 
-If you installed it as a gem add to your Rakefile
+Installed as gem? Add to your Rakefile:
 
     #Rakefile
     begin
@@ -53,14 +51,14 @@ If you installed it as a gem add to your Rakefile
 
 To initialize:
 
-    #config/initialisers/fast_gettext.rb
+    # config/initializers/fast_gettext.rb
     FastGettext.add_text_domain 'app', :path => 'locale'
     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
+    # app/controllers/application_controller.rb
     class ApplicationController < ...
       before_filter :set_gettext_locale
 
@@ -101,6 +99,13 @@ 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:  
+(% on string is atm buggy with always staying html_safe, no matter what was replaced)
+    # config/environment.rb
+    GettextI18nRails.translations_are_html_safe = true
+
 ActiveRecord - error messages
 =============================
 ActiveRecord error messages are translated through Rails::I18n, but
@@ -150,6 +155,12 @@ Sometimes translations like `_("x"+"u")` cannot be fond. You have 4 options:
  - add a Logger to a translation Chain, so every unfound translations is logged ([example]((http://github.com/grosser/fast_gettext)))
 
 
+TODO
+=====
+ - add Railtie for rake tasks on Rails 3
+ - 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
 ======
  - [ruby gettext extractor](http://github.com/retoo/ruby_gettext_extractor/tree/master) from [retoo](http://github.com/retoo)

data/VERSION

@@ -1 +1 @@
-0.2.4
+0.2.5

data/gettext_i18n_rails.gemspec

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

data/lib/gettext_i18n_rails.rb

@@ -12,7 +12,7 @@ end
 # include translations into all the places it needs to go...
 Object.send(:include, FastGettext::Translation)
 
-# make translations html_safe if needed
+# make translations html_safe if possible and wanted
 if "".respond_to?(:html_safe?)
   require 'gettext_i18n_rails/html_safe_translations'
   Object.send(:include, GettextI18nRails::HtmlSafeTranslations)

data/lib/gettext_i18n_rails/html_safe_translations.rb

@@ -1,19 +1,29 @@
 module GettextI18nRails
+  mattr_accessor :translations_are_html_safe
+
   module HtmlSafeTranslations
+    # also make available on class methods
     def self.included(base)
       base.extend self
     end
 
     def _(*args)
-      super(*args).to_s.html_safe
+      html_safe_if_wanted super
     end
 
     def n_(*args)
-      super(*args).to_s.html_safe
+      html_safe_if_wanted super
     end
 
     def s_(*args)
-      super(*args).to_s.html_safe
+      html_safe_if_wanted super
+    end
+
+    private
+
+    def html_safe_if_wanted(text)
+      return text unless GettextI18nRails.translations_are_html_safe
+      text.to_s.html_safe
     end
   end
 end

data/spec/gettext_i18n_rails_spec.rb

@@ -3,10 +3,47 @@ require File.expand_path("spec_helper", File.dirname(__FILE__))
 FastGettext.silence_errors
 
 describe GettextI18nRails do
+  before do
+    GettextI18nRails.translations_are_html_safe = nil
+  end
+
   it "extends all classes with fast_gettext" do
     _('test')
   end
 
+  describe 'translations_are_html_safe' do
+    before do
+      GettextI18nRails.translations_are_html_safe = nil
+    end
+
+    it "makes translations not html_safe by default" do
+      _('x').html_safe?.should == false
+      s_('x').html_safe?.should == false
+      n_('x','y',2).html_safe?.should == false
+      String._('x').html_safe?.should == false
+      String.s_('x').html_safe?.should == false
+      String.n_('x','y',2).html_safe?.should == false
+    end
+
+    it "makes instance translations html_safe when wanted" do
+      GettextI18nRails.translations_are_html_safe = true
+      _('x').html_safe?.should == true
+      s_('x').html_safe?.should == true
+      n_('x','y',2).html_safe?.should == true
+    end
+
+    it "makes class translations html_safe when wanted" do
+      GettextI18nRails.translations_are_html_safe = true
+      String._('x').html_safe?.should == true
+      String.s_('x').html_safe?.should == true
+      String.n_('x','y',2).html_safe?.should == true
+    end
+
+    it "does not make everything html_safe" do
+      'x'.html_safe?.should == false
+    end
+  end
+
   it "sets up out backend" do
     I18n.backend.is_a?(GettextI18nRails::Backend).should be_true
   end
@@ -37,7 +74,7 @@ describe GettextI18nRails do
       FastGettext.locale.should == 'yy'
     end
 
-    it "does not set a non-available locale thorugh I18n.locale" do
+    it "does not set a non-available locale though I18n.locale" do
       FastGettext.available_locales = ['de']
       I18n.locale = :xx
       FastGettext.locale.should == 'de'

data/spec/spec_helper.rb

@@ -1,9 +1,9 @@
 require 'rubygems'
 if ENV['VERSION']
   puts "running VERSION #{ENV['VERSION']}"
+  gem 'actionpack', ENV['VERSION']
   gem 'activerecord', ENV['VERSION']
   gem 'activesupport', ENV['VERSION']
-  gem 'actionpack', ENV['VERSION']
   gem 'actionmailer', ENV['VERSION']
 end
 

metadata

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