lit 1.1.0 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecbd506c6be8279728e5da85a4857dd542c75cdc752efac9745dd7e2ba022a5c
-  data.tar.gz: 45bf91076203d8be22b2da854886657ddb85f07acbc42cd287b9246883e0955d
+  metadata.gz: 7dcf44da1e10a331cafdd9352461c1d9b985c6ea3d97e61744a1390e036be71a
+  data.tar.gz: 3c03d7e70b3c172092d807539543f0389e4e04c7f0420c66ffb5f96f742a4fa6
 SHA512:
-  metadata.gz: b78bb6b6ef52a2010d0725165a0e898d72dbf5fcf843b4ae756291f5648032e12ac1c6ded47a90418b258627c5ea1521e956dbd3e1387f428d623ec144a0c9cc
-  data.tar.gz: ce87f326e76dce205a987bbb1474a154406afd5fda42a9f3b92017cd8912f621a54ef36a16bd1f0861e6193341a0db24220341a8d1c5120cdfbbb3d2438473c5
+  metadata.gz: ecf7688c8aa6f32c6c01fab3b14024720f75155b66ed1be9494c40f0ed4755855e2b73b9d1d528a7a215513316a27ceb3427a84e72e0420f611a4c7e877b6ce0
+  data.tar.gz: 5f4fe480d203c6ade865f44385b4dfb951aa4a32c33f8e224b9371e3f36f5a16acd444ef73136bc28f7278d6518b7681d29540dca11833e6f7ecfc3b776b1386

data/README.md

@@ -22,9 +22,14 @@ Highly inspired by Copycopter by thoughtbot.
 9. (On request) stores paths where translation keys were called
 10. (On request) is able to show all translation keys used to render current page
 
+
 ### Screenshots
 
