rack-i18n_locale_switcher 0.2.3 → 0.3.0

data/CHANGELOG

@@ -1,3 +1,6 @@
+= 0.3.0
+  Removed support for storing the locale in the session
+
 = 0.2.0 / 2011-11-24
   Better test coverage
 

data/README.md

@@ -1,3 +1,49 @@
 # Rack::I18nLocaleSwitcher
 
-This Rack middleware determines the I18n language from various sources.
+[![alt text][2]][1]
+
+  [1]: http://travis-ci.org/#!/christoph-buente/rack-i18n_locale_switcher
+  [2]: https://secure.travis-ci.org/christoph-buente/rack-i18n_locale_switcher.png
+
+This Rack middleware determines the I18n language from various sources.
+
+
+
+A language or locale, can be encode within an HTTP requests in various ways. Let's have a look at the following request url:
+
+    http://es.example.it/tr/?locale=de
+
+To extract the correct language from such a request, you probably don't want to hardcode it into you application. This middleware extracts the desired locale from this request in the following order:
+
+* request parameter (de, german)
+* url path (tr, turkish)
+* subdomain (es, spanish)
+* top level domain (it, italian)
+* HTTP Accept-language header (not visible in the url, but could be something completely different)
+
+Sound's good, gimme the code!
+
+## Rails
+
+    # file application.rb
+
+    require  'rack/i18n_locale_switcher'
+    config.middleware.use(Rack::I18nLocaleSwitcher)
+
+## Sinatra
+
+    require 'rack/i18n_locale_switcher'
+    use Rack::I18nLocaleSwitcher, :i18n_locale_switcher
+
+
+Q: Ok, but where does the locale go?
+
+A: The middleware uses the ruby internationalization gem [i18n](http://rubygems.org/gems/i18n), which stores the locale in a variable. You can use this variable in your app as
+
+    I18n.locale
+
+Q: How can I define, which locales are available?
+
+A: You can set the available locales before using instantiation the middleware.
+
+    I18n.available_locales = [:de, :en, :es, :it, :tr ]

data/Rakefile

@@ -2,9 +2,9 @@
 require 'rake'
 require 'echoe'
 
-Echoe.new('rack-i18n_locale_switcher', '0.2.3') do |p|
+Echoe.new('rack-i18n_locale_switcher', '0.3.0') do |p|
 
- p.description     = "Detects the current locale from url, domain, parameter, session or accept header."
+ p.description     = "Detects the current locale from url, domain, parameter 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"]

data/lib/rack/i18n_locale_switcher.rb

@@ -9,11 +9,8 @@ module Rack
 
     def call(env)
       request = Rack::Request.new(env)
-
-      session = request.session
       locale = extract_locale(request)
-      I18n.locale = session["locale"] = (is_present?(locale) ? locale : I18n.default_locale)
-
+      I18n.locale = (is_present?(locale) ? locale : I18n.default_locale)
       @app.call cleanup_env(env)
     end
 
@@ -44,11 +41,6 @@ module Rack
       locale if is_available?(locale)
     end
 
-    def extract_locale_from_session(request)
-      locale = request.session['locale']
-      locale if is_available?(locale)
-    end
-
     def extract_locale_from_accept_language(request)
       if lang = request.env["HTTP_ACCEPT_LANGUAGE"]
         lang = lang.split(",").map { |l|
@@ -68,7 +60,6 @@ module Rack
                   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

data/rack-i18n_locale_switcher.gemspec

@@ -2,12 +2,12 @@
 
 Gem::Specification.new do |s|
   s.name = "rack-i18n_locale_switcher"
-  s.version = "0.2.3"
+  s.version = "0.3.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-24"
-  s.description = "Detects the current locale from url, domain, parameter, session or accept header."
+  s.date = "2011-11-25"
+  s.description = "Detects the current locale from url, domain, parameter 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", "spec/spec_helper.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 url, domain, parameter, session or accept header."
+  s.summary = "Detects the current locale from url, domain, parameter or accept header."
 
   if s.respond_to? :specification_version then
     s.specification_version = 3

data/spec/i18n_locale_switcher_spec.rb

@@ -33,7 +33,6 @@ describe "Rack::I18nLocaleSwitcher" do
       get '/', :locale => 'xx'
       I18n.locale.should eql(I18n.default_locale)
     end
-
   end
 
   context 'from path prefix ' do
@@ -53,12 +52,10 @@ describe "Rack::I18nLocaleSwitcher" do
 
   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
@@ -67,19 +64,5 @@ describe "Rack::I18nLocaleSwitcher" do
       get '/' , {}, {'HTTP_ACCEPT_LANGUAGE' => "de, de-de,en;q=0.5"}
       I18n.locale.should eql(:de)
     end
-
   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

@@ -1,97 +1,94 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rack-i18n_locale_switcher
-version: !ruby/object:Gem::Version 
+version: !ruby/object:Gem::Version
+  version: 0.3.0
   prerelease: 
-  version: 0.2.3
 platform: ruby
-authors: 
-- "Christoph B\xC3\xBCnte, Andreas Korth"
+authors:
+- Christoph Bünte, Andreas Korth
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-24 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2154406440 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: i18n
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2154406440
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: &2154405980 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: domainatrix
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2154405980
+- !ruby/object:Gem::Dependency
+  name: domainatrix
+  requirement: &2154405520 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: echoe
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *2154405520
+- !ruby/object:Gem::Dependency
+  name: echoe
+  requirement: &2154405060 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: *2154405060
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2154404600 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-- !ruby/object:Gem::Dependency 
-  name: rack-test
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *2154404600
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: &2154404140 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+    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: 
+  prerelease: false
+  version_requirements: *2154404140
+description: Detects the current locale from url, domain, parameter or accept header.
+email:
 - info@christophbuente.de
 - andreas.korth@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - CHANGELOG
 - LICENSE
 - README.md
 - lib/rack/i18n_locale_switcher.rb
-files: 
+files:
 - CHANGELOG
 - LICENSE
 - Manifest
@@ -103,35 +100,32 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/christoph-buente/rack-i18n_locale_switcher
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --line-numbers
 - --inline-source
 - --title
 - Rack-i18n_locale_switcher
 - --main
 - README.md
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      version: "1.2"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.2'
 requirements: []
-
 rubyforge_project: rack-i18n_locale_switcher
 rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Detects the current locale from url, domain, parameter, session or accept header.
+summary: Detects the current locale from url, domain, parameter or accept header.
 test_files: []
-