fdl_translator 1.0.1

data/tasks/translator.rake

@@ -0,0 +1,23 @@
+require 'yaml'
+
+# Internationalization tasks
+namespace :i18n do
+  
+  desc "Validates YAML locale bundles"
+  task :validate_yml => [:environment] do |t, args|
+    
+    # Grab all the yaml bundles in config/locales
+    bundles = Dir.glob(File.join(RAILS_ROOT, 'config', 'locales', '**', '*.yml'))
+    
+    # Attempt to load each bundle
+    bundles.each do |bundle|
+      
+      begin
+        YAML.load_file( bundle )        
+      rescue Exception => exc
+        puts "Error loading: #{bundle}"
+        puts exc.to_s
+      end
+    end
+  end  
+end

data/test/fixtures/app/controllers/blog_posts_controller.rb

@@ -0,0 +1,89 @@
+# Stub a Blog Posts controller
+class BlogPostsController < ActionController::Base
+  
+  # Sets up view paths so tests will work
+  before_filter :fix_view_paths
+
+  # Simulate auth filter
+  before_filter :authorize, :only => [:admin]
+
+  layout "blog_layout", :only => :show_with_layout
+
+  def index
+    # Pull out sample strings for index to the fake blog
+    @page_title = t('title')
+    @intro = translate(:intro, :owner => "Ricky Rails")
+    render :nothing => true, :layout => false
+  end
+  
+  def show
+    # Sample blog post
+    render :template => "blog_posts/show"
+  end
+  
+  def about
+    # About page
+    render :template => "blog_posts/about"
+  end
+  
+  # Render the show action with a layout
+  def show_with_layout
+    render :template => "blog_posts/show"
+  end
+  
+  # The archives action references a view helper
+  def archives
+    render :template => "blog_posts/archives"
+  end
+  
+  # View that has a key that doesn't reference a valid string
+  def missing_translation
+    render :template => "blog_posts/missing_translation"
+  end
+  
+  def different_formats
+    # Get the same tagline using the different formats
+    @taglines = []
+    @taglines << t('global.sub.key') # dot-sep keys
+    @taglines << t('sub.key', :scope => :global) # dot-sep keys with scope
+    @taglines << t('key', :scope => 'global.sub') # string key with dot-sep scope
+    @taglines << t(:key, :scope => 'global.sub') # symbol key with dot-sep score
+    @taglines << t(:key, :scope => %w(global sub))
+    render :nothing => true
+  end
+  
+  # Partial template, but stored within this controller
+  def footer_partial
+    render :partial => "footer"
+  end
+  
+  # Partial that is shared across controllers
+  def header_partial
+    render :partial => "shared/header"
+  end
+
+  def admin
+    # Simulate an admin page that has a protection scheme
+  end
+  
+  def default_value
+    # Get a default value if the string isn't there
+    @title = t('not_there', :default => 'the default')
+    render :nothing => true
+  end
+  
+  protected
+  
+  # Simulate an auth system that prevents login
+  def authorize
+    # set a flash with a common message
+    flash[:error] = t('flash.invalid_login')
+    redirect_to :action => :index
+  end
+  
+  def fix_view_paths
+    # Append the view path to get the correct views/partials
+    self.append_view_path("#{File.dirname(__FILE__)}/../views")
+  end
+  
+end

data/test/fixtures/app/helpers/blog_posts_helper.rb

@@ -0,0 +1,10 @@
+# Helper
+module BlogPostsHelper
+  
+  # Get the list of archives
+  def get_archives
+    # Will be scoped to controller.action ("blog_posts.archives")
+    t('title')
+  end
+  
+end

data/test/fixtures/app/models/blog_comment_mailer.rb

@@ -0,0 +1,10 @@
+# A mailer for new comments on the fake blog
+class BlogCommentMailer < ActionMailer::Base
+  # Send email about new comments
+  def comment_notification
+    @subject = t('subject')
+  end
+end
+
+# Set the path to where the mail template will be found
+BlogCommentMailer.template_root = "#{File.dirname(__FILE__)}/../views"