-Check wiki: [Screenshots](https://github.com/prograils/lit/wiki/Screenshots)
+[Feature overview on YouTube](https://www.youtube.com/watch?v=_T9Kg05VvLI)
+
+![lit live translation](https://prograils-com-stuff.s3.amazonaws.com/lit/lit-front.gif)
+
+Check wiki for more: [Screenshots](https://github.com/prograils/lit/wiki/Screenshots)
 
 ### Installation
 
@@ -37,10 +42,10 @@ gem 'lit'
 
 2. run `bundle install`
 
-3. run installation generator `bundle exec rails g lit:install`
-  (for production/staging environment `redis` is suggested as key value engine. `hash` will not work in multi process environment)
+3. Add `config.i18n.available_locales = [...]` to `application.rb` - it's required to precompile appropriate language flags in lit backend.
 
-4. Add `config.i18n.available_locales = [...]` to `application.rb` - it's required to precompile appropriate language flags in lit backend.
+4. run installation generator `bundle exec rails g lit:install`
+  (for production/staging environment `redis` is suggested as key value engine. `hash` will not work in multi process environment)
 
 5. After doing above and restarting app, point your browser to `http://app/lit`
 
@@ -130,6 +135,10 @@ Lit::CloudTranslation.provider = Lit::CloudTranslation::Providers::Google
 ```
 gem 'google-cloud-translate', '~> 1.2.4'
 ```
+...we also support V2 of Google Cloud Translate gem, should you need it:
+```
+gem 'google-cloud-translate', '~> 2.1.2'
+```
 
 To use translation via Google, you need to obtain a [service account key](https://cloud.google.com/iam/docs/creating-managing-service-account-keys) containing all the credentials required by the API.
 
@@ -145,10 +154,10 @@ These credentials can be given in three ways:
       ... # see Google docs link above for reference
     }
   end
-  
+
   # For example, for Rails 6, from encrypted credentials file (HashWithIndifferentAccess is used, because the keys in
    the credentials.config could be strings or, as well, symbols):
-  
+
   Lit::CloudTranslation.configure do |config|
     config.keyfile_hash = HashWithIndifferentAccess.new(Rails.application.credentials.config[:google_translate_api])
   end
@@ -199,17 +208,17 @@ Also applies to upgrading from `0.4.pre.alpha` versions.
 
 1. Add `Lit::FrontendHelper` to your `ApplicationController`
 
-	```ruby
-	helper Lit::FrontendHelper
-	```
+```ruby
+helper Lit::FrontendHelper
+```
 
 2. In you layout file include lit assets
 
-	```erb
-	<% if admin_user_signed_in? %>
-	  <%= lit_frontend_assets %>
-	<% end %>
-	```
+```erb
+<% if admin_user_signed_in? %>
+  <%= lit_frontend_assets %>
+<% end %>
+```
 
 3. You're good to go - now log in to lit (if required) and open your frontend in separate tab (to have session persisted). On the bottom-right of your page you should see "Enable / disable lit highlight" - after enabling it you'll be able to click and translate phrases directly in your frontend
 
@@ -217,13 +226,14 @@ Also applies to upgrading from `0.4.pre.alpha` versions.
 
 5. This feature requires jQuery! (at least for now)
 
+
 ### Storing request info
 
-1. Include `Lit::Concerns::RequestInfoStore` concern in your `ApplicationController`
+1. Include `Lit::RequestInfoStore` concern in your `ApplicationController`
 
-	```ruby
-	include Lit::Concerns::RequestInfoStore
-	```
+```ruby
+include Lit::RequestInfoStore
+```
 
 2. In lit initializer (`lit.rb`) set `store_request_info` config to true
 
@@ -238,25 +248,31 @@ Lit.store_request_info = true
 
 1. Add `Lit::FrontendHelper` in your `ApplicationController`
 
-	```ruby
-	include Lit::FrontendHelper
-	```
+```ruby
+helper Lit::FrontendHelper
+```
+
+2. Include `Lit::RequestKeysStore` concern in your `ApplicationController`
 
-2. Include `Lit::Concerns::RequestKeysStore` concern in your `ApplicationController`
+```ruby
+include Lit::RequestKeysStore
+```
+
+3. Enable storing of request keys in lit initializer `config/initializers/lit.rb`
 
-	```ruby
-	include Lit::Concerns::RequestKeysStore
-	```
+```ruby
+Lit.store_request_keys = true
+```
 
-3. On the bottom of you layout file call `lit_translations_info` helper function
+4. On the bottom of you layout file call `lit_translations_info` helper function
 
-	```erb
-	<%= lit_translations_info %>
-	```
+```erb
+<%= lit_translations_info %>
+```
 
-4. From now on you'll be able to see all translation keys that were used to render current page. This feature works great with on-site live translations!
+5. From now on you'll be able to see all translation keys that were used to render current page. This feature works great with on-site live translations!
 
-5. Lit authorized user must be signed in for this feature to work! This feature requires jQuery!
+6. Lit authorized user must be signed in for this feature to work! This feature requires jQuery!
 
 
 

data/app/assets/javascripts/lit/backend/localizations.js.coffee

@@ -2,25 +2,32 @@
 $(document).ready ->
   $('td.localization_row[data-editing=0]').on 'click', ->
     $this = $(this)
-    if parseInt($this.data('editing'))==0
+    if parseInt($this.data('editing')) == 0
       edited_rows[$this.data('id')] = $this.html()
       unless parseInt($this.data('editing'))
         $this.data('editing', '1')
         $.get $this.data('edit')
-  $('td.localization_row').on 'click', 'form button.cancel', (e)->
+  $('td.localization_row').on 'click', 'form button.cancel', (e) ->
     $this = $(this)
-    if $this[0].localName=='button'
+    if $this[0].localName == 'button'
       $this = $this.parents('td.localization_row')
     $this.data('editing', 0)
     $this.html edited_rows[$this.data('id')]
     e.preventDefault()
     false
-  $('tr.localization_versions_row').on 'click', '.close_versions', (e)->
+  $('tr.localization_versions_row').on 'click', '.close_versions', (e) ->
     $this = $(this)
     $parent = $this.parents('tr.localization_versions_row')
     $parent.addClass('hidden')
     $parent.children('td').html('')
-  $('tr.localization_key_row').on 'click', 'input.wysiwyg_switch', (e)->
+  $('tr.localization_key_row').on 'click', 'input.wysiwyg_switch', (e) ->
     $(this).parents('form').find("textarea").jqte()
-  $('tr.localization_key_row').on 'click', '.request_info_link', (e)->
+  $('tr.localization_key_row').on 'click', '.request_info_link', (e) ->
     $(this).parents('tr.localization_key_row').find(".request_info_row").toggleClass('hidden')
+  $('tr.localization_key_row').on 'click', '.js-copy_to_clipboard', (e) ->
+    if(!navigator.clipboard)
+      alert('No browser support for clipboard')
+    else
+      navigator.clipboard.writeText($(this).data('key'))
+    e.preventDefault()
+    false

data/app/assets/stylesheets/lit/application.css

@@ -11,17 +11,17 @@
  *= require './backend/jquery-te-1.4.0.css'
  *= require_self
  */
-.detail_wrapper{
-  padding: 10px 0 0 50px;
+.detail_wrapper {
+  padding: 10px 0 0 10px;
 }
-.detail_wrapper table tr td.locale_row{
+.detail_wrapper table tr td.locale_row {
   width: 75px;
 }
-.localization_key_row .localization_keys_options{
+.localization_key_row .localization_keys_options {
   display: none;
   float: right;
 }
-.localization_key_row:hover .localization_keys_options{
+.localization_key_row:hover .localization_keys_options {
   display: block;
 }
 
@@ -29,29 +29,29 @@ li.key_prefix .fa-chevron-right {
   float: right;
   margin-top: 2px;
   margin-right: -6px;
-  opacity: .25;
+  opacity: 0.25;
 }
 
-.hidden{
+.hidden {
   display: none;
 }
-i.fa{
+i.fa {
   color: black;
 }
-.nav.nav-stacked>li>a {
-padding: 5px 7px;
+.nav.nav-stacked > li > a {
+  padding: 5px 7px;
 }
-.well{
+.well {
   background-color: white;
   border-radius: 0px;
 }
-.well label{
+.well label {
   font-weight: normal;
 }
 .well .form-search {
   margin-bottom: 15px;
 }
-.localization_row em{
+.localization_row em {
   color: #bbb;
 }
 .loading {
@@ -60,3 +60,6 @@ padding: 5px 7px;
 .loaded {
   display: none;
 }
+.copy_to_clipboard_btn {
+  cursor: pointer;
+}

data/app/assets/stylesheets/lit/lit_frontend.css

@@ -1,9 +1,11 @@
 .lit-key-generic {
 }
-.lit-key-highlight{
-  text-decoration: underline wavy red !important;
+.lit-key-highlight {
+  text-decoration: underline !important;
+  text-decoration-color: red !important;
+  text-decoration-style: wavy !important;
 }
-#lit_button_wrapper{
+#lit_button_wrapper {
   position: fixed;
   bottom: 20px;
   right: 20px;
@@ -15,16 +17,15 @@
   cursor: pointer;
   color: white;
 }
-#lit_button_wrapper.lit-highlight-enabled{
+#lit_button_wrapper.lit-highlight-enabled {
   background-color: lightgreen;
 }
-#lit_textarea{
+#lit_textarea {
   position: absolute;
   padding: 0 0 1px 0;
   margin: 0 0 0 0;
   border: 0;
   border-bottom: 1px solid red;
-
 }
 .lit-translations-info.collapsed {
   position: fixed;
@@ -38,7 +39,7 @@
   cursor: pointer;
   color: white;
 }
-.lit-translations-info.expanded{
+.lit-translations-info.expanded {
   position: absolute;
   display: block;
   width: 80%;
@@ -52,16 +53,16 @@
   z-index: 90;
 }
 
-.lit-translations-info.collapsed span.lit-open-button{
+.lit-translations-info.collapsed span.lit-open-button {
   display: block;
 }
-.lit-translations-info.expanded span.lit-open-button{
+.lit-translations-info.expanded span.lit-open-button {
   display: none;
 }
-.lit-translations-info.collapsed span.lit-close-button{
+.lit-translations-info.collapsed span.lit-close-button {
   display: none;
 }
-.lit-translations-info.expanded span.lit-close-button{
+.lit-translations-info.expanded span.lit-close-button {
   display: block;
   position: fixed;
   right: 10%;
@@ -71,16 +72,16 @@
   background-color: white;
   padding: 10px 10px 5px;
 }
-.lit-translations-info.collapsed ul.lit-translations-list{
+.lit-translations-info.collapsed ul.lit-translations-list {
   display: none;
 }
-.lit-translations-info.expanded ul.lit-translations-list{
+.lit-translations-info.expanded ul.lit-translations-list {
 }
 
-.lit-translations-info.expanded ul.lit-translations-list li{
+.lit-translations-info.expanded ul.lit-translations-list li {
   margin: 5px;
 }
 
-.lit-translations-info.expanded #lit_textarea{
+.lit-translations-info.expanded #lit_textarea {
   padding: 2px;
 }

data/app/controllers/lit/api/v1/localizations_controller.rb

@@ -2,34 +2,26 @@ module Lit
   class Api::V1::LocalizationsController < Api::V1::BaseController
     def index
       @localizations = fetch_localizations
-      render json: @localizations.as_json(
-        root: false,
-        only: %i[id localization_key_id locale_id],
-        methods: %i[
-          value localization_key_str locale_str
-          localization_key_is_deleted
-        ]
-      )
+      render json:
+               @localizations.as_json(
+                 root: false,
+                 only: %i[id localization_key_id locale_id],
+                 methods: %i[value localization_key_str locale_str localization_key_is_deleted],
+               )
     end
 
     def last_change
       @localization = Localization.order(updated_at: :desc).first
-      render json: @localization.as_json(
-        root: false, only: [], methods: [:last_change]
-      )
+      render json: @localization.as_json(root: false, only: [], methods: [:last_change])
     end
 
     private
 
     def fetch_localizations
-      scope = Localization.includes(
-        :locale,
-        :localization_key
-      )
+      scope = Localization.includes(:locale, :localization_key)
 
       if params[:after].present?
-        after_date = Time.parse("#{params[:after]} #{Time.zone.name}")
-                         .in_time_zone
+        after_date = Time.parse("#{params[:after]} #{Time.zone.name}").in_time_zone
         scope.after(after_date).to_a
       else
         scope.all

data/app/controllers/lit/cloud_translations_controller.rb

@@ -18,7 +18,7 @@ module Lit
           from: params[:from],
           to: @target_localization.locale.locale
         }.compact
-      @translated_text = Lit::CloudTranslation.translate(opts)
+      @translated_text = Lit::CloudTranslation.translate(**opts)
     rescue Lit::CloudTranslation::TranslationError => e
       @error_message = "Translation failed. #{e.message}"
     end

data/app/controllers/lit/concerns/request_info_store.rb

@@ -1,17 +1,8 @@
-module Lit
-  module Concerns
-    module RequestInfoStore
-      extend ::ActiveSupport::Concern
-      included do
-        before_action :store_request_path
-      end
+module Lit::Concerns::RequestInfoStore
+  extend ActiveSupport::Concern
 
-      private
-
-      def store_request_path
-        Thread.current[:lit_current_request_path] = request&.path
-      end
-    end
+  included do
+    Rails.logger.info 'DEPRECATED: Use include Lit::RequestInfoStore'
+    include Lit::RequestInfoStore
   end
 end
-

data/app/controllers/lit/concerns/request_keys_store.rb

@@ -1,16 +1,8 @@
-module Lit
-  module Concerns
-    module RequestKeysStore
-      extend ::ActiveSupport::Concern
-      included do
-        before_action :init_request_keys
-      end
+module Lit::Concerns::RequestKeysStore
+  extend ActiveSupport::Concern
 
-      private
-
-      def init_request_keys
-        Thread.current[:lit_request_keys] = {}
-      end
-    end
+  included do
+    Rails.logger.info 'DEPRECATED: Use include Lit::RequestKeysStore'
+    include Lit::RequestKeysStore
   end
 end

data/app/controllers/lit/localization_keys_controller.rb

@@ -1,9 +1,7 @@
 module Lit
   class LocalizationKeysController < ::Lit::ApplicationController
-    before_action :find_localization_scope,
-                  except: %i[destroy find_localization]
-    before_action :find_localization_key,
-                  only: %i[star destroy change_completed restore_deleted]
+    before_action :find_localization_scope, except: %i[destroy find_localization]
+    before_action :find_localization_key, only: %i[star destroy change_completed restore_deleted]
 
     def index
       get_localization_keys
@@ -20,27 +18,19 @@ module Lit
     end
 
     def find_localization
-      localization_key = Lit::LocalizationKey.find_by!(
-        localization_key: params[:key]
-      )
+      localization_key = Lit::LocalizationKey.find_by!(localization_key: params[:key])
       locale = Lit::Locale.find_by!(locale: params[:locale])
       localization = localization_key.localizations.find_by(locale_id: locale)
-      render json: {
-        path: localization_key_localization_path(localization_key, localization)
-      }
+      render json: { path: localization_key_localization_path(localization_key, localization) }
     end
 
     def starred
       @scope = @scope.where(is_starred: true)
 
-      if defined?(Kaminari) &&
-         @scope.respond_to?(Kaminari.config.page_method_name)
+      if defined?(Kaminari) && @scope.respond_to?(Kaminari.config.page_method_name)
         @scope = @scope.send(Kaminari.config.page_method_name, params[:page])
       end
-      if defined?(WillPaginate) &&
-         @scope.respond_to?(:paginate)
-        @scope = @scope.paginate(page: params[:page])
-      end
+      @scope = @scope.paginate(page: params[:page]) if defined?(WillPaginate) && @scope.respond_to?(:paginate)
       get_localization_keys
       render action: :index
     end
@@ -66,6 +56,16 @@ module Lit
       respond_to :js
     end
 
+    def batch_touch
+      get_localization_keys
+      localization_key_ids = @scope.distinct(false).pluck(:id)
+      if localization_key_ids.any?
+        @scope.distinct(false).update_all updated_at: Time.current
+        Localization.where(localization_key_id: localization_key_ids).update_all updated_at: Time.current
+      end
+      respond_to :js
+    end
+
     private
 
     def find_localization_key
@@ -73,19 +73,16 @@ module Lit
     end
 
     def find_localization_scope
-      @search_options = if params.respond_to?(:permit)
-                          params.permit(*valid_keys)
-                        else
-                          params.slice(*valid_keys)
-                        end
-      @scope = LocalizationKey.distinct.active
-                              .preload(localizations: :locale)
-                              .search(@search_options)
+      @search_options = params.respond_to?(:permit) ? params.permit(*valid_keys) : params.slice(*valid_keys)
+      @scope = LocalizationKey.distinct.active.preload(localizations: :locale).search(@search_options)
     end
 
     def get_localization_keys
       key_parts = @search_options[:key_prefix].to_s.split('.').length
-      @prefixes = @scope.reorder(nil).distinct.pluck(:localization_key).map { |lk| lk.split('.').shift(key_parts + 1).join('.') }.uniq.sort
+      @prefixes =
+        @scope.reorder(nil).distinct.pluck(:localization_key).map do |lk|
+          lk.split('.').shift(key_parts + 1).join('.')
+        end.uniq.sort
       if @search_options[:key_prefix].present?
         parts = @search_options[:key_prefix].split('.')
         @parent_prefix = parts[0, parts.length - 1].join('.')
@@ -104,16 +101,15 @@ module Lit
     end
 
     def grouped_localizations
-      @_grouped_localizations ||= begin
-        {}.tap do |hash|
-          @localization_keys.each do |lk|
-            hash[lk] = {}
-            lk.localizations.each do |l|
-              hash[lk][l.locale.locale.to_sym] = l
+      @_grouped_localizations ||=
+        begin
+          {}.tap do |hash|
+            @localization_keys.each do |lk|
+              hash[lk] = {}
+              lk.localizations.each { |l| hash[lk][l.locale.locale.to_sym] = l }
             end
           end
         end
-      end
     end
 
     def localization_for(locale, localization_key)
@@ -136,12 +132,16 @@ module Lit
     helper_method :localization_for
 
     def versions?(localization)
-      @_versions ||= begin
-        ids = grouped_localizations.values.map(&:values).flatten.map(&:id)
-        Lit::Localization.active.where(id: ids).joins(:versions).group(
-          "#{Lit::Localization.quoted_table_name}.id"
-        ).count
-      end
+      @_versions ||=
+        begin
+          ids = grouped_localizations.values.map(&:values).flatten.map(&:id)
+          Lit::Localization
+            .active
+            .where(id: ids)
+            .joins(:versions)
+            .group("#{Lit::Localization.quoted_table_name}.id")
+            .count
+        end
       @_versions[localization.id].to_i > 0
     end
     helper_method :versions?

data/app/controllers/lit/request_info_store.rb

@@ -0,0 +1,10 @@
+module Lit::RequestInfoStore
+  extend ::ActiveSupport::Concern
+  included { before_action :store_request_path }
+
+  private
+
+  def store_request_path
+    Thread.current[:lit_current_request_path] = request&.path
+  end
+end

data/app/controllers/lit/request_keys_store.rb

@@ -0,0 +1,10 @@
+module Lit::RequestKeysStore
+  extend ::ActiveSupport::Concern
+  included { before_action :init_request_keys }
+
+  private
+
+  def init_request_keys
+    Thread.current[:lit_request_keys] = {}
+  end
+end