rack-i18n_locale_switcher 0.3.1 → 0.4.0

data/CHANGELOG

@@ -1,3 +1,9 @@
+= 0.4.0 / 2011-11-26
+  Added support configuration of sources from which to determine the locale
+  as well as the name of the query parameter.
+  Drop support for TLD since locale can't be reliably inferred from it
+  Code refactoring and better test coverage.
+  
 = 0.3.1 / 2011-11-25
   Code refactoring
   Don't "clean" then Rack environment

data/Rakefile

@@ -2,12 +2,12 @@
 require 'rake'
 require 'echoe'
 
-Echoe.new('rack-i18n_locale_switcher', '0.3.1') do |p|
+Echoe.new('rack-i18n_locale_switcher', '0.4.0') do |p|
 
- p.description     = "Detects the current locale from host, top level domain, query parameter or Accept-Language header."
- p.url             = "http://github.com/christoph-buente/rack-i18n_locale_switcher"
- p.author          = ["Christoph Bünte", "Andreas Korth"]
- p.email           = ["info@christophbuente.de", "andreas.korth@gmail.com"]
+ p.description = "Detects the current locale from query parameter, path prefix, host or accept header."
+ p.url         = "http://github.com/christoph-buente/rack-i18n_locale_switcher"
+ p.author      = ["Christoph Bünte", "Andreas Korth"]
+ p.email       = ["info@christophbuente.de", "andreas.korth@gmail.com"]
 
  p.retain_gemspec = true
 

data/lib/rack/i18n_locale_switcher.rb

@@ -1,57 +1,72 @@
 require 'i18n'
-require 'domainatrix'
+# require 'domainatrix'
 
 module Rack
   class I18nLocaleSwitcher
     
+    DEFAULT_OPTIONS = {
+      :param  => 'locale',
+      :source => [ :param, :path, :host, :header ]
+    }.freeze
+
     def initialize(app, options = {})
       @app = app
+      
+      invalid_options = (options.keys - DEFAULT_OPTIONS.keys)
+      
+      if invalid_options.any?
+        raise ArgumentError, "Invalid option(s) #{ invalid_options.map(&:inspect).join(', ') }" 
+      end
+      
+      @options = DEFAULT_OPTIONS.merge(options)
+      @options[:source] = Array(@options[:source]) unless @options[:source].is_a?(Array)
     end
 
     def call(env)
-      I18n.locale = extract_locale(env)
+      I18n.locale = I18n.default_locale
+      
+      @options[:source].each do |source|
+        if locale = send(:"get_locale_from_#{source}", env)
+          I18n.locale = locale
+          break
+        end
+      end
+            
       @app.call(env)
     end
 
     private
 
-    def extract_locale(env)
-      request = Rack::Request.new(env)
-      uses = [ :param, :path, :subdomain, :tld, :client ]
-      uses.each do |use|
-        if locale = send(:"extract_locale_from_#{ use }", request)
-          unless locale.empty?
-            locale = locale.to_sym
-            return locale if I18n.available_locales.include?(locale)
-          end
-        end
-      end
-      I18n.default_locale
-    end
-
-    def extract_locale_from_param(request)
-      request.params["locale"]
+    def get_locale_from_param(env)
+      env['QUERY_STRING'] =~ /\b#{ @options[:param] }=([^&]+)\b/
+      to_available_locale($1)
     end
 
-    def extract_locale_from_path(request)
-      request.path_info =~ /^\/(\w{2,3})\b/ && $1
+    def get_locale_from_path(env)
+      env['PATH_INFO'] =~ /^\/([^\/]+)/
+      to_available_locale($1)
     end
 
-    def extract_locale_from_tld(request)
-      Domainatrix.parse(request.url).public_suffix rescue nil
+    def get_locale_from_host(env)
+      env['SERVER_NAME'] =~ /^([^.]+)\.[^.]+\.[^.]+/i
+      to_available_locale($1)
     end
 
