rails_locale_detection 1.1.0 → 1.2.0

data/Gemfile.lock

@@ -48,7 +48,7 @@ GEM
     sprockets (2.1.3)
       hike (~> 1.2)
       rack (~> 1.0)
-      tilt (!= 1.3.0, ~> 1.1)
+      tilt (~> 1.1, != 1.3.0)
     tilt (1.3.3)
     timecop (0.3.5)
 

data/README.rdoc

@@ -1,9 +1,10 @@
 = rails_locale_detection
 
-Sets the current locale of a request using a combination of params, cookies, and http headers. 
+Sets the current locale of a request using a combination of params, cookies, http headers, and an optional user object. 
 
-In turn, it checks the value of params[:locale], cookies[:locale] and finally HTTP_ACCEPT_LANGUAGE headers to find a locale that
-corresponds to the available locales, then stores the set locale in a cookie for future requests.
+In turn, it checks the value of params[:locale], cookies[:locale] and HTTP_ACCEPT_LANGUAGE headers to find a locale that
+corresponds to the available locales, then stores the set locale in a cookie for future requests. If a user_locale method
+is provided, the return value will be used, with preference over the other locale detection methods.
 
 == Usage
 
@@ -23,13 +24,26 @@ Call set_locale as a filter in your controllers
     
   end
 
+To support user locales, add a user_locale method
+
+  class ApplicationController < ActionController::Base
+    before_filter :set_locale
+
+    def user_locale
+      current_user.locale if current_user
+    end
+    
+  end
+
+
 == Configuration
 
-There are two configuration options:
+The configuration options:
 
   Rails::LocaleDetection.config do |config|
     config.locale_expiry = 3.months # This sets how long the locale cookie lasts.
     config.set_default_url_option = true # sets the default_url_options[:locale] to the current locale when set_locale is called
+    config.detection_order = [:user, :param, :cookie, :request] # set the order in which locale detection occurs. Omit values to skip those sources
   end
 
 == Contributing to rails_locale_detection

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/lib/rails/locale_detection.rb

@@ -6,6 +6,9 @@ module Rails
     mattr_accessor :set_default_url_option
     @@set_default_url_option = true
     
+    mattr_accessor :detection_order
+    @@detection_order = [:user, :param, :cookie, :request]
+    
     def self.config
       yield self
     end
@@ -18,6 +21,10 @@ module Rails
       I18n.default_locale
     end
   
+    def user_locale
+      nil
+    end
+  
     # returns the (symbolized) value passed if it's in the available_locales
     def validate_locale(locale)
       locale.to_sym if locale && available_locales.include?(locale.to_sym)
@@ -27,7 +34,7 @@ module Rails
       validate_locale(params[:locale])
     end
   
-    def locale_from_cookies
+    def locale_from_cookie
       validate_locale(cookies[:locale])
     end  
   
@@ -35,8 +42,16 @@ module Rails
       validate_locale(request.preferred_language_from(available_locales))
     end
   
+    def locale_from_user
+      validate_locale(user_locale)
+    end
+  
+    def locale_from(key)
+      send("locale_from_#{key}")
+    end
+  
     def get_locale
-      locale_from_param || locale_from_cookies || locale_from_request || default_locale
+      detection_order.inject(nil) { |result, source| result || locale_from(source) } || default_locale
     end
     
     # set I18n.locale, default_url_options[:locale] and cookies[:locale] to the value returned by

