i18n_admin_utils 1.0.0 → 1.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NDIzYjQyMjUxZTY1ZDUzY2FiYWUzOTlmZjU2ZjAzYTQ1MmRmZDBiNA==
+    NmNlM2EzNGNkOTgxN2RjOTllN2YwOGI4NDNmOWZlMTE4NDkxMzQ5OQ==
   data.tar.gz: !binary |-
-    ZmQ3Mzk2ZDIyNmY5NjNlY2U5Nzg2YmFiOWIzMzM3NjdlMmJiY2ZiYQ==
+    NWFkZDkxMDMzZWJkMzQ1NTY0YWU0MmFiODg4MTNlZDQwZjAzNzM0Zg==
 SHA512:
   metadata.gz: !binary |-
-    MzczOWZiMTIyNDg0NGY1ODg3NzI0YWQ2ZWQyN2JlYjY0ZjM4M2Y1NDhmM2I4
-    N2I4ZGRiOWE1MmY1M2I0ODE4OTMyYjZiZjVhNTgzY2I1YTY3MjVmMTFkMDY4
-    ZWEzMGQ1NTQwNjgwZDdmY2NiNjIxN2JjMmMzOWE1NjQzZjhiOGY=
+    NzU3OGIyZWRkZmM5OTE2MTRjNDMxNjBlMDQ5YmQ5YzhkNzYwMWIzYjFjYzgx
+    ZmJhNzUyY2ZkZjRhMjdjMDRlNWFkZmNlODg5MmE0NmQxZjEyZjVmNzYzZGE1
+    NDJhNTU3OTY4NDU3ZTAwZWRiOTRkOGQ4YWNiOGVlOWI1YTE0ZWM=
   data.tar.gz: !binary |-
-    ZGE1ZmM4N2YzMDkyNzg4OWZjZDk3YTUxOTE1MzFjZmY2MTg0MDRjYjdmMDdk
-    ZDJlY2U1NTJiZmQ5NjkyY2EzOWNhMzZmOGVjZjM1ZjM2ZGFiZDkwMTUxYjUz
-    NmYzZjUxNGM3MDcxMDRlZGE0ZWM3ZmRlZDc5MzI3YTgxZTcwNjk=
+    MDExZDA1YzBhNWE3MDI1ZDZjMjVlYTBmN2E1MmRmNjAwNGQ2YTRlNTdiYzM2
+    ZDNiMjYxZjE4NGU4NjBmMDVjMDllM2EzYTBkODI2OTZiZTQwOGYzNGM1Nzhk
+    MDRmMjAxOGY5ODRlNDMzZTkwODkwNGU3NTAyNzViMDQ4NDA0MTk=

data/app/assets/javascripts/i18n_admin_utils/application.coffee

@@ -42,19 +42,47 @@ $(document).ready () ->
     else
       container.show()
 
-  $(document).on 'keyup', 'input.translation_search', () ->
-    input = $(this)
-    val = input.val()
 
+  $(document).on 'click', '.translation_edit_container .locale-tab', () ->
+    tab = $(this)
+    active_tab = tab.parent().find('.locale-tab.active')
+    translation_edit_container = tab.closest('.translation_edit_container')
+    form = translation_edit_container.find('form.translation_form')
+    locale_input = form.find('input[name="locale"]')
+    text_input = form.find('textarea[name="value"]')
+    active_tab.data('translation', text_input.val())
+    text_input.val(tab.data('translation'))
+    locale_input.val(tab.data('locale'))
+    active_tab.removeClass('active')
+    tab.addClass('active')
 
-    container = input.closest '.translation_container'
-    elements = container.find('.translation_list .translation_item')
-    if val.length == 0
-      show_translation_element(elements)
-    else
-      query = '[data-locale*="' + val + '"],[data-key*="' + val + '"], [data-filename*="' + val + '"]'
-      show_translation_element(elements.filter(query))
-      hide_translation_element(elements.not(query))
+  $(document).on 'translation-saved', '.translation_edit_container form.translation_form button', () ->
+    button = $(this)
+    form = button.closest('form.translation_form')
+    #Update the tab
+    locale = form.find('input[name="locale"]')
+    container = button.closest('.translation_edit_container')
+    active_tab = container.find('.locale-tab[data-locale="' + locale.val() + '"]')
+    active_tab.removeClass('btn-danger').addClass('btn-success')
+
+    #Update the left menu
+    list = button.closest('.translation_container').find('.translation_list')
+    key = form.find('input[name="key"]')
+    element = list.find('.translation_item[data-key="' + key.val() + '"]')
+    $.get(element.data('reload-url'), {
+      translation: element.data('translation')
+    }
+
+    ).success (data) ->
+      element.html($(data).html())
+
+  $(document).on 'click', '.translation_filter .show-completed', () ->
+    button = $(this)
+    button.toggleClass('active')
+    filter(button.closest('.translation_filter'))
+
+  $(document).on 'keyup', 'input.translation_search', () ->
+    filter($(this).closest('.translation_filter'))
 
   $(document).on 'click', '.translation_list .translation_item', () ->
     item = $(this)
