i18n_backend_database 0.0.1

data/spec/database_spec.rb

@@ -0,0 +1,199 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe I18n::Backend::Database do
+  describe "an instance" do
+    before {
+      I18n.locale = "es"
+      @locales    = [:en, :es, :it]
+      @locale     = mock_model(Locale, { :code => "es" })
+      Locale.stub!(:available_locales).and_return(@locales)
+      Locale.stub!(:find_by_code).and_return(@locale)
+      @database   = I18n::Backend::Database.new
+    }
+
+    it "should use the current Rails cache store if none are provided" do
+      @database.cache_store.should == Rails.cache
+    end
+
+    it "should use a custom cache store if provided" do
+      @database = I18n::Backend::Database.new({:cache_store => :mem_cache_store})
+      @database.cache_store.class.should == ActiveSupport::Cache::MemCacheStore
+    end
+
+    it "should have default localize text tag if none provided" do
+      @database.localize_text_tag.should == '^^'
+    end
+
+    it "should use custom localize text tag if  provided" do
+      @database = I18n::Backend::Database.new({:localize_text_tag => '##'})
+      @database.localize_text_tag.should == '##'
+    end
+
+    it "should delegate the call to available_locales to the Locale class" do
+      Locale.should_receive(:available_locales)
+      @database.available_locales
+    end
+
+    it "should return all the available locales on a call to available_locales" do
+      @database.available_locales.should == @locales
+    end
+
+    it "should return a cache key of locale:key on call to build_cache_key" do
+      hash_key = Translation.hk("hola me amigo!")
+      Translation.ck(@locale, "hola me amigo!", 1).should == "es:#{hash_key}"
+    end
+
+    it "should generate a Base64 encoded (minus newline), MD5 encrypted hash, based on the key" do
+      encrypted_key = Digest::MD5.hexdigest("aoeuaoeu")
+      completed_key = Translation.hk("aoeuaoeu")
+      encrypted_key.should == Base64.decode64(completed_key).gsub(/\n/, '')
+    end
+
+    it "should have a nil locale cache by default" do
+      @database.locale.should == nil
+    end
+
+    it "should be able to set the locale cache by passing a locale code into locale=" do
+      @database.locale = "es"
+      @database.locale.should == @locale
+    end
+  end
+
+  # describe "omg an aminal" do
+  #   
+  #   before(:each) do
+  #     Locale.instance_variable_set("@validate_callbacks", ActiveSupport::Callbacks::CallbackChain.new)
+  #     Locale.create!(:code => "en")
+  #   end
+  #   
+  #   it "should contain one 'blank' key in the database" do
+  #     Locale.validates_presence_of :code
+  #     l = Locale.new
+  #     l.valid?
+  #     Translation.find_by_value("can't be blank").should_not be_nil
+  #   end
+  # 
+  #   it "should contain one 'blank' key and one custom 'blank' key in the database" do
+  #     Locale.validates_presence_of :code, :message => "ain't blank sucka"
+  #     l = Locale.new
+  #     l.valid?
+  #     Translation.find_by_value("ain't blank sucka").should_not be_nil
+  #     Translation.find_by_value("can't be blank").should be_nil
+  #   end
+  # 
+  #   it "should use the blank code if a custom code is present, but not enabled" do
+  #     Locale.validates_presence_of :code, :message => "ain't blank sucka"
+  # 
+  #     l = Locale.new
+  #     l.valid?
+  #     l.errors_on(:code).should include("ain't blank sucka")
+  # 
+  #     Locale.validates_presence_of :code
+  # 
+  #     l = Locale.new
+  #     l.valid?
+  #     l.errors_on(:code).should include("can't be blank")
+  #   end
+  # end
+
+  describe "translating a key" do
+    describe "for the first time in the default locale" do
+      before {
+        I18n.locale = "en"
+        I18n.default_locale = "en"
+        Locale.create({:code => "en", :name => "English"})
+        @database = I18n::Backend::Database.new
+        @database.translate(:en, "dog")
+      }
+
+      it "should set the value of the translation" do
+        Translation.first.value.should == "dog"
+      end
+    end
+
+    describe "for the first time in an alternate locale" do
+      before {
+        I18n.locale = "es"
+        I18n.default_locale = "en"
+        Locale.create({:code => "en", :name => "English"})
+        Locale.create({:code => "es", :name => "Spanish"})
+        @database = I18n::Backend::Database.new
+        @database.translate(:es, "dog")
+      }
+
+      it "should set the value of the translation to nil" do
+        Translation.first.value.should == nil
+      end
+    end
+  end
+
+  describe "setting a locale in context" do
+    before {
+      I18n.locale = "es"
+      @locale     = mock_model(Locale, { :code => "es" })
+      @database   = I18n::Backend::Database.new
+    }
+
+    describe "on a new instance when the cache locale is nil" do
+      before {
+        Locale.stub!(:find_by_code).and_return(@locale)
+      }
+
+      it "should return a locale record for the current locale in context" do
+        Locale.should_receive(:find_by_code).with(I18n.locale)
+        @database.send(:locale_in_context, I18n.locale)
+      end
+    end
+
+    describe "when passing in a temporary locale that's different from the local cache" do
+      before {
+        Locale.stub!(:find_by_code).with("it").and_return(@locale)
+        @database.locale = "it"
+      }
+
+      it "should return a locale record for the temporary locale" do
+        Locale.should_receive(:find_by_code).with("it")
+        @database.send(:locale_in_context, "it")
+      end
+
+      it "should set the locale to the temporary value" do
+        @database.send(:locale_in_context, "it").should == @locale
+      end
+    end
+
+    describe "when passing in a temporary locale that's the same as the local cache" do
+      before {
+        Locale.stub!(:find_by_code).with("es").and_return(@locale)
+        @database.locale = "es"
+      }
+
+      it "should set the locale to the temporary value" do
+        @database.send(:locale_in_context, "es").should == @locale
+      end
+    end
+
+    describe "when the locale is the same as the cache" do
+      before {
+        Locale.stub!(:find_by_code).with("es").and_return(@locale)
+      }
+
+      it "should update the locale cache with the new locale" do
+        @database.locale = "es"
+        @database.send(:locale_in_context, "es").should == @database.locale
+      end
+    end
+
+    describe "when the locale is different than the cache" do
+      before {
+        Locale.stub!(:find_by_code).with("es").and_return(@locale)
+        I18n.locale = "it"
+      }
+
+      it "should update the locale cache with the new locale" do
+        @database.locale = "es"
+        Locale.should_receive(:find_by_code).with("it")
+        @database.send(:locale_in_context, "it")
+      end
+    end
+  end
+end

