http_accept_language 2.0.0 → 2.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 64deaf476a87d9192739905f051cd546124d358e
+  data.tar.gz: 5afdaecd6f46c4df2240ae700c0bd66bc131eba1
+SHA512:
+  metadata.gz: 077e921e1398f9925a8498c6bf0c77f54b65c8d7cf6082e77613da8f7599c07d732ef3610f965a276a6529c586e659542ba2c16dd28b04d8d42a9abd5df4fcc8
+  data.tar.gz: 99a4e05c30bc9102686dc890ac5acd63af862eeecfe679e96514aecdbdc6d7380a328c384eba2f8ecb00c32803cbba62d511e384b1b3b4df70f9629815790a48

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+cache: bundler
+sudo: false
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+script: bundle exec rspec spec

data/README.md

@@ -1,9 +1,9 @@
-# HttpAcceptLanguage
+# HttpAcceptLanguage [![Build Status](https://travis-ci.org/iain/http_accept_language.svg?branch=master)](https://travis-ci.org/iain/http_accept_language)
 
 A gem which helps you detect the users preferred language, as sent by the "Accept-Language" HTTP header.
 
-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 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.
 
 Since version 2.0, this gem is Rack middleware.
@@ -43,6 +43,22 @@ class SomeController < ApplicationController
 end
 ```
 
+If you want to enable this behavior by default in your controllers, you can just include the provided concern:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include HttpAcceptLanguage::AutoLocale
+
+#...
+end
+```
+
+Then set available locales in `config/application.rb`:
+
+```ruby
+config.i18n.available_locales = %w(en nl de fr)
+```
+
 To use the middleware in any Rack application, simply add the middleware:
 
 ``` ruby

data/lib/http_accept_language.rb

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

data/lib/http_accept_language/auto_locale.rb

@@ -0,0 +1,17 @@
+require 'active_support/concern'
+
+module HttpAcceptLanguage
+  module AutoLocale
+    extend ActiveSupport::Concern
+
+    included do
+      before_filter :set_locale
+    end
+
+    private
+
+    def set_locale
+      I18n.locale = http_accept_language.compatible_language_from(I18n.available_locales) || I18n.default_locale
+    end
+  end
+end

data/lib/http_accept_language/middleware.rb

@@ -6,6 +6,7 @@ module HttpAcceptLanguage
 
     def call(env)
       env["http_accept_language.parser"] = Parser.new(env["HTTP_ACCEPT_LANGUAGE"])
+      
       def env.http_accept_language
         self["http_accept_language.parser"]
       end

data/lib/http_accept_language/parser.rb

@@ -1,7 +1,5 @@
 module HttpAcceptLanguage
-
   class Parser
-
     attr_accessor :header
 
     def initialize(header)
@@ -17,20 +15,26 @@ module HttpAcceptLanguage
     #   # => [ 'nl-NL', 'nl-BE', 'nl', 'en-US', 'en' ]
     #
     def user_preferred_languages
-      @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|
-        raise "Not correctly formatted" unless x.first =~ /^[a-z\-0-9]+$/i
-        y.last.to_f <=> x.last.to_f
-      end.collect do |l|
-        l.first.downcase.gsub(/-[a-z0-9]+$/i) { |x| x.upcase }
+      @user_preferred_languages ||= begin
+        header.to_s.gsub(/\s+/, '').split(',').map do |language|
+          locale, quality = language.split(';q=')
+          raise ArgumentError, 'Not correctly formatted' unless locale =~ /^[a-z\-0-9]+|\*$/i
+
+          locale  = locale.downcase.gsub(/-[a-z0-9]+$/i, &:upcase) # Uppercase territory
+          locale  = nil if locale == '*' # Ignore wildcards
+
+          quality = quality ? quality.to_f : 1.0
+
+          [locale, quality]
+        end.sort do |(_, left), (_, right)|
+          right <=> left
+        end.map(&:first).compact
+      rescue ArgumentError # Just rescue anything if the browser messed up badly.
+        []
       end
-    rescue # Just rescue anything if the browser messed up badly.
-      []
     end
 
-    # Sets the user languages preference, overiding the browser
+    # Sets the user languages preference, overriding the browser
     #
     def user_preferred_languages=(languages)
       @user_preferred_languages = languages
@@ -44,7 +48,7 @@ module HttpAcceptLanguage
     #   # => 'nl'
     #
     def preferred_language_from(array)
-      (user_preferred_languages & array.collect { |i| i.to_s }).first
+      (user_preferred_languages & array.map(&:to_s)).first
     end
 
     # Returns the first of the user_preferred_languages that is compatible
@@ -55,10 +59,13 @@ module HttpAcceptLanguage
     #   request.compatible_language_from I18n.available_locales
     #
     def compatible_language_from(available_languages)
-      user_preferred_languages.map do |x| #en-US
-        available_languages.find do |y| # en
-          y = y.to_s
-          x == y || x.split('-', 2).first == y.split('-', 2).first
+      user_preferred_languages.map do |preferred| #en-US
+        preferred = preferred.downcase
+        preferred_language = preferred.split('-', 2).first
+
+        available_languages.find do |available| # en
+          available = available.to_s.downcase
+          preferred == available || preferred_language == available.split('-', 2).first
         end
       end.compact.first
     end
@@ -70,12 +77,8 @@ module HttpAcceptLanguage
     # [ja_JP-x1, en-US-x4, en_UK-x5, fr-FR-x3] => [ja-JP, en-US, en-UK, fr-FR]
     #
     def sanitize_available_locales(available_languages)
-      available_languages.map do |avail|
-        split_locale = avail.split(/[_-]/)
-
-        split_locale.map do |e|
-          e unless e.match(/x|[0-9*]/)
-        end.compact.join("-")
+      available_languages.map do |available|
+        available.to_s.split(/[_-]/).reject { |part| part.start_with?("x") }.join("-")
       end
     end
 
@@ -90,15 +93,16 @@ module HttpAcceptLanguage
     #
     def language_region_compatible_from(available_languages)
       available_languages = sanitize_available_locales(available_languages)
-      user_preferred_languages.map do |x| #en-US
-        lang_group = available_languages.select do |y| # en
-          y = y.to_s
-          x.split('-', 2).first == y.split('-', 2).first
+      user_preferred_languages.map do |preferred| #en-US
+        preferred = preferred.downcase
+        preferred_language = preferred.split('-', 2).first
+
+        lang_group = available_languages.select do |available| # en
+          preferred_language == available.downcase.split('-', 2).first
         end
-        lang_group.find{|l| l == x} || lang_group.first #en-US, en-UK
+        
+        lang_group.find { |lang| lang.downcase == preferred } || lang_group.first #en-US, en-UK
       end.compact.first
     end
-
   end
-
 end

data/lib/http_accept_language/railtie.rb

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

data/lib/http_accept_language/version.rb

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

data/spec/auto_locale_spec.rb

@@ -0,0 +1,67 @@
+require 'i18n'
+require 'http_accept_language/auto_locale'
+require 'http_accept_language/parser'
+require 'http_accept_language/middleware'
+
+describe HttpAcceptLanguage::AutoLocale do
+  let(:controller_class) do
+    Class.new do
+      def initialize(header = nil)
+        super()
+        @header = header
+      end
+
+      def self.before_filter(dummy)
+        # dummy method
+      end
+
+      def http_accept_language
+        @http_accept_language ||= HttpAcceptLanguage::Parser.new(@header)
+      end
+
+      include HttpAcceptLanguage::AutoLocale
+    end
+  end
+
+  let(:controller) { controller_class.new("ja,en-us;q=0.7,en;q=0.3") }
+
+  context "available languages includes accept_languages" do
+    before do
+      I18n.available_locales = [:en, :ja]
+    end
+
+    it "take a suitable locale" do
+      controller.send(:set_locale)
+
+      expect(I18n.locale).to eq(:ja)
+    end
+  end
+
+  context "available languages do not include accept_languages" do
+    before do
+      I18n.available_locales = [:es]
+      I18n.default_locale = :es
+    end
+
+    it "set the locale to default" do
+      no_accept_language_controller.send(:set_locale)
+
+      expect(I18n.locale).to eq(:es)
+    end
+  end
+
+  let(:no_accept_language_controller) { controller_class.new() }
+
+  context "default locale is ja" do
+    before do
+      I18n.available_locales = [:en, :ja]
+      I18n.default_locale = :ja
+    end
+
+    it "set the locale to default" do
+      no_accept_language_controller.send(:set_locale)
+
+      expect(I18n.locale).to eq(:ja)
+    end
+  end
+end

data/spec/middleware_spec.rb

@@ -33,20 +33,20 @@ describe "Rack integration" do
     app = lambda { |env| env }
     middleware = HttpAcceptLanguage::Middleware.new(app)
     middleware.call(env)
-    env.http_accept_language.user_preferred_languages.should eq %w{en}
+    expect(env.http_accept_language.user_preferred_languages).to eq %w{en}
     env["HTTP_ACCEPT_LANGUAGE"] = "de"
     middleware.call(env)
-    env.http_accept_language.user_preferred_languages.should eq %w{de}
+    expect(env.http_accept_language.user_preferred_languages).to 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}
+    expect(r['user_preferred_languages']).to eq %w{en-US es-419 en-GB en}
   end
 
   it "finds the first available language" do
     request_with_header 'en-us,en-gb;q=0.8,en;q=0.6,es-419', :preferred => %w(en en-GB)
-    r['preferred_language_from'].should eq 'en-GB'
+    expect(r['preferred_language_from']).to eq 'en-GB'
   end
 
   def request_with_header(header, params = {})

data/spec/parser_spec.rb

@@ -8,49 +8,58 @@ describe HttpAcceptLanguage::Parser do
 
   it "should return empty array" do
     parser.header = nil
-    parser.user_preferred_languages.should eq []
+    expect(parser.user_preferred_languages).to eq []
   end
 
   it "should properly split" do
-    parser.user_preferred_languages.should eq %w{en-US es-419 en-GB en}
+    expect(parser.user_preferred_languages).to eq %w{en-US es-419 en-GB en}
   end
 
   it "should ignore jambled header" do
     parser.header = 'odkhjf89fioma098jq .,.,'
-    parser.user_preferred_languages.should eq []
+    expect(parser.user_preferred_languages).to 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}
+    expect(parser.user_preferred_languages).to 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"
+    expect(parser.preferred_language_from(%w{en en-GB})).to eq "en-GB"
   end
 
   it "should find first compatible language" do
-    parser.compatible_language_from(%w{en-hk}).should eq "en-hk"
-    parser.compatible_language_from(%w{en}).should eq "en"
+    expect(parser.compatible_language_from(%w{en-hk})).to eq "en-hk"
+    expect(parser.compatible_language_from(%w{en})).to eq "en"
   end
 
   it "should find first compatible from user preferred" do
     parser.header = 'en-us,de-de'
-    parser.compatible_language_from(%w{de en}).should eq 'en'
+    expect(parser.compatible_language_from(%w{de en})).to eq 'en'
   end
 
   it "should accept symbols as available languages" do
     parser.header = 'en-us'
-    parser.compatible_language_from([:"en-HK"]).should eq :"en-HK"
+    expect(parser.compatible_language_from([:"en-HK"])).to eq :"en-HK"
+  end
+
+  it "should accept and ignore wildcards" do
+    parser.header = 'en-US,en,*'
+    expect(parser.compatible_language_from([:"en-US"])).to eq :"en-US"
   end
 
   it "should sanitize available language names" do
-    parser.sanitize_available_locales(%w{en_UK-x3 en-US-x1 ja_JP-x2 pt-BR-x5}).should eq ["en-UK", "en-US", "ja-JP", "pt-BR"]
+    expect(parser.sanitize_available_locales(%w{en_UK-x3 en-US-x1 ja_JP-x2 pt-BR-x5 es-419-x4})).to eq ["en-UK", "en-US", "ja-JP", "pt-BR", "es-419"]
+  end
+
+  it "should accept available language names as symbols and return them as strings" do
+    expect(parser.sanitize_available_locales([:en, :"en-US", :ca, :"ca-ES"])).to eq ["en", "en-US", "ca", "ca-ES"]
   end
 
   it "should find most compatible language from user preferred" do
     parser.header = 'ja,en-gb,en-us,fr-fr'
-    parser.language_region_compatible_from(%w{en-UK en-US ja-JP}).should eq "ja-JP"
+    expect(parser.language_region_compatible_from(%w{en-UK en-US ja-JP})).to eq "ja-JP"
   end
 
 end

metadata

@@ -1,93 +1,113 @@
 --- !ruby/object:Gem::Specification
 name: http_accept_language
 version: !ruby/object:Gem::Version
-  version: 2.0.0
-  prerelease: 
+  version: 2.1.0
 platform: ruby
 authors:
 - iain
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-06 00:00:00.000000000 Z
+date: 2016-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70157591116080 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70157591116080
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70157591115660 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70157591115660
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70157591115240 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70157591115240
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70157591114820 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70157591114820
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70157591114320 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.6
   type: :development
   prerelease: false
-  version_requirements: *70157591114320
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.6
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70157591113900 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70157591113900
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &70157578096080 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70157578096080
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Find out which locale the user preferes by reading the languages they
   specified in their browser
 email:
@@ -96,8 +116,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - README.md
@@ -108,41 +129,43 @@ files:
 - features/support/rails_driver.rb
 - http_accept_language.gemspec
 - lib/http_accept_language.rb
+- lib/http_accept_language/auto_locale.rb
 - lib/http_accept_language/middleware.rb
 - lib/http_accept_language/parser.rb
 - lib/http_accept_language/railtie.rb
 - lib/http_accept_language/version.rb
+- spec/auto_locale_spec.rb
 - spec/middleware_spec.rb
 - spec/parser_spec.rb
 homepage: https://github.com/iain/http_accept_language
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: http_accept_language
-rubygems_version: 1.8.6
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Find out which locale the user preferes by reading the languages they specified
   in their browser
 test_files:
 - features/rails_integration.feature
 - features/steps/rails.rb
 - features/support/rails_driver.rb
+- spec/auto_locale_spec.rb
 - spec/middleware_spec.rb
 - spec/parser_spec.rb