lit 0.3.3 → 0.4.0.pre.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c4bb066b08ec7f1bb1cbd9992dca9e572acde0e
-  data.tar.gz: 704bb8463f8f8f6ff83bd5f0c5b63937323db920
+  metadata.gz: 6bcba84c0fc5b731bbbbd07f38d7a263f1778869
+  data.tar.gz: 105fcbf83b9b7df7f19eee1a33dc60802ff0703e
 SHA512:
-  metadata.gz: 63086561d6b158cbe8ae12a97cc3c6a29d78f1905a4bec3378247f9bb12a13a0cae19d5c0cdcbf4edcb2cfb626058feceb13199a7e290a43b05fdafdb6da9c15
-  data.tar.gz: 8413129a9c31d0c01cd2b6c97dd497d4a018f46848833685e4b27cd77fb5fc6872fe55da123e08c761edc2b0bab264af0ece86052bc159a7bb6a315dd6a632bc
+  metadata.gz: 9aeaae0bb50a36db06603cbe05323d12ac63ee6635acf76f8b70db0dbef5db694f063fabac4eb1416724c121b46d1cee1cc434ae988d59472e7528a8ec24f301
+  data.tar.gz: 277a1d97c1737886c8b5a0536336515f1bbc58dab0c0d4385b5f11dbd956136aafc0d1f040def8cf8ea0866bd5cfb5aaaff9eabc70b2b4e5d693777721ca6b86

data/README.md

@@ -16,7 +16,7 @@ Highly inspired by Copycopter by thoughtbot.
 3. Versioning translations - you can always check, how value did look like in past
 4. Possibility to synchronize translations between environments or apps
 5. Easy to install - works as an engine, comes with simple generator