data/rails_locale_detection.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "rails_locale_detection"
-  s.version = "1.1.0"
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Mateo Murphy"]
-  s.date = "2012-05-26"
+  s.date = "2012-06-05"
   s.description = "Sets the current locale of a request using a combination of params, cookies, and http headers"
   s.email = "mateo.murphy@gmail.com"
   s.extra_rdoc_files = [

data/spec/rails_locale_detection_spec.rb

@@ -36,6 +36,10 @@ describe Rails::LocaleDetection do
     it "returns nil if the passed locale isn't valid" do
       controller.validate_locale(:es).should be_nil
     end
+    
+    it "returns nil if nil is passed" do
+      controller.validate_locale(nil).should be_nil
+    end
   end
   
   describe '#locale_from_param' do
@@ -57,16 +61,16 @@ describe Rails::LocaleDetection do
   describe '#locale_from_cookie' do
     it "returns en if the param set was valid" do
       controller.cookies[:locale] = 'en'
-      controller.locale_from_cookies.should eq(:en)
+      controller.locale_from_cookie.should eq(:en)
     end
     
     it "returns nil if the param set was not" do
       controller.cookies[:locale] = 'es'
-      controller.locale_from_cookies.should be_nil
+      controller.locale_from_cookie.should be_nil
     end
 
     it "returns nil if not locale was set" do
-      controller.locale_from_cookies.should be_nil
+      controller.locale_from_cookie.should be_nil
     end
   end  
   
@@ -84,27 +88,93 @@ describe Rails::LocaleDetection do
     it "returns nil if not locale was set" do
       controller.locale_from_request.should be_nil
     end
-  end  
+  end
   
-  describe '#get_locale' do
-    it "returns nil if nothing is set" do
-      controller.get_locale.should eq(:en)
+  describe '#locale_from_user' do
+    it "returns the locale of the user if it's valid" do
+      controller.user = MockUser.new(:en)
+      controller.locale_from_user.should eq(:en)
     end
-
-    it "returns en if the params is set to en" do
-      controller.params[:locale] = "en"
-      controller.get_locale.should eq(:en)
+    
+    it "returns nil if the locale of the use isn't valid" do
+      controller.user = MockUser.new(:es)
+      controller.locale_from_user.should be_nil
+    end
+  end
+  
+  describe '#locale_from' do
+    before :all do
+      controller.params[:locale] = 'en'      
+      controller.cookies[:locale] = 'fr'
+    end
+    
+    it "returns the locale set in the param" do
+      controller.locale_from(:param).should eq(:en)
+    end
+    
+    it "return the locale set in the cookie" do
+      controller.locale_from(:cookie).should eq(:fr)
     end
+  end
+  
+  describe '#get_locale' do
+    context "with default detection order" do
+      before :all do
+        Rails::LocaleDetection.detection_order = [:user, :param, :cookie, :request]
+      end      
+      
+      it "returns default if nothing is set" do
+        controller.get_locale.should eq(:en)
+      end
+
+      it "returns en if the params is set to en" do
+        controller.params[:locale] = "en"
+        controller.get_locale.should eq(:en)
+      end
+
+      it "returns fr if the cookie is set to fr" do
+        controller.cookies[:locale] = "fr"
+        controller.get_locale.should eq(:fr)
+      end
 
-    it "returns fr if the cookie is set to fr" do
-      controller.cookies[:locale] = "fr"
-      controller.get_locale.should eq(:fr)
+      it "returns en if the request is set to en" do
+        request.env['HTTP_ACCEPT_LANGUAGE'] = 'en-us,en-gb;q=0.8,en;q=0.6'
+        controller.get_locale.should eq(:en)
+      end
+      
+      it "return fr if the user locale was set to fr" do
+        controller.user = MockUser.new(:en)
+        controller.get_locale.should eq(:en)
+      end
+      
     end
+    
+    context "with a custom detection order" do
+      before :all do
+        Rails::LocaleDetection.detection_order = [:user, :param, :request]
+      end
+      
+      it "returns return default if nothing is set" do
+        controller.get_locale.should eq(:en)
+      end
 
-    it "returns en if the request is set to en" do
-      request.env['HTTP_ACCEPT_LANGUAGE'] = 'en-us,en-gb;q=0.8,en;q=0.6'
-      controller.get_locale.should eq(:en)
+      it "returns en if the params is set to en" do
+        controller.params[:locale] = "en"
+        controller.get_locale.should eq(:en)
+      end
+
+      it "skips cookie" do
+        controller.cookies[:locale] = "fr"
+        controller.get_locale.should eq(:en)
+      end
+
+      it "returns en if the request is set to en" do
+        request.env['HTTP_ACCEPT_LANGUAGE'] = 'en-us,en-gb;q=0.8,en;q=0.6'
+        controller.get_locale.should eq(:en)
+      end      
+      
     end
+    
   end
 
   describe '#set_locale' do

data/spec/support/mock.rb

@@ -11,11 +11,24 @@ end
 class MockController
   include Rails::LocaleDetection
   
-  attr_accessor :request, :params, :cookies, :default_url_options
+  attr_accessor :request, :params, :cookies, :default_url_options, :user
   
   def initialize(request)
     @request = request
     @cookies = ActionDispatch::Cookies::CookieJar.new
     @default_url_options = @params = {}
   end
+  
+  def user_locale
+    return user.locale if user
+  end
+  
+end
+
+class MockUser
+  attr_accessor :locale
+  
+  def initialize(locale)
+    @locale = locale
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rails_locale_detection
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 31
   prerelease: 
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Mateo Murphy
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-26 00:00:00 Z
+date: 2012-06-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   type: :runtime