locale_detector 0.1.0 → 0.2.0

data/README.md

@@ -1,8 +1,10 @@
 # Locale Detector
 
 This Rails gem makes use of the HTTP_ACCEPT_LANGUAGE http header sent by web browsers with every request, to set the `I18n.locale` setting.
-When this fails (for example if there is no such http header - as is the case for Google bot), it will try to determine the locale based on the toplevel domain suffix (so it will set 'de' for the `example.de` domain).
-When both fail, it will fall back to the `LocaleDetector.fallback_locale`, which is 'en' by default and can be overriden in `config/initializers/locale_detector.rb`.
+
+When this fails (for example if there is no such http header - as is the case for Google bot), it will try to determine the locale based on the toplevel domain suffix (so it will set `'de'` for the `example.de` domain).
+
+When both fail, it will fall back to `I18n.default_locale`, which should be set in application’s `config/application.rb` file (and is `'en'` by default).
 
 The HTTP_ACCEPT_LANGUAGE header parser is based on:
 https://github.com/iain/http_accept_language/blob/master/lib/http_accept_language.rb
@@ -13,6 +15,17 @@ https://github.com/iain/http_accept_language/blob/master/lib/http_accept_languag
 Rails 3.0+
 
 
+## Example
+
+When this gem is installed and someone visits your application using a Polish version of Firefox the following http header will be sent:
+
+```
+HTTP_ACCEPT_LANGUAGE: pl,en-us;q=0.7,en;q=0.3
+```
+
+and the `I18n.locale` will be set to `'pl'`.
+
+
 ## Installation
 
 Install the gem
