activerecord_translatable 0.0.1 → 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d0a2bb1ba9aa75761f54be04bfddf1c8d981849
+  data.tar.gz: 48473b568dc9efb170db0432700b5edacee7b829
+SHA512:
+  metadata.gz: ec2b82cb27170bef276f5547e7a6c549118ef987c530cadad1941d42846fd019fc70847e1fa2f9c6e8fc2137e843830f8388839ce8035e3ae887087cc1799560
+  data.tar.gz: 4b063afdc3ab348cff5cdbd4127f24848d486a9e3e595af859ecd8214db5681d655716fd0c7ed4241bf8ec0aa16af34e2184e036662eb62577101ef5cd427e1c

data/README.rdoc

@@ -1,23 +1,25 @@
+{<img src="https://travis-ci.org/sideshowcoder/activerecord_translatable.png" />}[https://travis-ci.org/sideshowcoder/activerecord_translatable]
+
 = ActiveRecordTranslatable
 
 Make attributes of an ActiveRecord Model translatable, and store the
 translations in the provided I18n backend.  This is really helpful if there
-already is, a interface to provide ie missing translations for elements in I18n. 
+already is, a interface to provide ie missing translations for elements in I18n.
 
 == Usage
+Use inside of the model
 
-class MyModel < ActiveRecord::Base
-  include ActiveRecordTranslatable
-  translate :title
-end
+  class MyModel < ActiveRecord::Base
+    translate :title
+  end
 
-I18n.locale = :en
-mymodel = MyModel.create(title: "My title", title_de: "Mein Title)
-mymodel.title_wk = "Woohhaakkk"
+  I18n.locale = :en
+  mymodel = MyModel.create(title: "My title", title_de: "Mein Title)
+  mymodel.title_wk = "Woohhaakkk"
 
-mymodel.title # => "My title"
-mymodel.title_en # => "My title"
-mymodel.title_wk # => "Woohhaakkk"
+  mymodel.title # => "My title"
+  mymodel.title_en # => "My title"
+  mymodel.title_wk # => "Woohhaakkk"
 
 == Prerequisites
 To save the locales ActiveRecordTranslatable saves an array of the specified locale, for
@@ -28,19 +30,37 @@ gem 'activerecord-postgres-array'
 
 To add the array to the model the migration looks like this
 
-class CreateMyModel < ActiveRecord::Migration
-  def change
-    create_table :my_model do |t|
-      t.string_array :locales
+  class CreateMyModel < ActiveRecord::Migration
+    def change
+      create_table :my_model do |t|
+        t.string_array :locales
+      end
+    end
+  end
+
+If your database does not support native array types you can use ActiveRecords
+ability to serialize the locales array
+
+  class MyModel < ActiveRecord::Base
+    serialize :locales
+    translate :name
+  end
+
+And add the column as a string
+
+  class CreateMyModel < ActiveRecord::Migration
+    def change
+      create_table :my_model do |t|
+        t.string :locales
+      end
     end
   end
-end
 
 == How it works
 
-Translateable saves the translation via I18n.backend.store_translations, this 
-means that the backend has to be able to store new items. So backend needs to 
-be for example the KeyValue or ActiveRecord one. 
+Translateable saves the translation via I18n.backend.store_translations, this
+means that the backend has to be able to store new items. So backend needs to
+be for example the KeyValue or ActiveRecord one.
 More http://railscasts.com/episodes/256-i18n-backends
 
 == Miscellaneous
@@ -51,7 +71,7 @@ Since the example is using postgres, to get the tests working there needs to be
 a setup postgres user with the needed rights.
 
   $ createuser -h localhost
-  Enter name of role to add: translatable 
+  Enter name of role to add: translatable
   Shall the new role be a superuser? (y/n) n
   Shall the new role be allowed to create databases? (y/n) y
   Shall the new role be allowed to create more new roles? (y/n) n
@@ -64,8 +84,8 @@ Afterwards the db needs to be setup
   $ rake db:test:prepare
 
 Now the test can be run via
-  
-  $ rspec 
+
+  $ rspec
 
 === Current State
 The gem is still in early development and has just been extracted from a

data/lib/activerecord_translatable.rb

@@ -1,9 +1,26 @@
 require "active_record"
 require "active_support/concern"
+require "rails"
 require "activerecord_translatable/extension"
 
 module ActiveRecordTranslatable
 
-  VERSION = "0.0.1"
+  class Railtie < Rails::Railtie
+    initializer "activerecord_translatable.load_into_active_record" do
+      ActiveSupport.on_load :active_record do
+        ActiveRecordTranslatable::Railtie.load
+      end
+    end
+  end
+
+  class Railtie
+    class << self
+      def load
+        if defined?(ActiveRecord)
+          ActiveRecord::Base.send(:include, ActiveRecordTranslatable)
+        end
+      end
+    end
+  end
 
 end

data/lib/activerecord_translatable/extension.rb

@@ -3,43 +3,63 @@ module ActiveRecordTranslatable
 
   attr_accessor :translations
 
+  def translatable
+    self._translatable[base_name]
+  end
+
+  def available_locales
+    self.locales.map { |locale| locale.to_sym }
+  end
+
   def setup_locale(locale)
     locales = self.locales || []
     locales << locale.to_s
     self.locales = locales.uniq
-    @translations ||= {}
-    @translations[locale] ||= {}
   end
 
-  def available_locales
-    self.locales.map { |locale| locale.to_sym }   
+  def translations
+    @translations ||= Hash.new { |h,k| h[k] = {} }
+  end
+
+  def base_name
+    self.class.name.downcase
   end
 
   def translation(attribute, locale = I18n.locale)
-    setup_locale(locale)
     begin
-      @translations[locale][attribute] ||= I18n.t("#{self.base_name}.#{attribute}-#{self.id}",
-                                                  locale: locale, raise: true)
+      translation = translations.fetch(locale).fetch(attribute)
+    rescue KeyError
+      _get_stored_translation(attribute, locale)
+    end
+  end
+
+  def _get_stored_translation(attribute, locale)
+    begin
+      translation = I18n.t("#{base_name}.#{attribute}-#{self.id}", locale: locale, raise: true)
+      setup_locale(locale)
+      translations[locale][attribute] = translation
     rescue I18n::MissingTranslationData
-      @translations[locale][attribute]
+      nil
     end
   end
 
   def set_translation(attribute, value, locale = I18n.locale)
     setup_locale(locale)
-    @translations[locale][attribute] = value
+    translations[locale][attribute] = value
   end
-  
+
   def write_translations
-    @translations.each do |locale, translations|
-      translations.each do |attribute, value|
-        I18n.backend.store_translations(locale, { "#{self.base_name}.#{attribute}-#{self.id}" => value }, escape: false)
+    return if translations.empty? # there are no translations to be saved
+
+    translations.each do |locale, trans|
+      trans.each do |attribute, value|
+        I18n.backend.store_translations(locale, { "#{base_name}.#{attribute}-#{self.id}" => value }, escape: false)
       end
     end
   end
 
   def method_missing(method_name, *arguments, &block)
-    self.translateable.each do |attribute|
+    translatable.each do |attribute|
       attribute = attribute.to_s
       if method_name.to_s =~ /^#{attribute}_(.{2})=$/
         return set_translation(attribute, arguments.first, $1.to_sym)
@@ -53,9 +73,9 @@ module ActiveRecordTranslatable
     end
     super
   end
-  
+
   def respond_to_missing?(method_name, include_private = false)
-    self.translateable.each do |attribute|
+    translatable.each do |attribute|
       attribute = attribute.to_s
       if method_name.to_s =~ /^#{attribute}_(.{2})=$/
         return true
@@ -72,14 +92,22 @@ module ActiveRecordTranslatable
 
   included do
     after_save :write_translations
-    cattr_accessor :translateable, :base_name
+    cattr_accessor :_translatable
   end
 
   module ClassMethods
     def translate(*attributes)
-      self.base_name = self.name.downcase
-      self.translateable ||= []
-      self.translateable = self.translateable.concat(attributes)
+      self._translatable ||= Hash.new { |h,k| h[k] = [] }
+      self._translatable[base_name] = translatable.concat(attributes).uniq
+    end
+
+    def translatable
+      self._translatable[base_name] ||= []
+    end
+
+    private
+    def base_name
+      self.name.downcase
     end
   end
 

data/lib/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecordTranslatable
+
+  VERSION = "0.0.2"
+
+end

data/spec/activerecord_translateable_spec.rb

@@ -3,9 +3,21 @@ require 'spec_helper'
 describe "ActiveRecordTranslateable" do
 
     it "should add name to translateable" do
-      Something.translateable.should include(:name)
+      Something.translatable.should include(:name)
     end
 
+    context "class without translations" do
+      it "should save" do
+        foo = Foo.new
+        foo.save.should be_true
+      end
+      it "should load" do
+        foo = Foo.create!
+        Foo.find(foo.id).should_not be_nil
+      end
+    end
+
+
     context "translations" do
       before(:each) do
         @something = Something.create!(name: "Something")
@@ -37,7 +49,7 @@ describe "ActiveRecordTranslateable" do
         @something.set_translation("name", "Etwas")
         @something.translation("name", :de).should == "Etwas"
       end
-    
+
       it "should write the stored translations to the backend" do
         backend = double("Backend")
         I18n.stub(:backend).and_return(backend)
@@ -46,6 +58,42 @@ describe "ActiveRecordTranslateable" do
         @something.write_translations
       end
 
+      it "should save the model without translations" do
+        something = Something.new
+        something.save.should be_true
+      end
+
+    end
+
+    context "trigger save on model change" do
+      before(:each) do
+        @backend = double("Backend")
+        I18n.stub(:backend).and_return(@backend)
+      end
+      it "should save translations on save" do
+        @backend.should_receive(:store_translations).twice
+        Something.new(name: 'something', name_de: 'etwas').save
+      end
+
+      it "should save translations on create" do
+        @backend.should_receive(:store_translations).twice
+        Something.create(name: 'something', name_de: 'etwas')
+      end
+
+      it "should save translations on update" do
+        @backend.should_receive(:store_translations).exactly(4)
+        sth = Something.create(name: 'something_old', name_de: 'etwas_old')
+        sth.update_attributes(name: 'something', name_de: 'etwas')
+      end
+    end
+
+    context "don't set locales on read" do
+      let(:something) { Something.create!(name: "Something") }
+
+      it "should not include a read locale unless set to something" do
+        something.name_gr
+        something.locales.should_not include("gr")
+      end
     end
 
     context "custom created methods" do
@@ -67,7 +115,7 @@ describe "ActiveRecordTranslateable" do
 
     end
 
-    context "locales" do
+    context "locales with db array support" do
       let(:something) { Something.create!(name: "Something") }
 
       it "should respond with available locales" do
@@ -75,7 +123,16 @@ describe "ActiveRecordTranslateable" do
         something.name_de = "Etwas"
         something.available_locales.should include(:en, :de)
       end
-      
+
+    end
+
+    context "locales without db array support" do
+      let(:thing) { Noarraything.create!(name: "thing", name_de: "ding") }
+
+      it "should store the locales as array" do
+        locales = thing.locales
+        thing.reload.locales.should == locales
+      end
     end
 
 end

data/spec/dummy/app/models/foo.rb

@@ -0,0 +1,2 @@
+class Foo < ActiveRecord::Base
+end

data/spec/dummy/app/models/noarraything.rb

@@ -0,0 +1,4 @@
+class Noarraything < ActiveRecord::Base
+  serialize :locales
+  translate :name
+end

data/spec/dummy/app/models/something.rb

@@ -1,5 +1,3 @@
 class Something < ActiveRecord::Base
-  include ActiveRecordTranslatable
-
   translate :name
 end

data/spec/dummy/config/database.yml

@@ -3,7 +3,7 @@ development:
   encoding: unicode
   database: translatable_development
   pool: 5
-  username: translatable 
+  username: translatable
   password:
   host: localhost
 
@@ -15,7 +15,7 @@ test:
   encoding: unicode
   database: translatable_test
   pool: 5
-  username: translatable 
+  username: postgres
   password:
   host: localhost
 
@@ -24,6 +24,6 @@ production:
   encoding: unicode
   database: translatable_production
   pool: 5
-  username: translatable 
+  username: translatable
   password:
   host: localhost

data/spec/dummy/db/migrate/20130124094113_create_foo.rb

@@ -0,0 +1,7 @@
+class CreateFoo < ActiveRecord::Migration
+  def change
+    create_table :foos do |t|
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/migrate/20130124100555_create_noarraythings.rb

@@ -0,0 +1,9 @@
+class CreateNoarraythings < ActiveRecord::Migration
+  def change
+    create_table :noarraythings do |t|
+      t.string :locales
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -11,7 +11,18 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20121015083259) do
+ActiveRecord::Schema.define(:version => 20130124100555) do
+
+  create_table "foos", :force => true do |t|
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
+
+  create_table "noarraythings", :force => true do |t|
+    t.string   "locales"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
 
   create_table "somethings", :force => true do |t|
     t.string_array "locales",    :limit => 255