interpret 0.1.3 → 0.1.4

data/app/controllers/interpret/base_controller.rb

@@ -1,10 +1,29 @@
-class Interpret::BaseController < eval(Interpret.controller.classify)
+class Interpret::BaseController < eval(Interpret.parent_controller.classify)
   before_filter :set_locale
+  before_filter :interpret_set_current_user
   layout 'interpret'
 
+protected
+  def require_admin
+    if @interpret_user && !@interpret_admin
+      redirect_to interpret_root_url, :alert => "Not authorized"
+      return
+    end
+  end
+
 private
   def set_locale
     I18n.locale = params[:locale] if params[:locale]
   end
+
+  def interpret_set_current_user
+    if Interpret.current_user && defined?(Interpret.current_user.to_sym)
+      @interpret_user = eval(Interpret.current_user)
+      @interpret_admin = true
+      if Interpret.admin && @interpret_user.respond_to?(Interpret.admin)
+        @interpret_admin = @interpret_user.send(Interpret.admin)
+      end
+    end
+  end
 end
 

data/app/controllers/interpret/tools_controller.rb

@@ -1,4 +1,5 @@
 class Interpret::ToolsController < Interpret::BaseController
+  before_filter :require_admin
 
   def dump
     Interpret::Translation.dump
@@ -18,6 +19,12 @@ class Interpret::ToolsController < Interpret::BaseController
     send_data text[5..text.length], :filename => "#{I18n.locale}.yml"
   end
 
+  def run_update
+    Interpret::Translation.update
+    Interpret.backend.reload! if Interpret.backend
+    redirect_to interpret_tools_url, :notice => "Update done"
+  end
+
   def import
     unless params.has_key? :file
       redirect_to interpret_tools_url, :alert => "You have to select a file to import."

data/app/controllers/interpret/translations_controller.rb

@@ -8,10 +8,23 @@ class Interpret::TranslationsController < Interpret::BaseController
     t = Interpret::Translation.arel_table
     if key
       @translations = Interpret::Translation.locale(I18n.locale).where(t[:key].matches("#{key}.%"))
