model_translations 0.1.0

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+*.swp

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Jan Andersson
+
+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.markdown

@@ -0,0 +1,98 @@
+# ModelTranslations
+
+Minimal implementation of Globalize2 style model translations. Rails 2.2 is
+required.
+
+## Installation
+
+### Gem:
+
+in config/environment.rb:
+
+    config.gem 'model_translations', :source => 'http://gemcutter.org'
+
+### Plugin:
+
+    script/plugin install git://github.com/guillaumegentil/model_translations.git
+
+## Implementation
+
+    class Post < ActiveRecord::Base
+      translates :title, :text
+    end
+
+Allows you to translate values for the attributes :title and :text per locale:
+
+    I18n.locale = :en
+    post.title # ModelTranslations rocks!
+    I18n.locale = :sv
+    post.title # Rockar fett!
+
+In order to make this work you need to take care of creating the appropriate
+database migrations manually. The migration for the above Post model could look
+like this:
+
+    class CreatePosts < ActiveRecord::Migration
+      def self.up
+        create_table :posts do |t|
+          t.timestamps
+        end
+        create_table :post_translations do |t|
+          t.string     :locale
+          t.references :post
+          t.string     :title
+          t.text       :text
+          t.timestamps
+        end
+      end
+      def self.down
+        drop_table :posts
+        drop_table :post_translations
+      end
+    end
+
+To migrate from a model with existing attributes to one with translated
+attributes the migration could look like this.
+
+    class RemoveTitleTextFromPosts < ActiveRecord::Migration
+      def self.up
+        [:title, :text].each do |attribute|
+          Post.all.each{|post| post.update_attribute(attribute, post.read_attribute(attribute)) }
+          remove_column :post, attribute
+        end
+      end
+      def self.down
+        add_column :post, :title, :string
+        add_column :post, :text, :text
+        [:title, :text].each do |attribute|
+          Post.all.each{|post| post.write_attribute(attribute, post.send(attribute)); post.save}
+        end
+      end
+    end
+
+## Advanced Querying
+
+All models that have translations are hooked up with a has_many :translations 
+association for their corresponding translation table. Use this to your advantage. 
+
+Note that the following example requires Rails 2.3 since default_scope is used.
+
+    class Post < ActiveRecord::Base
+      translates :title, :text
+    
+      default_scope :include => :translations
+    
+      named_scope :translated, lambda { { :conditions => { 'post_translations.locale' => I18n.locale.to_s } } }
+      named_scope :ordered_by_title, :order => 'post_translations.title'
+      named_scope :with_title, lambda { |title| { :conditions => { 'post_translations.title' => title } } }
+    end
+
+    Post.translated.ordered_by_title # All posts with the current locale sorted on title
+    Post.with_title('My translated title') # Equivalent to Post.find_all_by_title
+
+As you can see including the model_translations on all querys by default gives 
+us (apart from reducing the number of querys to the database) the possibility
+of using the post_translations table for further query customization.
+
+
+Copyright (c) 2008 Jan Andersson, released under the MIT license

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "model_translations"
+    gem.summary = "ActiveRecord model translations"
+    gem.description = "Minimal implementation of Globalize2 style model translations. Rails 2.2 is required."
+    gem.email = "thibaud@thibaud.me"
+    gem.homepage = "http://github.com/guillaumegentil/model_translations"
+    gem.authors = ["Jan Andersson", "Thibaud Guillaume-Gentil"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    gem.files.include %w(rails/init.rb)
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "model_translations #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/lib/model_translations.rb

@@ -0,0 +1,70 @@
+module ModelTranslations
+  def translates(*attributes)
+    attributes = attributes.collect{ |attribute| attribute.to_sym }
+    
+    add_translation_model_and_logic(attributes) unless included_modules.include?(InstanceMethods)
+    add_translatable_attributes(attributes)
+  end
+    
+private
+  def add_translation_model_and_logic(attributes)
+    type = self.to_s.underscore
+    translation_class_name = "#{self.to_s}Translation"
+    translation_class = Class.new(ActiveRecord::Base) { belongs_to type.to_sym }
+    Object.const_set(translation_class_name, translation_class)
+    
+    include InstanceMethods
+    
+    has_many :translations, :class_name => translation_class_name, :dependent => :delete_all , :order => 'created_at desc'
+    
+    before_validation :clear_cached_translations
+    after_save :update_translations!
+  end
+  
+  def add_translatable_attributes(attributes)
+    attributes.each do |attribute|
+      define_method "#{attribute}=" do |value|
+        translated_attributes[attribute] = value
+      end
+      
+      define_method attribute do
+        Rails.cache.fetch "#{self.class.to_s.downcase}_translations.#{id}.#{attribute}.#{I18n.locale}" do
+          if translated_attributes[attribute]
+            translated_attributes[attribute]
+          elsif !new_record?
+            translation = translations.detect { |t| t.locale == I18n.locale.to_s } ||
+                          translations.detect { |t| t.locale == I18n.default_locale.to_s } ||
+                          translations.first
+            translation ? translation[attribute] : nil
+          end
+        end
+      end
+    end
+  end
+  
+  module InstanceMethods
+    def translated_attributes
+      @translated_attributes ||= {}
+    end
+    
+    # before_validation
+    def clear_cached_translations
+      # clear related cached
+      translated_attributes.each do |attribute|
+        Rails.cache.delete "#{self.class.to_s.downcase}_translations.#{id}.#{attribute.first}.#{I18n.locale}"
+      end
+    end
+    
+    # after_save
+    def update_translations!
+      unless translated_attributes.empty?
+        # update or create translation
+        translation = translations.find_or_initialize_by_locale(I18n.locale.to_s)
+        translated_attributes.each do |attribute, translation_string|
+          translation.send("#{attribute}=", translation_string)
+        end
+        translation.save!
+      end
+    end
+  end
+end

data/model_translations.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{model_translations}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jan Andersson", "Thibaud Guillaume-Gentil"]
+  s.date = %q{2009-11-16}
+  s.description = %q{Minimal implementation of Globalize2 style model translations. Rails 2.2 is required.}
+  s.email = %q{thibaud@thibaud.me}
+  s.extra_rdoc_files = [
+    "README.markdown"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.markdown",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/model_translations.rb",
+     "model_translations.gemspec",
+     "rails/init.rb",
+     "rails/init.rb",
+     "test/model_translations_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/guillaumegentil/model_translations}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{ActiveRecord model translations}
+  s.test_files = [
+    "test/model_translations_test.rb",
+     "test/test_helper.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/rails/init.rb

@@ -0,0 +1,3 @@
+require 'model_translations'
+
+ActiveRecord::Base.send :extend, ModelTranslations

data/test/model_translations_test.rb

@@ -0,0 +1,89 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :dbfile => ":memory:")
+
+def setup_db
+  ActiveRecord::Schema.define(:version => 1) do
+    create_table :posts do |t|
+      t.timestamps
+    end
+    create_table :post_translations do |t|
+      t.string     :locale
+      t.references :post
+      t.string     :title
+      t.text       :text
+      t.timestamps
+    end
+  end
+end
+
+def teardown_db
+  ActiveRecord::Base.connection.tables.each do |table|
+    ActiveRecord::Base.connection.drop_table(table)
+  end
+end
+
+class Post < ActiveRecord::Base
+  translates :title, :text
+  validates_presence_of :title
+end
+
+class ModelTranslationsTest < ActiveSupport::TestCase
+  
+  def setup
+    setup_db
+    I18n.locale = I18n.default_locale = :en
+    Post.create(:title => 'English title', :text => 'Text')
+  end
+  
+  def teardown
+    teardown_db
+  end
+  
+  test "database setup" do
+    assert Post.count == 1
+  end
+  
+  test "allow translation" do
+    I18n.locale = :sv
+    Post.first.update_attribute :title, 'Svensk titel'
+    assert_equal 'Svensk titel', Post.first.title
+    I18n.locale = :en
+    assert_equal 'English title', Post.first.title
+  end
+  
+  test "assert fallback to default" do
+    assert Post.first.title == 'English title'
+    I18n.locale = :sv
+    assert Post.first.title == 'English title'
+  end
+  
+  test "parent has_many translations" do
+    assert_equal PostTranslation, Post.first.translations.first.class
+  end
+  
+  test "translations are deleted when parent is destroyed" do
+    I18n.locale = :sv
+    Post.first.update_attribute :title, 'Svensk titel'
+    assert_equal 2, PostTranslation.count
+    
+    Post.destroy_all
+    assert_equal 0, PostTranslation.count
+  end
+  
+  test 'validates_presence_of should work' do
+    post = Post.new
+    assert_equal false, post.valid?
+    
+    post.title = 'English title'
+    assert_equal true, post.valid?
+  end
+  
+  test 'temporary locale switch should not clear changes' do
+    I18n.locale = :sv
+    post = Post.first
+    post.text = 'Svensk text'
+    post.title.blank?
+    assert_equal 'Svensk text', post.text
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'
+require 'active_support/test_case'
+require 'active_record'
+
+require File.dirname(__FILE__) + '/../lib/model_translations'
+# Explicitly include the module
+ActiveRecord::Base.send :extend, ModelTranslations
+
+# mimic Rails
+module Rails
+  def self.cache 
+    ActiveSupport::Cache.lookup_store(:memory_store)
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: model_translations
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jan Andersson
+- Thibaud Guillaume-Gentil
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-16 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Minimal implementation of Globalize2 style model translations. Rails 2.2 is required.
+email: thibaud@thibaud.me
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- .gitignore
+- MIT-LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- init.rb
+- lib/model_translations.rb
+- model_translations.gemspec
+- rails/init.rb
+- test/model_translations_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/guillaumegentil/model_translations
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: ActiveRecord model translations
+test_files: 
+- test/model_translations_test.rb
+- test/test_helper.rb