gettext 1.1.1 → 1.2.0

data/lib/gettext/erb.rb

@@ -1,26 +1,54 @@
 =begin
   gettext/erb.rb - GetText for ERB
 
-  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: erb.rb,v 1.1.1.1 2005/08/13 02:38:09 mutoh Exp $
+  $Id: erb.rb,v 1.2 2006/02/23 14:53:59 mutoh Exp $
 =end
 
 require 'erb'
 require 'gettext/container'
 
 module GetText
+
+  # This module provides basic functions to evaluate plural ERB files(.rhtml) in a TextDomain.
+  # You need to implement a class which includes GetText::ErbContainer.
+  #
+  # See simple examples below:
+  #
+  #  require 'gettext/erb'
+  #  class SimpleContainer
+  #    include GetText::ErbContainer
+  #     
+  #    def initialize(domainname, domainpath = nil, locale = nil, charset = nil)
+  #      bindtextdomain(domainname, domainpath, locale)
+  #    end
+  #  end
+  #  
+  #  container = SimpleContainer.new("helloerb1", "locale")
+  #  puts container.eval_file("/your/erb/file.rhtml")
+  #
+  # This module is an example for template engines such as ERB. 
+  # You can implement another implementation easily to read gettext/erb.rb.
   module ErbContainer
     include Container
 
+    # Evaluates ERB source(String) in the instance and returns the result HTML.
+    #
+    # * rhtml: an ERB source
+    # * Returns: the Evaluated ERB result
     def eval_src(rhtml)
       erb = ERB.new(rhtml).src
       eval(erb, binding)
     end
 
+    # Evaluates ERB file in the instance and returns the result HTML.
+    #
+    # * rhtml: an ERB file
+    # * Returns: the Evaluated ERB result
     def eval_file(rhtmlpath)
       eval_src(IO.read(rhtmlpath))
     end

data/lib/gettext/iconv.rb

@@ -9,20 +9,30 @@
   You may redistribute it and/or modify it under the same
   license terms as Ruby.
 
-  $Id: iconv.rb,v 1.1.1.1 2005/08/13 02:38:09 mutoh Exp $
+  $Id: iconv.rb,v 1.2 2006/02/22 16:42:41 mutoh Exp $
 =end
+
 begin
   require 'iconv.so'
 rescue LoadError
   begin
     require 'glib2'
+    # = Pseudo Iconv module
+    # 
+    # Provides Iconv.iconv which uses Ruby/GLib(1) functions. This library also required from 'gettext'.
+    # If you require 'gettext/iconv', Iconv.iconv try to call Ruby/GLib function 
+    # when it doesn't find original Iconv module(iconv.so).
+    #
+    # (1) Ruby/GLib is a module which is provided from Ruby-GNOME2 Project. 
+    # You can get binaries for Win32(One-Click Ruby Installer).
+    # <URL: http://ruby-gnome2.sourceforge.jp/>
     module Iconv
       module Failure; end
       class InvalidEncoding < ArgumentError;  include Failure; end
       class IllegalSequence < ArgumentError;  include Failure; end
       class InvalidCharacter < ArgumentError; include Failure; end
 
