rack-user-locale 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,8 @@
 rack-user-locale
 ----------------
 
+[![Build Status](https://secure.travis-ci.org/sleepingstu/rack-user-locale.png)](http://travis-ci.org/sleepingstu/rack-user-locale)
+
 A Rack module for getting and setting a user's locale via a cookie or browser default language.
 
 Credit to these gems for pointing me in the direction I wanted to go in...
@@ -36,10 +38,19 @@ and thats it!!
 Your application will now attempt to set the I18n.locale value based on the following:
 
 * Whether a user has a "user-locale" cookie set
-* The "HTTP_ACCEPT_LANGUAGE" value
+* The "HTTP_ACCEPT_LANGUAGE" value. If there are multiple values it will attempt to set the one ranked highest
 * The I18n.default_locale value (basically a fallback)
 
-Should you wish to overwrite a users locale value then simple rewrite the "user-locale" cookie.
+There is the option to pass in an accepted array of locales, like so:
+
+```
+use Rack::UserLocale, :accepted_locales => [:en, :es, :fr, :de, :jp, (whatever codes you support)]
+```
+
+If this option is supplied the the users locale will either be set to one of the accepted locales in the array, otherwise it will be set to the I18n.default_locale value.
+
+
+Should you wish to overwrite a users locale value at any point in your application, like for changing language prefs, then simple rewrite the "user-locale" cookie with a new value.
 
 Contributing to rack-user-locale
 =======================

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/rack-user-locale.rb

@@ -3,8 +3,10 @@ require "i18n"
 module Rack
   class UserLocale
 
-    def initialize(app)
-      @app = app
+    def initialize(app, options = {})
+      @app, @options = app, {
+          :accepted_locales => []
+        }.merge(options)
     end
 
     def call(env)
@@ -28,7 +30,12 @@ module Rack
     private
 
     def set_locale
-      I18n.locale = @env["rack.locale"] = locale.to_sym
+      new_locale = check_accepted? ? accepted_locale(locale.to_sym, get_default_locale) : locale.to_sym
+      I18n.locale = @env["rack.locale"] = new_locale
+    end
+
+    def accepted_locale(locale, other_locale = nil)
+      locale = @options[:accepted_locales].include?(locale) ? locale : other_locale
     end
 
     def locale
@@ -40,18 +47,34 @@ module Rack
     end
 
     def get_browser_locale
-      accept_langs = @env["HTTP_ACCEPT_LANGUAGE"]
-      return if accept_langs.nil?
+      accept_lang = @env["HTTP_ACCEPT_LANGUAGE"]
+      return if accept_lang.nil?
+
+      langs = accept_lang.split(",").map { |l|
+        l += ';q=1.0' unless l =~ /;q=\d+\.\d+$/
+        l.split(';q=')
+      }.sort { |a, b| b[1] <=> a[1] }
+
+      if check_accepted?
+        langs.each do |lang|
+          l = accepted_locale(split_lang(lang.first).to_sym)
+          return l unless l.nil?
+        end
+      end
 
-      lang = accept_langs.split(",").map { |l|
-          l += ';q=1.0' unless l =~ /;q=\d+\.\d+$/
-          l.split(';q=')
-        }.first
-      browser_locale = lang.first.split("-").first
+      return split_lang(langs.first.first)
+    end
+
+    def split_lang(lang)
+      lang.split("-").first unless lang.nil?
     end
 
     def get_default_locale
       I18n.default_locale
     end
+
+    def check_accepted?
+      @options[:accepted_locales].count > 0
+    end
   end
 end

data/rack-user-locale.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "rack-user-locale"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Stuart Chinery", "Dave Hrycyszyn"]
-  s.date = "2013-02-04"
+  s.date = "2013-02-05"
   s.description = "A Rack module for getting and setting a user's locale via a cookie or browser default language."
   s.email = "stuart.chinery@headlondon.com"
   s.extra_rdoc_files = [

data/test/helper.rb

@@ -19,14 +19,6 @@ begin; require 'turn/autorun'; rescue LoadError; end
 
 class MiniTest::Unit::TestCase
   include Rack::Test::Methods
-
-  def app
-    app = Rack::Builder.new {
-      use Rack::UserLocale
-
-      run BasicRackApp.new
-    }
-  end
 end
 
 class BasicRackApp

data/test/test_rack-user-locale.rb

@@ -1,67 +1,200 @@
-require 'helper'
+require "helper"
 
 describe "RackUserLocale" do
-  before do
-    I18n.default_locale = :en
-  end
+  describe "without accepted_locales set" do
+    before do
+      def app
+        app = Rack::Builder.new {
+          use Rack::UserLocale
 
-  it "should have I18n.locale set to :en initially" do
-    assert_equal :en, I18n.locale
-  end
+          run BasicRackApp.new
+        }
+      end
 
-  describe "when a locale cookie is set" do
-    before do
-      get 'http://example.com/', {}, 'HTTP_COOKIE' => 'user-locale=es'
+      I18n.default_locale = :en
     end
 
-    it "should have I18n.locale set to :es" do
-      assert_equal :es, I18n.locale
+    it "should have I18n.locale set to :en initially" do
+      assert_equal :en, I18n.locale
     end
 
-    it "should not set a cookie in the response" do
-      assert_equal nil, last_response["Set-Cookie"]
+    describe "when a locale cookie is set" do
+      before do
+        get "http://example.com/", {}, "HTTP_COOKIE" => "user-locale=be"
+      end
+
+      it "should have I18n.locale set to :be" do
+        assert_equal :be, I18n.locale
+      end
+
+      it "should not set a cookie in the response" do
+        assert_equal nil, last_response["Set-Cookie"]
+      end
     end
-  end
 
-  describe "when from HTTP_ACCEPT_LANGUAGE headers" do
-    before do
-      get 'http://example.com/', {}, 'HTTP_ACCEPT_LANGUAGE' => 'ar-tu'
+    describe "when from HTTP_ACCEPT_LANGUAGE headers" do
+      describe "with a single locale" do
+        before do
+          get "http://example.com/", {}, "HTTP_ACCEPT_LANGUAGE" => "fr-be"
+        end
+
+        it "should have I18n.locale set to :fr" do
+          assert_equal :fr, I18n.locale
+        end
+
+        it "should set a cookie in the response" do
+          assert_equal "user-locale=fr; domain=example.com; path=/", last_response["Set-Cookie"]
+        end
+      end
+
+      describe "with an multiple locales" do
+        before do
+          get "http://example.com/", {},
+            "HTTP_ACCEPT_LANGUAGE" => "de-DE;q=0.8,de;q=0.8,no-NO;q=1.0,no;q=0.7,ru-RU;q=0.7,sv-SE;q=0.4,sv;q=0.3,nl-BE;q=0.9"
+        end
+
+        it "should have I18n.locale set to :no" do
+          assert_equal :no, I18n.locale
+        end
+
+        it "should set a cookie in the response" do
+          assert_equal "user-locale=no; domain=example.com; path=/", last_response["Set-Cookie"]
+        end
+      end
     end
 
-    it "should have I18n.locale set to :ar" do
-      assert_equal :ar, I18n.locale
+    describe "when both a cooke and HTTP_ACCEPT_LANGUAGE headers are set" do
+      before do
+        get "http://example.com/", {}, "HTTP_COOKIE" => "user-locale=af", "HTTP_ACCEPT_LANGUAGE" => "ar-sa"
+      end
+
+      it "should have I18n.locale set to :af" do
+        assert_equal :af, I18n.locale
+      end
+
+      it "should not set a cookie in the response" do
+        assert_equal nil, last_response["Set-Cookie"]
+      end
     end
 
-    it "should set a cookie in the response" do
-      assert_equal "user-locale=ar; domain=example.com; path=/", last_response["Set-Cookie"]
+    describe "when nothing is changed" do
+      before do
+        get "http://example.com/"
+      end
+
+      it "should have I18n.locale set to :en" do
+        assert_equal :en, I18n.locale
+      end
+
+      it "should set a cookie in the response" do
+        assert_equal "user-locale=en; domain=example.com; path=/", last_response["Set-Cookie"]
+      end
     end
   end
 
-  describe "when both a cooke and HTTP_ACCEPT_LANGUAGE headers are set" do
+  describe "with accepted_locales set" do
     before do
-      get 'http://example.com/', {}, 'HTTP_COOKIE' => 'user-locale=jp', 'HTTP_ACCEPT_LANGUAGE' => 'fr-be'
+      def app
+        app = Rack::Builder.new {
+          use Rack::UserLocale, :accepted_locales => [:en, :es, :fr, :de, :jp, :nl]
+
+          run BasicRackApp.new
+        }
+      end
+
+      I18n.default_locale = :en
     end
 
-    it "should have I18n.locale set to :jp" do
-      assert_equal :jp, I18n.locale
+    it "should have I18n.locale set to :en initially" do
+      assert_equal :en, I18n.locale
     end
 
-    it "should not set a cookie in the response" do
-      assert_equal nil, last_response["Set-Cookie"]
+    describe "when a locale cookie is set" do
+      before do
+        get "http://example.com/", {}, "HTTP_COOKIE" => "user-locale=es"
+      end
+
+      it "should have I18n.locale set to :es" do
+        assert_equal :es, I18n.locale
+      end
+
+      it "should not set a cookie in the response" do
+        assert_equal nil, last_response["Set-Cookie"]
+      end
     end
-  end
 
-  describe "when nothing is changed" do
-    before do
-      get 'http://example.com/'
+    describe "when from HTTP_ACCEPT_LANGUAGE headers" do
+      describe "with an accepted locale" do
+        before do
+          get "http://example.com/", {}, "HTTP_ACCEPT_LANGUAGE" => "fr-be"
+        end
+
+        it "should have I18n.locale set to :fr" do
+          assert_equal :fr, I18n.locale
+        end
+
+        it "should set a cookie in the response" do
+          assert_equal "user-locale=fr; domain=example.com; path=/", last_response["Set-Cookie"]
+        end
+      end
+
+      describe "with an multiple locales" do
+        before do
+          get "http://example.com/", {},
+            "HTTP_ACCEPT_LANGUAGE" => "de-DE;q=0.8,de;q=0.8,no-NO;q=0.7,no;q=0.7,ru-RU;q=0.7,sv-SE;q=0.4,sv;q=0.3,nl-BE;q=0.9"
+        end
+
+        it "should have I18n.locale set to :nl" do
+          assert_equal :nl, I18n.locale
+        end
+
+        it "should set a cookie in the response" do
+          assert_equal "user-locale=nl; domain=example.com; path=/", last_response["Set-Cookie"]
+        end
+      end
+
+
+      describe "without an accepted locale" do
+        before do
+          get "http://example.com/", {}, "HTTP_ACCEPT_LANGUAGE" => "ar-sa"
+        end
+
+        it "should have I18n.locale set to :en" do
+          assert_equal :en, I18n.locale
+        end
+
+        it "should set a cookie in the response" do
+          assert_equal "user-locale=en; domain=example.com; path=/", last_response["Set-Cookie"]
+        end
+      end
     end
 
-    it "should have I18n.locale set to :en" do
-      assert_equal :en, I18n.locale
+    describe "when both a cooke and HTTP_ACCEPT_LANGUAGE headers are set" do
+      before do
+        get "http://example.com/", {}, "HTTP_COOKIE" => "user-locale=jp", "HTTP_ACCEPT_LANGUAGE" => "fr-be"
+      end
+
+      it "should have I18n.locale set to :jp" do
+        assert_equal :jp, I18n.locale
+      end
+
+      it "should not set a cookie in the response" do
+        assert_equal nil, last_response["Set-Cookie"]
+      end
     end
 
-    it "should set a cookie in the response" do
-      assert_equal "user-locale=en; domain=example.com; path=/", last_response["Set-Cookie"]
+    describe "when nothing is changed" do
+      before do
+        get "http://example.com/"
+      end
+
+      it "should have I18n.locale set to :en" do
+        assert_equal :en, I18n.locale
+      end
+
+      it "should set a cookie in the response" do
+        assert_equal "user-locale=en; domain=example.com; path=/", last_response["Set-Cookie"]
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-user-locale
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-04 00:00:00.000000000 Z
+date: 2013-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -192,7 +192,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3303822793188182499
+      hash: -1318168900759359089
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: