i18n_backend_database_rails3 0.2.0

data/lib/routing.rb

@@ -0,0 +1,15 @@
+module I18n 
+  module BackendDatabase 
+    module Routing 
+      # Loads the set of routes from within a plugin and 
+      # evaluates them at this point within an application’s 
+      # main routes.rb file. 
+      def from_plugin(name) 
+        map = self # to make 'map' available within the plugin route file
+        plugin_root = File.join(RAILS_ROOT, 'vendor', 'plugins') 
+        routes_path = File.join(plugin_root, name.to_s, 'routes.rb') 
+        eval(IO.read(routes_path), binding, routes_path) if File.file?(routes_path)
+      end
+    end 
+  end 
+end 

data/lib/views/layouts/translations.html.haml

@@ -0,0 +1,16 @@
+!!!
+%html{:lang => "en", "xml:lang" => "en", :xmlns => "http://www.w3.org/1999/xhtml"}
+  %head
+    %meta{:content => "text/html;charset=UTF-8", "http-equiv" => "content-type"}/
+    %title
+      Translation Administration: #{controller.action_name}
+    = stylesheet_link_tag 'scaffold'
+    = javascript_include_tag :defaults
+    = javascript_include_tag 'jsProgressBarHandler.js'
+  %body
+    %p
+      = link_to 'Textual Translations', translations_url
+      \· #{link_to 'Asset Translations', asset_translations_url}
+  %body.content
+    .content
+      = yield

data/lib/views/locales/edit.html.haml

@@ -0,0 +1,16 @@
+%h1 Editing locale
+- form_for(@locale) do |f|
+  = f.error_messages
+  %p
+    = f.label :code
+    %br/
+    = f.text_field :code
+  %p
+    = f.label :name
+    %br/
+    = f.text_field :name
+  %p
+    = f.submit "Update"
+= link_to 'Show', @locale
+|
+\#{link_to 'Back', locales_path}

data/lib/views/locales/index.html.haml

@@ -0,0 +1,14 @@
+%h1 Listing locales
+%table
+  %tr
+    %th Code
+    %th Name
+  - for locale in @locales
+    %tr
+      %td= h locale.code
+      %td= h locale.name
+      %td= link_to 'Show', locale
+      %td= link_to 'Edit', edit_locale_path(locale)
+      %td= link_to 'Destroy', locale, :confirm => 'Are you sure?', :method => :delete
+%br/
+= link_to 'New locale', new_locale_path

data/lib/views/locales/new.html.haml

@@ -0,0 +1,14 @@
+%h1 New locale
+- form_for(@locale) do |f|
+  = f.error_messages
+  %p
+    = f.label :code
+    %br/
+    = f.text_field :code
+  %p
+    = f.label :name
+    %br/
+    = f.text_field :name
+  %p
+    = f.submit "Create"
+= link_to 'Back', locales_path

data/lib/views/locales/show.html.haml

@@ -0,0 +1,10 @@
+%p
+  %b Code:
+  = h @locale.code
+%p
+  %b Name:
+  = h @locale.name
+= link_to 'Edit', edit_locale_path(@locale)
+|
+\#{link_to 'Translations', locale_translations_path(@locale)} |
+\#{link_to 'Back', locales_path}

data/lib/views/translations/asset_translations.html.haml

@@ -0,0 +1,23 @@
+- form_tag asset_translations_url do
+  = select_tag :locale_id,    options_from_collection_for_select(Locale.all, :code, :name, @locale.code)
+  = select_tag :translation_option, options_from_collection_for_select(TranslationOption.all, :code, :description, @translation_option.code)
+  = submit_tag 'Go'
+:javascript
+  Event.observe(window, 'load', function() {
+      myJsProgressBarHandler = new JS_BRAMUS.jsProgressBar($('translate_progress'), 0);
+  }, false);
+%p
+  Asset Translation progress:
+  %span#translate_progress.progressBar= @percentage_translated
+%h2
+  = @translation_option.description
+  \: #{@locale.name}
+- if @asset_translations.empty?
+  %h3 No records for this criteria.
+- for asset in @asset_translations
+  %p
+    = image_tag(asset, :size => "50x50")
+    = link_to(asset, image_path(asset))
+    - if !@locale.default_locale? && @translation_option == TranslationOption.translated
+      = image_tag(I18n.ta(asset, :locale => @locale.code), :size => "50x50")
+      = link_to(asset, image_path(I18n.ta(asset, :locale => @locale.code)))

