multi_formal_i18n_tenancy 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+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.rdoc

@@ -0,0 +1,63 @@
+= MultiFormalI18nTenancy {<img src="https://secure.travis-ci.org/Applicat/multi_formal_i18n_tenancy.png" />}[http://travis-ci.org/Applicat/multi_formal_i18n_tenancy] {<img src="https://codeclimate.com/badge.png" />}[https://codeclimate.com/github/Applicat/multi_formal_i18n_tenancy] {<img src="https://gemnasium.com/Applicat/multi_formal_i18n_tenancy.png?travis"/>}[https://gemnasium.com/Applicat/multi_formal_i18n_tenancy]
+
+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:
+
+<b>*_formal.yml</b>
+
+Given you want to offer your users the option to be addressed formally or informally through a session locale switch: 
+
+I18n.locale = :de # or :de_formal
+
+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).
+
+<b>#{locales_path}/tenants/your_tenant_name/**/your_tenant_name.yml</b>
+
+Given you want to have tenant specific locales through a session locale switch:
+
+I18n.locale :your_tenant_name_de # or :your_tenant_name_de_formal
+
+('Your Tenant Name'.parameterize.gsub('-', '_') + '_de').to_sym == :your_tenant_name_de
+
+<strong>Precondition:</strong> 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]
+
+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 "multi_formal_i18n_tenancy"
+  
+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 = MultiFormalI18nTenancy::Backend.new
+  
+== Wiki Docs
+
+* {Modules}[https://github.com/Applicat/multi_formal_i18n_tenancy/wiki/modules]
+
+== Compatibility
+
+Tested on MacOS with: Rails 3.1 & Ruby 1.9.2, Rails 3.2.6 & Ruby 1.9.3.
+
+= Future =
+
+* Support of more backends than only standard simple one
+
+== Contribution
+
+Just follow the screencast of Ryan Bates on railscasts.com: 
+
+  http://railscasts.com/episodes/300-contributing-to-open-source
+
+Add a description about your changes to CHANGELOG.md under section multi_formal_i18n_tenancy (unreleased).
+
+== License 
+
+This project uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,31 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new("spec")
+
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MultiFormalI18nTenancy'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+task :test => :spec

data/lib/multi_formal_i18n_tenancy.rb

@@ -0,0 +1,8 @@
+require 'i18n'
+
+require 'multi_formal_i18n_tenancy/backend'
+
+require 'multi_formal_i18n_tenancy/engine' if defined? Rails::Engine
+
+module MultiFormalI18nTenancy
+end

data/lib/multi_formal_i18n_tenancy/backend.rb

@@ -0,0 +1,91 @@
+class MultiFormalI18nTenancy::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
+    
+    [
+      # locale file groups order (ancestor chain)
+      #
+      # a) de > de_formal > your_enterprise_name_de > your_enterprise_name_de_formal
+      # b) de > your_enterprise_name_de
+      
+      # de
+      ->(f) { !f.match(FORMAL_FILENAME_PATTERN) && !f.match(TENANT_FILENAME_PATTERN) },
+      # de > your_enterprise_name_de
+      ->(f) { !f.match(FORMAL_FILENAME_PATTERN) && f.match(TENANT_FILENAME_PATTERN) },
+      # de > de_formal
+      ->(f) { f.match(FORMAL_FILENAME_PATTERN) && !f.match(TENANT_FILENAME_PATTERN) },
+      # de > de_formal > your_enterprise_name_de > your_enterprise_name_de_formal
+      ->(f) { f.match(FORMAL_FILENAME_PATTERN) && f.match(TENANT_FILENAME_PATTERN) }
+    ].each do |filename_filter|
+      filenames.flatten.select{|f| filename_filter.call(f) }.each { |filename| load_file(filename) }
+    end
+    
+    @filenames = [] # free memory
+  end
+      
+  # Stores translations for the given locale in memory.
+  # This uses a deep merge for the translations hash, so existing
+  # translations will be overwritten by new ones only at the deepest
+  # level of the hash.
+  def store_translations(locale, data, options = {})
+    locale = locale.to_sym
+    
+    # the has_key check assures that the inheritance will be performed for the first locale file
+    if (locale.to_s.match(FORMAL_LOCALE_PATTERN) || tenant_from_locale?(locale)) && !translations.has_key?(locale)
+      # inherit keys from base locale file
+      base_locale = locale.to_s
+      tenant = tenant_from_locale?(locale)
+      
+      if tenant && locale.to_s.match(FORMAL_LOCALE_PATTERN)
+        # de > de_formal
+        base_locale = locale.to_s.gsub(/^#{tenant}_/, '')
+        translations[locale] = (translations[base_locale.to_sym] || {}).clone
+        
+        # de_formal > your_enterprise_name_de
+        base_locale = locale.to_s.gsub(FORMAL_LOCALE_PATTERN, '') 
+        base_translations = (translations[base_locale.to_sym] || {}).clone.deep_symbolize_keys # deep_symbolize_keys?
+        translations[locale].deep_merge!(base_translations)
+      elsif tenant
+        base_locale.gsub!(/^#{tenant}_/, '')
+      else
+        base_locale.gsub!(FORMAL_LOCALE_PATTERN, '') 
+      end
+       
+      translations[locale] = (translations[base_locale.to_sym] || {}).clone
+    else
+      translations[locale] ||= {}
+    end
+    
+    data = data.deep_symbolize_keys
+    
+    translations[locale].deep_merge!(data)
+  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/lib/multi_formal_i18n_tenancy/engine.rb

@@ -0,0 +1,7 @@
+module RailsInfo
+  class Engine < ::Rails::Engine  
+    config.before_initialize do |app|
+      I18n.backend = MultiFormalI18nTenancy::Backend.new
+    end
+  end
+end

data/lib/multi_formal_i18n_tenancy/version.rb

@@ -0,0 +1,3 @@
+module MultiFormalI18nTenancy
+  VERSION = "0.0.1"
+end

data/spec/fixtures/de.yml

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

data/spec/fixtures/de_formal.yml

@@ -0,0 +1,2 @@
+de_formal:
+  formal_available: 'Sie'

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

@@ -0,0 +1,3 @@
+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

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

data/spec/lib/multi_formal_i18n_tenancy/backend_spec.rb

@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+# ruby gems
+require 'i18n'
+
+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__)
+    ]
+  end
+  
+  describe '.translate' do
+    context 'default' do
+      context 'formal translation available' do
+        it 'returns the formal translation' do
+          I18n.locale = :de
+          I18n.t('formal_available').should == 'Du'
+          I18n.locale = :de_formal
+          I18n.t('formal_available').should == 'Sie'
+        end
+      end
+      
+      context 'formal translation unavailable' do
+        it 'inerits the informal locales from :de' do
+          I18n.locale = :de_formal
+          I18n.t('formal_unavailable').should == 'Du'
+        end
+      end
+    end
+    
+    context 'tenant-specific' do
+      context 'formal translation available' do
+        it 'returns the formal translation' do
+          I18n.locale = :your_tenant_name_de
+          I18n.t('formal_available').should == 'Du auch'
+          I18n.locale = :your_tenant_name_de_formal
+          I18n.t('formal_available').should == 'Sie auch'
+        end
+      end
+      
+      context 'formal translation unavailable' do
+        it 'inerits the informal locales from :de and :your_tenant_name_de' do
+          I18n.locale = :your_tenant_name_de_formal
+          I18n.t('formal_unavailable').should == 'Du'
+          I18n.t('formal_unavailable_again').should == 'Du auch wieder'
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+unless defined? Rails
+  class Rails
+    def self.root
+      File.expand_path('dummy', __FILE__)
+    end
+    
+    def self.env
+      'test'
+    end
+  end
+end
+
+ENV["RAILS_ENV"] ||= 'test'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f }
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end
+
+# https://makandracards.com/makandra/950-speed-up-rspec-by-deferring-garbage-collection
+RSpec.configure do |config|
+  config.before(:all) do
+    DeferredGarbageCollection.start
+  end
+  config.after(:all) do
+    DeferredGarbageCollection.reconsider 
+  end
+end

