merb_global 0.0.1 → 0.0.2

data/HISTORY

@@ -0,0 +1,11 @@
+=== 0.0.2
+ * Added language customisation
+ * Support for auto-choose of language
+ * Support for DataMapper 0.9 (removed for 0.3)
+ * Developed examples
+ * Clean-up of code
+ * Minor other improvements
+
+=== 0.0.1
+ * Basic support for 'view' translation
+ * Auto-guess of language on base of Accept-Language header

data/LICENSE

@@ -1,4 +1,5 @@
-Copyright (c) 2008 Alex Coles, Ikonoklastik Productions
+Copyright (c) 2008  Alex Coles, Ikonoklastik Productions
+                    Maciej Piechotka
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -5,32 +5,30 @@ require 'spec/rake/spectask'
 
 PLUGIN = "merb_global"
 NAME = "merb_global"
-GEM_VERSION = "0.0.1"
-AUTHOR = "Alex Coles"
+GEM_VERSION = "0.0.2"
+AUTHORS = ["Alex Coles", "Maciej Piechotka"]
 EMAIL = "alex@alexcolesportfolio.com"
-HOMEPAGE = "http://github.com/myabc/merb_global/wikis"
+HOMEPAGE = "http://trac.ikonoklastik.com/merb_global/"
 SUMMARY = "Localization (L10n) and Internationalization (i18n) support for the Merb MVC Framework"
 
 spec = Gem::Specification.new do |s|
   s.name = NAME
   s.version = GEM_VERSION
   s.platform = Gem::Platform::RUBY
-  s.has_rdoc = true
-  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
   s.summary = SUMMARY
   s.description = s.summary
-  s.author = AUTHOR
+  s.authors = AUTHORS
   s.email = EMAIL
   s.homepage = HOMEPAGE
   s.add_dependency('merb-core', '>= 0.9.1')
   s.require_path = 'lib'
   s.autorequire = PLUGIN
-  s.files = %w(LICENSE README Rakefile TODO) +
+  s.files = %w(LICENSE README Rakefile TODO HISTORY) +
             Dir.glob("{lib,specs,*_generators}/**/*")
 
   # rdoc
   s.has_rdoc = true
-  s.extra_rdoc_files = %w( README LICENSE TODO )
+  s.extra_rdoc_files = %w(README LICENSE TODO HISTORY)
 end
 
 windows = (PLATFORM =~ /win32|cygwin/) rescue nil
@@ -54,7 +52,7 @@ end
 desc "Run all specs"
 Spec::Rake::SpecTask.new('specs') do |st|
   st.libs = ['lib', 'spec']
-  st.spec_files = FileList['spec/**/*.rb']
+  st.spec_files = FileList['spec/**/*_spec.rb']
   st.spec_opts = ['--format specdoc', '--color']
 end
 

data/activerecord_generators/translations_migration/translations_migration_generator.rb

@@ -1,9 +1,12 @@
 class TranslationMigrationGenerator < Merb::GeneratorBase
+  protected :banner
+
   def initialize runtime_args, runtime_options = {}
-    runtime_args.push ""
+    runtime_args.push ''
     super
     @name = 'translations'
   end
+
   def mainfest
     record do |m|
       m.directory 'schema/migrations'
@@ -11,14 +14,13 @@ class TranslationMigrationGenerator < Merb::GeneratorBase
         File.basename(f) =~ /^(\d+)/
         $1
       end.max
-      filename = format "%03d_%s", (highest_migration.to_i+1), @name.snake_case
-      m.template "translation_migration.erb",
+      filename = format '%03d_%s', (highest_migration.to_i+1), @name.snake_case
+      m.template 'translation_migration.erb',
                  "schema/migrations/#{filename}.rb"
       puts banner
     end
   end
 
-  protected :banner
   def banner
     <<-EOS
 A migration to add translation tables to your database has been created.

data/lib/merb_global/base.rb

@@ -1,3 +1,4 @@
+require 'merb_global/config'
 require 'merb_global/plural'
 require 'merb_global/provider'
 require 'merb_global/providers'
@@ -5,12 +6,15 @@ require 'merb_global/providers'
 module Merb
   module Global
     attr_accessor :lang, :provider
+
     def lang #:nodoc:
