multi_formal_i18n_tenancy 0.0.2 → 0.0.3

data/README.rdoc

@@ -6,25 +6,22 @@ This gem extend the standard i18n backend (I18n::Backend::Simple) to introduce {
 
 <b>1 ) *_formal.yml</b>
 
-Given you want to offer your users the option to be addressed formally or informally through a session locale switch: 
+Given you want to offer your users the option to be addressed formally or informally through a {session locale switch}[http://https://github.com/Applicat/multi_formal_i18n_tenancy#Backend Locale Switch]: 
 
-  I18n.locale = :de # or :de_formal
+Then this is a {DRY}[http://en.wikipedia.org/wiki/Don%27t_repeat_yourself] solution for the workaround about having duplication of de locales in the de_formal namespace even though informal & formal translation are the same.
 
-So this is a {DRY}[http://en.wikipedia.org/wiki/Don%27t_repeat_yourself] solution for the workaround about having duplication of de locales in the de_formal namespace even though informal & formal translation are the same.
-
-This locale file owns all translations from its base *.yml and lets you override them through the same translation keys (except of the deviant locale namespaces de and de_formal at the beginning).
+This locale file will own all translations from its base *.yml and lets you override them through the same translation keys (except of the deviant locale namespaces de and de_formal at the beginning).
 
 <b>2 ) #{locales_path}/tenants/your_tenant_name/**/your_tenant_name.yml</b>
 
-Given you want to have tenant specific locales through a session locale switch:
-
-  # ('Your Tenant Name'.parameterize.gsub('-', '_') + '_de').to_sym == :your_tenant_name_de
-  I18n.locale :your_tenant_name_de # or :your_tenant_name_de_formal
+Given you want to have tenant specific locales through a {session locale switch}[http://https://github.com/Applicat/multi_formal_i18n_tenancy#Backend Locale Switch]:
 
 <b>Precondition:</b> Assure that you recursively add locale files to i18n's locale path e.g. through your Rails 3 application.rb:
 
   config.i18n.load_path += Dir[Rails.root.join('config', 'locales', '**', '*.{rb,yml}').to_s]
 
+You may like to enable multi tenancy for your rails application by deploying the repository branch on multiple servers each with a different tenant-specific application constants file to load by a config system like {rails_config}[https://github.com/railsjedi/rails_config] at initialization.  
+
 This locale file owns all translations from its base *.yml and optional *_formal.yml under #{locales_path}/tenants/your-tenant-name/ (recurively) and lets you override them through the same translation keys (except of the deviant locale namespaces de and de_formal at the beginning).
 
 == Installation
@@ -39,6 +36,55 @@ OPTIONAL: you have to manually set the i18n backend for your non-rails Ruby appl
 
   I18n.backend = MultiFormalI18nTenancy::Backend.new
   
+== Backend Locale Switch
+
+Available since version 0.0.3.
+
+<b>Initializer</b>
+
+To initialize the global default locale based on current configuration. 
+
+Put this file for instance under config/initializer/multi_tenancy.rb
+
+  I18n.locale = I18n.backend.available_locale(
+    formal: Settings.address_formally, tenant: Settings.tenant.name
+  )
+  
+Settings is a constant for your settings brought by most popular rack app config system: https://github.com/railsjedi/rails_config  
+
+  I18n.locale = I18n.backend.available_locale(formal: Settings.formal, tenant: Settings.tenant.name)
+  
+<b>Controller</b>  
+
+Dependency: https://github.com/iain/http_accept_language
+
+  class ApplicationController
+    AVAILABLE_LOCALES = %w{de en}
+    
+    before_filter :set_locale
+    
+    private
+    
+    def set_locale
+      if user_signed_in? 
+        # use of devise helper methods: user_signed_in?, current_user
+        I18n.locale = current_user.language # you have to add a language string column to your schema
+      else
+        locale = request.preferred_language_from AVAILABLE_LOCALES
+        locale ||= request.compatible_language_from AVAILABLE_LOCALES
+        locale ||= I18n.default_locale
+        
+        unless Settings.tenant.name == 'global'
+          locale = ("#{Settings.tenant.name}_#{locale}").to_sym
+        end
+      end
+      
+      I18n.locale = I18n.backend.available_locale(
+        base_locale: locale, formal: Settings.formal_address, tenant: Settings.tenant.name
+      )
+    end
+  end
+  
 == Compatibility
 
 Tested on MacOS with: Rails 3.1 & Ruby 1.9.2, Rails 3.2.6 & Ruby 1.9.3.

data/lib/multi_formal_i18n_tenancy/backend.rb

@@ -6,7 +6,7 @@ class MultiFormalI18nTenancy::Backend < I18n::Backend::Simple
   TENANT_LOCALE_PATTERN = /tenants$/
 
   attr_accessor :filenames
-
+ 
   # Accepts a list of paths to translation files. Loads translations from
   # plain Ruby (*.rb) or YAML files (*.yml). See #load_rb and #load_yml
   # for details.
@@ -64,7 +64,9 @@ class MultiFormalI18nTenancy::Backend < I18n::Backend::Simple
         base_locale.gsub!(FORMAL_LOCALE_PATTERN, '') 
       end
        
-      translations[locale] = (translations[base_locale.to_sym] || {}).clone
+      unless tenant && locale.to_s.match(FORMAL_LOCALE_PATTERN)
+        translations[locale] = (translations[base_locale.to_sym] || {}).clone
+      end
     else
       translations[locale] ||= {}
     end
@@ -74,6 +76,46 @@ class MultiFormalI18nTenancy::Backend < I18n::Backend::Simple
     translations[locale].deep_merge!(data)
   end
   
+  def available_locale(options = {})
+    options.assert_valid_keys(:base_locale, :formal, :tenant) if options.respond_to? :assert_valid_keys
+    
+    base_locale = options[:base_locale] || I18n.default_locale
+    formal = options[:formal] || false
+    tenant = (options[:tenant] || '').parameterize.gsub('-', '_')
+     
+    deepest_available_locale = nil
+    
+    # take last / deepest available locale of possible combinations
+    variant_index = -1
+    
+    [     
+      [
+        (formal && tenant), 
+        [tenant, base_locale, 'formal']
+      ],
+      [
+        formal && tenant && available_locales.include?([tenant, base_locale].join('_').to_sym) &&
+        available_locales.include?([base_locale, 'formal'].join('_').to_sym), 
+        [tenant, base_locale, 'formal']
+      ],    
+      [tenant, [tenant, base_locale]],
+      [formal, [base_locale, 'formal']],
+      [true, [base_locale]], 
+    ].each do |variant|
+      variant_index += 1
+      
+      next unless variant[0]
+
+      if available_locales.include?(variant[1].join('_').to_sym) || (variant_index == 1 && [tenant, base_locale, 'formal'] == variant[1])
+        deepest_available_locale = variant[1].join('_').to_sym
+      end
+            
+      break if deepest_available_locale
+    end
+    
+    deepest_available_locale || I18n.default_locale
+  end
+  
   private
   
   def tenant_from_locale?(locale)

data/lib/multi_formal_i18n_tenancy/version.rb

@@ -1,3 +1,3 @@
 module MultiFormalI18nTenancy
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/multi_formal_i18n_tenancy.rb

@@ -1,4 +1,4 @@
-require 'i18n'
+require 'active_support/core_ext/string/inflections'
 
 module MultiFormalI18nTenancy
 end

data/spec/fixtures/devise.de.yml

@@ -0,0 +1,4 @@
+de:
+  devise:
+    example: 'Dein Beispiel'
+    informal_example: 'Dein anderes Beispiel'

data/spec/fixtures/devise.de_formal.yml

@@ -0,0 +1,4 @@
+de_formal:
+  devise:
+    example: Ihr Beispiel
+    examples: Ihre Beispiele

data/spec/fixtures/en.yml

@@ -0,0 +1,2 @@
+en:
+  example: 'Dummy'

data/spec/fixtures/tenants/another_tenant_name/another_tenant_name_fr_formal.yml

@@ -0,0 +1,2 @@
+another_tenant_name_fr_formal:
+  formal_available: 'jamais vous'

data/spec/fixtures/tenants/your_tenant_name/devise.your_tenant_name_de_formal.yml

@@ -0,0 +1,3 @@
+your_tenant_name_de_formal:
+  devise:
+    example: Ihr formelles Beispiel

data/spec/fixtures/tenants/your_tenant_name/your_tenant_name_en.yml

@@ -0,0 +1,2 @@
+your_tenant_name_en:
+  example: 'Dummy change'

data/spec/lib/multi_formal_i18n_tenancy/backend_spec.rb

@@ -7,16 +7,17 @@ require 'multi_formal_i18n_tenancy'
 
 describe MultiFormalI18nTenancy::Backend do
   before :all do
-    I18n.backend = MultiFormalI18nTenancy::Backend.new
-    I18n.load_path = [
-      File.expand_path('../../../fixtures/de.yml', __FILE__),
-      File.expand_path('../../../fixtures/de_formal.yml', __FILE__),
-      File.expand_path('../../../fixtures/tenants/your_tenant_name/your_tenant_name_de.yml', __FILE__),
-      File.expand_path('../../../fixtures/tenants/your_tenant_name/your_tenant_name_de_formal.yml', __FILE__)
-    ]
+    I18n.default_locale = :de
+    I18n.locale = I18n.default_locale
   end
   
-  describe '.translate' do
+  describe '#load_translations' do
+    include_context :all_locale_file_constellations
+    
+    before :all do
+      I18n.backend = MultiFormalI18nTenancy::Backend.new
+    end
+    
     context 'default' do
       context 'formal translation available' do
         it 'returns the formal translation' do
@@ -52,6 +53,140 @@ describe MultiFormalI18nTenancy::Backend do
           I18n.t('formal_unavailable_again').should == 'Du auch wieder'
         end
       end
+      
+      context 'formal translation available for locale without base locale' do
+        it 'inits the locale without inheritation of unavailable base locale' do
+          I18n.locale = :another_tenant_name_fr_formal
+          I18n.t('formal_available').should == 'jamais vous'
+        end
+      end
+    end
+    
+    context 'locale files with more than 1 dot' do
+      it 'principally works' do
+        I18n.locale = :de
+        I18n.t('devise.example').should == 'Dein Beispiel' 
+        I18n.locale = :de_formal
+        I18n.t('devise.example').should == 'Ihr Beispiel'
+        I18n.locale = :your_tenant_name_de_formal
+        I18n.t('devise.informal_example').should == 'Dein anderes Beispiel' # devise.de.yml
+        I18n.t('devise.examples').should == 'Ihre Beispiele' # devise.de_formal.yml
+        I18n.t('devise.example').should == 'Ihr formelles Beispiel' # tenants/your_tenant_name/devise.your_tenant_name_de_formal.yml
+      end
+    end
+  end
+  
+  describe '.available_locale' do
+    context 'any locale' do
+      before :all do
+        I18n.load_path = [
+          File.expand_path('../../../fixtures/de.yml', __FILE__),
+          File.expand_path('../../../fixtures/en.yml', __FILE__)
+        ]
+      end
+      
+      # .available_locale any locale principally works
+      it 'principally works' do
+        I18n.backend = MultiFormalI18nTenancy::Backend.new
+        
+        [
+          [{}, :de], 
+          [{base_locale: :en}, :en], 
+          [{base_locale: :unavailable}, :de],
+          [{tenant: 'Your Tenant Name'}, :de],
+          [{formal: true, tenant: 'Your Tenant Name'}, :de],
+          [{formal: true, tenant: 'Unavailable Tenant Name'}, :de]
+        ].each do |variant|
+          actual = I18n.backend.available_locale(variant.first)
+          actual.should(
+            be(variant.last), 
+            "input #{variant.first.inspect} should result in the output: #{variant.last.inspect} but got #{actual.inspect}"
+          )
+        end
+      end
+    end
+    
+    context 'any formal locale' do
+      before :all do
+        I18n.load_path = [
+          File.expand_path('../../../fixtures/de.yml', __FILE__),
+          File.expand_path('../../../fixtures/de_formal.yml', __FILE__)
+        ]
+      end
+      
+      it 'principally works' do
+        I18n.backend = MultiFormalI18nTenancy::Backend.new
+        
+        [
+          [{formal: true}, :de_formal], 
+          [{formal: true, tenant: 'Your Tenant Name'}, :de_formal]
+        ].each do |variant|
+          actual = I18n.backend.available_locale(variant.first)
+          actual.should(
+            be(variant.last), 
+            "input #{variant.first.inspect} should result in the output: #{variant.last.inspect} but got #{actual.inspect}"
+          )
+        end
+      end
+    end
+    
+    context 'any formal locale plus tenant specific locale' do
+      before :all do
+        I18n.load_path = [
+          File.expand_path('../../../fixtures/de.yml', __FILE__),
+          File.expand_path('../../../fixtures/de_formal.yml', __FILE__),
+          File.expand_path('../../../fixtures/tenants/your_tenant_name/your_tenant_name_de.yml', __FILE__),
+          File.expand_path('../../../fixtures/tenants/your_tenant_name/your_tenant_name_en.yml', __FILE__)
+        ]
+      end
+      
+      it 'principally works' do
+        I18n.backend = MultiFormalI18nTenancy::Backend.new
+        
+        [
+          [{formal: true}, :de_formal], 
+          # should be :your_tenant_name_de_formal even though there is no :your_tenant_name_de_formal file 
+          # but the base file :de_formal to inherit from
+          [{formal: true, tenant: 'Your Tenant Name'}, :your_tenant_name_de_formal],
+          [{base_locale: :en, formal: true, tenant: 'Your Tenant Name'}, :your_tenant_name_en]
+        ].each do |variant|
+          actual = I18n.backend.available_locale(variant.first)
+          actual.should(
+            be(variant.last), 
+            "input #{variant.first.inspect} should result in the output: #{variant.last.inspect} but got #{actual.inspect}"
+          )
+        end
+      end
+    end
+    
+    context 'any formal tenant-specific locale' do
+      include_context :all_locale_file_constellations
+      
+      it 'principally works' do
+        I18n.backend = MultiFormalI18nTenancy::Backend.new
+      end
+    end 
+    
+    context 'tenant has special locale without an equivalent base locale' do
+      before :all do
+        I18n.load_path = [
+          File.expand_path('../../../fixtures/tenants/your_tenant_name/your_tenant_name_de_formal.yml', __FILE__)
+        ]
+      end
+      
+      it 'principally works' do
+        I18n.backend = MultiFormalI18nTenancy::Backend.new
+        
+        [
+          [{base_locale: :de, formal: true, tenant: 'Your Tenant Name'}, :your_tenant_name_de_formal]
+        ].each do |variant|
+          actual = I18n.backend.available_locale(variant.first)
+          actual.should(
+            be(variant.last), 
+            "input #{variant.first.inspect} should result in the output: #{variant.last.inspect} but got #{actual.inspect}"
+          )
+        end
+      end
     end
   end
 end

data/spec/support/shared_contexts/all_locale_file_constellations.rb

@@ -0,0 +1,14 @@
+shared_context :all_locale_file_constellations do
+  before :all do
+    I18n.load_path = [
+      File.expand_path('../../../fixtures/de.yml', __FILE__),
+      File.expand_path('../../../fixtures/de_formal.yml', __FILE__),
+      File.expand_path('../../../fixtures/tenants/your_tenant_name/your_tenant_name_de.yml', __FILE__),
+      File.expand_path('../../../fixtures/tenants/your_tenant_name/your_tenant_name_de_formal.yml', __FILE__),
+      File.expand_path('../../../fixtures/tenants/another_tenant_name/another_tenant_name_fr_formal.yml', __FILE__),
+      File.expand_path('../../../fixtures/devise.de.yml', __FILE__),
+      File.expand_path('../../../fixtures/devise.de_formal.yml', __FILE__),
+      File.expand_path('../../../fixtures/tenants/your_tenant_name/devise.your_tenant_name_de_formal.yml', __FILE__),
+    ]
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: multi_formal_i18n_tenancy
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-12 00:00:00.000000000 Z
+date: 2012-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: i18n
-  requirement: &70230785180340 !ruby/object:Gem::Requirement
+  name: activesupport
+  requirement: &70220249428440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70230785180340
+  version_requirements: *70220249428440
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70230785178460 !ruby/object:Gem::Requirement
+  requirement: &70220249426980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,7 +32,7 @@ dependencies:
         version: 2.11.0
   type: :development
   prerelease: false
-  version_requirements: *70230785178460
+  version_requirements: *70220249426980
 description: Your formal locales will inherit translations from their base locale
   and locales stored in an enterprise folder can override base + formal translations
 email:
@@ -50,11 +50,18 @@ files:
 - README.rdoc
 - spec/fixtures/de.yml
 - spec/fixtures/de_formal.yml
+- spec/fixtures/devise.de.yml
+- spec/fixtures/devise.de_formal.yml
+- spec/fixtures/en.yml
+- spec/fixtures/tenants/another_tenant_name/another_tenant_name_fr_formal.yml
+- spec/fixtures/tenants/your_tenant_name/devise.your_tenant_name_de_formal.yml
 - spec/fixtures/tenants/your_tenant_name/your_tenant_name_de.yml
 - spec/fixtures/tenants/your_tenant_name/your_tenant_name_de_formal.yml
+- spec/fixtures/tenants/your_tenant_name/your_tenant_name_en.yml
 - spec/lib/multi_formal_i18n_tenancy/backend_spec.rb
 - spec/spec_helper.rb
 - spec/support/deferred_garbage_collection.rb
+- spec/support/shared_contexts/all_locale_file_constellations.rb
 homepage: http://applicat.github.com/multi_formal_i18n_tenancy
 licenses: []
 post_install_message: 
@@ -69,7 +76,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2892429864419253687
+      hash: 2083026653359506385
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -78,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2892429864419253687
+      hash: 2083026653359506385
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.17
@@ -89,8 +96,15 @@ summary: Your formal locales will inherit translations from their base locale an
 test_files:
 - spec/fixtures/de.yml
 - spec/fixtures/de_formal.yml
+- spec/fixtures/devise.de.yml
+- spec/fixtures/devise.de_formal.yml
+- spec/fixtures/en.yml
+- spec/fixtures/tenants/another_tenant_name/another_tenant_name_fr_formal.yml
+- spec/fixtures/tenants/your_tenant_name/devise.your_tenant_name_de_formal.yml
 - spec/fixtures/tenants/your_tenant_name/your_tenant_name_de.yml
 - spec/fixtures/tenants/your_tenant_name/your_tenant_name_de_formal.yml
+- spec/fixtures/tenants/your_tenant_name/your_tenant_name_en.yml
 - spec/lib/multi_formal_i18n_tenancy/backend_spec.rb
 - spec/spec_helper.rb
 - spec/support/deferred_garbage_collection.rb
+- spec/support/shared_contexts/all_locale_file_constellations.rb