lit 0.2.4 → 0.2.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7da8c1d5b37a875b54f3640e3767b5101a9aaf15
+  data.tar.gz: b14573576174aa805d17189bd1c2b9e9419d0d71
+SHA512:
+  metadata.gz: 170e2b67f08b84f893b5a0f1ce7c94122aaa39798835ab6cc1fe754e236785946f02d3d293dedc47dce0b325165aba039376e2ee69f32fdd67e09c59f91f0a01
+  data.tar.gz: eb22474f0ec620b6d1ed2219da048b01231ea2bbd2c541c405d86099e1d1faa6b4b6c5ffa9647b22c81dedad19e8564bfa20b4e3415467e141ec337f17917b9d

data/README.md

@@ -30,6 +30,18 @@ Once you call `I18n.t()` function from your views, *Lit* is asked whether it has
 
 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
+```bash
+$ rake lit:export
+```
+You may also give it extra env variables to limit the export results.
+```bash
+$ LOCALES=en,de rake lit:export
+```
+
+
 ### Installation
 
 1. Add `lit` gem to your `Gemfile`
@@ -37,6 +49,8 @@ To optimize translation key lookup, *Lit* can use different cache engines. For p
 gem 'lit'
 ```
 
+  For Ruby < 1.9 use `gem 'lit', '= 0.2.4'`, as next versions introduced new ruby hash syntax.
+
 2. run `bundle install`
 
 3. run installation generator `bundle exec rails g lit:install`
@@ -65,6 +79,9 @@ You may want to take a look at generated initializer in `config/initializers/lit
 * Integration with ActiveAdmin
 * Support for Proc defaults (like in `I18n.t('not_exising_keys', default: lambda{|_, options| 'text'})` )
 
+### Testing
+
+For local testing [wwtd](https://github.com/grosser/wwtd) gem comes into play, run tests via: `wwtd --local`. Run migrations using command `RAILS_ENV=test bundle exec rake db:migrate`.
 
 ### License
 

data/Rakefile

@@ -13,7 +13,6 @@ rescue LoadError
   RDoc::Task = Rake::RDocTask
 end
 
-
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'Lit'
@@ -22,7 +21,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
 load 'rails/tasks/engine.rake'
 
 Bundler::GemHelper.install_tasks
@@ -36,5 +35,3 @@ Rake::TestTask.new(:test) do |t|
   t.pattern = 'test/**/*_test.rb'
   t.verbose = false
 end
-
-

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

@@ -6,13 +6,13 @@ module Lit
         respond_to :json
         before_filter :authenticate_requests!
 
-
         private
-          def authenticate_requests!
-            authenticate_or_request_with_http_token do |token, options|
-              Lit.api_key == token
-            end
+
+        def authenticate_requests!
+          authenticate_or_request_with_http_token do |token, _options|
+            Lit.api_key == token
           end
+        end
       end
     end
   end

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

@@ -1,4 +1,4 @@
-require_dependency "lit/api/v1/base_controller"
+require_dependency 'lit/api/v1/base_controller'
 
 module Lit
   module Api
@@ -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: [:id, :locale])
         end
       end
     end

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

@@ -1,4 +1,4 @@
-require_dependency "lit/api/v1/base_controller"
+require_dependency 'lit/api/v1/base_controller'
 
 module Lit
   class Api::V1::LocalizationKeysController < Api::V1::BaseController
@@ -9,8 +9,7 @@ module Lit
       else
         @localization_keys = @localization_keys.all
       end
-      render :json=>@localization_keys.as_json(:root=>false, :only=>[:id, :localization_key])
+      render json: @localization_keys.as_json(root: false, only: [:id, :localization_key])
     end
   end
 end
-

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

@@ -7,12 +7,12 @@ module Lit
       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])
+      render json: @localizations.as_json(root: false, only: [:id, :localization_key_id, :locale_id], methods: [:value, :localization_key_str, :locale_str])
     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
   end
 end

data/app/controllers/lit/application_controller.rb

@@ -5,18 +5,19 @@ module Lit
     after_filter :restore_hits_counter
 
     private
-      def authenticate
-        if Lit.authentication_function.present?
-          send(Lit.authentication_function)
-        end
-      end
 
-      def stop_hits_counter
-        Lit.init.cache.stop_hits_counter
-      end
+    def authenticate
+      return unless Lit.authentication_function.present?
 
-      def restore_hits_counter
-        Lit.init.cache.restore_hits_counter
-      end
+      send(Lit.authentication_function)
+    end
+
+    def stop_hits_counter
+      Lit.init.cache.stop_hits_counter
+    end
+
+    def restore_hits_counter
+      Lit.init.cache.restore_hits_counter
+    end
   end
 end

