rack-i18n_locale_switcher 0.1.0 → 0.2.0

data/CHANGELOG

@@ -1,2 +1,5 @@
+= 0.2.0 / 2011-11-24
+  Better test coverage
+
 = 0.1.0 / 2011-11-24
   Initial Version

data/Rakefile

@@ -2,7 +2,7 @@
 require 'rake'
 require 'echoe'
 
-Echoe.new('rack-i18n_locale_switcher', '0.1.0') do |p|
+Echoe.new('rack-i18n_locale_switcher', '0.2.0') do |p|
 
  p.description     = "Detects the current locale from url, domain, parameter, session or accept header."
  p.url             = "http://github.com/christoph-buente/rack-i18n_locale_switcher"
@@ -20,7 +20,7 @@ Echoe.new('rack-i18n_locale_switcher', '0.1.0') do |p|
    *.tmproj
  }
 
- p.runtime_dependencies     = [ "rack", "i18n" ]
+ p.runtime_dependencies     = [ "rack", "i18n", "domainatrix" ]
  p.development_dependencies = [ "echoe", "rspec", "rack-test" ]
 end
 

data/lib/rack/i18n_locale_switcher.rb

@@ -1,4 +1,6 @@
 require 'i18n'
+require 'domainatrix'
+
 module Rack
   class I18nLocaleSwitcher
     def initialize(app, options = {})
@@ -6,24 +8,11 @@ module Rack
     end
 
     def call(env)
-      request = Rack::Request.new env
+      request = Rack::Request.new(env)
 
       session = request.session
-      locale = extract_locale_from_path_or_params(request)
-
-      if locale == I18n.default_locale
-        session["locale"] = locale
-        path = request.fullpath.gsub(/\/#{locale}\b/, '')
-        # ignore paths given with except option
-        unless request.fullpath =~ %r{/tolk/|/api/}
-          return [ 302, {'Location'=> "#{request.scheme}://#{request.host_with_port}#{path}" }, [] ]
-        end
-      end
-
-      session["locale"] = locale if is_present?(locale)
-      session["locale"] = first_http_accept_language(env) unless is_present?(session["locale"])
-
-      I18n.locale = session["locale"]
+      locale = extract_locale(request)
+      I18n.locale = session["locale"] = (is_present?(locale) ? locale : I18n.default_locale)
 
       @app.call cleanup_env(env)
     end
@@ -45,39 +34,62 @@ module Rack
       end
     end
 
-    def extract_locale_from_path_or_params(request)
-      symbolize_locale( extract_locale_from_path(request) || extract_locale_from_params(request) )
+    def extract_locale_from_tld(request)
+      locale = Domainatrix.parse(request.url).public_suffix rescue nil
+      locale if is_available?(locale)
     end
 
-    def cleanup_env env
-      %w{REQUEST_URI REQUEST_PATH PATH_INFO}.each do |key|
-        if is_present?(env[key]) && env[key].length > 1 && tmp = env[key].split("/")
-          tmp.delete_at(1) if tmp[1] =~ %r{^([a-zA-Z]{2})$}
-          env[key] = tmp.join("/")
-        end
-      end
-      env
+    def extract_locale_from_subdomain(request)
+      locale = Domainatrix.parse(request.url).subdomain rescue nil
+      locale if is_available?(locale)
+    end
+
+    def extract_locale_from_session(request)
+      locale = request.session['locale']
+      locale if is_available?(locale)
     end
 
-    def first_http_accept_language(env)
-      if lang = env["HTTP_ACCEPT_LANGUAGE"]
+    def extract_locale_from_accept_language(request)
+      if lang = request.env["HTTP_ACCEPT_LANGUAGE"]
         lang = lang.split(",").map { |l|
           l += ';q=1.0' unless l =~ /;q=\d+\.\d+$/
           l.split(';q=')
         }.first
         locale = symbolize_locale(lang.first.split("-").first)
       else
-        locale = nil
+        locale = I18n.default_locale
+      end
+      is_available?(locale) ? locale : I18n.default_locale
+    end
+
+
+    def extract_locale(request)
+      locale = (  extract_locale_from_params(request)           ||
+                  extract_locale_from_path(request)             ||
+                  extract_locale_from_subdomain(request)        ||
+                  extract_locale_from_tld(request)              ||
+                  extract_locale_from_session(request)          ||
+                  extract_locale_from_accept_language(request))
+      symbolize_locale(locale)
+    end
+
+    def cleanup_env env
+      %w{REQUEST_URI REQUEST_PATH PATH_INFO}.each do |key|
+        if is_present?(env[key]) && env[key].length > 1 && tmp = env[key].split("/")
+          tmp.delete_at(1) if tmp[1] =~ %r{^([a-zA-Z]{2})$}
+          env[key] = tmp.join("/")
+        end
       end
-      is_available?(locale) ? locale : I18n.available_locales
+      env
     end
 
+
     def is_present?(value)
       !value.to_s.empty?
     end
 
     def symbolize_locale(locale)
-      is_present?(locale) ?  locale.to_s.downcase.to_sym : locale
+      (is_present?(locale) ?  locale.to_s.downcase.to_sym : nil)
     end
 
   end

data/rack-i18n_locale_switcher.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = "rack-i18n_locale_switcher"
-  s.version = "0.1.0"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Christoph B\u{fc}nte, Andreas Korth"]
@@ -24,12 +24,14 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<rack>, [">= 0"])
       s.add_runtime_dependency(%q<i18n>, [">= 0"])
