rack-user-locale 0.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3-p362@rack-user-locale

data/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "rack"
+gem "i18n"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler"
+  gem 'debugger'
+  gem "jeweler"
+  gem "minitest"
+  gem "rack-test"
+  gem "turn"
+  gem "yard"
+end

data/Gemfile.lock

@@ -0,0 +1,44 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ansi (1.4.3)
+    columnize (0.3.6)
+    debugger (1.3.0)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1.1)
+      debugger-ruby_core_source (~> 1.1.7)
+    debugger-linecache (1.1.2)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.7)
+    git (1.2.5)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.6)
+    minitest (4.5.0)
+    rack (1.5.1)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.0.3)
+    rdoc (3.12)
+      json (~> 1.4)
+    turn (0.9.6)
+      ansi
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  debugger
+  i18n
+  jeweler
+  minitest
+  rack
+  rack-test
+  turn
+  yard

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Stuart Chinery
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+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...
+
+https://github.com/rack/rack-contrib/blob/master/lib/rack/contrib/locale.rb
+https://github.com/jeremyvdw/rack-locale-selector
+https://github.com/jeffersongirao/rack-locale_chooser
+
+Installation
+============
+
+```
+gem install rack-user-locale
+```
+
+In a Gemfile:
+
+```ruby
+gem 'rack-user-locale'
+```
+
+Usage
+=====
+
+Add the following line to your Rack application
+
+```
+use Rack::UserLocale
+```
+
+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 I18n.default_locale value (basically a fallback)
+
+Should you wish to overwrite a users locale value the simple rewrite the "user-locale" cookie.
+
+Contributing to rack-user-locale
+=======================
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+Copyright
+=========
+
+Copyright (c) 2013 [Stuart Chinery](http://www.headlondon.com/who-we-are#stuart-chinery) and [Dave Hrycyszyn](http://www.headlondon.com/who-we-are#david-hrycyszyn) - [headlondon.com](http://www.headlondon.com).
+
+See LICENSE.txt for further details.

data/Rakefile

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rack-user-locale"
+  gem.homepage = "http://github.com/sleepingstu/rack-user-locale"
+  gem.license = "MIT"
+  gem.summary = %Q{Rack module for getting and setting a user's locale}
+  gem.description = %Q{A Rack module for getting and setting a user's locale via a cookie or browser default language.}
+  gem.email = "stuart.chinery@headlondon.com"
+  gem.authors = ["Stuart Chinery", "Dave Hrycyszyn"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/lib/rack-user-locale.rb

@@ -0,0 +1,62 @@
+require "i18n"
+
+module Rack
+  class UserLocale
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      @env = env
+      @request = Rack::Request.new(@env)
+      set_locale
+
+      if @request.post? || @request.put? || @request.delete?
+        @app.call(env)
+      else
+        status, headers, body = @app.call(@env)
+        response = Rack::Response.new(body, status, headers)
+        response.set_cookie("user-locale", {
+          :value => I18n.locale,
+          :path => "/",
+          :domain => @request.host}) if get_cookie_locale != I18n.locale.to_s
+        response.finish
+      end
+    end
+
+    private
+
+    def set_locale
+      I18n.locale = @env["rack.locale"] = locale.to_sym
+    end
+
+    def locale
+      get_cookie_locale || get_browser_locale || get_default_locale
+    end
+
+    def get_cookie_locale
+      @request.cookies["user-locale"]
+    end
+
+    def get_browser_locale
+      accept_langs = @env["HTTP_ACCEPT_LANGUAGE"]
+      return if accept_langs.nil?
+
+      languages_and_qvalues = accept_langs.split(",").map { |l|
+        l += ";q=1.0" unless l =~ /;q=\d+(?:\.\d+)?$/
+        l.split(";q=")
+      }
+
+      lang = languages_and_qvalues.sort_by { |(locale, qvalue)|
+        qvalue.to_f
+      }.last.first
+
+      lang == "*" ? nil : lang
+    end
+
+    def get_default_locale
+      I18n.default_locale
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'bundler'
+require "rack/test"
+require "debugger"
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'minitest/autorun'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rack-user-locale'
+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
+  def call(env)
+    [200, {'Content-Type' => 'text/plain'}, 'Hello World']
+  end
+end
+
+MiniTest::Unit.autorun

data/test/test_rack-user-locale.rb

@@ -0,0 +1,67 @@
+require 'helper'
+
+describe "RackUserLocale" do
+  before do
+    I18n.default_locale = :en
+  end
+
+  it "should have I18n.locale set to :en initially" do
+    assert_equal :en, I18n.locale
+  end
+
+  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
+
+  describe "when from HTTP_ACCEPT_LANGUAGE headers" do
+    before do
+      get 'http://example.com/', {}, 'HTTP_ACCEPT_LANGUAGE' => 'ru'
+    end
+
+    it "should have I18n.locale set to :ru" do
+      assert_equal :ru, I18n.locale
+    end
+
+    it "should set a cookie in the response" do
+      assert_equal "user-locale=ru; domain=example.com; path=/", last_response["Set-Cookie"]
+    end
+  end
+
+  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'
+    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
+
+  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

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: rack-user-locale
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Stuart Chinery
+- Dave Hrycyszyn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: turn
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Rack module for getting and setting a user's locale via a cookie or
+  browser default language.
+email: stuart.chinery@headlondon.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .document
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/rack-user-locale.rb
+- test/helper.rb
+- test/test_rack-user-locale.rb
+homepage: http://github.com/sleepingstu/rack-user-locale
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 981042501419718969
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rack module for getting and setting a user's locale
+test_files: []