data/spec/i18n_ext_spec.rb

@@ -0,0 +1,40 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe I18n do
+
+  describe "with default locale en" do
+    before(:each) do
+      I18n.default_locale = "en"
+    end
+
+    describe "and locale en" do
+      before(:each) do
+        I18n.locale = "en"
+      end
+
+      it "should return empty local segment" do
+        I18n.locale_segment.should == ''
+      end
+
+      it "should return empty local segment using alias" do
+        I18n.ls.should == ''
+      end
+    end
+
+    describe "and locale es" do
+      before(:each) do
+        I18n.locale = "es"
+      end
+
+      it "should return es local segment" do
+        I18n.locale_segment.should == '/es'
+      end
+
+      it "should return es local segment using alias" do
+        I18n.ls.should == '/es'
+      end
+    end
+
+  end
+
+end

data/spec/localize_spec.rb

@@ -0,0 +1,66 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe I18n::Backend::Database do
+  before(:each) do
+    @backend = I18n::Backend::Database.new
+  end
+
+  after(:each) do
+    @backend.cache_store.clear
+  end
+
+  describe "with default locale en" do
+    before(:each) do
+      I18n.default_locale = "en"
+      if File.exists?('vendor/rails/activesupport/lib/active_support/locale/en.yml')
+        I18nUtil.load_from_yml 'vendor/rails/activesupport/lib/active_support/locale/en.yml'
+      else
+        activesupport_gem = Gem.cache.find_name('activesupport').sort_by { |g| g.version.version }.last
+        I18nUtil.load_from_yml "#{activesupport_gem.full_gem_path}/lib/active_support/locale/en.yml"
+      end
+    end
+
+    describe "and locale en" do
+      before(:each) do
+        I18n.locale = "en"
+      end
+
+      it "should localize dates in different formats" do
+        dates = {
+          Date.new(2009,1,1)   => {:default => "2009-01-01", :short => "Jan 01", :long => "January 01, 2009"},
+          Date.new(2009,1,31)  => {:default => "2009-01-31", :short => "Jan 31", :long => "January 31, 2009"},
+          Date.new(2009,2,2)   => {:default => "2009-02-02", :short => "Feb 02", :long => "February 02, 2009"},
+          Date.new(2009,2,28)  => {:default => "2009-02-28", :short => "Feb 28", :long => "February 28, 2009"},
+          Date.new(2008,2,29)  => {:default => "2008-02-29", :short => "Feb 29", :long => "February 29, 2008"},
+          Date.new(2009,3,11)  => {:default => "2009-03-11", :short => "Mar 11", :long => "March 11, 2009"},
+          Date.new(2010,4,30)  => {:default => "2010-04-30", :short => "Apr 30", :long => "April 30, 2010"},
+          Date.new(2020,12,31) => {:default => "2020-12-31", :short => "Dec 31", :long => "December 31, 2020"}
+        }
+
+        dates.each do |date, formats|
+          formats.each do |format, expected_value|
+            @backend.localize("en", date, format).should == expected_value
+          end
+        end
+      end
+
+      it "should localize times in different formats" do
+        time = DateTime.new(y=2008,m=3,d=22,h=16,min=30,s=12)
+
+        @backend.localize("en", time, :default).should == "Sat, 22 Mar 2008 16:30:12 +0000"
+        @backend.localize("en", time, :short).should == "22 Mar 16:30"
+        @backend.localize("en", time, :long).should == "March 22, 2008 16:30"
+        @backend.localize("en", time, '%B %d, %Y %H:%M %p').should == "March 22, 2008 16:30 pm"
+      end
+
+    end
+
+    describe "and locale es" do
+      before(:each) do
+        I18n.locale = "es"
+        @spanish_locale = Locale.create!(:code => 'es')
+      end
+
+    end
+  end
+end

