merb_global 0.0.5.2 → 0.0.6

data/HISTORY

@@ -1,3 +1,8 @@
+=== 0.0.6
+ * Introduction of Locale object
+ * Change of MessageProviders interface
+ * Per-enviroment configuration
+
 === 0.0.5
  * Handles lang_REGION as lang
  * Renamed providers into message providers and translate_to into localize

data/Rakefile

@@ -6,7 +6,7 @@ require 'fileutils'
 
 PLUGIN = "merb_global"
 NAME = "merb_global"
-GEM_VERSION = "0.0.5.2"
+GEM_VERSION = "0.0.6"
 AUTHORS = ["Alex Coles", "Maciej Piechotka"]
 EMAIL = "alex@alexcolesportfolio.com"
 HOMEPAGE = "http://trac.ikonoklastik.com/merb_global/"

data/lib/merb_global/base.rb

@@ -1,29 +1,53 @@
 require 'merb_global/config'
 require 'merb_global/plural'
+require 'merb_global/locale'
 require 'merb_global/date_providers'
 require 'merb_global/message_providers'
 require 'merb_global/numeric_providers'
 
-module Merb
-  module Global
-    attr_accessor :lang, :message_provider, :date_provider, :numeric_provider
+class String
+  def localize(args = {})
+    opts = {:locale => Merb::Global::Locale.current, :n => 1, :plural => nil}
+    opts.merge!(args)
+    Merb::Global::MessageProviders.provider.localize self, opts[:plural],
+                                                     opts[:n], opts[:locale]
+  end
+end
 
-    def lang #:nodoc:
-      @lang ||= 'en'
-    end
+class Numeric
+  def localize(args = {})
+    opts = {:locale => Merb::Global::Locale.current}
+    opts.merge!(args)
+    Merb::Global::NumericProviders.provider.localize opts[:locale], self
+  end
+end
 
-    def message_provider #:nodoc:
-      @message_provider ||= Merb::Global::MessageProviders.provider
-    end
+class Date
+  def localize(format, args = {})
+    opts = {:locale => Merb::Global::Locale.current}
+    opts.merge!(args)
+    Merb::Global::DateProviders.provider.localize opts[:locale], self, format
+  end
+end
 
-    def date_provider #:nodoc:
-      @date_provider ||= Merb::Global::DateProviders.provider
-    end
+class DateTime
+  def localize(format, args = {})
+    opts = {:locale => Merb::Global::Locale.current}
+    opts.merge!(args)
+    Merb::Global::DateProviders.provider.localize opts[:locale], self, format
+  end
+end
 
-    def numeric_provider #:nodoc:
-      @numeric_provider ||= Merb::Global::NumericProviders.provider
-    end
+class Time
+  def localize(format, args = {})
+    opts = {:locale => Merb::Global::Locale.current}
+    opts.merge!(args)
+    Merb::Global::DateProviders.provider.localize opts[:locale], self, format
+  end
+end
 
+module Merb
+  module Global
     # call-seq:
     #   _(singular, opts)          => translated message
     #   _(singlular, plural, opts) => translated message
@@ -40,7 +64,7 @@ module Merb
     # number<Numeric>:: A numeber to localize
     #
     # ==== Options (opts)
-    # :lang<String>:: A language to translate on
+    # :locale<Locale>:: A language to translate on
     # :n<Fixnum>:: A number of objects (for messages)
     #
     # ==== Returns
@@ -49,25 +73,25 @@ module Merb
     # ==== Example
     # <tt>render _('%d file deleted', '%d files deleted', :n => del) % del</tt>
     def _(*args)
-      opts = {:lang => self.lang, :n => 1}
+      opts = {:locale => Merb::Global::Locale.current, :n => 1}
       opts.merge! args.pop if args.last.is_a? Hash
       if args.first.respond_to? :strftime
         if args.size == 2
-          self.date_provider.localize opts[:lang], args[0], args[1]
+          Merb::Global::DateProviders.provider.localize opts[:locale], args[0], args[1]
         else
           raise ArgumentError, "wrong number of arguments (#{args.size} for 2)"
         end
       elsif args.first.is_a? Numeric
         if args.size == 1
-          self.numeric_provider.localize opts[:lang], args.first
+          Merb::Global::NumericProviders.provider.localize opts[:locale], args.first
         else
           raise ArgumentError, "wrong number of arguments (#{args.size} for 1)"
         end
       elsif args.first.is_a? String
         if args.size == 1