data/lib/views/translations/edit.html.haml

@@ -0,0 +1,24 @@
+%h1
+  Editing translation for #{@locale.code}
+%p
+  %b Key:
+  = h @translation.key
+%p
+  %b Raw Key:
+  = h @translation.raw_key
+%p
+  %b Pluralization Index:
+  = h @translation.pluralization_index
+%p
+  %b Default Locale Value:
+  = h @translation.default_locale_value
+- form_for([@locale, @translation]) do |f|
+  = f.error_messages
+  = f.label :value
+  %br/
+  = f.text_field :value
+  %p
+    = f.submit "Update"
+= link_to 'Show', locale_translation_path(@locale, @translation)
+|
+\#{link_to 'Back', locale_translations_path}

data/lib/views/translations/index.html.haml

@@ -0,0 +1,21 @@
+%h1
+  Listing translations for #{@locale.code}
+%table
+  %tr
+    %th Key
+    %th Raw Key
+    %th Value
+    %th Default Locale Value
+  - for translation in @translations
+    %tr
+      %td= h translation.key
+      %td= h translation.raw_key
+      %td= h translation.value
+      %td= h translation.default_locale_value
+      %td= link_to 'Show', locale_translation_path(@locale, translation)
+      %td= link_to 'Edit', edit_locale_translation_path(@locale, translation)
+      %td= link_to 'Destroy', locale_translation_path(@locale, translation), :confirm => 'Are you sure?', :method => :delete
+%br/
+= link_to 'New translation', new_locale_translation_path
+|
+\#{link_to 'Back', locales_path}

data/lib/views/translations/new.html.haml

@@ -0,0 +1,14 @@
+%h1 New translation
+- form_for([@locale, @translation]) do |f|
+  = f.error_messages
+  %p
+    = f.label :key
+    %br/
+    = f.text_field :key
+  %p
+    = f.label :value
+    %br/
+    = f.text_field :value
+  %p
+    = f.submit "Create"
+= link_to 'Back', locale_translations_path

data/lib/views/translations/show.html.haml

@@ -0,0 +1,21 @@
+%p
+  %b Locale:
+  = h @locale.code
+%p
+  %b Key:
+  = h @translation.key
+%p
+  %b Raw Key:
+  = h @translation.raw_key
+%p
+  %b Pluralization Index:
+  = h @translation.pluralization_index
+%p
+  %b Default Locale Value:
+  = h @translation.default_locale_value
+%p
+  %b Value:
+  = h @translation.value
+= link_to 'Edit', edit_locale_translation_path(@locale, @translation)
+|
+\#{link_to 'Back', locale_translations_path}

data/lib/views/translations/translations.html.haml

@@ -0,0 +1,20 @@
+- form_tag translations_url do
+  = select_tag :locale_id,    options_from_collection_for_select(Locale.all, :code, :name, @locale.code)
+  = select_tag :translation_option, options_from_collection_for_select(TranslationOption.all, :code, :description, @translation_option.code)
+  = submit_tag 'Go'
+%p
+  Textual Translation progress:
+  %span#translate_progress.progressBar= @locale.percentage_translated
+%h2
+  = @translation_option.description
+  \: #{@locale.name}
+- if @translations.empty?
+  %h3 No records for this criteria.
+- for translation in @translations
+  %div{:id => "translation_#{translation.class}_#{translation.id}"}
+    - remote_form_for([@locale, translation]) do |f|
+      %p= h translation.default_locale_value || translation.raw_key
+      %p
+        = f.text_field :value, :size => 128
+        = f.submit "Update"
+    %hr/

