lit 0.0.4.3 → 0.1.0

data/README.md

@@ -4,63 +4,55 @@
 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. 
-It's still under heave development!
 
 Highly inspired by Copycopter by thoughtbot.
 
+### Features
+
+1. Runs with your app - no need for external services
+2. Support for array types, (ie. `date.abbr_day_names`)
+3. Versioning translations - you can always check, how value did look like in past
+4. Possibility to synchronize between environments or even 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
+
 ### Screenshots
 
 Check wiki: [Screenshots](https://github.com/prograils/lit/wiki/Screenshots)
 
-### Instalation
+### Installation
 
-1. Add ```lit``` gem to your ```Gemfile```
+1. Add `lit` gem to your `Gemfile`
 ```ruby
 gem "lit"
-```
+````
 
-2. Install required migrations: ```bundle exec rake lit:install:migrations``` and run migrations ```bundle exec rake db:migrate```
+2. run `bundle install`
 
-3. Mount engine in ```config/routes.rb```
-```ruby
-mount Lit::Engine => "/lit"
-```
-
-4. Last step is initializer, that should be places ie in ```config/initializers/lit.rb```
-    ```ruby
-    ## Add extra authentication, symbol, that is provided as param to before_filter
-    ## Tested with devise, seems to work
-    # Lit.authentication_function = :authenticate_admin!
-    
-    ## Pass extra options to storage engine
-    ## You may find it useful ie. while using redis in shared environment.
-   	# Lit.storage_options = { :prefix=>"my_project" }
-   	
-    ## Which storage engine use. Please remember that in production environment
-    ## memory is not shared between processes, and hash may not be correct choice
-    ## (as changes will not be visible for all processes). But for any production
-    ## environment with finished translation, 'hash' is preferred choice.
-    ## Possible values: 'redis' or 'hash'
-    Lit.key_value_engine = 'redis'
-    
-    ## Initialize engine
-    Lit.init
-    ```
-
-5. After doing above and restarting app, point your browser to ```http://app/lit```
+3. run installation generator `bundle exec rails g lit:install`
+
+4. After doing above and restarting app, point your browser to ```http://app/lit```
 
+5. Profit!
+
+
+You may want to take a look at generated initializer in `config/initializers/lit.rb` and change some default configuration options.
 
 
 ### ToDo
 
+* ~~Versioning~~ 
+* ~~API~~
+* ~~Synchronization between environments~~
 * Rewrite initializer
 * Rewrite exporter (which is now code from copycopter)
-* Support for array types (ie. ```date.abbr_day_names```)
+* ~~Support for array types (ie. `date.abbr_day_names`)~~
+* ~~Generator~~
 * Support for wysiwyg
 * Better cache
-* Support for other key value providers (ie. Redis does not support Array types in easy way)
+* ~~Support for other key value providers (ie. Redis does not support Array types in easy way)~~ (not applicable, as array storage works now with redis).
 * Integration with ActiveAdmin
-* Add versioning 
+
 
 ### License
 

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

@@ -1,6 +1,8 @@
+@edited_rows = {}
 $(document).ready ->
   $('td.localization_row[data-editing=0]').on 'click', ->
     $this = $(this)
+    edited_rows[$this.data('id')] = $this.html()
     unless parseInt($this.data('editing'))
       $this.data('editing', '1')
       $.get $this.data('edit')
@@ -9,6 +11,11 @@ $(document).ready ->
     if $this[0].localName=='button'
       $this = $this.parents('td.localization_row')
     $this.data('editing', 0)
-    $this.html $this.data('content')
+    $this.html edited_rows[$this.data('id')]
     e.preventDefault()
     false
+  $('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('')

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

@@ -31,3 +31,7 @@ li.key_prefix .icon-chevron-right {
   margin-right: -6px;
   opacity: .25;
 }
+
+.hidden{
+  display: none;
+}

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

@@ -0,0 +1,19 @@
+module Lit
+  module Api
+    module V1
+      class BaseController < ActionController::Base
+        layout nil
+        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
+          end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+require_dependency "lit/api/v1/base_controller"
+
+module Lit
+  module Api
+    module V1
+      class LocalesController < Api::V1::BaseController
+        def index
+          @locales = Locale.all
+          render :json=>@locales.as_json(:root=>false, :only=>[:id, :locale])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+require_dependency "lit/api/v1/base_controller"
+
+module Lit
+  class Api::V1::LocalizationKeysController < Api::V1::BaseController
+    def index
+      @localization_keys = LocalizationKey
+      if params[:after].present?
+        @localization_keys = @localization_keys.after(DateTime.parse(params[:after])).to_a
+      else
+        @localization_keys = @localization_keys.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

@@ -0,0 +1,18 @@
+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])
+    end
+
+    def last_change
+      @localization = Localization.order('updated_at DESC').first
+      render :json=>@localization.as_json(:root=>false, :only=>[], :methods=>[:last_change])
+    end
+  end
+end

data/app/controllers/lit/application_controller.rb

@@ -6,7 +6,7 @@ module Lit
 
     private
       def authenticate
-        if Lit.authentication_function
+        if Lit.authentication_function.present?
           send(Lit.authentication_function)
         end
       end

data/app/controllers/lit/incomming_localizations_controller.rb

