locale_detector 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+log/*

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in locale_detector.gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright © 2011 Exvo.com Development BV
+
+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,40 @@
+# Locale Detector
+
+This Rails gem makes use of the HTTP_ACCEPT_LANGUAGE http header sent by web browsers with every request, to set the `I18n.locale` setting.
+When this fails (for example if there is no such http header - as is the case for Google bot), it will try to determine the locale based on the toplevel domain suffix (so it will set 'de' for the `example.de` domain).
+When both fail, it will fall back to the `LocaleDetector.fallback_locale`, which is 'en' by default and can be overriden in `config/initializers/locale_detector.rb`.
+
+The HTTP_ACCEPT_LANGUAGE header parser is based on:
+https://github.com/iain/http_accept_language/blob/master/lib/http_accept_language.rb
+
+
+## Installation
+
+Install the gem
+
+```bash
+$ gem install locale_detector
+```
+
+add it to the Gemfile
+
+```ruby
+gem 'locale_detector'
+```
+
+and bundle
+
+```bash
+$ bundle
+```
+
+
+You can optionally overwrite the default fallback locale by creating a `config/initializers/locale_detector.rb` file and set the `fallback_locale` to a new string, for example:
+
+```ruby
+LocaleDetector.fallback_locale = 'pl'
+```
+
+
+
+Copyright © 2011 Exvo.com Development BV, released under the MIT license

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/locale_detector.rb

@@ -0,0 +1,8 @@
+require "locale_detector/fallback_locale"
+require "locale_detector/filter"
+require "locale_detector/version"
+
+# Make it a Railtie
+module LocaleDetector
+  require 'locale_detector/railtie' if defined?(Rails)
+end

data/lib/locale_detector/fallback_locale.rb

@@ -0,0 +1,5 @@
+module LocaleDetector
+  @@fallback_locale = 'en'
+
+  mattr_accessor :fallback_locale
+end

data/lib/locale_detector/filter.rb

@@ -0,0 +1,45 @@
+module LocaleDetector
+  module Filter
+    extend ActiveSupport::Concern
+
+    included do
+      prepend_before_filter :set_locale
+    end
+
+    protected
+
+    def set_locale
+      I18n.locale = begin
+        request.env['HTTP_ACCEPT_LANGUAGE'].split(/\s*,\s*/).collect do |l|
+          l += ';q=1.0' unless l =~ /;q=\d+\.\d+$/
+          l.split(';q=')
+        end.sort do |x,y|
+          raise "Incorrect format" unless x.first =~ /^[a-z\-]+$/i
+          y.last.to_f <=> x.last.to_f
+        end.first.first.gsub(/-[a-z]+$/i, '').downcase
+      rescue # rescue (anything) from the malformed (or missing) accept language headers
+
+        # parse request.host and try to set the locale based on toplevel domain suffix (for netbots mostly)
+        suffix = request.host.split('.').last
+
+        # somewhat incomplete list of more common toplevel domains
+        if [:bg, :be, :cn, :cz, :da, :de, :es, :et, :fi, :fr, :gr, :hi, :hr, :hu, :is, :it, :jp, :ko, :lv, :lt,
+            :mk, :nl, :no, :pl, :pt, :ro, :ru, :se, :sr, :sk, :sl, :tr, :vi, :ua].include?(suffix.to_sym)
+          suffix
+        # some common international/English domains
+        elsif [:eu, :uk, :us].include?(suffix.to_sym)
+          'en'
+        # Spanish speaking countries
+        elsif [:ar, :cl, :co, :cu, :mx].include?(suffix.to_sym)
+          'es'
+        # Portuguese speaking countries
+        elsif suffix == 'br'
+          'pt'
+        # fall back to fallback_locale for .com and all other domains ('en' by default)
+        else
+          LocaleDetector.fallback_locale
+        end
+      end
+    end
+  end
+end

data/lib/locale_detector/railtie.rb

@@ -0,0 +1,12 @@
+require 'locale_detector'
+require 'rails'
+
+module LocaleDetector
+  class Railtie < Rails::Railtie
+    initializer "locale_detector.prepend_before_filter" do
+      ActiveSupport.on_load(:action_controller) do
+        ActionController::Base.send(:include, LocaleDetector::Filter)
+      end
+    end
+  end
+end

