merb_global 0.0.4.2 → 0.0.5

data/HISTORY

@@ -1,3 +1,9 @@
+=== 0.0.5
+ * Handles lang_REGION as lang
+ * Renamed providers into message providers and translate_to into localize
+ * Added support for localization of dates and numbers
+ * Updated specs
+
 === 0.0.4
  * Changed database format (to allow importing/exporting)
  * Added importing/exporting (EXPERIMENTAL)

data/Rakefile

@@ -2,10 +2,11 @@ require 'rubygems'
 require 'rake/gempackagetask'
 require 'rake/rdoctask'
 require 'spec/rake/spectask'
+require 'fileutils'
 
 PLUGIN = "merb_global"
 NAME = "merb_global"
-GEM_VERSION = "0.0.4.2"
+GEM_VERSION = "0.0.5"
 AUTHORS = ["Alex Coles", "Maciej Piechotka"]
 EMAIL = "alex@alexcolesportfolio.com"
 HOMEPAGE = "http://trac.ikonoklastik.com/merb_global/"
@@ -20,6 +21,7 @@ spec = Gem::Specification.new do |s|
   s.authors = AUTHORS
   s.email = EMAIL
   s.homepage = HOMEPAGE
+  s.rubyforge_project = 'merb-global'
   s.add_dependency('merb-core', '>= 0.9.1')
   s.add_dependency('treetop', '>= 1.2.3') # Tested on 1.2.3
   s.require_path = 'lib'
@@ -50,6 +52,17 @@ Rake::RDocTask.new do |rd|
   rd.rdoc_files.include "lib/**/*.rb"
 end
 
