rich_i18n 1.0.3 → 1.2.0

data/lib/assets/jzip/rich.js

@@ -0,0 +1,5 @@
+
+if (typeof(Rich) == "undefined") {
+  Rich = {};
+  $.initModules(Rich);
+}

data/lib/assets/jzip/rich/i18n.js

@@ -0,0 +1,22 @@
+
+Rich.I18n = (function() {
+  return {
+    beforeEdit: function(inputs, selector, specs, identifier) {
+      var translated_keys = $("<input name='content_item[derivative_keys]' type='hidden'/>")
+      
+      translated_keys.val($(identifier).map(function() {
+                            return $(this).attr("data-derivative_key");
+                          }).toArray().join(";"));
+                        
+      inputs.append(translated_keys);
+    },
+    afterUpdate: function(form, response, selector, specs, identifier) {
+      $.each(response.translations, function(key, value) {
+        $( "span.i18n" + identifier + "[data-derivative_key=" + key + "]")            .attr("data-value", response.value).html(              value);
+        $("input.i18n" + identifier + "[data-derivative_key=" + key + "][value]")     .attr("data-value", response.value).attr("value"     , value);
+        $("input.i18n" + identifier + "[data-derivative_key=" + key + "][seatholder]").attr("data-value", response.value).attr("seatholder", value);
+      });
+      SeatHolder.rebind();
+    }
+  };
+}());

data/lib/assets/jzip/rich_i18n.jz

@@ -0,0 +1,9 @@
+
+var onSeatHolderReady = function() {
+//= require jquery/extensions/modules
+
+//= require rich
+//= require rich/i18n
+};
+
+//= require jquery/seat_holder

data/lib/rich/i18n/actionpack.rb

@@ -1,4 +1,5 @@
 
+require File.join(File.dirname(__FILE__), "actionpack", "action_controller", "base.rb"      )
 require File.join(File.dirname(__FILE__), "actionpack", "action_controller", "dispatcher.rb")
 require File.join(File.dirname(__FILE__), "actionpack", "action_view"      , "base.rb"      )
 require File.join(File.dirname(__FILE__), "actionpack", "action_view"      , "sanitizor.rb" )

data/lib/rich/i18n/actionpack/action_controller/base.rb

@@ -0,0 +1,23 @@
+
+module ActionController
+  class Base
+
+    around_filter :prepare_rich_i18n
+    
+    def prepare_rich_i18n
+      String.clear_translations
+      ::Rich::I18n::Engine.current_controller = self
+      yield
+    ensure
+      ::Rich::I18n::Engine.current_controller = nil
+    end
+    
+    view_path = File.join File.dirname(__FILE__), "..", "..", "..", "..", "app", "views"
+    if respond_to? :append_view_path
+      self.append_view_path view_path
+    elsif respond_to? :view_paths
+      self.view_paths << view_path
+    end
+
+  end
+end

data/lib/rich/i18n/actionpack/action_controller/dispatcher.rb

@@ -9,4 +9,4 @@ unless defined?(Rich::I18n::CONTROLLER_HOOKED)
   
   Rich::I18n::CONTROLLER_HOOKED = true
   
-end
+end

data/lib/rich/i18n/actionpack/action_view/base.rb

@@ -2,6 +2,10 @@
 module ActionView
   class Base
 
+  	def rich_i18n
+  	  render :file => File.join(File.dirname(__FILE__), "..", "..", "..", "..", "app", "views", "rich_i18n.html.erb")
+  	end
+
     def render_with_rich_i18n(*args, &block)
       (html = render_without_rich_i18n(*args, &block)).include?("<i18n ") ?
         ::Rich::I18n::Actionpack::ActionView::Sanitizor.sanitize_html(html) :

data/lib/rich/i18n/core/enriched_string.rb

@@ -2,22 +2,31 @@
 module Rich
   module I18n
     module Core
-      class EnrichedString < ::String
+      class EnrichedString
+        
+        delegate :empty?, :blank?, :to_json, :to => :@string
       
