lit 1.0 → 1.1.2

data/app/helpers/lit/frontend_helper.rb

@@ -9,7 +9,7 @@ module Lit
         key = scope_key_by_partial(key)
         key = pluralized_key(key, count) if count
 
-        content = super(key, options)
+        content = super(key, **options.symbolize_keys)
         if !options[:skip_lit] && lit_authorized?
           content = get_translateable_span(key, content)
         end

data/app/helpers/lit/localizations_helper.rb

@@ -9,6 +9,15 @@ module Lit
       escape_javascript val.to_s
     end
 
+    def locale_flag locale
+      locale = locale.to_s.upcase[0,2]
+      locale = case locale
+               when 'EN' then 'GB'
+               else locale
+               end
+      locale.tr('A-Z', "\u{1F1E6}-\u{1F1FF}")
+    end
+
     def allow_wysiwyg_editor?(key)
       Lit.all_translations_are_html_safe || key.to_s =~ /(\b|_|\.)html$/
     end

data/app/models/lit/base.rb

@@ -1,38 +1,54 @@
 class Lit::Base < ActiveRecord::Base
   self.abstract_class = true
 
-  before_save :mark_for_retry_on_create, on: :create
-  before_save :mark_for_retry_on_update, on: :update
+  before_save :mark_for_retry
 
   attr_accessor :retried_created, :retried_updated
 
-  def mark_for_retry_on_create
+  def mark_for_retry
     @will_retry_create = true
   end
 
-  def mark_for_retry_on_update
-    @will_retry_update = true
+  after_rollback :retry_lit_model_save
+
+  def rolledback_after_insert?
+    persisted? && @was_saved_with_insert && @was_rolled_back
   end
 
-  after_rollback :retry_lit_model_save
+  def rolledback_after_update?
+    persisted? && @was_saved_with_update && @was_rolled_back
+  end
 
   private
 
-  def retry_lit_model_save
-    retry_on_create if instance_variable_defined?(:@will_retry_create) && @will_retry_create
-    retry_on_update if instance_variable_defined?(:@will_retry_update) && @will_retry_update
+  def create_or_update(**kwargs, &block)
+    @was_saved_with_insert = true if new_record?
+    @was_saved_with_update = true if persisted?
+
+    super
   end
 
-  def retry_on_create
-    return if self.retried_created
-    self.retried_created = true
-    self.class.create! attributes.merge(retried_created: true)
+  def retry_lit_model_save
+    return if @was_rolled_back
+    @was_rolled_back = true
+    do_retry if instance_variable_defined?(:@will_retry_create) && @will_retry_create
   end
 
-  def retry_on_update
-    return if self.retried_updated
-    self.retried_updated = true
-    update! attributes.merge(retried_updated: true)
+  def do_retry
+    if !retried_created
+      self.retried_created = true
+      if rolledback_after_insert?
+        self.class.create! attributes.merge(retried_created: true)
+      end
+    elsif !retried_updated
+      # Why elsif and not just if? Because if a record object was first saved
+      # with INSERT and then with UPDATE (still being the same Ruby object),
+      # it makes no sense to retry both create and upadte. Let's only retry create.
+      self.retried_updated = true
+      if rolledback_after_update?
+        update_columns(attributes)
+      end
+    end
   end
 
 end

data/app/models/lit/incomming_localization.rb

@@ -36,39 +36,27 @@ module Lit
     def duplicated?(val)
       set_localization
       return false if localization_has_changed?
-      translated_value =
-        localization.read_attribute_before_type_cast('translated_value')
-      if localization.is_changed? && !translated_value.nil?
-        translated_value == val
-      else
-        localization.read_attribute_before_type_cast('default_value') == val
-      end
+
+      localization.translation == val
     end
 
     private
 
     def set_localization
       return if locale.blank? || localization_key.blank?
-      self.localization = localization_key.localizations
-                                          .find_by(locale_id: locale_id)
+      self.localization = localization_key.localizations.find_by(locale_id: locale_id)
     end
 
     def localization_has_changed?
-      localization.blank? ||
-        localization.is_deleted != localization_key_is_deleted
+      localization.blank? || localization.is_deleted != localization_key_is_deleted
     end
 
     def update_existing_localization_data
