translatable_ar 1.0.1

data/lib/active_record_methods.rb

@@ -0,0 +1,65 @@
+class TranslatableAR
+  module ActiveRecordMethods
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+    
+      attr_accessor :translatable_ar_attributes
+
+      def translates(*attributes)
+        remember_translatable_ar_model
+        attributes.each do |attribute|
+          remember_translatable_ar_attribute(attribute)
+          define_translatable_ar_methods(attribute)
+        end
+      end      
+    
+    private
+
+      def remember_translatable_ar_model
+        TranslatableAR.models << self
+        TranslatableAR.models.uniq!
+      end
+  
+      def remember_translatable_ar_attribute(attribute)
+        @translatable_ar_attributes ||= [] 
+        @translatable_ar_attributes << attribute
+        @translatable_ar_attributes.uniq!
+      end
+  
+      def define_translatable_ar_methods(attribute)
+        serialize attribute, TranslatableAR.coder
+        class_eval do
+          define_translatable_ar_collection(attribute)
+          define_translatable_ar_writer(attribute)
+          define_translatable_ar_reader(attribute)
+        end
+      end
+  
+      def define_translatable_ar_collection(attribute)
+        define_method("#{attribute}_translations") do
+          self["#{attribute}"] ||= {}
+        end
+      end
+
+      def define_translatable_ar_reader(attribute)
+        define_method("#{attribute}") do
+          send("#{attribute}_translations")[I18n.locale.to_s]
+        end
+      end
+      
+      def define_translatable_ar_writer(attribute)
+        define_method("#{attribute}=") do |value|
+          if value.is_a?(Hash)
+            translations = value
+          else
+            translations = send("#{attribute}_translations")
+            translations[I18n.locale.to_s] = value
+          end
+          super(translations)
+        end
+      end
+    
+    end
+  end
+end

data/lib/railtie.rb

@@ -0,0 +1,39 @@
+require 'rails'
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class TranslatableAr < Rails::Railtie
+
+  initializer 'translatable_ar' do
+    ActiveSupport.on_load :active_record do
+      require "translatable_ar"
+    end
+  end
+
+  class Setup < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    def self.source_root
+      @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+    end
+
+    def self.next_migration_number(dirname)
+      if ActiveRecord::Base.timestamped_migrations
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      else
+        "%.3d" % (current_migration_number(dirname) + 1)
+      end
+    end
+
+    def create_migration_file
+      Rails.application.eager_load! # load models
+      migration_template template_path, 'db/migrate/setup_translatable_ar.rb'
+    end
+    
+    def template_path
+      TranslatableAR.uses_hstore? ? 'hstore.rb' : 'text.rb'
+    end
+
+  end
+end
+

data/lib/templates/hstore.rb

@@ -0,0 +1,72 @@
+class SetupTranslatableAr < ActiveRecord::Migration
+
+  def up
+<% TranslatableAR.models.each do |model| -%>
+<% model.translatable_ar_attributes.each do |attribute| -%>
+    add_column :<%= model.table_name %>, :<%= attribute %>_i18n_temp, :hstore
+<% end -%>
+<% end -%>
+<% TranslatableAR.models.each do |model| -%>
+
+    <%= model.to_s %>.translates <%= model.translatable_ar_attributes.map {|a| ":#{a}_i18n_temp" }.join(', ') %>
+    <%= model.to_s %>.all.each do |object|
+<% model.translatable_ar_attributes.each do |attribute| -%>
+      if object[:<%=attribute%>].is_a? Hash
+        object.<%=attribute%>_i18n_temp = object[:<%=attribute%>]
+      else
+        object.<%=attribute%>_i18n_temp = {'<%= I18n.locale%>' => object[:<%=attribute%>]}
+      end
+<% end -%>
+      object.save if object.changed?
+    end
+<% end -%>
+<% TranslatableAR.models.each do |model| -%>
+<% model.translatable_ar_attributes.each do |attribute| -%>
+    remove_column :<%= model.table_name %>, :<%= attribute %>
+    rename_column :<%= model.table_name %>, :<%= attribute%>_i18n_temp, :<%= attribute %>
+<% end -%>
+<% end -%>
+
+<% TranslatableAR.models.each do |model| -%>
+<% model.translatable_ar_attributes.each do |attribute| -%>
+#    execute "CREATE INDEX <%= model.table_name%>_gin_<%= attribute %> ON <%= model.table_name %> USING GIN(<%= attribute %>);"
+<% end -%>
+<% end -%>
+  end
+  
+  def down
+<% TranslatableAR.models.each do |model| -%>
+<% model.translatable_ar_attributes.each do |attribute| -%>
+    add_column :<%= model.table_name %>, :<%= attribute %>_i18n_temp, :<%= model.columns_hash[attribute.to_s].type %>
+<% end -%>
+<% end -%>
+<% TranslatableAR.models.each do |model| -%>
+
+    <%= model.to_s %>.translates <%= model.translatable_ar_attributes.map {|a| ":#{a}_i18n_temp" }.join(', ') %>
+    <%= model.to_s %>.all.each do |object|
+<% model.translatable_ar_attributes.each do |attribute| -%>
+      if object[:<%=attribute%>].is_a? Hash
+        object.<%=attribute%>_i18n_temp = object[:<%=attribute%>]['<%= I18n.locale%>']
+      else
+        object.<%=attribute%>_i18n_temp = object[:<%=attribute%>]
+      end
+<% end -%>
+      object.save if object.changed?
+    end
+<% end -%>
+
+<% TranslatableAR.models.each do |model| -%>
+<% model.translatable_ar_attributes.each do |attribute| -%>
+    execute "DROP INDEX <%= model.table_name%>_gin_<%= attribute %>;"
+<% end -%>
+<% end -%>
+    
+<% TranslatableAR.models.each do |model| -%>
+<% model.translatable_ar_attributes.each do |attribute| -%>
+    remove_column :<%= model.table_name %>, :<%= attribute %>
+    rename_column :<%= model.table_name %>, :<%= attribute%>_i18n_temp, :<%= attribute %>
+<% end -%>
+<% end -%>
+  end
+
+end

