locale 2.0.1 → 2.0.2

data/ChangeLog

@@ -1,3 +1,19 @@
+= locale-2.0.2 (2009-05-04)
+ * Add Locale.set_app_language_tags to restrict the target locales whole the application. [Suggested by Vladimir Dobriakov]
+ * locale/driver/cgi.rb: Add Locale.set_request.
+ * sample/rack: Add a sample for rack.
+ * Improve documents.
+ * Fix bugs
+   * Illegular -> Irregular [by Denis Defreyne]
+   * test_thread.rb doesn't work under the environment where LC_ALL is set .
+     [Reported by Hans de Graaff (Bug#24831)]
+   * Fixed Locale::Drive::CGI.charset don't work when accept_charset is nil.
+     [Reported by hallelujah (Bug#25583)]
+   * Fixed Locale::Drive::Win32.charset don't work.
+
+Thanks to:
+  Denis Defreyne, Hans de Graaff, hallelujah, Vladimir Dobriakov
+
 = locale-2.0.1 (2009-04-18)
  * Locale::Tag::Common#extensions are shown order by the keys.[reported by
  Dan Coutu]

data/README.rdoc

@@ -36,15 +36,23 @@ handle major locale ID standards.
   Download tar-ball from http://rubyforge.org/projects/locale/
   De-Compress archive and enter its top directory.
   Then type:
-  ($ su)
-  # ruby setup.rb
+   ($ su)
+   # ruby setup.rb
 
 == The simplest usage
 
  require 'rubygems'
  require 'locale'
  
- p Locale.current
+ p Locale.candidates
+
+== APIs
+The most important APIs are defined in Locale module.
+
+* Locale.candidates - Returns the current locale candidates.
+* Locale.current= - Sets the current locale(in a thread).
+* Locale.default= - Sets the default locale(in the whole program).
+* Locale.set_app_language_tags - Sets the locale that is supported by the App.
 
 == License
 This program is licenced under the same licence as Ruby.
@@ -65,13 +73,13 @@ This program is licenced under the same licence as Ruby.
 == References
 === Other libraries
 * langtag-0.1.0 
-    by Martin Dürst <http://rubyforge.org/projects/langtag/>
+  * by Martin Dürst <http://rubyforge.org/projects/langtag/>
 
 * memoizable.rb
-    from ActiveSupport-2.2.0 <http://rubyforge.org/projects/activesupport/>
+  * from ActiveSupport-2.2.0 <http://rubyforge.org/projects/activesupport/>
 
 * Ruby-GetText-Package-1.92.0
-    by Masao Mutoh <http://www.yotabanana.com/hiki/ruby-gettext.html>
+  * by Masao Mutoh <http://www.yotabanana.com/hiki/ruby-gettext.html>
 
 === Documents
 * The Open Group Base Specifications Issue 6 IEEE Std 1003.1, 2004 Edition 

data/Rakefile

@@ -28,9 +28,11 @@ Rake::RDocTask.new { |rdoc|
   end
   rdoc.rdoc_dir = 'doc'
   rdoc.title    = "Ruby-Locale library"
-  rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README.rdoc', 'ChangeLog')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.options << "--line-numbers" << "--inline-source" <<
+      "--accessor" << "cattr_accessor=object" << "--charset" << "utf-8"
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('ChangeLog')
+  rdoc.rdoc_files.add('lib')
   rdoc.template = allison if allison.size > 0
 }
 

data/lib/locale.rb

@@ -1,7 +1,7 @@
 =begin
   locale.rb - Locale module
 
-  Copyright (C) 2002-2008  Masao Mutoh
+  Copyright (C) 2002-2009  Masao Mutoh
 
   You may redistribute it and/or modify it under the same
   license terms as Ruby.
@@ -17,23 +17,50 @@ require 'locale/taglist'
 require 'locale/version'
 
 # Locale module manages the locale informations of the application.
+# These functions are the most important APIs in this library.
+# Almost of all i18n/l10n programs use this APIs only.
 module Locale
   @@default_tag = nil
   @@locale_driver_module = nil
 
+  ROOT = File.dirname(__FILE__)
+
   include Locale::Util::Memoizable
 
   module_function
+  def require_driver(name)  #:nodoc:
+    require File.join(ROOT, "locale/driver", name.to_s)
+  end
+
+  def create_language_tag(tag)  #:nodoc:
+    if tag
+      if tag.kind_of? Locale::Tag::Simple
+        tag
+      else
+        Locale::Tag.parse(tag)
+      end
+    else
+      nil
+    end
+  end
+
   # Initialize Locale library. 
   # Usually, you don't need to call this directly, because
   # this is called when Locale's methods are called.
-  # If you need to specify the option, call this once first.
-  # (But Almost of all case, you don't need this, because the 
-  # framework/library such as gettext calls this.)
   #
-  # If you use this library with CGI(and not use frameworks/gettext), 
+  # If you use this library with CGI or the kind of CGI.
   # You need to call Locale.init(:driver => :cgi).
   #
+  # ==== For Framework designers/programers:
+  # If your framework is for WWW, call this once like: Locale.init(:driver => :cgi).
+  #
+  # ==== To Application programers:
+  # If your framework doesn't use ruby-locale and the application is for WWW,
+  # call this once like: Locale.init(:driver => :cgi).
+  #
+  # ==== To Library authors:
+  # Don't call this, even if your application is only for WWW.
+  #
   # * opts: Options as a Hash.
   #   * :driver - The driver. :cgi if you use Locale module with CGI,
   #     nil if you use system locale.
@@ -41,14 +68,14 @@ module Locale
   #
   def init(opts = {})
     if opts[:driver]
-      require "locale/driver/#{opts[:driver]}"
+      require_driver opts[:driver]
     else
       if /cygwin|mingw|win32/ =~ RUBY_PLATFORM
-        require 'locale/driver/win32'
+        require_driver 'win32' 
       elsif /java/ =~ RUBY_PLATFORM
-        require 'locale/driver/jruby'
+        require_driver 'jruby' 
       else
-        require 'locale/driver/posix'
+        require_driver 'posix' 
       end
     end
   end
@@ -58,33 +85,26 @@ module Locale
   # Usually you don't need to call this method.
   #
   # * Returns: the driver module.
-  def driver_module
+  def driver_module 
     unless @@locale_driver_module
       Locale.init
     end
     @@locale_driver_module
   end
 
+  DEFAULT_LANGUAGE_TAG = Locale::Tag::Simple.new("en") #:nodoc:
+
   # Sets the default locale as the language tag 
   # (Locale::Tag's class or String(such as "ja_JP")).
   # 
   # * tag: the default language_tag
   # * Returns: self.
   def set_default(tag)
-    default_tag = nil
     Thread.list.each do |thread|
       thread[:current_languages] = nil
-      thread[:candidates_caches] = {}
-    end
-
-    if tag
-      if tag.kind_of? Locale::Tag::Simple
-        default_tag = tag
-      else
-        default_tag = Locale::Tag.parse(tag)
-      end
+      thread[:candidates_caches] = nil
     end
-    @@default_tag = default_tag
+    @@default_tag = create_language_tag(tag)
     self
   end
 
@@ -103,18 +123,19 @@ module Locale
   #
   # * Returns: the default locale (Locale::Tag's class).
   def default
-    @@default_tag
+    @@default_tag || DEFAULT_LANGUAGE_TAG
   end
 
   # Sets the locales of the current thread order by the priority. 
   # Each thread has a current locales.
-  # The default locale/system locale is used if the thread doesn't have current locales.
+  # The system locale/default locale is used if the thread doesn't have current locales.
   #
   # * tag: Locale::Language::Tag's class or the language tag as a String. nil if you need to
-  # clear current locales.
+  #   clear current locales.
   # * charset: the charset (override the charset even if the locale name has charset) or nil.
   # * Returns: self
   #
+  # (e.g.)
   #    Locale.set_current("ja_JP.eucJP")
   #    Locale.set_current("ja-JP")
   #    Locale.set_current("en_AU", "en_US", ...)
@@ -124,15 +145,11 @@ module Locale
     if tags[0]
       languages = Locale::TagList.new
       tags.each do |tag|
-        if tag.kind_of? Locale::Tag::Simple
-          languages << tag
-        else
-          languages << Locale::Tag.parse(tag)
-        end
+        languages << create_language_tag(tag)
       end
     end
     Thread.current[:current_languages] = languages
-    Thread.current[:candidates_caches] = {}
+    Thread.current[:candidates_caches] = nil
     self
   end
 
@@ -149,11 +166,18 @@ module Locale
   end
 
   # Gets the current locales (Locale::Tag's class).
+  # If the current locale is not set, this returns system/default locale.
+  #
+  # This method returns the current language tags even if it isn't included in app_language_tags.
+  #
+  # Usually, the programs should use Locale.candidates to find the correct locale, not this method.
   #
-  # If the current locale is not set, this returns default/system locale.
   # * Returns: an Array of the current locales (Locale::Tag's class).
   def current
-    Thread.current[:current_languages] ||= (default ? Locale::TagList.new([default]) : driver_module.locales)
+    unless Thread.current[:current_languages]
+      loc = driver_module.locales
+      Thread.current[:current_languages] = loc ? loc : Locale::TagList.new([default])
+    end
     Thread.current[:current_languages]
   end
 
@@ -168,21 +192,25 @@ module Locale
   end
 
   # Returns the language tags which are variations of the current locales order by priority.
+  #
   # For example, if the current locales are ["fr", "ja_JP", "en_US", "en-Latn-GB-VARIANT"], 
   # then returns ["fr", "ja_JP", "en_US", "en-Latn-GB-VARIANT", "en_Latn_GB", "en_GB", "ja", "en"].
-  # "en" is the default locale. It's added at the end of the list even if it isn't exist.
+  # "en" is the default locale(You can change it using set_default). 
+  # The default locale is added at the end of the list even if it isn't exist.
+  #
   # Usually, this method is used to find the locale data as the path(or a kind of IDs).
   # * options: options as a Hash or nil.
-  #   * :supported_language_tags: an Array of the language tags order by the priority. This option 
-  #      filters the locales which are supported by the library/application.
-  #      Default is nil if you don't need to filter the locales.
-  #       * (e.g.1) ["fr_FR", "en_GB", "en_US", ...], (e.g.2) ["fr-FR", "en-GB", "en-US", ...]
-  #   * :type: the type of language tag. :common, :rfc, :cldr, :posix and 
-  #      :simple are available. Default value is :common
-  #   * :default_language_tags: the default languages as an Array. Default value is ["en"]. 
+  #   * :supported_language_tags - 
+  #     An Array of the language tags order by the priority. This option 
+  #     restricts the locales which are supported by the library/application.
+  #     Default is nil if you don't need to restrict the locales.
+  #      (e.g.1) ["fr_FR", "en_GB", "en_US", ...]
+  #   * :type - 
+  #     The type of language tag. :common, :rfc, :cldr, :posix and 
+  #     :simple are available. Default value is :common
   def candidates(options = {})
-    opts = {:supported_language_tags => nil, :type => :common, 
-      :default_language_tags => ["en"]}.merge(options)
+    opts = {:supported_language_tags => nil, :current => current,
+      :type => :common}.merge(options)
 
     if Thread.current[:candidates_caches]
       cache = Thread.current[:candidates_caches][opts.hash]
@@ -191,31 +219,44 @@ module Locale
       Thread.current[:candidates_caches] = {} 
     end
     Thread.current[:candidates_caches][opts.hash] =
-      collect_candidates(opts[:type], current, 
-                         opts[:default_language_tags], 
+      collect_candidates(opts[:type], opts[:current],
                          opts[:supported_language_tags])
   end
 
   # collect tag candidates and memoize it. 
   # The result is shared from all threads.
-  def collect_candidates(type, tags, default_tags, supported_tags) # :nodoc:
-    default_language_tags = default_tags.collect{|v| 
-      Locale::Tag.parse(v).send("to_#{type}")}.flatten.uniq
-
+  def collect_candidates(type, tags, supported_tags) # :nodoc:
     candidate_tags = tags.collect{|v| v.send("to_#{type}").candidates}
+    default_tags = default.send("to_#{type}").candidates
+    if app_language_tags
+      app_tags = app_language_tags.collect{|v| v.send("to_#{type}")}.flatten.uniq
+    end
+    if supported_tags
+      supported_tags = supported_tags.collect{|v| Locale::Tag.parse(v).send("to_#{type}")}.flatten.uniq
+    end
 
     tags = []
     (0...candidate_tags[0].size).each {|i|
       tags += candidate_tags.collect{|v| v[i]}
     }
-    tags += default_language_tags
+    tags += default_tags
     tags.uniq!
 
-    if supported_tags
-      tags &= supported_tags.collect{|v| 
-        Locale::Tag.parse(v).send("to_#{type}")}.flatten
-      tags = default_language_tags if tags.size == 0
+    all_tags = nil
+    if app_tags
+      if supported_tags
+        all_tags = app_tags & supported_tags
+      else
+        all_tags = app_tags
+      end
+    elsif supported_tags
+      all_tags = supported_tags
     end
+    if all_tags
+      tags &= all_tags
+      tags = default_tags.uniq if tags.size == 0
+    end
+
     Locale::TagList.new(tags)
   end
   memoize :collect_candidates
@@ -227,7 +268,7 @@ module Locale
   #
   # * Returns: the current charset.
   def charset
-    driver_module.charset
+    driver_module.charset || "UTF-8"
   end
   memoize :charset
 
@@ -235,19 +276,54 @@ module Locale
   # * Returns: self
   def clear
     Thread.current[:current_languages] = nil
-    Thread.current[:candidates_caches] = {}
+    Thread.current[:candidates_caches] = nil
     self
   end
 
   # Clear all locales and charsets of all threads. 
-  # This doesn't clear the default locale.
+  # This doesn't clear the default and app_language_tags.
   # Use Locale.default = nil to unset the default locale.
   # * Returns: self
   def clear_all
     Thread.list.each do |thread|
       thread[:current_languages] = nil
-      thread[:candidates_caches] = {}
+      thread[:candidates_caches] = nil
+    end
+    memoize_clear
+    self
+  end
+
+  @@app_language_tags = nil
+  # Set the language tags which is supported by the Application.
+  # This value is same with supported_language_tags in Locale.candidates
+  # to restrict the result but is the global setting.
+  # If you set a language tag, the application works as the single locale 
+  # application.
+  #
+  # If the current locale is not included in app_language_tags,
+  # Locale.default value is used.
+  # Use Locale.set_default() to set correct language 
+  # if "en" is not included in the language tags.
+  #
+  # Set nil if clear the value.
+  #
+  # Note that the libraries/plugins shouldn't set this value.
+  #
+  #  (e.g.) Locale.set_app_language_tags("fr_FR", "en-GB", "en_US", ...)
+  def set_app_language_tags(*tags)
+    if tags[0]
+      @@app_language_tags = tags.collect{|v| Locale::Tag.parse(v)}
+    else
+      @@app_language_tags = nil
     end
+    
+    clear_all
     self
   end
+
+  # Returns the app_language_tags. Default is nil. See set_app_language_tags for more details.
+  def app_language_tags
+    @@app_language_tags
+  end
+
 end

data/lib/locale/driver/cgi.rb

@@ -19,9 +19,6 @@ module Locale
     module CGI
       $stderr.puts self.name + " is loaded." if $DEBUG
 
-      @@default_locale = Locale::Tag::Simple.new("en")
-      @@default_charset = "UTF-8"
-      
       module_function
       # Gets required locales from CGI parameters. (Based on RFC2616)
       #
@@ -29,14 +26,13 @@ module Locale
       #          (QUERY_STRING "lang" > COOKIE "lang" > HTTP_ACCEPT_LANGUAGE > "en")
       # 
       def locales
-        return Locale::TagList.new([@@default_locale]) unless cgi
-        cgi_ = cgi
+        req = Thread.current[:current_request]
+        return nil unless req
 
-        locales = Locale::TagList.new
+        locales = []
 
         # QUERY_STRING "lang"
-        langs = cgi_.params["lang"]
-        if langs
+        if langs = req[:query_langs]
           langs.each do |lang|
             locales << Locale::Tag.parse(lang)
           end
@@ -44,8 +40,7 @@ module Locale
 
         unless locales.size > 0
           # COOKIE "lang"
-          langs = cgi_.cookies["lang"]
-          if langs
+          if langs = req[:cookie_langs]
             langs.each do |lang|
               locales << Locale::Tag.parse(lang) if lang.size > 0
             end
@@ -54,77 +49,88 @@ module Locale
 
         unless locales.size > 0
           # HTTP_ACCEPT_LANGUAGE
-          if lang = cgi_.accept_language and lang.size > 0
+          if lang = req[:accept_language] and lang.size > 0
             locales += lang.gsub(/\s/, "").split(/,/).map{|v| v.split(";q=")}.map{|j| [j[0], j[1] ? j[1].to_f : 1.0]}.sort{|a,b| -(a[1] <=> b[1])}.map{|v| Locale::Tag.parse(v[0])}
           end
         end
 
-        unless locales.size > 0
-          locales << @@default_locale
-        end
-        Locale::TagList.new(locales.uniq)
+        locales.size > 0 ? Locale::TagList.new(locales.uniq) : nil
       end
 
       # Gets the charset from CGI parameters. (Based on RFC2616)
-      #  * Returns: the charset (HTTP_ACCEPT_CHARSET > "UTF-8").
+      #  * Returns: the charset (HTTP_ACCEPT_CHARSET or nil).
      def charset
-       cgi_ = cgi
-       charsets = cgi_.accept_charset
+       req = Thread.current[:current_request]
+       return nil unless req
+
+       charsets = req[:accept_charset]
        if charsets and charsets.size > 0
          num = charsets.index(',')
          charset = num ? charsets[0, num] : charsets
-         charset = @@default_charset if charset == "*"
+         charset = nil if charset == "*"
        else
-         charset = @@default_charset
+         charset = nil
        end
        charset
      end
 
-      # Sets a CGI object.
-      # * cgi_: CGI object
-      # * Returns: self
-      def set_cgi(cgi_)
-        Thread.current[:current_cgi]  = cgi_
-        self
-      end
-      
-      def cgi  #:nodoc:
-        Thread.current[:current_cgi]
-      end
+     # Set a request.
+     # 
+     # * query_langs: An Array of QUERY_STRING value "lang".
+     # * cookie_langs: An Array of cookie value "lang".
+     # * accept_language: The value of HTTP_ACCEPT_LANGUAGE
+     # * accept_charset: The value of HTTP_ACCEPT_CHARSET
+     def set_request(query_langs, cookie_langs, accept_language, accept_charset)
+       Thread.current[:current_request] = {
+         :query_langs => query_langs, 
+         :cookie_langs => cookie_langs, 
+         :accept_language => accept_language,
+         :accept_charset => accept_charset
+       }
+       self
+     end
+
+     # Clear the current request.
+     def clear_current_request
+       Thread.current[:current_request] = nil
+     end
     end
   end
 
   @@locale_driver_module = Driver::CGI
   
   module_function
-  # Sets a CGI object. 
-  #
-  # Call Locale.init(:driver => :cgi) first.
+  # Sets a request values for lang/charset.
   #
-  # * cgi_: CGI object
-  # * Returns: self
-  def set_cgi(cgi_)
-    @@locale_driver_module.set_cgi(cgi_)
+  # * query_langs: An Array of QUERY_STRING value "lang".
+  # * cookie_langs: An Array of cookie value "lang".
+  # * accept_language: The value of HTTP_ACCEPT_LANGUAGE
+  # * accept_charset: The value of HTTP_ACCEPT_CHARSET
+  def set_request(query_langs, cookie_langs, accept_language, accept_charset)
+    @@locale_driver_module.set_request(query_langs, cookie_langs, accept_language, accept_charset)
     self
   end
-  
-  # Sets a CGI object.
+
+  # Sets a CGI object. This is the convenient function of set_request().
   #
-  # Call Locale.init(:driver => :cgi) first.
+  # This method is appeared when Locale.init(:driver => :cgi) is called.
   #
-  # * cgi_: CGI object
-  # * Returns: cgi_ 
-  def cgi=(cgi_)
-    set_cgi(cgi_)
-    cgi_
+  # * cgi: CGI object
+  # * Returns: self
+  def set_cgi(cgi)
+    set_request(cgi.params["lang"], cgi.cookies["lang"],
+                cgi.accept_language, cgi.accept_charset)
+    self
   end
   
-  # Gets the CGI object. If it is nil, returns new CGI object.
+  # Sets a CGI object.This is the convenient function of set_request().
   #
-  # Call Locale.init(:driver => :cgi) first.
+  # This method is appeared when Locale.init(:driver => :cgi) is called.
   #
-  # * Returns: the CGI object
-  def cgi
-    @@locale_driver_module.cgi
+  # * cgi: CGI object
+  # * Returns: cgi 
+  def cgi=(cgi)
+    set_cgi(cgi)
+    cgi
   end
 end

data/lib/locale/driver/jruby.rb

@@ -11,7 +11,7 @@
   $Id: jruby.rb 27 2008-12-03 15:06:50Z mutoh $
 =end
 
-require 'locale/driver/env'
+require File.join(File.dirname(__FILE__), 'env')
 require 'java'
 
 module Locale
@@ -33,9 +33,14 @@ module Locale
         locales = ::Locale::Driver::Env.locales
         unless locales
           locale = java.util.Locale.getDefault
+          variant = Locale.getVariant 
+          variants = []
+          if valiant != nil and variant.size > 0
+            valiants = [valiant]
+          end
           locales = TagList.new([Locale::Tag::Common.new(locale.getLanguage, nil,
                                                          locale.getCountry, 
-                                                         [locale.getVariant])])
+                                                         variants)])
         end
         locales
       end

data/lib/locale/driver/posix.rb

@@ -11,7 +11,7 @@
   $Id: posix.rb 27 2008-12-03 15:06:50Z mutoh $
 =end
 
-require 'locale/driver/env'
+require File.join(File.dirname(__FILE__), 'env')
 
 module Locale 
   # Locale::Driver::Posix module for Posix OS (Unix)
@@ -30,14 +30,14 @@ module Locale
       end
 
       # Gets the charset from environment variable or the result of
-      # "locale charmap".
+      # "locale charmap" or nil.
       # * Returns: the system charset.
       def charset
         charset = ::Locale::Driver::Env.charset
         unless charset
           charset = `locale charmap`.strip
           unless $? && $?.success?
-            charset = "UTF-8"
+            charset = nil
           end
         end
         charset

data/lib/locale/driver/win32.rb

@@ -11,8 +11,8 @@
   $Id: win32.rb 27 2008-12-03 15:06:50Z mutoh $
 =end
 
-require 'locale/driver/env'
-require 'locale/driver/win32_table'
+require File.join(File.dirname(__FILE__), 'env')
+require File.join(File.dirname(__FILE__), 'win32_table')
 require 'dl/win32'
 
 
@@ -34,9 +34,10 @@ module Locale
       def charset
         charset = ::Locale::Driver::Env.charset
         unless charset
-          loc = LocaleTable.find{|v| v[1] =locale.to_general}
+          locale = locales[0]
+          loc = LocaleTable.find{|v| v[1] =locale.to_rfc}
           loc = LocaleTable.find{|v| v[1] =~ /^#{locale.language}-/} unless loc
-          charset = loc ? loc[2] : "CP1252"
+          charset = loc ? loc[2] : nil
         end
         charset
       end
@@ -47,10 +48,10 @@ module Locale
           lang = LocaleTable.assoc(@@win32.call)
           if lang
             ret = Locale::Tag::Common.parse(lang[1])
+            locales = Locale::TagList.new([ret])
           else
-            ret = Locale::Tag::Common.new("en")
+            locales = nil
           end
-          locales = Locale::TagList.new([ret])
         end
         locales
       end

data/lib/locale/tag.rb

@@ -8,7 +8,7 @@
 =end
 
 require 'locale/tag/simple'
-require 'locale/tag/illegular'
+require 'locale/tag/irregular'
 require 'locale/tag/common'
 require 'locale/tag/rfc'
 require 'locale/tag/cldr'
@@ -31,7 +31,7 @@ module Locale
         ret = parser.parse(tag)
         return ret if ret
       end
-      Locale::Tag::Illegular.new(tag)
+      Locale::Tag::Irregular.new(tag)
     end
     memoize :parse
   end

data/lib/locale/tag/cldr.rb

@@ -9,8 +9,8 @@
 
 require 'locale/tag/common'
 
-module Locale #:nodoc:
-  module Tag #:nodoc:
+module Locale 
+  module Tag 
 
     # Unicode locale identifier class for CLDR-1.6.1.
     # (Unicode Common Locale Data Repository).
@@ -61,7 +61,7 @@ module Locale #:nodoc:
         super(language, script, region, variants.map{|v| v.upcase})
       end
 
-      # Sets the extensions.
+      # Sets the extensions as an Hash.
       def extensions=(val)
         clear
         @extensions = val

data/lib/locale/tag/common.rb

@@ -67,7 +67,7 @@ module Locale
         @script
       end
 
-      # Set the variants
+      # Set the variants as an Array.
       def variants=(val)
         clear
         @variants = val

data/lib/locale/tag/{illegular.rb → irregular.rb}

@@ -1,12 +1,12 @@
 =begin
-  locale/tag/illegular.rb - Locale::Tag::Illegular
+  locale/tag/irregular.rb - Locale::Tag::Irregular
 
   Copyright (C) 2008  Masao Mutoh
 
   You may redistribute it and/or modify it under the same
   license terms as Ruby.
 
-  $Id: illegular.rb 27 2008-12-03 15:06:50Z mutoh $
+  $Id: irregular.rb 27 2008-12-03 15:06:50Z mutoh $
 =end
 
 require 'locale/tag/simple'
@@ -15,17 +15,17 @@ module Locale
 
   module Tag
     # Broken tag class.
-    class Illegular < Simple
+    class Irregular < Simple
 
       def initialize(tag)
-        tag = "en" if tag == nil || tag.empty?
+        tag = "en" if tag == nil or tag == ""
         @language = tag
         @tag = tag
       end
 
       # Returns an Array of tag-candidates order by priority.
       def candidates
-        [Illegular.new(tag)]
+        [Irregular.new(tag)]
       end
       memoize :candidates
 

data/lib/locale/tag/posix.rb

@@ -9,8 +9,8 @@
   $Id: posix.rb 27 2008-12-03 15:06:50Z mutoh $
 =end
 
-module Locale #:nodoc:
-  module Tag #:nodoc:
+module Locale 
+  module Tag 
 
     # Locale tag class for POSIX locale
     # * ja
@@ -60,7 +60,7 @@ module Locale #:nodoc:
         @charset = val
       end
 
-      # Set the modifier.
+      # Set the modifier as a String
       def modifier=(val)
         clear
         @modifier = val

data/lib/locale/tag/rfc.rb

@@ -9,8 +9,8 @@
 
 require 'locale/tag/common'
 
-module Locale #:nodoc:
-  module Tag #:nodoc:
+module Locale 
+  module Tag 
 
     # Language tag class for RFC4646(BCP47).
     class Rfc < Common
@@ -64,13 +64,13 @@ module Locale #:nodoc:
         super(language, script, region, variants)
       end
 
-      # Sets the extensions.
+      # Sets the extensions as an Array.
       def extensions=(val)
         clear
         @extensions = val
       end
 
-      # Sets the extensions.
+      # Sets the privateuse as a String
       def privateuse=(val)
         clear
         @privateuse = val

data/lib/locale/tag/simple.rb

@@ -91,6 +91,10 @@ module Locale
         to_s
       end
 
+      def <=>(other)
+        self.to_s <=> other.to_s
+      end
+
       def ==(other)  #:nodoc:
         other != nil and hash == other.hash
       end

data/lib/locale/util/memoizable.rb

@@ -7,9 +7,9 @@
 module Locale
   module Util
     module Memoizable
-      MEMOIZED_IVAR = Proc.new do |symbol|
+      MEMOIZED_IVAR = Proc.new do |symbol| 
         "#{symbol.to_s.sub(/\?\Z/, '_query').sub(/!\Z/, '_bang')}".to_sym
-      end
+      end 
 
       def self.included(base)
         mod = self
@@ -26,8 +26,13 @@ module Locale
         end
       end
 
+      # Clear memoized values. Deprecated.
+      def clear  # :nodoc: 
+        @_memoized_ivars = {}
+      end
+
       # Clear memoized values.
-      def clear
+      def memoize_clear
         @_memoized_ivars = {}
       end
 

data/lib/locale/version.rb

@@ -7,6 +7,6 @@
   license terms as Ruby.
 =end
 module Locale
-  VERSION = "2.0.1"
+  VERSION = "2.0.2"
 end
 

data/samples/rack/README

@@ -0,0 +1,10 @@
+= Install Rack:
+$ sudo gem install rack
+
+= Run rack server:
+$rackup hello_rack.ru
+
+= Access from WWW browser: 
+http://localhost:9292/
+http://localhost:9292/?lang=ja
+

data/samples/rack/hello_rack.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'rack'
+require 'locale'
+ 
+Locale.init(:driver => :cgi)
+
+class HelloRackApp
+  def call(env)
+    req = Rack::Request.new(env)
+    Locale.set_request(req["lang"], req.cookies["lang"],
+                       env["HTTP_ACCEPT_LANGUAGE"], env["HTTP_ACCEPT_CHARSET"])
+    str = "Language tag candidates of your request order by the priority:\n\n"
+    str += Locale.candidates(:type => :rfc).map{|v| v.inspect + "\n"}.join
+    [200, {"Content-Type" => "text/plain", "Content-Length" => str.length.to_s}, [str]]
+  end
+end
+

data/samples/rack/hello_rack.ru

@@ -0,0 +1,5 @@
+$LOAD_PATH.unshift "../../lib"
+
+require 'hello_rack'
+run HelloRackApp.new
+

data/test/test_detect_cgi.rb

@@ -62,59 +62,59 @@ class TestDetectCGI < Test::Unit::TestCase
   end
 
   def test_accept_language
-    setup_cgi("")
     ENV["HTTP_ACCEPT_LANGUAGE"] = ""
     ENV["HTTP_ACCEPT_CHARSET"] = ""
+    setup_cgi("")
     lang = Locale.current[0]
     assert_equal(Locale::Tag::Simple, lang.class)
     assert_equal("en", lang.to_s)
     assert_equal("en", lang.to_rfc.to_s)
 
-    setup_cgi("")
     ENV["HTTP_ACCEPT_LANGUAGE"] = "ja,en-us;q=0.7,en;q=0.3"
+    setup_cgi("")
     lang1, lang2, lang3 = Locale.current
     assert_equal("ja", lang1.to_rfc.to_s)
     assert_equal("en-US", lang2.to_rfc.to_s)
     assert_equal("en", lang3.to_rfc.to_s)
 
-    setup_cgi("")
     ENV["HTTP_ACCEPT_LANGUAGE"] = "en-us,ja;q=0.7,en;q=0.3"
+    setup_cgi("")
     lang1, lang2, lang3 = Locale.current
     assert_equal("en-US", lang1.to_rfc.to_s)
     assert_equal("ja", lang2.to_rfc.to_s)
     assert_equal("en", lang3.to_rfc.to_s)
 
-    setup_cgi("")
     ENV["HTTP_ACCEPT_LANGUAGE"] = "en"
+    setup_cgi("")
     lang = Locale.current[0]
     assert_equal("en", lang.to_rfc.to_s)
   end
 
   def test_accept_charset
     #accept charset
-    setup_cgi("")
     ENV["HTTP_ACCEPT_CHARSET"] = "Shift_JIS"
+    setup_cgi("")
     assert_equal("Shift_JIS", Locale.charset)
 
-    setup_cgi("")
     ENV["HTTP_ACCEPT_CHARSET"] = "EUC-JP,*,utf-8"
+    setup_cgi("")
     assert_equal("EUC-JP", Locale.charset)
 
-    setup_cgi("")
     ENV["HTTP_ACCEPT_CHARSET"] = "*"
+    setup_cgi("")
     assert_equal("UTF-8", Locale.charset)
 
-    setup_cgi("")
     ENV["HTTP_ACCEPT_CHARSET"] = ""
+    setup_cgi("")
     assert_equal("UTF-8", Locale.charset)
   end
 
   def test_default
     Locale.set_default(nil)
     Locale.set_default("ja-JP")
-    setup_cgi("")
     ENV["HTTP_ACCEPT_LANGUAGE"] = ""
     ENV["HTTP_ACCEPT_CHARSET"] = ""
+    setup_cgi("")
     assert_equal("ja-JP", Locale.default.to_rfc.to_s)
     assert_equal("ja-JP", Locale.current.to_rfc.to_s)
     Locale.set_default(nil)
@@ -137,9 +137,9 @@ class TestDetectCGI < Test::Unit::TestCase
   end
 
   def test_candidates
-    setup_cgi("")
 
     ENV["HTTP_ACCEPT_LANGUAGE"] = "fr-fr,zh_CN;q=0.7,zh_TW;q=0.2,ja_JP;q=0.1"
+    setup_cgi("")
 
     assert_equal common("fr-FR", "zh-CN", "zh-TW", "ja-JP", 
                         "fr", "zh", "ja", "en"), Locale.candidates
@@ -153,27 +153,64 @@ class TestDetectCGI < Test::Unit::TestCase
     assert_equal simple("fr-FR", "zh-CN", "zh-TW", "ja-JP",  
                         "fr", "zh", "ja", "en"), Locale.candidates(:type => :simple)
 
+    taglist = Locale.candidates(:type => :rfc)
+    assert_equal Locale::TagList, taglist.class
+    assert_equal "fr", taglist.language
+    assert_equal "FR", taglist.region
+
+  end
+
+  def test_candidates_with_supported_language_tags
+    ENV["HTTP_ACCEPT_LANGUAGE"] = "fr-fr,zh_CN;q=0.7,zh_TW;q=0.2,ja_JP;q=0.1"
+    setup_cgi("")
+
     assert_equal common("fr_FR", "zh", "ja"), Locale.candidates(:type => :common, 
                                                                 :supported_language_tags => ["fr_FR", "ja", "zh"])
 
     assert_equal simple("fr-FR", "zh", "ja"), Locale.candidates(:type => :simple, 
                                                                 :supported_language_tags => ["fr-FR", "ja", "zh"])
+    #supported_language_tags includes "pt" as not in HTTP_ACCEPT_LANGUAGE
+    assert_equal simple("fr-FR", "zh", "ja"), 
+    Locale.candidates(:type => :simple, 
+                      :supported_language_tags => ["fr-FR", "ja", "zh", "pt"])
+
+  end
 
-    assert_equal simple("fr-FR", "zh", "ja", "no", "pt"), 
+  def test_candidates_with_default
+    ENV["HTTP_ACCEPT_LANGUAGE"] = "fr-fr,zh_CN;q=0.7,zh_TW;q=0.2,ja_JP;q=0.1"
+    setup_cgi("")
+
+    Locale.default = "zh_TW"
+    assert_equal simple("fr-FR", "zh", "ja"), 
     Locale.candidates(:type => :simple, 
-                      :supported_language_tags => ["fr-FR", "ja", "zh", "no", "pt"],
-                      :default_language_tags => ["no", "pt"])
+                      :supported_language_tags => ["fr-FR", "ja", "zh", "pt"])
 
-    assert_equal simple("no", "pt"), Locale.candidates(:type => :simple, 
-                                                       :supported_language_tags => ["aa"],
-                                                       :default_language_tags => ["no", "pt"])
-    assert_equal simple("en"), Locale.candidates(:type => :simple, 
+    Locale.default = "pt"
+    assert_equal simple("fr-FR", "zh", "ja", "pt"), 
+    Locale.candidates(:type => :simple, 
+                      :supported_language_tags => ["fr-FR", "ja", "zh", "pt"])
+
+    # default value is selected even if default is not in supported_language_tags.
+    assert_equal simple("pt"), Locale.candidates(:type => :simple, 
                                                  :supported_language_tags => ["aa"])
-    
-    taglist = Locale.candidates(:type => :rfc)
-    assert_equal Locale::TagList, taglist.class
-    assert_equal "fr", taglist.language
-    assert_equal "FR", taglist.region
+    Locale.default = "en"
+  end
+
+
+  def test_candidates_with_app_language_tags
+    Locale.set_app_language_tags("fr-FR", "ja")
+
+    ENV["HTTP_ACCEPT_LANGUAGE"] = "fr-fr,zh_CN;q=0.7,zh_TW;q=0.2,ja_JP;q=0.1"
+    setup_cgi("")
+
+    assert_equal common("fr-FR", "ja"), Locale.candidates
+
+    # default value is selected if default is not in app_language_tags.
+    Locale.set_app_language_tags("no", "pt")
+    Locale.default = "zh"
+    assert_equal common("zh"), Locale.candidates
 
+    Locale.default = "en"
+    Locale.set_app_language_tags(nil)
   end
 end

data/test/test_detect_general.rb

@@ -123,6 +123,7 @@ class TestDetectGeneral < Test::Unit::TestCase
   end
 
   def test_default
+    return unless /linux|bsd/ =~ RUBY_PLATFORM
     Locale.set_default("yo_NG")
     assert_equal Locale::Tag.parse("yo_NG"), Locale.default
     assert_equal Locale::Tag.parse("yo_NG"), Locale.current[0]

data/test/test_tag.rb

@@ -1135,11 +1135,11 @@ class TagTest < Test::Unit::TestCase
 
   def test_invaild
     lang = Locale::Tag.parse("")
-    assert_equal Locale::Tag::Illegular, lang.class
+    assert_equal Locale::Tag::Irregular, lang.class
     assert_equal "en", lang.language
     assert_equal nil, lang.region
 
-    assert_equal [Locale::Tag::Illegular.new("en"),
+    assert_equal [Locale::Tag::Irregular.new("en"),
                  ], lang.candidates
 
     assert_equal Locale::Tag::Simple.parse("en"), lang.to_simple
@@ -1149,11 +1149,11 @@ class TagTest < Test::Unit::TestCase
     assert_equal Locale::Tag::Posix.parse("en"), lang.to_posix
 
     lang = Locale::Tag.parse(nil)
-    assert_equal Locale::Tag::Illegular, lang.class
+    assert_equal Locale::Tag::Irregular, lang.class
     assert_equal "en", lang.language
     assert_equal nil, lang.region
 
-    assert_equal [Locale::Tag::Illegular.new("en"),
+    assert_equal [Locale::Tag::Irregular.new("en"),
                  ], lang.candidates
 
     assert_equal Locale::Tag::Simple.parse("en"), lang.to_simple
@@ -1168,4 +1168,5 @@ class TagTest < Test::Unit::TestCase
       Locale::Tag::Simple.new(nil)
     }
   end
+
 end

data/test/test_thread.rb

@@ -12,7 +12,7 @@ class TestThread < Test::Unit::TestCase
   def invoke_thread(tag, sleep_time)
     Thread.start do
       @mutex.synchronize {
-        ENV["LANG"] = tag
+        ENV["LC_ALL"] = tag
         Locale.current
       }
       (1..10).each do |v|
@@ -27,9 +27,9 @@ class TestThread < Test::Unit::TestCase
   end
 
   def test_thread
-    th1 = invoke_thread("ja_JP.eucJP", 0.6)
-    th2 = invoke_thread("zh_CN.UTF-8", 0.4)
-    th3 = invoke_thread("en", 0.2)
+    th1 = invoke_thread("ja_JP.eucJP", 0.3)
+    th2 = invoke_thread("zh_CN.UTF-8", 0.2)
+    th3 = invoke_thread("en", 0.1)
     th1.join
     th2.join   
     th3.join

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: locale
 version: !ruby/object:Gem::Version 
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors: 
 - Masao Mutoh
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-04-19 00:00:00 +09:00
+date: 2009-05-09 00:00:00 +09:00
 default_executable: 
 dependencies: []
 
@@ -25,6 +25,10 @@ files:
 - ChangeLog
 - samples
 - samples/sample_info.rb
+- samples/rack
+- samples/rack/README
+- samples/rack/hello_rack.rb
+- samples/rack/hello_rack.ru
 - samples/sample_1.rb
 - samples/cgi
 - samples/cgi/cookie.cgi
@@ -49,8 +53,8 @@ files:
 - lib/locale/tag
 - lib/locale/tag/cldr.rb
 - lib/locale/tag/common.rb
-- lib/locale/tag/illegular.rb
 - lib/locale/tag/rfc.rb
+- lib/locale/tag/irregular.rb
 - lib/locale/tag/posix.rb
 - lib/locale/tag/simple.rb
 - lib/locale/info