-      def check_glib_version?(major, minor, micro)
+      def check_glib_version?(major, minor, micro) # :nodoc:
         (GLib::BINDING_VERSION[0] > major ||
          (GLib::BINDING_VERSION[0] == major && 
           GLib::BINDING_VERSION[1] > minor) ||
@@ -33,6 +43,11 @@ rescue LoadError
       module_function :check_glib_version?
 
       if check_glib_version?(0, 11, 0)
+	# This is a function equivalent of Iconv.iconv.
+	# * to: encoding name for destination
+	# * from: encoding name for source
+	# * str: strings to be converted
+	# * Returns: Returns an Array of converted strings.
         def iconv(to, from, str)
           begin
             GLib.convert(str, to, from).split(//)
@@ -48,7 +63,7 @@ rescue LoadError
           end
         end
       else
-       def iconv(to, from, str)
+       def iconv(to, from, str) # :nodoc:
          begin
            GLib.convert(str, to, from).split(//)
          rescue
@@ -61,7 +76,7 @@ rescue LoadError
   rescue LoadError
     module Iconv
       module_function
-      def iconv(to, from, str)
+      def iconv(to, from, str) # :nodoc:
         warn "Iconv was not found." if $DEBUG
         str.split(//)
       end

data/lib/gettext/locale.rb

@@ -6,56 +6,205 @@
   You may redistribute it and/or modify it under the same
   license terms as Ruby.
 
-  $Id: locale.rb,v 1.4 2005/09/04 17:47:54 mutoh Exp $
+  $Id: locale.rb,v 1.9 2006/02/20 12:35:06 mutoh Exp $
 =end
 
+require 'gettext/locale_object'
+
 begin
-  require 'gettext/_locale'
+  require 'locale_system'
 rescue LoadError
-  # For rubygems
-  begin
-    require '_locale'
-  rescue LoadError
-    # This is used for installation process(from rake only)
-    module Locale
-      CTYPE = 0
-      NUMERIC = 1
-      TIME = 2
-      COLLATE = 3
-      MONETARY = 4
-      MESSAGES = 5
-      ALL = 6
-
-      module_function
-      def codeset; "UTF-8"; end
-      def set(lc, val);	"C"; end
-      def __locale_id; [0x00, 0x00]; end
-    end
+  # This is used for installation process(from rake only)
+  # And deprecated these constants.
+  module Locale
+    # Deprecated.
+    CTYPE = 0
+    # Deprecated.
+    NUMERIC = 1
+    # Deprecated.
+    TIME = 2
+    # Deprecated.
+    COLLATE = 3
+    # Deprecated.
+    MONETARY = 4
+    # Deprecated.
+    MESSAGES = 5
+    # Deprecated.
+    ALL = 6
   end
 end
 
-if /cygwin|mingw|mswin32|bccwin32/ =~ RUBY_PLATFORM
+if /cygwin|mingw|win32/ =~ RUBY_PLATFORM
   require 'gettext/locale_win32'
 else
-  require 'gettext/locale_default'
+  require 'gettext/locale_posix'
 end
 
+# Locale module manages the locale informations of the application.
 module Locale
-  def get(lctype = Locale::CTYPE)
-    __get(lctype)
-  end
-  
-  alias :setlocale :set
-  alias :charset :codeset
-  
-  module_function :get, :setlocale, :charset
-end
+  unless defined? CTYPE
+    CTYPE = 0    #:nodoc:
+    NUMERIC = 1  #:nodoc:
+    TIME = 2     #:nodoc:
+    COLLATE = 3  #:nodoc:
+    MONETARY = 4 #:nodoc:
+    MESSAGES = 5 #:nodoc:
+    ALL = 6      #:nodoc:
+  end
+
+  @@default = nil
+  @@current = nil
+
+  module_function
+  # Sets the default locale (Locale::Object).
+  #
+  # * locale: the default locale
+  # * Returns: self.
+  def set_default(locale)
+    @@default = locale
+    if @@default
+      @@default.charset ||= @@locale_system_module.get_charset(locale)
+    end
+    self
+  end
+  # Same as Locale.set_default.
+  #
+  # * locale: the default locale (Locale::Object).
+  # * Returns: locale.
+  def default=(locale)
+    set_default(locale)
+    @@default
+  end
+
+  # Gets the system locale.
+  # * Returns: the system locale (Locale::Object).
+  def system
+    @@locale_system_module.system
+  end
+
+  # Gets the default locale.
+  #
+  # If the default locale not set, this returns system locale.
+  # * Returns: the default locale (Locale::Object).
+  def default
+    @@default = system unless @@default
+    @@default
+  end
+
+  # Gets the current locale (Locale::Object).
+  #
+  # If the current locale is not set, this returns default locale. 
+  # * Returns: the current locale (Locale::Object).
+  def current
+    @@current = default unless @@current
+    @@current
+  end
+
+  # Sets a locale as the current locale.
+  #
+  # This returns the current Locale::Object.
+  # * lang: Locale::Object or locale name(String), or language name.
+  # * country: the country code(String)
+  # * charset: the charset(override the charset even if the locale name has charset).
+  # * Returns: self
+  #
+  #    Locale.set_current("ja_JP.eucJP")
+  #    Locale.set_current("ja", "JP")
+  #    Locale.set_current("ja", "JP", "eucJP")
+  #    Locale.set_current("ja", nil, "eucJP")
+  #    Locale.set_current(Locale::Object.new("ja", "JP", "eucJP"))
+  def set_current(lang, country = nil, charset = nil)
+    if lang == nil
+      @@current = nil
+    else
+      if lang.kind_of? Locale::Object
+	@@current = lang
+      else
+	@@current = Locale::Object.new(lang, country, charset)
+      end
+      @@current.charset ||= @@locale_system_module.get_charset(@@current)
+    end
+    self
+  end
+
+  # Sets a current locale. This is a single argument version of Locale.set_current.
+  #
+  # * lang: the Locale::Object
+  # * Returns: the current locale (Locale::Object).
+  #
+  #    Locale.current = "ja_JP.eucJP"
+  #    Locale.current = Locale::Object.new("ja", "JP", "eucJP")
+  def current=(lang)
+    set_current(lang)
+    @@current
+  end
+
+  # call-seq:
+  #   set(lang)
+  #   set(lang, country = nil, charset = nil)
+  #
+  # Sets a default locale. This function is an alias of Locale.set_default.
+  #
+  # *Notice*: Locale.set(lctype, locale) is deprecated.
+  def set(lang, country = nil, charset = nil)
+    if lang.kind_of? Numeric
+      warn "Locale.set(lctype, locale) is deprecated. Use Locale.set(locale) instead." 
+      # Locale.set(Locale::CTYPE, "ja_JP.eucJP") "country" means locale.
+      lang = country
+      country = nil
+      charset = nil
+    end
 
-if __FILE__ == $0
-  p Locale.set(Locale::CTYPE, "")
-  p Locale.set(Locale::CTYPE, nil)
-  p Locale.set(Locale::CTYPE, "ja_JP.eucJP")
-  p Locale.set(Locale::MESSAGES, nil)
-  p Locale.get
-  p Locale.codeset
+    if lang
+      set_default(Locale::Object.new(lang, country, charset))
+    else
+      set_default(nil)
+    end
+    @@default
+  end
+
+  # call-seq:
+  #   current
+  #   get
+  #   get(lctype = nil)  (Deprecated)
+  #
+  # * Returns: the current locale (Locale::Object).
+  #
+  # *Notice*: lctype is deprecated. Use this with no parameter instead.
+  def get(lctype = nil)
+    warn "Locale.get(lctype) is deprecated. Use Locale.get (noparam) instead." if lctype
+    @@current = default unless @@current
+    @@current
+  end
+
+  # *Deprecated*. Use Locale.set or Locale.set_current instead.
+  def setlocale(lctype, loc)
+    warn "Deprecated. Use Locale#set instead."
+    set(lctype, loc)
+  end
+
+  # Same as charset. Gets the charset of the current locale.
+  # * Returns: the charset of the current locale (String)
+  def codeset
+    current.charset
+  end
+
+  # Gets the charset of the current locale.
+  # * Returns: the charset of the current locale (String)
+  def charset
+    codeset
+  end 
+  # Same as codeset. Returns the charset of the current locale. 
+  # * Returns: the charset of the current locale (String)
+  def current_charset
+    codeset
+  end
+
+  # Clear default/current locale.
+  # * Returns: self
+  def clear
+    set(nil)
+    set_current(nil)
+    self
+  end
 end

data/lib/gettext/locale_cgi.rb

@@ -0,0 +1,102 @@
+=begin
+  locale_cgi.rb 
+
+  Copyright (C) 2002-2006  Masao Mutoh
+
+  You may redistribute it and/or modify it under the same
+  license terms as Ruby.
+
+  $Id: locale_cgi.rb,v 1.1 2006/02/20 12:35:06 mutoh Exp $
+=end
+
+
+module Locale # :nodoc:
+  # Locale::System module for Default OS (Unix)
+  # This is low-level class. Application shouldn't use this directly.
+  module SystemCGI
+    @@default_locale = Locale::Object.new("en", nil, "UTF-8")
+    @@cgi = nil
+
+    module_function
+    # Gets the default locale using setlocale and nl_langinfo. 
+    # * Returns the system locale (Locale::Object).
+    def system
+      cgi_ = cgi
+      if ret = cgi_["lang"] and ret.size > 0
+	$stderr.print "query_string: lang = #{ret}\n" if $DEBUG
+      elsif ret = cgi_.cookies["lang"][0]
+	$stderr.print "cookie: lang = #{ret}\n" if $DEBUG
+      elsif lang = cgi_.accept_language and lang.size > 0
+	$stderr.print "accept lanaugage: lang = #{lang}\n" if $DEBUG
+	ret = lang.split(/,|;/).first
+      else
+	ret = @@default_locale.to_str
+      end
+      
+      codesets = cgi_.accept_charset
+      if codesets and codesets.size > 0
+	ary = codesets.split(',')
+	codeset = ary[0]
+	codeset = @@default_locale.charset if codeset == "*"
+      else
+	codeset = @@default_locale.charset
+      end
+      Locale::Object.new(ret, nil, codeset)
+    end
+
+    # Gets the charset of the locale.
+    # * locale: Locale::Object
+    # * Returns: the charset of the locale
+    def get_charset(locale)
+      locale.charset ? locale.charset : @@default_locale.charset
+    end
+
+    # Sets a CGI object.
+    # * cgi_: CGI object
+    # * Returns: self
+    def set_cgi(cgi_)
+      @@cgi = cgi_
+      self
+    end
+    
+    # Sets a CGI object.
+    # * cgi_: CGI object
+    # * Returns: cgi_ 
+    def cgi=(cgi_)
+      set_cgi(cgi_)
+      cgi_
+    end
+
+    # Gets the CGI object. If it is nil, returns new CGI object.
+    # * Returns: the CGI object
+    def cgi
+      @@cgi = CGI.new unless @@cgi
+      @@cgi
+    end
+
+    # 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
+
+    # Gets the default Locale::Object. 
+    # * Returns: the default locale
+    def default_locale
+      @@default_locale
+    end
+  end
+  @@locale_system_module = SystemCGI
+end
+