lit 1.1.0 → 1.1.5

data/app/helpers/lit/frontend_helper.rb

@@ -1,83 +1,83 @@
-module Lit
-  module FrontendHelper
-    include ActionView::Helpers::TranslationHelper
+module Lit::FrontendHelper
+  include ActionView::Helpers::TranslationHelper
 
-    module TranslationKeyWrapper
-      def translate(key, options = {})
-        count = options[:count]
-        options = options.with_indifferent_access
-        key = scope_key_by_partial(key)
-        key = pluralized_key(key, count) if count
+  module TranslationKeyWrapper
+    def translate(key, options = {})
+      count = options[:count]
+      options = options.with_indifferent_access
+      key = scope_key_by_partial(key)
+      key = pluralized_key(key, count) if count
 
-        content = super(key, options.symbolize_keys)
-        if !options[:skip_lit] && lit_authorized?
-          content = get_translateable_span(key, content)
-        end
-        content
-      end
-
-      def pluralized_key(key, count)
-        pluralizer = I18n.backend.send(:pluralizer, locale)
-        return unless pluralizer.respond_to?(:call)
-        last = count.zero? ? :zero : pluralizer.call(count)
-        format '%<key>s.%<last>s', key: key, last: last
-      end
-
-      def t(key, options = {})
-        translate(key, options)
-      end
+      content = super(key, **options.symbolize_keys)
+      content = get_translateable_span(key, content) if !options[:skip_lit] && lit_authorized?
+      content
     end
-    prepend Lit::FrontendHelper::TranslationKeyWrapper
 
-    def javascript_lit_tag
-      javascript_include_tag 'lit/lit_frontend'
+    def pluralized_key(key, count)
+      pluralizer = I18n.backend.send(:pluralizer, locale)
+      return unless pluralizer.respond_to?(:call)
+      last = count.zero? ? :zero : pluralizer.call(count)
+      format '%<key>s.%<last>s', key: key, last: last
     end
 
-    def stylesheet_lit_tag
-      stylesheet_link_tag 'lit/lit_frontend'
+    def t(key, options = {})
+      translate(key, options)
     end
+  end
+  prepend Lit::FrontendHelper::TranslationKeyWrapper
 
-    def lit_frontend_assets
-      return unless lit_authorized?
-      meta = content_tag :meta,
-                         '',
-                         value: lit.find_localization_localization_keys_path,
-                         name: 'lit-url-base'
-      safe_join [javascript_lit_tag, stylesheet_lit_tag, meta]
-    end
+  def javascript_lit_tag
+    javascript_include_tag 'lit/lit_frontend'
+  end
+
+  def stylesheet_lit_tag
+    stylesheet_link_tag 'lit/lit_frontend'
+  end
+
+  def lit_frontend_assets
+    return unless lit_authorized?
 
-    def lit_translations_info
-      return if Thread.current[:lit_request_keys].nil?
-      return unless lit_authorized?
-      content_tag :div, class: 'lit-translations-info collapsed' do
-        concat content_tag(:span, 'Show translations', class: 'lit-open-button')
-        concat content_tag(:span, 'X', class: 'lit-close-button')
-        concat translations_list_content_tag
-      end
+    meta = content_tag :meta, '', value: lit.find_localization_localization_keys_path, name: 'lit-url-base'
+    safe_join [javascript_lit_tag, stylesheet_lit_tag, meta]
+  end
+
+  def lit_translations_info
+    return if Thread.current[:lit_request_keys].nil?
+    return unless lit_authorized?
+
+    content_tag :div, class: 'lit-translations-info collapsed' do
+      concat content_tag(:span, 'Show translations', class: 'lit-open-button')
+      concat content_tag(:span, 'X', class: 'lit-close-button')
+      concat translations_list_content_tag
     end
+  end
 
-    def translations_list_content_tag
-      content_tag :ul, class: 'lit-translations-list' do
-        Lit.init.cache.request_keys.each do |k, v|
-          concat(content_tag(:li) do
-            concat content_tag(:code, "#{k}:")
-            concat get_translateable_span(k, v, alternative_text: '[empty]')
-          end)
+  def translations_list_content_tag
+    content_tag :ul, class: 'lit-translations-list' do
+      Lit
+        .init
+        .cache
+        .request_keys
+        .each do |k, v|
+          concat(
+            content_tag(:li) do
+              concat content_tag(:code, "#{k}:")
+              concat get_translateable_span(k, v, alternative_text: '[empty]')
+            end,
+          )
         end
-      end
     end
+  end
 