-        def initialize(s = "", meta_data = nil)
-          super s
-          @meta_data = meta_data || (s.meta_data.dup unless (s.meta_data.nil? rescue true)) || {}
+        def initialize(string = "", meta_data = nil)
+          @string    = string
+          @meta_data = meta_data || (s.meta_data.dup unless (string.meta_data.nil? rescue true)) || {}
         end
       
-        def initialize_copy_with_rich_i18n(s)
-          result = super(s)
-          result.meta_data = self.meta_data.dup
+        def to_es
+          (@meta_data.filled? && Engine.can_enrich_output?) ? to_tag : @string
         end
+        alias_method :to_s, :to_es
+        
+      private
       
-        def to_es
-          @meta_data.filled? and ::Rich::I18n::Engine.can_enrich_output? ? 
-            "<i18n #{@meta_data.collect{|k, v| "data-#{k}=#{v.inspect}"}.join(" ")}>#{to_s}</i18n>" :
-            to_s
+        def to_tag
+          keys  = [:key, :value, :locale, :derivative_key]
+          data  = @meta_data.reject{|k, v| !keys.include?(k.to_sym)}
+
+          tag   = :i18n
+          attrs = data.collect{|k, v| "data-#{k}=\"#{::ERB::Util.html_escape v}\""}.join " "
+          value = @string
+          
+          "<#{tag} #{attrs}>#{value}</#{tag}>"
         end
         
       end

data/lib/rich/i18n/core/string/enrichments.rb

@@ -5,19 +5,17 @@ module Rich
       module String
         module Enrichments
         
-          # TODO: override String interpolation (e.g. "foo #{"bar".t}")
-        
           def self.included(base)
             base.class_eval do
+              alias_method_chain :initialize_copy, :rich_i18n
+              
               alias_method :add_without_rich_i18n, :+
               alias_method :+, :add_with_rich_i18n
+              
               alias_method_chain :concat, :rich_i18n
               undef_method :<<
               alias_method :<<, :concat_with_rich_i18n
-            
-              alias_method_chain :initialize_copy, :rich_i18n
 
-              attr_accessor :meta_data
               attr_accessor :merged_strings
             end
           end
@@ -58,7 +56,7 @@ module Rich
           def to_output
             merged_strings.blank? ?
               to_es :
-              merged_strings.collect(&:to_output).join
+              merged_strings.collect(&:to_output).join(" ")
           end
         
         end

data/lib/rich/i18n/core/string/internationalization.rb

@@ -6,17 +6,28 @@ module Rich
         module Internationalization
 
           def self.included(base)
+            base.extend ClassMethods
             base.send :include, InstanceMethods
+            base.class_eval do
+              cattr_accessor :i18n_translations
+            end
+          end
+          
+          module ClassMethods
+            def clear_translations
+              i18n_translations.clear
+            end
           end
-        
+          
           module InstanceMethods
             def t(options = {})
-              self.split(" ").collect do |string|
+              self.split(" ").inject([]) do |array, string|
                 key              = string.include?(".") ? string.dup : "word.#{string}"
                 default          = key.split(".").last
                 translating_word = key.starts_with?("word.")
     
-                key.downcase!
+                key.downcase! unless string.match(/^(label|seatholder)\./)
+
                 options[:pluralize]            = "".respond_to?(:pl) && (options[:pluralize].nil? || options[:pluralize])
                 options[:translate_callback] ||= LOGGER_PROC if RAILS_ENV == "development"
 
@@ -49,26 +60,32 @@ module Rich
                   s.cp_case! options[:capitalize] ? default.capitalize : default
                 end
               
-                EnrichedString.new s, {:key => string, :actual_key => key, :actual_value => value}
+                array << " " unless array.empty?
+                array << EnrichedString.new(s, {:key => key, :value => value, :locale => I18n.locale, :derivative_key => string})
       
-              end.join(" ")
+              end.join
             end
           
           private
 
             RICH_I18N_OPTIONS = [:count, :pluralize, :capitalize, :translate_callback]
