i18n_multitenant 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb35d5985cf6d4869028f5370b636016011059be
-  data.tar.gz: b47174e2024be883a1a0b25a63c6678acb7af154
+  metadata.gz: 4554661f81cd76709a2fdd32fd9eefb348941870
+  data.tar.gz: dbc66eb9a981b1991c391d5d2ff3800abdf3467d
 SHA512:
-  metadata.gz: 80ccc546b9f990086bbabcf9213d0ec2d0a47afed41f7092b4a8572e44a889658a7cc31f2a6d1cdcca9e6b27e6119f1cc63053b2547b3b8e6e5dcacf684054e3
-  data.tar.gz: 849ea28b7d3fb78006cddbff7e4f6f53aeb1da8f5d551dc1f2c925d7f03c4f7598fc930011132c1473897b79170a62a68a7506221641313531668f09ca23d9b8
+  metadata.gz: fc570d3d1f4f828822721b3cb478408137e5ac6f804903e7da44a0190d29b48bb4d9ce4945f6cfc4c796c6bca7cb7088124241d652389d013ca2c32449af23f1
+  data.tar.gz: bef4b20e3361d1c6eb176e0f9898042fb159b0577713eddebbe9d755c16dc2c36e6f41624f9a11e044dd6f77116cfe0eea0c0a56d1a30c182fb7e6d5b66796f1

data/README.md

@@ -1,99 +1,59 @@
-# I18nMultitenant
+# i18n Multi-Tenant
 