-          self.message_provider.localize args[0], nil, opts
+          Merb::Global::MessageProviders.provider.localize args[0], nil, opts[:n], opts[:locale]
         elsif args.size == 2
-          self.message_provider.localize args[0], args[1], opts
+          Merb::Global::MessageProviders.provider.localize args[0], args[1], opts[:n], opts[:locale]
         else
           raise ArgumentError,
                 "wrong number of arguments (#{args.size} for 1-2)"

data/lib/merb_global/config.rb

@@ -1,5 +1,6 @@
 module Merb
   module Global
+    @@config = nil
     # call-seq:
     #    config(key)                        => value
     #    config([key1, key2, ...])          => value
@@ -19,7 +20,13 @@ module Merb
     # <tt>Merb::Global.config [:gettext, :domain], 'merbapp'</tt>
     def self.config(keys, default = nil)
       keys = [keys] unless keys.is_a? Array
-      current = Merb::Plugins.config[:merb_global]
+      #if @@config.nil?
+        @@config = Merb::Plugins.config[:merb_global].dup
+        unless Merb::Plugins.config[:merb_global][Merb.env].nil?
+          @@config.merge! Merb::Plugins.config[:merb_global][Merb.env]
+        end
+      #end
+      current = @@config
       while current.respond_to?(:[]) and not keys.empty?
         current = current[keys.shift]
       end

data/lib/merb_global/controller.rb

@@ -3,64 +3,62 @@ require 'merb_global/base'
 module Merb
   class Controller
     include Merb::Global
-    class_inheritable_accessor :_language
+
+    class_inheritable_accessor :_mg_locale
 
     before do
       # Set up the language
       accept_language = self.request.env['HTTP_ACCEPT_LANGUAGE']
-      self.lang = params[:language] ||
-        (self._language && self.instance_eval(&self._language)) ||
+      Merb::Global::Locale.current =
+        Merb::Global::Locale.new(params[:locale]) ||
+        (self._mg_locale &&
+         Merb::Global::Locale.new(self.instance_eval(&self._mg_locale))) ||
         begin
           unless accept_language.nil?
-            accept_language = accept_language.split(',')
-            accept_language.collect! {|lang| lang.delete ' ' "\n" "\r" "\t"}
-            accept_language.reject! {|lang| lang.empty?}
-            accept_language.collect! {|lang| lang.split ';q='}
+            accept_language = Merb::Global::Locale.parse(accept_language)
             accept_language.collect! do |lang|
-              if lang.size == 1
-                [lang[0], 1.0]
-              else
-                [lang[0], lang[1].to_f]
-              end
-            end
-            accept_language.sort! {|lang_a, lang_b| lang_a[1] <=> lang_b[1]}
-            accept_language.collect! {|lang| lang[0]}
-            accept_language_orig = accept_language.dup
-            accept_language.collect! do |lang|
-              if lang == '*'
-                '*'
-              elsif self.message_provider.support? lang
+              if lang.any?
+                lang
+              elsif Merb::Global::MessageProviders.provider.support? lang
                 lang
-              elsif lang.include? '-'
-                lang = lang.split('-')[0]
-                if self.message_provider.support? lang
+              else
+                lang = lang.base_locale
+                if not lang.nil? and Merb::Global::MessageProviders.provider.support? lang
                   lang
                 else
                   nil
                 end
-              else
-                nil
               end
             end
             accept_language.reject! {|lang| lang.nil?}
             unless accept_language.empty?
-              unless accept_language.last == '*'
+              unless accept_language.last.any?
                 accept_language.last
               else
                 accept_language.pop
-                self.message_provider.choose accept_language
+                Merb::Global::MessageProviders.provider.choose accept_language
               end
             end
           end
-        end || 'en'
+        end || Merb::Global::Locale.new('en')
     end
 
     # Sets the language of block.
     #
     # The block should return language or nil if other method should be used
     # to determine the language
+    #
+    # Please note that this method is deprecated and the prefereed method is
+    # locale.
     def self.language(&block)
-      self._language = block
+      self._mg_locale = block
+    end
+    # Sets the language of block.
+    #
+    # The block should return language or nil if other method should be used
+    # to determine the language
+    def self.locale(&block)
+      self._mg_locale = block
     end
   end
 end

data/lib/merb_global/date_providers/fork.rb