@@ -70,6 +98,7 @@ $(document).ready () ->
       container.html(data)
       window.load_script_on(container)
 
+
 #Rerun this command for reloading script for new element added with ajax for example
 window.load_script_on = (container) ->
   container.find("[rel=tooltip]").tooltip({ container: 'body', animation: false, delay: 0});
@@ -89,4 +118,22 @@ hide_translation_element = (elements) ->
   elements.each () ->
     element = $(this)
     if  element.is ':visible'
-      element.slideUp(200)
+      element.slideUp(200)
+
+
+filter = (filter_container) ->
+  input = filter_container.find('input.translation_search')
+  show_completed_button = filter_container.find('.btn.show-completed')
+  val = input.val()
+
+  container = input.closest '.translation_container'
+  elements = container.find('.translation_list .translation_item')
+  query = ''
+  query += '[data-key*="' + val + '"]'  if val.length > 0
+  query += '[data-completed=false]' unless show_completed_button.hasClass('active')
+
+  if query.length >0
+    show_translation_element(elements.filter(query))
+    hide_translation_element(elements.not(query))
+  else
+    show_translation_element(elements)

data/app/assets/javascripts/i18n_admin_utils/translation_helper.coffee

@@ -21,12 +21,20 @@ $(document).ready () ->
       type: form.attr('method'),
       dataType: 'json',
       data: form.serialize()
-    }).success( (data) ->
+    }).success((data) ->
       if data.success
-        form.find('button:not(.nosubmit)').html("<span class='glyphicon glyphicon-ok'></span>")
+        button = form.find('button:not(.nosubmit)')
+        old_html = button.html()
+        button.width(button.width()) #So the button dont get smaller when changing the text
+        button.html("<span class='glyphicon glyphicon-ok'></span>")
+        button.trigger('translation-saved')
+        setTimeout(() ->
+          button.html(old_html)
+          button.prop('disabled', false);
+        , 1500)
         form.find('div.alert').hide()
       else
-        handle_error(form,  data)
+        handle_error(form, data)
     ).error (data) ->
       handle_error(form, data)
     return false

data/app/assets/stylesheets/i18n_admin_utils/application.scss

