lolita-translation 0.3.3 → 0.5.0

data/lib/lolita-translation/translated_string.rb

@@ -0,0 +1,11 @@
+class TranslatedString < String 
+  def initialize(str, translation_record, attribute_name)
+    @translation_record = translation_record
+    @attribute_name     = attribute_name
+    super(str)
+  end
+
+  def in(locale)
+    @translation_record.translated_attribute(@attribute_name, :locale => locale)
+  end
+end

data/lib/lolita-translation/translation_class_builder.rb

@@ -0,0 +1,59 @@
+require 'lolita-translation/builder/active_record_builder'
+require 'lolita-translation/builder/mongoid_builder'
+require 'lolita-translation/utils'
+
+module Lolita
+  module Translation
+
+    # Create ORM class for translations. For Post class it will create PostTranslation class, 
+    # for News it will create NewsTranslation and so on
+    class TranslationClassBuilder
+
+      attr_reader :klass
+
+      def initialize(base_class, configuration = nil) 
+        @klass          = base_class
+        @configuration  = configuration
+        detect_builder_class
+      end
+
+      def builder_available?
+        !!@builder_class
+      end
+
+      def builder
+        @builder ||= @builder_class && @builder_class.new(klass, @configuration)
+      end
+
+      def build_class
+        if builder
+          builder.build
+          builder.klass
+        else
+          raise Lolita::Translation::NoBuilderForClassError.new(klass)
+        end
+      end
+
+      def override_attributes(attributes)
+        if builder 
+          builder.override_klass_attributes(attributes)
+        else
+          raise Lolita::Translation::NoBuilderForClassError.new(klass)
+        end
+      end
+
+      private
+
+      def detect_builder_class
+        @builder_class ||= if Lolita::Translation::Utils.active_record_class?(klass)
+          Lolita::Translation::Builder::ActiveRecordBuilder
+        elsif Lolita::Translation::Utils.mongoid_class?(klass)
+          Lolita::Translation::Builder::MongoidBuilder
+        else
+          nil
+        end 
+      end
+    end
+
+  end
+end

data/lib/lolita-translation/utils.rb

@@ -0,0 +1,13 @@
+module Lolita
+  module Translation
+    module Utils
+      def self.mongoid_class?(klass) 
+        defined?(Mongoid::Document) && klass.ancestors.include?(Mongoid::Document)
+      end
+
+      def self.active_record_class?(klass)
+         defined?(ActiveRecord::Base) && klass.ancestors.include?(ActiveRecord::Base)
+      end
+    end
+  end
+end

data/lib/lolita-translation/version.rb

@@ -0,0 +1,32 @@
+module Lolita
+  module Translation
+    module Version
+      MAJOR = 0
+      MINOR = 5
+      PATCH = 0
+      BUILD = nil
+
+      STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+
+      def self.to_s
+        STRING
+      end
+
+      def self.major
+        MAJOR
+      end
+
+      def self.minor
+        MINOR
+      end
+
+      def self.patch
+        PATCH
+      end
+
+      def self.build
+        BUILD
+      end
+    end
+  end
+end

data/lib/tasks/lolita_translation.rake

@@ -0,0 +1,14 @@
+require 'lolita-translation'
+require 'rake'
+
+namespace :lolita_translation do 
+  desc "Synca all tables at once"
+  task :sync_tables do
+    Lolita.mappings.each do |k,mapping|
+      klass = mapping.to
+      if klass && klass.respond_to?(:sync_translation_table!)
+        klass.sync_translation_table!
+      end
+    end
+  end
+end

data/lolita-translation.gemspec

@@ -1,83 +1,36 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "lolita-translation/version"
 
 Gem::Specification.new do |s|
-  s.name = "lolita-translation"
-  s.version = "0.3.3"
+  s.name        = "lolita-translation"
+  s.version     = Lolita::Translation::Version.to_s
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["ITHouse (Latvia) and Arturs Meisters"]
+  s.email       = "support@ithouse.lv"
+  s.homepage    = "http://github.com/ithouse/lolita-translation"
+  s.summary     = %q{Lolita extension that add multilanguate support to Lolita.}
+  s.description = %q{Lolita extension that allow users to change language and translate DB data.}
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["ITHouse", "Gatis Tomsons", "Arturs Meisters"]
-  s.date = "2011-12-20"
-  s.description = "Translates models in Lolita"
-  s.email = "support@ithouse.lv"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md"
   ]
