lit 1.1.0 → 1.1.5

data/lib/lit/cloud_translation/providers/google.rb

@@ -45,13 +45,10 @@ module Lit::CloudTranslation::Providers
   #   end
   class Google < Base
     def translate(text:, from: nil, to:, **opts)
-      @client ||=
-        ::Google::Cloud::Translate.new(project_id: config.keyfile_hash['project_id'],
-                                       credentials: config.keyfile_hash)
-      result = @client.translate(sanitize_text(text), from: from, to: to, **opts)
+      result = client.translate(sanitize_text(text), from: from, to: to, **opts)
       unsanitize_text(
         case result
-        when ::Google::Cloud::Translate::Translation then result.text
+        when translation_class then result.text
         when Array then result.map(&:text)
         end
       )
@@ -67,6 +64,27 @@ module Lit::CloudTranslation::Providers
 
     private
 
+    def client
+      @client ||= begin
+        args = {
+          project_id: config.keyfile_hash['project_id'], credentials: config.keyfile_hash,
+          version: :v2
+        }
+        if Gem.loaded_specs['google-cloud-translate'].version < Gem::Version.create('2.0')
+          args = args.tap { |hs| hs.delete(:version) }
+        end
+        ::Google::Cloud::Translate.new(**args)
+      end
+    end
+
+    def translation_class
+      if Gem.loaded_specs['google-cloud-translate'].version < Gem::Version.create('2.0')
+        ::Google::Cloud::Translate::Translation
+      else
+        ::Google::Cloud::Translate::V2::Translation
+      end
+    end
+
     def default_config
       if ENV['GOOGLE_TRANSLATE_API_KEYFILE'].blank?
         env_keys = ENV.keys.grep(/\AGOOGLE_TRANSLATE_API_/)
@@ -93,7 +111,7 @@ module Lit::CloudTranslation::Providers
     def sanitize_text(text_or_array)
       case text_or_array
       when String
-        text_or_array.gsub(/%{(.+?)}/, '<code>__LIT__\1__LIT__</code>')
+        text_or_array.gsub(/%{(.+?)}/, '<code>__LIT__\1__LIT__</code>').gsub(/\r\n/, '<code>0</code>')
       when Array
         text_or_array.map { |s| sanitize_text(s) }
       when nil
@@ -106,7 +124,7 @@ module Lit::CloudTranslation::Providers
     def unsanitize_text(text_or_array)
       case text_or_array
       when String
-        text_or_array.gsub(/<code>__LIT__(.+?)__LIT__<\/code>/, '%{\1}')
+        text_or_array.gsub(%r{<code>0</code>}, "\r\n").gsub(%r{<code>__LIT__(.+?)__LIT__</code>}, '%{\1}')
       when Array
         text_or_array.map { |s| unsanitize_text(s) }
       else

data/lib/lit/engine.rb

