exvo_globalize 0.3.1 → 0.3.2

data/app/controllers/globalize_translations_controller.rb

@@ -8,17 +8,40 @@ class GlobalizeTranslationsController < ApplicationController
   respond_to :html, :json
 
   def show
-    # returns {"default_locale":"en","pl":{"hello.world":"Witaj \u015bwiecie","hello.earth":"Witaj ziemio"},"en":{"hello.world":"Hello world","hello.earth":"Hello Earth"}}
     @translations = I18n.backend.available_app_translations.merge({ :default_locale => I18n.default_locale })
     respond_with @translations
   end
 
+  def list
+    @languages = I18n.backend.available_locales.sort_by(&:to_s)
+
+    hash = case params[:type]
+      when "yaml-app"
+        I18n.backend.available_app_translations
+      when "yaml"
+        I18n.backend.simple.available_translations
+      when "db"
+        I18n.backend.globalize_store.available_translations
+      else
+        I18n.backend.available_translations
+      end
+
+    @translations = params[:locale].present? ? { params[:locale].to_sym => hash[params[:locale].to_sym] } : hash
+  end
+
   def update
-    if I18n.backend.store_nested_translations(@globalize_app.fetch_translations)
-      flash.now[:notice] = 'Translations updated'
+    translations = @globalize_app.fetch_translations
+
+    if translations.present? and !translations.has_key?("errors")
+      if I18n.backend.store_nested_translations(translations)
+        flash.now[:notice] = 'Translations updated'
+      else
+        flash.now[:alert] = 'There was a problem while updating translations'
+      end
     else
-      flash.now[:alert] = 'There was a problem while updating translations'
+      flash.now[:alert] = "There was a problem while fetching translations: #{translations["errors"].to_s.downcase}"
     end
+
     render :show
   end
 

data/app/models/globalize_translation.rb

@@ -2,9 +2,7 @@ class GlobalizeTranslation < ActiveRecord::Base
 
   # based on https://github.com/svenfuchs/i18n-active_record/blob/master/lib/i18n/backend/active_record/translation.rb
 
-  def self.locale(locale)
-    scoped(:conditions => { :locale => locale.to_s })
-  end
+  scope :ordered, :order => :key
 
   def self.lookup(keys)
     column_name = connection.quote_column_name('key')

data/app/views/globalize_translations/list.html.haml

@@ -0,0 +1,11 @@
+= form_tag list_globalize_translations_path, :class => "search", :method => :get do
+  %p
+    I18n backend:
+    = select_tag "type", options_for_select([ ["Globalize store (database)", "db"], ["YAML (application)", "yaml-app"], ["YAML (application and gems)", "yaml"] ], :selected => params[:type]), :include_blank => "All"
+
+    Language:
+    = select_tag "locale", options_for_select(@languages, :selected => params[:locale]), :include_blank => "All"
+
+    = submit_tag "show"
+
+= raw(HashToHTML(@translations)) if @translations.present?

data/app/views/layouts/exvo_globalize.html.haml

@@ -4,6 +4,10 @@
     %title= "Exvo Globalize translations"
     %meta{ :name => "robots", :content => "noindex, nofollow" }
     :css
+      html, body, fieldset, form, input, select, textarea {
+        font: 13px/130% "Lucida Grande", Tahoma, Verdana, Helvetica, Arial, sans-serif;
+      }
+
       p.request_host {
         background: #f9fdf1;
         border: 1px solid #d2e1b8;
@@ -22,7 +26,43 @@
         margin: 0.2em auto;
       }
 
+      form p {
+        background: #f9fdf1;
+        border: 1px solid #d2e1b8;
+        margin: 1em 0;
+        padding: 1em 1.2em;
+        width: 600px;
+      }
+
+      select {
+        margin-right: 12px;
+      }
+
+      ul {
+        margin-bottom: 1em;
+        padding-left: 1em;
+      }
+
+      li {
+        color: #eee;
+        list-style: disc;
+      }
+
+      li strong {
+        color: #509e43;
+        margin-right: 0.2em;
+      }
+
+      li span {
+        color: black;
+      }
+
   %body
+    %p
+      = link_to 'Main page',  globalize_translations_path
+      |
+      = link_to 'Translations list', list_globalize_translations_path
+
     %p.request_host
       Request host:
       %span= @globalize_app.request_host

data/config/routes.rb

@@ -1,6 +1,7 @@
 Rails.application.routes.draw do
   scope '/globalize' do
     resource :translations, :only => [:show, :update], :as => 'globalize_translations', :controller => 'globalize_translations' do
