http_accept_language 2.0.0.pre → 2.0.0

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -1,45 +1,49 @@
 # HttpAcceptLanguage
 
-A small effort in making a plugin which helps you detect the users preferred language, as sent by the HTTP header.
+A gem which helps you detect the users preferred language, as sent by the "Accept-Language" HTTP header.
 
-Since version 2.0, this gem is Rack middleware.
-
-## Features
-
-* Splits the http-header into languages specified by the user
-* Returns empty array if header is illformed.
-* Corrects case to xx-XX
-* Sorted by priority given, as much as possible.
-* Gives you the most important language
-* Gives compatible languages
+The algorithm is based on [RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html), with one exception: 
+when a user requests "en-US" and "en" is an available language, "en" is deemed compatible with "en-US". 
+The RFC specifies that the requested language must either exactly match the available language or must exactly match a prefix of the available language. This means that when the user requests "en" and "en-US" is available, "en-US" would be compatible, but not the other way around. This is usually not what you're looking for.
 
-See also: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
+Since version 2.0, this gem is Rack middleware.
 
 ## Example
 
-When using in Rails:
+The `http_accept_language` method is available in any controller:
 
-``` ruby
+```ruby
 class SomeController < ApplicationController
-
   def some_action
-
-    http_accept_language.user_preferred_languages # => [ 'nl-NL', 'nl-BE', 'nl', 'en-US', 'en' ]
-    available = %w{en en-US nl-BE}
+    http_accept_language.user_preferred_languages # => %w(nl-NL nl-BE nl en-US en)
+    available = %w(en en-US nl-BE)
     http_accept_language.preferred_language_from(available) # => 'nl-BE'
 
-    http_accept_language.user_preferred_languages # => [ 'en-GB']
-    available = %w{en-US}
+    http_accept_language.user_preferred_languages # => %w(en-GB)
+    available = %w(en-US)
     http_accept_language.compatible_language_from(available) # => 'en-US'
 
+    http_accept_language.user_preferred_languages # => %w(nl-NL nl-BE nl en-US en)
+    available = %w(en nl de) # This could be from I18n.available_locales
+    http_accept_language.preferred_language_from(available) # => 'nl'
   end
-
 end
 ```
 
-Older versions of Rails (pre 3.0) might need to include the middleware manually.
+You can easily set the locale used for i18n in a before-filter:
 
-Usage in any Rack application, simple add the middleware:
+```ruby
+class SomeController < ApplicationController
+  before_filter :set_locale
+
+  private
+    def set_locale
+      I18n.locale = http_accept_language.compatible_language_from(I18n.available_locales)
+    end
+end
+```
+
+To use the middleware in any Rack application, simply add the middleware:
 
 ``` ruby
 require 'http_accept_language'
@@ -47,15 +51,20 @@ use HttpAcceptLanguage::Middleware
 run YourAwesomeApp
 ```
 
-Then you can access it:
+Then you can access it from `env`:
 
 ``` ruby
 class YourAwesomeApp
 
-  def self.call(env)
+  def initialize(app)
+    @app = app
+  end
+
+  def call(env)
     available = %w(en en-US nl-BE)
     language = env.http_accept_language.preferred_language_from(available)
-    [ 200, {}, ["Oh, you speak #{language}!"]]
+
+    [200, {}, ["Oh, you speak #{language}!"]]
   end
 
 end
@@ -65,15 +74,15 @@ end
 
 * **user_preferred_languages**:
   Returns a sorted array based on user preference in HTTP_ACCEPT_LANGUAGE, sanitized and all.
-* **preferred_language_from**:
+* **preferred_language_from(languages)**:
   Finds the locale specifically requested by the browser
-* **compatible_language_from**:
+* **compatible_language_from(languages)**:
   Returns the first of the user_preferred_languages that is compatible with the available locales.
   Ignores region.
-* **sanitize_available_locales**:
+* **sanitize_available_locales(languages)**:
   Returns a supplied list of available locals without any extra application info
   that may be attached to the locale for storage in the application.
-* **language_region_compatible_from**:
+* **language_region_compatible_from(languages)**:
   Returns the first of the user preferred languages that is
   also found in available languages.  Finds best fit by matching on
   primary language first and secondarily on region.  If no matching region is
@@ -81,7 +90,6 @@ end
 
 ## Installation
 
-
 ### Without Bundler
 
 Install the gem `http_accept_language`

data/http_accept_language.gemspec

@@ -1,5 +1,6 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/http_accept_language/version', __FILE__)
+$:.push File.expand_path("../lib", __FILE__)
+require "http_accept_language/version"
 
 Gem::Specification.new do |s|
   s.name        = "http_accept_language"
@@ -9,6 +10,7 @@ Gem::Specification.new do |s|
   s.homepage    = "https://github.com/iain/http_accept_language"
   s.summary     = %q{Find out which locale the user preferes by reading the languages they specified in their browser}
   s.description = %q{Find out which locale the user preferes by reading the languages they specified in their browser}