-  s.files = [
-    ".document",
-    ".rspec",
-    "Gemfile",
-    "LICENSE.txt",
-    "README.md",
-    "Rakefile",
-    "VERSION",
-    "app/assets/.gitkeep",
-    "app/assets/javascripts/.gitkeep",
-    "app/assets/javascripts/lolita/translation/application.js",
-    "app/assets/stylesheets/lolita/translation/application.css",
-    "app/views/components/lolita/translation/_assets.html.erb",
-    "app/views/components/lolita/translation/_language_wrap.html.erb",
-    "app/views/components/lolita/translation/_switch.html.erb",
-    "config/locales/en.yml",
-    "config/locales/lv.yml",
-    "lib/generators/lolita_translation/USAGE",
-    "lib/generators/lolita_translation/has_translations_generator.rb",
-    "lib/lolita-translation.rb",
-    "lib/lolita-translation/configuration.rb",
-    "lib/lolita-translation/model.rb",
-    "lib/lolita-translation/modules.rb",
-    "lib/lolita-translation/rails.rb",
-    "lib/lolita-translation/string.rb",
-    "lib/tasks/has_translations_tasks.rake",
-    "lolita-translation.gemspec",
-    "spec/has_translations_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = "http://github.com/ithouse/lolita-translations"
   s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
-  s.summary = "Lolita models translation plugin"
-  s.test_files = [
-    "spec/has_translations_spec.rb",
-    "spec/spec_helper.rb"
-  ]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  s.add_runtime_dependency(%q<lolita>, ["~> 3.2.0.rc.9"])
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<lolita>, [">= 3.2.0.rc.3"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-    else
-      s.add_dependency(%q<lolita>, [">= 3.2.0.rc.3"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<lolita>, [">= 3.2.0.rc.3"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-  end
-end
+  s.add_development_dependency(%q<rails>, ["~> 3.2.3"])
+  s.add_development_dependency(%q<rspec>, ["~> 2.9.0"])
+  s.add_development_dependency(%q<rspec-rails>, ["~> 2.9.0"])
+  s.add_development_dependency(%q<ffaker>, ["~> 1"])
+  s.add_development_dependency(%q<capybara>, ["~> 1.1.2"])
+  s.add_development_dependency(%q<capybara-webkit>, ["~> 0.11.0"])
+  s.add_development_dependency(%q<cover_me>, ["~> 1.2.0"])
+  s.add_development_dependency(%q<sqlite3>, ["~> 1.3.6"])
+  s.add_development_dependency(%q<debugger>,[">0"])
 
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+end

data/spec/ar_schema.rb

@@ -0,0 +1,90 @@
+require 'active_record'
+
+# Override connection method, to load schema on demand when there is no tables in, this allow to solve problems 
+# when there are different connection between rspec and capybara::session. This does not work well when data is stored
+# in memory, because connection is lost in some way.
+class ActiveRecord::Base
+  def self.connection 
+    temp_c = retrieve_connection
+    if temp_c.tables.empty? && !::ARSchema.loading
+      ::ARSchema.load_schema
+    end
+    temp_c
+  end
+end 
+
+# Is used to load schema and clean data from table when there is any. 
+# Schema load is called from overrided ActiveRecord::Base.connection method.
+class ARSchema
+  cattr_accessor :loading, :connection
+  @@loading = false
+  @connection = false
+
+  def self.connect!
+    unless ActiveRecord::Base.connected?
+      ActiveRecord::Base.establish_connection(:adapter => "sqlite3", :database => ":memory:")
+    end
+  end
+
+  def self.clean!
+    [:products,:products_translations,:categories,:categories_translations, :posts, :posts_translations].each do |table_name|
+      begin 
+        if ActiveRecord::Base.connection.execute("SELECT count(*) FROM #{table_name}")[0]["count(*)"] > 0
+          ActiveRecord::Base.connection.execute("DELETE FROM #{table_name}")
+        end
+      rescue Exception => e
+        puts "Error: #{e}"
+      end
+    end
+  end
+
+  def self.load_schema
+    # Add models
+    ActiveRecord::Schema.define do
+      ::ARSchema.loading = true
+      create_table :products, :force => true do |t|
+        t.string  :name
+        t.text    :description
+        t.integer :price
+        t.integer :category_id
+      end
+
+      create_table :products_translations, :force => true do |t|
+        t.string  :name
+        t.text    :description
+        t.integer :product_id
+        t.string  :locale
+      end
+
+      create_table :categories, :force => true do |t|
+        t.string  :name
+        t.string  :default_locale
+      end
+
+      create_table :categories_translations, :force => true do |t|
+        t.string  :name 
+        t.integer :category_id
+        t.string  :locale
+      end
+
+      create_table :posts, :force => true do |t|
+        t.string  :title
+        t.string  :body
+        t.integer :views
+      end
+
+      create_table :posts_translations, :force => true do |t|
+        t.string  :title
+        t.string  :body
+        t.integer :post_id
+        t.string  :locale
+      end
+
+      create_table :comments, :force => true do |t|
+        t.text  :body
+        t.string  :commenter
+      end 
+      ::ARSchema.loading = false
+    end
+  end
+end

data/spec/header.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'cover_me'
+
+CoverMe.config do |c|
+    # where is your project's root:
+    c.project.root = File.expand_path("../lolita-translation") # => "Rails.root" (default)
+    
+    # what files are you interested in coverage for:
+    c.file_pattern =  [
+      /(#{CoverMe.config.project.root}\/app\/.+\.rb)/i,
+      /(#{CoverMe.config.project.root}\/lib\/.+\.rb)/i
+    ] 
+end

data/spec/integrations/active_record_integration_spec.rb

@@ -0,0 +1,218 @@
+require 'spec_helper'
+require 'ar_schema'
+
+ARSchema.connect!
+
+describe "Integration with ActiveRecord" do 
+  before(:each) do 
+    ActiveRecord::Base.connection.execute("DELETE FROM categories")
+    ActiveRecord::Base.connection.execute("DELETE FROM products")
+  end
+  context "configuration defination" do 
+
+    before(:each) do 
+      Object.send(:remove_const, :Product) rescue nil
+      klass = Class.new(ActiveRecord::Base)
+      Object.const_set(:Product,klass)
+    end
+
+    it "should have class method for translation configuration" do 
+      Product.class_eval do
+        include Lolita::Translation
+      end
+
+      Product.should.respond_to?(:translations)
+      Product.should.respond_to?(:translate)
+    end
+
+    it "should create configuration when class is loaded with field names to translate" do  
+      Product.class_eval do 
+        include Lolita::Translation
+        translate :name, :description
+      end
+      Product.translations_configuration.should be_kind_of(Lolita::Translation::Configuration)
+    end
+
+    it "should accept block and yield configuration" do 
+      block_called = false
+      Product.class_eval do 
+        include Lolita::Translation
+        translate :name, :description do |conf|
+          block_called = true
+        end
+      end
+      block_called.should be_true
+    end
+  end
+
+  context "record" do 
+    let(:category){Category.create(:name => "category_name", :default_locale => "en")}
+
+    before(:each) do 
+      Object.send(:remove_const, :Category) rescue nil
+      klass = Class.new(ActiveRecord::Base)
+      Object.const_set(:Category,klass)
+      Category.class_eval do 
+        include Lolita::Translation
+        translate :name
+      end
+    end
+
+    it "validation should fail when no location is given, but class accepts translation locale" do 
+      category = Category.create(:name => Faker::Name.first_name, :default_locale => "")
+      category.errors.keys.should include(:default_locale)
+    end
+
+    it "should have default locale" do 
+      category = Category.create(:name => Faker::Name.first_name, :default_locale => "en")
+      I18n.default_locale = :lv
+      category.original_locale.should eq("en")
+    end
+
+    it "should have translations" do 
+      category.translations.should be_empty
+      category.update_attributes(:name => "updated",:translations_attributes => [{:name => "translation-lv", :locale => "lv"}])
+      category.errors.should be_empty
+      category.translations.reload.should have(1).item
+    end
+
+    it "should return translatable attribute in current locale" do 
+      I18n.default_locale = :lv
+      I18n.locale = :lv
+      category.name.should eq("category_name")
+      I18n.locale = :en
+      category.name.should eq("category_name")
+      category.update_attributes(:name => "updated",:translations_attributes => [{:name => "translation-lv", :locale => "lv"}])
+      I18n.locale = :lv
+      category.name.should eq("translation-lv")
+      I18n.locale = :ru 
+      category.name.should eq("updated")
+    end
+
+    it "should switch attribute to different locale" do 
+      category.name.should eq("category_name")
+      category.update_attributes(:translations_attributes => [{:name => "translation-lv", :locale => "lv"}])
+      category.name.in(:lv).should eq("translation-lv")
+    end
+  end
+  
+  context "saving" do
+    let(:category){Category.create(:name => "category_name", :default_locale => :en)}
+    let(:product){ Product.create(:name => "product_name", :description => "product_description") }
+
+    before(:each) do 
+      I18n.locale = :en
+      I18n.default_locale = :lv
+      Object.send(:remove_const, :Category) rescue nil
+      Object.send(:remove_const, :Product) rescue nil
+      klass = Class.new(ActiveRecord::Base)
+      Object.const_set(:Category,klass)
+      product_klass = Class.new(ActiveRecord::Base)
+      Object.const_set(:Product,product_klass)
+      Category.class_eval do 
+        include Lolita::Translation
+        translate :name
+      end
+      Product.class_eval do 
+        include Lolita::Translation
+        translate :name, :description
+      end
+    end
+ 
+    it "should create translations for object" do 
+      new_cat = Category.create({
+        :name => "cat_name",
+        :original_locale => :en,
+        :translations_attributes => [
+          {:name => "translation-lv", :locale => "lv"},
+          {:name => "translation-fr", :locale => "fr"}
+        ]
+      })
+      new_cat.errors.should be_empty
+      new_cat.translations.should have(2).items
+    end
+
+    it "should save translation as nested attributes" do 
+      category.translations.should be_empty
+      category.update_attributes(:translations_attributes => [
+        {:name => "translation-lv", :locale => "lv"},
+        {:name => "translation-fr", :locale => "fr"}
+      ])
+      category.translations.reload
+      category.translations.should have(2).items
+    end
+
+    it "should save locale for record if it accepts it" do 
+      I18n.locale = :lv
+      category.original_locale.should eq(:en)
+      product.original_locale.should eq(:lv)
+    end
+
+    it "should not save translation for record default locale" do
+      category.translations.should be_empty
+      category.update_attributes(:translations_attributes => [
+        { :name => "translation2-lv", :locale => "lv"},
+        { :name => "translation2-en", :locale => "en"}
+      ])
+      category.errors.keys.should include(:"translations.locale")
+    end
+
+    it "translation record should be associated with original record" do 
+      transl1 = CategoryTranslation.new(:name => "translation-lv", :locale => "lv")
+      transl1.category = category
+      transl1.save
+      transl1.errors.should be_empty
+      transl2 = CategoryTranslation.create(:name => "translation-fr", :locale => "fr")
+      transl2.update_attributes(:name => "updated-translation-fr")
+      transl2.errors.keys.should include(:"category")
+    end
+
+    it "should validate that locale is presented" do 
+      transl1 = CategoryTranslation.new(:name => "translation-lv")
+      transl1.category = category 
+      transl1.save
+      transl1.errors.keys.should eq([:"locale"])
+    end
+
+    it "should validate that locale is unique for each original record" do 
+      transl1 = category.translations.create(:name => "translation-lv", :locale => "lv")
+      transl2 = category.translations.create(:name => "translation-lv", :locale => "lv")
+      transl1.errors.should be_empty
+      transl2.errors.keys.should eq([:"locale"])
+    end
+
+    it "should use default locale for records without default locale field" do 
+      product.update_attributes(:translations_attributes => [
+        { :name => "product_name-ru", :locale => "ru"}
+      ])
+      product.name.should eq("product_name")
+      I18n.locale = :ru
+      product.name.should eq("product_name-ru")
+      I18n.locale = :en
+      product.name.should eq("product_name")
+    end
+  end
+
+  context "migrating" do 
+    before(:each) do 
+      Object.send(:remove_const,:Comment) rescue nil
+      c_class = Class.new(ActiveRecord::Base)
+      Object.const_set(:Comment,c_class)
+      c_class.class_eval do 
+        include Lolita::Translation
+        translate :body
+      end
+      ActiveRecord::Base.connection.execute("DROP TABLE comments_translations") rescue nil
+    end
+
+    after(:each) do 
+      Object.send(:remove_const,:Comment) rescue nil
+    end
+
+    it "should sync translation table through migrations" do 
+      ActiveRecord::Base.connection.tables.should_not include("comments_translations")
+      Comment.sync_translation_table!
+      ActiveRecord::Base.connection.tables.should include("comments_translations")
+    end
+  end
+end