emipair-merb_global 0.0.1

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+coverage
+doc
+log
+pkg
+pkg/*
+tmp/
+tmp/*
+*.db

data/CONTRIBUTORS

@@ -0,0 +1,6 @@
+Contributors
+============
+
+  * Alex Coles,        alex at alexcolesportfolio dot com
+  * Maciej Piechotka,  uzytkownik2 at gmail dot com
+  * Pavel Kunc

data/HISTORY

@@ -0,0 +1,34 @@
+=== 0.0.7
+ * More consistent configuration of supported languages
+ * JRuby Numeric provider
+ * Some small fixes
+
+=== 0.0.6
+ * Introduction of Locale object
+ * Change of MessageProviders interface
+ * Per-environment configuration
+
+=== 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)
+
+=== 0.0.3
+ * New Plural engine
+
+=== 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

@@ -0,0 +1,21 @@
+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
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,4 @@
+= merb_global
+== Localization (L10n) and Internationalization (i18n) support for the Merb MVC Framework
+
+Please see README.markdown.

data/README.markdown

@@ -0,0 +1,179 @@
+MerbGlobal README
+=================
+
+A plugin for the Merb framework providing Localization (L10n) and 
+Internationalization (i18n) support.
+ 
+merb\_global will have the following feature set:
+
+ * support for model (content) localization
+    - by default, localization stored in the database
+        - with DataMapper   (targeted 0.1)
+        - with ActiveRecord (targeted 0.2)
+        - with Sequel ORM   
+    - and, with a choice of strategies in each case:
+        - single-table  (c.f. globalize RoR plugin)
+        
+                |title   |varchar(100)|
+                |title_de|varchar(100)|
+                |title_fr|varchar(100)|
+                
+        - joined-table for unlimited localizations (c.f. Symfony PHP)
+    - or, alternatively localizations can be stored outside of the domain 
+      model, UI Strings.
+        
+ * support for view (UI String) localization
+    - choice of providers (po, yaml, database)
+        
+            Merb::Plugins.config[:merb_global] = {
+              #:message_provider => "po",   # default
+              :message_provider => 'yaml'
+              #:message_provider => active_record
+              #:message_provider => data_mapper
+              #:message_provider => sequel
+            }
+            
+    - for JRuby, wrapper allowing use of .properties files.
+    
+ * Extract, update for PO/POT files
+ * Currency, Date and Language Helpers
+        - stored either in the database, or for JRuby, wrappers around
+        built-in functionality provided by java.util.Currency, java.util.Locale
+        
+ * support for localization of Merb generated code
+ * support for non-English Inflectors.
+
+Developer ReadMe
+----------------
+
+**REQUEST** : Your development support is very much appreciated. Please 
+contact us below if you're interested in lending a hand with the development 
+of this project.
+
+Getting the Source
+------------------
+
+Performing a git clone on either of the following repositories will get you 
+the latest source:
+
+    git clone git://github.com/myabc/merb_global.git
+    git clone git://gitorious.org/merb_global/mainline.git (on gitorious)
+
+The following additional mirrors are available:
+
+    git://repo.or.cz/merb_global.git
+    http://repo.or.cz/r/merb_global.git
+
+Installation and Setup
+----------------------
+
+	Dependencies:
+	sudo gem install gettext
+	
+	Installing MerbGlobal
+    rake gem
+    sudo gem install pkg/merb_global-0.0.1.gem
+
+Configuration options
+---------------------
+
+MerbGlobal is possible to configure with:
+
+    Merb::Plugins.config[:merb_global] = {
+        :message_provider => 'gettext'
+        ...
+     }
+
+in init.rb or using plugins.yml file:
+
+    :merb_global:
+        :message_provider: gettext
+        ...
+
+Configuration options:
+ 
+ * :message_provider
+   
+   What message provider we want to use.
+
+   Values: gettext, yaml, sequel, active\_record, data\_mapper
+   Default: gettext
+
+ * :date_provider
+ 
+   What date provider we want to use.
+ 
+   Values: fork
+   Default: fork
+
+ * :numeric_providers
+
+   What numeric provider we want to use.
+
+   Values: fork
+   Default: fork
+
+ * :flat
+
+   Are we running merb-flat or normal merb?
+
+   Values: true/false
+   Default: false
+
+ * :localedir
+
+   Define directory where translations are stored.
+
+   If :flat is set to true than MerbGlobal will search in #{Merb.root}+'locale'. If :flat is false than in #{Merb.root}+:localedir. When :flat is false and :localedir configuration is not defined the default will be #{Merb.root}+'app/locale'.
+
+ * :gettext => :domain
+   
+   Name of the text domain. Which is basically name of the GetText MO file without .mo extension.
+
+   Default: merbapp
+
+##Configuration examples
+
+Follwing configuraiton in plugins.yml:
+
+    :merb_global:
+        :provider:  gettext
+        :flat:      false
+        :localedir: locale
+	:gettext:
+	    :domain:    messages
+
+will make MerbGlobal to search translations in following places:
+
+    #{Merb.root}/locale/#{language}/LC_MESSAGES/messages.mo
+    #{Merb.root}/locale/#{language}/messages.mo
+
+Where #{language} is string which defines language such as cs\_CZ, en\_GB or just cs, en.
+
+No configuration will look at:
+
+    #{Merb.root}/app/locale/#{language}/LC_MESSAGES/merbapp.mo
+    #{Merb.root}/app/locale/#{language}/merbapp.mo
+
+Licensing and Copyright
+-----------------------
+
+MerbGlobal is released under an **MIT License**. Copyright information, as 
+well as a copy of the License may be found in the LICENSE file.
+
+Support
+-------
+
+**WARNING REPEATED** : MerbGlobal at an early stage of its development. 
+You should not use this code unless you're reasonably secure with both Ruby 
+and Merb. That said, _please do get involved!_
+
+Your best sources for support are currently the wiki, IRC or our mailing
+list:
+
+ * **MerbGlobal Wiki**:         <http://trac.ikonoklastik.com/merb_global/>
+ * **MerbGlobal mailing list**: <http://groups.google.com/group/merb_global>
+ * **MerbGlobal homepage**: _coming soon_
+ * Contact the developers directly:
+    - <alex@alexcolesportfolio.com> | myabc on #datamapper, #merb IRC
+    - <uzytkownik2@gmail.com> | <xmpp:uzytkownik@jid.pl>

data/Rakefile

@@ -0,0 +1,65 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+
+PLUGIN = "emipair-merb_global"
+NAME = "emipair-merb_global"
+GEM_VERSION = "0.0.7"
+AUTHORS = ["Matt Kent", "Ryan Dy"]
+EMAIL = "eng@emimusic.com"
+HOMEPAGE = "http://trac.ikonoklastik.com/merb_global/"
+SUMMARY = "Localization (L10n) and Internationalization (i18n) support for the Merb MVC Framework"
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = NAME
+    gemspec.summary = SUMMARY
+    gemspec.description = gemspec.summary
+    gemspec.email = EMAIL
+    gemspec.homepage = HOMEPAGE
+    gemspec.authors = AUTHORS
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+desc "Install merb_global"
+task :install => [:package] do
+  sh %{gem install pkg/#{NAME}-#{GEM_VERSION}}
+end
+
+Rake::RDocTask.new do |rd|
+  rd.rdoc_dir = "doc"
+  rd.rdoc_files.include "lib/**/*.rb"
+end
+
+desc "Creates database for examples"
+task :populate_db do
+  require 'fileutils'
+  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 "pkg/#{NAME}-#{GEM_VERSION}" => [:populate_db]
+
+require 'spec/rake/spectask'
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new('specs') do |st|
+  st.libs = ['lib', 'spec']
+  st.spec_files = FileList['spec/**/*_spec.rb']
+  st.spec_opts = ['--format specdoc', '--color']
+end
+
+desc "Run rcov"
+Spec::Rake::SpecTask.new('rcov') do |rct|
+  rct.libs = ['lib', 'spec']
+  rct.rcov = true
+  rct.rcov_opts = ['-x gems', '-x usr', '-x spec']
+  rct.spec_files = FileList['spec/**/*.rb']
+  rct.spec_opts = ['--format specdoc', '--color']
+end

