i18n_toolbox 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store
+test/debug.log
+test/i18n_toolbox_plugin.sqlite3.db

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in i18n_toolbox.gemspec
+gemspec
+
+gem "rails", "~> 3.0.7"
+gem "sqlite3-ruby"

data/README.rdoc

@@ -0,0 +1,41 @@
+== i18n_toolbox
+
+I18n_toolbox is a collection of helpers and active_model additions that solve basic problems that kept showing up when working with multiple language sites:
+
+* Showing different images for different locales
+* Different validates_length_of values for different locales
+* Truncating text to different lengths depending on locale
+* Applying "possessive case" correctly with correct use of apostrophes for different languages (ie "Jack's Homepage, Miles' Homepage, Miles")
+
+== Usage
+
+=== image_tag
+
+TBA
+
+=== truncate
+
+TBA
+
+=== validates_length_of
+
+TBA
+
+=== possessive
+
+TBA
+
+  ja:
+    i18n_toolbox:
+      character_ratio: 0.5
+
+
+== Additional information
+
+=== Maintainers
+
+* Jens Balvig (http://github.com/balvig)
+
+== License
+
+MIT License. Copyright 2011 Cookpad Pte http://cookpad.it

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+require 'rake/testtask'
+Bundler::GemHelper.install_tasks
+
+task :default => :test
+
+desc 'Run unit tests.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end

data/i18n_toolbox.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "i18n_toolbox/version"
+
+Gem::Specification.new do |s|
+  s.name        = "i18n_toolbox"
+  s.version     = I18nToolbox::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jens Balvig"]
+  s.email       = ["jens@balvig.com"]
+  s.homepage    = "https://github.com/balvig/i18n_toolbox"
+  s.summary     = %q{Provides a set of convenient helpers and active model additions for working with multiple languages}
+  s.description = %q{Provides a set of convenient helpers and active model additions for working with multiple languages}
+
+  s.rubyforge_project = "i18n_toolbox"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/i18n_toolbox/active_model/validations/length.rb

@@ -0,0 +1,28 @@
+module ActiveModel
+  module Validations
+    class LengthValidator < EachValidator
+      def validate_each(record, attribute, value)
+        value = options[:tokenizer].call(value) if value.kind_of?(String)
+
+        CHECKS.each do |key, validity_check|
+          next unless check_value = options[key]
+          
+          check_value = check_value * I18nToolbox.character_ratio if options[:localize]
+
+          value ||= [] if key == :maximum
+
+          value_length = value.respond_to?(:length) ? value.length : value.to_s.length
+          next if value_length.send(validity_check, check_value)
+
+          errors_options = options.except(*RESERVED_OPTIONS)
+          errors_options[:count] = check_value
+
+          default_message = options[MESSAGES[key]]
+          errors_options[:message] ||= default_message if default_message
+
+          record.errors.add(attribute, MESSAGES[key], errors_options)
+        end
+      end
+    end
+  end
+end

data/lib/i18n_toolbox/helpers/i18n_helper.rb

@@ -0,0 +1,18 @@
+module I18nToolbox
+  module I18nHelper
+    def image_tag(source, options = {})
+      source = "#{I18n.locale}/#{source}" if options.delete(:localize)
+      super(source, options)
+    end
+    
+    def possessive(owner, thing)
+      t(owner.last == 's' ? :'i18n_toolbox.possessive_s' : :'i18n_toolbox.possessive', :owner => owner, :thing => thing, :default => :'i18n_toolbox.possessive') if owner.present?
+    end
+
+    def truncate(text, options = {})
+      options.reverse_merge!(:length => 30)
+      options[:length] = options[:length] * I18nToolbox.character_ratio if options.delete(:localize)
+      super(text, options)
+    end
+  end
+end

data/lib/i18n_toolbox/version.rb

@@ -0,0 +1,3 @@
+module I18nToolbox
+  VERSION = "0.0.1"
+end

data/lib/i18n_toolbox.rb

@@ -0,0 +1,10 @@
+require 'i18n_toolbox/helpers/i18n_helper'
+require 'i18n_toolbox/active_model/validations/length'
+
+module I18nToolbox
+  ActionController::Base.helper(I18nHelper)
+  
+  def self.character_ratio
+    I18n.t(:'i18n_toolbox.character_ratio', :default => 1)
+  end
+end

data/test/active_model/validations/length_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+
+class I18nToolbox::LengthValidatorTest < ActiveSupport::TestCase  
+  I18n.backend = I18n::Backend::KeyValue.new({})
+  I18n.backend.store_translations :en, :i18n_toolbox => {:character_ratio => 1}
+  I18n.backend.store_translations :ja, :i18n_toolbox => {:character_ratio => 0.5}
+
+  class Post < ActiveRecord::Base
+    validates_length_of :title, :maximum => 20, :localize => true
+    validates_length_of :body, :maximum => 20
+  end
+  
+  test "validates_length_of maximum should change depending on locale if localize => true" do
+
+    I18n.locale = :en
+    assert !Post.new(:title => 'This is a long sentence').valid?
+    assert Post.new(:title => 'Short sentence').valid?
+
+    I18n.locale = :ja
+    assert !Post.new(:title => 'Short sentence').valid?
+    assert Post.new(:title => 'Short!').valid?
+  end
+  
+  test "validates_length_of maximum should work normally if localize => false" do
+    I18n.locale = :en
+    assert Post.new(:body => 'Short sentence').valid?
+  
+    I18n.locale = :ja
+    assert Post.new(:body => 'Short sentence').valid?
+  end
+  
+  #should work with range too
+end

data/test/helpers/i18n_helper_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+class I18nToolbox::I18nHelperTest < ActionView::TestCase  
+  test "image_tag given localize => true should return a localized image" do
+    I18n.locale = :ja
+    assert_match 'images/ja/logo.png', image_tag('logo.png', :localize => true)
+    I18n.locale = :en
+    assert_match 'images/en/logo.png', image_tag('logo.png', :localize => true)
+    assert_match 'images/logo.png', image_tag('logo.png', :localize => false)
+  end
+  
+  test "image_tag should otherwise work as usual" do
+    assert_match 'images/logo.png', image_tag('logo.png')
+  end
+  
+  test "possessive should add localized 's" do
+    I18n.backend = I18n::Backend::KeyValue.new({})
+    I18n.backend.store_translations :en, :i18n_toolbox => {:possessive => "%{owner}'s %{thing}", :possessive_s => "%{owner}' %{thing}"}
+    I18n.backend.store_translations :ja, :i18n_toolbox => {:possessive => "%{owner}の%{thing}"}
+    I18n.backend.store_translations :fr, :i18n_toolbox => {:possessive => "%{thing} de %{owner}"}
+    
+    assert_nil possessive(nil,nil)
+    I18n.locale = :en
+    assert_equal "Bob's house", possessive('Bob','house')
+    assert_equal "Miles' house", possessive('Miles','house')
+    I18n.locale = :ja
+    assert_equal "Bobの家", possessive('Bob','家')
+    assert_equal "Milesの家", possessive('Miles','家')
+    I18n.locale = :fr
+    assert_equal "La maison de Bob", possessive('Bob','La maison')
+    assert_equal "La maison de Miles", possessive('Miles','La maison')
+  end
+  
+  test "truncate should respect different lengths for different locales" do
+    I18n.backend = I18n::Backend::KeyValue.new({})
+    I18n.backend.store_translations :en, :i18n_toolbox => {:character_ratio => 1}
+    I18n.backend.store_translations :ja, :i18n_toolbox => {:character_ratio => 0.5}
+    
+    I18n.locale = :en
+    assert_equal 'Top Gun is one of the best ...', truncate('Top Gun is one of the best movies ever made', :localize => true)
+    I18n.locale = :ja
+    assert_equal "トップガンは今まで見た映画の中でも特に印象に残るものの...", truncate('トップガンは今まで見た映画の中でも特に印象に残るものの一つです')
+    assert_equal "トップガンは今まで見た映...", truncate('トップガンは今まで見た映画の中でも特に印象に残るものの一つです', :localize => true)
+    I18n.locale = :da
+    assert_equal 'Top Gun is one of the best ...', truncate('Top Gun is one of the best movies ever made', :localize => true)
+  end
+end

data/test/rails_app/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/test/rails_app/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/rails_app/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/rails_app/app/models/post.rb

@@ -0,0 +1,2 @@
+class Post < ActiveRecord::Base
+end

data/test/rails_app/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/rails_app/config/application.rb

@@ -0,0 +1,44 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end

data/test/rails_app/config/boot.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+gemfile = File.expand_path('../../../../Gemfile', __FILE__)
+
+if File.exist?(gemfile)
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+end
+
+$:.unshift File.expand_path('../../../../lib', __FILE__)

data/test/rails_app/config/database.yml

@@ -0,0 +1,18 @@
+# SQLite version 3.x
+#   gem install sqlite3
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: ":memory:"
+
+production:
+  adapter: sqlite3
+  database: ":memory:"

data/test/rails_app/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+# Initialize the rails application
+Dummy::Application.initialize!

data/test/rails_app/config/environments/development.rb

@@ -0,0 +1,26 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+

data/test/rails_app/config/environments/production.rb

@@ -0,0 +1,49 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Specifies the header that your server uses for sending files
+  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+  # For nginx:
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+
+  # If you have no front-end server that supports something like X-Sendfile,
+  # just comment this out and Rails will serve the files
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end