@@ -10,7 +10,7 @@ module Merb
           pipe_rd, pipe_wr = IO.pipe
           pid = fork do
             pipe_rd.close
-            setlocale(lang)
+            setlocale(lang.to_s)
             pipe_wr.write(date.strftime(format))
             pipe_wr.flush
           end

data/lib/merb_global/locale.rb

@@ -0,0 +1,96 @@
+require 'merb_global/base'
+require 'thread'
+require 'weakref'
+
+class Thread
+  attr_accessor :mg_locale
+end
+
+module Merb
+  module Global
+    class Locale
+      attr_reader :language, :country
+      
+      def initialize(name)
+        # TODO: Understend RFC 1766 fully
+        @language, @country = name.split('-')
+      end
+
+      def any?
+        language == '*' && country.nil?\
+      end
+
+      def base_locale
+        if not @country.nil?
+          Locale.new(@language)
+        else
+          nil
+        end
+      end
+
+      def to_s
+        if country.nil?
+          "#{@language.downcase}"
+        else
+          "#{@language.downcase}_#{@country.upcase}"
+        end
+      end
+      
+      def self.parse(header)
+        header = header.split(',')
+        header.collect! {|lang| lang.delete ' ' "\n" "\r" "\t"}
+        header.reject! {|lang| lang.empty?}
+        header.collect! {|lang| lang.split ';q='}
+        header.collect! do |lang|
+          if lang.size == 1
+            [lang[0], 1.0]
+          else
+            [lang[0], lang[1].to_f]
+          end
+        end
+        header.sort! {|lang_a, lang_b| lang_a[1] <=> lang_b[1]}
+        header.collect! {|lang| lang[0]}
+        return header.collect! {|lang| Locale.new(lang)}
+      end
+      
+      def self.current
+        Thread.current.mg_locale
+      end
+
+      def self.current=(new_locale)
+        Thread.current.mg_locale = new_locale
+      end
+
+      class << self
+        alias_method :pure_new, :new
+        private :pure_new
+      end
+
+      @@current = {}
+      @@current_mutex = Mutex.new
+      # Create new locale object and returns it.
+      # 
+      # Please note that this method is cached.
+      def self.new(name)
+        return nil if name.nil?
+        return name if name.is_a? Locale
+        @@current_mutex.synchronize do
+          begin
+            n = @@current[name]
+            if n.nil?
+              n = pure_new(name)
+              @@current[name] = WeakRef.new(n)
+            else
+              n = n.__getobj__
+            end
+            n
+          rescue WeakRef::RefError
+            n = pure_new(name)
+            @@current[name] = WeakRef.new(n)
+            n
+          end
+        end
+      end
+    end
+  end
+end

data/lib/merb_global/message_providers/active_record.rb

@@ -13,13 +13,13 @@ module Merb
         include Merb::Global::MessageProviders::Base::Importer
         include Merb::Global::MessageProviders::Base::Exporter
 
-        def localize(singular, plural, opts)
+        def localize(singular, plural, n, locale)
           language = Language.find :first,
-                                   :conditions => {:name => opts[:lang]}
+                                   :conditions => {:name => locale.to_s}
           unless language.nil?
             unless plural.nil?