data/TODO

@@ -0,0 +1,4 @@
+= TODO
+
+Please see http://trac.ikonoklastik.com/merb_global/ for the MerbGlobal issue
+tracker.

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/activerecord_generators/translations_migration/USAGE

@@ -0,0 +1,4 @@
+Description:
+
+
+Usage:

data/activerecord_generators/translations_migration/templates/translations_migration.erb

@@ -0,0 +1,30 @@
+#<% if false %>
+class Merb::Global::MessageProviders::ActiveRecord
+#<% end %>
+class AddTranslationsMigration < ActiveRecord::Migration
+  def self.up
+    create_table :merb_global_languages do |t|
+      t.string	  :name,         :limit => 16
+      t.integer	  :nplural
+      t.string    :plural,       :size => 128
+    end
+    add_index :merb_global_languages, :name, :unique => true
+    create_table :merb_global_translations,
+                 :id => false, :primary_key => [:language_id,
+                                                :msgid_hash,
+                                                :msgstr_index] do |t|
+      t.integer   :language_id,  :null => false
+      t.text      :msgid,        :null => false
+      t.text      :msgid_plural
+      t.text	  :msgstr,	 :null => false
+      t.integer   :msgstr_index, :null => true
+    end
+  end
+  def self.down
+    drop_table :merb_global_languages
+    drop_table :merb_global_translations
+  end
+end
+#<% if false %>
+end
+#<% end %>