-This gem extend the standard i18n backend (I18n::Backend::Simple) to introduce {Conventions over configuration}[http://en.wikipedia.org/wiki/Convention_over_configuration] about 2 new types of locale files.
-
-WARNING: Have to rethink parts of the implementation which seem to reimplement I18n::Backend::Fallbacks without this nice to have convention over configuration "algorithm".
-
-So you can also write this with a little help of i18n's basic fallback module (at bootstrap process):
+This gem is a small utility that provides the basic configuration to perform
+tenant-specific translations in multi-tenant apps.
 
+## Setting the locale
 ```ruby
-I18n::Backend::Simple.send(:include, I18n::Backend::Fallbacks)
-
-I18n.fallbacks[:es] = [:es]
-I18n.fallbacks[:tenant_name_es] = [:tenant_name_es, :es]
+I18nMultitenant.set(locale: :en, tenant: 'Tenant Name')
 ```
 
-This gem will just save you these lines through a convenient convention over configuration "algorithm".
-
-## Conventions
+## Locale files
 
-### *_formal.yml
+The library leverages the use of fallbacks, using the tenant name as a locale variant.
 
-Given you want to offer your users the option to be addressed formally or informally through a {session locale switch}[https://github.com/Applicat/i18n_multitenant#backend-locale-switch]:
+You can organize the files in nested folders as you find suitable, the only
+requirement is that the root of a translation file uses the following convention:
 
-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.
-
-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).
-
-### #{locales_path}/tenants/your_tenant_name/**/your_tenant_name.yml
+```yaml
+lang-TENANT_NAME:
+  ...
+```
 
-Given you want to have tenant specific locales through a {session locale switch}[https://github.com/Applicat/i18n_multitenant#backend-locale-switch]:
+For a few different examples, check out the [locale files used in tests](https://github.com/ElMassimo/i18n_multitenant/tree/master/spec/support/config), but here are few valid roots:
 
-<b>Precondition:</b> Assure that you recursively add locale files to i18n's locale path e.g. through your Rails 3 application.rb:
+```yaml
+en:
+en-US:
+en-US-TENANT_NAME:
+```
 
-  config.i18n.load_path +# Dir[Rails.root.join('config', 'locales', '**', '*.{rb,yml}').to_s]
+Any name can be passed through the `:tenant` option, and it will be normalized
+to be uppercase and not contain any hyphens, dots, or spaces.
 
-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.
+If you need to use names that are not be valid yml keys even after this process,
+you will need to sanitize the names yourself before handing them over to `set`.
 
-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
 
-Add this to your Gemfile and run the +bundle+ command.
-
-  gem "i18n_multitenant"
-
-The gem (# engine) will automatically set the backend for your Rails application.
-
-OPTIONAL: you have to manually set the i18n backend for your non-rails Ruby application:
-
-  I18n.backend # I18nMultitenant::Backend.new
-
-## Backend Locale Switch
-
-Available since version 0.0.3.
+Add this line to your application's Gemfile and run `bundle install`:
 
-<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}
+```ruby
+  gem 'i18n_multitenant'
+```
 
-    before_filter :set_locale
+Or install it yourself running:
 
-    private
+```sh
+gem install i18n_multitenant
+```
 
-    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
+## Configuration
 
-        unless Settings.tenant.name ## 'global'
-          locale # ("#{Settings.tenant.name.downcase.strip.tr(' ', '_')}_#{locale}").to_sym
-        end
-      end
+In Rails everything should be configured out of the box, but you can perform
+the configuration yourself in other applications by calling:
 
-      I18n.locale # I18n.backend.available_locale(
-        base_locale: locale, formal: Settings.formal_address, tenant: Settings.tenant.name
-      )
-    end
-  end
+```ruby
+I18nMultitenant.configure(I18n) # or pass I18n.config
+```

data/lib/i18n_multitenant/railtie.rb

@@ -1,6 +1,5 @@
 class I18nMultitenant::Railtie < ::Rails::Railtie
   config.before_initialize do |app|
-    I18n.config.enforce_available_locales = false
-    I18n.backend = I18nMultitenant::Backend.new
+    I18nMultitenant.configure(I18n)
   end
 end

data/lib/i18n_multitenant/version.rb

@@ -1,3 +1,3 @@
 module I18nMultitenant
-  VERSION = '0.0.0'
+  VERSION = '0.0.1'
 end

data/lib/i18n_multitenant.rb

@@ -1,3 +1,39 @@
-require 'i18n_multitenant/version'
-require 'i18n_multitenant/backend'
+require 'i18n'
+
+# frozen_string_literal: true
+module I18nMultitenant
+
+  # Public: Sets the internal locale to consider the current tenant and base locale.
+  #
+  # locale: The base locale to be set (optional: uses the default locale).
+  # tenant: Name of the current tenant (optional: does not scope to the tenant).
+  #
+  # Returns the key that should be used for all translations specific to that
+  # locale and tenant configuration.
+  #
+  # Example:
+  #   I18nMultitenant.set(locale: :en, tenant: 'Veridian Dynamics')
+  #   => "en-VERIDIAN_DYNAMICS"
+  #
+  #   I18nMultitenant.set(locale: 'en-GB', tenant: :'strange.tenant-name')
+  #   => "en-GB-STRANGE_TENANT_NAME"
+  #
+  #   I18nMultitenant.set(locale: :es)
+  #   => :es
+  def self.set(locale: I18n.default_locale, tenant: nil)
+    unless tenant.nil? || tenant.empty?
+      locale = "#{ locale }-#{ tenant.to_s.upcase.tr(' .-', '_') }"
+    end
+
+    I18n.locale = locale
+  end
+
+  # Public: Configures an instance of I18n::Config to ensure fallbacks are setup.
+  def self.configure(config, enforce_available_locales: false)
+    config.enforce_available_locales = enforce_available_locales
+    config.backend.class.send(:include, I18n::Backend::Fallbacks)
+    config.load_path += Dir[Rails.root.join('config', 'locales', '**', '*.{rb,yml}')]
+  end
+end
+
 require 'i18n_multitenant/railtie' if defined?(Rails::Railtie)

data/spec/lib/i18n_multitenant_spec.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+require 'spec_helper'
+
+def t(*args)
+  I18n.translate(*args)
+end
+
+RSpec.describe I18nMultitenant do
+  Given {
+    I18nMultitenant.configure(I18n, enforce_available_locales: true)
+  }
+
+  describe 'set' do
+    context 'setting only the locale' do
+      When(:result) { I18nMultitenant.set(locale: locale) }
+
+      context 'regular locale' do
+        Given(:locale) { :es }
+        Then { result == :es }
+        And  { I18n.locale == result }
+      end
+
+      context 'specific locale' do
+        Given(:locale) { 'en-GB' }
+        Then { result == 'en-GB' }
+        And  { I18n.locale == result.to_sym }
+      end
+
+      context 'non existing locale' do
+        Given(:locale) { 'en-US' }
+        Then { expect(result).to have_failed(I18n::InvalidLocale, /not a valid locale/) }
+      end
+    end
+
+    context 'setting only the tenant' do
+      When(:result) { I18nMultitenant.set(tenant: tenant) }
+      Invariant { I18n.locale == result.to_sym }
+
+      context 'regular tenant' do
+        Given(:tenant) { 'Free' }
+        Then { result == 'en-FREE' }
+      end
+
+      context 'weird casing tenant' do
+        Given(:tenant) { 'eNtErPrIsE' }
+        Then { result == 'en-ENTERPRISE' }
+      end
+
+      context 'non existing tenant' do
+        Given { I18n.enforce_available_locales = false }
+        Given(:tenant) { :'Strange.teNant-namE' }
+        Then { result == 'en-STRANGE_TENANT_NAME' }
+      end
+    end
+
+    context 'setting both' do
+      When(:result) { I18nMultitenant.set(locale: locale, tenant: tenant) }
+
+      context 'regular tenant and locale' do
+        Given(:locale) { :es }
+        Given(:tenant) { 'eNtErPrIsE' }
+        Then { result == 'es-ENTERPRISE' }
+        And { I18n.locale == result.to_sym }
+      end
+
+      context 'regular tenant and specific locale' do
+        Given(:locale) { 'en-US' }
+        Given(:tenant) { :free }
+        Then { result == 'en-US-FREE' }
+        And { I18n.locale == result.to_sym }
+      end
+
+      context 'non existing tenant/locale combination' do
+        Given(:locale) { 'en-US' }
+        Given(:tenant) { 'Enterprise' }
+        Then { expect(result).to have_failed(I18n::InvalidLocale, /"en-US-ENTERPRISE" is not a valid locale/) }
+      end
+    end
+  end
+
+  describe 'translation' do
+    context 'setting the locale directly' do
+      context 'english' do
+        When { I18n.locale = :en }
+        Then { t(:app_name) == 'I18n' }
+        And  { t(:greeting) == 'Welcome!' }
+        And  { t('simple_form.labels.user.name') == 'Name' }
+        And  { t('devise.failure.already_authenticated') == 'You are already signed in.' }
+      end
+
+      context 'spanish' do
+        When { I18n.locale = :es }
+        Then { t('app_name') == 'I18n' }
+        And  { t('greeting') == 'Bienvenido!' }
+        And  { t('simple_form.labels.user.name') == 'Nombre' }
+        And  { t('devise.failure.already_authenticated') == 'Ya has iniciado sesión.' }
+      end
+
+      context 'non-existing locale' do
+        When(:locale) { I18n.locale = 'en-US' }
+        Then { expect(locale).to have_failed(I18n::InvalidLocale, /not a valid locale/) }
+      end
+
+      context 'locale and tenant (internal representation)' do
+        When { I18n.locale = 'en-FREE' }
+        Then { t(:greeting) == 'Welcome!' }
+      end
+    end
+
+    context 'setting the locale and tenant' do
+      Given {
+        I18nMultitenant.set(tenant: tenant, locale: locale)
+      }
+
+      context 'english' do
+        Given(:locale) { :en }
+
+        context 'Free Tenant' do
+          Given(:tenant) { 'Free' }
+          Then { t(:app_name) == 'I18n (community edition)' }
+          And  { t(:greeting) == 'Welcome!' }
+          And  { t('simple_form.labels.user.name') == 'Name' }
+          And  { t('devise.failure.already_authenticated') == 'You are already signed in.' }
+        end
+
+        context 'Enterprise Tenant' do
+          Given(:tenant) { 'eNterPrise' }
+          Then { t(:app_name) == 'I18n Enterprise' }
+          And  { t(:greeting) == 'Welcome!' }
+          And  { t('simple_form.labels.user.name') == 'Name' }
+          And  { t('devise.failure.already_authenticated') == 'You are already signed in.' }
+        end
+      end
+
+      context 'spanish' do
+        Given(:locale) { :es }
+
+        context 'Free Tenant' do
+          Given(:tenant) { :free }
+          Then { t('app_name') == 'I18n (versión gratuita)' }
+          And  { t('greeting') == 'Bienvenido!' }
+          And  { t('simple_form.labels.user.name') == 'Nombre' }
+          And  { t('devise.failure.already_authenticated') == 'Ya iniciaste sesión.' }
+        end
+
+        context 'Enterprise Tenant' do
+          Given(:tenant) { :enterprise }
+          Then { t('app_name') == 'I18n PRO' }
+          And  { t('greeting') == 'Bienvenido!' }
+          And  { t('simple_form.labels.user.name') == 'Nombre y Apellido' }
+          And  { t('devise.failure.already_authenticated') == 'Ya has iniciado sesión.' }
+        end
+      end
+
+      context 'specific locale with tenant' do
+        Given(:locale) { 'en-US' }
+        Given(:tenant) { 'Free' }
+        Then { t(:app_name) == 'I18n (community edition)' }
+      end
+
+      context 'nil tenant' do
+        Given(:locale) { :en }
+        Given(:tenant) { nil }
+        Then { t(:greeting) == 'Welcome!' }
+      end
+
+      context 'empty tenant' do
+        Given(:locale) { :es }
+        Given(:tenant) { '' }
+        Then { t(:greeting) == 'Bienvenido!' }
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -6,6 +6,7 @@ end
 
 require 'rspec/given'
 require 'pry'
+require 'pathname'
 require 'i18n_multitenant'
 
 RSpec.configure do |config|
@@ -17,3 +18,9 @@ end
 Dir['./spec/support/**/*.rb'].each do |f|
   require f
 end
+
+module Rails
+  def self.root
+    Pathname.new('spec/support')
+  end
+end

data/spec/support/config/locales/devise.en.yml

@@ -0,0 +1,4 @@
+en:
+  devise:
+    failure:
+      already_authenticated: 'You are already signed in.'

data/spec/support/config/locales/devise.es.yml

@@ -0,0 +1,4 @@
+es:
+  devise:
+    failure:
+      already_authenticated: 'Ya has iniciado sesión.'

data/spec/support/config/locales/en-GB.yml

@@ -0,0 +1,2 @@
+en-GB:
+  greeting: 'Welcome! How do you do?'

data/spec/support/config/locales/en.yml

@@ -0,0 +1,3 @@
+en:
+  app_name: 'I18n'
+  greeting: 'Welcome!'

data/spec/support/config/locales/es.yml

@@ -0,0 +1,2 @@
+es:
+  greeting: 'Bienvenido!'

data/spec/support/config/locales/simple_form.en.yml

@@ -0,0 +1,5 @@
+en:
+  simple_form:
+    labels:
+      user:
+        name: 'Name'

data/spec/support/config/locales/simple_form.es.yml

@@ -0,0 +1,5 @@
+es:
+  simple_form:
+    labels:
+      user:
+        name: 'Nombre'

data/spec/support/config/locales/tenants/enterprise/en-ENTERPRISE.yml

@@ -0,0 +1,2 @@
+en-ENTERPRISE:
+  app_name: "I18n Enterprise"

data/spec/support/config/locales/tenants/enterprise/es-ENTERPRISE.yml

@@ -0,0 +1,2 @@
+es-ENTERPRISE:
+  app_name: "I18n PRO"

data/spec/support/config/locales/tenants/enterprise/simple_form.es-ENTERPRISE.yml

@@ -0,0 +1,5 @@
+es-ENTERPRISE:
+  simple_form:
+    labels:
+      user:
+        name: 'Nombre y Apellido'

data/spec/support/config/locales/tenants/free/devise.es-FREE.yml

@@ -0,0 +1,4 @@
+es-FREE:
+  devise:
+    failure:
+      already_authenticated: 'Ya iniciaste sesión.'

data/spec/support/config/locales/tenants/free/en-FREE.yml

@@ -0,0 +1,2 @@
+en-FREE:
+  app_name: 'I18n (community edition)'

data/spec/support/config/locales/tenants/free/en-US-FREE.yml

@@ -0,0 +1,2 @@
+en-US-FREE:
+  app_name: 'I18n (community edition)'

data/spec/support/config/locales/tenants/free/es-FREE.yml

@@ -0,0 +1,2 @@
+es-FREE:
+  app_name: "I18n (versión gratuita)"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n_multitenant
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-11 00:00:00.000000000 Z
+date: 2017-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: i18n
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.7'
 description: I18nMultitenant allows you to specify translations that are tenant-specific,
   falling back to the base locale.
 email:
@@ -37,22 +37,24 @@ files:
 - README.md
 - Rakefile
 - lib/i18n_multitenant.rb
-- lib/i18n_multitenant/backend.rb
 - lib/i18n_multitenant/railtie.rb
 - lib/i18n_multitenant/version.rb
-- 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/i18n_multitenant/backend_spec.rb
+- spec/lib/i18n_multitenant_spec.rb
 - spec/spec_helper.rb
-- spec/support/shared_contexts/all_locale_file_constellations.rb
+- spec/support/config/locales/devise.en.yml
+- spec/support/config/locales/devise.es.yml
+- spec/support/config/locales/en-GB.yml
+- spec/support/config/locales/en.yml
+- spec/support/config/locales/es.yml
+- spec/support/config/locales/simple_form.en.yml
+- spec/support/config/locales/simple_form.es.yml
+- spec/support/config/locales/tenants/enterprise/en-ENTERPRISE.yml
+- spec/support/config/locales/tenants/enterprise/es-ENTERPRISE.yml
+- spec/support/config/locales/tenants/enterprise/simple_form.es-ENTERPRISE.yml
+- spec/support/config/locales/tenants/free/devise.es-FREE.yml
+- spec/support/config/locales/tenants/free/en-FREE.yml
+- spec/support/config/locales/tenants/free/en-US-FREE.yml
+- spec/support/config/locales/tenants/free/es-FREE.yml
 homepage: https://github.com/ElMassimo/i18n_multitenant
 licenses:
 - MIT
@@ -66,7 +68,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -79,16 +81,19 @@ signing_key:
 specification_version: 4
 summary: Translation for multi-tenant applications.
 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/i18n_multitenant/backend_spec.rb
+- spec/lib/i18n_multitenant_spec.rb
 - spec/spec_helper.rb
-- spec/support/shared_contexts/all_locale_file_constellations.rb
+- spec/support/config/locales/devise.en.yml
+- spec/support/config/locales/devise.es.yml
+- spec/support/config/locales/en-GB.yml
+- spec/support/config/locales/en.yml
+- spec/support/config/locales/es.yml
+- spec/support/config/locales/simple_form.en.yml
+- spec/support/config/locales/simple_form.es.yml
+- spec/support/config/locales/tenants/enterprise/en-ENTERPRISE.yml
+- spec/support/config/locales/tenants/enterprise/es-ENTERPRISE.yml
+- spec/support/config/locales/tenants/enterprise/simple_form.es-ENTERPRISE.yml
+- spec/support/config/locales/tenants/free/devise.es-FREE.yml
+- spec/support/config/locales/tenants/free/en-FREE.yml
+- spec/support/config/locales/tenants/free/en-US-FREE.yml
+- spec/support/config/locales/tenants/free/es-FREE.yml

data/lib/i18n_multitenant/backend.rb

@@ -1,134 +0,0 @@
-require 'i18n'
-
-class I18nMultitenant::Backend < I18n::Backend::Simple
-  FORMAL_FILENAME_PATTERN = /_formal\.[a-zA-Z]+$/
-  FORMAL_LOCALE_PATTERN = /_formal$/
-
-  TENANT_FILENAME_PATTERN = /tenants/
-  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.
-  def load_translations(*filenames)
-    filenames = I18n.load_path if filenames.empty?
-
-    @filenames = filenames.flatten
-
-    @filenames.each { |filename| load_file(filename) }
-  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] || '').downcase.strip.tr(' ', '_')
-
-    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
-
-  protected
-
-  # Looks up a translation from the translations hash. Returns nil if
-  # eiher key is nil, or locale, scope or key do not exist as a key in the
-  # nested translations hash. Splits keys or scopes containing dots
-  # into multiple keys, i.e. <tt>currency.format</tt> is regarded the same as
-  # <tt>%w(currency format)</tt>.
-  def lookup(locale, key, scope = [], options = {})
-    init_translations unless initialized?
-
-    # only formal address: [:de, :de_formal]
-    # only multi tenancy: [:de, :tenant_name_de]
-    # formal address & multi tenancy: [:de, :tenant_name_de, :de_formal, :tenant_name_de_formal]
-
-    locales = []
-
-    base_locale = locale.to_s.gsub(FORMAL_LOCALE_PATTERN, '')
-
-    tenant = tenant_from_locale?(locale)
-    base_locale.gsub!(/^#{tenant}_/, '') if tenant
-
-    locales << base_locale.to_sym
-
-    if locale.to_s.match(FORMAL_LOCALE_PATTERN) && tenant && locale.to_s.match(/^#{tenant}_/)
-      locales << locale.to_s.gsub(FORMAL_LOCALE_PATTERN, '').to_sym
-      locales << locale.to_s.gsub(/^#{tenant}_/, '').to_sym
-    end
-
-    locales << locale unless locales.include?(locale)
-
-    entry, last_entry = nil, nil
-
-    locales.each do |locale|
-      keys = I18n.normalize_keys(locale, key, scope, options[:separator])
-
-      entry = keys.inject(translations) do |result, _key|
-        _key = _key.to_sym
-
-        unless result.is_a?(Hash) && result.has_key?(_key)
-          nil
-        else
-          result = result[_key]
-          result = resolve(locale, _key, result, options.merge(:scope => nil)) if result.is_a?(Symbol)
-          result
-        end
-      end
-
-      if entry.nil?
-        entry = last_entry
-      else
-        last_entry = entry
-      end
-    end
-
-    entry
-  end
-
-  private
-
-  def tenant_from_locale?(locale)
-    tenant = locale.to_s.gsub(FORMAL_LOCALE_PATTERN, '').split('_')
-
-    if tenant.length > 2
-      tenant.pop # pop languages like de
-      tenant = tenant.join('_')
-    else
-      tenant = nil
-    end
-
-    tenant && @filenames.select{|f| f.match("/tenants/#{tenant}/")}.any? ? tenant : nil
-  end
-end

data/spec/fixtures/de.yml

@@ -1,4 +0,0 @@
-de:
-  formal_available: 'Du'
-  formal_unavailable: 'Du'
-  de_formal_formal_available: 'Du'

data/spec/fixtures/de_formal.yml

@@ -1,3 +0,0 @@
-de_formal:
-  formal_available: 'Sie'
-  de_formal_formal_available: 'Sie'

data/spec/fixtures/devise.de.yml

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

data/spec/fixtures/devise.de_formal.yml

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

data/spec/fixtures/en.yml

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

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

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

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

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

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

@@ -1,3 +0,0 @@
-your_tenant_name_de:
-  formal_available: 'Du auch'
-  formal_unavailable_again: 'Du auch wieder'

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

@@ -1,2 +0,0 @@
-your_tenant_name_de_formal:
-  formal_available: 'Sie auch'

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

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

data/spec/lib/i18n_multitenant/backend_spec.rb

@@ -1,204 +0,0 @@
-require 'spec_helper'
-
-RSpec.describe I18nMultitenant::Backend do
-  before :all do
-    I18n.config.enforce_available_locales = false
-    I18n.default_locale = :de
-    I18n.locale = I18n.default_locale
-  end
-
-  describe '#lookup' do
-    include_context :all_locale_file_constellations
-
-    before :all do
-      I18n.backend = I18nMultitenant::Backend.new
-    end
-
-    context 'default' do
-      context 'formal translation available' do
-        context 'returns the translation' do
-          Given { I18n.locale = :de }
-          Then { I18n.t('formal_available') == 'Du' }
-          Then { I18n.t('de_formal_formal_available') == 'Du' }
-        end
-
-        context 'returns the formal translation' do
-          Given { I18n.locale = :de_formal }
-          Then { I18n.t('formal_available') == 'Sie' }
-          Then { I18n.t('de_formal_formal_available') == 'Sie' }
-        end
-      end
-
-      context 'formal translation unavailable' do
-        context 'inerits the informal locales from :de' do
-          Given { I18n.locale = :de_formal }
-          Then { I18n.t('formal_unavailable') == 'Du' }
-        end
-      end
-    end
-
-    context 'tenant-specific' do
-      context 'formal translation available' do
-        context 'returns the translation' do
-          Given { I18n.locale = :your_tenant_name_de }
-          Then { I18n.t('formal_available') == 'Du auch' }
-          Then { I18n.t('de_formal_formal_available') == 'Du' }
-        end
-
-        context 'returns the formal translation' do
-          Given { I18n.locale = :your_tenant_name_de_formal }
-          Then { I18n.t('formal_available') == 'Sie auch' }
-          Then { I18n.t('de_formal_formal_available') == 'Sie' }
-        end
-      end
-
-      context 'formal translation unavailable' do
-        context 'inerits the informal locales from :de and :your_tenant_name_de' do
-          Given { I18n.locale = :your_tenant_name_de_formal }
-          Then { I18n.t('formal_unavailable') == 'Du' }
-          Then { I18n.t('formal_unavailable_again') == 'Du auch wieder' }
-        end
-      end
-
-      context 'formal translation available for locale without base locale' do
-        context 'inits the locale without inheritation of unavailable base locale' do
-          Given { I18n.locale = :another_tenant_name_fr_formal }
-          Then { I18n.t('formal_available') == 'jamais vous' }
-        end
-      end
-    end
-
-    context 'locale files with more than 1 dot' do
-      context 'principally works' do
-        Given { I18n.locale = :de }
-        Then { I18n.t('devise.example') == 'Dein Beispiel' }
-      end
-
-      context 'principally works' do
-        Given { I18n.locale = :de_formal }
-        Then { I18n.t('devise.example') == 'Ihr Beispiel' }
-      end
-
-      context 'principally works tenant' do
-        Given { I18n.locale = :your_tenant_name_de_formal }
-        Then { I18n.t('devise.informal_example') == 'Dein anderes Beispiel' } # devise.de.yml
-        Then { I18n.t('devise.examples') == 'Ihre Beispiele' } # devise.de_formal.yml
-        Then { I18n.t('devise.example') == '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 = I18nMultitenant::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)
-          expect(actual).to(
-            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 = I18nMultitenant::Backend.new
-
-        [
-          [{formal: true}, :de_formal],
-          [{formal: true, tenant: 'Your Tenant Name'}, :de_formal]
-        ].each do |variant|
-          actual = I18n.backend.available_locale(variant.first)
-          expect(actual).to(
-            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 = I18nMultitenant::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)
-          expect(actual).to(
-            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 = I18nMultitenant::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 = I18nMultitenant::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)
-          expect(actual).to(
-            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

@@ -1,14 +0,0 @@
-RSpec.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