+      s.add_runtime_dependency(%q<domainatrix>, [">= 0"])
       s.add_development_dependency(%q<echoe>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
       s.add_development_dependency(%q<rack-test>, [">= 0"])
     else
       s.add_dependency(%q<rack>, [">= 0"])
       s.add_dependency(%q<i18n>, [">= 0"])
+      s.add_dependency(%q<domainatrix>, [">= 0"])
       s.add_dependency(%q<echoe>, [">= 0"])
       s.add_dependency(%q<rspec>, [">= 0"])
       s.add_dependency(%q<rack-test>, [">= 0"])
@@ -37,6 +39,7 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<rack>, [">= 0"])
     s.add_dependency(%q<i18n>, [">= 0"])
+    s.add_dependency(%q<domainatrix>, [">= 0"])
     s.add_dependency(%q<echoe>, [">= 0"])
     s.add_dependency(%q<rspec>, [">= 0"])
     s.add_dependency(%q<rack-test>, [">= 0"])

data/spec/i18n_locale_switcher_spec.rb

@@ -2,6 +2,11 @@ require "spec_helper"
 
 describe "Rack::I18nLocaleSwitcher" do
 
+  before do
+    I18n.available_locales = [:en, :'en-US', :de, :'de-DE', :es]
+    I18n.default_locale = :en
+  end
+
   def app
     Rack::Builder.new {
       map "/" do
@@ -11,12 +16,70 @@ describe "Rack::I18nLocaleSwitcher" do
     }.to_app
   end
 
+  it "should set the locate to default locale" do
+    get '/'
+    I18n.locale.should eql(I18n.default_locale)
+  end
+
+  context 'from request params' do
+
+    it "should set the I18n locale" do
+      get '/', :locale => 'de'
+      last_request.url.should include('?locale=de')
+      I18n.locale.should eql(:de)
+    end
+
+    it "should disallow other locales than the available locales" do
+      get '/', :locale => 'xx'
+      I18n.locale.should eql(I18n.default_locale)
+    end
+
+  end
+
+  context 'from path prefix ' do
+    it "should set the I18n locale" do
+      get '/de/'
+      I18n.locale.should eql(:de)
+    end
+  end
+
+  context 'from subdomain' do
+
+    it "should set the I18n locale" do
+      get 'http://de.example.com/'
+      I18n.locale.should eql(:de)
+    end
+  end
+
+  context 'from top level domain' do
+
+
+    it "should set the I18n locale" do
+      get 'http://example.de/'
+      I18n.locale.should eql(:de)
+    end
+
+  end
+
+  context 'from accept-language header' do
+
+    it "should override the client requested locale" do
+      get '/' , {}, {'HTTP_ACCEPT_LANGUAGE' => "de, de-de,en;q=0.5"}
+      I18n.locale.should eql(:de)
+    end
 
-  it "should detect locale from Accept-Language-Header" do
-    get '/', {'Accept-Language' => 'en-US, en'}
-    I18n.locale.should == :en
   end
 
+  context 'from session' do
+    it "should set the locale to whatever locale is set in the session" do
+
+      get '/', {}, {'rack.session' => {'locale' => 'de'}}
+      I18n.locale.should eql(:de)
+    end
 
+  end
+
+  context 'from default' do
+  end
 
 end

metadata

@@ -2,7 +2,7 @@
 name: rack-i18n_locale_switcher
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Christoph B\xC3\xBCnte, Andreas Korth"
@@ -35,7 +35,7 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: echoe
+  name: domainatrix
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -43,10 +43,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: echoe
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -57,7 +57,7 @@ dependencies:
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: rack-test
+  name: rspec
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -67,6 +67,17 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id006
 description: Detects the current locale from url, domain, parameter, session or accept header.
 email: 
 - info@christophbuente.de