-6. You can always export all translations to plain old YAML file
+6. You can always export all translations to plain old YAML file which can then be imported elsewhere. Translations can also be exported to (and then imported from) a CSV file so that e.g. a third party can easily edit translations for you using any spreadsheet editor, without access to your website's Lit panel.
 7. Has build in wysiwyg editor ([jQuery TE](http://jqueryte.com/))
 8. Translating apps directly in frontend (see bellow)
 9. (On request) stores paths where translation keys were called
@@ -50,26 +50,60 @@ gem 'lit'
 You may want to take a look at generated initializer in `config/initializers/lit.rb` and change some default configuration options.
 
 ### So... again - what is it and how to use it?
-*Lit* is Rails engine - it runs in it's own namespace, by default it's avaulable under `/lit`. It provides UI for managing translations of your app.
+*Lit* is Rails engine - it runs in it's own namespace, by default it's available under `/lit`. It provides UI for managing translations of your app.
 
-Once you call `I18n.t()` function from your views, *Lit* is asked whether it has or not proper value for it. If translation is present in database and is available for *Lit*, it's served back. If it does not exists, record is automatically created in database with initial value provided in `default` option key. If `default` key is not present, value `nil` is saved to database. When app is starting, *Lit* will preload all keys from your local `config/locale/*.yml` files - this is why app startup may take a while.
+Once you call `I18n.t()` function from your views, *Lit* is asked whether it has or not proper value for it. If translation is present in database and is available for *Lit*, it's served back. If it does not exist, record is automatically created in database with initial value provided in `default` option key. If `default` key is not present, value `nil` is saved to database. When app is starting, *Lit* will preload all keys from your local `config/locale/*.yml` files - this is why app startup may take a while.
 
 To optimize translation key lookup, *Lit* can use different cache engines. For production with many workers `redis` is suggested, for local development `hash` will be fine (`hash` is stored in memory, so if you have many workers and will update translation value in backend, only one worker will have proper translation in it's cache - db will be updated anyway).
 
 Keys ending with `_html` have auto wysiwyg support.
 
-You can also export translations using rake task
+### Import and export
 
+#### Export
+
+Translations can be exported using the `lit:export` rake task:
 ```bash
 $ rake lit:export
 ```
 
-You may also give it extra env variables to limit the export results.
+The task exports to YAML format by default, which can be overridden by setting the `FORMAT` environment variable to `csv`.
+As well as this, by default, it exports all of your application's locales; using the `LOCALES` environment variable you can limit it to specific locales.
+Using `OUTPUT` environment variable you can specify the output file (defaults to `config/locales/lit.yml` or `.csv`).
+
+ For example:
+```bash
+$ rake lit:export FORMAT=csv LOCALES=en,pl OUTPUT=export.csv
+```
+...will only export the `en` and `pl` locales, producing CSV output to `export.csv` in the current folder.
+
+Using the task `lit:export_splitted` does the same as `lit:export` but splits the locales by their name (`config/locales/en.yml`, etc).
+
+#### Import
+
+Translation import is handled using the `lit:import` task, where imported file name should be specified in the `FILE` envionment variable:
+```bash
+$ rake lit:import FILE=stuff.csv
+```
+
+Optionally, `LOCALES` and `SKIP_NIL` environment variables can be used to select specific locales to import from a multi-locale CSV file and to prevent nil values from being set as translated values for localizations, respectively.
+The following call:
+```bash
+$ rake lit:import FILE=stuff.csv LOCALES=en,pl SKIP_NIL=1
+```
+...will only load `en` and `pl` locales from the file, skipping nil values.
 
+Additionally, there is the `lit:warm_up_keys` task (temporarily aliased as `lit:raw_import` for compatibility) which serves a different purpose: rather than for actual import of translations, it is intended to pre-load into database translations from a specific locale's YAML file **when the application is first deployed to a server and not all translation keys are present in the database yet**. This task also takes the `SKIP_NIL` option in a similar way as the import task.
 ```bash
-$ LOCALES=en,de rake lit:export
+$ rake lit:warm_up_keys FILES=config/locales/en.yml LOCALES=en
 ```
+In this case, when the `config/locales/en.yml` contains a translation for `foo` which doesn't have a key in the DB yet, it will be created, but if it already exists in the DB with a translation, it won't be overridden.
+
+#### Deleted keys
+
+Keys marked as deleted (i.e. still existing but deleted from the Lit UI) are *not* exported. In order to make these keys exported again, you need to restore them from the "Deleted and visited again" view.
 
+Deleted keys whose translations are encountered during import are restored automatically.
 
 ### 0.2 -> 0.3 upgrade guide
 

data/app/assets/javascripts/lit/lit_frontend.js

@@ -7,15 +7,22 @@
     replaceWithForm, submitForm, removeLitForm;
 
   buildLocalizationForm = function(e){
+    e.stopPropagation();
+
     var $this = $(this);
+
+    if($this.is(':focus'))
+      return false;
+
     var meta = $('meta[name="lit-url-base"]');
-    if(meta.length > 0){
+
+    if(meta.length > 0)
       getLocalizationPath($this, meta);
-      //replaceWithForm(e.currentTarget, value, update_path)
-    }
-    e.stopPropagation();
+    else
+      console.error('cannot find lit base url');
+
     return false;
-  }
+  };
 
   getLocalizationPath = function(elem, metaElem) {
     $.getJSON(metaElem.attr('value'),
@@ -38,8 +45,9 @@
   replaceWithForm = function(elem, value, update_path){
     removeLitForm();
     var $this = $(elem);
-    $this.attr('contentEditable', true);
-    $this.html( value );
+    $this.attr('contenteditable', true);
+    if(value)
+      $this.html(value);
     $this.focus();
     $this.on('blur', function(){
       submitForm($this, $this.html(), update_path);
@@ -59,15 +67,15 @@
         console.log('saved ' + elem.data('key'));
       },
       error: function(){
-        console.log('problem saving ' + elem.data('key'));
-        alert('ups, ops, something went wrong');
+        console.error('cannot save ' + elem.data('key'));
+        alert('cannot save ' + elem.data('key'));
       }
     });
   };
 
   removeLitForm = function(){
     $('#litForm').remove();
-  }
+  };
 
   $(document).ready(function(){
     $('<div id="lit_button_wrapper" />').appendTo('body');
@@ -75,14 +83,14 @@
     $btn.on('click', function(){
       removeLitForm();
       if($btn.hasClass('lit-highlight-enabled')){
-        $('.lit-key-generic').removeClass('lit-key-highlight').off('click.form');
+        $('.lit-key-generic').removeClass('lit-key-highlight').off('click.lit');
         $btn.removeClass('lit-highlight-enabled');
         $('.lit-key-generic').each(function(_, elem){
           $elem = $(elem);
           $elem.attr('title', $elem.data('old-title') || '');
         });
       }else{
-        $('.lit-key-generic').addClass('lit-key-highlight').on('click.form', buildLocalizationForm);
+        $('.lit-key-generic').addClass('lit-key-highlight').on('click.lit', buildLocalizationForm);
         $btn.addClass('lit-highlight-enabled');
         $('.lit-key-generic').each(function(_, elem){
           $elem = $(elem);

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

@@ -48,6 +48,9 @@ padding: 5px 7px;
 .well label{
   font-weight: normal;
 }
+.well .form-search {
+  margin-bottom: 15px;
+}
 .localization_row em{
   color: #bbb;
 }

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

@@ -3,7 +3,7 @@ module Lit
     module V1
       class BaseController < ActionController::Base
         layout nil
-        respond_to :json
+        respond_to :json if ::Rails::VERSION::MAJOR < 5
         before_action :authenticate_requests!
 
         private

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

@@ -6,7 +6,7 @@ module Lit
       class LocalesController < Api::V1::BaseController
         def index
           @locales = Locale.all
-          render json: @locales.as_json(root: false, only: [:id, :locale])
+          render json: @locales.as_json(root: false, only: %i[id locale])
         end
       end
     end

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

@@ -3,13 +3,21 @@ require_dependency 'lit/api/v1/base_controller'
 module Lit
   class Api::V1::LocalizationKeysController < Api::V1::BaseController
     def index
-      @localization_keys = LocalizationKey
+      @localization_keys = fetch_localization_keys
+      render json: @localization_keys.as_json(
+        root: false, only: %i[id localization_key is_deleted]
+      )
+    end
+
+    private
+
+    def fetch_localization_keys
       if params[:after].present?
-        @localization_keys = @localization_keys.after(DateTime.parse(params[:after])).to_a
+        after_date = Time.parse(params[:after])
+        LocalizationKey.after(after_date).to_a
       else
-        @localization_keys = @localization_keys.all
+        LocalizationKey.all
       end
-      render json: @localization_keys.as_json(root: false, only: [:id, :localization_key])
     end
   end
 end

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

@@ -1,18 +1,34 @@
 module Lit
   class Api::V1::LocalizationsController < Api::V1::BaseController
     def index
-      @localizations = Localization
-      if params[:after].present?
-        @localizations = @localizations.after(DateTime.parse(params[:after])).to_a
-      else
-        @localizations = @localizations.all
-      end
-      render json: @localizations.as_json(root: false, only: [:id, :localization_key_id, :locale_id], methods: [:value, :localization_key_str, :locale_str])
+      @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
+        ]
+      )
     end
 
     def last_change
-      @localization = Localization.order('updated_at DESC').first
-      render json: @localization.as_json(root: false, only: [], methods: [:last_change])
+      @localization = Localization.order(updated_at: :desc).first
+      render json: @localization.as_json(
+        root: false, only: [], methods: [:last_change]
+      )
+    end
+
+    private
+
+    def fetch_localizations
+      if params[:after].present?
+        after_date = Time.parse("#{params[:after]} #{Time.zone.name}")
+                         .in_time_zone
+        Localization.after(after_date).to_a
+      else
+        Localization.all
+      end
     end
   end
 end

data/app/controllers/lit/application_controller.rb

@@ -1,8 +1,8 @@
 module Lit
   class ApplicationController < ActionController::Base
     unless respond_to?(:before_action)
-      alias_method :before_action, :before_filter
-      alias_method :after_action, :after_filter
+      alias before_action before_filter
+      alias after_action after_filter
     end
     before_action :authenticate
     before_action :stop_hits_counter
@@ -24,16 +24,19 @@ module Lit
       Lit.init.cache.restore_hits_counter
     end
 
-    def redirect_to_back_or_default(fallback_location: lit.localization_keys_path)
+    def redirect_to_back_or_default(fallback_location: nil)
+      fallback_location ||= lit.localization_keys_path
       if respond_to?(:redirect_back)
         redirect_back fallback_location: fallback_location
+      elsif referer.present? && referer != request.env['REQUEST_URI']
+        redirect_to :back
       else
-        if request.env["HTTP_REFERER"].present? and request.env["HTTP_REFERER"] != request.env["REQUEST_URI"]
-          redirect_to :back
-        else
-          redirect_to fallback_location
-        end
+        redirect_to fallback_location
       end
     end
+
+    def referer
+      request.referer
+    end
   end
 end

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

@@ -14,3 +14,4 @@ module Lit
     end
   end
 end
+

data/app/controllers/lit/incomming_localizations_controller.rb

@@ -2,37 +2,32 @@ require_dependency 'lit/application_controller'
 
 module Lit
   class IncommingLocalizationsController < ApplicationController
-    before_action :find_source
+    before_action :find_source_and_incomming_localizations
+    before_action :find_icomming_localization, only: %i[accept destroy]
 
-    def index
-      @incomming_localizations = @source.incomming_localizations
-    end
+    def index; end
 
     def accept
-      @incomming_localization = @source.incomming_localizations.find(params[:id].to_i)
       @incomming_localization.accept
-      Lit.init.cache.refresh_key @incomming_localization.full_key
       respond_to do |format|
-        format.html { redirect_to_back_or_default(fallback_location: source_incomming_localizations_path(@source)) }
+        format.html { finish_request }
         format.js
       end
     end
 
     def accept_all
-      @source.incomming_localizations.each do |li|
-        li.accept
-        Lit.init.cache.refresh_key li.full_key
+      ActiveRecord::Base.transaction do
+        @incomming_localizations.each(&:accept)
       end
-      redirect_to_back_or_default(fallback_location: source_incomming_localizations_path(@source))
+      finish_request
     end
 
     def reject_all
-      @source.incomming_localizations.destroy_all
-      redirect_to_back_or_default(fallback_location: source_incomming_localizations_path(@source))
+      @incomming_localizations.destroy_all
+      finish_request
     end
 
     def destroy
-      @incomming_localization = @source.incomming_localizations.find(params[:id].to_i)
       @incomming_localization.destroy
       respond_to do |format|
         format.html { redirect_to source_incomming_localizations_path(@source) }
@@ -42,8 +37,20 @@ module Lit
 
     private
 
-    def find_source
+    def find_icomming_localization
+      @incomming_localization = @source.incomming_localizations
+                                       .find(params[:id].to_i)
+    end
+
+    def find_source_and_incomming_localizations
       @source = Source.find(params[:source_id].to_i)
+      @incomming_localizations = @source.incomming_localizations
+    end
+
+    def finish_request
+      redirect_to_back_or_default(
+        fallback_location: source_incomming_localizations_path(@source)
+      )
     end
   end
 end

data/app/controllers/lit/locales_controller.rb

@@ -13,7 +13,7 @@ module Lit
 
     def hide
       @locale = Locale.find(params[:id])
-      @locale.is_hidden = !@locale.is_hidden?
+      @locale.toggle :is_hidden
       @locale.save
       respond_to :js
     end

data/app/controllers/lit/localization_keys_controller.rb

@@ -1,14 +1,28 @@
 module Lit
   class LocalizationKeysController < ::Lit::ApplicationController
-    before_action :get_localization_scope, except: [:destroy, :find_localization]
+    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
     end
 
+    def not_translated
+      @scope = @scope.not_completed
+      get_localization_keys
+    end
+
+    def visited_again
+      @scope = @scope.unscope(where: :is_deleted).not_active.visited_again
+      get_localization_keys
+    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: {
@@ -19,7 +33,7 @@ module Lit
     def starred
       @scope = @scope.where(is_starred: true)
 
-      if defined?(Kaminari) && \
+      if defined?(Kaminari) &&
          @scope.respond_to?(Kaminari.config.page_method_name)
         @scope = @scope.send(Kaminari.config.page_method_name, params[:page])
       end
@@ -28,31 +42,41 @@ module Lit
     end
 
     def star
-      @localization_key = LocalizationKey.find params[:id].to_i
-      @localization_key.is_starred = !@localization_key.is_starred?
+      @localization_key.toggle :is_starred
       @localization_key.save
       respond_to :js
     end
 
+    def change_completed
+      @localization_key.change_all_completed
+      respond_to :js
+    end
+
+    def restore_deleted
+      @localization_key.restore
+      respond_to :js
+    end
+
     def destroy
-      @localization_key = LocalizationKey.find params[:id].to_i
-      @localization_key.destroy
-      I18n.backend.available_locales.each do |l|
-        Lit.init.cache.delete_key "#{l}.#{@localization_key.localization_key}"
-      end
+      @localization_key.soft_destroy
       respond_to :js
     end
 
     private
 
-    def get_localization_scope
+    def find_localization_key
+      @localization_key = LocalizationKey.find params[:id].to_i
+    end
+
+    def find_localization_scope
       @search_options = if params.respond_to?(:permit)
                           params.permit(*valid_keys)
                         else
                           params.slice(*valid_keys)
                         end
-      @search_options[:include_completed] = '1' if @search_options.empty?
-      @scope = LocalizationKey.distinct.preload(localizations: :locale).search(@search_options)
+      @scope = LocalizationKey.distinct.active
+                              .preload(localizations: :locale)
+                              .search(@search_options)
     end
 
     def get_localization_keys
@@ -70,7 +94,7 @@ module Lit
     end
 
     def valid_keys
-      %w( key include_completed key_prefix order )
+      %w[key key_prefix order]
     end
 
     def grouped_localizations
@@ -105,13 +129,15 @@ module Lit
     end
     helper_method :localization_for
 
-    def has_versions?(localization)
+    def versions?(localization)
       @_versions ||= begin
         ids = grouped_localizations.values.map(&:values).flatten.map(&:id)
-        Lit::Localization.where(id: ids).joins(:versions).group("#{Lit::Localization.quoted_table_name}.id").count
+        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 :has_versions?
+    helper_method :versions?
   end
 end