refinerycms-translations 0.3

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Victor Castell
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,61 @@
+## RefineryCMS-Translation ##
+
+A simple approach to content translation for [RefineryCMS](http://refinerycms.org).
+
+Features:
+
+* Mark string or block as translatable in you view, key-value * locale.
+* Let the end-user translate from Refinery backend
+* On the first request that need translation, locale for every language is created
+* You can define translated string to be edited with text_field or WYMeditor in the backend.
+* Translation are cached
+* When the content change, the translation is marked as out-dated to ease site maintenance.
+
+### Install ###
+
+Install the plugin
+
+Add this line to your Gemfile:
+> gem 'refinerycms-translations', :git => 'git@github.com:seasonlabs/refinerycms-translations.git'
+
+Install the gem
+> bundle install
+
+Copy the migration file
+> rails generate refinerycms_pepes
+
+Run the migration
+
+> rake db:migrate
+
+Make sure you have correctly set the following setting in Refinery: 'i18n_frontend_translation_locales', 'i18n_translation_default_frontend_locale'
+
+### Usage ###
+
+Given the following code in you view:
+
+> <h1><%= RefinerySetting.site_name %></h1>
+
+You can do:
+
+> <h1><%= Translation.for_string('site name', RefinerySetting.site_name) %></h1>
+
+Or for more complex text:
+
+> <div id='footer'>
+> <p>Please give us a call! 1-877-555-1234</p>
+> <p>Copyright 2010 - Your Company Name</p>
+> </div>
+
+Using a block:
+
+> <div id='footer'>
+> <% Translate.for_block('footer') do %>
+> <p>Please give us a call! 1-877-555-1234</p>
+> <p>Copyright 2010 - Your Company Name</p>
+> <% end %>
+> </div>
+
+Note: for_string and for_block both take the option "wym" argument to edit the translation with the WYM editor. for_block default to true, for_string default to false.
+
+Based on code from http://github.com/unixcharles

data/app/controllers/admin/translations_controller.rb

@@ -0,0 +1,16 @@
+class Admin::TranslationsController < Admin::BaseController
+
+  crudify :translation, :title_attribute => :name, :order => "fresh, updated_at DESC, name ASC"
+  
+private  
+  def paginate_all_translations
+    if params[:language]
+      @translations = Translation.paginate :page => params[:page],
+                                                    :order => "fresh, updated_at DESC, name ASC",
+                                                    :conditions => {:locale => params[:language]}
+    else
+      @translations = Translation.paginate :page => params[:page],
+                                                    :order => "fresh, updated_at DESC, name ASC"    
+    end
+  end
+end

data/app/controllers/translations_controller.rb.txt

@@ -0,0 +1,30 @@
+class TranslationsController < ApplicationController
+
+  before_filter :find_all_translations
+  before_filter :find_page
+
+  def index
+    # you can use meta fields from your model instead (e.g. browser_title)
+    # by swapping @page for @translations in the line below:
+    present(@page)
+  end
+
+  def show
+    @translations = Translations.find(params[:id])
+
+    # you can use meta fields from your model instead (e.g. browser_title)
+    # by swapping @page for @translations in the line below:
+    present(@page)
+  end
+
+protected
+
+  def find_all_translations
+    @translations = Translations.find(:all, :order => "position ASC")
+  end
+
+  def find_page
+    @page = Page.find_by_link_url("/translations")
+  end
+
+end

data/app/models/translation.rb

@@ -0,0 +1,72 @@
+class Translation < ActiveRecord::Base
+
+  acts_as_indexed :fields => [:name]
+
+  validates_presence_of :name
+
+  before_update { |record| Translation.cache_expire(record.name, record.locale, record.untranslated_was) }
+  after_save    { |record| Translation.cache_write(record.name, record.locale, record.untranslated, record.value) }
+
+  # will_paginate per_page
+  def self.per_page
+    20
+  end
+
+  # Caching methods
+  def self.cache_key(name, locale, untranslated)
+    "#{Refinery.base_cache_key}_translation_#{name}_#{locale.to_s}_#{Digest::MD5.hexdigest(untranslated)}"
+  end
+
+  def self.cache_read(name, locale, untranslated)
+    Rails.cache.read(cache_key(name, locale, untranslated))
+  end
+
+  def self.cache_expire(name, locale, untranslated)
+    Rails.cache.read(cache_key(name, locale, untranslated), nil)
+  end
+
+  def self.cache_write(name, locale, untranslated, value)
+    Rails.cache.write(cache_key(name, locale, untranslated), value)
+  end
+
+  def self.for_block(name, wym = true)
+    self.lookup(name, yield, wym)
+  end
+
+  def self.for_string(name, untranslated, wym = false)
+    self.lookup(name, untranslated, wym)
+  end
+
+  def self.lookup(name, untranslated = nil, wym = false)
+    locale = I18n.locale
+    return untranslated if locale == Refinery::I18n.default_locale
+    
+    if translation = self.cache_read(name,locale,untranslated)
+      return translation
+    end if RefinerySetting.find_or_set(:i18n_frontend_cache_translation, true, {:scoping => 'refinery'})
+    
+    if ( translation = self.find(:first, :conditions => {:name => name.to_s, :locale => locale.to_s}) ).nil?
+      (Refinery::I18n.locales.keys - [Refinery::I18n.default_frontend_locale]).each do |current_locale|
+        if (translation = self.find(:first, :conditions => {:name => name, :locale => current_locale.to_s})).nil?
+          Translation.create(:name => name, :locale => current_locale.to_s, 
+                             :value => untranslated, :untranslated => untranslated,:wym => wym,
+                             :fresh => false, :freshness_key => Digest::MD5.hexdigest(untranslated))
+        end
+      end
+      translation = self.find(:first, :conditions => {:name => name.to_s, :locale => locale.to_s})
+    else
+      if translation.fresh
+        unless translation.freshness_key == Digest::MD5.hexdigest(untranslated)
+          translation.freshness_key = Digest::MD5.hexdigest(untranslated)
+          translation.untranslated = untranslated
+          translation.fresh = false
+          translation.save
+        end
+      end
+    end
+
+    self.cache_write(name, locale, untranslated, translation.value) if RefinerySetting.find_or_set(:i18n_frontend_cache_translation, true, {:scoping => 'refinery'})
+    translation.value
+  end
+
+end

data/app/views/admin/translations/_form.html.erb

@@ -0,0 +1,32 @@
+<% form_for [:admin, @translation] do |f| -%>
+  <h2>
+    <%=t(".translating_key_from_default_to", 
+          :key => @translation.name.titleize,
+          :from => Refinery::I18n.locales[Refinery::I18n.default_locale], 
+          :to => Refinery::I18n.locales[@translation.locale]) %>
+  </h2>
+  <div class='field'>
+    <%= f.label :untranslated, t('.untranslated') -%>
+    <% if @translation.wym %>
+      <%= sanitize @translation.untranslated, :tags => %w(p br), :attributes => [nil] %>
+    <% else %>
+      <p><%= sanitize @translation.untranslated, :tags => [nil], :attributes => [nil] %></p>
+    <% end %>
+  </div>
+  
+  <div class='field'>
+    <%= f.label :value, t('.value') -%>
+    <% if @translation.wym %>
+      <%= f.text_area :value, :rows => 20, :class => "wymeditor widest" -%>
+    <% else %>
+      <%= f.text_field :value -%>
+    <% end %>
+  </div>
+  
+  <div class='field'>
+    <%= f.label :fresh, t('.fresh') -%>
+    <%= f.check_box :fresh -%>
+  </div>
+  
+  <%= render :partial => "/shared/admin/form_actions", :locals => {:f => f, :continue_editing => false} %>
+<% end -%>

data/app/views/admin/translations/_sortable_list.html.erb

@@ -0,0 +1,4 @@
+<ul id='sortable_list'>
+  <%= render :partial => 'translations', :collection => @translations %>
+</ul>
+<%= render :partial => "/shared/admin/sortable_list", :locals => {:continue_reordering => (defined?(continue_reordering) ? continue_reordering : true)} %>

data/app/views/admin/translations/_translation.html.erb

@@ -0,0 +1,19 @@
+<li class='clearfix record <%= cycle("on", "on-hover") %>' id="<%= dom_id(translation) -%>">
+  <span class='title'>
+    <%= image_tag("/images/refinery/icons/flags/#{translation.locale}.png") unless params[:language] %>
+    <%=h translation.name.titleize %>
+    <%= content_tag(:strong, t(".not_fresh")) unless translation.fresh %>
+    <span class="preview">&nbsp;</span>
+  </span>
+  <span class='actions'>
+    <%= link_to refinery_icon_tag("application_edit.png"), edit_admin_translation_path(translation),
+         :title => t('.edit') %>
+    <%= link_to refinery_icon_tag("delete.png"), admin_translation_path(translation),
+        :class => "cancel confirm-delete",
+        :title => t('.delete'),
+        :'data-confirm' => t('shared.admin.delete.message',
+        :title => translation.name
+      ),
+        :'data-method' => :delete %>
+  </span>
+</li>

data/app/views/admin/translations/edit.html.erb

@@ -0,0 +1 @@
+<%= render :partial => "form" %>

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

@@ -0,0 +1,68 @@
+<div id='actions'>
+  <ul>
+    <li>
+      <%= render :partial => "/shared/admin/search", :locals => {:url => admin_translations_url} %>
+    </li>
+  <% if !searching? and Translation.count > 1 %>
+    <li>
+      <%= link_to t('refinery.reorder', :what => "Translations"), admin_translations_url, :id => "reorder_action", :class => "reorder_icon" %>
+      <%= link_to t('refinery.reorder_done', :what => "Translations"), admin_translations_url, :id => "reorder_action_done", :style => "display: none;", :class => "reorder_icon" %>
+    </li>
+  <% end %>
+  </ul>
+
+    <% current_locale = params[:language] -%>
+    <ul id='current_locale'>
+      <li>
+        <% if current_locale %>
+          <%= link_to "#{Refinery::I18n::locales[current_locale]}
+                      <span>#{t('.change_language')}</span>
+                      <span style='display:none;'>#{t('shared.admin.form_actions.cancel')}</span>".html_safe,
+                    "#",
+                    :style => "background-image: url('/images/refinery/icons/flags/#{current_locale}.png');" %>
+        <% else %>
+          <%= link_to "#{t('.all_language')}<span>#{t('.change_language')}</span><span style='display:none;'> #{t('shared.admin.form_actions.cancel')}</span>".html_safe,
+                      "#",
+              :style => "background-image: url('/images/refinery/icons/flags/en.png');" %>
+          
+        <% end %>
+      </li>
+    </ul>
+    <ul id='other_locales' style='display: none'>
+      <% (Refinery::I18n.locales.keys - [Refinery::I18n.default_frontend_locale]).each do |locale| %>
+        <li>
+          <%= link_to Refinery::I18n.locales[locale],
+                      params.dup.tap { |p| p[:language] = locale }, 
+                      :style => "background-image: url('/images/refinery/icons/flags/#{locale}.png');" %>
+        </li>
+      <% end %>
+    </ul>
+  
+</div>
+<div id='records'>
+  <% if params[:language] %>
+    <h2><%= t('.language', :language => Refinery::I18n.locales[params[:language]]) %></h2>
+  <% end %>
+  <% if searching? %>
+    <h2><%= t('admin.search_results_for', :query => params[:search]) %></h2>
+    <% if @translations.any? %>
+      <%= render :partial => "translation", :collection => @translations %>
+    <% else %>
+      <p><%= t('admin.search_no_results') %></p>
+    <% end %>
+  <% else %>
+    <% if @translations.any? %>
+      <%= will_paginate @translations, :previous_label => '&laquo;', :next_label => '&raquo;' %>
+       <ul id='sortable_list'>
+        <%= render :partial => 'translation', :collection => @translations %>
+       </ul>
+      <%= will_paginate @translations, :previous_label => '&laquo;', :next_label => '&raquo;' %>
+    <% else %>
+      <p>
+        <strong>
+          <%= t('.no_items_yet') %>
+        </strong>
+      </p>
+    <% end %>
+  <% end %>
+</div>

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

@@ -0,0 +1 @@
+<%= render :partial => "form" %>

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

@@ -0,0 +1,11 @@
+<% content_for :body_content_left do %>
+  <ul id="translations">
+    <% @translations.each do |translations| %>
+      <li>
+        <%= link_to translations.name, translations_url(translations) %>
+      </li>
+    <% end %>
+  </ul>
+<% end %>
+
+<%= render :partial => "/shared/content_page" %>

data/app/views/translations/show.html.erb

@@ -0,0 +1,30 @@
+<% content_for :body_content_title do %>
+  <%= @translations.name %>
+<% end %>
+
+<% content_for :body_content_left do %>
+  
+  <div>
+    <h3>Name</h3>
+    <%=raw @translations.name %>
+  </div>
+  
+  <div>
+    <h3>Value</h3>
+    <%=raw @translations.value %>
+  </div>
+  
+<% end %>
+
+<% content_for :body_content_right do %>
+  <h2><%= t('.other') %></h2>
+  <ul id="translations">
+    <% @translations.each do |translations| %>
+      <li>
+        <%= link_to translations.name, translations_url(translations) %>
+      </li>
+    <% end %>
+  </ul>
+<% end %>
+
+<%= render :partial => "/shared/content_page" %>

data/config/locales/en.yml

@@ -0,0 +1,28 @@
+en:
+  plugins:
+    translations:
+      title: Translations
+  admin:
+    translations:
+      index:
+        create_new: Create a new Translation
+        reorder: Reorder Translations
+        reorder_done: Done Reordering Translations
+        sorry_no_results: Sorry! There are no results found.
+        no_items_yet: There are no translations yet. Click "Create a new Translation" to add your first translation.
+        change_language: Select the language to translate.
+        all_language: All
+        language: "Translations for '{{language}}'"
+      singular_name:
+        view_live: View this translation live <br/><em>(opens in a new window)</em>
+        edit: Edit this translation
+        delete: Remove this translation forever
+      form:
+        fresh: "Mark this translation as fresh when you're done"
+        translating_key_from_default_to: "Translate '{{key}}' from '{{from}}' to '{{to}}'"
+        untranslated: "Untranslated content"
+        value: "You're translation"
+      translation:
+        edit: Edit this translation
+        delete: Delete this translation
+        not_fresh: Need update

data/config/routes.rb

@@ -0,0 +1,17 @@
+#Refinery::Application.routes.draw do
+#  resources :translations
+
+#  scope(:path => 'refinery', :as => 'admin', :module => 'admin') do
+#    resources :translations do
+#      collection do
+#        post :update_positions
+#      end
+#    end
+#  end
+#end
+
+ActionController::Routing::Routes.draw do |map|
+  map.namespace(:admin, :path_prefix => 'refinery') do |admin|
+    admin.resources :translations
+  end
+end

data/lib/generators/refinerycms_translations_generator.rb

@@ -0,0 +1,6 @@
+class RefinerycmsTranslations < Refinery::Generators::EngineInstaller
+  
+  source_root File.expand_path('../../', __FILE__)
+  engine_name "translations"
+  
+end

data/lib/tasks/translations.rake

@@ -0,0 +1,13 @@
+namespace :refinery do
+  
+  namespace :translations do
+    
+    # call this task my running: rake refinery:translations:my_task
+    # desc "Description of my task below"
+    # task :my_task => :environment do
+    #   # add your logic here
+    # end
+  
+  end
+  
+end

data/lib/translations.rb

@@ -0,0 +1,20 @@
+require 'refinery'
+
+module Refinery
+  module Translations
+    class Engine < Rails::Engine
+      initializer "static assets" do |app|
+        app.middleware.insert_after ::ActionDispatch::Static, ::ActionDispatch::Static, "#{root}/public"
+      end
+      
+      config.after_initialize do
+        Refinery::Plugin.register do |plugin|
+          plugin.name = "translations"
+          plugin.activity = {:class => Translations,
+          :title => 'name'
+        }
+        end
+      end
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'refinerycms-translationsgem'
+
+class Test::Unit::TestCase
+end

data/test/test_refinerycms-translations.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestRefinerycmsTranslationsgem < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: refinerycms-translations
+version: !ruby/object:Gem::Version 
+  hash: 13
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  version: "0.3"
+platform: ruby
+authors: 
+- season
+- Victor Castell
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-20 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: Ruby on Rails Translations engine for Refinery CMS rails 3 compatible
+email: victorcoder@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- app/controllers/admin/translations_controller.rb
+- app/controllers/translations_controller.rb.txt
+- app/models/translation.rb
+- app/views/admin/translations/_form.html.erb
+- app/views/admin/translations/_sortable_list.html.erb
+- app/views/admin/translations/_translation.html.erb
+- app/views/admin/translations/edit.html.erb
+- app/views/admin/translations/index.html.erb
+- app/views/admin/translations/new.html.erb
+- app/views/translations/index.html.erb
+- app/views/translations/show.html.erb
+- config/locales/en.yml
+- config/routes.rb
+- lib/generators/refinerycms_translations_generator.rb
+- lib/tasks/translations.rake
+- lib/translations.rb
+- LICENSE
+- README.rdoc
+- test/helper.rb
+- test/test_refinerycms-translations.rb
+has_rdoc: true
+homepage: http://github.com/seasonlabs/refinerycms-translations
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+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 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby on Rails Translations engine for Refinery CMS
+test_files: 
+- test/helper.rb
+- test/test_refinerycms-translations.rb