kriss-gettext_i18n 0.2.0

data/CHANGELOG.rdoc

@@ -0,0 +1,8 @@
+== 0.2.0
+* Integrated with globalize2
+* Simple backend extension moved to Gettext backend
+* Add I18n::Globalize and I18n::Globalize::Singleton
+* Add ruby Symbol extension
+* ActiveRecord::Base extended with I18n::Gettext
+* Add almost all tests (only tests for controllers and views are missing)
+* Add full documentation and examples

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Kriss Kowalik
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,78 @@
+Extended Globalize2 which is acting like gettext translations.
+
+== Installation
+
+  sudo gem install kriss-gettext_like_i18n --source=http://gems.github.com/
+  
+== Usage
+
+in controllers...
+
+   class FooController < ApplicationController
+     def bar
+       render :text => _('Wonderfull i18n notice!')
+     end
+   end
+
+in models...
+
+   class Bar < ActiveRecord::Base
+     def foo(condition)
+       if condition
+         return "Some translated string".t
+       else
+       	 return :"some.key.for.translation".t
+       end
+     end
+   end
+
+in views...
+
+   <div id="foo">
+     <%=_ 'Translated message' %> or <%= 'Other translated message'.t %><br />
+     <%=_ 'Great translated string with {{parameter}}, :parameter => 'gettext like i18n' %><br />
+     <%= link_to _('Get it now!'), 'http://github.com/kriss/gettext_like_i18n/' %>
+   </div>
+
+== Translations
+
+Each string will be displayed as default if is not translated in locale files. 
+Eg. locale file locales/pl.yml can look like this:
+
+  pl:
+    "Translated message": "Tlumaczona wiadomosc"
+    "Some translated string": "Jakis tlumaczony tekst"
+    key_to_translate: "Translated!"
+    nested:
+      key: "Hello!"
+
+== Rails i18n & Globalize2 compatibility
+
+gettext_like_i18n is full compatible with Ruby on Rails i18n and Globalize2 plugin.
+Only you should remember that to load translation by key using gettext method you 
+have to specify key as symbol, eg:
+
+  <%=_ "nested.key" %>
+ 	
+is not the same as:
+ 	
+  <%=_ :"nested.key" %> 
+
+First will produce "nested key" string, and second translation for specified key.
+For key based translation it's better to use #t or #translate method.
+
+== Extending your classes and modules
+
+You can also extend your own classes and modules in easy way. Only thing you 
+have to do is include I18n::Gettext or I18n::Gettext::Singleton with your library, eg.
+
+  class Foo
+    include I18n::Gettext
+    include I18n::Gettext::Singleton
+  end
+  
+  module Foo
+    extend I18n::Gettext
+  end
+	
+Enjoy!

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 2
+:patch: 0
+:major: 0

data/gettext_i18n.gemspec

