rich_i18n 1.2.3 → 1.3.0

data/CHANGELOG

@@ -1,6 +1,6 @@
 = Rich-i18n CHANGELOG
 
-== Version 1.2.3 (October 19, 2010)
+== Version 1.2.3 (October 20, 2010)
 
 * Using SeatHolder v0.8.8 in order to tell SeatHolder not to react on focus events (yay!)
 * Corrected Rich.I18n.afterUpdate() so certain page elements will be updated again after updating translations

data/README.textile

@@ -35,50 +35,46 @@ h3. More available features when using E9s (enrichments)
 
 h2. Installation
 
-h3. Using Rich-i18n as gem
+h3. Using Rich-i18n as gem in Rails 3
 
-Install the Rich-i18n gem:
+Add Rich-i18n in @Gemfile@ as a gem dependency:
 
 <pre>
-  sudo gem install rich_i18n
+  gem "rich_i18n"
 </pre>
 
-Add rich_i18n in environment.rb as a gem dependency:
+Run the following in your console to install with Bundler:
 
 <pre>
-  config.gem "rich_i18n"
+  bundle install
 </pre>
 
-h3. Using Rich-i18n as plugin
+h3. Using Rich-i18n as gem in Rails 2
 
-Install the Rich-i18n plugin:
+Add Rich-i18n in @environment.rb@ as a gem dependency:
 
 <pre>
-  ./script/plugin install git://github.com/archan937/rich_i18n.git 
+  config.gem "rich_i18n"
 </pre>
 
-Install i18n if you haven't already:
+Run the following in your console:
 
 <pre>
-  sudo gem install i18n
+  sudo rake gems:install
 </pre>
 
-h3. Optional
-
-You will have to install the @Formtastic@ plugin when translating @labels@ and @seatholders@ with *Rich-i18n as plugin*:
+h3. Using Rich-i18n as plugin in Rails 3
 
 <pre>
-  ./script/plugin install git://github.com/justinfrench/formtastic.git
+  rails plugin install git://github.com/archan937/rich_i18n.git
 </pre>
 
-When wanting to use @seatholders@, please include @seat_holder.js@ in your template:
+h3. Using Rich-i18n as plugin in Rails 2
 
 <pre>
-  <script src="path/to/seat_holder.js" type="text/javascript"></script>
+  script/plugin install git://github.com/archan937/rich_i18n.git
 </pre>
 
-*Note*: please visit "http://github.com/archan937/seat_holder":http://github.com/archan937/seat_holder for more information about SeatHolder.
-
 h3. Testing Rich-i18n out-of-the-box
 
 Run the Rails console:
@@ -96,6 +92,38 @@ Start translating in Dutch:
   => "Man / Vrouw"
 </pre>
 
+h2. Use the provided Rails generators
+
+Rich-i18n requires the following entity:
+
+* An @ActiveRecord@ model used for translations storage
+
+Fortunately, Rich-i18n is provided with a Rails generator with which you can generate the entity.
+
+h4. In Rails 3
+
+Run the following in your console:
+
+<pre>
+  rails g rich:translation -m
+</pre>
+
+*Note*: At default, it will create the @Translation@ class and @CreateTranslations@ migration. You can alter the class names with the following:
+
+<pre>
+  rails g rich:translation CodeHeroes::Translation -m
+</pre>
+
+*Note*: The generator has the @-m@ or @--migrate@ option which runs @rake db:migrate@ after creating the files.
+
+h4. In Rails 2
+
+Run the following in your console:
+
+<pre>
+  script/generate rich_i18n_translation -m
+</pre>
+
 h2. Usage
 
 Just call the @t@ method on string or symbols to translate using Rich-i18n.
@@ -109,7 +137,7 @@ At default, I18n uses @I18n::Backend::Simple@ of which translations are stored w
 <pre>
 ---
 nl:
-  
+
   word:
     "yes":   ja
     "no":    nee
@@ -203,32 +231,32 @@ You can translate @labels@ and @seatholders@ (placeholders :D) within Formtastic
 <pre>
 ---
 nl:
-  
+
   word:
     password:       wachtwoord
-  
+
   label:
     user_name:      gebruikersnaam
     content:        bericht