-      localization.update_attributes!(
-        translated_value: translated_value,
-        is_changed: true
-      )
+      localization.update!(translated_value: translated_value, is_changed: true)
     end
 
     def update_existing_localization_key_data
-      localization_key.update_attributes!(
-        is_deleted: localization_key_is_deleted
-      )
+      localization_key.update!(is_deleted: localization_key_is_deleted)
     end
 
     def assign_new_localization_data
@@ -83,25 +71,23 @@ module Lit
 
     def assign_new_localization_key
       self.localization_key =
-        Lit::LocalizationKey.where(
-          localization_key: localization_key_str,
-          is_deleted: localization_key_is_deleted
-        ).first_or_create!
+        Lit::LocalizationKey.where(localization_key: localization_key_str, is_deleted: localization_key_is_deleted)
+          .first_or_create!
     end
 
     def assign_new_localization
       self.localization =
-        Lit::Localization.where(localization_key_id: localization_key.id)
-                         .where(locale_id: locale.id)
-                         .first_or_initialize
+        Lit::Localization
+          .where(localization_key_id: localization_key.id)
+          .where(locale_id: locale.id)
+          .first_or_initialize
       localization.translated_value = translated_value
       localization.is_changed = true
       localization.save!
     end
 
     def update_cache
-      Lit.init.cache.update_cache localization.full_key,
-                                  localization.translation
+      Lit.init.cache.update_cache localization.full_key, localization.translation
     end
   end
 end

data/app/models/lit/localization.rb

@@ -6,19 +6,14 @@ module Lit
     ## SCOPES
     scope :changed, -> { where is_changed: true }
     scope :not_changed, -> { where is_changed: false }
+
     # @HACK: dirty, find a way to round date to full second
-    scope :after, lambda { |dt|
-      where('updated_at >= ?', dt + 1.second)
-        .where(is_changed: true)
-    }
-    scope :active, lambda {
-      joins(:localization_key)
-        .where(Lit::LocalizationKey.table_name => { is_deleted: false })
-    }
+    scope :after, lambda { |dt| where('updated_at >= ?', dt + 1.second).where(is_changed: true) }
+    scope :active, lambda { joins(:localization_key).where(Lit::LocalizationKey.table_name => { is_deleted: false }) }
 
     ## ASSOCIATIONS
-    belongs_to :locale
-    belongs_to :localization_key, touch: true
+    belongs_to :locale, required: true
+    belongs_to :localization_key, touch: true, required: true
     has_many :localization_versions, dependent: :destroy
     has_many :versions, class_name: '::Lit::LocalizationVersion'
 
@@ -31,9 +26,7 @@ module Lit
     ## ACCESSORS
     attr_accessor :full_key_str
 
-    unless defined?(::ActionController::StrongParameters)
-      attr_accessible :translated_value, :locale_id
-    end
+    attr_accessible :translated_value, :locale_id unless defined?(::ActionController::StrongParameters)
 
     ## BEFORE & AFTER
     with_options if: :translated_value_changed? do |o|
@@ -94,6 +87,5 @@ module Lit
       translated_value = translated_value_was || default_value
       localization_versions.new(translated_value: translated_value)
     end
-
   end
 end

data/app/services/remote_interactor_service.rb

@@ -11,6 +11,7 @@ class RemoteInteractorService
   rescue => e
     return unless defined?(Rails)
     ::Rails.logger.error { "Lit remote error: #{e}" }
+    nil # Return nil to be consistent with checks for .nil? otherwise returns True
   end
 
   private
@@ -26,7 +27,7 @@ class RemoteInteractorService
 
   def initialize_request(uri)
     req = Net::HTTP::Get.new(uri.request_uri)
-    req.add_field('Authorization', %(Token token="#{@source.api_key}"))
+    req.add_field('Authorization', "Token token=\"#{@source.api_key}\"")
     req
   end
 
@@ -40,6 +41,7 @@ class RemoteInteractorService
   def perform_request(connection, request)
     res = connection.start { |http| http.request(request) }
     return res unless res.is_a?(Net::HTTPSuccess)
+
     JSON.parse(res.body)
   end
 end

data/app/services/synchronize_source_service.rb