-      @lang ||= "en"
+      @lang ||= 'en'
     end
+
     def provider #:nodoc:
       @provider ||= Merb::Global::Providers.provider
     end
+
     # call-seq:
     #   _(singular, opts)          => translated
     #   _(singlular, plural, opts) => translated
@@ -29,12 +33,12 @@ module Merb
     # translated<String>:: A translated string
     #
     # ==== Example
-    # <tt>render _("%d file deleted", "%d files deleted", :n => del) % del</tt>
+    # <tt>render _('%d file deleted', '%d files deleted', :n => del) % del</tt>
     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], args[0], opts
+        self.provider.translate_to args[0], nil, opts
       elsif args.size == 2
         self.provider.translate_to args[0], args[1], opts
       else

data/lib/merb_global/config.rb

@@ -0,0 +1,29 @@
+module Merb
+  module Global
+    # call-seq:
+    #    config(key)                        => value
+    #    config([key1, key2, ...])          => value
+    #    config(key, default)               => value
+    #    config([key1, key2, ...], default) => value
+    #
+    # Lookup the configuration
+    # ==== Params
+    # key<Symbol>:: A key
+    # keys<Array[Symbol]>:: Keys
+    # default<Object>:: A default value
+    #
+    # ==== Returns
+    # value<Object>:: Object read from configuration or default
+    #
+    # ==== Examples
+    # <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]
+      while current.respond_to?(:[]) and not keys.empty?
+        current = current[keys.shift]
+      end
+      (keys.empty? and not current.nil?) ? current : default
+    end
+  end
+end

data/lib/merb_global/controller.rb

@@ -1,28 +1,51 @@
 require 'merb_global/base'
 
 module Merb
-  class Controller #:nodoc:
+  class Controller 
     include Merb::Global
+    class_inheritable_accessor :_language
+
     before do
+      # Set up the language
       accept_language = self.request.env['HTTP_ACCEPT_LANGUAGE']
-      self.lang = "en"
-      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.collect! do |lang|
-          if lang.size == 1
-            [lang[0], 1.0]
-          else
-            [lang[0], lang[1].to_f]
+      self.lang = params[:language] ||
+        (self._language && self._language.call) ||
+        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.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.reject! do |lang|
+              lang != '*' and not self.provider.support? lang
+            end
+            unless accept_language.empty?
+              unless accept_language.last == '*'
+                accept_language.last
+              else
+                accept_language.pop
+                self.provider.choose accept_language
+              end
+            end
           end
-        end
-        accept_language.sort! {|lang_a, lang_b| lang_a[1] <=> lang_b[1]}
-        accept_language.collect! {|lang| lang[0]}
-        accept_language.reject! {|lang| not self.provider.support? lang}
-        self.lang = accept_language.last unless accept_language.empty?
-      end
+        end || 'en'
+    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.language(&block)
+      self._language = block
     end
   end
 end

data/lib/merb_global/merbrake.rb

@@ -3,7 +3,7 @@ namespace :merb_global do
     Merb.start_environment :adapter => 'runner',
                            :environment => ENV['MERB_ENV'] || 'development'
   end
-  desc "create migration"
+  desc 'Create migration'
   task :migration => :merb_start do
     Merb::Global::Providers.provider.create!
   end

data/lib/merb_global/provider.rb

@@ -14,7 +14,7 @@ module Merb
       #
       # ==== Parameters
       # singular<String>:: A string to translate
-      # plural<String>:: A plural form of string
+      # plural<String>:: A plural form of string (nil if only singular)
       # opts<Hash>:: An options hash (see below)
       #
       # ==== Options (opts)
@@ -57,6 +57,13 @@ module Merb
       def create!
         raise NoMethodError.new('method create! has not been implemented')
       end
+      
+      # This method choos an supported language except those form the list
+      # given. It may fallback to english if none language can be found
+      # which agree with those criteria
+      def choose(except)
+        raise NoMethodError.new('method choose has not been implemented')
+      end
     end
   end
 end

data/lib/merb_global/providers/active_record.rb

@@ -19,12 +19,14 @@ module Merb
           end rescue nil
           return opts[:n] > 1 ? plural : singular # Fallback if not in database
         end
+
         def support?(lang)
           Language.count(:conditions => {:name => lang}) != 0
         end
+
         def create!
