i18n_backend_database_rails3 0.2.0

data/spec/controllers/locales_routing_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe LocalesController do
+  describe "route generation" do
+    it "should map #index" do
+      route_for(:controller => "locales", :action => "index").should == "/locales"
+    end
+  
+    it "should map #new" do
+      route_for(:controller => "locales", :action => "new").should == "/locales/new"
+    end
+  
+    it "should map #show" do
+      route_for(:controller => "locales", :action => "show", :id => "1").should == "/locales/1"
+    end
+  
+    it "should map #edit" do
+      route_for(:controller => "locales", :action => "edit", :id => "1").should == "/locales/1/edit"
+    end
+  
+    it "should map #update" do
+      route_for(:controller => "locales", :action => "update", :id => "1").should == {:path => "/locales/1", :method => :put}
+    end
+  
+    it "should map #destroy" do
+      route_for(:controller => "locales", :action => "destroy", :id => "1").should == {:path => "/locales/1", :method => :delete}
+    end
+  end
+
+  describe "route recognition" do
+    it "should generate params for #index" do
+      params_from(:get, "/locales").should == {:controller => "locales", :action => "index"}
+    end
+  
+    it "should generate params for #new" do
+      params_from(:get, "/locales/new").should == {:controller => "locales", :action => "new"}
+    end
+  
+    it "should generate params for #create" do
+      params_from(:post, "/locales").should == {:controller => "locales", :action => "create"}
+    end
+  
+    it "should generate params for #show" do
+      params_from(:get, "/locales/1").should == {:controller => "locales", :action => "show", :id => "1"}
+    end
+  
+    it "should generate params for #edit" do
+      params_from(:get, "/locales/1/edit").should == {:controller => "locales", :action => "edit", :id => "1"}
+    end
+  
+    it "should generate params for #update" do
+      params_from(:put, "/locales/1").should == {:controller => "locales", :action => "update", :id => "1"}
+    end
+  
+    it "should generate params for #destroy" do
+      params_from(:delete, "/locales/1").should == {:controller => "locales", :action => "destroy", :id => "1"}
+    end
+  end
+end

data/spec/controllers/translations_controller_spec.rb

@@ -0,0 +1,189 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe TranslationsController do
+
+  def mock_locale(stubs={})
+    stubs = {
+      :translations => mock("Array of Translations"),
+      :to_param     => 'en'
+    }.merge(stubs)
+    
+    @mock_locale ||= mock_model(Locale, stubs)
+  end
+  
+  def mock_translation(stubs={})
+    stubs = {
+      :value => nil
+    }.merge(stubs)
+    @mock_translation ||= mock_model(Translation, stubs)
+  end
+  
+  before(:each) do
+    Locale.should_receive(:find_by_code).with('en').and_return(mock_locale)
+  end
+  
+  describe "responding to GET index" do
+
+    it "should expose all translations as @translations" do
+      mock_locale.translations.should_receive(:find).with(:all, {:order=>"raw_key, pluralization_index"}).and_return([mock_translation])
+      get :index, :locale_id => "en"
+      assigns[:translations].should == [mock_translation]
+    end
+
+    describe "with mime type of xml" do
+  
+      it "should render all translations as xml" do
+        request.env["HTTP_ACCEPT"] = "application/xml"
+        mock_locale.translations.should_receive(:find).with(:all, {:order=>"raw_key, pluralization_index"}).and_return(translations = mock("Array of Translations"))
+        translations.should_receive(:to_xml).and_return("generated XML")
+        get :index, :locale_id => "en"
+        response.body.should == "generated XML"
+      end
+    
+    end
+
+  end
+
+  describe "responding to GET show" do
+
+    it "should expose the requested translation as @translation" do
+      mock_locale.translations.should_receive(:find).with("37").and_return(mock_translation)
+      get :show, :locale_id => "en", :id => "37"
+      assigns[:translation].should equal(mock_translation)
+    end
+    
+    describe "with mime type of xml" do
+
+      it "should render the requested translation as xml" do
+        request.env["HTTP_ACCEPT"] = "application/xml"
+        mock_locale.translations.should_receive(:find).with("37").and_return(mock_translation)
+        mock_translation.should_receive(:to_xml).and_return("generated XML")
+        get :show, :locale_id => "en", :id => "37"
+        response.body.should == "generated XML"
+      end
+
+    end
+    
+  end
+
+  describe "responding to GET new" do
+  
+    it "should expose a new translation as @translation" do
+      Translation.should_receive(:new).and_return(mock_translation)
+      get :new, :locale_id => "en"
+      assigns[:translation].should equal(mock_translation)
+    end
+
+  end
+
+  describe "responding to GET edit" do
+  
+    it "should expose the requested translation as @translation" do
+      mock_locale.translations.should_receive(:find).with("37").and_return(mock_translation)
+      get :edit, :locale_id => "en", :id => "37"
+      assigns[:translation].should equal(mock_translation)
+    end
+
+  end
+
+  describe "responding to POST create" do
+
+    describe "with valid params" do
+      
+      it "should expose a newly created translation as @translation" do
+        mock_locale.translations.should_receive(:build).with({'these' => 'params'}).and_return(mock_translation(:save => true))
+        post :create, :locale_id => "en", :translation => {:these => 'params'}
+        assigns(:translation).should equal(mock_translation)
+      end
+
+      it "should redirect to the created translation" do
+        mock_locale.translations.stub!(:build).and_return(mock_translation(:save => true))
+        post :create, :locale_id => "en", :translation => {}
+        response.should redirect_to(locale_translation_url(mock_locale, mock_translation))
+      end
+      
+    end
+    
+    describe "with invalid params" do
+
+      it "should expose a newly created but unsaved translation as @translation" do
+        mock_locale.translations.stub!(:build).with({'these' => 'params'}).and_return(mock_translation(:save => false))
+        post :create, :locale_id => "en", :translation => {:these => 'params'}
+        assigns(:translation).should equal(mock_translation)
+      end
+
+      it "should re-render the 'new' template" do
+        mock_locale.translations.stub!(:build).and_return(mock_translation(:save => false))
+        post :create, :locale_id => "en", :translation => {}
+        response.should render_template('new')
+      end
+      
+    end
+    
+  end
+
+  describe "responding to PUT udpate" do
+
+    describe "with valid params" do
+
+      it "should update the requested translation" do
+        mock_locale.translations.should_receive(:find).with("37").and_return(mock_translation)
+        mock_translation.should_receive(:update_attributes).with({'these' => 'params'})
+        put :update, :locale_id => "en", :id => "37", :translation => {:these => 'params'}
+      end
+
+      it "should expose the requested translation as @translation" do
+        mock_locale.translations.stub!(:find).and_return(mock_translation(:update_attributes => true))
+        put :update, :locale_id => "en", :id => "1"
+        assigns(:translation).should equal(mock_translation)
+      end
+
+      it "should redirect to the translation" do
+        mock_locale.translations.stub!(:find).and_return(mock_translation(:update_attributes => true))
+        put :update, :locale_id => "en", :id => "1"
+        response.should redirect_to(locale_translation_url(mock_locale, mock_translation))
+      end
+
+    end
+    
+    describe "with invalid params" do
+
+      it "should update the requested translation" do
+        mock_locale.translations.should_receive(:find).with("37").and_return(mock_translation)
+        mock_translation.should_receive(:update_attributes).with({'these' => 'params'})
+        put :update, :locale_id => "en", :id => "37", :translation => {:these => 'params'}
+      end
+
+      it "should expose the translation as @translation" do
+        mock_locale.translations.stub!(:find).and_return(mock_translation(:update_attributes => false))
+        put :update, :locale_id => "en", :id => "1"
+        assigns(:translation).should equal(mock_translation)
+      end
+
+      it "should re-render the 'edit' template" do
+        mock_locale.translations.stub!(:find).and_return(mock_translation(:update_attributes => false))
+        put :update, :locale_id => "en", :id => "1"
+        response.should render_template('edit')
+      end
+
+    end
+
+  end
+
+  describe "responding to DELETE destroy" do
+
+    it "should destroy the requested translation" do
+      mock_locale.translations.should_receive(:find).with("37").and_return(mock_translation)
+      mock_translation.should_receive(:destroy)
+      delete :destroy, :locale_id => "en", :id => "37"
+    end
+  
+    it "should redirect to the translations list" do
+      mock_locale.translations.stub!(:find).and_return(mock_translation(:destroy => true))
+      delete :destroy, :locale_id => "en", :id => "1"
+      response.should redirect_to(locale_translations_url(mock_locale))
+    end
+
+  end
+
+end