data/lib/views/translations/update.rjs

@@ -0,0 +1,7 @@
+# update the percentage and remove the translated record if translated for first time otherwise highlight change
+if @first_time_translating
+  page.call 'myJsProgressBarHandler.setPercentage', 'translate_progress', @locale.percentage_translated
+  page.remove("translation_#{@translation.class}_#{@translation.id}") 
+else
+  page.visual_effect :highlight, "translation_#{@translation.class}_#{@translation.id}"
+end

data/routes.rb

@@ -0,0 +1,3 @@
+map.resources :locales, :has_many => :translations
+map.translations '/translations', :controller => 'translations', :action => 'translations'
+map.asset_translations '/asset_translations', :controller => 'translations', :action => 'asset_translations'

data/spec/assets/views/test_view1.html.erb

@@ -0,0 +1 @@
+<div class="promo-ad"><%= link_to (translated_image_tag(I18n.ta("promo/sfc08_140x400_3.gif")), "http://streak.espn.go.com/") %></div>

data/spec/assets/views/test_view2.html.erb

@@ -0,0 +1,30 @@
+<h1>Listing people</h1>
+<%= image_tag(I18n.ta('image1.gif')) %>
+<%= image_tag(I18n.ta('image2.gif')) %>
+<%= image_tag(I18n.ta('image2.gif')) %> <!-- test duplicate tag ... image should only appear once -->
+<%= image_tag(I18n.ta('icons/icon1.gif')) %>
+<%= image_tag(I18n.ta('icons/icon2.gif')) %>
+<%= image_tag(I18n.ta('/favicons/favicon1.gif')) image_tag(I18n.ta('/favicons/favicon2.gif')) %> <!-- should find tags on same line -->
+
+<table>
+  <tr>
+    <th>Name</th>
+    <th>City</th>
+    <th>Age</th>
+  </tr>
+
+<% for person in @people %>
+  <tr>
+    <td><%=h person.name %></td>
+    <td><%=h person.city %></td>
+    <td><%=h person.age %></td>
+    <td><%= link_to 'Show', person %></td>
+    <td><%= link_to 'Edit', edit_person_path(person) %></td>
+    <td><%= link_to 'Destroy', person, :confirm => 'Are you sure?', :method => :delete %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'New person', new_person_path(:locale => I18n.locale) %>

data/spec/caching_spec.rb