-          migration_exists = Dir[File.join(Merb.root,"schema",
-                                           "migrations", "*.rb")].detect do |f|
+          migration_exists = Dir[File.join(Merb.root, 'schema',
+                                           'migrations', '*.rb')].detect do |f|
             f =~ /translations\.rb/
           end
           if migration_exists
@@ -33,9 +35,24 @@ module Merb
             sh %{merb-gen translations_migration}
           end
         end
+
+        def choose(except)
+          if except.empty?
+            Language.find(:first).name
+          else
+            condition = 'name NOT IN (' + '?, ' * (except.length - 1) + '?)'
+            Language.find(:first, :conditions => [condition, *except]).name
+          end
+          # On #rubyonrails the following method was given. However I do not
+          # trust it. Please change if the validity is confirmed
+          # Language.find(:first, :conditions => ['name NOT IN ?',
+          #                                       "(#{except.join(',')})"])
+        end
+
         class Language < ::ActiveRecord::Base
           set_table_name :merb_global_languages
         end
+
         class Translation < ::ActiveRecord::Base
           set_table_name :merb_global_translations
           set_primary_keys :language_id, :msgid_hash, :msgstr_index

data/lib/merb_global/providers/data_mapper.rb

@@ -1,10 +1,11 @@
 require 'data_mapper'
+require 'dm-aggregates'
 require 'merb_global/plural'
 
 module Merb
   module Global
     module Providers
-      class DataMapper < Merb::Global::Provider #:nodoc: all
+      class DataMapper #:nodoc: all
         def translate_to(singular, plural, opts)
           # I hope it's from MemCache
           language = Language.first :name => opts[:lang]
@@ -18,32 +19,43 @@ module Merb
           # Fallback if not in database
           return opts[:n] != 1 ? plural : singular
         end
+
         def support?(lang)
-          Language.count(:name => lang) != 0
+          not Language.first(:name => lang).nil?
         end
+
         def create!
           Language.auto_migrate!
           Translation.auto_migrate!
         end
+
+        def choose(except)
+          Language.first(:name.not => except).name
+        end
+
         # When table structure becomes stable it *should* be documented
-        class Language < ::DataMapper::Base
-          set_table_name 'merb_global_languages'
-          property :name, :string, :index => true # It should be unique
-          property :plural, :text, :lazy => false
-          validates_uniqueness_of :name
+        class Language
+          include ::DataMapper::Resource
+          storage_names[:default] = 'merb_global_languages'
+          property :id, Integer, :serial => true
+          property :name, String, :index => :unique
+          property :plural, Text, :lazy => false
+          # validates_is_unique :name
         end
-        class Translation < ::DataMapper::Base
-          set_table_name 'merb_global_translations'
-          property :language_id, :integer, :nullable => false, :key => true
+
+        class Translation
+          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_hash, :integer, :nullable => false, :key => true
-          property :msgstr, :text, :nullable => false, :lazy => false
-          property :msgstr_index, :integer, :nullable => false, :key => true
+          property :msgid_hash, Integer, :nullable => false, :key => true
+          property :msgstr, Text, :nullable => false, :lazy => false
+          property :msgstr_index, Integer, :nullable => false, :key => true
           #belongs_to :language
         end
       end

data/lib/merb_global/providers/gettext.rb

@@ -15,20 +15,35 @@ module Merb
         def translate_to(singular, plural, opts)
           context = Thread.current.gettext_context
           context.set_locale opts[:lang], true
-          context.ngettext(singular, plural, opts[:n])
+          unless plural.nil?
+            context.ngettext singular, plural, opts[:n]
+          else
+            context.gettext singular
+          end
         end
+
         def support?(lang)
-          puts File.join(Merb::Global::Providers.localedir, lang)
-          File.exist? File.join(Merb::Global::Providers.localedir, lang)
+          lang == 'en' ||
+            File.exist?(File.join(Merb::Global::Providers.localedir, lang))
         end
+
         def create!
           File.mkdirs Merb::Global::Providers.localedir
         end
+
+        def choose(except)
+          dir = Dir[Merb::Global::Providers.localedir + '/*/']
+          dir.collect! {|p| File.basename p}
+          dir << 'en'
+          dir.reject! {|lang| except.include? lang}
+          dir.first
+        end
+
         class GettextContext
           include ::GetText