data/activerecord_generators/translations_migration/translations_migration_generator.rb

@@ -0,0 +1,31 @@
+class TranslationMigrationGenerator < Merb::GeneratorBase
+  protected :banner
+
+  def initialize runtime_args, runtime_options = {}
+    runtime_args.push ''
+    super
+    @name = 'translations'
+  end
+
+  def mainfest
+    record do |m|
+      m.directory 'schema/migrations'
+      highest_migration = Dir[Dir.pwd+'/schema/migrations/*'].map do |f|
+        File.basename(f) =~ /^(\d+)/
+        $1
+      end.max
+      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
+
+  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.
+
+EOS
+  end
+end

data/benchmarks/database1.rb

@@ -0,0 +1,174 @@
+require 'sequel'
+require 'benchmark'
+
+DB = Sequel.connect ARGV[0]
+
+DB.create_table! :languages1 do
+  primary_key :id
+  varchar  :name,         :size => 16,           :unique => true
+  varchar  :plural,       :size => 128
+end
+
+DB.create_table! :translations1 do
+  primary_key [:language_id, :msgid_hash, :msgstr_index]
+  foreign_key :language_id, :languages1, :null => false
+  integer     :msgid_hash,   :null => false
+  text        :msgstr,       :null => false
+  integer     :msgstr_index
+end
+
+DB.create_table! :languages2 do
+  primary_key :id
+  varchar  :name,         :size => 16,           :unique => true
+  varchar  :plural,       :size => 128
+end
+
+DB.create_table! :translations2 do
+  primary_key [:language_id, :msgid, :msgstr_index]
+  foreign_key :language_id, :languages2, :null => false
+  text        :msgid,        :null => false
+  text        :msgstr,       :null => false
+  integer     :msgstr_index
+end
+
+DB.create_table! :languages3 do
+  primary_key :id
+  varchar  :name,         :size => 16,           :unique => true
+  varchar  :plural,       :size => 128
+end
+
+drop_table :original3 rescue nil
+DB << "CREATE TABLE original3 (id INTEGER PRIMARY KEY, msgid TEXT)"
+
+DB.create_table! :translations3 do
+  primary_key [:language_id, :original_id, :msgstr_index]
+  foreign_key :language_id, :languages3, :null => false
+  foreign_key :original_id, :original3, :null => false
+  text        :msgstr,       :null => false
+  integer     :msgstr_index
+end
+
+$chars = ('a'..'z').to_a + ('A'..'Z').to_a + ('0'..'9').to_a
+def rand_string size
+  (0...size).collect { $chars[Kernel.rand($chars.length)] }.join
+end
+
+$original = []
+128.times { $original << rand_string(32) }
+$original.sort!.uniq!
+$translations = {}
+$plurals = {}
+3.times do
+  lang_name = rand_string(2)
+  $translations[lang_name] = lang = {}
+  $plurals[lang_name] = rand_string(8)
+  $original.each do |orig|
+    lang[orig] = rand_string(32)
+  end
+end
+
+$languages = $plurals.keys
+def rand_language
+  $languages[Kernel.rand($languages.length)]
+end
+
+def rand_original
+  $original[Kernel.rand($original.length)]
+end
+
+puts 'Export'
+Benchmark.bm(22) do |bm|
+  bm.report('Original 0.0.3:') do
+    $translations.each do |lang, trans|
+      lang_id = (DB[:languages1] << {:name => lang, :plural => $plurals[lang]})
+      trans.each do |original, translation|
+        DB[:translations1] << {
+          :language_id => lang_id,
+          :msgid_hash => original.hash,
+          :msgstr => translation
+        }
+      end
+    end
+  end
+  bm.report('With string inside:') do
+    $translations.each do |lang, trans|
+      lang_id = (DB[:languages2] << {:name => lang, :plural => $plurals[lang]})
+      trans.each do |original, translation|
+        DB[:translations2] << {
+          :language_id => lang_id,
+          :msgid => original,
+          :msgstr => translation
+        }
+      end
+    end
+  end
+  bm.report('With separate strings:') do
+    $original.each do |original|
+      DB[:original3] << {:id => original.hash, :msgid => original}
+    end
+    $translations.each do |lang, trans|
+      lang_id = (DB[:languages3] << {:name => lang, :plural => $plurals[lang]})
+      trans.each do |original, translation|
+        DB[:translations3] << {
+          :language_id => lang_id,
+          :original_id => original.hash,
+          :msgstr => translation
+        }
+      end
+    end
+  end
+end
+
+$search = (0...1024).collect {[rand_language, rand_original]}
+
+puts ''
+puts 'Searching'
+Benchmark.bm(22) do |bm|
+  bm.report('Original 0.0.3:') do
+    $search.each do |arr|
+      _lang, _orig = *arr
+      lang = DB[:languages1].filter(:name => _lang).first[:id]
+      trans = DB[:translations1].filter(:language_id => lang,
+                                        :msgid_hash => _orig.hash,
+                                        :msgstr_index => nil).first[:msgstr]
+    end
+  end
+  bm.report('With string inside:') do
+    $search.each do |arr|
+      _lang, _orig = *arr
+      lang = DB[:languages2].filter(:name => _lang).first[:id]
+      trans = DB[:translations2].filter(:language_id => lang,
+                                        :msgid => _orig,
+                                        :msgstr_index => nil).first[:msgstr]
+    end
+  end
+  bm.report('With separate strings:') do
+    $search.each do |arr|
+      _lang, _orig = *arr
+      lang = DB[:languages3].filter(:name => _lang).first[:id]
+      trans = DB[:translations3].filter(:language_id => lang,
+                                        :original_id => _orig.hash,
+                                        :msgstr_index => nil).first[:msgstr]
+    end
+  end
+end
+
+puts ''
+puts 'Import'
+Benchmark.bm(22) do |bm|
+  bm.report('With string inside:') do
+    DB[:languages2].each do |lang|
+      DB[:translations2].each do |trans|
+        [lang[:name], trans[:msgid], trans[:msgstr], trans[:msgstr_index]]
+      end
+    end
+  end
+  bm.report('With separate strings:') do
+    DB[:languages3].each do |lang|
+      DB[:translations3].each do |trans|
+        orig = DB[:original3].filter(:id => trans[:original_id]).first[:msgid]
+        [lang[:name], orig, trans[:msgstr], trans[:msgstr_index]]
+      end
+    end
+  end
+end