+      get :list, :on => :collection
     end
   end
 end

data/lib/exvo_globalize/backend/chain.rb

@@ -7,7 +7,7 @@ module I18n
         # returning a combined hash with translations from all chained backends
         def available_translations
           # reverse, so that the translations from the first backend (GlobalizeStore) overwrite/overshadow others
-          @available_translations ||= backends.map { |backend| backend.available_translations }.reverse.inject(&:merge)
+          @available_translations ||= backends.map { |backend| backend.available_translations }.reverse.inject(&:deep_merge)
         end
 
         # Return a hash only with Application translations

data/lib/exvo_globalize/backend/flatten.rb

@@ -9,9 +9,9 @@ module I18n
         hash.map do |main_key, main_value|
           main_key.to_s.split(".").reverse.inject(main_value) do |value, key|
             if value.is_a?(Hash)
-              { key.to_s => nest_translations(value) }
+              { key.to_sym => nest_translations(value) }
             else
-              { key.to_s => value }
+              { key.to_sym => value }
             end
           end
         end.inject(&:deep_merge)

data/lib/exvo_globalize/backend/globalize_store.rb

@@ -13,15 +13,14 @@ module I18n
           GlobalizeTranslation.available_locales
         end
 
-        # returns a Hash with all translations (translation keys are dot separated strings, not hashes):
-        #   {:en=>{"hello.world"=>"Hello world", "hello.earth"=>"Hello Earth"}, :pl=>{"hello.world"=>"Witaj świecie", "hello.earth"=>"Witaj ziemio"}}
+        # returns a nested Hash with all translations
+        # { :en => { :hello => { :world => "Hello world", :earth => "Hello Earth" } } } ...
         def available_translations(locale = nil)
-          (locale.present? ? GlobalizeTranslation.locale(locale.to_s) : GlobalizeTranslation.all).
-            inject({}) do |result, element|
-              result[element.locale.to_sym] ||= {}
-              result[element.locale.to_sym][element.key] = element.value
-              result
-            end
+          translations = locale.present? ? GlobalizeTranslation.where(:locale => locale).ordered : GlobalizeTranslation.ordered
+
+          translations.inject({}) do |result, element|
+            result.deep_merge( { element["locale"].to_sym => nest_translations(element["key"] => element["value"]) } )
+          end
         end
 
         def store_translations(locale, data, options = {})
@@ -32,7 +31,7 @@ module I18n
         end
 
         def store_flatten_translation(locale, key, value)
-          GlobalizeTranslation.locale(locale).lookup(expand_keys(key)).delete_all
+          GlobalizeTranslation.where(:locale => locale).lookup(expand_keys(key)).delete_all
           GlobalizeTranslation.create(:locale => locale.to_s, :key => key.to_s, :value => value)
         end
 
@@ -40,7 +39,7 @@ module I18n
 
         def lookup(locale, key, scope = [], options = {})
           key = normalize_flat_keys(locale, key, scope, options[:separator])
-          result = GlobalizeTranslation.locale(locale).lookup(key).all
+          result = GlobalizeTranslation.where(:locale => locale).lookup(key).all
 
           if result.empty?
             nil

data/lib/exvo_globalize/engine.rb

@@ -20,5 +20,11 @@ module ExvoGlobalize
       # GlobalizeStore first (database backed), YAML files second (Simple backend, the default one)
       I18n.backend = I18n::Backend::Chain.new(I18n::Backend::GlobalizeStore.new, I18n.backend)
     end
+
+    initializer "exvo_globalize.configure_helpers" do |app|
+      ActiveSupport.on_load(:action_view) do
+        ActionView::Base.send :include, ExvoGlobalize::Helpers
+      end
+    end
   end
 end

data/lib/exvo_globalize/globalize_app.rb

@@ -24,7 +24,7 @@ class GlobalizeApp
   private
 
   def globalize_host
-    Rails.env.production? ? "globalize.exvo.com" : "globalize.exvo.co"
+    Rails.env.production? or ENV['GLOBALIZE_USE_PRODUCTION_SERVER'] == 'true' ? "globalize.exvo.com" : "globalize.exvo.co"
   end
 
   def translations_uri

data/lib/exvo_globalize/helpers.rb