-          # Please change it to proper location
-          bindtextdomain "merbapp", Merb::Global::Providers.localedir
-          public :set_locale, :ngettext
+          bindtextdomain Merb::Global.config([:gettext, :domain], 'merbapp'),
+                         Merb::Global::Providers.localedir
+          public :set_locale, :ngettext, :gettext
         end
       end
     end

data/lib/merb_global/providers/mock.rb

@@ -5,12 +5,18 @@ module Merb
         def translate_to(singular, plural, opts)
           opts[:n] > 1 ? plural : singular
         end
+
         def support?(lang)
           true
         end
+
         def create!
           nil # It's mock after all ;)
         end
+
+        def choose
+          'en'
+        end
       end
     end
   end

data/lib/merb_global/providers/sequel.rb

@@ -8,18 +8,20 @@ module Merb
         def translate_to(singular, plural, opts)
           language = Language[:name => opts[:lang]] # I hope it's from MemCache
           unless language.nil?
-            n = Plural.which_form opts[:n], language.plural
+            n = Plural.which_form opts[:n], language[:plural]
             translation = Translation[language.pk, singular.hash, n]
-            return translation.msgstr unless translation.nil?
+            return translation[:msgstr] unless translation.nil?
           end
           return opts[:n] > 1 ? plural : singular # Fallback if not in database
         end
+
         def support?(lang)
           Language.filter(:name => lang).count != 0
         end
+
         def create!
-          migration_exists = Dir[File.join(Merb.root,"schema",
-                                           "migrations", "*.rb")].detect do |f|
+          migration_exists = Dir[File.join(Merb.root, 'schema',
+                                           'migrations', "*.rb")].detect do |f|
             f =~ /translations\.rb/
           end
           if migration_exists
@@ -28,8 +30,14 @@ module Merb
             sh %{merb-gen translations_migration}
           end
         end
+
+        def choose(except)
+          Language.filter {:name != except}.first[:name]
+        end
+
         class Language < ::Sequel::Model(:merb_global_languages)
         end
+
         class Translation < ::Sequel::Model(:merb_global_translations)
           set_primary_key :language_id, :msgid_hash, :msgstr_index
         end

data/lib/merb_global/providers/yaml.rb

@@ -10,6 +10,7 @@ module Merb
           # Shouldn't it be sort of cache with some expiration limit?
           @lang = Hash.new
         end
+
         def translate_to(singular, plural, opts)
           unless @lang.include? opts[:lang]
             file = File.join Merb::Global::Providers.localedir,
@@ -20,15 +21,21 @@ module Merb
               @lang[opts[:lang]] = nil
             end
           end
+
           unless @lang[opts[:lang]].nil?
             lang = @lang[opts[:lang]]
-            n = Merb::Global::Plural.which_form opts[:n], lang[:plural]
             unless lang[singular].nil?