-    def extract_locale_from_subdomain(request)
-      Domainatrix.parse(request.url).subdomain rescue nil
+    def get_locale_from_header(env)
+      locale = nil
+      if accept = env['HTTP_ACCEPT_LANGUAGE']
+        locales = accept.scan(/([^;,]+)\s*(;\s*q\s*=\s*(1|0\.[0-9]+))?/i)
+        locales.sort_by{ |loc| 1 - (loc.last || 1).to_f }.each do |loc|
+          break if locale = to_available_locale(loc.first)
+        end
+      end
+      locale
     end
-
-    def extract_locale_from_client(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
-        lang.first.split("-").first
+    
+    def to_available_locale(locale)
+      if locale =~ /^([a-z]{1,8})(-[a-z]{1,8})?$/i
+        locale = :"#{ $1.downcase }#{ ($2 || '').upcase }"
+        locale if I18n.available_locales.include?(locale)
       end
     end
   end

data/rack-i18n_locale_switcher.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name = "rack-i18n_locale_switcher"
-  s.version = "0.3.1"
+  s.version = "0.4.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"]
-  s.date = "2011-11-25"
-  s.description = "Detects the current locale from host, top level domain, query parameter or Accept-Language header."
+  s.date = "2011-11-26"
+  s.description = "Detects the current locale from query parameter, path prefix, host or accept header."
   s.email = ["info@christophbuente.de", "andreas.korth@gmail.com"]
   s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.md", "lib/rack/i18n_locale_switcher.rb"]
   s.files = ["CHANGELOG", "LICENSE", "Manifest", "README.md", "Rakefile", "lib/rack/i18n_locale_switcher.rb", "rack-i18n_locale_switcher.gemspec", "spec/i18n_locale_switcher_spec.rb"]
@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.rubyforge_project = "rack-i18n_locale_switcher"
   s.rubygems_version = "1.8.11"
-  s.summary = "Detects the current locale from host, top level domain, query parameter or Accept-Language header."
+  s.summary = "Detects the current locale from query parameter, path prefix, host or accept header."
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/spec/i18n_locale_switcher_spec.rb

@@ -5,13 +5,19 @@ describe Rack::I18nLocaleSwitcher do
 
   include Rack::Test::Methods
 
-  def app
-    Rack::Builder.new {
+  let :options do
+    {}
+  end
+  
+  let :app do
+    opts = options
+    rack = Rack::Builder.new do
       map "/" do
-        use Rack::I18nLocaleSwitcher
+        use Rack::I18nLocaleSwitcher, opts
         run lambda { |env| [200, {}, "Coolness"] }
       end
-    }.to_app
+    end
+    rack.to_app
   end
 
   before do
@@ -19,54 +25,107 @@ describe Rack::I18nLocaleSwitcher do
     I18n.default_locale = :en
   end
 
-  it "should set the locale to default locale" do
-    get '/'
+  it "should fall back to the locale to default locale" do
+    get 'http://example.com/some/path'
+    I18n.locale.should eql(I18n.default_locale)
+
+    get 'http://www.example.com/'
     I18n.locale.should eql(I18n.default_locale)
   end
+  
+  it "should not accept invalid options" do
+    expect { 
+      Rack::I18nLocaleSwitcher.new('app', :not_an_option => 'foo') 
+    }.to raise_error(ArgumentError, "Invalid option(s) :not_an_option")
+  end
+  
+  context 'with custom sources' do
+    
+    let :options do
+      { :source => [ :header, :host ] }
+    end
+    
+    it "should honor the sequence" do
+      get 'http://de.example.com' , {}, {'HTTP_ACCEPT_LANGUAGE' => "es"}
+      I18n.locale.should eql(:es)
 
-  context 'request param' do
+      get 'http://de.example.com' , {}, {'HTTP_ACCEPT_LANGUAGE' => "foo"}
+      I18n.locale.should eql(:de)
 
-    it "should set the I18n locale" do
-      get '/', :locale => 'de'
-      last_request.url.should include('?locale=de')
+      get 'http://de.example.com'
       I18n.locale.should eql(:de)
     end
 