@@ -0,0 +1,32 @@
+module ExvoGlobalize
+  module Helpers
+
+    # Prints nested Hash as a nested <ul> and <li> tags
+    # - keys are wrapped in <strong> tags
+    # - values are wrapped in <span> tags
+    def HashToHTML(hash, opts = {})
+      return if !hash.is_a?(Hash)
+
+      indent_level = opts.fetch(:indent_level) { 0 }
+
+      out = " " * indent_level + "<ul>\n"
+
+      hash.each do |key, value|
+        out += " " * (indent_level + 2) + "<li><strong>#{key}:</strong>"
+
+        if value.is_a?(Hash)
+          out += "\n" + HashToHTML(value, :indent_level => indent_level + 2) + " " * (indent_level + 2) + "</li>\n"
+        elsif value.is_a?(Array)
+          out += " <span>[ #{value.join(', ')} ]</span></li>\n"
+        elsif value.is_a?(Proc)
+          out += " <span>" + CGI::escapeHTML(value.to_s) + "</span></li>\n"
+        else
+          out += " <span>#{value}</span></li>\n"
+        end
+      end
+
+      out += " " * indent_level + "</ul>\n"
+    end
+
+  end
+end

data/lib/exvo_globalize/version.rb

@@ -1,3 +1,3 @@
 module ExvoGlobalize
-  VERSION = "0.3.1"
+  VERSION = "0.3.2"
 end

data/lib/exvo_globalize.rb

@@ -5,6 +5,7 @@ require 'exvo_globalize/backend/flatten'
 require "exvo_globalize/backend/globalize_store"
 require "exvo_globalize/backend/simple"
 require 'exvo_globalize/globalize_app'
+require 'exvo_globalize/helpers'
 require 'haml'
 require 'httparty'
 require 'awesome_print'

data/lib/tasks/dump.rake

@@ -2,16 +2,12 @@ namespace :"globalize:translations:dump" do
   desc "Dump GlobalizeStore I18n translations as YAML"
   task :yaml => :environment do
     puts "Dumping translations as YAML..."
-    backend = I18n.backend.globalize_store
-    translations = backend.available_translations
-    puts backend.nest_translations(translations).ya2yaml
+    puts I18n.backend.globalize_store.available_translations.ya2yaml
   end
 
   desc "Dump GlobalizeStore I18n translations as Ruby Hash"
   task :ruby => :environment do
     puts "Dumping translations as Ruby Hash..."
-    backend = I18n.backend.globalize_store
-    translations = backend.available_translations
-    ap backend.nest_translations(translations), { :plain => true, :indent => 2, :sorted_hash_keys => true }
+    ap I18n.backend.globalize_store.available_translations, { :plain => true, :indent => 2, :sorted_hash_keys => true }
   end
 end

data/spec/controllers/globalize_translations_controller_spec.rb

@@ -58,11 +58,7 @@ describe GlobalizeTranslationsController do
       let(:intro) { "Introduction" }
       let(:translations) { { :en => { :intro => { :title => intro } } } }
 
-      before do
-        controller.stub!(:require_admin).and_return(true)
-        GlobalizeApp.any_instance.stub(:fetch_translations) { translations }
-        put :update
-      end
+      before { fetch_translations(translations) }
 
       it "updates the translations" do
         I18n.t(:title, :scope => :intro).should eq(intro)
@@ -77,6 +73,51 @@ describe GlobalizeTranslationsController do
       end
     end
 
+    describe "PUT :update with error from Globalize" do
+      let(:message) { "Not found" }
+      let(:translations) { { "errors" => message } }
+
+      before { fetch_translations(translations) }
+
+      it "sets a flash alert" do
+        flash[:alert].should_not be_empty
+      end
+
+      it "displays a flash alert" do
+        page.should have_selector('p.alert')
+      end
+    end
+
+    describe "GET :list" do
+      before do
+        @title = Factory(:i18n_title)
+        controller.stub!(:require_admin).and_return(true)
+
+        # invalidate #available_translations cache before each run
+        I18n.backend.instance_variable_set(:@available_translations, nil)
+      end
+
+      it "displays all available translations" do
+        get :list
+        page.should have_selector('li span', :text => @title.value)
+        page.should have_selector('li span', :text => 'YAML Nested Title')
+      end
+
+      it "displays available translations in the GlobalizeStore backend" do
+        get :list, { :type => 'db', :locale => 'en' }
+        page.should have_selector('li span', :text => @title.value)
+        page.should_not have_selector('li span', :text => 'YAML Nested Title')
+      end
+    end
+
+  end
+
+  private
+
+  def fetch_translations(translations_stub)
+    controller.stub!(:require_admin).and_return(true)
+    GlobalizeApp.any_instance.stub(:fetch_translations) { translations_stub }
+    put :update
   end
 
 end

