panmind-http_accept_language 1.1.0

data/.gitignore

@@ -0,0 +1,4 @@
+pkg
+.*.sw?
+.DS_Store
+*.gemspec

data/README.rdoc

@@ -0,0 +1,44 @@
+= HttpAcceptLanguage
+
+A small effort in making a plugin which helps you detect the users preferred language, as sent by the HTTP header.
+
+== 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
+See also: http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
+
+== Example
+
+  class SomeController < ApplicationController
+    def some_action
+      
+      request.user_preferred_languages
+      # => [ 'nl-NL', 'nl-BE', 'nl', 'en-US', 'en' ]
+      
+      available = %w{en en-US nl-BE}
+      request.preferred_language_from(available)
+      # => 'nl-BE'
+      
+      request.user_preferred_languages
+      # => [ 'en-GB']
+      available = %w{en-US}
+      request.compatible_language_from(available)
+      # => 'en-US'
+    end
+  end
+
+== Installation
+
+Install the gem <tt>http_accept_language</tt>, require it in your Rails app.
+
+== Changelog
+
+* 2010-01-05: Gem release
+* 2009-03-12: Rails 2.3 compatible
+
+Copyright (c) 2008-2010 Iain Hecker, released under the MIT license

data/Rakefile

@@ -0,0 +1,37 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "panmind-http_accept_language"
+    gem.summary = %Q{Parse the HTTP Accept Language Header}
+    gem.description = %Q{Find out which locale the user preferes by reading the languages they specified in their browser}
+    gem.email = "marcello.barnaba@gmail.com"
+    gem.homepage = "http://github.com/Panmind/http_accept_language"
+    gem.authors = ["Iain Hecker", "Marcello Barnaba"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+desc 'Test the http_accept_language plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+require 'rake/rdoctask'
+desc 'Generate documentation for the http_accept_language plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HttpAcceptLanguage'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.1.0

data/lib/http_accept_language.rb

@@ -0,0 +1,89 @@
+module HttpAcceptLanguage
+
+  # Returns a sorted array based on user preference in sent via
+  # the Accept-Language HTTP header. Don't think this is holy!
+  #
+  # Returns an empty array if the header does not contain any
+  # parsable language code.
+  #
+  # Example:
+  #
+  #   Accept-Language: en;q=0.3, nl-NL, nl-be;q=0.9, en-US;q=0.5
+  #
+  #   request.user_preferred_languages
+  #   # => [ 'nl-NL', 'nl-BE', 'nl', 'en-US', 'en' ]
+  #
+  def user_preferred_languages
+    @user_preferred_languages ||= env['HTTP_ACCEPT_LANGUAGE']
+      .scan(/\b([a-z]{2}(?:-[a-z]{2})?)(?:;q=([01](?:\.\d)?))?\s*($|,)/)
+      .sort_by {|l, pref| 1 - (pref || 1).to_f}
+      .map! {|l,| l.downcase.sub(/-\w{2}/) { $&.upcase } }
+
+  rescue # Just rescue anything if the browser messed up badly.
+    []
+  end
+
+  # Returns a sorted array of language codes symbols based on user's
+  # browser preference sent via the Accept-Language HTTP header.
+  #
+  # Example:
+  #
+  #   Accept-Language: en;q=0.3, nl-NL, nl-be;q=0.9, en-US;q=0.5
+  #
+  #   request.user_preferred_languages
+  #   # => [ :nl, :en ]
+  #
+  def user_preferred_language_codes
+    @user_preferred_language_codes ||=
+      strip_region_from user_preferred_languages
+  end
+
+  # Sets the user languages preference, overiding the browser
+  #
+  def user_preferred_languages=(languages)
+    @user_preferred_languages = languages
+    @user_preferred_language_codes = nil
+  end
+
+  # Returns a preferred language from an array containing
+  # language codes with regions.
+  #
+  # Example:
+  #
+  #   Accept-Language: en;q=0.3, nl-NL, nl-be;q=0.9, en-US;q=0.5
+  #
+  #   request.preferred_language_from %w( it fr nl nl-NL )
+  #   # => 'nl'
+  #
+  def preferred_language_from(array)
+    (user_preferred_languages & array.map(&:to_s)).first
+  end
+
+  # Returns the first of the user_preferred_languages that
+  # is included into the given array, ignoring region.
+  #
+  # Useful with Rails' I18n.available_locales.
+  #
+  # Example:
+  #
+  #   Accept-Language: en;q=0.3, nl-NL, nl-be;q=0.9, en-US;q=0.5
+  #
+  #   request.compatible_language_from [:nl, :it]
+  #   # => 'nl'
+  #
+  def compatible_language_from(array)
+    (user_preferred_language_codes & strip_region_from(array)).first
+  end
+
+  private
+    def strip_region_from(languages)
+      languages.map {|l| l.to_s.sub(/-\w{2}/, '')}.uniq
+    end
+end
+if defined?(ActionDispatch::Request)
+  ActionDispatch::Request.send :include, HttpAcceptLanguage
+elsif defined?(ActionDispatch::AbstractRequest)
+  ActionDispatch::AbstractRequest.send :include, HttpAcceptLanguage
+elsif defined?(ActionDispatch::CgiRequest)
+  ActionDispatch::CgiRequest.send :include, HttpAcceptLanguage
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require "http_accept_language"

data/test/http_accept_language_test.rb

@@ -0,0 +1,55 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'http_accept_language'
+require 'test/unit'
+
+class MockedCgiRequest
+  include HttpAcceptLanguage
+  def env
+    @env ||= {'HTTP_ACCEPT_LANGUAGE' => 'it;q=0.4,en-us, en-gb;q=0.8,en;q=0.6, de;q=2, invalid;q=1, xx;q=30,, ., .'}
+  end
+end
+
+class HttpAcceptLanguageTest < Test::Unit::TestCase
+  def test_should_return_empty_array
+    request.env['HTTP_ACCEPT_LANGUAGE'] = nil
+    assert_equal [], request.user_preferred_languages
+  end
+
+  def test_should_properly_split
+    assert_equal %w{en-US en-GB en it}, request.user_preferred_languages
+  end
+
+  def test_should_ignore_jambled_header
+    request.env['HTTP_ACCEPT_LANGUAGE'] = 'odkhjf89fioma098jq .,.,'
+    assert_equal [], request.user_preferred_languages
+  end
+
+  def test_should_find_first_available_language
+    assert_equal 'en-GB', request.preferred_language_from(%w{en en-GB})
+  end
+
+  def test_should_find_first_compatible_language
+    assert_equal 'en', request.compatible_language_from(%w{en-hk en-GB en})
+    assert_equal 'it', request.compatible_language_from(%w{it de})
+  end
+
+  def test_should_find_first_compatible_from_user_preferred
+    request.env['HTTP_ACCEPT_LANGUAGE'] = 'en-us,de-de'
+    assert_equal 'en', request.compatible_language_from(%w{de en})
+  end
+
+  def test_should_find_first_compatible_from_user_preferred_in_order
+    request.env['HTTP_ACCEPT_LANGUAGE'] = 'de-de, en-us'
+    assert_equal 'de', request.compatible_language_from(%w{de en})
+  end
+  
+  def test_should_accept_symbols_as_available_languages
+    request.env['HTTP_ACCEPT_LANGUAGE'] = 'en-us'
+    assert_equal 'en', request.compatible_language_from([:en, :de])
+  end
+
+  private
+  def request
+    @request ||= MockedCgiRequest.new
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: panmind-http_accept_language
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 1
+  - 1
+  - 0
+  version: 1.1.0
+platform: ruby
+authors: 
+- Iain Hecker
+- Marcello Barnaba
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-27 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Find out which locale the user preferes by reading the languages they specified in their browser
+email: marcello.barnaba@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- README.rdoc
+- Rakefile
+- VERSION
+- http_accept_language.gemspec
+- lib/http_accept_language.rb
+- rails/init.rb
+- test/http_accept_language_test.rb
+has_rdoc: true
+homepage: http://github.com/Panmind/http_accept_language
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Parse the HTTP Accept Language Header
+test_files: 
+- test/http_accept_language_test.rb