gettext 1.1.1 → 1.2.0

data/lib/gettext/locale_win32.rb

@@ -1,55 +1,79 @@
 =begin
-  locale_win32.rb - Locale module for win32.
+  locale_win32.rb
 
-  Copyright (C) 2002,2003  Masao Mutoh <mutoh@highway.ne.jp>
+  Copyright (C) 2002-2006  Masao Mutoh <mutoh@highway.ne.jp>
 
   You may redistribute it and/or modify it under the same
   license terms as Ruby.
 
-  $Id: locale_win32.rb,v 1.4 2005/12/29 07:02:52 mutoh Exp $
+  $Id: locale_win32.rb,v 1.12 2006/02/20 16:12:05 mutoh Exp $
 =end
 
 require 'gettext/locale_table_win32'
 
-module Locale
-  @@locale_win32 = {}
-  def __get(lctype = Locale::CTYPE)
-    ret = nil
-    if @@locale_win32[lctype] 
-      ret = @@locale_win32[lctype]
-    else
-      ["LC_ALL", "LC_MESSAGES", "LANG"].each do |env|
-	ret = ENV[env]
-	break if ret
+module Locale #:nodoc:
+  # Locale::SystemWin32 module for win32.
+  module SystemWin32
+    extend Locale::System
+
+    @@default_locale = Locale::Object.new("en", nil, "CP1252")
+
+    module_function
+    # Gets the charset of the locale. ENV(LC_ALL > LC_CTYPE > LC_MESSAGES > LANG) > 
+    # the default locale from GetUserDefaultLangID.
+    # * locale: Locale::Object
+    # * Returns the charset of the locale
+    def get_charset(locale)
+      loc = LocaleTable.find{|v| v[1] == locale.to_win}
+      loc ? loc[2] : "CP1252"
+    end
+
+    # Gets the system locale.
+    # * Returns the system locale (Locale::Object)
+    def system
+      lang = nil
+      ["LC_ALL", "LC_CTYPE", "LC_MESSAGES", "LANG"].each do |env|
+	lang = ENV[env]
+	if lang
+	  ret = Locale::Object.new(lang)
+	  ret.charset = get_charset(ret)
+	  break
+	end
       end
-      unless ret
-	pri_id, sub_id = __locale_id
-	lang = LocaleTable.assoc(pri_id)
-	if lang.size == 3
-	  lang = lang[2].assoc(sub_id)
+      unless lang
+	lang = LocaleTable.assoc(locale_id)
+	if lang
+	  ret = Locale::Object.new(lang[1], nil, lang[2])
+	else
+	  ret = @@default_locale
 	end
-	ret = lang ? lang[1] : "C"
       end
-      @@locale_win32[lctype] = ret
+      ret
     end
-    ret
-  end
 
-  def set(lctype, loc)
-    if lctype == ALL
-      @@locale_win32[lctype] = loc
+    # Sets a default locale. en.UTF-8 is the default value if not set.
+    # * locale: Locale::Object object. You can't set nil.
+    # * Returns: self
+    def set_default_locale(locale)
+      raise "Wrong parameter: #{locale}" if locale.nil?
+      @@default_locale = locale
+      self
+    end
+    
+    # Sets a default locale. en.UTF-8 is the default value if not set.
+    # * locale: Locale::Object
+    # * Returns: locale 
+    def default_locale=(locale)
+      set_default_locale(locale)
+      locale
     end
-  end
 
-  unless defined? CTYPE
-    CTYPE = 0
-    NUMERIC = 1
-    TIME = 2
-    COLLATE = 3
-    MONETARY = 4
-    MESSAGES = 5
-    ALL = 6
+    # Gets the default Locale::Object. 
+    # * Returns: the default locale
+    def default_locale
+      @@default_locale
+    end
   end
-  module_function :__get
+  @@locale_system_module = SystemWin32
 end
 

data/lib/gettext/mo.rb

@@ -12,12 +12,12 @@
     of Ruby.  License of Ruby is included with Ruby distribution in
     the file "README".
 
