globalize2 0.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+doc
+spec/spec/db/*
+vendor
+NOTES

data/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.

data/README.textile

@@ -0,0 +1,202 @@
+h1. Globalize2
+
+Globalize2 is the successor of Globalize for Rails. 
+
+It is compatible with and builds on the new "I18n api in Ruby on Rails":http://rails-i18n.org. and adds model translations as well as a bunch of other useful features, such as Locale fallbacks (RFC4647 compliant) and automatic loading of Locale data from defined directory/file locations.
+
+Globalize2 is much more lightweight and modular than its predecessor was. Content translations in Globalize2 use default ActiveRecord features and do not limit any functionality any more. 
+
+All features and tools in Globalize2 are implemented in the most unobstrusive and loosely-coupled way possible, so you can pick whatever features or tools you need for your application and combine them with other tools from other libraries or plugins.
+
+h2. Requirements
+
+Rails 2.2 (currently Rails edge)
+
+h2. Installation
+
+To install Globalize2 with its default setup just use:
+
+<pre><code>
+script/plugin install git://github.com/joshmh/globalize2.git
+</code></pre>
+
+This will:
+
+* activate model translations
+* set I18n.load_path to an instance of Globalize::LoadPath
+* set I18n.backend to an instance of Globalize::Backend::Static
+
+h2. Configuration
+
+You might want to add additional configuration to an initializer, e.g. config/initializers/globalize.rb
+
+h2. Model translations
+
+Model translations (or content translations) allow you to translate your models' attribute values. E.g.
+
+<pre><code>
+class Post < ActiveRecord::Base
+  translates :title, :text
+end
+</code></pre>
+
+Allows you to values for the attributes :title and :text per locale:
+
+<pre><code>
+I18n.locale = :en
+post.title # Globalize2 rocks!
+
+I18n.locale = :he
+post.title # גלובאלייז2 שולט!
+</code></pre>
+
+In order to make this work, you'll need to add the appropriate translation tables. Globalize2 comes with a handy helper method to help you do this. It's called @create_translation_table!@. Here's an example:
+
+<pre><code>
+class CreatePosts < ActiveRecord::Migration
+  def self.up
+    create_table :posts do |t|
+      t.timestamps
+    end
+    Post.create_translation_table! :title => :string, :text => :text
+  end
+  def self.down
+    drop_table :posts
+    Post.drop_translation_table!
+  end
+end
+</code></pre>
+
+Note that the ActiveRecord model @Post@ must already exist and have a @translates@ directive listing the translated fields.
+
+h2. Globalize::Backend::Static
+
+Globalize2 ships with a Static backend that builds on the Simple backend from the I18n library (which is shipped with Rails) and adds the following features:
+
+* It uses locale fallbacks when looking up translation data.
+* It returns an instance of Globalize::Translation::Static instead of a plain Ruby String as a translation.
+* It allows to hook in custom pluralization logic as lambdas.
+
+h2. Custom pluralization logic
+
+The Simple backend has its pluralization algorithm baked in hardcoded. This algorithm is only suitable for English and other languages that have the same pluralization rules. It is not suitable for, e.g., Czech though.
+
+To add custom pluralization logic to Globalize' Static backend you can do something like this:
+
+<pre><code>
+@backend.add_pluralizer :cz, lambda{|c| 
+  c == 1 ? :one : (2..4).include?(c) ? :few : :other 
+}
+</code></pre>
+
+h2. Locale Fallbacks
+
+Globalize2 ships with a Locale fallback tool which extends the I18n module to hold a fallbacks instance which is set to an instance of Globalize::Locale::Fallbacks by default but can be swapped with a different implementation. 
+
+Globalize2 fallbacks will compute a number of other locales for a given locale. For example:
+
+<pre><code>
+I18n.fallbacks[:"es-MX"] # => [:"es-MX", :es, :"en-US", :en]
+</code></pre>
+
+Globalize2 fallbacks always fall back to 
+
+* all parents of a given locale (e.g. :es for :"es-MX"), 
+* then to the fallbacks' default locales and all of their parents and 
+* finally to the :root locale. 
+
+The default locales are set to [:"en-US"] by default but can be set to something else. The root locale is a concept borrowed from "CLDR":http://unicode.org and makes sense for storing common locale data which works as a last default fallback (e.g. "ltr" for bidi directions).
+
+One can additionally add any number of additional fallback locales manually. These will be added before the default locales to the fallback chain. For example:
+
+<pre><code>
+fb = I18n.fallbacks
+
+fb.map :ca => :"es-ES"
+fb[:ca] # => [:ca, :"es-ES", :es, :"en-US", :en]
+
+fb.map :"ar-PS" => :"he-IL"
+fb[:"ar-PS"] # => [:"ar-PS", :ar, :"he-IL", :he, :"en-US", :en]
+fb[:"ar-EG"] # => [:"ar-EG", :ar, :"en-US", :en]
+
+fb.map :sms => [:"se-FI", :"fi-FI"]
+fb[:sms] # => [:sms, :"se-FI", :se, :"fi-FI", :fi, :"en-US", :en]
+</code></pre>
+
+h2. Globalize::LoadPath
+
+Globalize2 replaces the plain Ruby array that is set to I18n.load_path by default through an instance of Globalize::LoadPath.
+
+This object can be populated with both paths to files and directories. If a path to a directory is added to it it will look up all locale data files present in that directory enforcing the following convention:
+
+<pre><code>
+I18n.load_path << "#{RAILS_ROOT}/lib/locales"
+
+# will load all the following files if present:
+lib/locales/all.yml
+lib/locales/fr.yml
+lib/locales/fr/*.yaml
+lib/locales/ru.yml
+lib/locales/ru/*.yaml
+...
+</code></pre>
+
+One can also specify which locales are used. By default this is set to "*" meaning that files for all locales are added. To define that only files for the locale :es are added one can specify:
+
+<pre><code>
+I18n.load_path.locales = [:es]
+</code></pre>
+
+One can also specify which file extensions are used. By default this is set to ['rb', 'yml'] so plain Ruby and YAML files are added if found. To define that only *.sql files are added one can specify:
+
+<pre><code>
+I18n.load_path.extensions = ['sql']
+</code></pre>
+
+Note that Globalize::LoadPath "expands" a directory to its contained file paths immediately when you add it to the load_path. Thus, if you change the locales or extensions settings in the middle of your application the change won't be applied to already added file paths.
+
+
+h2. Globalize::Translation classes
+
+Globalize2's Static backend as well as Globalize2 model translations return instances of Globalize::Translation classes (instead of plain Ruby Strings). These are simple and lightweight value objects that carry some additional meta data about the translation and how it was looked up.
+
+Model translations return instances of Globalize::Translation::Attribute, the Static backend returns instances of Globalize::Translation::Static.
+
+For example:
+
+<pre><code>
+I18n.locale = :de
+
+# Translation::Attribute
+title = Post.first.title  # assuming that no translation can be found:
+title.locale              # => :en
+title.requested_locale    # => :de 
+title.fallback?           # => true
+
+# Translation::Static
+rails = I18n.t :rails     # assuming that no translation can be found:
+rails.locale              # => :en
+rails.requested_locale    # => :de 
+rails.fallback?           # => true
+rails.options             # returns the options passed to #t
+rails.plural_key          # returns the plural_key (e.g. :one, :other)
+rails.original            # returns the original translation with no values 
+                          # interpolated to it (e.g. "Hi {{name}}!")
+</code></pre>
+
+h2. Missing Translations Log Handler
+
+A simple exception handler that behaves like the default exception handler but additionally logs missing translations to a given log.
+
+Useful for identifying missing translations during testing.
+
+E.g. 
+
+  require 'globalize/i18n/missing_translations_log_handler
+  I18n.missing_translations_logger = RAILS_DEFAULT_LOGGER
+  I18n.exception_handler = :missing_translations_log_handler
+
+To set up a different log file:
+
+  logger = Logger.new("#{RAILS_ROOT}/log/missing_translations.log")
+  I18n.missing_translations_logger = logger

data/Rakefile

@@ -0,0 +1,39 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the globalize2 plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the globalize2 plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Globalize2'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "globalize2"
+    s.summary = "Rails I18n: de-facto standard library for ActiveRecord data translation"
+    s.description = "Rails I18n: de-facto standard library for ActiveRecord data translation"
+    s.email = "joshmh@gmail.com"
+    s.homepage = "http://github.com/joshmh/globalize2"
+    # s.rubyforge_project = ''
+    s.authors = ["Sven Fuchs, Joshua Harvey, Clemens Kofler"]
+    # s.add_development_dependency ''
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/generators/templates/db_backend_migration.rb

@@ -0,0 +1,25 @@
+class ActsAsTaggableMigration < ActiveRecord::Migration
+  def self.up
+    create_table :globalize_translations do |t|
+      t.string :locale, :null => false
+      t.string :key, :null => false
+      t.string :translation
+      t.timestamps
+    end
+
+# TODO: FINISH DOING MIGRATION -- stopped in the middle
+    
+    create_table :globalize_translations_map do |t|
+      t.string  :key, :null => false
+      t.integer :translation_id, :null => false
+    end
+    
+    add_index :taggings, :tag_id
+    add_index :taggings, [:taggable_id, :taggable_type]
+  end
+  
+  def self.down
+    drop_table :globalize_translations
+    drop_table :tags
+  end
+end

data/globalize2.gemspec

@@ -0,0 +1,100 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{globalize2}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sven Fuchs, Joshua Harvey, Clemens Kofler"]
+  s.date = %q{2009-11-08}
+  s.description = %q{Rails I18n: de-facto standard library for ActiveRecord data translation}
+  s.email = %q{joshmh@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "generators/db_backend.rb",
+     "generators/templates/db_backend_migration.rb",
+     "globalize2.gemspec",
+     "init.rb",
+     "lib/globalize/backend/chain.rb",
+     "lib/globalize/backend/pluralizing.rb",
+     "lib/globalize/backend/static.rb",
+     "lib/globalize/i18n/missing_translations_log_handler.rb",
+     "lib/globalize/i18n/missing_translations_raise_handler.rb",
+     "lib/globalize/load_path.rb",
+     "lib/globalize/locale/fallbacks.rb",
+     "lib/globalize/locale/language_tag.rb",
+     "lib/globalize/model/active_record.rb",
+     "lib/globalize/model/active_record/adapter.rb",
+     "lib/globalize/model/active_record/translated.rb",
+     "lib/globalize/translation.rb",
+     "lib/locale/root.yml",
+     "lib/rails_edge_load_path_patch.rb",
+     "notes.textile",
+     "test/all.rb",
+     "test/backends/chained_test.rb",
+     "test/backends/pluralizing_test.rb",
+     "test/backends/static_test.rb",
+     "test/data/locale/all.yml",
+     "test/data/locale/de-DE.yml",
+     "test/data/locale/en-US.yml",
+     "test/data/locale/en-US/module.yml",
+     "test/data/locale/fi-FI/module.yml",
+     "test/data/locale/root.yml",
+     "test/data/models.rb",
+     "test/data/no_globalize_schema.rb",
+     "test/data/schema.rb",
+     "test/i18n/missing_translations_test.rb",
+     "test/load_path_test.rb",
+     "test/locale/fallbacks_test.rb",
+     "test/locale/language_tag_test.rb",
+     "test/model/active_record/migration_test.rb",
+     "test/model/active_record/sti_translated_test.rb",
+     "test/model/active_record/translated_test.rb",
+     "test/test_helper.rb",
+     "test/translation_test.rb"
+  ]
+  s.homepage = %q{http://github.com/joshmh/globalize2}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Rails I18n: de-facto standard library for ActiveRecord data translation}
+  s.test_files = [
+    "test/all.rb",
+     "test/backends/chained_test.rb",
+     "test/backends/pluralizing_test.rb",
+     "test/backends/static_test.rb",
+     "test/data/models.rb",
+     "test/data/no_globalize_schema.rb",
+     "test/data/schema.rb",
+     "test/i18n/missing_translations_test.rb",
+     "test/load_path_test.rb",
+     "test/locale/fallbacks_test.rb",
+     "test/locale/language_tag_test.rb",
+     "test/model/active_record/migration_test.rb",
+     "test/model/active_record/sti_translated_test.rb",
+     "test/model/active_record/translated_test.rb",
+     "test/test_helper.rb",
+     "test/translation_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb

@@ -0,0 +1,8 @@
+require 'globalize/model/active_record'
+
+I18n.backend = Globalize::Backend::Static.new
+
+I18n.load_path = Globalize::LoadPath.new I18n.load_path
+I18n.load_path << "#{File.dirname(__FILE__)}/lib/locale"
+I18n.load_path << "#{RAILS_ROOT}/lib/locale"
+

data/lib/globalize/backend/chain.rb

@@ -0,0 +1,102 @@
+module I18n
+  class << self
+    def chain_backends(*args)
+      self.backend = Globalize::Backend::Chain.new(*args)
+    end
+  end
+end
+  
+module Globalize  
+  module Backend
+    class Chain      
+      def initialize(*args)
+        add(*args) unless args.empty?
+      end
+      
+      # Change this to a) accept any number of backends and b) accept classes.
+      # When classes are passed instantiate them and add the instances as backends.
+      # Return the added backends from #add.
+      #
+      # Add an initialize method that accepts the same arguments and passes them
+      # to #add, so we could:
+      #   I18n.backend = Globalize::Backend::Chain.new(Globalize::Backend::Foo, Globalize::Backend::Bar)
+      #   Globalize::Backend::Chain.new(:foo, :bar)
+      #   Globalize.chain_backends :foo, :bar
+      def add(*backends)
+        backends.each do |backend|
+          backend = Globalize::Backend.const_get(backend.to_s.capitalize) if backend.is_a? Symbol
+          backend = backend.new if backend.is_a? Class
+          self.backends << backend
+        end
+      end
+      
+      def load_translations(*args)
+        backends.each{|backend| backend.load_translations(*args) }
+      end
+    
+      # For defaults:
+      # Never pass any default option to the backends but instead implement our own default
+      # mechanism (e.g. symbols as defaults would need to be passed to the whole chain to
+      # be translated).
+      #
+      # For namespace lookup: 
+      # Only return if the result is not a hash OR count is not present, otherwise merge them.
+      # So in effect the count variable would control whether we have a namespace lookup or a 
+      # pluralization going on.
+      #
+      # Exceptions:
+      # Make sure that we catch MissingTranslationData exceptions and raise
+      # one in the end when no translation was found at all.
+      #
+      # For bulk translation:
+      # If the key is an array we need to call #translate for each of the
+      # keys and collect the results.
+      
+      def translate(locale, key, options = {})
+        raise I18n::InvalidLocale.new(locale) if locale.nil?
+        return key.map{|k| translate locale, k, options } if key.is_a? Array
+        
+        default = options.delete(:default)
+        result = backends.inject({}) do |namespace, backend|
+          begin
+            translation = backend.translate(locale.to_sym, key, options) 
+            if namespace_lookup?(translation, options)
+              namespace.merge! translation
+            elsif translation
+              return translation 
+            end
+          rescue I18n::MissingTranslationData
+          end
+        end
+        result || default(locale, default, options) || raise(I18n::MissingTranslationData.new(locale, key, options))
+      end
+      
+      def localize(locale, object, format = :default)
+        backends.each do |backend|
+          result = backend.localize(locale, object, format) and return result
+        end
+      end
+    
+      protected
+        def backends
+          @backends ||= []
+        end
+        
+        def default(locale, default, options = {})
+          case default
+            when String then default
+            when Symbol then translate locale, default, options
+            when Array  then default.each do |obj| 
+              result = default(locale, obj, options.dup) and return result
+            end and nil
+          end
+        rescue I18n::MissingTranslationData
+          nil
+        end
+        
+        def namespace_lookup?(result, options)
+          result.is_a?(Hash) and not options.has_key?(:count)
+        end
+    end
+  end
+end