data/test/fixtures/app/models/blog_post.rb

@@ -0,0 +1,14 @@
+# Model of a blog post, defined in schema.rb
+class BlogPost < ActiveRecord::Base
+  
+  # text for a permalink
+  def self.permalink(url)
+    t('permalink', :url => url)
+  end
+  
+  # Has a title, author and body
+  def written_by
+    # Get sting like "Written by Ricky"
+    t('byline', :author => self.author)
+  end
+end

data/test/fixtures/app/views/blog_comment_mailer/comment_notification.rhtml

@@ -0,0 +1,5 @@
+Subject: <%= @subject %>
+
+From,
+
+<%= t('signoff' )%>

data/test/fixtures/app/views/blog_posts/_footer.erb

@@ -0,0 +1,3 @@
+<hr />
+
+<p><%= t('copyright') %></p>

data/test/fixtures/app/views/blog_posts/about.erb

@@ -0,0 +1,6 @@
+<!-- Fake About page -->
+<%# Bio exists in English & Spanish %>
+<%= t('bio') %>
+
+<%# Subscribe only exists in English %>
+<%= t('subscribe_feed') %>

data/test/fixtures/app/views/blog_posts/archives.erb

@@ -0,0 +1,2 @@
+<%# Call to BlogPostsHelper %>
+<%= get_archives() %>

data/test/fixtures/app/views/blog_posts/missing_translation.erb

@@ -0,0 +1,2 @@
+<!-- Key should not be found -->
+<p><%= t('missing_string') %></p>

data/test/fixtures/app/views/blog_posts/show.erb

@@ -0,0 +1,4 @@
+<!-- Simulate blog posting page -->
+<h1><%= t('title') %></h1>
+
+<p><%= t('body', :name => 'hobbes') %></h1>

data/test/fixtures/app/views/layouts/blog_layout.erb

@@ -0,0 +1,9 @@
+<html>
+
+<body>
+  <h1><%= t('blog_title') %></h1>
+  
+  <%= yield %>
+  
+</body>
+</html>

data/test/fixtures/app/views/shared/_header.erb

@@ -0,0 +1,2 @@
+<!-- The header for my awesome blog -->
+<h1><%= translate('blog_name') %></h1>

data/test/fixtures/schema.rb

@@ -0,0 +1,11 @@
+ActiveRecord::Schema.define do
+
+  create_table "blog_posts", :force => true do |t|
+    t.column "title",:string
+    t.column "body", :text
+    t.column "author", :string
+    t.column "created_at", :datetime
+    t.column "updated_at", :datetime
+    
+  end
+end

data/test/locales/en.yml

@@ -0,0 +1,56 @@
+en:
+  # Global strings
+  global:
+    sub:
+      key: "Hello i18n World"
+
+  # Controller
+  blog_posts:
+    # shared strings
+    bio: "Hello!"
+    subscribe_feed: "Subscribe to my feed!"
+    
+    # typical actions
+    index: 
+      title: "My Blog Posts"
+      intro: "Welcome to the blog of {{owner}}"
+    # specific post
+    show:
+      title: "Catz Are Cute"
+      body: "My cat {{name}} is the most awesome"
+      category: "catz, lolz"
+    # archives action - key used from a view helper
+    archives:
+      title: "My Blog Archives"
+    # footer partial (non-shared)
+    footer:
+      copyright: "Copyright 2009"
+    
+    # Flash messages not specific to one action, but within a single controller
+    flash:
+      invalid_login: "Invalid login"
+    
+  # shared partials in the "shared" dir
+  shared:
+    header:
+      blog_name: "Ricky Rocks Rails"
+      
+  # Layouts
+  layouts:
+    blog_layout:
+      blog_title: "The Blog of Ricky"  
+  
+  #
+  # ActiveRecord models (note singular)
+  #
+  blog_post:
+    byline: "Written by {{author}}"
+    permalink: "Permalink to {{url}}"
+
+  #
+  # ActionMailers
+  #
+  blog_comment_mailer:
+    comment_notification:
+      subject: "New Comment Notification"
+      signoff: "Your Faithful Emailing Bot"