@@ -12,8 +12,7 @@ class SynchronizeSourceService
 
   def synchronize_localizations
     after_date = @source.last_updated_at&.to_s(:db)
-    result = interactor.send_request Lit::Source::LOCALIZATIONS_PATH,
-                                     after: after_date
+    result = interactor.send_request Lit::Source::LOCALIZATIONS_PATH, after: after_date
     return unless result&.is_a?(Array)
     result.each { |loc| synchronize_localization loc }
   end
@@ -28,19 +27,16 @@ class SynchronizeSourceService
     inc_loc.localization_key = find_localization_key(inc_loc)
     inc_loc.translated_value = loc['value']
     return if inc_loc.duplicated?(loc['value'])
+
     inc_loc.save!
   end
 
   def find_incomming_localization(localization)
-    Lit::IncommingLocalization.find_or_initialize_by(
-      incomming_id: localization['id']
-    )
+    Lit::IncommingLocalization.find_or_initialize_by(incomming_id: localization['id'])
   end
 
   def find_localization_key(inc_loc)
-    Lit::LocalizationKey.find_by(
-      localization_key: inc_loc.localization_key_str
-    )
+    Lit::LocalizationKey.find_by(localization_key: inc_loc.localization_key_str)
   end
 
   def localization_key_deleted?(loc)

data/app/views/layouts/lit/application.html.erb

@@ -10,7 +10,6 @@
     <%= stylesheet_link_tag    '//netdna.bootstrapcdn.com/bootswatch/3.0.3/yeti/bootstrap.min.css', media: 'all' %>
     <%= stylesheet_link_tag    'lit/application', media: 'all' %>
     <%= javascript_include_tag 'lit/application' %>
-    <%= javascript_include_tag '//netdna.bootstrapcdn.com/bootstrap/3.0.3/js/bootstrap.min.js' %>
     <%= csrf_meta_tags %>
   </head>
   <body class="<%= params[:controller] %>">

data/app/views/lit/dashboard/index.html.erb

@@ -1,5 +1,5 @@
 <strong>All localization keys</strong> <%= Lit::LocalizationKey.active.count(:id) %><br/>
 <% @locales.each do |l| %>
-  <strong><%= image_tag "lit/famfamfam_flags/#{l.locale[0,2]}.png" %> <%= I18n.t("lit.locale_to_languages.#{l.locale}", :default=>l.locale) %>:</strong> <span title="<%= "#{l.changed_localizations_count}/#{l.all_localizations_count}" %>"><%= l.translated_percentage %>%</span><br/>
+  <strong><%= EmojiFlag.new(l.locale) %> <%= I18n.t("lit.locale_to_languages.#{l.locale}", :default=>l.locale) %>:</strong> <span title="<%= "#{l.changed_localizations_count}/#{l.all_localizations_count}" %>"><%= l.translated_percentage %>%</span><br/>
 <% end %>
 

data/app/views/lit/incomming_localizations/index.html.erb

@@ -25,7 +25,7 @@
   <% @incomming_localizations.each do |il| %>
     <tr data-id="<%= il.id %>">
       <td colspan="3">
-        <%= image_tag "lit/famfamfam_flags/#{il.locale_str[0,2]}.png" %>
+        <%= image_tag EmojiFlag.new(il.locale_str) %>
         <strong><%= il.full_key %></strong>
       </td>
     </tr>

data/app/views/lit/localization_keys/_localizations_list.html.erb

@@ -1,8 +1,12 @@
-<table class="table">
+<div class="col-12 text-right">
+  <%= link_to "batch touch", lit.batch_touch_localization_keys_path(key: params[:key], key_prefix: params[:key_prefix]), method: :post, remote: true, class: 'btn btn-sm btn-primary', data: { confirm: 'This will "touch" all search results making them subject of synchronization. Proceed?'} %>
+</div>
+<table class="table mt-1">
   <%- @localization_keys.each do |lk| %>
     <tr class="localization_key_row" data-id="<%= lk.id %>">
       <td>
         <strong><%= lk.localization_key %></strong>
