galetahub-globalize3 0.2.1

data/README.textile

@@ -0,0 +1,206 @@
+h1. Globalize3
+
+Globalize3 is the successor of Globalize for Rails. Globalize is targeted at ActiveRecord 3. It is compatible with and builds on the new "I18n API in Ruby on Rails":http://guides.rubyonrails.org/i18n.html and adds model translations to ActiveRecord.
+
+Globalize3 is much more lightweight and compatible than its predecessor Globalize for Rails was. Model translations in Globalize3 use default ActiveRecord features and do not limit any ActiveRecord functionality any more.
+
+h2. Requirements
+
+ActiveRecord > 3.0.0.rc
+I18n
+
+h2. Installation
+
+To install Globalize3 with its default setup just use:
+
+<pre><code>
+  gem globalize3
+</code></pre>
+
+h2. Model translations
+
+Model translations allow you to translate your models' attribute values. E.g.
+
+h3. New schema
+
+<pre><code>
+class Post < ActiveRecord::Base
+  translates "title:string", "content:text"
+end
+</code></pre>
+
+h3. Old schema
+
+<pre><code>
+class Post < ActiveRecord::Base
+  translates :title, :text
+end
+</code></pre>
+
+Allows you to translate the attributes :title and :text per locale:
+
+<pre><code>
+I18n.locale = :en
+post.title # => Globalize3 rocks!
+
+I18n.locale = :he
+post.title # => גלובאלייז2 שולט!
+</code></pre>
+
+In order to make this work, you'll need to add the appropriate translation tables. Globalize3 comes with a handy helper method to help you do this. It's called @create_translation_table!@. Here's an example:
+
+h3. New schema
+
+Synchronize translated columns with database (create/drop table or add/change/remove column)
+
+<pre><code>
+  rake db:globalize:up
+</code></pre>
+
+Drop all globalize translations tables (but be careful: non-refundable with backup)
+
+<pre><code>
+  rake db:globalize:down
+</code></pre>
+
+h3. Old schema
+
+<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. Migrating existing data to and from the translated version
+
+As well as creating a translation table, you can also use @create_translation_table!@ to migrate across any
+existing data to the default locale. This can also operate in reverse to restore any translations from the default locale
+back to the model when you don't want to use a translation table anymore using @drop_translation_table!@
+
+This feature makes use of @untranslated_attributes@ which allows access to the model's attributes as they were before
+the translation was applied. Here's an example (which assumes you already have a model called @Post@ and its table exists):
+
+<pre><code>
+  class TranslatePosts < ActiveRecord::Migration
+    def self.up
+      Post.create_translation_table!({
+        :title => :string,
+        :text => :text
+      }, {
+        :migrate_data => true
+      })
+    end
+    def self.down
+      Post.drop_translation_table! :migrate_data => true
+    end
+  end
+</code></pre>
+
+h2. Versioning with Globalize3
+
+Globalize3 nicely integrates with "vestal_versions":http://github.com/laserlemon/vestal_versions:
+
+<pre><code>
+require 'globalize/versioning/vestal_versions'
+</code></pre>
+
+As of writing (2010-08-05) the original vestal_versions respository has not been updated to be compatible with Rails 3 though. You can use "this fork":http://github.com/svenfuchs/vestal_versions though. "Globalize3's Gemfile":http://github.com/svenfuchs/globalize3/blob/master/Gemfile#L10 is currently set up accordingly.
+
+Please also note that @update_attribute@ currently hides itself from dirty tracking in ActiveRecord >= 3.0.0.beta (which is considered a "regression":http://github.com/rails/rails/commit/01629d180468049d17a8be6900e27a4f0d2b18c4#commitcomment-123199). That means that you currently need to use attribute writers or @update_attributes@ in order to track changes/versions for your models.
+
+Also, please see the tests in test/globalize3/versioning_test.rb for some current gotchas.
+
+h2. I18n fallbacks for empty translations
+
+It is possible to enable fallbacks for empty translations. It will depend on the configuration setting you have set for I18n translations in your Rails config.
+
+You can enable them by adding the next line to @config/application.rb@ (or only @config/environments/production.rb@ if you only want them in production)
+
+<pre><code>config.i18n.fallbacks = true</code></pre>
+
+By default, globalize3 will only use fallbacks when your translation model does not exist or the translation value for the item you've requested is @nil@. However it is possible to also use fallbacks for @blank@ translations by adding @:fallbacks_for_empty_translations => true@ to the @translates@ method.
+
+<pre><code>
+  class Post < ActiveRecord::Base
+    translates :title, :name
+  end
+
+  puts post.translations.inspect
+  # => [#<Post::Translation id: 1, post_id: 1, locale: "en", title: "Globalize3 rocks!", name: "Globalize3">, #<Post::Translation id: 2, post_id: 1, locale: "nl", title: '', name: nil>]
+
+  I18n.locale = :en
+  post.title # => 'Globalize3 rocks!'
+  post.name  # => 'Globalize3'
+
+  I18n.locale = :nl
+  post.title # => ''
+  post.name  # => 'Globalize3'
+</code></pre>
+<pre><code>
+  class Post < ActiveRecord::Base
+    translates :title, :name, :fallbacks_for_empty_translations => true
+  end
+
+  puts post.translations.inspect
+  # => [#<Post::Translation id: 1, post_id: 1, locale: "en", title: "Globalize3 rocks!", name: "Globalize3">, #<Post::Translation id: 2, post_id: 1, locale: "nl", title: '', name: nil>]
+
+  I18n.locale = :en
+  post.title # => 'Globalize3 rocks!'
+  post.name  # => 'Globalize3'
+
+  I18n.locale = :nl
+  post.title # => 'Globalize3 rocks!'
+  post.name  # => 'Globalize3'
+</code></pre>
+
+
+h2. Scoping objects by those with translations
+
+To only return objects that have a translation for the given locale we can use the `with_translations` scope. This will only return records that have a translations for the passed in locale.
+
+<pre><code>
+
+Post.with_translations('en') # => [#<Post::Translation id: 1, post_id: 1, locale: "en", title: "Globalize3 rocks!", name: "Globalize3">, #<Post::Translation id: 2, post_id: 1, locale: "nl", title: '', name: nil>]
+
+Post.with_translations(I18n.locale) # => [#<Post::Translation id: 1, post_id: 1, locale: "en", title: "Globalize3 rocks!", name: "Globalize3">, #<Post::Translation id: 2, post_id: 1, locale: "nl", title: '', name: nil>]
+
+Post.with_translations('de') # => []
+
+</code></pre>
+
+h2. Changes since Globalize2
+
+* `translation_table_name` was renamed to `translations_table_name`
+* `available_locales` has been removed. please use `translated_locales`
+
+h2. Migration from Globalize for Rails (version 1)
+
+See this script by Tomasz Stachewicz: http://gist.github.com/120867
+
+h2. Alternative Solutions
+
+* "Veger's fork":http://github.com/veger/globalize2 - uses default AR schema for the default locale, delegates to the translations table for other locales only
+* "TranslatableColumns":http://github.com/iain/translatable_columns - have multiple languages of the same attribute in a model (Iain Hecker)
+* "localized_record":http://github.com/glennpow/localized_record - allows records to have localized attributes without any modifications to the database (Glenn Powell)
+* "model_translations":http://github.com/janne/model_translations - Minimal implementation of Globalize2 style model translations (Jan Andersson)
+
+h2. Related solutions
+
+* "globalize2_versioning":http://github.com/joshmh/globalize2_versioning - acts_as_versioned style versioning for globalize2 (Joshua Harvey)
+* "i18n_multi_locales_validations":http://github.com/ZenCocoon/i18n_multi_locales_validations - multi-locales attributes validations to validates attributes from globalize2 translations models (Sébastien Grosjean)
+* "globalize2 Demo App":http://github.com/svenfuchs/globalize2-demo - demo application for globalize2 (Sven Fuchs)</li>
+* "migrate_from_globalize1":http://gist.github.com/120867 - migrate model translations from Globalize1 to globalize2 (Tomasz Stachewicz)</li>
+* "easy_globalize2_accessors":http://github.com/astropanic/easy_globalize2_accessors - easily access (read and write) globalize2-translated fields (astropanic, Tomasz Stachewicz)</li>
+* "globalize2-easy-translate":http://github.com/bsamman/globalize2-easy-translate - adds methods to easily access or set translated attributes to your model (bsamman)</li>
+* "batch_translations":http://github.com/alvarezrilla/batch_translations - allow saving multiple globalize2 translations in the same request (Jose Alvarez Rilla)</li>

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Run all tests.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'Globalize3'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/globalize.rb

@@ -0,0 +1,59 @@
+require 'active_record'
+require 'patches/active_record/xml_attribute_serializer'
+require 'patches/active_record/query_method'
+
+module Globalize
+  autoload :ActiveRecord, 'globalize/active_record'
+  autoload :Versioning, 'globalize/versioning'
+  autoload :Utils, 'globalize/utils'
+  
+  mattr_accessor :available_locales
+  
+  class << self
+    def locale
+      read_locale || I18n.locale
+    end
+
+    def locale=(locale)
+      set_locale(locale)
+    end
+
+    def with_locale(locale, &block)
+      previous_locale = read_locale
+      set_locale(locale)
+      result = yield(locale)
+      set_locale(previous_locale)
+      result
+    end
+
+    def with_locales(*locales, &block)
+      locales.flatten.map do |locale|
+        with_locale(locale, &block)
+      end
+    end
+
+    def fallbacks?
+      I18n.respond_to?(:fallbacks)
+    end
+
+    def fallbacks(locale = self.locale)
+      fallbacks? ? I18n.fallbacks[locale] : [locale.to_sym]
+    end
+    
+    def available_locales
+      @@available_locales || I18n.backend.available_locales
+    end
+
+  protected
+
+    def read_locale
+      Thread.current[:globalize_locale]
+    end
+
+    def set_locale(locale)
+      Thread.current[:globalize_locale] = locale.to_sym rescue nil
+    end
+  end
+end
+
+require 'globalize/engine'

data/lib/globalize/active_record.rb

@@ -0,0 +1,13 @@
+module Globalize
+  module ActiveRecord
+    autoload :ActMacro,        'globalize/active_record/act_macro'
+    autoload :Adapter,         'globalize/active_record/adapter'
+    autoload :Attributes,      'globalize/active_record/attributes'
+    autoload :ClassMethods,    'globalize/active_record/class_methods'
+    autoload :Exceptions,      'globalize/active_record/exceptions'
+    autoload :InstanceMethods, 'globalize/active_record/instance_methods'
+    autoload :Migration,       'globalize/active_record/migration'
+    autoload :Translation,     'globalize/active_record/translation'
+    autoload :Accessors,       'globalize/active_record/accessors'
+  end
+end

data/lib/globalize/active_record/accessors.rb

@@ -0,0 +1,22 @@
+module Globalize
+  module ActiveRecord
+    module Accessors
+      def self.included(base)
+        base.class_eval do
+          translated_attribute_names.each do |attr_name|  
+            Globalize.available_locales.each do |locale|
+              define_method :"#{attr_name}_#{locale}" do
+                read_attribute(attr_name, {:locale => locale})
+              end
+
+              define_method :"#{attr_name}_#{locale}=" do |value|
+                changed_attributes[:"#{attr_name}_#{locale}"] = value unless value == read_attribute(attr_name, locale)
+                write_attribute(attr_name, value, {:locale => locale})
+              end
+            end
+          end 
+        end
+      end
+    end
+  end
+end

data/lib/globalize/active_record/act_macro.rb

@@ -0,0 +1,67 @@
+module Globalize
+  module ActiveRecord
+    module ActMacro
+      # Translated attributes
+      # Example: 
+      #   class Post < ActiveRecord::Base
+      #     translates "title:string", "content:text", :versioning => true, :table_name => "..."
+      #   end
+      #
+      def translates(*attr_columns)
+        return if translates?
+
+        options = attr_columns.extract_options!
+        options[:table_name] ||= "#{table_name.singularize}_translations"
+        
+        attrs_hash = Utils.convert_columns(attr_columns)
+        attr_names = attrs_hash.keys
+        
+        class_attribute :translated_attribute_names, :translation_options, 
+                        :fallbacks_for_empty_translations, :translated_columns_hash
+                        
+        self.translated_attribute_names = attr_names.map(&:to_sym)
+        self.translation_options        = options
+        self.translated_columns_hash    = attrs_hash
+        self.fallbacks_for_empty_translations = options[:fallbacks_for_empty_translations]
+
+        include InstanceMethods, Accessors
+        extend  ClassMethods, Migration
+
+        has_many :translations, :class_name  => translation_class.name,
+                                :foreign_key => class_name.foreign_key,
+                                :dependent   => :destroy,
+                                :extend      => HasManyExtensions
+
+        before_save :update_checkers!
+        after_create :save_translations!
+        after_update :save_translations!
+
+        if options[:versioning]
+          ::ActiveRecord::Base.extend(Globalize::Versioning::PaperTrail)
+
+          translation_class.has_paper_trail
+          delegate :version, :versions, :to => :translation
+        end
+
+        attr_names.each { |attr_name| translated_attr_accessor(attr_name) }
+      end
+
+      def class_name
+        @class_name ||= begin
+          class_name = table_name[table_name_prefix.length..-(table_name_suffix.length + 1)].downcase.camelize
+          pluralize_table_names ? class_name.singularize : class_name
+        end
+      end
+
+      def translates?
+        included_modules.include?(InstanceMethods)
+      end
+    end
+
+    module HasManyExtensions
+      def find_or_initialize_by_locale(locale)
+        with_locale(locale.to_s).first || build(:locale => locale.to_s)
+      end
+    end
+  end
+end

data/lib/globalize/active_record/adapter.rb

@@ -0,0 +1,101 @@
+module Globalize
+  module ActiveRecord
+    class Adapter
+      # The cache caches attributes that already were looked up for read access.
+      # The stash keeps track of new or changed values that need to be saved.
+      attr_accessor :record, :stash, :translations
+      private :record=, :stash=
+
+      delegate :translation_class, :to => :'record.class'
+
+      def initialize(record)
+        self.record = record
+        self.stash = Attributes.new
+      end
+
+      def fetch_stash(locale, name)
+        value = stash.read(locale, name)
+        return value if value
+        return nil
+      end
+
+      def fetch(locale, name)
+        Globalize.fallbacks(locale).each do |fallback|
+          value = fetch_stash(fallback, name) || fetch_attribute(fallback, name)
+
+          unless fallbacks_for?(value)
+            set_metadata(value, :locale => fallback, :requested_locale => locale)
+            return value
+          end
+        end
+        return nil
+      end
+
+      def write(locale, name, value)
+        stash.write(locale, name, value)
+      end
+
+      def save_translations!
+        stash.each do |locale, attrs|
+          translation = record.translations.find_or_initialize_by_locale(locale.to_s)
+          attrs.each { |name, value| translation[name] = value }
+          translation.save!
+        end
+        record.translations.reset
+        stash.clear
+      end
+
+      def reset
+        stash.clear
+      end
+      
+      def all_blank?(locale, attrs)
+        [attrs].flatten.collect { |name| fetch(locale, name).blank? }.all?
+      end
+
+    protected
+
+      def type_cast(name, value)
+        if value.nil?
+          nil
+        elsif column = column_for_attribute(name)
+          column.type_cast(value)
+        else
+          value
+        end
+      end
+
+      def column_for_attribute(name)
+        translation_class.columns_hash[name.to_s]
+      end
+
+      def unserializable_attribute?(name, column)
+        column.text? && translation_class.serialized_attributes[name.to_s]
+      end
+
+      def fetch_attribute(locale, name)
+        translation = record.translation_for(locale)
+        return translation && translation.send(name)
+      end
+
+      def set_metadata(object, metadata)
+        object.translation_metadata.merge!(meta_data) if object.respond_to?(:translation_metadata)
+        object
+      end
+
+      def translation_metadata_accessor(object)
+        return if obj.respond_to?(:translation_metadata)
+        class << object; attr_accessor :translation_metadata end
+        object.translation_metadata ||= {}
+      end
+
+      def fallbacks_for?(object)
+        object.nil? || (fallbacks_for_empty_translations? && object.blank?)
+      end
+
+      def fallbacks_for_empty_translations?
+        record.fallbacks_for_empty_translations
+      end
+    end
+  end
+end