-    it "should only allow available locales" do
-      get '/', :locale => 'xx'
-      I18n.locale.should eql(I18n.default_locale)
+    it "should ignore other sources" do
+      get 'http://example.com?locale=de'
+      I18n.locale.should eql(:en)
+
+      get 'http://example.com/de'
+      I18n.locale.should eql(:en)
     end
   end
 
-  context 'from path prefix ' do
+  context 'request param' do
 
-    it "should set the I18n locale" do
-      get '/de/'
+    it "should set the locale" do
+      get 'http://example.com?locale=de'
       I18n.locale.should eql(:de)
+
+      get 'http://example.com?locale=en-US'
+      I18n.locale.should eql(:'en-US')
+
+      get 'http://example.com/some/path?foo=bar&locale=es&param=value'
+      I18n.locale.should eql(:es)
+    end
+
+    it "should not set an unavailable locale" do
+      get 'http://example.com?locale=xx'
+      I18n.locale.should eql(I18n.default_locale)
+    end
+    
+    context 'name' do
+      
+      let :options do
+        { :param => 'lang' }
+      end
+      
+      it "should be configurable" do
+        get 'http://example.com?lang=de'
+        I18n.locale.should eql(:de)
+      end
     end
   end
 
-  context 'from subdomain' do
+  context 'from path prefix ' do
 
     it "should set the I18n locale" do
-      get 'http://de.example.com/'
+      get 'http://example.com/de/some/path/'
       I18n.locale.should eql(:de)
+
+      get 'http://example.com/en-us'
+      I18n.locale.should eql(:'en-US')
     end
   end
 
-  context 'from top level domain' do
+  context 'from host' do
 
     it "should set the I18n locale" do
-      get 'http://example.de/'
+      get 'http://de.example.com/'
       I18n.locale.should eql(:de)
+
+      get 'http://de-de.example.com/'
+      I18n.locale.should eql(:'de-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)
+      get 'http://example.com' , {}, {'HTTP_ACCEPT_LANGUAGE' => "de-de,de,en;q=0.5"}
+      I18n.locale.should eql(:'de-DE')
+
+      get 'http://example.com' , {}, {'HTTP_ACCEPT_LANGUAGE' => "en;q=0.5,en-US;q=0.8,es;q=0.7"}
+      I18n.locale.should eql(:'en-US')
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-i18n_locale_switcher
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-25 00:00:00.000000000 Z
+date: 2011-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2154168640 !ruby/object:Gem::Requirement
+  requirement: &2158734100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2154168640
+  version_requirements: *2158734100
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &2154168180 !ruby/object:Gem::Requirement
+  requirement: &2158733640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2154168180
+  version_requirements: *2158733640
 - !ruby/object:Gem::Dependency
   name: domainatrix
-  requirement: &2154167720 !ruby/object:Gem::Requirement
+  requirement: &2158733180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2154167720
+  version_requirements: *2158733180
 - !ruby/object:Gem::Dependency
   name: echoe
-  requirement: &2154167260 !ruby/object:Gem::Requirement
+  requirement: &2158732720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154167260
+  version_requirements: *2158732720
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2154166800 !ruby/object:Gem::Requirement
+  requirement: &2158732260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154166800
+  version_requirements: *2158732260
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &2154166340 !ruby/object:Gem::Requirement
+  requirement: &2158731800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,9 +76,9 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154166340
-description: Detects the current locale from host, top level domain, query parameter
-  or Accept-Language header.
+  version_requirements: *2158731800
+description: Detects the current locale from query parameter, path prefix, host or
+  accept header.
 email:
 - info@christophbuente.de
 - andreas.korth@gmail.com
@@ -127,6 +127,6 @@ rubyforge_project: rack-i18n_locale_switcher
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Detects the current locale from host, top level domain, query parameter or
-  Accept-Language header.
+summary: Detects the current locale from query parameter, path prefix, host or accept
+  header.
 test_files: []