-    
+
     Question:
       content:      jouw vraag
-    
+
     Answer:
       content:      jouw antwoord
-    
+
     (search_form)
       criteria:     uw zoekcriteria
-  
+
   seatholder:
     email_address:  uw.naam@een.website.nl
-    
+
     Question:
       content:      Hoeveel uren zitten in een dag?
-    
+
     Answer:
       content:      24 uur
-    
+
     (search_form)
       criteria:     '&Voorbeeld'
 </pre>
@@ -263,7 +291,6 @@ h2. ToDo's
 * Handle the click on inputs with seatholders better
 * Use a better implementation to tackle String interpolation (e.g. "foo #{"bar".t}") to preserve meta data
 * Most String inflection methods are also defined in rich_pluralization (keep it DRY)
-* Make Rich-i18n compatible with Rails 3
 
 h2. Enrichments
 

data/Rakefile

@@ -12,10 +12,11 @@ begin
     gemspec.homepage    = "http://codehero.es/rails_gems_plugins/rich_i18n"
     gemspec.author      = "Paul Engel"
 
-    gemspec.add_dependency "formtastic", "1.0.1"
+    gemspec.add_dependency "authlogic" , ">= 2.1.2"
+    gemspec.add_dependency "formtastic", ">= 1.1.0"
     gemspec.add_dependency "hpricot"
     gemspec.add_dependency "i18n"      , ">= 0.3.7"
-    gemspec.add_dependency "jzip"      , ">= 1.0.10"
+    gemspec.add_dependency "jzip"      , ">= 1.0.11"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
@@ -25,12 +26,25 @@ end
 desc "Default: run unit tests."
 task :default => :test
 
-desc "Test the rich_i18n plugin."
-Rake::TestTask.new(:test) do |t|
-  t.libs    << "lib"
-  t.libs    << "test"
-  t.pattern  = "test/**/*_test.rb"
-  t.verbose  = true
+task :test do
+  Rake::Task["test:rails3"].execute
+end
+
+namespace :test do
+  desc "Test the rich_i18n plugin in Rails 2."
+  Rake::TestTask.new(:rails2) do |t|
+    t.libs    << "lib"
+    t.libs    << "test"
+    t.pattern  = "test/rails-2/{,/*/**}/*_test.rb"
+    t.verbose  = true
+  end
+  desc "Test the rich_i18n plugin in Rails 3."
+  Rake::TestTask.new(:rails3) do |t|
+    t.libs    << "lib"
+    t.libs    << "test"
+    t.pattern  = "test/rails-3/{,/*/**}/*_test.rb"
+    t.verbose  = true
+  end
 end
 
 desc "Generate documentation for the rich_i18n plugin."

data/VERSION

@@ -1 +1 @@
-1.2.3
+1.3.0

data/{lib/assets → assets}/jzip/jquery/seat_holder.js