-    $Id: mo.rb,v 1.2 2005/10/22 10:49:59 mutoh Exp $
+    $Id: mo.rb,v 1.3 2006/02/23 14:53:59 mutoh Exp $
 =end
 
 require 'gettext/iconv'
 
-class MOFile < Hash
+class MOFile < Hash #:nodoc:
   class InvalidFormat < RuntimeError; end;
 
   Header = Struct.new(:magic,

data/lib/gettext/parser/activerecord.rb

@@ -7,7 +7,7 @@
   You may redistribute it and/or modify it under the same
   license terms as Ruby.
 
-  $Id: activerecord.rb,v 1.5 2006/01/14 13:48:23 mutoh Exp $
+  $Id: activerecord.rb,v 1.6 2006/02/22 16:42:41 mutoh Exp $
 =end
 
 require 'gettext'
@@ -31,7 +31,7 @@ module GetText
     @ar_re = nil
 
     module_function
-    def require_rails(file)
+    def require_rails(file) # :nodoc:
       begin
 	require file
       rescue MissingSourceFile
@@ -39,6 +39,16 @@ module GetText
       end
     end
 
+    # Sets some preferences to parse ActiveRecord files.
+    #
+    # * config: a Hash of the config. It can takes some values below:
+    #   * :use_classname: If true, the msgids of ActiveRecord become "ClassName|FieldName" (e.g. "Article|Title"). Otherwise the ClassName is not used (e.g. "Title"). Default is true.
+    #   * :db_yml: the path of database.yml. Default is "config/database.yml".
+    #   * :db_mode: the mode of the database. Default is "development"
+    #   * :activerecord_classes: an Array of the superclass of the models. The classes should be String value. Default is ["ActiveRecord::Base"]
+    #
+    # "ClassName|FieldName" uses GetText.sgettext. So you don't need to translate the left-side of "|". 
+    # See <Documents for Translators for more details(http://www.yotabanana.com/hiki/ruby-gettext-translate.html)>.
     def init(config)
       if config
 	config.each{|k, v|
@@ -48,7 +58,7 @@ module GetText
       @ar_re = /class.*(#{@config[:activerecord_classes].join("|")})/
     end
 
-    def parse(file, targets = [])
+    def parse(file, targets = []) # :nodoc:
       old_constants = constants
       begin
         eval(open(file).read)
@@ -83,7 +93,7 @@ module GetText
       targets
     end
 
-    def target?(file)
+    def target?(file) # :nodoc:
       init(nil) unless @ar_re
       data = IO.readlines(file)
       data.each do |v|
@@ -91,7 +101,11 @@ module GetText
 	  unless @db
 	    require 'rubygems'
 	    require 'active_record'
-	    yml = YAML.load(ERB.new(IO.read(@config[:db_yml])).result)
+	    begin
+	      yml = YAML.load(ERB.new(IO.read(@config[:db_yml])).result)
+	    rescue
+	      return false
+	    end
 	    ENV["RAILS_ENV"] = @config[:db_mode]
 	    require_rails 'config/boot.rb'
 	    require_rails 'config/environment.rb'

data/lib/gettext/parser/erb.rb

@@ -6,7 +6,7 @@
   You may redistribute it and/or modify it under the same
   license terms as Ruby.
 
-  $Id: erb.rb,v 1.3 2006/01/07 13:39:13 mutoh Exp $
+  $Id: erb.rb,v 1.4 2006/02/22 16:42:41 mutoh Exp $
 =end
 
 require 'erb'
@@ -19,18 +19,21 @@ module GetText
     }
 
     module_function
+    # Sets some preferences to parse ERB files.
+    # * config: a Hash of the config. It can takes some values below:
+    #   * :extnames: An Array of target files extension. Default is [".rhtml"].
     def init(config)
       config.each{|k, v|
 	@config[k] = v
       }
     end
 
-    def parse(file, targets = [])
+    def parse(file, targets = []) # :nodoc:
       erb = ERB.new(IO.readlines(file).join).src.split(/$/)
       RubyParser.parse_lines(file, erb, targets)
     end
 
-    def target?(file)
+    def target?(file) # :nodoc:
       @config[:extnames].each do |v|
 	return true if File.extname(file) == v
       end

data/lib/gettext/parser/glade.rb

@@ -6,7 +6,7 @@
   You may redistribute it and/or modify it under the same
   license terms as Ruby.
 
-  $Id: glade.rb,v 1.3 2006/01/07 13:39:13 mutoh Exp $
+  $Id: glade.rb,v 1.4 2006/02/22 16:42:41 mutoh Exp $
 =end
 
 require 'cgi'
@@ -21,13 +21,13 @@ module GetText
     TARGET2 = /(.*)<\/property>/
 
     module_function
-    def parse(file, targets = [])
+    def parse(file, targets = []) # :nodoc: 
       lines = IO.readlines(file)
       parse_lines(file, lines, targets)
     end
 
     #from ary of lines.
-    def parse_lines(file, lines, targets)
+    def parse_lines(file, lines, targets) # :nodoc:
       cnt = 0
       target = false
       line_no = 0
@@ -65,7 +65,7 @@ module GetText
     XML_RE = /<\?xml/ 
     GLADE_RE = /glade-2.0.dtd/
  
-    def target?(file)
+    def target?(file) # :nodoc:
       data = IO.readlines(file)
       if XML_RE =~ data[0]
 	if GLADE_RE =~ data[1]
@@ -81,7 +81,7 @@ module GetText
       end
     end
 
-    def add_target(val, file, line_no, targets)
+    def add_target(val, file, line_no, targets) # :nodoc:
       return unless val.size > 0
       assoc_data = targets.assoc(val)
       val = CGI.unescapeHTML(val)

data/lib/gettext/parser/ruby.rb

@@ -9,13 +9,13 @@
   You may redistribute it and/or modify it under the same
   license terms as Ruby.
 
-  $Id: ruby.rb,v 1.4 2005/12/17 07:12:40 mutoh Exp $
+  $Id: ruby.rb,v 1.6 2006/02/22 16:42:41 mutoh Exp $
 =end
 
 require 'irb/ruby-lex.rb'
 require 'stringio'
 
-class RubyLexX < RubyLex
+class RubyLexX < RubyLex  # :nodoc: all
   
   def initialize
     super
@@ -124,15 +124,15 @@ end
 module GetText
   module RubyParser
     ID = ['gettext', '_', 'N_', 'sgettext', 's_']
-    PLURAL_ID = ['ngettext', 'n_']
+    PLURAL_ID = ['ngettext', 'n_', 'Nn_']
 
     module_function
-    def parse(file, targets = [])
+    def parse(file, targets = [])  # :nodoc:
       lines = IO.readlines(file)
       parse_lines(file, lines, targets)
     end
 
-    def parse_lines(file_name, lines, targets)
+    def parse_lines(file_name, lines, targets)  # :nodoc:
       file = StringIO.new(lines.join + "\n")
       rl = RubyLexX.new
       rl.set_input(file)
@@ -188,7 +188,7 @@ module GetText
       targets
     end
 
-    def target?(file)
+    def target?(file)  # :nodoc:
       true # always true, as default parser.
     end
     

data/lib/gettext/poparser.rb

@@ -20,7 +20,7 @@ module GetText
 
   class PoParser < Racc::Parser
 
-module_eval <<'..end src/poparser.ry modeval..id827ea1cb71', 'src/poparser.ry', 90
+module_eval <<'..end src/poparser.ry modeval..ida44e3c5e28', 'src/poparser.ry', 90
   include GetText
   GetText.bindtextdomain("rgettext")
 
@@ -32,10 +32,11 @@ module_eval <<'..end src/poparser.ry modeval..id827ea1cb71', 'src/poparser.ry',
     ret
   end
   
-  def parse(str, data)
+  def parse(str, data, ignore_fuzzy = true)
     @comments = []
     @data = data
     @fuzzy = false
+    $ignore_fuzzy = ignore_fuzzy
     str.strip!
     @q = []
     until str.empty? do
@@ -92,7 +93,7 @@ module_eval <<'..end src/poparser.ry modeval..id827ea1cb71', 'src/poparser.ry',
 
   def on_message(msgid, msgstr)
     @data[msgid] = msgstr
-    
+ 
     @data.set_comment(msgid, @comments.join("\n"))
     @comments.clear
   end
@@ -102,7 +103,7 @@ module_eval <<'..end src/poparser.ry modeval..id827ea1cb71', 'src/poparser.ry',
     @comments << comment
   end 
 
-..end src/poparser.ry modeval..id827ea1cb71
+..end src/poparser.ry modeval..ida44e3c5e28
 
 ##### racc 1.4.4 generates ###
 
@@ -217,7 +218,7 @@ Racc_debug_parser = true
 
 module_eval <<'.,.,', 'src/poparser.ry', 36
   def _reduce_4( val, _values, result )
-    if @fuzzy
+    if @fuzzy and $ignore_fuzzy 
       if val[1] != ""
         $stderr.print _("Warning: fuzzy message was ignored.\n")
         $stderr.print "         msgid '#{val[1]}'\n"
@@ -235,7 +236,7 @@ module_eval <<'.,.,', 'src/poparser.ry', 36
 
 module_eval <<'.,.,', 'src/poparser.ry', 51
   def _reduce_5( val, _values, result )
-    if @fuzzy
+    if @fuzzy and $ignore_fuzzy
       if val[1] != ""
         $stderr.print _("Warning: fuzzy message was ignored.\n")
         $stderr.print "msgid = '#{val[1]}\n"

data/lib/gettext/rails.rb

@@ -1,28 +1,53 @@
 =begin
   gettext/rails.rb - GetText for "Ruby on Rails"
 
-  Copyright (C) 2005  Masao Mutoh
+  Copyright (C) 2005,2006  Masao Mutoh
 
   You may redistribute it and/or modify it under the same
   license terms as Ruby.
 
-  $Id: rails.rb,v 1.12 2006/01/14 13:48:22 mutoh Exp $
+  $Id: rails.rb,v 1.17 2006/02/23 14:53:59 mutoh Exp $
 =end
 
-require 'gettext'
 require 'gettext/cgi'
 require 'active_record'
 require 'active_support'
 
-module GetText
+module GetText #:nodoc:
+  # = GetText for Ruby on Rails
+  # GetText::Rails supports Ruby on Rails.
+  # You add only 2 lines in your controller, all of the controller/view/models are
+  # targeted the textdomain. 
+  #
+  # See <Ruby-GetText-Package HOWTO for Ruby on Rails (http://www.yotabanana.com/hiki/ruby-gettext-howto-rails.html>.
   module Rails
     include GetText
+    extend GetText
 
-    Rails = ::Rails
+    Rails = ::Rails  #:nodoc:
 
-    alias :_bindtextdomain :bindtextdomain
+    alias :_bindtextdomain :bindtextdomain #:nodoc:
 
+    # Bind a textdomain(#{path}/#{locale}/LC_MESSAGES/#{domainname}.mo) to your program. 
+    # Notes the textdomain scope becomes all of the controllers/views/models in your app. 
+    # This is different from normal GetText.bindtextomain.
+    #
+    # Usually, you don't call this directly in your rails application.
+    # Call init_gettext in ActionController::Base instead.
+    #
+    # On the other hand, you need to call this in helpers/plugins.
+    #
+    # * domainname: the textdomain name.
+    # * locale: the locale value such as "ja-JP". When the value is nil, 
+    # * charset: the charset. Generally UTF-8 is recommanded.
+    # * with_model: false if you want to ignore model support.
+    #
+    # locale is searched the order by this value > "lang" value of QUERY_STRING > 
+    # "lang" value of Cookie > HTTP_ACCEPT_LANGUAGE value > Default locale(en). 
+    # And the charset is set order by "the argument of bindtextdomain" > HTTP_ACCEPT_CHARSET > Default charset(UTF-8).
+    #
     def bindtextdomain(domainname, _cgi = nil, locale = nil, charset = nil, with_model = true)
+      Locale.clear  # IMPORTANT! current locale should be nil once(default is used).
       set_cgi(_cgi) if _cgi
       @gettext_container_domainname = domainname
       path = File.join(RAILS_ROOT, "locale")
@@ -31,20 +56,20 @@ module GetText
       bindtextdomain_to(ActiveRecord::Base, domainname) if with_model
     end
 
-    def bindtextdomain_to(klass, domainname)
+    def bindtextdomain_to(klass, domainname) #:nodoc:
       klass.class_eval {
 	textdomain(domainname)
 
-	def self.human_attribute_name(attribute_key_name)
+	def self.human_attribute_name(attribute_key_name) #:nodoc:
 	  s_("#{self}|#{attribute_key_name.humanize}")
 	end
-	def self.human_attribute_table_name_for_error(table_name)
+	def self.human_attribute_table_name_for_error(table_name) #:nodoc:
 	  _(table_name.gsub(/_/, " "))
 	end
       }
     end
 
-    def callersrc
+    def callersrc  #:nodoc:
       @gettext_container_domainname = nil unless defined? @gettext_container_domainname
       @gettext_container_domainname
     end
@@ -52,7 +77,7 @@ module GetText
 end
 
 
-module ActionController
+module ActionController #:nodoc:
   class Base
     helper GetText::Rails
     include GetText::Rails
@@ -62,13 +87,22 @@ module ActionController
     @@gettext_content_type = nil
 
     prepend_before_filter :init_gettext
-
-    def init_gettext_main
+    after_filter :init_content_type
+    
+    def init_gettext_main #:nodoc:
       bindtextdomain(@@gettext_domainname, request.cgi)  #You need to pass CGI object first.
-      @headers["Content-Type"] = "#{@@gettext_content_type}; charset=#{GetText.output_charset}"
     end
 
-    def init_gettext
+    def init_content_type #:nodoc:
+      if @headers["Content-Type"] and /javascript/ =~ @headers["Content-Type"]
+	@headers["Content-Type"] = "text/javascript; charset=#{GetText.output_charset}"
+      elsif ! @headers["Content-Type"]
+	@headers["Content-Type"] = "#{@@gettext_content_type}; charset=#{GetText.output_charset}"
+      end
+    end
+
+
+    def init_gettext # :nodoc:
       init_gettext_main if @@gettext_domainname
       ActiveRecord::Errors.class_eval{
 	# You need to call bindtextdomain here because ActiveRecord::Errors doesn't know
@@ -77,6 +111,21 @@ module ActionController
       }
     end
     
+    # Bind a 'textdomain' to all of the controllers/views/models. Call this instead of GetText.bindtextdomain.
+    # * textdomain: the textdomain
+    # * charset: the output charset. Default is "UTF-8"
+    # * content_type: the content type. Default is "text/html"
+    #
+    # If you want to separate the textdomain each controllers, you need to call this function in the each controllers.
+    #
+    # app/controller/blog_controller.rb:
+    #  require 'gettext/rails'
+    #  
+    #  class BlogController < ApplicationController
+    #    init_gettext "blog"
+    #      :
+    #      :
+    #    end
     def self.init_gettext(domainname, charset = "UTF-8", content_type = "text/html")
       GetText.output_charset = charset
       @@gettext_domainname = domainname
@@ -84,7 +133,7 @@ module ActionController
     end
   end
 
-  class TestRequest < AbstractRequest 
+  class TestRequest < AbstractRequest  #:nodoc:
     @cgi = nil
     def cgi
       @cgi = CGI.new unless @cgi
@@ -93,18 +142,38 @@ module ActionController
   end
 end
 
-module ActiveRecord
+module ActiveRecord #:nodoc:
   class Base
-    include GetText::Rails
-    extend GetText::Rails
-  end
+    include GetText::Rails  # Important
+    extend GetText::Rails   # Important
+
+    @@error_message_title = nil
+    @@error_message_explanation = nil
+    
+    # Sets a your own title of error message dialog.
+    def self.set_error_message_title(single_msg, plural_msg)
+      @@error_message_title = [single_msg, plural_msg]
+    end
+    
+    # Sets a your own explanation of the error message dialog.
+    def self.set_error_message_explanation(single_msg, plural_msg)
+      @@error_message_explanation = [single_msg, plural_msg]
+    end
 
-  class Errors
+    def error_message_title #:nodoc:
+      @@error_message_title
+    end
+    def error_message_explanation #:nodoc:
+      @@error_message_explanation
+    end
+  end
+  
+  class Errors #:nodoc:
     include GetText
     extend GetText
     
-    RE_FIELD_NAME = /%\{fn\}/
-
+    RE_FIELD_NAME = /%\{fn\}/  #:nodoc:
+    
     # You need to define this here, because this values will be updated by application.
     default_error_messages.update(
 				  :inclusion => N_("%{fn} is not included in the list"),
@@ -120,22 +189,20 @@ module ActiveRecord
 				  :taken => N_("%{fn} has already been taken"),
 				  :not_a_number => N_("%{fn} is not a number")
 				  )
-
     @@default_error_messages_d = {
       :too_long => default_error_messages[:too_long],
       :too_short => default_error_messages[:too_short],
       :wrong_length => default_error_messages[:wrong_length]
     }
 
-    def self.convert_validates_messages_of_validates_length_of
+    def self.convert_validates_messages_of_validates_length_of #:nodoc:
       default_error_messages[:too_long] = _(@@default_error_messages_d[:too_long])
       default_error_messages[:too_short] = _(@@default_error_messages_d[:too_short])
       default_error_messages[:wrong_length] = _(@@default_error_messages_d[:wrong_length])      
     end
 
-    def full_messages
+    def full_messages #:nodoc:
       full_messages = []
-
       @errors.each_key do |attr|
 	@errors[attr].each do |msg|
 	  next if msg.nil?
@@ -152,8 +219,8 @@ module ActiveRecord
     end
   end
 
-  module Validations
-    module ClassMethods
+  module Validations #:nodoc:
+    module ClassMethods #:nodoc:
       alias :_validates_length_of :validates_length_of
       def validates_length_of(*attrs)
 	ActiveRecord::Errors.convert_validates_messages_of_validates_length_of
@@ -164,33 +231,44 @@ module ActiveRecord
 end
 
 
-module ActionView
-  module Helpers
-    module ActiveRecordHelper
+module ActionView #:nodoc:
+  module Helpers  #:nodoc:
+    module ActiveRecordHelper #:nodoc: all
       module L10n
 	# Separate namespace for textdomain
 	include GetText
 	extend GetText
+
+	@error_message_title = Nn_("%{num} error prohibited this %{record} from being saved", 
+				   "%{num} errors prohibited this %{record} from being saved")
+	@error_message_explanation = Nn_("There was a problem with the following field:", 
+					 "There were problems with the following fields:")
+
 	module_function
+	def render_error_message(object, klass, record, count, options)
+	  message_title = object.error_message_title || @error_message_title
+	  message_explanation = object.error_message_explanation || @error_message_explanation
+	  
+	  klass.content_tag("div",
+			    klass.content_tag(
+					      options[:header_tag] || "h2",
+					      n_(message_title, count) % {:num => count, :record => record}
+					      ) +
+			    klass.content_tag("p", n_(message_explanation, count) % {:num => count}) +
+			    klass.content_tag("ul", object.errors.full_messages.collect { |msg| klass.content_tag("li", msg) }),
+			    "id" => options[:id] || "errorExplanation", "class" => options[:class] || "errorExplanation"
+			    )
+	end
+
 	def error_messages_for(object, object_name, klass, options = {})
 	  textdomain("rails")
 
 	  options = options.symbolize_keys
-  
+
 	  unless object.errors.empty?
 	    count = object.errors.count
 	    record = ActiveRecord::Base.human_attribute_table_name_for_error(object_name)
-	    klass.content_tag("div",
-			klass.content_tag(
-				    options[:header_tag] || "h2",
-					  n_("%{num} error prohibited this %{record} from being saved", 
-					     "%{num} errors prohibited this %{record} from being saved", count) %
-					  {:num => count, :record => record}) +
-			klass.content_tag("p", n_("There were problems with the following field:", 
-					    "There were problems with the following fields:", count)) +
-			klass.content_tag("ul", object.errors.full_messages.collect { |msg| klass.content_tag("li", msg) }),
-			"id" => options[:id] || "errorExplanation", "class" => options[:class] || "errorExplanation"
-			)
+	    render_error_message(object, klass, record, count, options)
 	  end
 	end
       end