@@ -0,0 +1,86 @@
+Gem::Specification.new do |s|
+  s.name    = 'gettext_i18n'
+  s.version = '0.2.0'
+  s.date    = '2009-09-25'
+
+  s.summary = "Extended Globalize2 which is acting like gettext translations"
+  s.description = "Extended Globalize2 which is acting like gettext translations"
+
+  s.authors  = ['Kriss Kowalik']
+  s.email    = 'kriss.kowalik@gmail.pl'
+  s.homepage = 'http://krisskowalik.pl'
+
+  s.has_rdoc = false
+  s.rdoc_options = ['--main', 'README.rdoc']
+  s.rdoc_options << '--inline-source' << '--charset=UTF-8'
+  s.extra_rdoc_files = ['README.rdoc', 'MIT-LICENSE', 'CHANGELOG.rdoc']
+
+  s.files = [
+		'MIT-LICENSE',
+		'README.rdoc',
+		'CHANGELOG.rdoc',
+		'VERSION.yml',
+		'gettext_i18n.gemspec',
+		'init.rb',
+		'lib/gettext_i18n.rb',
+		'lib/globalize/backend/gettext.rb',
+		'lib/globalize/i18n.rb',
+		'lib/rails/extend.rb',
+		'lib/ruby/string.rb',
+		'lib/ruby/symbol.rb',
+		'test/gettext_i18n_test.rb',
+		'test/locales/en.yml',
+		'test/locales/pl.yml',
+		'test/locales/root.yml',
+		'test/test_helper.rb',
+		'vendor/globalize2/LICENSE',
+		'vendor/globalize2/README.textile',
+		'vendor/globalize2/Rakefile',
+		'vendor/globalize2/generators/db_backend.rb',
+		'vendor/globalize2/generators/templates/db_backend_migration.rb',
+		'vendor/globalize2/init.rb',
+		'vendor/globalize2/lib/globalize/backend/chain.rb',
+		'vendor/globalize2/lib/globalize/backend/pluralizing.rb',
+		'vendor/globalize2/lib/globalize/backend/static.rb',
+		'vendor/globalize2/lib/globalize/i18n/missing_translations_log_handler.rb',
+		'vendor/globalize2/lib/globalize/i18n/missing_translations_raise_handler.rb',
+		'vendor/globalize2/lib/globalize/load_path.rb',
+		'vendor/globalize2/lib/globalize/locale/fallbacks.rb',
+		'vendor/globalize2/lib/globalize/locale/language_tag.rb',
+		'vendor/globalize2/lib/globalize/model/active_record.rb',
+		'vendor/globalize2/lib/globalize/model/active_record/adapter.rb',
+		'vendor/globalize2/lib/globalize/model/active_record/translated.rb',
+		'vendor/globalize2/lib/globalize/translation.rb',
+		'vendor/globalize2/lib/locale/root.yml',
+		'vendor/globalize2/lib/rails_edge_load_path_patch.rb',
+		'vendor/globalize2/notes.textile',
+		'vendor/globalize2/test/backends/chained_test.rb',
+		'vendor/globalize2/test/backends/pluralizing_test.rb',
+		'vendor/globalize2/test/backends/static_test.rb',
+		'vendor/globalize2/test/data/locale/all.yml',
+		'vendor/globalize2/test/data/locale/de-DE.yml',
+		'vendor/globalize2/test/data/locale/en-US.yml',
+		'vendor/globalize2/test/data/locale/en-US/module.yml',
+		'vendor/globalize2/test/data/locale/fi-FI/module.yml',
+		'vendor/globalize2/test/data/locale/root.yml',
+		'vendor/globalize2/test/data/no_globalize_schema.rb',
+		'vendor/globalize2/test/data/post.rb',
+		'vendor/globalize2/test/data/schema.rb',
+		'vendor/globalize2/test/i18n/missing_translations_test.rb',
+		'vendor/globalize2/test/load_path_test.rb',
+		'vendor/globalize2/test/locale/fallbacks_test.rb',
+		'vendor/globalize2/test/locale/language_tag_test.rb',
+		'vendor/globalize2/test/model/active_record/migration_test.rb',
+		'vendor/globalize2/test/model/active_record/sti_translated_test.rb',
+		'vendor/globalize2/test/model/active_record/translated_test.rb',
+		'vendor/globalize2/test/test_helper.rb',
+		'vendor/globalize2/test/translation_test.rb'
+  ]
+  s.test_files = [
+		'test/gettext_i18n_test.rb',
+		'test/locales/en.yml',
+		'test/locales/pl.yml',
+		'test/locales/root.yml',
+		'test/test_helper.rb',
+  ]
+end

data/init.rb

@@ -0,0 +1 @@
+require "gettext_i18n"

data/lib/gettext_i18n.rb

