tolk 1.0 → 1.1.0

data/{public → app/assets/stylesheets}/tolk/screen.css

@@ -130,8 +130,7 @@ ul.locales {
 }
 
 ul.locales li {
-  /*width: 230px;*/
-  width: 150px;
+  width: 300px;
   display: block;
   float: left;
   margin: 0 10px 10px 0;

data/app/controllers/tolk/application_controller.rb

@@ -11,7 +11,7 @@ module Tolk
     end
 
     def ensure_no_primary_locale
-      redirect_to tolk_locales_path if @locale.primary?
+      redirect_to tolk.locales_path if @locale.primary?
     end
   end
 end

data/app/models/tolk/locale.rb

@@ -1,6 +1,6 @@
 module Tolk
   class Locale < ActiveRecord::Base
-    set_table_name "tolk_locales"
+    self.table_name = "tolk_locales"
 
     MAPPING = {
       'ar'    => 'Arabic',
@@ -34,7 +34,7 @@ module Tolk
       'nl'    => 'Dutch',
       'no'    => 'Norwegian',
       'pl'    => 'Polish',
-      'pt-BR' => 'Portuguese (Brazilian)',
+      'pt-br' => 'Portuguese (Brazilian)',
       'pt-PT' => 'Portuguese (Portugal)',
       'ro'    => 'Romanian',
       'ru'    => 'Russian',
@@ -47,11 +47,13 @@ module Tolk
       'tr'    => 'Turkish',
       'uk'    => 'Ukrainian',
       'vi'    => 'Vietnamese',
-      'zh'    => 'Chinese'
+      'zh-CN' => 'Chinese (Simplified)',
+      'zh-TW' => 'Chinese (Traditional)'
     }
 
     has_many :phrases, :through => :translations, :class_name => 'Tolk::Phrase'
     has_many :translations, :class_name => 'Tolk::Translation', :dependent => :destroy
+
     accepts_nested_attributes_for :translations, :reject_if => proc { |attributes| attributes['text'].blank? }
     before_validation :remove_invalid_translations_from_target, :on => :update
 
@@ -103,7 +105,7 @@ module Tolk
         self.special_prefixes.include?(prefix) || self.special_keys.include?(key)
       end
 
-      PLURALIZATION_KEYS = ['zero', 'one', 'two', 'few', 'many', 'other']
+      PLURALIZATION_KEYS = ['none', 'one', 'two', 'few', 'many', 'other']
       def pluralization_data?(data)
         keys = data.keys.map(&:to_s)
         keys.all? {|k| PLURALIZATION_KEYS.include?(k) }
@@ -133,8 +135,8 @@ module Tolk
       existing_ids = self.translations.all(:select => 'tolk_translations.phrase_id').map(&:phrase_id).uniq
       phrases = phrases.scoped(:conditions => ['tolk_phrases.id NOT IN (?)', existing_ids]) if existing_ids.present?
 
-      result = phrases.paginate({:page => page}.merge(options))
-      Tolk::Phrase.send :preload_associations, result, :translations
+      result = phrases.paginate({:page => page, :per_page => Phrase.per_page}.merge(options))
+      ActiveRecord::Associations::Preloader.new result, :translations
       result
     end
 
@@ -148,14 +150,14 @@ module Tolk
         self.translations.containing_text(query)
       end
 
-      phrases = Tolk::Phrase.scoped(:order => 'tolk_phrases.key ASC')      
+      phrases = Tolk::Phrase.scoped(:order => 'tolk_phrases.key ASC')
       phrases = phrases.scoped(:conditions => ['tolk_phrases.id IN(?)', translations.map(&:phrase_id).uniq])
       phrases.paginate({:page => page}.merge(options))
     end
-    
+
     def search_phrases_without_translation(query, page = nil, options = {})
       return phrases_without_translation(page, options) unless query.present?
-      
+
       phrases = Tolk::Phrase.scoped(:order => 'tolk_phrases.key ASC')
 
       found_translations_ids = Tolk::Locale.primary_locale.translations.all(:conditions => ["tolk_translations.text LIKE ?", "%#{query}%"], :select => 'tolk_translations.phrase_id').map(&:phrase_id).uniq
@@ -163,7 +165,7 @@ module Tolk
       phrases = phrases.scoped(:conditions => ['tolk_phrases.id NOT IN (?) AND tolk_phrases.id IN(?)', existing_ids, found_translations_ids]) if existing_ids.present?
 
       result = phrases.paginate({:page => page}.merge(options))
-      Tolk::Phrase.send :preload_associations, result, :translations
+      ActiveRecord::Associations::Preloader.new result, :translations
       result
     end
 
@@ -189,26 +191,26 @@ module Tolk
       MAPPING[self.name] || self.name
     end
 
-    def [](key)
+    def get(key)
       if phrase = Tolk::Phrase.find_by_key(key)
-        t = self.translations.find_by_phrase_id(phrase.id)
+        t = self.translations.where(:phrase_id => phrase.id).first
         t.text if t
       end
     end
 
     def translations_with_html
-      translations = self.translations.all(:conditions => "tolk_translations.text LIKE '%>%' AND 
+      translations = self.translations.all(:conditions => "tolk_translations.text LIKE '%>%' AND
         tolk_translations.text LIKE '%<%' AND tolk_phrases.key NOT LIKE '%_html'", :joins => :phrase)
-      Translation.send :preload_associations, translations, :phrase
+      ActiveRecord::Associations::Preloader.new translations, :phrase
       translations
     end
 
     private
 
     def remove_invalid_translations_from_target
-      self.translations.proxy_target.each do |t|
-        unless t.valid?
-          self.translations.proxy_target.delete(t)
+      self.translations.target.dup.each do |t|
+         unless t.valid?
+          self.translations.target.delete(t)
         else
           t.updated_at = Time.current # Silly hax to fool autosave into saving the record
         end
@@ -222,12 +224,12 @@ module Tolk
         :conditions => { :'tolk_translations.locale_id' => self.id }.merge(conditions),
         :joins => :translations, :order => 'tolk_phrases.key ASC')
 
-      Tolk::Phrase.send :preload_associations, result, :translations
-
       result.each do |phrase|
         phrase.translation = phrase.translations.for(self)
       end
 
+      ActiveRecord::Associations::Preloader.new result, :translations
+
       result
     end
 

data/app/models/tolk/phrase.rb

@@ -1,6 +1,6 @@
 module Tolk
   class Phrase < ActiveRecord::Base
-    set_table_name "tolk_phrases"
+    self.table_name = "tolk_phrases"
 
     validates_uniqueness_of :key
 

data/app/models/tolk/translation.rb

@@ -1,16 +1,19 @@
 module Tolk
   class Translation < ActiveRecord::Base
-    set_table_name "tolk_translations"
+    self.table_name = "tolk_translations"
 
     scope :containing_text, lambda {|query| where("tolk_translations.text LIKE ?", "%#{query}%") }
 
     serialize :text
     validates_presence_of :text, :if => proc {|r| r.primary.blank? && !r.explicit_nil }
+    validate :check_matching_variables, :if => proc { |tr| tr.primary_translation.present? }
 
     validates_uniqueness_of :phrase_id, :scope => :locale_id
 
     belongs_to :phrase, :class_name => 'Tolk::Phrase'
     belongs_to :locale, :class_name => 'Tolk::Locale'
+    validates_presence_of :locale_id
+
 
     attr_accessor :force_set_primary_update
     before_save :set_primary_updated
@@ -40,6 +43,7 @@ module Tolk
     end
 
     def text=(value)
+      value = value.to_s if value.kind_of?(Fixnum)
       super unless value.to_s == text
     end
 
@@ -51,6 +55,23 @@ module Tolk
       end
     end
 
+    def self.detect_variables(search_in)
+      case search_in
+        when String then Set.new(search_in.scan(/\{\{(\w+)\}\}/).flatten + search_in.scan(/\%\{(\w+)\}/).flatten)
+        when Array then search_in.inject(Set[]) { |carry, item| carry + detect_variables(item) }
+        when Hash then search_in.values.inject(Set[]) { |carry, item| carry + detect_variables(item) }
+        else Set[]
+      end
+    end
+
+    def variables
+      self.class.detect_variables(text)
+    end
+
+    def variables_match?
+      self.variables == primary_translation.variables
+    end
+
     private
 
     def set_explicit_nil
@@ -68,7 +89,6 @@ module Tolk
           rescue ArgumentError
             nil
           end
-
         end
 
         self.text = nil if primary_translation.text.class != self.text.class
@@ -87,5 +107,14 @@ module Tolk
       true
     end
 
+    def check_matching_variables
+      unless variables_match?
+        if primary_translation.variables.empty? || primary_translation.variables.class == Set
+          self.errors.add(:text, "The original does not contain variables, so they should not be included.")
+        else
+          self.errors.add(:text, "The translation should contain the variables #{primary_translation.to_a.to_sentence}.")
+        end
+      end
+    end
   end
 end

data/app/views/layouts/tolk/application.html.erb

@@ -12,18 +12,19 @@
     <%= javascript_include_tag :defaults %>
   <% end %>
 
-  <%= stylesheet_link_tag "/tolk/reset", "/tolk/screen" %>
+  <%= stylesheet_link_tag "tolk/reset" %>
+  <%= stylesheet_link_tag "tolk/screen" %>
   <%= yield :head %>
 </head>
 
 <body>
   <div id="container">
     <div id="head">
-      <h1><span class="home"><%= link_to "Tolk", tolk_root_path %></span><%= yield :locale %></h1>
+      <h1><span class="home"><%= link_to "Tolk", tolk.root_path %></span><%= yield :locale %></h1>
     </div>
     <%= yield %>
   </div>
-  
+
   <script type="text/javascript">
     $$('td textarea').each(function(element) {
       element.setStyle({height: element.up('td').measure('height')+'px'});

data/app/views/tolk/locales/all.html.erb

@@ -4,7 +4,7 @@
 <h3 class="switch">Completed translations <span>(<%= link_to 'See phrases missing translation', @locale %>)</span></h3>
 
 <% if @locale.has_updated_translations? && action_name != 'updated' %>
-  <span class="notice">Some phrases have changed. <%= link_to "Update translations", updated_tolk_locale_path(@locale) %>.</span>
+  <span class="notice">Some phrases have changed. <%= link_to "Update translations", tolk.updated_locale_path(@locale) %>.</span>
 <% end %>
 
 <div class="search">

data/app/views/tolk/locales/index.html.erb

@@ -21,7 +21,6 @@
 <% end %>
 <%= form_for(Tolk::Locale.new) do |f| %>
 <div class="submit">
-  <%= f.error_messages %>
   <p>
     <%= f.label "Add a new Locale" %>
     <select id="select_tolk_locale_name" name="tolk_locale[name]">

data/app/views/tolk/locales/show.html.erb

@@ -3,13 +3,13 @@
 <% end %>
 
 <% content_for :head do %>
-  <link rel="alternate" type="application/rss+xml" title="RSS" href="<%= tolk_locale_path(@locale, :format => 'atom') -%>" />
+  <link rel="alternate" type="application/rss+xml" title="RSS" href="<%= tolk.locale_path(@locale, :format => 'atom') -%>" />
 <% end %>
 
-<h3 class="switch">Phrases missing translation (<%= @locale.count_phrases_without_translation %>) <span>(<%= link_to 'See completed translations', all_tolk_locale_path(@locale) %>)</span></h3>
+<h3 class="switch">Phrases missing translation (<%= @locale.count_phrases_without_translation %>) <span>(<%= link_to 'See completed translations', tolk.all_locale_path(@locale) %>)</span></h3>
 
 <% if @locale.has_updated_translations? && action_name != 'updated' %>
-  <span class="notice">Some phrases have changed. <%= link_to "Update translations", updated_tolk_locale_path(@locale) %>.</span>
+  <span class="notice">Some phrases have changed. <%= link_to "Update translations", tolk.updated_locale_path(@locale) %>.</span>
 <% end %>
 
 <div class="search">
@@ -37,7 +37,7 @@
               <% if params[:q].present? -%>
                 <%= highlight(format_i18n_value(phrase.translations.primary.text), params[:q]) -%>
               <% else -%>
-                <%= format_i18n_value(phrase.translations.primary.text) -%>
+                <%= format_i18n_value(phrase.translations.primary.text).html_safe -%>
               <% end -%>
               <span class="key" title="<%= phrase.key %>"><%= truncate(phrase.key, :length => 100) %></span>
             </td>

data/app/views/tolk/searches/show.html.erb

@@ -9,7 +9,7 @@
 <div class="search_exits">
   <%= link_to "Phrases missing translation", @locale %>
   &nbsp;
-  <%= link_to "Completed translations", all_tolk_locale_path(@locale) %>
+  <%= link_to "Completed translations", tolk.all_locale_path(@locale) %>
 </div>
 
 <div class="translations">

data/config/routes.rb

@@ -1,7 +1,10 @@
-Rails.application.routes.draw do |map|
-  map.namespace('tolk') do |tolk|
-    tolk.root :controller => 'locales'
-    tolk.resources :locales, :member => {:all => :get, :updated => :get}
-    tolk.resource :search
+Tolk::Engine.routes.draw do
+  root :to => 'locales#index'
+  resources :locales do
+    member do
+      get :all
+      get :updated
+    end
   end
+  resource :search
 end

data/lib/tasks/tolk_tasks.rake

@@ -1,13 +1,12 @@
 namespace :tolk do
   desc "Add database tables, copy over the assets, and import existing translations"
   task :setup => :environment do
-    Rake::Task['tolk:import_assets'].invoke
     system("rails generate tolk_migration")
     Rake::Task['db:migrate'].invoke
     Rake::Task['tolk:sync'].invoke
     Rake::Task['tolk:import'].invoke
   end
-  
+
   desc "Sync Tolk with the default locale's yml file"
   task :sync => :environment do
     Tolk::Locale.sync!
@@ -32,12 +31,4 @@ namespace :tolk do
     end
   end
 
-  desc "Copies required assets from tolk to application's public/ directory"
-  task :import_assets do
-    tolk_assets = File.expand_path(File.join(File.dirname(__FILE__), '../../public/tolk'))
-    command = "cp -R #{tolk_assets} #{Rails.root}/public/"
-    puts command
-    system(command)
-  end
-
 end

data/lib/tolk.rb

@@ -1,6 +1,8 @@
 require 'will_paginate'
 require 'ya2yaml'
 require 'tolk/engine'
+require 'tolk/sync'
+require 'tolk/import'
 
 module Tolk
 end

data/lib/tolk/engine.rb

@@ -2,6 +2,6 @@ require 'rails'
 
 module Tolk
   class Engine < Rails::Engine
-    engine_name :tolk
+    isolate_namespace Tolk
   end
 end

metadata

@@ -1,63 +1,57 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: tolk
-version: !ruby/object:Gem::Version 
-  hash: 15
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  version: "1.0"
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - David Heinemeier Hansson
+- Emilio Tagua
+- Thomas Darde
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-06-06 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: will_paginate
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: 961915916
-        segments: 
-        - 3
-        - 0
-        - pre
-        version: 3.0.pre
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: ya2yaml
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ya2yaml
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 63
-        segments: 
-        - 0
-        - 26
-        version: "0.26"
+      - !ruby/object:Gem::Version
+        version: '0.26'
   type: :runtime
-  version_requirements: *id002
-description: Tolk is a web interface for doing i18n translations packaged as an engine for Rails applications.
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.26'
+description: Tolk is a web interface for doing i18n translations packaged as an engine
+  for Rails applications.
 email: david@loudthinking.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
-- README
+files:
 - MIT-LICENSE
 - config/routes.rb
 - init.rb
@@ -68,6 +62,8 @@ files:
 - lib/tolk/import.rb
 - lib/tolk/sync.rb
 - lib/tolk.rb
+- app/assets/stylesheets/tolk/reset.css
+- app/assets/stylesheets/tolk/screen.css
 - app/controllers/tolk/application_controller.rb
 - app/controllers/tolk/locales_controller.rb
 - app/controllers/tolk/searches_controller.rb
@@ -82,41 +78,28 @@ files:
 - app/views/tolk/locales/show.html.erb
 - app/views/tolk/searches/_form.html.erb
 - app/views/tolk/searches/show.html.erb
-- public/tolk/reset.css
-- public/tolk/screen.css
-has_rdoc: true
-homepage: http://www.rubyonrails.org
+homepage: http://github.com/tolk/tolk
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Rails engine providing web interface for managing i18n yaml files
 test_files: []
-

data/README

@@ -1,60 +0,0 @@
-Tolk is a Rails 3 engine designed to facilitate the translators doing the dirty work of translating your application to other languages.
-
-* Installation & Setup
-
-To install add the following to your Gemfile:
-
-  gem 'tolk'
-
-To setup just run:
-
-  $ rake tolk:setup
-
-* Usage
-
-Tolk treats I18n.default_locale as the master source of strings to be translated. If you want the master source to be different from I18n.default_locale, you can override it by setting Tolk::Locale.primary_locale_name. Developers are expected to make all the changes to the master locale file ( en.yml by default ) and treat all the other locale.yml files as readonly files.
-
-As tolk stores all the keys and translated strings in the database, you need to ask Tolk to update it's database from the primary yml file :
-
-  $ rake tolk:sync
-  
-The above will fetch all the new keys from en.yml and put them in the database. Additionally, it'll also get rid of the deleted keys from the database and reflect updated translations - if any.
-
-If you already have data in your non primary locale files, you will need to import those to Tolk as a one time thing :
-
-  $ rake tolk:import
-
-Upon visiting http://your_app.com/tolk - you will be presented with different options like creating new locale or providing translations for the existing locales. Once done with translating all the pending strings, you are can write back the new locales to filesystem :
-
-  $ rake tolk:dump_all
-
-This will generate yml files for all non primary locales and put them in #{Rails.root}/config/locales/ directory by default.
-
-You can use the dump_all method defined in Tolk::Locale directly and pass directory path as the argument if you want the generated files to be at a different location :
-
-  $ script/runner "Tolk::Locale.dump_all('/Users/lifo')"
-
-You can even download the yml file using Tolk web interface by appending '.yml' to the locale url. E.g http://your_app.com/tolk/locales/de.yml
-
-* Authentication
-
-If you want to authenticate users who can access Tolk, you need to provide <tt>Tolk::ApplicationController.authenticator</tt> proc. For example :
-
-  # config/initializers/tolk.rb
-  Tolk::ApplicationController.authenticator = proc {
-    authenticate_or_request_with_http_basic do |user_name, password|
-      user_name == 'translator' && password == 'transpass'
-    end
-  }
-
-Authenticator proc will be run from a before filter in controller context.
-
-* Handling blank and non-string values
-
-Tolk speaks YAML for non strings values. If you want to enter a nil values, you could just enter '~'. Similarly, for an Array value, you could enter :
-
----
-- Sun
-- Mon
-
-And Tolk will take care of generating the appropriate entry in the YAML file.