-    def lit_authorized?
-      return false if Lit.authentication_verification.blank?
-      send Lit.authentication_verification
-    end
+  def lit_authorized?
+    return false if Lit.authentication_verification.blank?
+
+    send Lit.authentication_verification
+  end
 
-    def get_translateable_span(key, localization, alternative_text: nil)
-      content_tag :span,
-                  class: 'lit-key-generic',
-                  data: { key: key, locale: I18n.locale } do
-        localization.blank? ? alternative_text : localization
-      end
+  def get_translateable_span(key, localization, alternative_text: nil)
+    content_tag :span, class: 'lit-key-generic', data: { key: key, locale: I18n.locale } do
+      localization.blank? ? alternative_text : localization
     end
   end
 end

data/app/models/lit/base.rb

@@ -21,7 +21,7 @@ class Lit::Base < ActiveRecord::Base
 
   private
 
-  def create_or_update(*args, &block)
+  def create_or_update(**kwargs, &block)
     @was_saved_with_insert = true if new_record?
     @was_saved_with_update = true if persisted?
 

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!(
-        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!(
-        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

@@ -27,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
 
@@ -41,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/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">
                   <%= 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/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 → initializer.erb}

@@ -3,7 +3,7 @@
 # `nil` will let everyone in.
 Lit.authentication_function = <%= @authentication_function || 'nil' %>
 
-# Which authentication verification function to use (ie. :user_signed_in)?
+# Which authentication verification function to use (ie. :user_signed_in?)?
 # This is used together with frontend translation module to determine, if
 # helper button should be applied and translations wrapped in custom span
 Lit.authentication_verification = <%= @authentication_verification || 'nil' %>
@@ -53,6 +53,11 @@ Lit.set_last_updated_at_upon_creation = true
 # For more information please check the README.md
 Lit.store_request_info = false
 
+# Store request keys - this will store all keys used to render a page. Useful
+# only when combined with Lit::RequestKeysStore concern to view those keys in
+# frontend
+Lit.store_request_keys = false
+
 # Initialize lit
 Lit.init
 

data/lib/generators/lit/install_generator.rb

@@ -11,24 +11,22 @@ module Lit
       desc 'Automates Lit installation'
 
       def set_authentication_function
-        @authentication_function = options['authentication-function'].presence ||
-              ask("What's the authentication function, ie. :authenticate_user! :").presence ||
-              nil
+        @authentication_function =
+          options['authentication-function'].presence ||
+            ask("What's the authentication function, ie. :authenticate_user! :").presence || nil
       end
 
       def set_key_value_engine
-        @key_value_engine = options['key-value-engine'].presence ||
-              ask("What's the key value engine? ([hash] OR redis):").presence ||
-              :hash
+        @key_value_engine =
+          options['key-value-engine'].presence || ask("What's the key value engine? ([hash] OR redis):").presence ||
+            :hash
       end
 
       def add_redis_dependency
         if @key_value_engine == 'redis'
           puts 'Adding redis dependency'
           gem 'redis'
-          Bundler.with_clean_env do
-            run 'bundle install'
-          end
+          Bundler.with_clean_env { run 'bundle install' }
         end
       end
 
@@ -42,7 +40,7 @@ module Lit
           puts 'Skipping config/initializers/lit.rb creation, file already exists!'
         else
           puts 'Adding lit initializer (config/initializers/lit.rb)...'
-          template 'initializer.rb', path
+          template 'initializer.erb', path
         end
       end
 

data/lib/lit/adapters/hash_storage.rb

@@ -1,4 +1,4 @@
-module Lit
+module Lit::Adapters
   class HashStorage < Hash
     def incr(key)
       self[key] ||= 0
@@ -25,7 +25,7 @@ module Lit
 
       cache_localizations = form_cache_localizations(keys_of_subtree)
 
-      full_subtree = Lit::LocalizationKeysToHashService.call(cache_localizations)
+      full_subtree = Lit::Services::LocalizationKeysToHashService.call(cache_localizations)
       requested_part = full_subtree.dig(*key.split('.'))
       return nil if requested_part.blank?
       return requested_part if requested_part.is_a?(String)

data/lib/lit/adapters/redis_storage.rb

@@ -13,7 +13,7 @@ module Lit
     Lit.redis_url || ENV[ENV['REDIS_PROVIDER'] || 'REDIS_URL']
   end
 
-  class RedisStorage
+  class Adapters::RedisStorage
     def initialize
       Lit.redis
     end
@@ -22,14 +22,15 @@ module Lit
     def exists?(key)
       # Use recommended binary-returning method create [with this redis-rb commit](https://github.com/redis/redis-rb/commit/bf42fc9e0db4a1719d9b1ecc65aeb20425d44427).
       return Lit.redis.exists?(key) if Lit.redis.respond_to?(:exists?)
+
       # Fall back with older gem
       Lit.redis.exists(key)
     end
 
     def [](key)
-      if self.exists?(_prefixed_key_for_array(key))
+      if exists?(_prefixed_key_for_array(key))
         Lit.redis.lrange(_prefixed_key(key), 0, -1)
-      elsif self.exists?(_prefixed_key_for_nil(key))
+      elsif exists?(_prefixed_key_for_nil(key))
         nil
       else
         val = Lit.redis.get(_prefixed_key(key))
@@ -43,9 +44,7 @@ module Lit
       delete(k)
       if v.is_a?(Array)
         Lit.redis.set(_prefixed_key_for_array(k), '1')
-        v.each do |ve|
-          Lit.redis.rpush(_prefixed_key(k), ve.to_s)
-        end
+        v.each { |ve| Lit.redis.rpush(_prefixed_key(k), ve.to_s) }
       elsif v.nil?
         Lit.redis.set(_prefixed_key_for_nil(k), '1')
         Lit.redis.set(_prefixed_key(k), '')
@@ -69,7 +68,7 @@ module Lit
     end
 
     def has_key?(key)
-      self.exists?(_prefixed_key(key))
+      exists?(_prefixed_key(key))
     end
     alias key? has_key?
 
@@ -78,9 +77,7 @@ module Lit
     end
 
     def sort
-      Lit.redis.keys.sort.map do |k|
-        [k, self.[](k)]
-      end
+      Lit.redis.keys.sort.map { |k| [k, self.[](k)] }
     end
 
     def prefix
@@ -118,7 +115,7 @@ module Lit
       values_of_subtree = Lit.redis.mget(keys_of_subtree)
       cache_localizations = form_cache_localizations(keys_of_subtree, values_of_subtree)
 
-      full_subtree = Lit::LocalizationKeysToHashService.call(cache_localizations)
+      full_subtree = Lit::Services::LocalizationKeysToHashService.call(cache_localizations)
       requested_part = full_subtree.dig(*key.split('.'))
       return nil if requested_part.blank?
       return requested_part if requested_part.is_a?(String)

data/lib/lit/adapters.rb

@@ -0,0 +1,2 @@
+module Lit::Adapters
+end

data/lib/lit/cache.rb

@@ -18,6 +18,9 @@ end
 
 module Lit
   class Cache
+    @@last_update = nil
+    @@localization_cache = {}
+
     def initialize
       @hits_counter = Lit.get_key_value_engine
       @request_info_store = Lit.get_key_value_engine
@@ -32,6 +35,7 @@ module Lit
 
     def [](key)
       value = nil
+      check_and_clean_if_required
       unless localization_cache.key?(key)
         value = localizations[key]
         localization_cache[key] = value
@@ -81,6 +85,7 @@ module Lit
       locale = find_locale(locale_key)
       localization = find_localization(locale, key_without_locale, value: value, force_array: force_array, update_value: true)
       return localization.translation if startup_process && localization.is_changed?
+
       localizations[key] = localization.translation if localization
       localization_cache[key] = localizations[key]
     end
@@ -120,6 +125,7 @@ module Lit
       @localization_object_cache.delete(key)
       localization = find_localization(locale, key_without_locale, default_fallback: true)
       localizations[key] = localization.translation if localization
+      clear_localization_cache
     end
 
     def delete_key(key)
@@ -175,11 +181,26 @@ module Lit
     end
 
     def localization_cache
-      Thread.current[:lit_thread_cache] ||= {}
+      # Thread.current[:lit_thread_cache] ||= {}
+      @@localization_cache ||= {}
     end
 
     def clear_localization_cache
-      Thread.current[:lit_thread_cache] = {}
+      # Thread.current[:lit_thread_cache] = {}
+      @@localization_cache = {}
+    end
+
+    def check_and_clean_if_required
+      # we want this method to run only once during a request or background job
+      return if Thread.current[:localization_cache_valid]
+
+      # get most recently updated translation and compare with what we store in class var
+      last_up = Lit::Localization.order(updated_at: :desc).limit(1).pluck(:updated_at).first.to_i
+      if last_up != @@last_update
+        clear_localization_cache
+        @@last_update = last_up
+      end
+      Thread.current[:localization_cache_valid] = true
     end
 
     private