data/test/locales/es.yml

@@ -0,0 +1,16 @@
+# Spanish version (pardon the bad translations)
+es:
+  # Global strings
+  global:
+    sub:
+      key: "Hola i18n Mundo"
+  
+  # Controller
+  blog_posts:
+    # shared strings
+    bio: "Hola!"
+    
+    # typical actions
+    index: 
+      # Purposely has the intro but *not* "title" key
+      intro: "Bienvenidos a el blog de {{owner}}"

data/test/test_helper.rb

@@ -0,0 +1,90 @@
+# Load Rails from the app, which allows picking up a frozen rails install 
+# instead of from the gems
+#
+# Borrowed from setup in classic_pagination plugin
+plugin_root = File.join(File.dirname(__FILE__), '..')
+# is the plugin installed in an application?
+app_root = plugin_root + '/../../..'
+
+if File.directory? app_root + '/config'
+  Object.const_set(:RAILS_ENV, ENV["RAILS_ENV"] ||= "test") unless defined?(RAILS_ENV)
+  Object.const_set(:RAILS_ROOT, app_root) unless defined?(RAILS_ROOT)
+  require "#{RAILS_ROOT}/config/environment"
+end
+
+require 'pp'
+require 'test/unit'
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'
+
+require 'action_controller'
+require 'action_controller/test_process'
+require 'action_mailer'
+require 'active_record'
+require 'active_record/fixtures'
+
+require 'action_pack'
+require 'action_view'
+require 'action_view/helpers'
+
+# Load the Translator init after loading Rails
+require File.dirname(__FILE__) + '/../init'
+
+# Set up an ActiveRecord connection to sqlite db for testing
+# Define the connector
+class ActiveRecordTestConnector
+  cattr_accessor :able_to_connect
+  cattr_accessor :connected
+
+  # Set our defaults
+  self.connected = false
+  self.able_to_connect = true
+
+  class << self
+    def setup
+      unless self.connected || !self.able_to_connect
+        setup_connection
+        load_schema
+        self.connected = true
+      end
+    rescue Exception => e  # errors from ActiveRecord setup
+      $stderr.puts "\nSkipping ActiveRecord assertion tests: #{e}"
+      self.able_to_connect = false
+    end
+
+    private
+
+    def setup_connection
+      if Object.const_defined?(:ActiveRecord)
+        defaults = { :database => ':memory:' }
+        begin
+          options = defaults.merge :adapter => 'sqlite3', :timeout => 500
+          ActiveRecord::Base.establish_connection(options)
+          ActiveRecord::Base.configurations = { 'sqlite3_ar_integration' => options }
+          ActiveRecord::Base.connection
+        rescue Exception  # errors from establishing a connection
+          $stderr.puts 'SQLite 3 unavailable; trying SQLite 2.'
+          options = defaults.merge :adapter => 'sqlite'
+          ActiveRecord::Base.establish_connection(options)
+          ActiveRecord::Base.configurations = { 'sqlite2_ar_integration' => options }
+          ActiveRecord::Base.connection
+        end
+
+        Object.send(:const_set, :QUOTED_TYPE, ActiveRecord::Base.connection.quote_column_name('type')) unless Object.const_defined?(:QUOTED_TYPE)
+      else
+        raise "Can't setup connection since ActiveRecord isn't loaded."
+      end
+    end
+
+    # Loads the schema.rb 
+    def load_schema
+      # Silence the output of creating the db
+      silence_stream(STDOUT) do
+        Dir.glob(File.dirname(__FILE__) + "/fixtures/schema.rb").each {|f| require f}
+      end
+    end
+  end
+end
+
+ActiveRecordTestConnector.setup