data/lib/locale_detector/version.rb

@@ -0,0 +1,3 @@
+module LocaleDetector
+  VERSION = "0.0.1"
+end

data/locale_detector.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "locale_detector/version"
+
+Gem::Specification.new do |s|
+  s.name        = "locale_detector"
+  s.version     = LocaleDetector::VERSION
+  s.authors     = ["Paweł Gościcki"]
+  s.email       = ["pawel.goscicki@gmail.com"]
+  s.homepage    = "https://github.com/Exvo/locale_detector"
+  s.summary     = "Rails gem setting the I18n.locale based on user's browser language"
+  s.description = "Parses HTTP_ACCEPT_LANGUAGE http header and sets the I18n.locale based on that"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.licenses = ['MIT']
+
+  s.add_dependency 'rails', ['>= 3.0.0']
+  s.add_dependency 'i18n', ['>= 0.5.0']
+  s.add_development_dependency 'guard', ['>= 0.5.0']
+  s.add_development_dependency 'guard-rspec', ['>= 0.4.0']
+  s.add_development_dependency 'rspec', ['>= 2.6']
+  s.add_development_dependency 'rspec-rails', ['>= 2.6']
+end

data/spec/locale_detector/fallback_locale_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+
+describe LocaleDetector do
+
+  subject { LocaleDetector.fallback_locale }
+
+  it { should_not be_empty }
+
+end

data/spec/locale_detector/filter_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe LocaleDetector::Filter do
+
+  def set_locale(opts = {})
+    filter = Object.new.extend(LocaleDetector::Filter)
+
+    request = if opts[:language].present?
+        double('request', :env => { 'HTTP_ACCEPT_LANGUAGE' => opts[:language] })
+      else
+        double('request', :env => nil, :host => opts[:host])
+      end
+
+    filter.stub(:request).and_return(request)
+    filter.send(:set_locale)
+  end
+
+  context "http header locale setting" do
+
+    specify { set_locale(:language => 'pl').should eql('pl') }
+
+    specify { set_locale(:language => 'pl-PL').should eql('pl') }
+
+    specify { set_locale(:language => 'pl,en-us;q=0.7,en;q=0.3').should eql('pl') }
+
+    specify { set_locale(:language => 'lt,en-us;q=0.8,en;q=0.6,ru;q=0.4,pl;q=0.2').should eql('lt') }
+
+    specify { set_locale(:language => 'pl-PL;q=0.1,en-us;q=0.7,en;q=0.3').should eql('en') }
+
+  end
+
+  context "host based locale setting" do
+
+    specify { set_locale(:host => 'example.pl').should eql('pl') }
+
+    specify { set_locale(:host => 'example.co.uk').should eql('en') }
+
+    specify { set_locale(:host => 'example.mx').should eql('es') }
+
+    specify { set_locale(:host => 'example.br').should eql('pt') }
+
+    specify { set_locale(:host => 'example.com').should eql(LocaleDetector.fallback_locale) }
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$:.unshift(File.dirname(__FILE__))
+
+require 'rails'
+require 'locale_detector'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification 
+name: locale_detector
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Pawe\xC5\x82 Go\xC5\x9Bcicki"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-11 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: guard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 0
+        - 5
+        - 0
+        version: 0.5.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: guard-rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 0
+        - 4
+        - 0
+        version: 0.4.0
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :development
+  version_requirements: *id006
+description: Parses HTTP_ACCEPT_LANGUAGE http header and sets the I18n.locale based on that
+email: 
+- pawel.goscicki@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/locale_detector.rb
+- lib/locale_detector/fallback_locale.rb
+- lib/locale_detector/filter.rb
+- lib/locale_detector/railtie.rb
+- lib/locale_detector/version.rb
+- locale_detector.gemspec
+- spec/locale_detector/fallback_locale_spec.rb
+- spec/locale_detector/filter_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: https://github.com/Exvo/locale_detector
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+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.6.2
+signing_key: 
+specification_version: 3
+summary: Rails gem setting the I18n.locale based on user's browser language
+test_files: []
+