@@ -4,6 +4,8 @@ module Lit
 
     config.autoload_paths += %W[#{Lit::Engine.root}/app/controllers/lit/concerns]
 
+    paths.add 'lib'
+
     isolate_namespace Lit
 
     initializer 'lit.assets.precompile' do |app|
@@ -12,16 +14,12 @@ module Lit
     end
 
     initializer 'lit.reloader' do |app|
-      config.to_prepare do
-        Lit.loader.cache.reset_local_cache if Lit.loader
-      end
+      config.to_prepare { Lit.loader.cache.reset_local_cache if Lit.loader }
     end
 
     initializer 'lit.migrations.append' do |app|
       unless app.root.to_s.include?(root.to_s)
-        config.paths['db/migrate'].expanded.each do |expanded_path|
-          app.config.paths['db/migrate'] << expanded_path
-        end
+        config.paths['db/migrate'].expanded.each { |expanded_path| app.config.paths['db/migrate'] << expanded_path }
       end
     end
 

data/lib/lit/export.rb

@@ -4,7 +4,7 @@ require 'lit/services/localization_keys_to_hash_service'
 module Lit
   class Export
     def self.call(locale_keys:, format:, include_hits_count: false)
-      raise ArgumentError, "format must be yaml or csv" if %i[yaml csv].exclude?(format)
+      raise ArgumentError, 'format must be yaml or csv' if %i[yaml csv].exclude?(format)
       Lit.loader.cache.load_all_translations
       localizations_scope = Lit::Localization.active
       if locale_keys.present?
@@ -12,13 +12,11 @@ module Lit
         localizations_scope = localizations_scope.where(locale_id: locale_ids) unless locale_ids.empty?
       end
       db_localizations = {}
-      localizations_scope.find_each do |l|
-        db_localizations[l.full_key] = l.translation
-      end
+      localizations_scope.find_each { |l| db_localizations[l.full_key] = l.translation }
 
       case format
       when :yaml
-        exported_keys = Lit::LocalizationKeysToHashService.call(db_localizations)
+        exported_keys = Lit::Services::LocalizationKeysToHashService.call(db_localizations)
         exported_keys.to_yaml
       when :csv
         relevant_locales = locale_keys.presence || I18n.available_locales.map(&:to_s)
@@ -46,9 +44,7 @@ module Lit
               relevant_locales.map { |l| Array.wrap(db_localizations["#{l}.#{key_without_locale}"]) }
             transpose(key_localizations_per_locale).each do |translation_series|
               csv_row = [key_without_locale, *translation_series]
-              if include_hits_count
-                csv_row << (Lit.init.cache.get_global_hits_counter(key_without_locale) || 0)
-              end
+              csv_row << (Lit.init.cache.get_global_hits_counter(key_without_locale) || 0) if include_hits_count
               csv << csv_row
             end
           end
@@ -59,9 +55,7 @@ module Lit
     # This is like Array#transpose but ignores size differences between inner arrays.
     private_class_method def self.transpose(matrix)
       maxlen = matrix.max { |x| x.length }.length
-      matrix.each do |array|
-        array[maxlen - 1] = nil if array.length < maxlen
-      end
+      matrix.each { |array| array[maxlen - 1] = nil if array.length < maxlen }
       matrix.transpose
     end
   end

data/lib/lit/i18n_backend.rb

@@ -16,9 +16,22 @@ module Lit
       I18n.const_set(:RESERVED_KEYS, reserved_keys.freeze)
     end
 
+    ## DOC
+    ## Translation flow starts with Rails-provided ActionView::Helpers::TranslationHelper `translate` method
+    ## In that method any calls to `I18n.translate` are catched by this method below (because Lit acts as I18 backend)
+    ## Any calls in Lit to `super` go straight to I18n
     def translate(locale, key, options = {})
       options[:lit_default_copy] = options[:default].dup if can_dup_default(options)
       content = super(locale, key, options)
+
+      if on_rails_6_1_or_higher?
+        @untranslated_key = key if key.present? && options[:default].instance_of?(Object)
+
+        if key.nil? && options[:lit_default_copy].present?
+          update_default_localization(locale, content, options)
+        end
+      end
+
       if Lit.all_translations_are_html_safe && content.respond_to?(:html_safe)
         content.html_safe
       else
@@ -54,6 +67,17 @@ module Lit
 
     private
 
+    def on_rails_6_1_or_higher?
+      "#{::Rails::VERSION::MAJOR}#{::Rails::VERSION::MINOR}".to_i == 61 ||
+        ::Rails::VERSION::MAJOR >= 7
+    end
+
+    def update_default_localization(locale, content, options)
+      parts = I18n.normalize_keys(locale, @untranslated_key, options[:scope], options[:separator])
+      key_with_locale = parts.join('.')
+      @cache.update_locale(key_with_locale, content, content.is_a?(Array))
+    end
+
     def can_dup_default(options = {})
       return false unless options.key?(:default)
       return true if options[:default].is_a?(String)

data/lib/lit/import.rb

@@ -3,14 +3,14 @@ require 'csv'
 module Lit
   class Import
     class << self
-      def call(*args)
-        new(*args).perform
+      def call(**kwargs)
+        new(**kwargs).perform
       end
     end
 
     attr_reader :input, :locale_keys, :format, :skip_nil
 
-    def initialize(input:, locale_keys: [], format:, skip_nil: true, dry_run: false, raw: false)
+    def initialize(input:, format:, locale_keys: [], skip_nil: true, dry_run: false, raw: false)
       raise ArgumentError, 'format must be yaml or csv' if %i[yaml csv].exclude?(format.to_sym)
       @input = input
       @locale_keys = locale_keys.presence || I18n.available_locales
@@ -143,7 +143,7 @@ module Lit
                          .find_by('localization_key = ? and locale = ?', key, locale)
 
         return unless existing_translation
-        
+
         if @raw
           existing_translation.update(default_value: value)
         else

data/lib/lit/middleware.rb

@@ -0,0 +1,29 @@
+require 'rack/body_proxy'
+
+# A middleware that ensures the lit thread value is cleared after
+# the last part of the body is rendered. This is useful when
+# using streaming.j
+#
+# Uses Rack::BodyProxy, adapted from Rack::Lock's usage of the
+# same pattern.
+#
+
+module Lit
+  class Middleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      Thread.current[:localization_cache_valid] = false
+      response = @app.call(env)
+
+      # for streaming support wrap request in Rack::BodyProxy
+      response << Rack::BodyProxy.new(response.pop) do
+        Thread.current[:localization_cache_valid] = false
+      end
+    ensure
+      Thread.current[:localization_cache_valid] = false
+    end
+  end
+end

data/lib/lit/rails.rb

@@ -11,6 +11,7 @@ module Lit
 end
 
 if defined?(Rails::Railtie)
+  require 'lit/middleware'
   require 'lit/railtie'
 else
   Lit::Rails.initialize

data/lib/lit/railtie.rb

@@ -1,12 +1,11 @@
 module Lit
   class Railtie < ::Rails::Railtie
-    ## INITIALIZE IN config/initialize if you want to use redis!!!
-    initializer :initialize_lit_rails, after: :before_initialize do
-      # Lit::Rails.initialize
-    end
+    initializer :lit_middleware do |app|
+      app.config.middleware.insert_after ActionDispatch::RequestId, Lit::Middleware
 
-    # rake_tasks do
-    # load "tasks/lit_tasks.rake"
-    # end
+      ActiveSupport::Reloader.to_complete do
+        Thread.current[:localization_cache_valid] = false
+      end
+    end
   end
 end

data/lib/lit/services/localization_keys_to_hash_service.rb

@@ -1,23 +1,26 @@
 # frozen_string_literal: true
 
 module Lit
-  # Converts flat hash with localization_keys as keys and translations as values to nested hash
-  # by nesting on '.' localization key dots
-  class LocalizationKeysToHashService
-    # http://subtech.g.hatena.ne.jp/cho45/20061122
-    def self.call(db_localizations)
-      deep_proc = proc do |_k, s, o|
-        next s.merge(o, &deep_proc) if s.is_a?(Hash) && o.is_a?(Hash)
+  module Services
+    # Converts flat hash with localization_keys as keys and translations as values to nested hash
+    # by nesting on '.' localization key dots
+    class LocalizationKeysToHashService
+      # http://subtech.g.hatena.ne.jp/cho45/20061122
+      def self.call(db_localizations)
+        deep_proc =
+          proc do |_k, s, o|
+            next s.merge(o, &deep_proc) if s.is_a?(Hash) && o.is_a?(Hash)
 
-        next o
+            next o
+          end
+        nested_keys = {}
+        db_localizations.sort.each do |k, v|
+          key_parts = k.to_s.split('.')
+          converted = key_parts.reverse.reduce(v) { |a, n| { n => a } }
+          nested_keys.merge!(converted, &deep_proc)
+        end
+        nested_keys
       end
-      nested_keys = {}
-      db_localizations.sort.each do |k, v|
-        key_parts = k.to_s.split('.')
-        converted = key_parts.reverse.reduce(v) { |a, n| { n => a } }
-        nested_keys.merge!(converted, &deep_proc)
-      end
-      nested_keys
     end
   end
 end

data/lib/lit/version.rb

@@ -1,3 +1,17 @@
+# frozen_string_literal: true
+
 module Lit
-  VERSION = '1.1.0'.freeze
+  module_function
+
+  def version
+    Gem::Version.new Version::STRING
+  end
+
+  module Version
+    MAJOR = 1
+    MINOR = 1
+    TINY = 5
+
+    STRING = [MAJOR, MINOR, TINY].compact.join('.')
+  end
 end

data/lib/lit.rb

@@ -1,5 +1,6 @@
 require 'lit/engine'
 require 'lit/loader'
+require 'lit/adapters'
 
 module Lit
   mattr_accessor :authentication_function
@@ -30,7 +31,7 @@ module Lit
       self.loader ||= Loader.new
       Lit.humanize_key = false if Lit.humanize_key.nil?
       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 = %w[i18n date datetime number time support]
       Lit.humanize_key_ignored |= Lit.humanize_key_ignored_keys
       Lit.humanize_key_ignored = Regexp.new("(#{Lit.humanize_key_ignored.join('|')}).*")
       Lit.ignore_yaml_on_startup = true if Lit.ignore_yaml_on_startup.nil?
@@ -42,6 +43,7 @@ module Lit
       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
@@ -55,10 +57,10 @@ module Lit
   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")}"
+        "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
@@ -68,18 +70,16 @@ module Lit
     case Lit.key_value_engine
     when 'redis'
       require 'lit/adapters/redis_storage'
-      return RedisStorage.new
+      return ::Lit::Adapters::RedisStorage.new
     else
       require 'lit/adapters/hash_storage'
-      return HashStorage.new
+      return ::Lit::Adapters::HashStorage.new
     end
   end
 
   def self.fallback=(_value)
-    ::Rails.logger.error "[DEPRECATION] Lit.fallback= has been deprecated, please use `config.i18n.fallbacks` instead"
+    ::Rails.logger.error '[DEPRECATION] Lit.fallback= has been deprecated, please use `config.i18n.fallbacks` instead'
   end
 end
 
-if defined? Rails
-  require 'lit/rails'
-end
+require 'lit/rails' if defined?(Rails)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lit
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.5
 platform: ruby
 authors:
 - Maciej Litwiniuk
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-03 00:00:00.000000000 Z
+date: 2021-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -19,14 +19,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
@@ -89,14 +89,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.0
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: devise
   requirement: !ruby/object:Gem::Requirement
@@ -111,20 +111,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.7.1
-- !ruby/object:Gem::Dependency
-  name: google-cloud-translate
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.2.4
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.2.4
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -233,6 +219,8 @@ files:
 - app/controllers/lit/locales_controller.rb
 - app/controllers/lit/localization_keys_controller.rb
 - app/controllers/lit/localizations_controller.rb
+- app/controllers/lit/request_info_store.rb
+- app/controllers/lit/request_keys_store.rb
 - app/controllers/lit/sources_controller.rb
 - app/helpers/lit/application_helper.rb
 - app/helpers/lit/dashboard_helper.rb
@@ -272,6 +260,7 @@ files:
 - app/views/lit/localization_keys/_localization_row.html.erb
 - app/views/lit/localization_keys/_localizations_list.html.erb
 - app/views/lit/localization_keys/_sidebar.html.erb
+- app/views/lit/localization_keys/batch_touch.js.erb
 - app/views/lit/localization_keys/change_completed.js.erb
 - app/views/lit/localization_keys/destroy.js.erb
 - app/views/lit/localization_keys/index.html.erb
@@ -304,9 +293,10 @@ files:
 - db/migrate/20181018075955_lit_add_localization_key_is_deleted_to_localization_keys.rb
 - db/migrate/20181030111522_lit_add_is_visited_again_to_localization_keys.rb
 - db/migrate/20181129103819_lit_add_localization_key_locale_unique_index_to_localizations.rb
-- lib/generators/lit/install/templates/initializer.rb
+- lib/generators/lit/install/templates/initializer.erb
 - lib/generators/lit/install_generator.rb
 - lib/lit.rb
+- lib/lit/adapters.rb
 - lib/lit/adapters/hash_storage.rb
 - lib/lit/adapters/redis_storage.rb
 - lib/lit/cache.rb
@@ -319,6 +309,7 @@ files:
 - lib/lit/i18n_backend.rb
 - lib/lit/import.rb
 - lib/lit/loader.rb
+- lib/lit/middleware.rb
 - lib/lit/rails.rb
 - lib/lit/railtie.rb
 - lib/lit/services/localization_keys_to_hash_service.rb
@@ -343,7 +334,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Database powered i18n backend with web gui