@@ -35,6 +35,9 @@ body {
 }
 
 .editor_container {
+  .location_container{
+    margin-bottom: 3rem;
+  }
   .ace_editor {
     overflow: hidden;
   }
@@ -47,6 +50,7 @@ $translation_container_offset: $titleheight+$headerheight;
 div.translation_title {
   height: $titleheight;
 }
+
 div.translation_container {
   border-top: 1px solid $border-color;
   min-height: calc(100vh - #{$translation_container_offset});
@@ -77,13 +81,7 @@ div.translation_container {
 
       border-bottom: 1px solid $border-color;
 
-      .translation_filename {
-        direction: rtl;
-        overflow: hidden;
-        text-overflow: ellipsis;
-        unicode-bidi: bidi-override;
-        font-style: italic;
-      }
+
 
       &.active {
         background-color: #6B9ED1;
@@ -119,7 +117,7 @@ div.translation_container {
 
   div.translation_edit_container {
     position: relative;
-    padding-top: 5rem;
+    padding-top: 1rem;
     padding-bottom: 5rem;
     textarea {
       height: 10rem;
@@ -145,3 +143,39 @@ div.translation_container {
   }
 }
 
+.translation_filename {
+  direction: rtl;
+  overflow: hidden;
+  text-overflow: ellipsis;
+  unicode-bidi: bidi-override;
+  font-style: italic;
+  white-space: nowrap;
+}
+
+.color-range-0 {
+  color: $md_green
+}
+
+.color-range-1 {
+  color: #BABF24
+}
+
+.color-range-2 {
+  color: #ffc40d
+}
+
+.color-range-3 {
+  color: #BF6C24
+}
+
+.color-range-4 {
+  color: #BF2C24;
+}
+
+.bold {
+  font-weight: bold;
+}
+
+.greentext {
+  color: $md_green
+}

data/app/assets/stylesheets/i18n_admin_utils/variables.scss

@@ -3,6 +3,8 @@ $lighter_grey: #e5e5e5;
 $lightest_grey: #f5f5f5;
 $white_grey: #fcfcfc;
 
+$md_green: #00B945;
+
 $text_sm: 1rem;
 $text_md: 2rem;
 $text_lg: 4rem;

data/app/controllers/i18n_admin_utils/translation_controller.rb

@@ -5,7 +5,7 @@ module I18nAdminUtils
 
     def edit
       if params[:key].nil?
-        i18n_redirect('No key specified')
+        i18n_redirect('No key specified', false)
       else
         key = params[:key]
         locale = params[:locale]
@@ -26,8 +26,15 @@ module I18nAdminUtils
     end
 
     def show
-      unless params[:translation].nil?
-        render :partial => 'show', :locals => {:translation => params[:translation]}
+      if params[:translation].nil?
+        render :text => 'Error no params given'
+      else
+        translation = I18nAdminUtils::Translation.from_hash(params[:translation])
+        if translation.key.nil?
+          render :text => 'Error no key given'
+        else
+          render :partial => 'show', :locals => {:translation => translation}
+        end
       end
     end
 
@@ -37,6 +44,20 @@ module I18nAdminUtils
       render :partial => 'missing_list', :layouts => false, :locals => {:translations => translations}
     end
 
+    def list_element
+      if params[:translation].nil?
+        render :text => 'Error no translation given'
+      else
+        translation = I18nAdminUtils::Translation.from_hash(params[:translation])
+        if translation.key.nil?
+          render :text => 'Error no key given'
+        else
+          render :partial => 'list_element', :locals => {:translation => translation}
+        end
+
+      end
+    end
+
     def i18n_redirect(message, success = true)
       if request.xhr?
         render :json => {:success => success, :message => message}

data/app/helpers/i18n_admin_utils/application_helper.rb

@@ -1,4 +1,31 @@
 module I18nAdminUtils
   module ApplicationHelper
+
+    #Show the number of translation missing with colorization
+    def translation_missing_icon(translation)
+      missing_translations = translation.missing_translations
+      color_id = (missing_translations.size.to_f/translation.translations.size.to_f*5).ceil-1
+      if missing_translations.size == 0
+        content_tag 'span', '', :class => 'glyphicon glyphicon-ok greentext',
+                    :title => 'This key has been translated in all languages', :rel => 'tooltip'
+      else
+        content_tag 'span', "(#{missing_translations.size})", :class => "color-range-#{color_id} bold",
+                    :title => missing_translations.keys.join(','), :rel => 'tooltip'
+      end
+    end
+
+    def translation_locations_compact_list(translation)
+      if translation.locations.size == 0
+
+        content_tag 'div', '', :class => 'translation_filename'
+      elsif translation.locations.size == 1
+        content_tag 'div', translation.locations.first[:filename].reverse, :class => 'translation_filename'
+      else
+        content = "#{translation.locations.first[:filename]} and #{translation.locations.size-1} more"
+        title= translation.locations[1..-1].map { |x| "<div class='translation_filename'> #{x[:filename].reverse} </div>" }.join('')
+        content_tag 'div', content.reverse, :class => 'translation_filename', :title => title, :rel => 'tooltip',
+                    'data-html' => true
+      end
+    end
   end
 end

data/app/views/i18n_admin_utils/translation/_list_element.html.erb

@@ -0,0 +1,14 @@
+<div class="translation_item" data-translation='<%= translation.to_json %>' data-reload-url='<%= translation_list_element_path %>'
+     data-key='<%= translation.key %>' data-completed='<%= not translation.missing_translation? %>'>
+  <div class="row">
+    <div class="col-md-1">
+      <%= translation_missing_icon(translation) %>
+    </div>
+    <div class="col-md-5">
+      <%= translation.key %>
+    </div>
+    <div class="col-md-6 ">
+      <%= translation_locations_compact_list(translation) %>
+    </div>
+  </div>
+</div>

data/app/views/i18n_admin_utils/translation/_missing_list.html.erb

@@ -1,22 +1,5 @@
 <% translations.each do |translation| %>
-    <div class="translation_item" data-translation='<%= translation.to_json %>'
-         data-locale='<%= translation[:locale] %>'
-         data-key='<%= translation[:key] %>'
-         data-filename='<%= translation[:filename] %>'>
-      <div class="row">
-        <div class="col-md-1">
-          <%= translation[:locale] %>
-        </div>
-        <div class="col-md-5">
-          <%= translation[:key] %>
-        </div>
-        <div class="col-md-6 ">
-          <div class="translation_filename">
-            <%= translation[:filename].reverse %>
-          </div>
-        </div>
-      </div>
-    </div>
+    <%= render :partial => 'list_element', :locals => {:translation => translation} %>
 <% end %>
 
 

data/app/views/i18n_admin_utils/translation/_show.html.erb

@@ -1,21 +1,25 @@
+<% default_locale = I18nAdminUtils::Config.locales.first %>
 <div class="row">
-  <div class="col-md-1">
-    <b>Locale:</b> <%= translation[:locale] %>
-  </div>
-  <div class="col-md-5">
-    <b>Key:</b> <%= translation[:key] %>
-  </div>
-  <div class="col-md-6">
-    <i><%= translation[:filename] %></i>
+  <div class="col-md-12">
+    <div class="btn-group">
+      <% translation.translations.each do |locale, translation| %>
+          <% type = translation.blank? ? 'danger' : 'success' %>
+          <div class="btn btn-<%= type %> locale-tab <%= 'active' if locale == default_locale %>"
+               data-translation='<%= translation %>' data-locale='<%= locale %>'>
+            <%= locale %>
+          </div>
+      <% end %>
+    </div>
   </div>
 </div>
-<div class="row">
+<div class="row" style="margin-top: 2rem">
   <div class="col-md-6">
+    <b>Key:</b> <%= translation.key %>
     <div>
-      <%= form_tag translation_edit_path, :class => 'translation_helper' do %>
-          <%= hidden_field_tag :locale, translation[:locale] %>
-          <%= hidden_field_tag :key, translation[:key] %>
-          <%= text_area_tag :value, '', :class => 'form-control autosize', 'data-update' => 'value_ta', :placeholder => 'Translate here...' %>
+      <%= form_tag translation_edit_path, :class => 'translation_form translation_helper' do %>
+          <%= hidden_field_tag :locale, default_locale %>
+          <%= hidden_field_tag :key, translation.key %>
+          <%= text_area_tag :value, translation.translations[default_locale], :class => 'form-control autosize', 'data-update' => 'value_ta', :placeholder => 'Translate here...' %>
           <button class='btn btn-default'>
             Add
           </button>
@@ -25,9 +29,18 @@
   <div class="col-md-6">
     <div class="editor_container">
       <div>
-        <%= rails_embed_editor(translation[:filename], :line => translation[:line], :radius => 4,
-                               :editormode => RailsEmbedEditor::EditorMode::READ_WRITE,
-                               :highlight => translation[:line]) %>
+        <% translation.locations.each do |location| %>
+            <div class="location_container">
+              <div>
+                <i><%= location[:filename] %></i>
+              </div>
+              <div>
+                <%= rails_embed_editor(location[:filename], :line => location[:line], :radius => 4,
+                                       :editormode => RailsEmbedEditor::EditorMode::READ_WRITE,
+                                       :highlight => location[:line]) %>
+              </div>
+            </div>
+        <% end %>
       </div>
     </div>
   </div>

data/app/views/i18n_admin_utils/translation/index.html.erb

@@ -1,11 +1,20 @@
 <div class="translation_title">
-  <span class="text-lg text-bold">List of untranslated key found in the application</span>
+  <span class="text-lg text-bold">List translation key found in the application</span>
 </div>
 
 <div class="row translation_container">
   <div class="col-md-3 translation_list" data-url='<%= translation_missing_show_path %>' data-container='.translation_edit_container'>
-    <div class="translation_filter">
-      <%= text_field_tag :search, '', :class => 'translation_search form-control', :placeholder => 'Search...', :autocomplete => 'off' %>
+    <div class="container-fluid translation_filter">
+      <div class="row">
+        <div class=" col-md-10">
+          <%= text_field_tag :search, '', :class => 'translation_search form-control', :placeholder => 'Search...', :autocomplete => 'off' %>
+        </div>
+        <div class="col-md-2">
+          <div class="btn btn-default active show-completed">
+            <span class="glyphicon glyphicon-eye-open" title="Show completed" rel='tooltip'></span>
+          </div>
+        </div>
+      </div>
     </div>
     <div class='loadonready' data-url='<%= translation_missing_list_path %>'>
     </div>

data/config/routes.rb

@@ -1,7 +1,8 @@
 Rails.application.routes.draw do
 
   get '/translation' => 'i18n_admin_utils/translation#index', :as => :translation_home
-  get 'translation/missing' => 'i18n_admin_utils/translation#show', :as => :translation_missing_show
-  get 'translation/missing/list' => 'i18n_admin_utils/translation#missing_list', :as => :translation_missing_list
+  get 'translation/show' => 'i18n_admin_utils/translation#show', :as => :translation_missing_show
+  get 'translation/list' => 'i18n_admin_utils/translation#missing_list', :as => :translation_missing_list
+  get 'translation/list/element' => 'i18n_admin_utils/translation#list_element', :as => :translation_list_element
   post '/translation/edit' => 'i18n_admin_utils/translation#edit', :as => :translation_edit
 end

data/lib/generators/i18n_admin_utils/templates/initializer.rb

@@ -1,4 +1,4 @@
-if Rails.env.development?
+if defined? I18nAdminUtils and defined? I18nAdminUtils.config #Load the config only if the gem is required(development mode only)
   I18nAdminUtils.config do |config|
 
     #Specify the backend if you are using the chain(it will use the first one by default)