@@ -0,0 +1,87 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe I18n::Backend::Database do
+  before(:each) do
+    @backend = I18n::Backend::Database.new
+    I18n.backend = @backend
+  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 cache translations" do
+        @english_locale.translations.create!(:key => 'activerecord.errors.messages.blank', :value => 'is blank moron!')
+
+        options = {:attribute=>"Locale", :value=>nil, 
+          :scope=>[:activerecord, :errors], :default=>[:"models.translation.blank", :"messages.blank"], :model=>"Translation"}
+
+        @backend.translate("en", :"models.translation.attributes.locale.blank", options).should == "is blank moron!"
+
+        @backend.cache_store.exist?("en:#{Translation.hk("activerecord.errors.models.translation.attributes.locale.blank")}").should be_true
+        @backend.cache_store.exist?("en:#{Translation.hk("activerecord.errors.models.translation.blank")}").should be_true
+        @backend.cache_store.exist?("en:#{Translation.hk("activerecord.errors.messages.blank")}").should be_true
+
+        @backend.cache_store.read("en:#{Translation.hk("activerecord.errors.models.translation.attributes.locale.blank")}").should == nil
+        @backend.cache_store.read("en:#{Translation.hk("activerecord.errors.models.translation.blank")}").should == nil
+        @backend.cache_store.read("en:#{Translation.hk("activerecord.errors.messages.blank")}").should == "is blank moron!"
+      end
+
+      it "should update a cache record if the translation record changes" do
+        hash_key = Translation.hk("blah")
+        @backend.translate("en", "blah")
+        @backend.cache_store.read("en:#{hash_key}").should == "blah"
+
+        translation = @english_locale.translations.find_by_key(Translation.hk("blah")) 
+        translation.value.should == "blah"
+
+        translation.update_attribute(:value, "foo")
+        translation.value.should == "foo"
+        @backend.cache_store.read("en:#{hash_key}").should == "foo"
+      end
+    end
+
+    describe "and locale es" do
+      before(:each) do
+        I18n.locale = "es"
+        @spanish_locale = Locale.create!(:code => 'es')
+      end
+
+      it "should cache translations" do
+        @english_locale.translations.create!(:key => 'activerecord.errors.messages.blank', :value => 'is blank moron!')
+
+        options = {:attribute=>"Locale", :value=>nil, 
+          :scope=>[:activerecord, :errors], :default=>[:"models.translation.blank", :"messages.blank"], :model=>"Translation"}
+
+        @backend.translate("es", :"models.translation.attributes.locale.blank", options).should == "is blank moron!"
+
+        @backend.cache_store.exist?("es:#{Translation.hk("activerecord.errors.models.translation.attributes.locale.blank")}").should be_true
+        @backend.cache_store.exist?("es:#{Translation.hk("activerecord.errors.models.translation.blank")}").should be_true
+        @backend.cache_store.exist?("es:#{Translation.hk("activerecord.errors.messages.blank")}").should be_true
+
+        @backend.cache_store.read("es:#{Translation.hk("activerecord.errors.models.translation.attributes.locale.blank")}").should == nil
+        @backend.cache_store.read("es:#{Translation.hk("activerecord.errors.models.translation.blank")}").should == nil
+        @backend.cache_store.read("es:#{Translation.hk("activerecord.errors.messages.blank")}").should == "is blank moron!"
+
+        @backend.cache_store.exist?("en:#{Translation.hk("activerecord.errors.models.translation.attributes.locale.blank")}").should be_true
+        @backend.cache_store.exist?("en:#{Translation.hk("activerecord.errors.models.translation.blank")}").should be_true
+        @backend.cache_store.exist?("en:#{Translation.hk("activerecord.errors.messages.blank")}").should be_true
+
+        @backend.cache_store.read("en:#{Translation.hk("activerecord.errors.models.translation.attributes.locale.blank")}").should == nil
+        @backend.cache_store.read("en:#{Translation.hk("activerecord.errors.models.translation.blank")}").should == nil
+        @backend.cache_store.read("en:#{Translation.hk("activerecord.errors.messages.blank")}").should == "is blank moron!"
+      end
+    end
+  end
+end

data/spec/controllers/locales_controller_spec.rb