+        <i class="fa fa-clipboard js-copy_to_clipboard copy_to_clipboard_btn " data-key="<%= lk.localization_key %>"></i>
         <span class="badge"><%= Lit.init.cache.get_global_hits_counter(lk.localization_key) %></span>
         <div class="localization_keys_options">
           <% if Lit.store_request_info %>
@@ -30,26 +34,30 @@
         <div class="detail_wrapper">
           <table class="table table-bordered table-striped">
             <tr>
-              <th class="col-md-8">Translation</th>
-              <th class="col-md-2 text-center">Locale</th>
+              <th class="col-md-1"></th>
+              <th class="col-md-9">Translation</th>
+              <th class="col-md-1 text-center">Locale</th>
               <% unless lk.is_deleted? %>
-                <th class="col-md-2 text-center">Completed</th>
+                <th class="col-md-1 text-center">Completed</th>
               <% end %>
             </tr>
             <%- available_locales.each do |locale| %>
               <%- localization = localization_for(locale, lk) %>
               <tr>
+                <td>
+                  <% if localization %>
+                    <%= draw_icon 'clock-o', title: "Last updated at #{localization.updated_at.to_s(:db)}" %>
+                    <%= link_to lit.previous_versions_localization_key_localization_path(lk, localization, format: :js), class: "js-show_prev_versions #{'hidden' unless versions?(localization)}", remote: true do %>
+                      <%= draw_icon 'random', title: I18n.t('lit.common.previous_versions', default: 'Previous versions') %>
+                    <% end %>
+                  <% end %>
+                </td>
                 <td class="localization_row" data-id="<%= localization.id%>" data-edit="<%= edit_localization_key_localization_path(lk, localization, format: :js) %>" data-editing=0 data-content="">
                   <%= render partial: 'localization_row', locals: {localization: Lit.init.cache["#{locale}.#{lk.localization_key}"]} %>
                 </td>
                 <td class="locale_row text-center">
-                  <%= image_tag "lit/famfamfam_flags/#{locale[0,2]}.png" %>
+                  <%= EmojiFlag.new(locale) %>
                   <%= locale %>
-                  <% if localization %>
-                    <%= link_to lit.previous_versions_localization_key_localization_path(lk, localization, format: :js), class: "show_prev_versions #{'hidden' unless versions?(localization)}", remote: true do %>
-                      <%= draw_icon 'random', title: I18n.t('lit.common.previous_versions', default: 'Previous versions') %>
-                    <% end %>
-                  <% end %>
                 </td>
                 <% unless lk.is_deleted? %>
                   <td class="text-center">
@@ -65,7 +73,7 @@
             <% end %>
             <% if Lit.store_request_info %>
               <tr class="hidden request_info_row">
-                <td colspan="2">
+                <td colspan="3">
                   <strong>Translation key recently displayed on following pages:</strong>
                   <ul>
                     <% Lit.init.cache.get_request_info(lk.localization_key).split(' ').reverse.each do |l| %>

data/app/views/lit/localization_keys/batch_touch.js.erb

@@ -0,0 +1 @@
+alert('All of search results have been marked as updated now, please retry synchronizing now');

data/app/views/lit/localization_keys/index.html.erb

@@ -4,6 +4,8 @@
 
 <% if defined?(Kaminari)  %>
   <%= paginate @localization_keys, :theme=>"lit" %>
+<% elsif defined?(WillPaginate)  %>
+  <%= will_paginate @localization_keys %>
 <% end %>
 
 <%= render 'sidebar' %>

data/app/views/lit/localization_keys/not_translated.html.erb

@@ -4,6 +4,8 @@
 
 <% if defined?(Kaminari)  %>
   <%= paginate @localization_keys, :theme=>"lit" %>
+<% elsif defined?(WillPaginate)  %>
+  <%= will_paginate @localization_keys %>
 <% end %>
 
 <%= render 'sidebar' %>

data/app/views/lit/localization_keys/visited_again.html.erb

@@ -4,6 +4,9 @@
 
 <% if defined?(Kaminari)  %>
   <%= paginate @localization_keys, :theme=>"lit" %>
+<% elsif defined?(WillPaginate)  %>
+  <%= will_paginate @localization_keys %>
 <% end %>
 
+
 <%= render 'sidebar' %>

data/app/views/lit/localizations/update.js.erb