@@ -34,12 +47,5 @@ $ bundle
 ```
 
 
-You can optionally overwrite the default fallback locale by creating a `config/initializers/locale_detector.rb` file and set the `fallback_locale` to a new string, for example:
-
-```ruby
-LocaleDetector.fallback_locale = 'pl'
-```
-
-
 
 Copyright © 2011 Exvo.com Development BV, released under the MIT license

data/lib/locale_detector.rb

@@ -1,4 +1,3 @@
-require "locale_detector/fallback_locale"
 require "locale_detector/filter"
 require "locale_detector/version"
 

data/lib/locale_detector/filter.rb

@@ -18,28 +18,100 @@ module LocaleDetector
           y.last.to_f <=> x.last.to_f
         end.first.first.gsub(/-[a-z]+$/i, '').downcase
       rescue # rescue (anything) from the malformed (or missing) accept language headers
+        country_to_language(request.host.split('.').last)
+      end
+    end
+
+    # a somewhat incomplete list of toplevel domain suffix to language code mappings
+    def country_to_language(country_code)
+
+      # sources:
+      # http://en.wikipedia.org/wiki/List_of_Internet_top-level_domains
+      # http://www.w3.org/WAI/ER/IG/ert/iso639.htm
+      # http://msdn.microsoft.com/en-us/library/ms693062%28v=vs.85%29.aspx
+
+      # country_code => language_code
+      mappings = {
+        # English
+        :au => :en,
+        :ca => :en,
+        :eu => :en,
+        :ie => :en,
+        :nz => :en,
+        :sg => :en,
+        :uk => :en,
+        :us => :en,
+
+        # French
+        :cd => :fr,
+        :cg => :fr,
+        :cm => :fr,
+        :fr => :fr,
+        :mg => :fr,
 
-        # parse request.host and try to set the locale based on toplevel domain suffix (for netbots mostly)
-        suffix = request.host.split('.').last
-
-        # somewhat incomplete list of more common toplevel domains
-        if [:bg, :be, :cn, :cz, :da, :de, :es, :et, :fi, :fr, :gr, :hi, :hr, :hu, :is, :it, :jp, :ko, :lv, :lt,
-            :mk, :nl, :no, :pl, :pt, :ro, :ru, :se, :sr, :sk, :sl, :tr, :vi, :ua].include?(suffix.to_sym)
-          suffix
-        # some common international/English domains
-        elsif [:eu, :uk, :us].include?(suffix.to_sym)
-          'en'
-        # Spanish speaking countries
-        elsif [:ar, :cl, :co, :cu, :mx].include?(suffix.to_sym)
-          'es'
-        # Portuguese speaking countries
-        elsif suffix == 'br'
-          'pt'
-        # fall back to fallback_locale for .com and all other domains ('en' by default)
-        else
-          LocaleDetector.fallback_locale
-        end
+        # German
+        :at => :de,
+        :ch => :de,
+        :de => :de,
+        :li => :de,
+        :lu => :de,
+
+        # Portuguese
+        :ao => :pt,
+        :br => :pt,
+        :mz => :pt,
+        :pt => :pt,
+
+        # Spanish
+        :ar => :es,
+        :cl => :es,
+        :co => :es,
+        :cu => :es,
+        :es => :es,
+        :mx => :es,
+
+        # All other languages
+        :bg => :bg,
+        :by => :be,
+        :cn => :zh,
+        :cz => :cs,
+        :dk => :da,
+        :ee => :et,
+        :fi => :fi,
+        :gr => :el,
+        :hr => :hr,
+        :hu => :hu,
+        :il => :he,
+        :in => :hi,
+        :is => :is,
+        :it => :it,
+        :jp => :ja,
+        :kr => :ko,
+        :lt => :lt,
+        :lv => :lv,
+        :mn => :mn,
+        :nl => :nl,
+        :no => :no,
+        :pl => :pl,
+        :ro => :ro,
+        :rs => :sr,
+        :ru => :ru,
+        :se => :sv,
+        :si => :sl,
+        :sk => :sk,
+        :th => :th,
+        :tr => :tr,
+        :ua => :uk,
+        :vn => :vi,
+      }
+
+      if mappings.has_key?(country_code.to_sym)
+        mappings[country_code.to_sym].to_s
+      else
+        # fall back for all other missing mappings
+        I18n.default_locale.to_s
       end
+
     end
   end
 end

data/lib/locale_detector/version.rb

@@ -1,3 +1,3 @@
 module LocaleDetector
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/locale_detector.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["pawel.goscicki@gmail.com"]
   s.homepage    = "https://github.com/Exvo/locale_detector"
   s.summary     = "Rails gem setting the I18n.locale based on user's browser language"
-  s.description = "Parses HTTP_ACCEPT_LANGUAGE http header and sets the I18n.locale based on that"
+  s.description = "Parses HTTP_ACCEPT_LANGUAGE http header and sets the I18n.locale based on that, if it's missing it uses toplevel regional domain suffix or falls back to I18n.default_locale"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/locale_detector/filter_spec.rb

@@ -16,7 +16,6 @@ describe LocaleDetector::Filter do
   end
 
   context "http header locale setting" do
-
     specify { set_locale(:language => 'pl').should eql('pl') }
 
     specify { set_locale(:language => 'pl-PL').should eql('pl') }
@@ -26,11 +25,9 @@ describe LocaleDetector::Filter do
     specify { set_locale(:language => 'lt,en-us;q=0.8,en;q=0.6,ru;q=0.4,pl;q=0.2').should eql('lt') }
 
     specify { set_locale(:language => 'pl-PL;q=0.1,en-us;q=0.7,en;q=0.3').should eql('en') }
-
   end
 
   context "host based locale setting" do
-
     specify { set_locale(:host => 'example.pl').should eql('pl') }
 
     specify { set_locale(:host => 'example.co.uk').should eql('en') }
@@ -39,8 +36,17 @@ describe LocaleDetector::Filter do
 
     specify { set_locale(:host => 'example.br').should eql('pt') }
 
-    specify { set_locale(:host => 'example.com').should eql(LocaleDetector.fallback_locale) }
+    specify { set_locale(:host => 'example.jp').should eql('ja') }
+
+    specify { set_locale(:host => 'example.se').should eql('sv') }
+  end
+
+  context "default fallback" do
+    before do
+      I18n.default_locale = 'de'
+    end
 
+    specify { set_locale(:host => 'example.com').should eql('de') }
   end
 
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: locale_detector
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Pawe\xC5\x82 Go\xC5\x9Bcicki"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-09 00:00:00 +02:00
+date: 2011-08-11 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -112,7 +112,7 @@ dependencies:
         version: "2.6"
   type: :development
   version_requirements: *id006
-description: Parses HTTP_ACCEPT_LANGUAGE http header and sets the I18n.locale based on that
+description: Parses HTTP_ACCEPT_LANGUAGE http header and sets the I18n.locale based on that, if it's missing it uses toplevel regional domain suffix or falls back to I18n.default_locale
 email: 
 - pawel.goscicki@gmail.com
 executables: []
@@ -129,12 +129,10 @@ files:
 - README.md
 - Rakefile
 - lib/locale_detector.rb
-- lib/locale_detector/fallback_locale.rb
 - lib/locale_detector/filter.rb
 - lib/locale_detector/railtie.rb
 - lib/locale_detector/version.rb
 - locale_detector.gemspec
-- spec/locale_detector/fallback_locale_spec.rb
 - spec/locale_detector/filter_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true

data/lib/locale_detector/fallback_locale.rb

@@ -1,5 +0,0 @@
-module LocaleDetector
-  @@fallback_locale = 'en'
-
-  mattr_accessor :fallback_locale
-end

data/spec/locale_detector/fallback_locale_spec.rb

@@ -1,9 +0,0 @@
-require 'spec_helper'
-
-describe LocaleDetector do
-
-  subject { LocaleDetector.fallback_locale }
-
-  it { should_not be_empty }
-
-end