data/test/translator_test.rb

@@ -0,0 +1,353 @@
+require 'test_helper'
+
+# Include the models/helpers directories on the load path.
+[:models, :helpers, :controllers].each do |path|
+  $:.unshift "#{File.dirname(__FILE__)}/fixtures/app/#{path}"
+end
+
+# sample AR model
+require 'blog_post'
+# sample ActionMailer
+require 'blog_comment_mailer'
+# sample controller
+require 'blog_posts_controller'
+
+# Set up simple routing for testing
+ActionController::Routing::Routes.reload rescue nil
+ActionController::Routing::Routes.draw do |map|
+  map.connect ':controller/:action/:id'
+end
+
+# For Rails 2.2 compat
+parent_module = ActiveSupport::TestCase
+
+if Rails::VERSION::MAJOR == 2 && Rails::VERSION::MINOR > 2
+  # Rails 2.3 compat
+  parent_module = ActionController::TestCase
+end
+
+# Test Translator functionality
+class TranslatorTest < parent_module
+
+  def setup
+    # Create test locale bundle
+    I18n.backend = I18n::Backend::Simple.new
+    
+    # tell the I18n library where to find your translations
+    I18n.load_path += Dir.glob(File.join(File.dirname(__FILE__), 'locales', '*.{yml,rb}'))
+
+    # reset the locale
+    I18n.default_locale = :en
+    I18n.locale = :en
+    
+    # Set up test env
+    @controller = BlogPostsController.new
+    @request    = ActionController::TestRequest.new
+    @response   = ActionController::TestResponse.new
+    super
+  end
+  
+  ### ActionController Tests
+  
+  # Test that translate gets typical controller scoping
+  def test_controller_simple
+    get :index
+    assert_response :success
+    assert_not_nil assigns
+    # Test that controller could translate
+    assert_equal I18n.t('blog_posts.index.title'), assigns(:page_title)
+    assert_equal I18n.translate('blog_posts.index.intro', :owner => "Ricky Rails"), assigns(:intro)
+  end
+  
+  # Test that if something that breaks convention is still processed correctly
+  # This case breaks with standard key hierarchy convention
+  def test_controller_different_formats
+    get :different_formats
+    assert_response :success
+    assert_not_nil assigns(:taglines)
+    
+    expected = "Hello i18n World" # copied from en.yml
+
+    assigns(:taglines).each do |str|
+      assert_equal expected, str
+    end
+  end
+  
+  # Test call to translate with default value
+  def test_controller_with_defaults
+    get :default_value
+    assert_response :success
+    assert_not_nil assigns(:title)
+    
+    # TODO: Need better way to check that the default was only returned as last resort.
+    assert_equal 'the default', assigns(:title)
+  end
+  
+  # TODO: Test bulk lookup
+  def test_bulk_lookup
+    # flunk
+  end
+  
+  # Translator should raise an exception on a leading dot key to 
+  # preserve Rails 2.3 behavior. It is caught & handled
+  def test_leading_dot_key
+    assert_raise Translator::TranslatorError do
+      Translator.translate_with_scope(["blog_posts", "show"], ".category")
+    end
+  end
+  
+  # Test that first the most specific scope will be tried (controller.action) then
+  # back off to just the outer scope (controller)
+  def test_controller_shared_messages
+    get :admin
+    assert_response :redirect
+    
+    # Test that t should have tried the outer scope
+    assert_equal I18n.t('blog_posts.flash.invalid_login'), flash[:error]
+  end
+  
+  ### ActionView Tests
+  
+  # Test that translate works in Views. 
+  # Also tests that a dotted key (".foo") can be accepted used, since
+  # Rails 2.3 supports it
+  def test_view_show
+    get :show
+    assert_response :success
+    post_title = I18n.translate('blog_posts.show.title')
+    post_body = I18n.t('blog_posts.show.body', :name => 'hobbes') # matches show.erb
+
+    assert_match /#{post_title}/, @response.body
+    assert_match /#{post_body}/, @response.body
+  end
+  
+  # Test that layouts can pull strings
+  def test_show_with_layout
+    get :show_with_layout
+    assert_response :success
+    
+    blog_title = I18n.t('layouts.blog_layout.blog_title')
+    assert_match /#{blog_title}/, @response.body
+  end
+  
+  # Test that partials pull strings from their own key
+  def test_view_partial
+    get :footer_partial
+    assert_response :success
+    
+    footer = I18n.t('blog_posts.footer.copyright')
+    assert_match /#{footer}/, @response.body
+  end
+  
+  def test_header_partial
+    get :header_partial
+    assert_response :success
+    
+    blog_name = I18n.t('shared.header.blog_name')
+    assert_match /#{blog_name}/, @response.body
+  end
+  
+  # Test that view helpers inherit correct scoping
+  def test_view_helpers
+    get :archives
+    assert_response :success
+    
+    archives_title = I18n.t('blog_posts.archives.title')
+    assert_match /#{archives_title}/, @response.body
+  end
+  
+  # Test that original behavior of TranslationHelper is not undone.
+  # It adds a <span class="translation_missing"> that should still be there
+  def test_missing_translation_show_in_span
+    Translator.strict_mode(false)
+    
+    get :missing_translation
+    assert_response :success
+
+    # behavior added by TranslationHelper
+    assert_match /span class="translation_missing"/, @response.body, "Should be a span tag translation_missing"
+  end
+  
+  # Test that strict mode prevents TranslationHelper from adding span.
+  def test_strict_mode_in_views
+    Translator.strict_mode(true)
+    
+    get :missing_translation
+    assert_response :error
+    assert_match /18n::MissingTranslationData/, @response.body, "Exception should be for a missing translation"
+  end
+  
+  ### ActionMailer Tests
+  
+  def test_mailer    
+    mail = BlogCommentMailer.create_comment_notification
+    # Subject is fetched from the mailer action
+    subject = I18n.t('blog_comment_mailer.comment_notification.subject')
+    
+    # Signoff is fetched in the mail template (via addition to ActionView)
+    signoff = I18n.t('blog_comment_mailer.comment_notification.signoff')
+    
+    assert_match /#{subject}/, mail.body
+    assert_match /#{signoff}/, mail.body
+  end
+   
+  ### ActiveRecord tests
+  
+  # Test that a model's method can call translate
+  def test_model_calling_translate
+    post = nil
+    author = "Ricky"
+    assert_nothing_raised do
+      post = BlogPost.create(:title => "First Post!", :body => "Starting my new blog about RoR", :author => author)
+    end
+    assert_not_nil post
+    
+    assert_equal I18n.t('blog_post.byline', :author => author), post.written_by
+  end
+  
+  # Test that the translate method is added as a class method too so that it can
+  # be used in validate calls, etc.
+  def test_class_method_translate
+    
+    url = "http://ricky.blog"
+    # Call a static method
+    assert_equal I18n.t('blog_post.permalink', :url => url), BlogPost.permalink(url)
+  end
+   
+  ### TestUnit helpers
+  
+  def test_strict_mode
+    Translator.strict_mode(true)
+    
+    # With strict mode on, exception should be thrown
+    assert_raise I18n::MissingTranslationData do
+      str = "Exception should be raised #{I18n.t('the_missing_key')}"
+    end
+    
+    Translator.strict_mode(false)
+    
+    assert_nothing_raised do
+      str = "Exception should not be raised #{I18n.t('the_missing_key')}"
+    end
+  end
+  
+  # Fetch a miss
+  def test_assert_translated
+    # Within the assert_translated block, any missing keys fail the test
+    assert_raise Test::Unit::AssertionFailedError do
+      assert_translated do
+        str = "Exception should be raised #{I18n.t('the_missing_key')}"
+      end
+    end
+    
+    assert_nothing_raised do
+      str = "Exception should not be raised #{I18n.t('the_missing_key')}"
+    end
+  end
+  
+  # Test that marker text appears in when using pseudo-translation
+  def test_pseudo_translate
+    Translator.pseudo_translate(true)
+    
+    # Create a blog post that uses translate to create a byline
+    blog_post = BlogPost.create!(:author => "Ricky")
+    assert_not_nil blog_post
+    
+    assert_match Translator.pseudo_prepend, blog_post.written_by, "Should start with prepend text"
+    assert_match Translator.pseudo_append, blog_post.written_by, "Should end with append text"
+  end
+  
+  # Test that markers can be changed
+  def test_pseudo_translate_with_diff_markers
+    Translator.pseudo_translate(true)
+    
+    start_marker = "!!"
+    end_marker = "%%"
+    
+    # Set the new markers
+    Translator.pseudo_prepend = start_marker
+    Translator.pseudo_append = end_marker
+    
+    get :footer_partial
+    assert_response :success
+
+    # Test that the view has the pseudo-translated strings
+    copyright = I18n.t('blog_posts.footer.copyright')
+    assert_match /#{start_marker + copyright + end_marker}/, @response.body
+  end
+  
+  # Test that if fallback mode is enabled, the default locale is used if
+  # the set locale can't be found
+  def test_fallback
+    # Enable fallback mode
+    Translator.fallback(true)
+    
+    # Set the locale to Spanish
+    I18n.locale = :es
+    
+    # The index action fetchs 2 keys - 1 has a Spanish translation (intro), 1 does not
+    get :index
+    assert_response :success
+    assert_not_nil assigns
+    
+    # Test that controller could translate the intro from spanish
+    assert_equal I18n.t('blog_posts.index.intro', :owner => "Ricky Rails"), assigns(:intro)
+    
+    # Test that global strings are found correctly when they have a prefix
+    assert_equal I18n.t('global.sub.key', :locale => :es), @controller.t('global.sub.key')
+    
+    # Should find the English version
+    I18n.locale = :en # reset local so call to I18n pulls correct string
+    assert_equal I18n.translate('blog_posts.index.title'), assigns(:page_title)
+    
+    # Test that global strings are found correctly when they have a prefix
+    assert_equal I18n.t('global.sub.key', :locale => :en), @controller.t('global.sub.key')
+  end
+  
+  # Test that fallback 
+  def test_fallback_with_scoping_backoff
+    
+    # Enable fallback mode
+    Translator.fallback(true)
+    
+    # Set the locale to Spanish
+    I18n.locale = :es
+    
+    get :about
+    assert_response :success
+    
+    # Test that the Spanish version was found
+    bio = I18n.t('blog_posts.bio', :locale => :es)
+    assert_match /#{bio}/, @response.body
+    
+    # Only English version of this string
+    subscribe = I18n.t('blog_posts.subscribe_feed', :locale => :en)
+    assert_match /#{subscribe}/, @response.body
+  end
+  
+  # Test that we can set up a callback for missing translations
+  def test_missing_translation_callback
+    test_exception = nil
+    test_key = nil
+    test_options = nil
+       
+    Translator.set_missing_translation_callback do |ex, key, options|
+      test_exception = ex
+      test_key = key
+      test_options = options
+    end
+    
+    get :missing_translation
+    assert_response :success
+    assert_equal "missing_string", test_key
+    assert_not_nil test_options
+    assert_not_nil test_exception
+  end
+  
+  # Test the generic translate method on Translator that does lookup without a scope, but includes fallback behavior.
+  def test_generic_translate_methods
+    assert_equal I18n.t('blog_posts.index.intro', :owner => "Ricky Rails"), Translator.translate('blog_posts.index.intro', :owner => "Ricky Rails")
+    assert_equal I18n.t('blog_posts.footer.copyright'), Translator.t('blog_posts.footer.copyright')
+  end
+  
+end