data/spec/localize_text_spec.rb

@@ -0,0 +1,76 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe I18n::Backend::Database do
+  before(:each) do
+    @backend = I18n::Backend::Database.new
+  end
+
+  after(:each) do
+    @backend.cache_store.clear
+  end
+
+  describe "with default locale en" do
+    before(:each) do
+      I18n.default_locale = "en"
+      @english_locale = Locale.create!(:code => "en")
+    end
+
+    describe "and locale en" do
+      before(:each) do
+        I18n.locale = "en"
+      end
+
+      it "should localize tagged text" do
+        @backend.localize_text("en", "shane ^^is now friends with^^ dylan").should == "shane is now friends with dylan"
+      end
+
+      it "should localize text tagged more than once" do
+        @backend.localize_text("en", "dylan ^^is now friends with^^ shane ^^and is happy, ^^dylan ^^claps his hands!^^").should == "dylan is now friends with shane and is happy, dylan claps his hands!"
+      end
+
+      it "should localize tagged text using class method" do
+        I18n.localize_text("shane ^^is now friends with^^ dylan").should == "shane is now friends with dylan"
+      end
+
+      it "should localize tagged text using class method alias" do
+        I18n.lt("shane ^^is now friends with^^ dylan").should == "shane is now friends with dylan"
+      end
+
+      it "should add localize text tags" do
+        I18n.tag_localized_text("is now friends with").should == "^^is now friends with^^"
+      end
+
+      it "should add localize text tags using alias" do
+        I18n.tlt("is now friends with").should == "^^is now friends with^^"
+      end
+
+      it "should just return text with no localize text tags" do
+        @backend.localize_text("en", "shane is now friends with dylan").should == "shane is now friends with dylan"
+      end
+
+      it "should localize tagged text using custom localize text tag" do
+        @backend.localize_text_tag = "##"
+        @backend.localize_text("en", "shane ##is now friends with## dylan").should == "shane is now friends with dylan"
+      end
+
+      it "should localize tagged text using another custom localize text tag" do
+        @backend.localize_text_tag = "LOCALIZED_TEXT_TAG"
+        @backend.localize_text("en", "shane LOCALIZED_TEXT_TAGis now friends withLOCALIZED_TEXT_TAG dylan").should == "shane is now friends with dylan"
+      end
+
+    end
+
+    describe "and locale es" do
+      before(:each) do
+        I18n.locale = "es"
+        @spanish_locale = Locale.create!(:code => 'es')
+      end
+
+      it "should localize tagged text" do
+        @spanish_locale.translations.create!(:key => 'is now friends with', :value => 'ahora es con amigos')
+        @backend.localize_text("es", "shane ^^is now friends with^^ dylan").should == "shane ahora es con amigos dylan"
+      end
+
+    end
+  end
+end

