lit 0.2.6 → 0.3.0

data/lib/lit/engine.rb

@@ -1,9 +1,28 @@
 module Lit
   class Engine < ::Rails::Engine
+    require 'jquery-rails'
+
+    config.autoload_paths += %W[#{Lit::Engine.root}/app/controllers/lit/concerns]
+
     isolate_namespace Lit
 
     initializer 'lit.assets.precompile' do |app|
-      app.config.assets.precompile += %w(lit/application.css lit/application.js)
+      app.config.assets.precompile += %w[lit/application.css lit/application.js]
+      app.config.assets.precompile += %w[lit/lit_frontend.css lit/lit_frontend.js]
+      # add language flags to list of precompiled assets
+      if app.config.i18n.available_locales
+        app.config.i18n.available_locales.each do |l|
+          app.config.assets.precompile << "lit/famfamfam_flags/#{l.to_s[0,2]}.png"
+        end
+      end
+    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
+      end
     end
   end
 end

data/lib/lit/i18n_backend.rb

@@ -9,10 +9,16 @@ module Lit
     def initialize(cache)
       @cache = cache
       @available_locales_cache = nil
+      @translations = {}
+      reserved_keys = I18n.const_get :RESERVED_KEYS
+      reserved_keys << :lit_default_copy
+      I18n.send(:remove_const, :RESERVED_KEYS)
+      I18n.const_set(:RESERVED_KEYS, reserved_keys)
     end
 
     def translate(locale, key, options = {})
-      content = super(locale, key, options.merge(fallback: Lit.fallback))
+      options[:lit_default_copy] = options[:default].dup if can_dup_default(options)
+      content = super(locale, key, options)
       if Lit.all_translations_are_html_safe && content.respond_to?(:html_safe)
         content.html_safe
       else
@@ -22,9 +28,9 @@ module Lit
 
     def available_locales
       return @available_locales_cache unless @available_locales_cache.nil?
-      locales = ::Rails.configuration.i18n.available_locales
-      if locales && !locales.empty?
-        @available_locales_cache = locales.map(&:to_sym)
+      @locales ||= ::Rails.configuration.i18n.available_locales
+      if @locales && !@locales.empty?
+        @available_locales_cache = @locales.map(&:to_sym)
       else
         @available_locales_cache = Lit::Locale.ordered.visible.map { |l| l.locale.to_sym }
       end
@@ -48,6 +54,15 @@ module Lit
 
     private
 
+    def can_dup_default(options = {})
+      return false unless options.key?(:default)
+      return true if options[:default].is_a?(String)
+      return true if options[:default].is_a?(Array) && \
+                     (options[:default].first.is_a?(String) || \
+                      options[:default].first.is_a?(Symbol))
+      false
+    end
+
     def lookup(locale, key, scope = [], options = {})
       init_translations unless initialized?
 
@@ -58,42 +73,67 @@ module Lit
       content = @cache[key_with_locale] || super
       return content if parts.size <= 1
 
-      if should_cache?(key_with_locale)
+      if content.nil? && should_cache?(key_with_locale)
         new_content = @cache.init_key_with_value(key_with_locale, content)
         content = new_content if content.nil? # Content can change when Lit.humanize is true for example
-
-        if content.nil? && options[:default].present?
-          if options[:default].is_a?(Array)
-            default = options[:default].map do |key|
-              if key.is_a?(Symbol)
-                I18n.normalize_keys(nil, key.to_s, options[:scope], options[:separator]).join('.').to_sym
-              else
-                key
+        # so there is no content in cache - it might not be if ie. we're doing
+        # fallback to already existing language
+        if content.nil?
+          # check if default was provided
+          if options[:lit_default_copy].present?
+            # default most likely will be an array
+            if options[:lit_default_copy].is_a?(Array)
+              default = options[:lit_default_copy].map do |key_or_value|
+                if key_or_value.is_a?(Symbol)
+                  I18n.normalize_keys(nil, key_or_value.to_s, options[:scope], options[:separator]).join('.').to_sym
+                else
+                  key_or_value
+                end
               end
+              default = default.first if default.is_a?(Array)
+            else
+              default = options[:lit_default_copy]
+            end
+            content = default
+          end
+          # if we have content now, let's store it in cache
+          if content.present?
+            @cache[key_with_locale] = content
+            content = @cache[key_with_locale]
+          end
+          # content might be nil - default value passed to cache was in fact
+          # useless.
+          # if content is still nil, we may try to humanize it. Rails will do
+          # it anyway if we return nil, but then it will wrap it also in
+          # translation_missing span.
+          # Humanizing key should be last resort
+          if content.nil? && Lit.humanize_key
+            content = key.to_s.split('.').last.humanize
+            if content.present?
+              @cache[key_with_locale] = content
+              content = @cache[key_with_locale]
             end
-          else
-            default = options[:default]
           end
-
-          @cache[key_with_locale] = default
-          content = @cache[key_with_locale]
         end
       end
       ## return translated content
       content
     end
 
-    def store_item(locale, data, scope = [])
+    def store_item(locale, data, scope = [], startup_process = false)
+      key = ([locale] + scope).join('.')
       if data.respond_to?(:to_hash)
         # ActiveRecord::Base.transaction do
           data.to_hash.each do |key, value|
-            store_item(locale, value, scope + [key])
+            store_item(locale, value, scope + [key], startup_process)
           end
         # end
-      elsif data.respond_to?(:to_str)
+      elsif data.respond_to?(:to_str) || data.is_a?(Array)
         key = ([locale] + scope).join('.')
-        @cache[key] ||= data
+        return if startup_process && @cache.keys.member?(key) && Lit.ignore_yaml_on_startup
+        @cache.update_locale(key, data, data.is_a?(Array), startup_process)
       elsif data.nil?
+        return if startup_process
         key = ([locale] + scope).join('.')
         @cache.delete_locale(key)
       end
@@ -102,7 +142,7 @@ module Lit
     def load_translations_to_cache
       ActiveRecord::Base.transaction do
         (@translations || {}).each do |locale, data|
-          store_item(locale, data) if valid_locale?(locale)
+          store_item(locale, data, [], true) if valid_locale?(locale)
         end
       end
     end
@@ -128,12 +168,12 @@ module Lit
     end
 
     def store_items?
-      @store_items.nil? || @store_items
+      !instance_variable_defined?(:@store_items) || @store_items
     end
 
     def valid_locale?(locale)
-      locales = ::Rails.configuration.i18n.available_locales
-      !locales || locales.map(&:to_s).include?(locale.to_s)
+      @locales ||= ::Rails.configuration.i18n.available_locales
+      !@locales || @locales.map(&:to_s).include?(locale.to_s)
     end
 
     def is_ignored_key(key_without_locale)

data/lib/lit/version.rb

@@ -1,3 +1,3 @@
 module Lit
-  VERSION = '0.2.6'
+  VERSION = '0.3.0'.freeze
 end

data/lib/tasks/lit_tasks.rake

@@ -2,9 +2,27 @@ namespace :lit do
   desc 'Exports translated strings from lit to config/locales/lit.yml file.'
   task export: :environment do
     if yml = Lit.init.cache.export
-      PATH = 'config/locales/lit.yml'
-      File.new("#{Rails.root}/#{PATH}", 'w').write(yml)
-      puts "Successfully exported #{PATH}."
+      path = Rails.root.join('config', 'locales', 'lit.yml')
+      File.new(path, 'w').write(yml)
+      puts "Successfully exported #{path}."
+    end
+  end
+
+  desc 'Reads config/locales/#{ENV["FILES"]} files and calls I18n.t() on keys forcing Lit to import given LOCALE to cache / to display them in UI'
+  task raw_import: :environment do
+    return 'you need to define FILES env' if ENV['FILES'].blank?
+    return 'you need to define LOCALE env' if ENV['LOCALE'].blank?
+    files = ENV['FILES'].to_s.split(',')
+    locale = ENV['LOCALE'].to_s
+    I18n.with_locale(locale) do
+      files.each do |file|
+        locale_file = File.open(Rails.root.join('config', 'locales', file))
+        yml = YAML.load(locale_file)[locale]
+        Hash[*Lit::Cache.flatten_hash(yml)].each do |key, default_translation|
+          puts key
+          I18n.t(key, default: default_translation)
+        end
+      end
     end
   end
 end

metadata

@@ -1,88 +1,104 @@
 --- !ruby/object:Gem::Specification
 name: lit
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.3.0
 platform: ruby
 authors:
 - Maciej Litwiniuk
+- Piotr Boniecki
+- Michał Buszkiewicz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-12 00:00:00.000000000 Z
+date: 2018-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: i18n
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>'
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>'
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '0.7'
 - !ruby/object:Gem::Dependency
-  name: i18n
+  name: jquery-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: jquery-rails
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.2.0
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: devise
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: ! 'Translate your apps with pleasure (sort of...) and for free. It''s
-  simple i18n web interface, build on top of twitter bootstrap, that one may find
-  helpful in translating app by non-technicals. '
+description: "Translate your apps with pleasure (sort of...) and for free.\n                   It's
+  simple i18n web interface, build on top of twitter\n                   bootstrap,
+  that one may find helpful in translating app by\n                   non-technicals. "
 email:
 - maciej@litwiniuk.net
 executables: []
@@ -344,18 +360,23 @@ files:
 - app/assets/images/lit/famfamfam_flags/zw.png
 - app/assets/images/lit/jquery-te.png
 - app/assets/javascripts/lit/application.js
-- app/assets/javascripts/lit/bootstrap.js.coffee
-- app/assets/javascripts/lit/dashboard.js
-- app/assets/javascripts/lit/jquery-te-1.4.0.min.js
-- app/assets/javascripts/lit/localizations.js.coffee
+- app/assets/javascripts/lit/backend/bootstrap.js.coffee
+- app/assets/javascripts/lit/backend/dashboard.js
+- app/assets/javascripts/lit/backend/jquery-te-1.4.0.min.js
+- app/assets/javascripts/lit/backend/localizations.js.coffee
+- app/assets/javascripts/lit/backend/sources.js.coffee
+- app/assets/javascripts/lit/lit_frontend.js
+- app/assets/javascripts/lit/mousetrap.js
 - app/assets/stylesheets/lit/application.css
-- app/assets/stylesheets/lit/dashboard.css
-- app/assets/stylesheets/lit/jquery-te-1.4.0.css.scss
+- app/assets/stylesheets/lit/backend/jquery-te-1.4.0.css.scss
+- app/assets/stylesheets/lit/lit_frontend.css
 - app/controllers/lit/api/v1/base_controller.rb
 - app/controllers/lit/api/v1/locales_controller.rb
 - app/controllers/lit/api/v1/localization_keys_controller.rb
 - app/controllers/lit/api/v1/localizations_controller.rb
 - app/controllers/lit/application_controller.rb
+- app/controllers/lit/concerns/request_info_store.rb
+- app/controllers/lit/concerns/request_keys_store.rb
 - app/controllers/lit/dashboard_controller.rb
 - app/controllers/lit/incomming_localizations_controller.rb
 - app/controllers/lit/locales_controller.rb
@@ -364,8 +385,11 @@ files:
 - app/controllers/lit/sources_controller.rb
 - app/helpers/lit/application_helper.rb
 - app/helpers/lit/dashboard_helper.rb
+- app/helpers/lit/frontend_helper.rb
+- app/helpers/lit/localization_keys_helper.rb
 - app/helpers/lit/localizations_helper.rb
 - app/helpers/lit/sources_helper.rb
+- app/jobs/lit/synchronize_source_job.rb
 - app/models/lit/incomming_localization.rb
 - app/models/lit/locale.rb
 - app/models/lit/localization.rb
@@ -403,16 +427,16 @@ files:
 - app/views/lit/sources/index.html.erb
 - app/views/lit/sources/new.html.erb
 - app/views/lit/sources/show.html.erb
-- config/database.yml
 - config/routes.rb
-- db/migrate/20121103144612_create_lit_locales.rb
-- db/migrate/20121103174049_create_lit_localization_keys.rb
-- db/migrate/20121103182106_create_lit_localizations.rb
-- db/migrate/20121225112100_add_is_completed_and_is_starred_to_localization_keys.rb
-- db/migrate/20130511111904_add_is_hidden_to_locales.rb
-- db/migrate/20130921071304_create_lit_localization_versions.rb
-- db/migrate/20130923162141_create_lit_sources.rb
-- db/migrate/20130924151910_create_lit_incomming_localizations.rb
+- db/migrate/20180101010101_lit_create_lit_locales.rb
+- db/migrate/20180101010102_lit_create_lit_localization_keys.rb
+- db/migrate/20180101010103_lit_create_lit_localizations.rb
+- db/migrate/20180101010104_lit_add_is_completed_and_is_starred_to_localization_keys.rb
+- db/migrate/20180101010105_lit_add_is_hidden_to_locales.rb
+- db/migrate/20180101010106_lit_create_lit_localization_versions.rb
+- db/migrate/20180101010107_lit_create_lit_sources.rb
+- db/migrate/20180101010108_lit_create_lit_incomming_localizations.rb
+- db/migrate/20180101010109_lit_add_sync_complete_to_lit_sources.rb
 - lib/generators/lit/install/templates/initializer.rb
 - lib/generators/lit/install_generator.rb
 - lib/lit.rb
@@ -436,17 +460,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Database powered i18n backend with web gui

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

@@ -1,4 +0,0 @@
-/*
-  Place all the styles related to the matching controller here.
-  They will automatically be included in application.css.
-*/

data/config/database.yml

@@ -1,8 +0,0 @@
-test:
-  adapter: postgresql
-  database: lit_test
-  username: ebin
-  password: ebin
-  host: localhost
-  pool: 5
-  timeout: 5000