data/lib/templates/text.rb

@@ -0,0 +1,39 @@
+class SetupTranslatableAr < ActiveRecord::Migration
+
+  def up
+<% TranslatableAR.models.each do |model| -%>
+<% model.translatable_ar_attributes.each do |attribute| -%>
+    add_column :<%= model.table_name %>, :<%= attribute %>_i18n_temp, :text
+<% end -%>
+<% end -%>
+<% TranslatableAR.models.each do |model| -%>
+
+    <%= model.to_s %>.translates <%= model.translatable_ar_attributes.map {|a| ":#{a}_i18n_temp" }.join(', ') %>
+    <%= model.to_s %>.all.each do |object|
+<% model.translatable_ar_attributes.each do |attribute| -%>
+      if object[:<%=attribute%>].is_a? Hash
+        object.<%=attribute%>_i18n_temp = object[:<%=attribute%>]
+      else
+        object.<%=attribute%>_i18n_temp = {'<%= I18n.locale%>' => object[:<%=attribute%>]}
+      end
+<% end -%>
+      object.save if object.changed?
+    end
+<% end -%>
+<% TranslatableAR.models.each do |model| -%>
+<% model.translatable_ar_attributes.each do |attribute| -%>
+    remove_column :<%= model.table_name %>, :<%= attribute %>
+    rename_column :<%= model.table_name %>, :<%= attribute%>_i18n_temp, :<%= attribute %>
+<% end -%>
+<% end -%>
+  end
+  
+  def down
+<% TranslatableAR.models.each do |model| -%>
+<% model.translatable_ar_attributes.each do |attribute| -%>
+    change_column :<%= model.table_name %>, :<%= attribute %>, :<%= model.columns_hash[attribute.to_s].type %>
+<% end -%>
+<% end -%>
+  end
+
+end

data/lib/translatable_ar.rb

@@ -0,0 +1,7 @@
+require 'active_support'
+if defined? Rails
+  require "railtie"
+end
+require 'translatable_ar_class'
+require 'active_record_methods'
+ActiveRecord::Base.send(:include, TranslatableAR::ActiveRecordMethods)

data/lib/translatable_ar_class.rb

@@ -0,0 +1,16 @@
+class TranslatableAR
+
+  class << self
+    attr_accessor :models, :coder
+    def coder
+      @coder ||= Object # Use ActiveRecord's default serializer class
+    end
+    def models
+      @models ||= []
+    end    
+    def uses_hstore?
+      @coder == ActiveRecord::Coders::Hstore rescue false
+    end
+  end
+
+end

data/test/rails_3.2.11/test/unit/product_test.rb