data/examples/active_record_example/README.txt

@@ -0,0 +1,9 @@
+Merb Flat
+==============
+
+An example of a small Merb application. Uses a single views directory and one
+controller file.
+
+Start with
+
+  merb

data/examples/active_record_example/application.rb

@@ -0,0 +1,5 @@
+class ActiveRecordExample < Merb::Controller
+  def index
+    _('Hi! Hello world!')
+  end
+end

data/examples/active_record_example/config/database.yml

@@ -0,0 +1,9 @@
+:development: &defaults
+  :adapter: sqlite3
+  :database: database.db
+
+:test:
+  <<: *defaults
+
+:production:
+  <<: *defaults

data/examples/active_record_example/config/framework.rb

@@ -0,0 +1,5 @@
+Merb::Config[:framework] = {
+  :application => 'application.rb',
+  :view => 'views',
+  :config => 'config'
+}

data/examples/active_record_example/config/init.rb

@@ -0,0 +1,24 @@
+# Load the merb_global from current tree
+Gem.clear_paths
+Gem.path.unshift((Pathname(__FILE__).dirname + '../../../pkg').expand_path)
+$LOAD_PATH.unshift((Pathname(__FILE__).dirname + '../../../lib').expand_path)
+
+Merb::Router.prepare do |r|
+  r.match('/').to(:controller => 'active_record_example', :action =>'index')
+end
+
+use_orm :activerecord
+dependency 'merb_global'
+
+Merb::Config.use { |c|
+  c[:environment]         = 'production',
+  c[:framework]           = {},
+  c[:log_level]           = 'debug',
+  c[:use_mutex]           = false,
+  c[:session_store]       = 'cookie',
+  c[:session_id_key]      = '_session_id',
+  c[:session_secret_key]  = '779c710d6a7b90faf17cba97c156fc133a9884c9',
+  c[:exception_details]   = true,
+  c[:reload_classes]      = true,
+  c[:reload_time]         = 0.5
+}

data/examples/active_record_example/config/plugins.yml

@@ -0,0 +1,3 @@
+:merb_global:
+  :message_provider: active_record
+  :locales: ['en', 'pl']

data/examples/data_mapper_example/README.txt

@@ -0,0 +1,9 @@
+Merb Flat
+==============
+
+An example of a small Merb application. Uses a single views directory and one
+controller file.
+
+Start with
+
+  merb

data/examples/data_mapper_example/application.rb

@@ -0,0 +1,5 @@
+class DataMapperExample < Merb::Controller
+  def index
+    _('Hi! Hello world!')
+  end
+end

data/examples/data_mapper_example/config/database.yml

@@ -0,0 +1,9 @@
+:development: &defaults
+  :adapter: sqlite3
+  :database: database.db
+
+:test:
+  <<: *defaults
+
+:production:
+  <<: *defaults

data/examples/data_mapper_example/config/framework.rb

@@ -0,0 +1,5 @@
+Merb::Config[:framework] = {
+  :application => 'application.rb',
+  :view => 'views',
+  :config => 'config'
+}