-              return lang[singular][n] unless lang[singular][n].nil?
+              unless plural.nil?
+                n = Merb::Global::Plural.which_form opts[: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
         end
+
         def support?(lang)
           unless @lang.include? lang
             file = File.join Merb::Global::Providers.localedir, lang + '.yaml'
@@ -36,10 +43,18 @@ module Merb
           end
           not @lang[lang].nil?
         end
+
         def create!
           require 'ftools'
           File.mkdirs Merb::Global::Providers.localedir
         end
+
+        def choose(except)
+          dir = Dir[Merb::Global::Providers.localedir + '/*.yaml']
+          dir.collect! {|p| File.basename p, '.yaml'}
+          dir.reject! {|lang| except.include? lang}
+          dir.first
+        end
       end
     end
   end

data/lib/merb_global/providers.rb

@@ -1,6 +1,14 @@
 module Merb
   module Global
     module Providers
+      @@provider_name = lambda do
+          Merb::Global.config :provider, 'gettext'
+        end
+      @@provider_loading = lambda do |provider|
+        require 'merb_global/providers/' + provider
+        @@provider = eval "Merb::Global::Providers::#{provider.camel_case}.new"
+      end
+
       # call-seq:
       #     localedir => localdir
       #
@@ -10,33 +18,15 @@ module Merb
       # ==== Returns
       # localedir<String>>:: Directory where the locales are stored
       def self.localedir
-        localedir = nil
-        unless Merb::Plugins.config[:merb_global].nil?
-          if not Merb::Plugins.config[:merb_global][:localedir].nil?
-            localedir = Merb::Plugins.config[:merb_global][:localedir]
-          elsif Merb::Plugins.config[:merb_global][:flat]
-            localedir = 'locale'
+        localedir =
+          if Merb::Global.config :flat
+            'locale'
+          else
+            Merb::Global.config :localedir, File.join('app', 'locale')
           end
-        end
-        localedir ||= File.join('app', 'locale')
         File.join Merb.root, localedir
       end
-      # Is there a way to mark static methods as private?
-      @@provider_name = lambda do 
-        provider = 'gettext'
-        unless Merb::Plugins.config[:merb_global].nil?
-          unless Merb::Plugins.config[:merb_global][:provider].nil?
-            provider = Merb::Plugins.config[:merb_global][:provider].to_s
-          end
-        end
-        return provider
-      end
-      @@provider_loading = lambda do |provider|
-        # Should it be like that or should the provider be renamed?
-        require 'merb_global/providers/' + provider
-        @@provider = eval "Merb::Global::Providers::#{provider.camel_case}.new"
-      end
-      @@provider_loading.call @@provider_name.call
+
       # call-seq:
       #     provider => provider
       #
@@ -45,7 +35,7 @@ module Merb
       # ==== Returns
       # provider<Provider>:: Returns provider
       def self.provider
-        @@provider
+        @@provider ||= @@provider_loading.call @@provider_name.call
       end
     end
   end

data/lib/merb_global.rb

@@ -1,6 +1,8 @@
+require 'pathname'
+
 if defined? Merb::Plugins
-  require 'merb_global/base'
-  require 'merb_global/controller'
+  require Pathname(__FILE__).dirname.expand_path + 'merb_global/base'
+  require Pathname(__FILE__).dirname.expand_path + 'merb_global/controller'
 
   Merb::Plugins.add_rakefiles 'merb_global/rake'
 end

data/sequel_generators/translations_migration/translations_migration_generator.rb

@@ -1,9 +1,12 @@
 class TranslationMigrationGenerator < Merb::GeneratorBase
+  protected :banner
+
   def initialize runtime_args, runtime_options = {}
-    runtime_args.push ""
+    runtime_args.push ''
     super
     @name = 'translations'
   end
+
   def mainfest
     record do |m|
       m.directory 'schema/migrations'
@@ -12,17 +15,17 @@ class TranslationMigrationGenerator < Merb::GeneratorBase
         $1
       end.max
       filename = format "%03d_%s", (highest_migration.to_i+1), @name.snake_case
-      m.template "translation_migration.erb",
+      m.template 'translation_migration.erb',
                  "schema/migrations/#{filename}.rb"
       puts banner
     end
   end
 
-  protected :banner
   def banner
     <<-EOS
 A migration to add translation tables to your database has been created.
-Run 'rake sequel:db:migrate' to add the translations migration to your database.
+Run 'rake sequel:db:migrate' to add the translations migration to your
+database.
 
 EOS
   end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification 
 name: merb_global
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Alex Coles
+- Maciej Piechotka
 autorequire: merb_global
 bindir: bin
 cert_chain: []
 
-date: 2008-05-20 00:00:00 +02:00
+date: 2008-06-01 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,15 +32,18 @@ extra_rdoc_files:
 - README
 - LICENSE
 - TODO
+- HISTORY
 files: 
 - LICENSE
 - README
 - Rakefile
 - TODO
+- HISTORY
 - lib/merb_global
 - lib/merb_global/plural.rb
 - lib/merb_global/providers.rb
 - lib/merb_global/provider.rb
+- lib/merb_global/config.rb
 - lib/merb_global/controller.rb
 - lib/merb_global/base.rb
 - lib/merb_global/merbrake.rb
@@ -62,7 +66,7 @@ files:
 - activerecord_generators/translations_migration/templates
 - activerecord_generators/translations_migration/templates/translations_migration.erb
 has_rdoc: true
-homepage: http://github.com/myabc/merb_global/wikis
+homepage: http://trac.ikonoklastik.com/merb_global/
 post_install_message: 
 rdoc_options: []