@@ -0,0 +1,25 @@
+# Path to Globalize2 plugin
+GLOBALIZE_ROOT = File.join(File.dirname(__FILE__), '../vendor/globalize2')
+$:.unshift(File.join(GLOBALIZE_ROOT, 'lib'))
+
+# Globalize2 plugin is required so we have to load it...
+require "globalize/load_path"
+require "globalize/backend/static"
+require "globalize/model/active_record"
+require 'globalize/i18n/missing_translations_raise_handler'
+require File.join(GLOBALIZE_ROOT, 'init')
+
+# Internationalization extensions
+require "globalize/backend/gettext"
+require "globalize/i18n"
+
+# Ruby core extensions
+require "ruby/string"
+require "ruby/symbol"
+
+# Extend Rails with I18n::Gettext
+require "rails/extend"
+
+# Set gettex backend in I18n
+I18n.backend = Globalize::Backend::Gettext.new
+I18n.exception_handler = :missing_translations_raise_handler

data/lib/globalize/backend/gettext.rb

@@ -0,0 +1,26 @@
+module Globalize
+  module Backend
+    class Gettext < Static
+      # Gettext like translations
+      #
+      # == Examples
+      #
+      #   I18n.backend.gettext(:en, :"key.of.translation") # => Some value of specified key
+      #   I18n.backend.gettext(:pl, "Some string to translate") # => Jakis tekst do przetlumaczenia
+      #   I18n.backend.gettext(:pl, "Hello {{msg}}!", :msg => 'world') # => Hello world!
+      def gettext(locale, key, options={})
+        # TODO: hmm, should i check all ancestors?
+        if key.is_a? String
+          return if key.blank?
+          begin
+            translate locale, key.to_sym, options
+          rescue I18n::MissingTranslationData
+            return key
+          end
+        else
+          translate locale, key, options
+        end
+      end
+    end
+  end
+end

data/lib/globalize/i18n.rb

@@ -0,0 +1,46 @@
+module I18n
+  class << self
+    # Returns translation for current string
+    def gettext(key, options={})
+      I18n.backend.gettext(locale, key, options)
+    end
+
+    # Shortcut for gettext method
+    alias :_ :gettext
+  end
+
+  # Extension for other modules and classess, especially for Ruby on Rails 
+  # ActionController and ActionView helpers
+  #
+  # == Usage
+  #
+  #   class Foo < Bar
+  #     include I18n::Gettext
+  #
+  #     def bar
+  #       return _("Translate!")
+  #     end
+  #   end
+  #
+  #   module Hello
+  #     extend I18n::Gettext
+  #   end
+  module Gettext
+    # Gettext translation method
+    def gettext(key, options={})
+      I18n.gettext(key, options)
+    end
+    
+    # Shortcut for #translate method
+    alias :_ :gettext 
+    
+    # Extend singleton with Gettext methods
+    module Singleton
+      def self.included(base)
+        base.class_eval do
+          extend I18n::Gettext
+        end
+      end
+    end
+  end
+end

data/lib/rails/extend.rb

@@ -0,0 +1,7 @@
+class ActiveRecord::Base
+  include I18n::Gettext
+  include I18n::Gettext::Singleton
+end
+
+ActionController::Translation.send(:extend, I18n::Gettext)
+ActionView::Helpers::TranslationHelper.send(:extend, I18n::Gettext)

data/lib/ruby/string.rb

@@ -0,0 +1,15 @@
+class String
+  # Special string translations
+  #
+  # == Usage
+  #
+  #   I18n.locale = :pl
+  #   "Some string to translate".translate # => Jakis tekst do przetlumaczenia
+  def translate(options={})
+    I18n.gettext(self, options)
+  end
+  
+  # Shortcuts for #translate
+  alias_method :gettext, :translate
+  alias_method :t, :translate
+end

data/lib/ruby/symbol.rb

@@ -0,0 +1,15 @@
+class Symbol
+  # Show translation for key
+  #
+  # == Usage
+  #
+  #   I18n.locale = :pl
+  #   :key_for_translation.translate # => Jakis tlumaczony tekst
+  def translate(options={})
+    I18n.gettext(self, options)
+  end
+  
+  # Shortcuts for #translate
+  alias_method :gettext, :translate
+  alias_method :t, :translate
+end

data/test/gettext_i18n_test.rb