@@ -0,0 +1,173 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe LocalesController do
+
+  def mock_locale(stubs={})
+    @mock_locale ||= mock_model(Locale, stubs)
+  end
+  
+  describe "responding to GET index" do
+
+    it "should expose all locales as @locales" do
+      Locale.should_receive(:find).with(:all).and_return([mock_locale])
+      get :index
+      assigns[:locales].should == [mock_locale]
+    end
+
+    describe "with mime type of xml" do
+  
+      it "should render all locales as xml" do
+        request.env["HTTP_ACCEPT"] = "application/xml"
+        Locale.should_receive(:find).with(:all).and_return(locales = mock("Array of Locales"))
+        locales.should_receive(:to_xml).and_return("generated XML")
+        get :index
+        response.body.should == "generated XML"
+      end
+    
+    end
+
+  end
+
+  describe "responding to GET show" do
+
+    it "should expose the requested locale as @locale" do
+      Locale.should_receive(:find_by_code).with("en").and_return(mock_locale)
+      get :show, :id => "en"
+      assigns[:locale].should equal(mock_locale)
+    end
+    
+    describe "with mime type of xml" do
+
+      it "should render the requested locale as xml" do
+        request.env["HTTP_ACCEPT"] = "application/xml"
+        Locale.should_receive(:find_by_code).with("en").and_return(mock_locale)
+        mock_locale.should_receive(:to_xml).and_return("generated XML")
+        get :show, :id => "en"
+        response.body.should == "generated XML"
+      end
+
+    end
+    
+  end
+
+  describe "responding to GET new" do
+  
+    it "should expose a new locale as @locale" do
+      Locale.should_receive(:new).and_return(mock_locale)
+      get :new
+      assigns[:locale].should equal(mock_locale)
+    end
+
+  end
+
+  describe "responding to GET edit" do
+  
+    it "should expose the requested locale as @locale" do
+      Locale.should_receive(:find_by_code).with("en").and_return(mock_locale)
+      get :edit, :id => "en"
+      assigns[:locale].should equal(mock_locale)
+    end
+
+  end
+
+  describe "responding to POST create" do
+
+    describe "with valid params" do
+      
+      it "should expose a newly created locale as @locale" do
+        Locale.should_receive(:new).with({'these' => 'params'}).and_return(mock_locale(:save => true))
+        post :create, :locale => {:these => 'params'}
+        assigns(:locale).should equal(mock_locale)
+      end
+
+      it "should redirect to the created locale" do
+        Locale.stub!(:new).and_return(mock_locale(:save => true))
+        post :create, :locale => {}
+        response.should redirect_to(locale_url(mock_locale))
+      end
+      
+    end
+    
+    describe "with invalid params" do
+
+      it "should expose a newly created but unsaved locale as @locale" do
+        Locale.stub!(:new).with({'these' => 'params'}).and_return(mock_locale(:save => false))
+        post :create, :locale => {:these => 'params'}
+        assigns(:locale).should equal(mock_locale)
+      end
+
+      it "should re-render the 'new' template" do
+        Locale.stub!(:new).and_return(mock_locale(:save => false))
+        post :create, :locale => {}
+        response.should render_template('new')
+      end
+      
+    end
+    
+  end
+
+  describe "responding to PUT udpate" do
+
+    describe "with valid params" do
+
+      it "should update the requested locale" do
+        Locale.should_receive(:find_by_code).with("en").and_return(mock_locale)
+        mock_locale.should_receive(:update_attributes).with({'these' => 'params'})
+        put :update, :id => "en", :locale => {:these => 'params'}
+      end
+
+      it "should expose the requested locale as @locale" do
+        Locale.stub!(:find_by_code).and_return(mock_locale(:update_attributes => true))
+        put :update, :id => "en"
+        assigns(:locale).should equal(mock_locale)
+      end
+
+      it "should redirect to the locale" do
+        Locale.stub!(:find).and_return(mock_locale(:update_attributes => true))
+        put :update, :id => "1"
+        response.should redirect_to(locale_url(mock_locale))
+      end
+
+    end
+    
+    describe "with invalid params" do
+
+      it "should update the requested locale" do
+        Locale.should_receive(:find_by_code).with("en").and_return(mock_locale)
+        mock_locale.should_receive(:update_attributes).with({'these' => 'params'})
+        put :update, :id => "en", :locale => {:these => 'params'}
+      end
+
+      it "should expose the locale as @locale" do
+        Locale.stub!(:find_by_code).and_return(mock_locale(:update_attributes => false))
+        put :update, :id => "en"
+        assigns(:locale).should equal(mock_locale)
+      end
+
+      it "should re-render the 'edit' template" do
+        Locale.stub!(:find_by_code).and_return(mock_locale(:update_attributes => false))
+        put :update, :id => "en"
+        response.should render_template('edit')
+      end
+
+    end
+
+  end
+
+  describe "responding to DELETE destroy" do
+
+    it "should destroy the requested locale" do
+      Locale.should_receive(:find_by_code).with("en").and_return(mock_locale)
+      mock_locale.should_receive(:destroy)
+      delete :destroy, :id => "en"
+    end
+  
+    it "should redirect to the locales list" do
+      Locale.stub!(:find_by_code).and_return(mock_locale(:destroy => true))
+      delete :destroy, :id => "en"
+      response.should redirect_to(locales_url)
+    end
+
+  end
+
+end