data/app/controllers/lit/dashboard_controller.rb

@@ -1,4 +1,4 @@
-require_dependency "lit/application_controller"
+require_dependency 'lit/application_controller'
 
 module Lit
   class DashboardController < ::Lit::ApplicationController

data/app/controllers/lit/incomming_localizations_controller.rb

@@ -1,4 +1,4 @@
-require_dependency "lit/application_controller"
+require_dependency 'lit/application_controller'
 
 module Lit
   class IncommingLocalizationsController < ApplicationController
@@ -12,7 +12,10 @@ module Lit
       @incomming_localization = @source.incomming_localizations.find(params[:id].to_i)
       @incomming_localization.accept
       Lit.init.cache.refresh_key @incomming_localization.full_key
-      redirect_to :back
+      respond_to do |format|
+        format.html { redirect_to :back }
+        format.js
+      end
     end
 
     def accept_all
@@ -31,12 +34,16 @@ module Lit
     def destroy
       @incomming_localization = @source.incomming_localizations.find(params[:id].to_i)
       @incomming_localization.destroy
-      redirect_to source_incomming_localizations_path(@source)
+      respond_to do |format|
+        format.html { redirect_to source_incomming_localizations_path(@source) }
+        format.js
+      end
     end
 
     private
-      def find_source
-        @source = Source.find(params[:source_id].to_i)
-      end
+
+    def find_source
+      @source = Source.find(params[:source_id].to_i)
+    end
   end
 end

data/app/controllers/lit/locales_controller.rb

@@ -1,27 +1,27 @@
-require_dependency "lit/application_controller"
+require_dependency 'lit/application_controller'
 
 module Lit
   class LocalesController < ApplicationController
     def index
       @locales = Locale.ordered.all
-  
+
       respond_to do |format|
         format.html # index.html.erb
         format.json { render json: @locales }
       end
     end
-    
+
     def hide
       @locale = Locale.find(params[:id])
       @locale.is_hidden = !@locale.is_hidden?
       @locale.save
       respond_to :js
     end
-  
+
     def destroy
       @locale = Locale.find(params[:id])
       @locale.destroy
-  
+
       respond_to do |format|
         format.html { redirect_to locales_url }
         format.json { head :no_content }

data/app/controllers/lit/localization_keys_controller.rb

@@ -1,19 +1,19 @@
 module Lit
   class LocalizationKeysController < ::Lit::ApplicationController
-    before_filter :get_localization_scope, :except=>[:destroy]
+    before_filter :get_localization_scope, except: [:destroy]
 
     def index
       get_localization_keys
     end
 
     def starred
-      @scope = @scope.where(:is_starred=>true)
+      @scope = @scope.where(is_starred: true)
 
-      if @scope.respond_to?(:page)
-        @scope = @scope.page(params[:page])
+      if defined?(Kaminari) and @scope.respond_to?(Kaminari.config.page_method_name)
+        @scope = @scope.send(Kaminari.config.page_method_name, params[:page])
       end
       get_localization_keys
-      render :action=>:index
+      render action: :index
     end
 
     def star
@@ -33,72 +33,72 @@ module Lit
     end
 
     private
-      def get_localization_scope
-        @search_options = params.slice(*valid_keys)
-        @search_options[:include_completed] = '1' if @search_options.empty?
-        @scope = LocalizationKey.uniq.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).uniq.pluck(:localization_key).map{|lk| lk.split('.').shift(key_parts+1).join('.') }.uniq.sort
-        if @search_options[:key_prefix].present?
-          parts = @search_options[:key_prefix].split('.')
-          @parent_prefix = parts[0,parts.length-1].join('.')
-        end
-        if @scope.respond_to?(:page)
-          @localization_keys = @scope.page(params[:page])
-        else
-          @localization_keys = @scope.all
-        end
-      end
+    def get_localization_scope
+      @search_options = params.slice(*valid_keys)
+      @search_options[:include_completed] = '1' if @search_options.empty?
+      @scope = LocalizationKey.uniq.preload(localizations: :locale).search(@search_options)
+    end
 
-      def valid_keys
-        %w( key include_completed key_prefix order )
+    def get_localization_keys
+      key_parts = @search_options[:key_prefix].to_s.split('.').length
+      @prefixes = @scope.reorder(nil).uniq.pluck(:localization_key).map { |lk| lk.split('.').shift(key_parts + 1).join('.') }.uniq.sort
+      if @search_options[:key_prefix].present?
+        parts = @search_options[:key_prefix].split('.')
+        @parent_prefix = parts[0, parts.length - 1].join('.')
+      end
+      if defined?(Kaminari) and @scope.respond_to?(Kaminari.config.page_method_name)
+        @localization_keys = @scope.send(Kaminari.config.page_method_name, params[:page])
+      else
+        @localization_keys = @scope.all
       end