-      @translations = @translations.select{|x| x.key =~ /#{key}\.\w+$/}
+      if I18n.locale != I18n.default_locale
+        @references = Interpret::Translation.locale(I18n.default_locale).where(t[:key].matches("#{key}.%"))
+      end
     else
-      @translations = Interpret::Translation.locale(I18n.locale).where(t[:key].does_not_match("%.%")).paginate :page => params[:page]
+      @translations = Interpret::Translation.locale(I18n.locale).where(t[:key].does_not_match("%.%"))
+      if I18n.locale != I18n.default_locale
+        @references = Interpret::Translation.locale(I18n.default_locale).where(t[:key].does_not_match("%.%"))
+      end
     end
+    if @interpret_user
+      @translations = @translations.where(:protected => false) if !@interpret_admin
+      @references = @references.where(:protected => false) if @references && !@interpret_admin
+    end
+
+    # not show translations inside nested folders, \w avoids dots
+    @translations = @translations.select{|x| x.key =~ /#{key}\.\w+$/} if key
+    @references = @references.select{|x| x.key =~ /#{key}\.\w+$/} if key && @references
   end
 
   def edit
@@ -19,12 +32,17 @@ class Interpret::TranslationsController < Interpret::BaseController
   end
 
   def update
+    if @interpret_user && !@interpret_admin && params[:interpret_translation].has_key?(:protected)
+      head :error
+      return
+    end
     @translation = Interpret::Translation.find(params[:id])
     old_value = @translation.value
 
     respond_to do |format|
       if @translation.update_attributes(params[:interpret_translation])
-        msg = respond_to?(:current_user) ? "By [#{current_user}]. " : ""
+        msg = ""
+        msg << "By [#{@interpret_user}]. " if @interpret_user
         msg << "Locale: [#{@translation.locale}], key: [#{@translation.key}]. The translation has been changed from [#{old_value}] to [#{@translation.value}]"
         Interpret.logger.info msg
 
@@ -39,6 +57,30 @@ class Interpret::TranslationsController < Interpret::BaseController
     end
   end
 
+  def new
+    @reference = Interpret::Translation.find(params[:translation_id])
+    if @reference.locale === I18n.locale.to_s
+      redirect_to interpret_root_path
+      return
+    end
+    @translation = Interpret::Translation.new :locale => I18n.locale, :key => @reference.key
+  end
+
+  def create
+    @reference = Interpret::Translation.find(params[:translation_id])
+    if @reference.locale == I18n.locale.to_s
+      redirect_to interpret_root_path
+      return
+    end
+    @translation = Interpret::Translation.new params[:interpret_translation].merge(:locale => I18n.locale, :key => @reference.key)
+
+    if @translation.save
+      redirect_to interpret_root_path(:locale => I18n.locale), :notice => "New translation created"
+    else
+      render :action => :new
+    end
+  end
+
 private
   def get_tree
     @tree = session[:tree] ||= Interpret::Translation.get_tree

data/app/models/interpret/translation.rb

@@ -47,9 +47,11 @@ module Interpret
       end
 
       # Import the contents of the given .yml locale file into the database
-      # backend. All the existing translations for the given language will be
-      # erased, the backend will contain only the translations from the file
-      # (in that language).
+      # backend. If a given key already exists in database, it will be
+      # overwritten, otherwise it won't be touched. This means that in any
+      # case it will delete an existing translation, it only overwrites the
+      # ones you give in the file.
+      # If the given file has new translations, these will be ignored.
       #
       # The language will be obtained from the first unique key of the yml
       # file.
@@ -61,13 +63,14 @@ module Interpret
         raise ArgumentError, "the YAML file must contain an unique first key representing the locale" unless hash.keys.count == 1
 
         lang = hash.keys.first
-        delete_all(:locale => lang)
 
         records = parse_hash(hash.first[1], lang)
-        # TODO: Replace with activerecord-import bulk inserts
         transaction do
           records.each do |x|
-            x.save!
+            if tr = locale(lang).find_by_key(x.key)
+              tr.value = x.value
+              tr.save!
+            end
           end
         end
       end

data/app/sweepers/interpret/base_sweeper.rb

@@ -5,6 +5,10 @@ class Interpret::BaseSweeper < ActionController::Caching::Sweeper
     expire_cache(translation)
   end
 
+  def after_create(translation)
+    expire_cache(translation)
+  end
+
 protected
 
   # Implement user's custom expire logic

data/app/sweepers/interpret/translation_sweeper.rb

@@ -5,10 +5,7 @@ class Interpret::TranslationSweeper < ActionController::Caching::Sweeper
     Interpret.backend.reload! if Interpret.backend
   end
 
-private
-  def expire_cache
-    #expire_action :controller => "interpret/translations", :action => :tree
-    session.delete(:tree)
+  def after_create(translation)
     Interpret.backend.reload! if Interpret.backend
   end
 end

data/app/views/interpret/search/index.html.erb

@@ -1,3 +1,5 @@
+<% interpret_title "Interpret - Search" %>
+
 <div id="header">
   <h1>Search translations</h1>
 </div>
@@ -20,10 +22,10 @@
 
   <% end %>
 
-  <%= content_for :sidebar do %>
+  <% content_for :sidebar do %>
     <h2>Search</h2>
     <p>
-  You can use this search feature to look into all the translations. Can be filtered by language, key and phrase.
+      You can use this search feature to look into all the translations. Can be filtered by language, key and phrase.
     </p>
   <% end %>
-</div>
+</div>

data/app/views/interpret/search/perform.html.erb

@@ -1,4 +1,4 @@
-<%= content_for :title do %>
+<% content_for :title do %>
   Search translations
   <%= "by " unless params[:key].blank? && params[:value].blank? %>
   <%= params[:key] unless params[:key].blank? %>
@@ -10,11 +10,9 @@
   <h1>Search translations</h1>
 </div>
 
-
 <%= render 'interpret/translations/listing' %>
 
-
-<%= content_for :sidebar do %>
+<% content_for :sidebar do %>
   <h2>Search</h2>
   <p>
     <%= @translations.size %> results found.

data/app/views/interpret/tools/index.html.erb

@@ -1,3 +1,5 @@
+<% interpret_title "Interpret - Tools" %>
+
 <div class="header">
   <h1>Your master language</h1>
 </div>
@@ -8,6 +10,13 @@ can change it below:
 </p>
 <p><em>TODO</em></p>
 
+<div class="header">
+  <h1>Update contents from yml locale files</h1>
+</div>
+
+<p>update all your application translatinos from the yml files.<br/>
+</p>
+<%= button_to "Update contents", run_update_interpret_tools_path %>
 <div class="header">
   <h1>Dump .yml contents into database</h1>
 </div>

data/app/views/interpret/translations/_listing.html.erb

@@ -1,22 +1,58 @@
 <table>
   <thead>
     <tr class="header">
-      <th>Key</th>
-      <th>Content</th>
+      <% if @references %>
+        <th>Master translation [<%= I18n.default_locale %>]</th>
+      <% else %>
+        <th>Key</th>
+      <% end %>
+      <th>Content [<%= I18n.locale %>]</th>
+      <% if @interpret_admin && @references.nil? %>
+        <th style="width:5%">Protected?</th>
+      <% end %>
     </tr>
   </thead>
   <tbody>
-    <% @translations.each do |x| %>
-      <tr id="translation_<%= x.id %>">
-        <td><%= x.key %></td>
-        <td>
-          <%= best_in_place x, :value,
-              :type => :textarea,
-              :path => interpret_translation_path(x),
-              :activator => "#translation_#{x.id}",
-              :sanitize => false %>
-        </td>
-      </tr>
+    <% unless @references %>
+      <% @translations.each do |x| %>
+        <tr<%= " class='protected'" if x.protected %>>
+          <td class='key'><%= x.key %></td>
+          <td class="content" id="translation_<%= x.id %>">
+            <%= best_in_place x, :value,
+                :type => :textarea,
+                :path => interpret_translation_path(x),
+                :activator => "#translation_#{x.id}",
+                :sanitize => false %>
+          </td>
+          <% if @interpret_admin%>
+            <td style="width:5%" class='protection_input' id="protection_<%= x.id %>">
+              <%= best_in_place x, :protected,
+                  :type => :checkbox,
+                  :path => interpret_translation_path(x),
+                  :activator => "#protection_#{x.id}"
+                  %>
+            </td>
+          <% end %>
+        </tr>
+      <% end %>
+    <% else %>
+      <% @references.each do |x| %>
+        <% trans = @translations.detect{|y| y.key == x.key} %>
+        <tr<%= " id='translation_#{trans.id}'" if trans %><%= " class='protected'" if x.protected %>>
+          <td style='width:50%'><%= x.value %></td>
+          <td style='width:50%'>
+            <% if trans %>
+              <%= best_in_place trans, :value,
+                  :type => :textarea,
+                  :path => interpret_translation_path(trans),
+                  :activator => "#translation_#{trans.id}",
+                  :sanitize => false %>
+            <% else %>
+              <%= link_to "[Create missing translation]", new_interpret_translation_translation_path(x) %>
+            <% end %>
+          </td>
+        </tr>
+      <% end %>
     <% end %>
   </tbody>
 </table>

data/app/views/interpret/translations/index.html.erb

@@ -1,8 +1,7 @@
-<%= content_for :title do %>
-  Translation list
-<% end %>
+<% interpret_title "Interpret - Translations" %>
+
 <div id="header">
-  <h1>Translations for <%= I18n.locale %></h1>
+  <h1>Translations for [<%= I18n.locale %>]</h1>
 </div>
 <p>
 Below are the translations without any particulary key in your application.
@@ -12,9 +11,17 @@ rest of your app's contents, navigate using the tree in the left, that shows you
 locales structure.
 </p>
 
+<p>
+<% if @references %>
+  There are <%=  @references.size - @translations.size %> / <%= @references.size %> missing translations.
+<% else %>
+  There are <%= @translations.size %> translations.
+<% end %>
+</p>
+
 <%= render 'interpret/translations/listing' %>
 
-<%= content_for :sidebar do %>
+<% content_for :sidebar do %>
   <div id="tree_sidebar">
     <h3>
       <% if params[:key] %>
@@ -23,6 +30,6 @@ locales structure.
         /
       <% end %>
     </h3>
-    <%= show_interpret_tree(@tree, params[:key]) %>
+    <%= interpret_show_tree(@tree, params[:key]) %>
   </div>
 <% end %>

data/app/views/interpret/translations/new.html.erb

@@ -0,0 +1,15 @@
+<% interpret_title "Interpret - New translation" %>
+
+<h1>Creating '<%= @translation.key %>'</h1>
+
+<p>
+Previous value:
+<b>[<%= @reference.locale %>] <%= @reference.value %></b>
+</p>
+<%= form_for [@reference, @translation], :url => interpret_translation_translations_path(@reference) do |f| %>
+  <%= f.label :value, "Translation to [#{I18n.locale}]" %>
+  <%= f.text_area :value, :value => @translation.value %>
+  <%= f.submit %>
+<% end %>
+
+<%= link_to "Back", interpret_root_path %>

data/app/views/layouts/interpret.html.erb

@@ -1,28 +1,23 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>INTERPRET - <%= yield :title %></title>
-  <%= stylesheet_link_tag "interpret_style" %>
-  <%= javascript_include_tag "https://ajax.googleapis.com/ajax/libs/jquery/1.4.4/jquery.min.js" %>
-  <%= javascript_include_tag "jquery.purr" %>
-  <%= javascript_include_tag "best_in_place" %>
-  <%= csrf_meta_tag %>
-</head>
-<body>
-<div id="container">
-  <div class="menu grid_16">
+
+<div id="interpret_container">
+  <div class="menu grid_12">
     <%= interpret_section_link_to "Overview", interpret_root_path %> |
-    <%= interpret_section_link_to "Tools", interpret_tools_path %> |
+    <% if @interpret_admin %>
+      <%= interpret_section_link_to "Tools", interpret_tools_path %> |
+    <% end %>
     <%= interpret_section_link_to "Search", interpret_search_path %>
     <hr />
   </div>
-  <div class="menu grid_16">
+  <div class="menu grid_4">
     Languages:
-    <% I18n.available_locales.each do |locale| %>
-      <%= link_to locale, :locale => locale %>
+    <% Interpret::Translation.available_locales.each do |locale| %>
+      <% opts = {:locale => locale} %>
+      <% opts[:key] = params[:key] if params[:key] %>
+      <%= link_to locale, opts %>
     <% end %>
     <hr />
   </div>
+  <div class="clearfix"></div>
   <div id="sidebar" class="grid_3">
     <%= yield :sidebar %>
   </div>
@@ -31,11 +26,4 @@
   </div>
 </div>
 
-<%= javascript_tag do %>
-  $(document).ready(function() {
-  /* Activating Best In Place */
-    jQuery(".best_in_place").best_in_place()
-  });
-<% end %>
-</body>
-</html>
+<% interpret_parent_layout Interpret.layout %>

data/app/views/layouts/interpret_base.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= yield :title %></title>
+  <%= stylesheet_link_tag "interpret_style" %>
+  <%= javascript_include_tag "https://ajax.googleapis.com/ajax/libs/jquery/1.4.4/jquery.min.js" %>
+  <%= javascript_include_tag "jquery.purr", "best_in_place", "interpret" %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+  <%= yield %>
+</body>
+</html>
+

data/config/routes.rb

@@ -1,13 +1,16 @@
 Rails.application.routes.draw do
   scope Interpret.scope do
     namespace :interpret do
-      resources :translations, :only => [:edit, :update]
+      resources :translations, :only => [:edit, :update] do
+        resources :translations, :only => [:new, :create]
+      end
 
       resources :tools, :only => :index do
         collection do
           get :export
           post :import
           post :dump
+          post :run_update
         end
       end
 

data/lib/generators/interpret/setup_generator.rb

@@ -9,6 +9,7 @@ module Interpret
     end
 
     def copy_js
+      copy_file "javascripts/interpret.js", "public/javascripts/interpret.js"
       copy_file "javascripts/jquery.purr.js", "public/javascripts/jquery.purr.js"
     end
 

data/lib/generators/interpret/templates/migration.rb

@@ -6,6 +6,7 @@ class InterpretCreateTranslations < ActiveRecord::Migration
       t.text   :value
       t.text   :interpolations
       t.boolean :is_proc, :default => false
+      t.boolean :protected, :default => false
     end
   end
 

data/lib/interpret/helpers.rb

@@ -2,7 +2,7 @@ module Interpret
   module InterpretHelpers
 
     # Generates the html tree from the given keys
-    def show_interpret_tree(tree, origin_keys)
+    def interpret_show_tree(tree, origin_keys)
       tree = tree.first[1]
       unless origin_keys.nil?
         origin_keys.split(".").each do |key|
@@ -12,8 +12,25 @@ module Interpret
       build_tree(tree, origin_keys)
     end
 
+    def interpret_section_link_to(name, options = {}, html_options = {})
+      html_options.merge!({ :class => 'current' }) if current_controller?(options)
+      link_to name, options, html_options
+    end
+
+    def interpret_title(title)
+      content_for :title do
+        title
+      end
+    end
+
+    def interpret_parent_layout(layout)
+      @_content_for[:layout] = self.output_buffer
+      self.output_buffer = render(:file => "layouts/#{layout}")
+    end
+
+  private
     def build_tree(hash, origin_keys = "", prev_key = "")
-      out = "<ul id='navigation'>"
+      out = "<ul>"
       if origin_keys.present? && prev_key.blank?
         parent_key = origin_keys.split(".")[0..-2].join(".")
         if parent_key.blank?
@@ -35,11 +52,5 @@ module Interpret
       hash = Rails.application.routes.recognize_path(url_for(opts))
       params[:controller] == hash[:controller]
     end
-
-    def interpret_section_link_to(name, options = {}, html_options = {})
-      html_options.merge!({ :class => 'current' }) if current_controller?(options)
-      link_to name, options, html_options
-    end
-
   end
 end

data/lib/interpret/version.rb

@@ -1,3 +1,3 @@
 module Interpret
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/interpret.rb

@@ -5,24 +5,22 @@ require 'lazyhash'
 module Interpret
   mattr_accessor :backend
   mattr_accessor :logger
-
-  mattr_accessor :controller
-  @@controller = "action_controller/base"
-
   mattr_accessor :sweeper
-  @@sweeper = nil
-
+  mattr_accessor :parent_controller
   mattr_accessor :registered_envs
-  @@registered_envs = [:production, :staging]
-
   mattr_accessor :scope
+  mattr_accessor :current_user
+  mattr_accessor :admin
+  mattr_accessor :layout
+
+  @@controller = "action_controller/base"
+  @@registered_envs = [:production, :staging]
   @@scope = ""
+  @@layout = "interpret_base"
 
-  # More options:
-  # - memoize?
-  # - flatten?
-  # - logging?
-  # - current_user method. If set, current_user will appear in logs, otherwise not.
+  def self.configure
+    yield self
+  end
 end
 
 require 'interpret/engine' if defined? Rails

data/public/javascripts/interpret.js

@@ -0,0 +1,7 @@
+$(document).ready(function() {
+  $("#interpret_container .protection_input").click(function() {
+    $(this).parent().toggleClass("protected");
+  });
+  /* Activating Best In Place */
+  $("#interpret_container .best_in_place").best_in_place()
+});