@@ -0,0 +1,110 @@
+require File.expand_path('../../test_helper', __FILE__)
+
+class ProductTest < ActiveSupport::TestCase
+
+  # Singular Association
+
+  test "build with nested locale values" do
+    p = Product.new(:name => {'en' => 'Chair', 'da' => 'Stol'}, image_url: '/image1.png')
+    assert_equal 'Chair', p.name_translations['en']
+    assert_equal 'Stol', p.name_translations['da']
+    assert_equal '/image1.png', p.image_url
+  end
+
+  test "build with default locale" do
+    p = Product.new(name: 'Table', image_url: '/image1.png')
+    assert_equal('Table', p.name)
+    assert_equal({'en' => 'Table'}, p.name_translations)
+    assert_equal '/image1.png', p.image_url
+  end
+
+  test "create with nested locale values" do
+    p = Product.create(:name => {'en' => 'Chair', 'da' => 'Stol'}, image_url: '/image1.png')
+    assert_equal 'Chair', p.name_translations['en']
+    assert_equal 'Stol', p.name_translations['da']
+    assert_equal '/image1.png', p.image_url
+  end
+
+  test "create with default locale" do
+    p = Product.create(name: 'Table', image_url: '/image1.png')
+    assert_equal 'Table', p.name
+    assert_equal({'en' => 'Table'}, p.name_translations)
+    assert_equal '/image1.png', p.image_url
+  end
+
+  test "update with nested locale values" do
+    p = Product.new
+    p.update_attributes(:name => {'en' => 'Chair', 'da' => 'Stol'}, image_url: '/image1.png')
+    assert_equal 'Chair', p.name_translations['en']
+    assert_equal 'Stol', p.name_translations['da']
+    assert_equal '/image1.png', p.image_url
+  end
+
+  test "update with locale" do
+    p = Product.new
+    p.update_attributes(name: 'Table', image_url: '/image1.png')
+    assert_equal 'Table', p.name
+    assert_equal({'en' => 'Table'}, p.name_translations)
+    assert_equal '/image1.png', p.image_url
+  end
+
+  test "update with different locale" do
+    p = Product.create(name: 'Table', image_url: '/image1.png')
+    
+    assert_equal 'Table', p.name
+    assert_equal '/image1.png', p.image_url
+    
+    I18n.locale = :da
+    
+    assert_equal nil, p.name
+    assert_equal '/image1.png', p.image_url
+    
+    p.name = 'Bord'
+    
+    assert_equal 'Bord', p.name
+    assert_equal({'en' => 'Table', 'da' => 'Bord'}, p.name_translations)
+    
+    p.save
+
+    I18n.locale = :en
+    
+    assert_equal 'Table', p.name
+    assert_equal({'en' => 'Table', 'da' => 'Bord'}, p.name_translations)
+    
+  end
+
+  # Collection Association
+  
+  test "build from collection with nested locale values" do
+    c = Category.create(name: 'Furniture')
+    p = c.products.build(:name => {'en' => 'Chair', 'da' => 'Stol'}, image_url: '/image1.png')
+    assert_equal 'Chair', p.name_translations['en']
+    assert_equal 'Stol', p.name_translations['da']
+    assert_equal '/image1.png', p.image_url
+  end  
+  
+  test "build from collection with default locale" do
+    c = Category.create(name: 'Furniture')
+    p = c.products.build(name: 'Table', image_url: '/image1.png')
+    assert_equal('Table', p.name)
+    assert_equal({'en' => 'Table'}, p.name_translations)
+    assert_equal '/image1.png', p.image_url
+  end
+
+  test "create from collection with nested locale values" do
+    c = Category.create(name: 'Furniture')
+    p = c.products.create(:name => {'en' => 'Chair', 'da' => 'Stol'}, image_url: '/image1.png')
+    assert_equal 'Chair', p.name_translations['en']
+    assert_equal 'Stol', p.name_translations['da']
+    assert_equal '/image1.png', p.image_url
+  end
+
+  test "create from collection with default locale" do
+    c = Category.create(name: 'Furniture')
+    p = c.products.create(name: 'Table', image_url: '/image1.png')
+    assert_equal 'Table', p.name
+    assert_equal({'en' => 'Table'}, p.name_translations)
+    assert_equal '/image1.png', p.image_url
+  end
+  
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: translatable_ar
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kasper Bjørn Nielsen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: No joins. No locale columns. Attribute translations are saved in-column
+  as a serialized hash.
+email: kasperbn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/active_record_methods.rb
+- lib/railtie.rb
+- lib/templates/hstore.rb
+- lib/templates/text.rb
+- lib/translatable_ar.rb
+- lib/translatable_ar_class.rb
+- test/rails_3.2.11/test/unit/product_test.rb
+homepage: http://github.com/kasperbn/translatable_ar
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Less painful i18n for your active record models
+test_files:
+- test/rails_3.2.11/test/unit/product_test.rb