-            LOGGER_PROC = Proc.new{|translation, key, options| puts "INFO: I18n.t #{key.inspect}, #{options.inspect}"}
+            LOGGER_PROC = Proc.new{|translation, key, options| puts "== RICH-I18N: I18n.t #{key.inspect}, #{options.inspect}"}
           
             @@i18n_translations = {}
 
             def i18n_t(key, opts = {})
               options = opts.inject({}) do |hash, (k, v)|
+                          # FIXME: this code is to handle interpolated translations... however, this needs to be refactored
                           hash[k] = v.is_a?(String) && v.include?("<i18n") ? v.gsub(/(\<i18n[^\>]+\>)|(\<\/i18n\>)/, "") : v unless RICH_I18N_OPTIONS.include?(k)
                           hash
                         end
             
-              k = "#{key.inspect}, #{options.inspect}"
-              translation = (@@i18n_translations[k] ||= I18n.t(key, options).dup)
+              k = "#{I18n.locale} #{key.inspect}, #{options.inspect}"
+              translation = if Engine.cache_translations
+                              (@@i18n_translations[k] ||= I18n.t(key, options)).try :dup
+                            else
+                              I18n.t key, options
+                            end
               opts[:translate_callback].try :call, translation, key, options
     
               translation

data/lib/rich/i18n/engine.rb

@@ -4,9 +4,30 @@ module Rich
     module Engine
       extend self
     
-      attr_accessor :enable_enriched_output
-    
+      attr_accessor :enable_enriched_output, :cache_translations
+      
       def init(test_class = nil)
+        @enable_enriched_output = true if @enable_enriched_output.nil?
+        @cache_translations     = true if @cache_translations    .nil?
+        
+        %w(controllers).each do |dir|
+          path = File.join File.dirname(__FILE__), "..", "..", "app", dir
+          $LOAD_PATH << path
+          ActiveSupport::Dependencies.load_paths << path
+          ActiveSupport::Dependencies.load_once_paths.delete path
+        end
+        
+        ::Jzip::Engine.add_template_location({File.join(File.dirname(__FILE__), "..", "..", "assets", "jzip") => File.join(RAILS_ROOT, "public", "javascripts")})
+        
+        load_i18n test_class
+      end
+      
+      def current_controller=(current_controller)
+        @current_controller = current_controller
+        @can_enrich_output  = nil
+      end
+      
+      def load_i18n(test_class)
         if test_class
           test_locale = test_class.name.match(/(Rich\:\:I18n\:\:Test\:\:Locales\:\:)(\w+)/).captures[1].downcase.to_sym
           
@@ -19,11 +40,34 @@ module Rich
         
         test_locale
       end
+    
+      def enable_i18n_cms(enriched_output_criteria = :current_rich_cms_admin, assign_i18n_backend = true)
+        raise "Missing E9s module Rich-CMS, please install first" unless defined?(Cms::Engine)
+        
+        self.enable_enriched_output = enriched_output_criteria
+        Cms::Engine.register ".i18n", {:class_name => "Translation", :key => [:key, :locale], :before_edit => "Rich.I18n.beforeEdit", :after_update => "Rich.I18n.afterUpdate"}
+        
+        # FIXME: the check is a dirty fix to be able to test all the E9s modules at once (find a better implementation)
+        if RAILS_ENV != "test" && assign_i18n_backend
+          ::I18n.backend = ::I18n::Backend::Chain.new ::I18n::Backend::ActiveRecord.new, ::I18n.backend
+          ::I18n.backend.extend ::I18n::Backend::Fallbacks
+        end
+      end
       
+      def enable_enriched_output=(value)
+        @enable_enriched_output = value
+        @can_enrich_output      = nil
+      end
+
       def can_enrich_output?
-        !enable_enriched_output.blank? and (enable_enriched_output.is_a?(Symbol) ? (send(enable_enriched_output) rescue false) : enable_enriched_output)
+        if @can_enrich_output.nil?
+          @can_enrich_output = !!@enable_enriched_output &&
+                                (@enable_enriched_output.is_a?(Symbol) ? (@current_controller.send(@enable_enriched_output) rescue false) : @enable_enriched_output)
+        else
+          @can_enrich_output
+        end
       end