+desc "Creates database for examples"
+task :populate_db do
+  pwd = File.dirname __FILE__
+  db = "#{pwd}/examples/database.db"
+  sh %{sqlite3 #{db} < #{pwd}/examples/database.sql}
+  FileUtils.cp db, "#{pwd}/examples/active_record_example/database.db"
+  FileUtils.cp db, "#{pwd}/examples/data_mapper_example/database.db"
+  FileUtils.cp db, "#{pwd}/examples/sequel_example/database.db"
+end
+task :gem => :populate_db
+
 desc "Run all specs"
 Spec::Rake::SpecTask.new('specs') do |st|
   st.libs = ['lib', 'spec']

data/activerecord_generators/translations_migration/templates/translations_migration.erb

@@ -1,5 +1,5 @@
 #<% if false %>
-class Merb::Global::Providers::ActiveRecord
+class Merb::Global::MessageProviders::ActiveRecord
 #<% end %>
 class AddTranslationsMigration < ActiveRecord::Migration
   def self.up

data/lib/merb_global/base.rb

@@ -1,34 +1,47 @@
 require 'merb_global/config'
 require 'merb_global/plural'
-require 'merb_global/provider'
-require 'merb_global/providers'
-require 'merb_global/transfer'
+require 'merb_global/date_providers'
+require 'merb_global/message_providers'
+require 'merb_global/numeric_providers'
 
 module Merb
   module Global
-    attr_accessor :lang, :provider
+    attr_accessor :lang, :message_provider, :date_provider, :numeric_provider
 
     def lang #:nodoc:
       @lang ||= 'en'
     end
 
-    def provider #:nodoc:
-      @provider ||= Merb::Global::Providers.provider
+    def message_provider #:nodoc:
+      @message_provider ||= Merb::Global::MessageProviders.provider
+    end
+
+    def date_provider #:nodoc:
+      @date_provider ||= Merb::Global::DateProviders.provider
+    end
+
+    def numeric_provider #:nodoc:
+      @numeric_provider ||= Merb::Global::NumericProviders.provider
     end
 
     # call-seq:
-    #   _(singular, opts)          => translated
-    #   _(singlular, plural, opts) => translated
+    #   _(singular, opts)          => translated message
+    #   _(singlular, plural, opts) => translated message
+    #   _(date, format)            => localized date
+    #   _(number)                  => localized number
     #
     # Translate a string.
     # ==== Parameters
     # singular<String>:: A string to translate
     # plural<String>:: A plural form of string
     # opts<Hash>:: An options hash (see below)
+    # date<~strftime>:: A date to localize
+    # format<String>:: A format of string (should be compatibile with strftime)
+    # number<Numeric>:: A numeber to localize
     #
     # ==== Options (opts)
     # :lang<String>:: A language to translate on
-    # :n<Fixnum>:: A number of objects
+    # :n<Fixnum>:: A number of objects (for messages)
     #
     # ==== Returns
     # translated<String>:: A translated string
@@ -38,12 +51,30 @@ module Merb
     def _(*args)
       opts = {:lang => self.lang, :n => 1}
       opts.merge! args.pop if args.last.is_a? Hash
-      if args.size == 1
-        self.provider.translate_to args[0], nil, opts
-      elsif args.size == 2
-        self.provider.translate_to args[0], args[1], opts
+      if args.first.respond_to? :strftime
+        if args.size == 2
+          self.date_provider.localize opts[:lang], 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
+        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
+        elsif args.size == 2
+          self.message_provider.localize args[0], args[1], opts
+        else
+          raise ArgumentError,
+                "wrong number of arguments (#{args.size} for 1-2)"
+        end
       else
-        raise ArgumentError, "wrong number of arguments (#{args.size} for 1-2)"
+        raise ArgumentError,
+              "wrong type of arguments - see documentation for details"
       end
     end
   end

data/lib/merb_global/controller.rb

@@ -1,7 +1,7 @@
 require 'merb_global/base'
 
 module Merb
-  class Controller 
+  class Controller
     include Merb::Global
     class_inheritable_accessor :_language
 
@@ -9,7 +9,7 @@ module Merb
       # Set up the language
       accept_language = self.request.env['HTTP_ACCEPT_LANGUAGE']
       self.lang = params[:language] ||
-        (self._language && self._language.call) ||
+        (self._language && self.instance_eval(&self._language)) ||
         begin
           unless accept_language.nil?
             accept_language = accept_language.split(',')
@@ -25,15 +25,30 @@ module Merb
             end
             accept_language.sort! {|lang_a, lang_b| lang_a[1] <=> lang_b[1]}
             accept_language.collect! {|lang| lang[0]}
-            accept_language.reject! do |lang|
-              lang != '*' and not self.provider.support? lang
+            accept_language_orig = accept_language.dup
+            accept_language.collect! do |lang|
+              if lang == '*'
+                '*'
+              elsif self.message_provider.support? lang
+                lang
+              elsif lang.include? '-'
+                lang = lang.split('-')[0]
+                if self.message_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 == '*'
                 accept_language.last
               else
                 accept_language.pop
-                self.provider.choose accept_language
+                self.message_provider.choose accept_language
               end
             end
           end

data/lib/merb_global/date_providers/fork.rb

@@ -0,0 +1,35 @@
+require 'inline'
+
+module Merb
+  module Global
+    module DateProviders
+      class Fork
+        include Merb::Global::DateProviders::Base
+
+        def localize(lang, date, format)
+          pipe_rd, pipe_wr = IO.pipe
+          pid = fork do
+            pipe_rd.close
+            setlocale(lang)
+            pipe_wr.write(date.strftime(format))
+            pipe_wr.flush
+          end
+          pipe_wr.close
+          Process.wait(pid)
+          pipe_rd.read
+        end
+
+        inline do |builder|
+          builder.include '<locale.h>'
+          builder.c <<C
+void set_locale(const char *locale)
+{
+  setlocale(LC_ALL, locale);
+}
+C
+        end
+        private :set_locale
+      end
+    end
+  end
+end

data/lib/merb_global/date_providers.rb

@@ -0,0 +1,47 @@
+require 'merb_global/providers'
+
+module Merb
+  module Global
+    module DateProviders
+      include Providers
+      # call-seq:
+      #     provider => provider
+      #
+      # Returns the provider of required type
+      #
+      # ==== Returns
+      # provider<Provider>:: Returns provider
+      def self.provider
+        @@provider ||= self[Merb::Global.config(:date_provider, 'fork')]
+      end
+      # Merb-global is able to handle localization in different ways.
+      # Providers are the interface.
+      #
+      # Please note that it is not required to include this module - despite it
+      # is recomended both as a documentation part and the more customized
+      # error messages.
+      module Base
+        ##
+        # 
+        # Localize date using format as in strftime
+        def localize(lang, date, format)
+          raise NoMethodError.new('method localize has not been implemented')
+        end
+      end
+    end
+    # Perform the registration
+    #
+    # ==== Parameters
+    # name<~to_sym>:: Name under which it is registred
+    def self.DateProvider(provider_name)
+      Module.new do
+        @@rb_date_provider_name = provider_name
+        include Merb::Global::DateProviders::Base
+        
+        def self.included(klass)
+          Merb::Global::DateProviders.register @@rb_date_provider_name, klass
+        end
+      end
+    end
+  end
+end

data/lib/merb_global/merbrake.rb

@@ -1,25 +1,25 @@
 require 'fileutils'
 
 namespace :merb_global do
-  
+
   task :merb_start do
     Merb.start_environment :adapter => 'runner',
                            :environment => ENV['MERB_ENV'] || 'development'
   end
-  
+
   desc 'Create migration'
   task :migration => :merb_start do
-    Merb::Global::Providers.provider.create!
+    Merb::Global::MessageProviders.provider.create!
   end
-  
+
   desc 'Transfer the translations from one provider to another'
   task :transfer => :merb_start do
     from = Merb::Global.config 'source', 'gettext'
     into = Merb::Global.config 'provider', 'gettext'
     if from == 'gettext' and into == 'gettext'
-      Dir[Merb::Global::Providers.localedir + '/*.po'].each do |file|
+      Dir[Merb::Global::MessageProviders.localedir + '/*.po'].each do |file|
         lang = File.basename file, '.po'
-        lang_dir = File.join(Merb::Global::Providers.localedir,
+        lang_dir = File.join(Merb::Global::MessageProviders.localedir,
                              lang, 'LC_MESSAGES')
         FileUtils.mkdir_p lang_dir
         domain = Merb::Global.config([:gettext, :domain], 'merbapp')
@@ -28,10 +28,10 @@ namespace :merb_global do
     elsif from == into
       Merb.logger.error 'Tried transfer from and into the same provider'
     else
-      from = Merb::Global::Providers[from]
-      into = Merb::Global::Providers[into]
+      from = Merb::Global::MessageProviders[from]
+      into = Merb::Global::MessageProviders[into]
       Merb::Global::Provider.transfer from, into
     end
   end
-  
-end
+
+end

data/lib/merb_global/{providers → message_providers}/active_record.rb

@@ -7,13 +7,13 @@ require 'merb_global/plural'
 
 module Merb
   module Global
-    module Providers
+    module MessageProviders
       class ActiveRecord #:nodoc: all
-        include Merb::Global::Provider
-        include Merb::Global::Provider::Importer
-        include Merb::Global::Provider::Exporter
-        
-        def translate_to(singular, plural, opts)
+        include Merb::Global::MessageProviders::Base
+        include Merb::Global::MessageProviders::Base::Importer
+        include Merb::Global::MessageProviders::Base::Exporter
+
+        def localize(singular, plural, opts)
           language = Language.find :first,
                                    :conditions => {:name => opts[:lang]}
           unless language.nil?
@@ -22,7 +22,7 @@ module Merb
               translation = Translation.find [language.id, singular, n]
             else
               translation = Translation.find [language.id, singular, nil]
-            end  
+            end
             return translation.msgstr
           end rescue nil
           return opts[:n] > 1 ? plural : singular # Fallback if not in database
@@ -57,54 +57,61 @@ module Merb
           #                                       "(#{except.join(',')})"])
         end
 
-        def import(exporter, export_data)
+        def import
+          data = {}
           Language.transaction do
             Translation.transaction do
-              Language.find(:all).each do |language|
-                exporter.export_language export_data, language.name,
-                                         language.nplural,
-                                         language.plural do |lang|
-                  language.translations.each do |translation|
-                    exporter.export_string lang, translation.msgid,
-                                                 translation.msgid_plural,
-                                                 translation.msgstr_index,
-                                                 translation.msgstr
-                  end
+              Language.find(:all).each do |lang|
+                data[lang.name] = lang_hash = {
+                  :plural => lang.plural,
+                  :nplural => lang.nplural
+                }
+                lang.translations.each do |translation|
+                  lang_hash[translation.msgid] ||= {
+                    :plural => translation.msgid_plural
+                  }
+                  lang_hash[translation.msgid][translation.msgstr_index] =
+                    translation.msgstr
                 end
               end
             end
           end
+          data
         end
 
-        def export
+        def export(data)
           Language.transaction do
             Translation.transaction do
-              Language.delete_all
               Translation.delete_all
-              yield nil
+              Language.delete_all
+              data.each do |lang_name, lang|
+                lang_id = Language.create!(:name => lang_name,
+                                           :plural => lang[:plural],
+                                           :nplural => lang[:nplural]).id
+                lang.each do |msgid, msgstrs|
+                  if msgid.is_a? String
+                    plural = msgstrs[:plural]
+                    msgstrs.each do |index, msgstr|
+                      if index.nil? or index.is_a? Fixnum
+                        Translation.create! :language_id => lang_id,
+                                            :msgid => msgid,
+                                            :msgid_plural => plural,
+                                            :msgstr => msgstr,
+                                            :msgstr_index => index
+                      end
+                    end
+                  end
+                end
+              end
             end
           end
         end
 
-        def export_language(export_data, language, nplural, plural)
-          yield Language.create!(:language => language, :nplural => nplural,
-                                 :plural => plural).id
-        end
-
-        def export_string(language_id, msgid, msgid_plural,
-                                       msgstr, msgstr_index)
-          Translation.create! :language_id => language_id,
-                              :msgid => msgid,
-                              :msgid_plural => msgid_plural,
-                              :msgstr => msgstr,
-                              :msgstr_index => msgstr_index
-        end
-
         class Language < ::ActiveRecord::Base
           set_table_name :merb_global_languages
           has_many :translations,
             :class_name =>
-              "::Merb::Global::Providers::ActiveRecord::Translation"
+              "::Merb::Global::MessageProviders::ActiveRecord::Translation"
         end
 
         class Translation < ::ActiveRecord::Base

data/lib/merb_global/{providers → message_providers}/data_mapper.rb

@@ -1,16 +1,16 @@
-require 'data_mapper'
+require 'dm-core'
 require 'dm-aggregates'
 require 'merb_global/plural'
 
 module Merb
   module Global
-    module Providers
+    module MessageProviders
       class DataMapper #:nodoc: all
-        include Merb::Global::Provider
-        include Merb::Global::Provider::Importer
-        include Merb::Global::Provider::Exporter
-        
-        def translate_to(singular, plural, opts)
+        include Merb::Global::MessageProviders
+        include Merb::Global::MessageProviders::Base::Importer
+        include Merb::Global::MessageProviders::Base::Exporter
+
+        def localize(singular, plural, opts)
           # I hope it's from MemCache
           language = Language.first :name => opts[:lang]
           unless language.nil?
@@ -43,50 +43,54 @@ module Merb
           Language.first(:name.not => except).name
         end
 
-        def import(exporter, export_data)
+        def import
+          data = {}
           ::DataMapper::Transaction.new(Language, Translation) do
             Language.all.each do |language|
-              exporter.export_language export_data, language.name,
-                                       language.nplural,
-                                       language.plural do |lang|
-                language.translations.each do |translation|
-                  exporter.export_string lang, translation.msgid,
-                                               translation.msgid_plural,
-                                               translation.msgstr_index,
-                                               translation.msgstr
-                end
+              data[language.name] = lang_hash = {
+                :plural => language.plural,
+                :nplural => language.nplural
+              }
+              language.translations(:fields => Translation.properties.to_a).
+                       each do |translation|
+                lang_hash[translation.msgid] ||= {
+                  :plural => translation.msgid_plural
+                }
+                lang_hash[translation.msgid][translation.msgstr_index] =
+                  translation.msgstr
               end
             end
           end
+          data
         end
 
-        def export
+        def export(data)
           ::DataMapper::Transaction.new(Language, Translation) do
-            Language.all.each {|language| language.destroy}
             Translation.all.each {|translation| translation.destroy}
-            yield nil
+            Language.all.each {|language| language.destroy}
+            data.each do |lang_name, lang|
+              lang_obj = Language.create!(:name => lang_name,
+                                          :plural => lang[:plural],
+                                          :nplural => lang[:nplural])
+              lang.each do |msgid, msgstr_hash|
+                if msgstr_hash.is_a? Hash
+                  plural = msgstr_hash[:plural]
+                  msgstr_hash.each do |msgstr_index, msgstr|
+                    if msgstr_index.nil? or msgstr_index.is_a? Fixnum
+                      Translation.create!(:language_id => lang_obj.id,
+                                          :msgid => msgid,
+                                          :msgid_plural => plural,
+                                          :msgstr => msgstr,
+                                          :msgstr_index => msgstr_index) or
+                                                                          raise
+                    end
+                  end
+                end
+              end
+            end
           end
         end
 
-        def export_language(export_data, language, nplural, plural)
-          lang = Language.new :language => language, :nplural => nplural,
-                              :plural => plural
-          lang.save
-          raise if lang.new_record?
-          yield lang.id
-        end
-
-        def export_string(language_id, msgid, msgid_plural,
-                                       msgstr, msgstr_index)
-          trans = Translation.new :language_id => language_id,
-                                  :msgid => msgid,
-                                  :msgid_plural => msgid_plural,
-                                  :msgstr => msgstr,
-                                  :msgstr_index => msgstr_index
-          trans.save
-          raise if lang.new_record?
-        end
-
         # When table structure becomes stable it *should* be documented
         class Language
           include ::DataMapper::Resource
@@ -97,7 +101,7 @@ module Merb
           property :plural, Text, :lazy => false
           # validates_is_unique :name
           has n, :translations,
-            :class_name => "Merb::Global::Providers::DataMapper::Translation",
+            :class_name => "Merb::Global::MessageProviders::DataMapper::Translation",
             :child_key => [:language_id]
         end
 
@@ -105,12 +109,6 @@ module Merb
           include ::DataMapper::Resource
           storage_names[:default] = 'merb_global_translations'
           property :language_id, Integer, :nullable => false, :key => true
-          # Sould it be propery :msgid, :text?
-          # This form should be faster. However:
-          # - collision may appear (despite being unpropable)
-          # - it may be wrong optimalisation
-          # As far I'll leave it in this form. If anybody could measure the
-          # speed of both methods it will be appreciate.
           property :msgid, Text, :nullable => false, :key => true
           property :msgid_plural, Text, :lazy => true
           property :msgstr, Text, :nullable => false, :lazy => false