@@ -0,0 +1,42 @@
+require_dependency "lit/application_controller"
+
+module Lit
+  class IncommingLocalizationsController < ApplicationController
+    before_filter :find_source
+
+    def index
+      @incomming_localizations = @source.incomming_localizations.all
+    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
+      redirect_to :back
+    end
+
+    def accept_all
+      @source.incomming_localizations.each do |li|
+        li.accept
+        Lit.init.cache.refresh_key li.full_key
+      end
+      redirect_to :back
+    end
+
+    def reject_all
+      @source.incomming_localizations.destroy_all
+      redirect_to :back
+    end
+
+    def destroy
+      @incomming_localization = @source.incomming_localizations.find(params[:id].to_i)
+      @incomming_localization.destroy
+      redirect_to source_incomming_localizations_path(@source)
+    end
+
+    private
+      def find_source
+        @source = Source.find(params[:source_id].to_i)
+      end
+  end
+end

data/app/controllers/lit/localization_keys_controller.rb

@@ -17,14 +17,14 @@ module Lit
     end
 
     def star
-      @localization_key = LocalizationKey.find params[:id]
+      @localization_key = LocalizationKey.find params[:id].to_i
       @localization_key.is_starred = ! @localization_key.is_starred?
       @localization_key.save
       respond_to :js
     end
 
     def destroy
-      @localization_key = LocalizationKey.find params[:id]
+      @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}"

data/app/controllers/lit/localizations_controller.rb

@@ -12,6 +12,12 @@ module Lit
       if @localization.update_attributes(clear_params)
         Lit.init.cache.refresh_key @localization.full_key
       end
+      @localization.reload
+      respond_to :js
+    end
+
+    def previous_versions
+      @versions = @localization.versions.order('created_at DESC')
       respond_to :js
     end
 
@@ -25,8 +31,8 @@ module Lit
       end
 
       def clear_params
-        if ::Rails::VERSION::MAJOR>=4
-          params[:localization].permit(:translated_value, :locale_id)
+        if defined?(::ActionController::StrongParameters)
+          params.require(:localization).permit(:translated_value, :locale_id)
         else
           params[:localization]
         end

data/app/controllers/lit/sources_controller.rb

@@ -0,0 +1,60 @@
+require_dependency "lit/application_controller"
+
+module Lit
+  class SourcesController < ApplicationController
+    def index
+      @sources = Source.all
+    end
+
+    def show
+      @source = Source.find(params[:id])
+    end
+
+    def new
+      @source = Source.new
+    end
+
+    def edit
+      @source = Source.find(params[:id])
+    end
+
+    def synchronize
+      @source = Source.find(params[:id])
+      @source.synchronize
+      redirect_to lit.source_incomming_localizations_path(@source)
+    end
+
+    def create
+      @source = Source.new(clear_params)
+      if @source.save
+        redirect_to @source, :notice => 'Source was successfully created.'
+      else
+        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.'
+      else
+        render :action => "edit"
+      end
+    end
+
+    def destroy
+      @source = Source.find(params[:id])
+      @source.destroy
+      redirect_to sources_url
+    end
+
+    private
+      def clear_params
+        if defined?(::ActionController::StrongParameters)
+          params.require(:source).permit(:identifier, :url, :api_key)
+        else
+          params[:source]
+        end
+      end
+  end
+end

data/app/helpers/lit/localizations_helper.rb

@@ -5,7 +5,7 @@ module Lit
     end
 
     def ejs(val)
-      escape_javascript val
+      escape_javascript val.to_s
     end
   end
 end

data/app/helpers/lit/sources_helper.rb

@@ -0,0 +1,4 @@
+module Lit
+  module SourcesHelper
+  end
+end

data/app/models/lit/incomming_localization.rb

@@ -0,0 +1,60 @@
+module Lit
+  class IncommingLocalization < ActiveRecord::Base
+    serialize :translated_value
+
+    ## ASSOCIATIONS
+    belongs_to :locale
+    belongs_to :localization_key
+    belongs_to :localization
+    belongs_to :source
+
+    unless defined?(::ActionController::StrongParameters)
+      attr_accessible
+    end
+
+    ## BEFORE & AFTER
+    before_create :set_localization_id
+
+
+    def get_value
+      self.translated_value
+    end
+
+    def full_key
+      [self.locale_str, self.localization_key_str].join('.')
+    end
+
+    def accept
+      if self.localization.present?
+        self.localization.translated_value = self.translated_value
+        self.localization.save
+      else
+        unless self.locale.present?
+          self.locale = Lit::Locale.new
+          self.locale.locale = self.locale_str
+          self.locale.save
+        end
+        unless self.localization_key.present?
+          self.localization_key = Lit::LocalizationKey.new
+          self.localization_key.localization_key = self.localization_key_str
+          self.localization_key.save
+        end
+        unless self.localization.present?
+          self.localization = Lit::Localization.new
+          self.localization.locale = self.locale
+          self.localization.localization_key = self.localization_key
+          self.localization.default_value = self.translated_value
+          self.localization.save
+        end
+      end
+      self.destroy
+    end
+
+    private
+      def set_localization_id
+        if self.locale.present? and self.localization_key.present?
+          self.localization = self.localization_key.localizations.where(:locale_id=>self.locale_id).first
+        end
+      end
+  end
+end

data/app/models/lit/locale.rb

@@ -13,7 +13,7 @@ module Lit
               :presence=>true,
               :uniqueness=>true
 
-    if ::Rails::VERSION::MAJOR<4
+    unless defined?(::ActionController::StrongParameters)
       ## ACCESSIBLE
       attr_accessible :locale
     end
@@ -23,7 +23,8 @@ module Lit
     end
 
     def get_translated_percentage
-      self.get_changed_localizations_count * 100 / self.get_all_localizations_count
+      total = self.get_all_localizations_count
+      total > 0 ? (self.get_changed_localizations_count * 100 / total) : 0
     end
 
     def get_changed_localizations_count