+  s.license     = "MIT"
 
   s.rubyforge_project = "http_accept_language"
 

data/lib/http_accept_language.rb

@@ -1,4 +1,3 @@
-require 'http_accept_language/version'
 require 'http_accept_language/parser'
 require 'http_accept_language/middleware'
 require 'http_accept_language/railtie' if defined?(Rails::Railtie)

data/lib/http_accept_language/middleware.rb

@@ -1,16 +1,16 @@
 module HttpAcceptLanguage
   class Middleware
-
     def initialize(app)
       @app = app
     end
 
     def call(env)
+      env["http_accept_language.parser"] = Parser.new(env["HTTP_ACCEPT_LANGUAGE"])
       def env.http_accept_language
-        @http_accept_language ||= Parser.new(self['HTTP_ACCEPT_LANGUAGE'])
+        self["http_accept_language.parser"]
       end
+      
       @app.call(env)
     end
-
   end
 end

data/lib/http_accept_language/parser.rb

@@ -17,7 +17,7 @@ module HttpAcceptLanguage
     #   # => [ 'nl-NL', 'nl-BE', 'nl', 'en-US', 'en' ]
     #
     def user_preferred_languages
-      @user_preferred_languages ||= header.split(/\s*,\s*/).collect do |l|
+      @user_preferred_languages ||= header.gsub(/\s+/, '').split(/,/).collect do |l|
         l += ';q=1.0' unless l =~ /;q=\d+\.\d+$/
           l.split(';q=')
       end.sort do |x,y|

data/lib/http_accept_language/railtie.rb

@@ -1,17 +1,17 @@
 module HttpAcceptLanguage
   class Railtie < ::Rails::Railtie
-
     initializer "http_accept_language.add_middleware" do |app|
       app.middleware.use Middleware
-      ApplicationController.send :include, EasyAccess
+      
+      ActiveSupport.on_load :action_controller do
+        include EasyAccess
+      end
     end
-
   end
 
   module EasyAccess
     def http_accept_language
-      env.http_accept_language
+      @http_accept_language ||= request.env["http_accept_language.parser"] || Parser.new("")
     end
   end
-
 end

data/lib/http_accept_language/version.rb

@@ -1,3 +1,3 @@
 module HttpAcceptLanguage
-  VERSION = '2.0.0.pre'
+  VERSION = '2.0.0'
 end

data/spec/middleware_spec.rb

@@ -28,6 +28,17 @@ describe "Rack integration" do
     end.to_app
   end
 
+  it "handles reuse of the env instance" do
+    env = { "HTTP_ACCEPT_LANGUAGE" => "en" }
+    app = lambda { |env| env }
+    middleware = HttpAcceptLanguage::Middleware.new(app)
+    middleware.call(env)
+    env.http_accept_language.user_preferred_languages.should eq %w{en}
+    env["HTTP_ACCEPT_LANGUAGE"] = "de"
+    middleware.call(env)
+    env.http_accept_language.user_preferred_languages.should eq %w{de}
+  end
+
   it "decodes the HTTP_ACCEPT_LANGUAGE header" do
     request_with_header 'en-us,en-gb;q=0.8,en;q=0.6,es-419'
     r['user_preferred_languages'].should eq %w{en-US es-419 en-GB en}

data/spec/parser_spec.rb

@@ -20,6 +20,11 @@ describe HttpAcceptLanguage::Parser do
     parser.user_preferred_languages.should eq []
   end
 
+  it "should properly respect whitespace" do
+    parser.header = 'en-us, en-gb; q=0.8,en;q = 0.6,es-419'
+    parser.user_preferred_languages.should eq %w{en-US es-419 en-GB en}
+  end
+
   it "should find first available language" do
     parser.preferred_language_from(%w{en en-GB}).should eq "en-GB"
   end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: http_accept_language
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre
-  prerelease: 6
+  version: 2.0.0
+  prerelease: 
 platform: ruby
 authors:
 - iain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-13 00:00:00.000000000 Z
+date: 2013-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70157591116080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,15 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70157591116080
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70157591115660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,15 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70157591115660
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70157591115240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -53,15 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70157591115240
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70157591114820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -69,15 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70157591114820
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70157591114320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -85,15 +65,10 @@ dependencies:
         version: 3.2.6
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.2.6
+  version_requirements: *70157591114320
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70157591113900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -101,15 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70157591113900
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70157578096080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -117,12 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70157578096080
 description: Find out which locale the user preferes by reading the languages they
   specified in their browser
 email:
@@ -150,7 +115,8 @@ files:
 - spec/middleware_spec.rb
 - spec/parser_spec.rb
 homepage: https://github.com/iain/http_accept_language
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -164,12 +130,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: http_accept_language
-rubygems_version: 1.8.24
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
 summary: Find out which locale the user preferes by reading the languages they specified