-              n = Plural.which_form opts[:n], language.plural
-              translation = Translation.find [language.id, singular, n]
+              pn = Plural.which_form n, language.plural
+              translation = Translation.find [language.id, singular, pn]
             else
               # Bug of composite_primary_keys?
               conditions = {
@@ -31,11 +31,11 @@ module Merb
             end
             return translation.msgstr
           end rescue nil
-          return opts[:n] > 1 ? plural : singular # Fallback if not in database
+          return n > 1 ? plural : singular # Fallback if not in database
         end
 
         def support?(lang)
-          Language.count(:conditions => {:name => lang}) != 0
+          Language.count(:conditions => {:name => lang.to_s}) != 0
         end
 
         def create!
@@ -54,6 +54,7 @@ module Merb
           if except.empty?
             Language.find(:first).name
           else
+            except = except.collect {|locale| locale.to_s}
             condition = 'name NOT IN (' + '?, ' * (except.length - 1) + '?)'
             Language.find(:first, :conditions => [condition, *except]).name
           end

data/lib/merb_global/message_providers/data_mapper.rb

@@ -10,15 +10,15 @@ module Merb
         include Merb::Global::MessageProviders::Base::Importer
         include Merb::Global::MessageProviders::Base::Exporter
 
-        def localize(singular, plural, opts)
+        def localize(singular, plural, n, locale)
           # I hope it's from MemCache
-          language = Language.first :name => opts[:lang]
+          language = Language.first :name => locale.to_s
           unless language.nil?
             unless plural.nil?
-              n = Plural.which_form opts[:n], language.plural
+              pn = Plural.which_form n, language.plural
               translation = Translation.first :language_id => language.id,
                                               :msgid => singular,
-                                              :msgstr_index => n
+                                              :msgstr_index => pn
             else
               translation = Translation.first :language_id => language.id,
                                               :msgid => singular,
@@ -27,11 +27,11 @@ module Merb
             return translation.msgstr unless translation.nil?
           end
           # Fallback if not in database
-          return opts[:n] != 1 ? plural : singular
+          return n != 1 ? plural : singular
         end
 
         def support?(lang)
-          not Language.first(:name => lang).nil?
+          not Language.first(:name => lang.to_s).nil?
         end
 
         def create!
@@ -40,6 +40,7 @@ module Merb
         end
 
         def choose(except)
+          except = except.collect {|locale| except.to_s}
           Language.first(:name.not => except).name
         end
 

data/lib/merb_global/message_providers/gettext.rb

@@ -2,11 +2,9 @@ require 'gettext'
 require 'treetop'
 require 'pathname'
 
-# I'm not sure if it is the correct way of doing it.
-# As far it seems to be simpler.
-class Thread #:nodoc:
-  def gettext_context
-    @gettext_context ||= Merb::Global::MessageProviders::Gettext::GettextContext.new
+class Merb::Global::Locale #:nodoc:
+  def _mg_gettext
+    @mg_gettext ||= Merb::Global::MessageProviders::Gettext::GettextContext.new
   end
 end
 
@@ -18,17 +16,18 @@ module Merb
         include Merb::Global::MessageProviders::Base::Importer
         include Merb::Global::MessageProviders::Base::Exporter
 
-        def localize(singular, plural, opts)
-          context = Thread.current.gettext_context
-          context.set_locale opts[:lang], true
+        def localize(singular, plural, n, locale)
+          context = locale._mg_gettext
+          context.set_locale locale.to_s, true
           unless plural.nil?
-            context.ngettext singular, plural, opts[:n]
+            context.ngettext singular, plural, n
           else
             context.gettext singular
           end
         end
 
         def support?(lang)
+          lang = lang.to_s
           lang == 'en' ||
             File.exist?(File.join(Merb::Global::MessageProviders.localedir, lang))
         end
@@ -38,6 +37,7 @@ module Merb
         end
 
         def choose(except)
+          except = except.collect {|locale| locale.to_s}
           dir = Dir[Merb::Global::MessageProviders.localedir + '/*/']
           dir.collect! {|p| File.basename p}
           dir << 'en'

data/lib/merb_global/message_providers/mock.rb

@@ -4,8 +4,8 @@ module Merb
       class Mock #:nodoc:
         include Merb::Global::MessageProviders::Base
 
-        def localize(singular, plural, opts)
-          opts[:n] > 1 ? plural : singular
+        def localize(singular, plural, n, locale)
+          n > 1 ? plural : singular
         end
 
         def support?(lang)
@@ -16,7 +16,7 @@ module Merb
           nil # It's mock after all ;)
         end
 
-        def choose
+        def choose(except)
           'en'
         end
       end

data/lib/merb_global/message_providers/sequel.rb

@@ -9,22 +9,23 @@ module Merb
         include Merb::Global::MessageProviders::Base::Importer
         include Merb::Global::MessageProviders::Base::Exporter
 
-        def localize(singular, plural, opts)
-          language = Language[:name => opts[:lang]] # I hope it's from MemCache
+        def localize(singular, plural, n, locale)
+          # I hope it's from MemCache
+          language = Language[:name => locale.to_s]
           unless language.nil?
             unless plural.nil?
-              n = Plural.which_form opts[:n], language[:plural]
-              translation = Translation[language.pk, singular, n]
+              pn = Plural.which_form n, language[:plural]
+              translation = Translation[language.pk, singular, pn]
             else
               translation = Translation[language.pk, singular, nil]
             end
             return translation[:msgstr] unless translation.nil?
           end
-          return opts[:n] > 1 ? plural : singular # Fallback if not in database
+          return n > 1 ? plural : singular # Fallback if not in database
         end
 
         def support?(lang)
-          Language.filter(:name => lang).count != 0
+          Language.filter(:name => lang.to_s).count != 0
         end
 
         def create!
@@ -43,6 +44,7 @@ module Merb
           if except.empty?
             Language.first[:name]
           else
+            except = except.collect {|locale| locale.to_s}
             Language.filter(~{:name => except}).first[:name]
           end
         end

data/lib/merb_global/message_providers/yaml.rb

@@ -16,41 +16,42 @@ module Merb
           @lang = Hash.new
         end
 
-        def localize(singular, plural, opts)
+        def localize(singular, plural, n, locale)
           unless Merb.environment == "development"
             lang = @lang
           else
             lang = {}
           end
           
-          unless lang.include? opts[:lang]
+          unless lang.include? locale
             file = File.join Merb::Global::MessageProviders.localedir,
-                             opts[:lang] + '.yaml'
+                             locale.to_s + '.yaml'
             if File.exist? file
-              lang[opts[:lang]] = YAML.load_file file
+              lang[locale] = YAML.load_file file
             else
-              lang[opts[:lang]] = nil
+              # TODO: Check if it not opens security risk
+              lang[locale] = nil
             end
           end
 
-          unless lang[opts[:lang]].nil?
-            lang = lang[opts[:lang]]
+          unless lang[locale].nil?
+            lang = lang[locale]
             unless lang[singular].nil?
               unless plural.nil?
-                n = Merb::Global::Plural.which_form opts[:n], lang[:plural]
+                n = Merb::Global::Plural.which_form n, lang[:plural]
                 return lang[singular][n] unless lang[singular][n].nil?
               else
                 return lang[singular] unless lang[singular].nil?
               end
             end
           end
-          return opts[:n] > 1 ? plural : singular
+          return n > 1 ? plural : singular
         end
 
         def support?(lang)
           unless @lang.include? lang
             file = File.join Merb::Global::MessageProviders.localedir,
-                             lang + '.yaml'
+                             lang.to_s + '.yaml'
             @lang[lang] = YAML.load_file file if File.exist? file
           end
           not @lang[lang].nil?
@@ -61,6 +62,7 @@ module Merb
         end
 
         def choose(except)
+          except = except.collect {|locale| locale.to_s}
           dir = Dir[Merb::Global::MessageProviders.localedir + '/*.yaml']
           dir.collect! {|p| File.basename p, '.yaml'}
           dir.reject! {|lang| except.include? lang}

data/lib/merb_global/message_providers.rb

@@ -50,18 +50,15 @@ module Merb
         # ==== Parameters
         # singular<String>:: A string to translate
         # plural<String>:: A plural form of string (nil if only singular)
-        # opts<Hash>:: An options hash (see below)
-        #
-        # ==== Options (opts)
-        # :lang<String>:: A language to translate on
-        # :n<Fixnum>:: A number of objects
+        # n<Fixnum>:: A number of objects
+        # locale<Locale>:: A locale to which translate
         #
         # ==== Returns
         # translated<String>:: A translated string
         #
         # ==== Raises
         # NoMethodError:: Raised by default implementation. Should not be thrown.
-        def localize(singular, plural, opts)
+        def localize(singular, plural, n, locale)
           raise NoMethodError.new 'method localize has not been implemented'
         end
         # call-seq:

data/lib/merb_global/numeric_providers/fork.rb

@@ -10,7 +10,7 @@ module Merb
           pipe_rd, pipe_wr = IO.pipe
           pid = fork do
             pipe_rd.close
-            setlocale(lang)
+            setlocale(lang.to_s)
             pipe_wr.write(number)
             pipe_wr.flush
           end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: merb_global
 version: !ruby/object:Gem::Version 
-  version: 0.0.5.2
+  version: 0.0.6
 platform: ruby
 authors: 
 - Alex Coles
@@ -10,7 +10,7 @@ autorequire: merb_global
 bindir: bin
 cert_chain: []
 
-date: 2008-10-31 00:00:00 +01:00
+date: 2008-11-06 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -68,6 +68,7 @@ files:
 - lib/merb_global/date_providers
 - lib/merb_global/date_providers/fork.rb
 - lib/merb_global/controller.rb
+- lib/merb_global/locale.rb
 - lib/merb_global/base.rb
 - lib/merb_global/numeric_providers
 - lib/merb_global/numeric_providers/fork.rb