data/spec/models/locale_spec.rb

@@ -0,0 +1,111 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Locale do
+  before(:each) do
+    @valid_attributes = {
+      :code => "en",
+      :name => "English"
+    }
+  end
+
+  it "should create a new instance given valid attributes" do
+    Locale.create!(@valid_attributes)
+  end
+
+  it "should return code as to_param" do
+    Locale.new(@valid_attributes).to_param.should == 'en'
+  end
+
+  it "should be invalid with no code" do
+    Locale.create!(:code => "en")
+    locale = Locale.new
+    locale.should_not be_valid
+  end
+end
+
+
+describe "English and Spanish Locales with I18n default locale set to English" do
+  before(:each) do
+    I18n.default_locale = "en"
+    @english_locale = Locale.create!(:code => "en")
+    @spanish_locale = Locale.create!(:code => "es")
+  end
+
+  it "should create a translated translation using english locale" do
+    translation = @english_locale.create_translation('Hello World', 'Hello World')
+    translation.key.should == Translation.hk('Hello World')
+    translation.value.should == 'Hello World'
+  end
+
+  it "should create an untranslated translation using spanish locale" do
+    translation = @spanish_locale.create_translation('Hello World', 'Hello World')
+    translation.key.should == Translation.hk('Hello World')
+    translation.value.should be_nil
+  end
+
+  it "should return default locale of English" do
+    Locale.default_locale.should == @english_locale
+  end
+
+  it "should return list of non-default locales" do
+    @geek_locale = Locale.create!(:code => "gk")
+    Locale.non_defaults.should include(@spanish_locale)
+    Locale.non_defaults.should include(@geek_locale)
+    Locale.non_defaults.should_not include(@english_locale)
+  end
+
+  it "should know that the english_locale is the default" do
+    @english_locale.should be_default_locale
+  end
+
+  it "should know if it has a translation record" do
+    translation = @english_locale.create_translation('key', 'Hello World')
+    @english_locale.should have_translation('key')
+  end
+
+  it "should have 0 translations" do
+    @spanish_locale.should have(0).translations
+  end
+
+  it "should have 0 untranslated" do
+    @spanish_locale.translations.untranslated.should have(0).records
+  end
+
+  it "should have 0 translated" do
+    @spanish_locale.translations.translated.should have(0).records
+  end
+
+  it "should have 100% translated" do
+    @spanish_locale.percentage_translated.should == 100
+  end
+
+end
+
+describe "Locale with translations" do
+  before(:each) do
+    I18n.default_locale = "en"
+    @english_locale = Locale.create!(:code => "en")
+    @spanish_locale = Locale.create!(:code => "es")
+
+    @spanish_locale.translations.create!(:key => 'key1', :value => 'translated1')
+    @spanish_locale.translations.create!(:key => 'key2', :value => 'translated2')
+    @spanish_locale.translations.create!(:key => 'key3', :value =>  nil) # 1 untranslated record
+  end
+
+  it "should have 3 translations" do
+    @spanish_locale.should have(3).translations
+  end
+
+  it "should have 1 untranslated" do
+    @spanish_locale.translations.untranslated.should have(1).records
+  end
+
+  it "should have 2 translated" do
+    @spanish_locale.translations.translated.should have(2).records
+  end
+
+  it "should have 67% translated" do
+    @spanish_locale.percentage_translated.should == 67
+  end
+
+end