data/spec/controllers/translations_routing_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe TranslationsController do
+  describe "route generation" do
+    it "should map #index" do
+      route_for(:controller => "translations", :action => "index", :locale_id => "en").should == "/locales/en/translations"
+    end
+  
+    it "should map #new" do
+      route_for(:controller => "translations", :action => "new", :locale_id => "en").should == "/locales/en/translations/new"
+    end
+  
+    it "should map #show" do
+      route_for(:controller => "translations", :action => "show", :id => "1", :locale_id => "en").should == "/locales/en/translations/1"
+    end
+  
+    it "should map #edit" do
+      route_for(:controller => "translations", :action => "edit", :id => "1", :locale_id => "en").should == "/locales/en/translations/1/edit"
+    end
+  
+    it "should map #update" do
+      route_for(:controller => "translations", :action => "update", :id => "1", :locale_id => "en").should == {:path => "/locales/en/translations/1", :method => :put}
+    end
+  
+    it "should map #destroy" do
+      route_for(:controller => "translations", :action => "destroy", :id => "1", :locale_id => "en").should == {:path => "/locales/en/translations/1", :method => :delete}
+    end
+  end
+
+  describe "route recognition" do
+    it "should generate params for #index" do
+      params_from(:get, "/locales/en/translations").should == {:controller => "translations", :action => "index", :locale_id => "en"}
+    end
+  
+    it "should generate params for #new" do
+      params_from(:get, "/locales/en/translations/new").should == {:controller => "translations", :action => "new", :locale_id => "en"}
+    end
+  
+    it "should generate params for #create" do
+      params_from(:post, "/locales/en/translations").should == {:controller => "translations", :action => "create", :locale_id => "en"}
+    end
+  
+    it "should generate params for #show" do
+      params_from(:get, "/locales/en/translations/1").should == {:controller => "translations", :action => "show", :id => "1", :locale_id => "en"}
+    end
+  
+    it "should generate params for #edit" do
+      params_from(:get, "/locales/en/translations/1/edit").should == {:controller => "translations", :action => "edit", :id => "1", :locale_id => "en"}
+    end
+  
+    it "should generate params for #update" do
+      params_from(:put, "/locales/en/translations/1").should == {:controller => "translations", :action => "update", :id => "1", :locale_id => "en"}
+    end
+  
+    it "should generate params for #destroy" do
+      params_from(:delete, "/locales/en/translations/1").should == {:controller => "translations", :action => "destroy", :id => "1", :locale_id => "en"}
+    end
+  end
+end

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