+    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
-              end
+    def valid_keys
+      %w( key include_completed key_prefix order )
+    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
             end
           end
         end
       end
+    end
 
-      def localization_for(locale, localization_key)
-        @_localization_for ||= {}
-        key = [locale, localization_key]
-        ret = @_localization_for[key]
-        if ret == false
-          nil
-        elsif ret.nil?
-          ret = grouped_localizations[localization_key][locale]
-          unless ret
-            Lit.init.cache.refresh_key("#{locale}.#{localization_key.localization_key}")
-            ret = localization_key.localizations.where(:locale_id=>Lit.init.cache.find_locale(locale).id).first
-          end
-          @_localization_for[key] = ret ? ret : false
-        else
-          ret
+    def localization_for(locale, localization_key)
+      @_localization_for ||= {}
+      key = [locale, localization_key]
+      ret = @_localization_for[key]
+      if ret == false
+        nil
+      elsif ret.nil?
+        ret = grouped_localizations[localization_key][locale]
+        unless ret
+          Lit.init.cache.refresh_key("#{locale}.#{localization_key.localization_key}")
+          ret = localization_key.localizations.where(locale_id: Lit.init.cache.find_locale(locale).id).first
         end
-
+        @_localization_for[key] = ret ? ret : false
+      else
+        ret
       end
+    end
 
-      helper_method :localization_for
+    helper_method :localization_for
 
-      def has_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
-        end
-        @_versions[localization.id].to_i > 0
+    def has_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
       end
+      @_versions[localization.id].to_i > 0
+    end
 
-      helper_method :has_versions?
+    helper_method :has_versions?
   end
 end

data/app/controllers/lit/localizations_controller.rb

@@ -22,25 +22,26 @@ module Lit
     end
 
     private
-      def find_localization_key
-        @localization_key = Lit::LocalizationKey.find(params[:localization_key_id])
-      end
 
-      def find_localization
-        @localization = @localization_key.localizations.find(params[:id])
-      end
+    def find_localization_key
+      @localization_key = Lit::LocalizationKey.find(params[:localization_key_id])
+    end
 
-      def clear_params
-        if defined?(::ActionController::StrongParameters)
-          # allow translated_value to be an array
-          if @localization.value.is_a?(Array)
-            params.require(:localization).permit(:locale_id, :translated_value => [])
-          else
-            params.require(:localization).permit(:locale_id, :translated_value)
-          end
+    def find_localization
+      @localization = @localization_key.localizations.find(params[:id])
+    end
+
+    def clear_params
+      if defined?(::ActionController::StrongParameters)
+        # allow translated_value to be an array
+        if @localization.value.is_a?(Array)
+          params.require(:localization).permit(:locale_id, translated_value: [])
         else
-          params[:localization].is_a?(Hash) ? params[:localization].slice(:translated_value, :locale_id) : {}
+          params.require(:localization).permit(:locale_id, :translated_value)
         end
+      else
+        params[:localization].is_a?(Hash) ? params[:localization].slice(:translated_value, :locale_id) : {}
       end
+    end
   end
 end

data/app/controllers/lit/sources_controller.rb

@@ -1,4 +1,4 @@
-require_dependency "lit/application_controller"
+require_dependency 'lit/application_controller'
 
 module Lit
   class SourcesController < ApplicationController
@@ -27,24 +27,24 @@ module Lit
     def touch
       @source = Source.find(params[:id])
       @source.touch_last_updated_at!
-      redirect_to request.env["HTTP_REFERER"].present? ? :back : @source
+      redirect_to request.env['HTTP_REFERER'].present? ? :back : @source
     end
 
     def create
       @source = Source.new(clear_params)
       if @source.save
-        redirect_to @source, :notice => 'Source was successfully created.'
+        redirect_to @source, notice: 'Source was successfully created.'
       else
-        render :action => "new"
+        render action: 'new'
       end
     end
 
     def update
       @source = Source.find(params[:id])
       if @source.update_attributes(clear_params)
-        redirect_to @source, :notice => 'Source was successfully updated.'
+        redirect_to @source, notice: 'Source was successfully updated.'
       else
-        render :action => "edit"
+        render action: 'edit'
       end
     end
 
@@ -55,12 +55,13 @@ module Lit
     end
 
     private
-      def clear_params
-        if defined?(::ActionController::StrongParameters)
-          params.require(:source).permit(:identifier, :url, :api_key)
-        else
-          params[:source]
-        end
+
+    def clear_params
+      if defined?(::ActionController::StrongParameters)
+        params.require(:source).permit(:identifier, :url, :api_key)
+      else
+        params[:source]
       end
+    end
   end
 end