@@ -0,0 +1,114 @@
+require File.dirname(__FILE__) + '/test_helper.rb' 
+
+class GettextI18nTest < Test::Unit::TestCase
+  context "Simple translate" do
+    should "return itself if are not translated" do
+      I18n.locale = :en
+      assert_equal "Some not translated text", I18n.gettext("Some not translated text")
+    end
+
+    should "return translated string if are translated" do
+      I18n.locale = :pl
+      assert_equal "Testowa translacja", I18n.gettext("Test translation")
+    end
+
+    should "return translated string in the same language if such is defined" do
+      I18n.locale = :en
+      assert_equal "Correct translation", I18n.gettext("Translation with mistake")
+    end
+    
+    should "return translation for specified key" do
+      I18n.locale = :pl
+      assert_equal "Sukces!", I18n._(:key_to_translate)
+      assert_equal "Sukces!", I18n._(:"nested.translation")
+    end
+    
+    should "translate string and symbol using built in helpers" do
+      I18n.locale = :pl
+      assert_equal "Testowa translacja", "Test translation".t
+      assert_equal "Sukces!", :"nested.translation".t
+    end
+    
+    should "fallback translation to :root language" do
+      I18n.locale = :en
+      #assert_equal "It's work!", I18n.gettext("Translation fallback")
+    end
+  end
+  
+  context "Translate inside modules and classes" do 
+    should "allow to use gettext methods in extended module" do 
+      module SampleFoo
+        extend I18n::Gettext
+        
+        def self.test
+          gettext('Test translation')
+        end
+      end
+      
+      result = nil
+      I18n.locale = :pl
+      
+      assert begin
+        result = SampleFoo.test
+        true
+      rescue
+        false
+      end
+      
+      assert_equal "Testowa translacja", result
+    end
+    
+    should "allow to use gettext methods in extended class and it singleton" do 
+      class SampleBar
+        include I18n::Gettext
+        include I18n::Gettext::Singleton
+        
+        def self.test
+          gettext('Test translation')
+        end
+        def test
+          gettext('Test translation')
+        end
+      end
+      
+      results = []
+      I18n.locale = :pl
+      
+      assert begin
+        results << SampleBar.test
+        results << SampleBar.new.test
+        true
+      rescue
+        false
+      end
+      
+      assert_equal "Testowa translacja", results.first
+      assert_equal "Testowa translacja", results.last
+    end
+  end
+  
+  context "Translation in Rails" do
+    should "allow to use gettext methods in models" do
+      class SampleModel < ActiveRecord::Base
+        def self.columns; []; end
+        def self.foo
+          gettext('Test translation')
+        end
+      end
+      
+      result = nil
+      I18n.locale = :pl
+      
+      assert begin
+        result = SampleModel.foo
+        true
+      rescue
+        false
+      end
+      
+      assert_equal "Testowa translacja", result
+    end
+    
+    # TODO: tests for controllers and views
+  end
+end

data/test/locales/en.yml

@@ -0,0 +1,2 @@
+en:
+  "Translation with mistake": "Correct translation"

data/test/locales/pl.yml

@@ -0,0 +1,6 @@
+pl:
+  "Translation with mistake": "Poprawne tlumaczenie"
+  "Test translation": "Testowa translacja"
+  key_to_translate: "Sukces!"
+  nested:
+    translation: "Sukces!"

data/test/locales/root.yml

@@ -0,0 +1,2 @@
+root:
+  "Translation fallback": "It's work!"

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+ENV['RAILS_ENV'] = 'test'
+ENV['RAILS_ROOT'] ||= File.dirname(__FILE__) + '/../../../..'
+
+require 'rubygems'
+gem 'rspec'
+gem 'rspec-rails'
+gem 'thoughtbot-shoulda'
+require 'shoulda'
+require 'test/unit'
+require File.expand_path(File.join(ENV['RAILS_ROOT'], 'config/environment.rb'))
+
+I18n.load_path << Dir[File.join(File.dirname(__FILE__), 'locales', '*.{rb,yml}')]
+I18n.backend.send(:init_translations) 

data/vendor/globalize2/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2008, 2009 Joshua Harvey
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.