data/spec/support/deferred_garbage_collection.rb

@@ -0,0 +1,43 @@
+# https://makandracards.com/makandra/950-speed-up-rspec-by-deferring-garbage-collection
+class DeferredGarbageCollection
+  DEFERRED_GC_THRESHOLD = (ENV['DEFER_GC'] || 10.0).to_f #used to be 10.0
+
+  @@last_gc_run = Time.now
+
+  def self.start
+    return if unsupported_enviroment
+    GC.disable if DEFERRED_GC_THRESHOLD > 0
+  end
+
+  def self.memory_threshold
+    @mem = %x(free 2>/dev/null).to_s.split(" ")
+    return nil if @mem.empty?
+    @mem[15].to_i / (@mem[7].to_i/100)
+  end
+
+  def self.reconsider
+    return if unsupported_enviroment
+
+    if (percent_used = self.memory_threshold)
+      running_out_of_memory = percent_used > 90
+
+      # just for info, as soon as we got some numbers remove it
+      swap_percent_used = @mem[19].to_i / (@mem[18].to_i/100) rescue 0
+      puts "percent memory used #{percent_used} (#{@mem[8]} of #{@mem[7]})"
+      puts "percent swap used   #{swap_percent_used} (#{@mem[19]} of #{@mem[18]})"
+    else
+      running_out_of_memory = false
+    end
+
+    if( (DEFERRED_GC_THRESHOLD > 0 && Time.now - @@last_gc_run >= DEFERRED_GC_THRESHOLD) || running_out_of_memory )
+      GC.enable
+      GC.start
+      GC.disable
+      @@last_gc_run = Time.now
+    end
+  end
+
+  def self.unsupported_enviroment
+    ENV['TRAVIS'] # TODO: enable for ruby 1.9.3 or more RAM
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: multi_formal_i18n_tenancy
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mathias Gawlista
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &70279376278580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70279376278580
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70279376293860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: *70279376293860
+description: Your formal locales will inherit translations from their base locale
+  and locales stored in an enterprise folder can override base + formal translations
+email:
+- gawlista@googlemail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/multi_formal_i18n_tenancy/backend.rb
+- lib/multi_formal_i18n_tenancy/engine.rb
+- lib/multi_formal_i18n_tenancy/version.rb
+- lib/multi_formal_i18n_tenancy.rb
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+- spec/fixtures/de.yml
+- spec/fixtures/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/lib/multi_formal_i18n_tenancy/backend_spec.rb
+- spec/spec_helper.rb
+- spec/support/deferred_garbage_collection.rb
+homepage: http://applicat.github.com/multi_formal_i18n_tenancy
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2196548884169363665
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2196548884169363665
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Your formal locales will inherit translations from their base locale and
+  locales stored in an enterprise folder can override base + formal translations
+test_files:
+- spec/fixtures/de.yml
+- spec/fixtures/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/lib/multi_formal_i18n_tenancy/backend_spec.rb
+- spec/spec_helper.rb
+- spec/support/deferred_garbage_collection.rb