-    
+      
     end
   end
 end

data/lib/rich/i18n/formtastic.rb

@@ -8,12 +8,12 @@ module Rich
       end
 
       def input_with_enrichments(*args)
-        object      = (@object.class.name if @object) || @object_name.match(/\[(\w+)_attributes\]/).captures.first.classify
+        object      = ((@object.class.name if @object) || @object_name.match(/\[(\w+)_attributes\]/).captures.first).camelize
         method_arg  = args.shift
         method      = method_arg.to_s
         options     = args.extract_options!
         wrapper_tag = options.delete(:wrapper_tag)
-
+        
         unless options.include?(:label)
           keys = [:"label.#{object}.#{method}", :"label.#{method}", :"word.#{method}"]
         

data/rails_generators/rich_i18n_translation/rich_i18n_translation_generator.rb

@@ -0,0 +1,60 @@
+class RichI18nTranslationGenerator < Rails::Generator::Base
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @name = @args.first || "translation"
+  end
+
+  def manifest
+    record do |m|
+      m.directory                          "app/models"
+      m.template               "model.rb", "app/models/#{model_file_name}.rb"
+      m.template              "config.rb", "config/initializers/enrichments.rb", {:collision => :skip}
+      m.migration_template "migration.rb", "db/migrate", :migration_file_name => migration_file_name
+    end
+  end
+  
+  def after_generate
+    File.open(destination_path("config/initializers/enrichments.rb"), "a+") do |file|
+      file << "\nRich::I18n::Engine.enable_i18n_cms"
+    end
+    
+    system "rake db:migrate" if options[:migrate]
+  end
+
+  def model_file_name
+    @name.underscore
+  end
+
+  def model_class_name
+    @name.classify
+  end
+  
+  def table_name
+    model_file_name.gsub("/", "_").pluralize
+  end
+
+  def migration_file_name
+    "create_#{table_name}"
+  end
+
+  def migration_class_name
+    migration_file_name.camelize
+  end
+
+protected
+
+  def add_options!(opt)
+    opt.separator ""
+    opt.separator "Options:"
+    opt.on("-m", "--migrate", "Run 'rake db:migrate' after generating model and migration.") { options[:migrate] = true }
+  end
+
+  def banner
+    <<-EOS
+Creates Rich-i18n translation model and migration.
+
+USAGE: #{$0} #{spec.name} [model_name]
+EOS
+  end
+
+end

data/rails_generators/rich_i18n_translation/templates/migration.rb

@@ -0,0 +1,18 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+      t.string  :locale
+      t.string  :key
+      t.text    :value
+      t.boolean :is_proc, :default => false
+      t.timestamps
+    end
+    
+    add_index :<%= table_name %>, :locale
+    add_index :<%= table_name %>, :key
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/rails_generators/rich_i18n_translation/templates/model.rb

@@ -0,0 +1,7 @@
+class <%= model_class_name %> < ActiveRecord::Base
+  
+  def to_rich_cms_response(params)
+    {:value => value, :translations => Hash[*params[:derivative_keys].split(";").uniq.collect{|x| [x, x.t]}.flatten]}
+  end
+  
+end

data/rich_i18n.gemspec