data/spec/exvo_globalize/flatten_spec.rb

@@ -5,18 +5,18 @@ describe ExvoGlobalize do
   let(:backend) { I18n.backend.globalize_store }
 
   it "should not change a normal hash" do
-    hash = { 'hello' => "Hello", 'world' => "World" }
+    hash = { :hello => "Hello", :world => "World" }
     backend.nest_translations(hash).should eq(hash)
   end
 
   it "should not change a nested hash" do
-    nested_hash = { 'en' => { 'hello' => "Hello World!", 'world' => "World!" } }
+    nested_hash = { :en => { :hello => "Hello World!", :world => "World!" } }
     backend.nest_translations(nested_hash).should eq(nested_hash)
   end
 
   it "should nest a simple flatten hash" do
     hash = { "hello.world" => "Hello World!" }
-    nested_hash = { 'hello' => { 'world' => "Hello World!" } }
+    nested_hash = { :hello => { :world => "Hello World!" } }
     backend.nest_translations(hash).should eq(nested_hash)
   end
 
@@ -29,10 +29,10 @@ describe ExvoGlobalize do
     }
 
     nested_hash = {
-      'en' => {
-        'hello' => {
-          'world' => "Hello World!",
-          'earth' => "Hello Earth!"
+      :en => {
+        :hello => {
+          :world => "Hello World!",
+          :earth => "Hello Earth!"
         }
       }
     }

data/spec/exvo_globalize/globalize_store_spec.rb

@@ -6,6 +6,9 @@ describe ExvoGlobalize do
   let(:i18n_nested_header) { Factory(:i18n_nested_header) }
   let(:i18n_title) { Factory(:i18n_title) }
 
+  # invalidate #available_translations cache before each run
+  before { I18n.backend.instance_variable_set(:@available_translations, nil) }
+
   it "respects the default_locale setting" do
     I18n.default_locale.should eq(:en)
   end
@@ -57,10 +60,22 @@ describe ExvoGlobalize do
     I18n.backend.simple.available_translations[:en][:yaml][:title].should eq('YAML Nested Title')
   end
 
+  it "lists available translations from the GlobalizeStore backend" do
+    i18n_nested_header.value.should eq(I18n.backend.globalize_store.available_translations[:en][:nested][:header])
+  end
+
   it "lists available app translations" do
     I18n.backend.available_app_translations[:en][:helpers][:select].has_key?(:prompt).should be_true
   end
 
+  it "lists all available translations" do
+    I18n.backend.available_translations[:en][:yaml][:title].should eql('YAML Nested Title')
+  end
+
+  it "lists all available translations prioritizing the GlobalizeStore backend" do
+    i18n_title.value.should eql(I18n.backend.available_translations[:en][:title])
+  end
+
   it "excludes fixtures from app_translations and does so without breaking the I18n.load_path" do
     I18n.backend.available_app_translations[:en].has_key?(:title).should be_false
     I18n.backend.available_translations[:en].has_key?(:title).should be_true

data/spec/models/globalize_translation_spec.rb

@@ -14,7 +14,7 @@ describe GlobalizeTranslation do
   end
 
   it "returns a translation for scoped locale" do
-    i18n_title.value.should eq(GlobalizeTranslation.locale('en').lookup(:title).first.value)
+    i18n_title.value.should eq(GlobalizeTranslation.where(:locale => :en).lookup(:title).first.value)
   end
 
   it "lists available locales" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: exvo_globalize
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - "Pawe\xC5\x82 Go\xC5\x9Bcicki"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-29 00:00:00 +02:00
+date: 2011-09-06 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -275,6 +275,7 @@ files:
 - app/controllers/globalize_translations_controller.rb
 - app/models/globalize_translation.rb
 - app/views/globalize_translations/_flash_messages.html.haml
+- app/views/globalize_translations/list.html.haml
 - app/views/globalize_translations/show.html.haml
 - app/views/layouts/exvo_globalize.html.haml
 - config/locales/ar.yml
@@ -339,6 +340,7 @@ files:
 - lib/exvo_globalize/backend/simple.rb
 - lib/exvo_globalize/engine.rb
 - lib/exvo_globalize/globalize_app.rb
+- lib/exvo_globalize/helpers.rb
 - lib/exvo_globalize/version.rb
 - lib/generators/exvo_globalize/exvo_globalize_generator.rb
 - lib/generators/exvo_globalize/templates/migration.rb