@@ -1,6 +1,6 @@
 var $row = $('td.localization_row[data-id="<%= @localization.id %>"]');
 $row.data('editing', 0);
 $row.html("<%= ejs render(:partial=>"/lit/localization_keys/localization_row", formats: ['html'], :locals=>{:localization=>@localization.translated_value }) %>");
-$row.siblings().find('.show_prev_versions').removeClass('hidden');
+$row.siblings().find('.js-show_prev_versions').removeClass('hidden');
 $('a.change_completed_<%= @localization.id %> input[type=checkbox]').prop("checked", true);
 

data/config/routes.rb

@@ -25,6 +25,7 @@ Lit::Engine.routes.draw do
       get :find_localization
       get :not_translated
       get :visited_again
+      post :batch_touch
     end
     resources :localizations, only: [:edit, :update, :show] do
       member do

data/lib/generators/lit/install/templates/initializer.rb

@@ -29,11 +29,14 @@ Lit.all_translations_are_html_safe = false
 # <span title="translation missing string"></span>
 Lit.humanize_key = false
 
-# If set to `true` will always parse yaml files upon startup and update cache
-# values with ones with yaml - but only, if those keys haven't been changed via
-# web ui before
+# If set to `false` will always parse yaml files upon startup and update cached
+# values with ones with yaml (but only, if those keys haven't been changed via
+# web ui before)
 Lit.ignore_yaml_on_startup = true
 
+# Array of ignored keys or key prefixes
+Lit.ignored_keys = ['i18n.transliterate'].freeze
+
 # API enabled? API allows third party browsing your translations, as well as
 # synchronizing them between environments
 Lit.api_enabled = false

data/lib/lit.rb

@@ -17,6 +17,8 @@ module Lit
   mattr_accessor :all_translations_are_html_safe
   mattr_accessor :set_last_updated_at_upon_creation
   mattr_accessor :store_request_info
+  mattr_accessor :store_request_keys
+  mattr_accessor :hits_counter_enabled
 
   class << self
     attr_accessor :loader
@@ -30,13 +32,16 @@ module Lit
       Lit.humanize_key_ignored_keys = [] if Lit.humanize_key_ignored_keys.nil?
       Lit.humanize_key_ignored = %w[i18n date datetime number time support ]
       Lit.humanize_key_ignored |= Lit.humanize_key_ignored_keys
-      Lit.humanize_key_ignored = %r{(#{Lit.humanize_key_ignored.join('|')}).*}
-      if Lit.ignored_keys.is_a?(String)
-        keys = Lit.ignored_keys.split(',').map(&:strip)
-        Lit.ignored_keys = keys
-      end
+      Lit.humanize_key_ignored = Regexp.new("(#{Lit.humanize_key_ignored.join('|')}).*")
       Lit.ignore_yaml_on_startup = true if Lit.ignore_yaml_on_startup.nil?
+
+      Lit.ignored_keys = Lit.ignored_keys.split(',').map(&:strip) if Lit.ignored_keys.is_a?(String)
       Lit.ignored_keys = [] unless Lit.ignored_keys.is_a?(Array)
+      Lit.ignored_keys = Lit.ignored_keys.map(&:freeze).freeze
+
+      Lit.hits_counter_enabled = false if Lit.hits_counter_enabled.nil?
+      Lit.store_request_info = false if Lit.store_request_info.nil?
+      Lit.store_request_keys = false if Lit.store_request_keys.nil?
       # if loading all translations on start, migrations have to be already
       # performed, fails on first deploy
       # self.loader.cache.load_all_translations
@@ -47,7 +52,15 @@ module Lit
 
   def self.check_if_table_exists
     Lit::Locale.table_exists?
-  rescue
+  rescue ActiveRecord::ActiveRecordError => e
+    log_txt =
+      "An #{e.class} error has been raised during Lit initialization. " \
+      "Lit assumes that database tables do not exist.\n\n" \
+      "Error: #{e.message}\n\n" \
+      "Backtrace:\n" \
+      "#{e.backtrace.join("\n")}"
+    Logger.new(STDOUT).error(log_txt) if ::Rails.env.test? # ensure this is logged to stdout in test
+    ::Rails.logger.error(log_txt)
     false
   end