@@ -0,0 +1,112 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rich_i18n}
+  s.version = "1.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Paul Engel"]
+  s.date = %q{2010-10-01}
+  s.description = %q{Rich-i18n is a module of E9s (http://github.com/archan937/e9s) which enriches I18n, Formtastic, the String and Symbol classes. This simplifies internationalization of your Rails application making a Rails developers life much easier.}
+  s.email = %q{paul.engel@holder.nl}
+  s.extra_rdoc_files = [
+    "README.textile"
+  ]
+  s.files = [
+    ".gitignore",
+     "CHANGELOG",
+     "MIT-LICENSE",
+     "README.textile",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "install.rb",
+     "lib/app/views/rich_i18n.html.erb",
+     "lib/assets/jzip/jquery/core.jz",
+     "lib/assets/jzip/jquery/extensions/modules.js",
+     "lib/assets/jzip/jquery/seat_holder.js",
+     "lib/assets/jzip/rich.js",
+     "lib/assets/jzip/rich/i18n.js",
+     "lib/assets/jzip/rich_i18n.jz",
+     "lib/rich/i18n.rb",
+     "lib/rich/i18n/actionpack.rb",
+     "lib/rich/i18n/actionpack/action_controller/base.rb",
+     "lib/rich/i18n/actionpack/action_controller/dispatcher.rb",
+     "lib/rich/i18n/actionpack/action_view/base.rb",
+     "lib/rich/i18n/actionpack/action_view/sanitizor.rb",
+     "lib/rich/i18n/core.rb",
+     "lib/rich/i18n/core/array.rb",
+     "lib/rich/i18n/core/array/merging.rb",
+     "lib/rich/i18n/core/enriched_string.rb",
+     "lib/rich/i18n/core/enumerable/methods.rb",
+     "lib/rich/i18n/core/erb.rb",
+     "lib/rich/i18n/core/erb/output.rb",
+     "lib/rich/i18n/core/hash.rb",
+     "lib/rich/i18n/core/nil_class.rb",
+     "lib/rich/i18n/core/object.rb",
+     "lib/rich/i18n/core/object/output.rb",
+     "lib/rich/i18n/core/string.rb",
+     "lib/rich/i18n/core/string/enrichments.rb",
+     "lib/rich/i18n/core/string/inflections.rb",
+     "lib/rich/i18n/core/string/internationalization.rb",
+     "lib/rich/i18n/core/symbol.rb",
+     "lib/rich/i18n/core/symbol/internationalization.rb",
+     "lib/rich/i18n/engine.rb",
+     "lib/rich/i18n/formtastic.rb",
+     "lib/rich_i18n.rb",
+     "locales/nl.yml",
+     "rails/init.rb",
+     "rails_generators/rich_i18n_translation/rich_i18n_translation_generator.rb",
+     "rails_generators/rich_i18n_translation/templates/config.rb",
+     "rails_generators/rich_i18n_translation/templates/migration.rb",
+     "rails_generators/rich_i18n_translation/templates/model.rb",
+     "rich_i18n.gemspec",
+     "tasks/rich_i18n_tasks.rake",
+     "test/core/string/inflections_test.rb",
+     "test/core/string/internationalization_test.rb",
+     "test/engine_test.rb",
+     "test/locales/nl/internationalization_test.rb",
+     "test/setup.rb",
+     "test/test_helper.rb",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/archan937/rich_i18n}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Enrichments (e9s) module for internationalization (i18n)}
+  s.test_files = [
+    "test/core/string/inflections_test.rb",
+     "test/core/string/internationalization_test.rb",
+     "test/engine_test.rb",
+     "test/locales/nl/internationalization_test.rb",
+     "test/setup.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<i18n>, ["= 0.3.7"])
+      s.add_runtime_dependency(%q<jzip>, [">= 1.0.10"])
+      s.add_runtime_dependency(%q<hpricot>, [">= 0"])
+      s.add_runtime_dependency(%q<formtastic>, ["= 0.9.7"])
+    else
+      s.add_dependency(%q<i18n>, ["= 0.3.7"])
+      s.add_dependency(%q<jzip>, [">= 1.0.10"])
+      s.add_dependency(%q<hpricot>, [">= 0"])
+      s.add_dependency(%q<formtastic>, ["= 0.9.7"])
+    end
+  else
+    s.add_dependency(%q<i18n>, ["= 0.3.7"])
+    s.add_dependency(%q<jzip>, [">= 1.0.10"])
+    s.add_dependency(%q<hpricot>, [">= 0"])
+    s.add_dependency(%q<formtastic>, ["= 0.9.7"])
+  end
+end
+