@@ -15,19 +15,19 @@ if (typeof(SeatHolder) == "undefined") {
 
 SeatHolder = (function() {
   var hintClass = "sh_hint", hideClass = "sh_hide", ignored_types = ["file", "submit"], reacting = true;
-  
+
   var injectCode = function() {
-    var style = "<style>" + 
+    var style = "<style>" +
                   "." + hintClass + " { color: " + SeatHolder.hintColor +" !important } " +
                   "." + hideClass + " { display: none !important }" +
                 "</style>";
 
     jQuery(style).prependTo("head");
   };
-  
+
   var bind = function() {
     var hintedElements = [];
-    
+
     jQuery.each(jQuery(SeatHolder.selector), function(i, element) {
       element = jQuery(element);
       var seatholder = element.attr("seatholder");
@@ -41,11 +41,11 @@ SeatHolder = (function() {
       } else {
         hintedElements.push(element);
       }
-        
+
       element.focus(onFocus)
              .blur(onBlur);
     });
-    
+
     jQuery.each(hintedElements, function(i, element) {
       element         = jQuery(element);
       var hintElement = element.data("hint_element");
@@ -57,61 +57,61 @@ SeatHolder = (function() {
                        .attr("readonly", true)
                        .data("hinted_element", element)
                        .focus(onHintFocus);
-      
+
         jQuery.each(element.get(0).attributes, function(index, attribute) {
           var key   = attribute.name;
           var value = attribute.value;
-        
+
           if ((jQuery.inArray(key, ["class", "size", "cols", "rows", "style"]) != -1) || key.match(/^data-/)) {
             switch(attribute) {
               case "class":
                 hintElement.attr(key, value.replace(hideClass, "")); break;
               default:
                 hintElement.attr(key, value);
-            }          
+            }
           }
         });
-      
+
         hintElement.addClass(hintClass);
         element.data("hint_element", hintElement)
                .before(hintElement);
       }
-    
+
       hintElement.val(element.attr("seatholder"));
       onBlur(null, element);
     });
   };
-  
+
   var react = function(bool) {
     reacting = typeof(bool) == "undefined" ? true : bool;
   };
-  
+
   var onHintFocus = function(event) {
     if (!reacting) {
       return;
     }
-    
+
     var hintElement = jQuery(event.target).addClass(hideClass);
-    
+
     hintElement.data("hinted_element")
                .removeClass(hideClass)
                .focus();
   };
-  
+
   var onFocus = function(event) {
     if (!reacting) {
       return;
     }
-    
+
     var element = jQuery(event.target);
     var seatholder = element.attr("seatholder");
-    
+
     if (element.val() == seatholder.replace(/^&/, "")) {
       element.val("");
     }
-    
+
     var input = element.get(0);
-      
+
     if (input.createTextRange) {
       var oRange = input.createTextRange();
       oRange.moveStart("character", 0);
@@ -121,25 +121,25 @@ SeatHolder = (function() {
       input.setSelectionRange(0, element.val().length);
     }
   };
-  
+
   var onBlur = function(event, element) {
     if (element == null) {
       element = jQuery(event.target);
     }
-    
+
     var seatholder  = element.attr("seatholder");
     var hintElement = element.data("hint_element");
     if (typeof(hintElement) == "undefined") {
       hintElement = null;
     }
-    
+
     if ((element.val().length > 0 && element.val() != seatholder.replace(/^&/, ""))) {
       if (hintElement) {
-      	hintElement.addClass(hideClass);
+        hintElement.addClass(hideClass);
       }
-			return;
+      return;
     }
-    
+
     if (seatholder.match(/^&/)) {
       element.val(seatholder.replace(/^&/, ""));
     } else {
@@ -148,7 +148,7 @@ SeatHolder = (function() {
       hintElement.removeClass(hideClass);
     }
   };
-  
+
   return {
     version: "0.8.8",
     selector: "[seatholder]",
@@ -169,11 +169,11 @@ SeatHolder = (function() {
 
 (function requireMissingLibs() {
   var missing_libs = [];
-  
+
   if (typeof(jQuery) == "undefined") {
     missing_libs.push("core");
   }
-  
+
   if (missing_libs.length == 0) {
     SeatHolder.init();
   } else {
@@ -186,9 +186,9 @@ SeatHolder = (function() {
       element = element.previousSibling;
     }
     dummyScript.parentNode.removeChild(dummyScript);
-    
+
     var src = element.getAttribute("src").replace(/(development\/)?(\w+)(\-min)?\.js.*$/, "jquery/" + missing_libs.sort().join(".") + ".js");
-    document.write('<script src="' + src + '" type="text/javascript" ' + 
+    document.write('<script src="' + src + '" type="text/javascript" ' +
                            'onload="SeatHolder.init()" onreadystatechange="SeatHolder.init()">' +
                    '</script>');
   }

data/{lib/assets → assets}/jzip/rich/i18n.js

@@ -3,11 +3,11 @@ 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) {

data/lib/generators/rich.rb

@@ -0,0 +1,25 @@
+require "rails/generators/named_base"
+
+module Rich
+  module Generators
+
+    class Base < Rails::Generators::Base
+      def self.source_root
+        File.expand_path File.join(File.dirname(__FILE__), "rich", generator_name, "templates")
+      end
+    end
+
+    module Migration
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def next_migration_number(dirname)
+          Time.now.strftime "%Y%m%d%H%M%S"
+        end
+      end
+    end
+
+  end
+end