rails_locale_detection 1.0.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

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

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem 'http_accept_language'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'i18n'
+  gem 'timecop'
+  gem 'actionpack', '~> 3.1.1'
+  gem 'activesupport', '~> 3.1.1'
+  gem "rspec", "~> 2.3.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,69 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      i18n (~> 0.6)
+      rack (~> 1.3.5)
+      rack-cache (~> 1.1)
+      rack-mount (~> 0.8.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.0.3)
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
+      builder (~> 3.0.0)
+      i18n (~> 0.6)
+    activesupport (3.1.3)
+      multi_json (~> 1.0)
+    builder (3.0.0)
+    diff-lcs (1.1.3)
+    erubis (2.7.0)
+    git (1.2.5)
+    hike (1.2.1)
+    http_accept_language (1.0.2)
+    i18n (0.6.0)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    multi_json (1.0.3)
+    rack (1.3.5)
+    rack-cache (1.1)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    sprockets (2.0.3)
+      hike (~> 1.2)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    tilt (1.3.3)
+    timecop (0.3.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  actionpack (~> 3.1.1)
+  activesupport (~> 3.1.1)
+  bundler (~> 1.0.0)
+  http_accept_language
+  i18n
+  jeweler (~> 1.6.4)
+  rcov
+  rspec (~> 2.3.0)
+  timecop

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Mateo Murphy
+
+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.rdoc

@@ -0,0 +1,40 @@
+= rails_locale_detection
+
+Sets the current locale of a request using a combination of params, cookies, and http headers. 
+
+In turn, it checks the value of params[:locale], cookies[:locale] and finally HTTP_ACCEPT_LANGUAGE headers to find a locale that
+corresponds to the available locales, then stores the set locale in a cookie for future requests.
+
+== Usage
+
+Include the gem in your Gemfile 
+
+  gem 'rails_locale_detection'
+  
+Set your default and available locales
+
+  I18n.default_locale = :en
+  I18n.available_locales = [:en, :fr]
+  
+Call set_locale as a filter in your controllers
+
+  class ApplicationController < ActionController::Base
+    before_filter :set_locale
+    
+  end
+
+== Contributing to rails_locale_detection
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Mateo Murphy. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "rails_locale_detection"
+  gem.homepage = "http://github.com/mateomurphy/rails_locale_detection"
+  gem.license = "MIT"
+  gem.summary = %Q{locale setting for rails project}
+  gem.description = %Q{Sets the current locale of a request using a combination of params, cookies, and http headers}
+  gem.email = "mateo.murphy@gmail.com"
+  gem.authors = ["Mateo Murphy"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rails_locale_detection #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/rails/locale_detection.rb

@@ -0,0 +1,45 @@
+module Rails
+  module LocaleDetection
+    mattr_accessor :locale_expiry
+    @@locale_expiry = 3.months
+    
+    def available_locales
+      I18n.available_locales
+    end
+  
+    def default_locale
+      I18n.default_locale
+    end
+  
+    # returns the (symbolized) value passed if it's in the available_locales
+    def validate_locale(locale)
+      locale.to_sym if locale && available_locales.include?(locale.to_sym)
+    end
+  
+    def locale_from_param
+      validate_locale(params[:locale])
+    end
+  
+    def locale_from_cookies
+      validate_locale(cookies[:locale])
+    end  
+  
+    def locale_from_request
+      validate_locale(request.preferred_language_from(available_locales))
+    end
+  
+    def get_locale
+      locale_from_param || locale_from_cookies || locale_from_request || default_locale
+    end
+    
+    # set I18n.locale, default_url_options[:locale] and cookies[:locale] to the value returned by
+    # get_locale
+    def set_locale
+      default_url_options[:locale] = I18n.locale = get_locale
+      
+      cookies[:locale] = { :value => I18n.locale, :expires => locale_expiry.from_now }
+      
+      I18n.locale
+    end  
+  end
+end

data/lib/rails_locale_detection.rb

@@ -0,0 +1,4 @@
+require 'http_accept_language'
+require 'rails/locale_detection'
+
+ActionController::Base.send :include, Rails::LocaleDetection if defined?(ActionController)

data/rails_locale_detection.gemspec

@@ -0,0 +1,77 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rails_locale_detection}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Mateo Murphy"]
+  s.date = %q{2011-12-16}
+  s.description = %q{Sets the current locale of a request using a combination of params, cookies, and http headers}
+  s.email = %q{mateo.murphy@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/rails/locale_detection.rb",
+    "lib/rails_locale_detection.rb",
+    "rails_locale_detection.gemspec",
+    "spec/rails_locale_detection_spec.rb",
+    "spec/spec_helper.rb",
+    "spec/support/mock.rb"
+  ]
+  s.homepage = %q{http://github.com/mateomurphy/rails_locale_detection}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{locale setting for rails project}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<http_accept_language>, [">= 0"])
+      s.add_development_dependency(%q<i18n>, [">= 0"])
+      s.add_development_dependency(%q<timecop>, [">= 0"])
+      s.add_development_dependency(%q<actionpack>, ["~> 3.1.1"])
+      s.add_development_dependency(%q<activesupport>, ["~> 3.1.1"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+    else
+      s.add_dependency(%q<http_accept_language>, [">= 0"])
+      s.add_dependency(%q<i18n>, [">= 0"])
+      s.add_dependency(%q<timecop>, [">= 0"])
+      s.add_dependency(%q<actionpack>, ["~> 3.1.1"])
+      s.add_dependency(%q<activesupport>, ["~> 3.1.1"])
+      s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<http_accept_language>, [">= 0"])
+    s.add_dependency(%q<i18n>, [">= 0"])
+    s.add_dependency(%q<timecop>, [">= 0"])
+    s.add_dependency(%q<actionpack>, ["~> 3.1.1"])
+    s.add_dependency(%q<activesupport>, ["~> 3.1.1"])
+    s.add_dependency(%q<rspec>, ["~> 2.3.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+  end
+end
+

data/spec/rails_locale_detection_spec.rb

@@ -0,0 +1,126 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+I18n.available_locales = [:en, :fr]
+Timecop.freeze
+
+describe Rails::LocaleDetection do
+  let(:request) { MockRequest.new }
+  let(:controller) { MockController.new(request) }
+  
+  describe '.locale_expiry' do
+    it "should be set to 3 months be default" do
+      Rails::LocaleDetection.locale_expiry.should eq(3.months)
+    end
+  end
+  
+  describe '#available_locales' do
+    it "should shadow I18n available_locales" do
+      controller.available_locales.should eq([:en, :fr])
+    end
+  end
+  
+  describe '#default_locale' do
+    it "should shadow I18n default locale"  do
+      I18n.default_locale = :en
+      controller.default_locale.should eq(:en)
+    end
+  end
+  
+  describe '#validate_locale' do
+    it "should return the passed locale if it's valid" do
+      controller.validate_locale(:en).should eq(:en)
+    end
+    
+    it "should return nil if the passed locale isn't valid" do
+      controller.validate_locale(:es).should be_nil
+    end
+  end
+  
+  describe '#locale_from_param' do
+    it "should return en if the param set was valid" do
+      controller.params[:locale] = 'en'
+      controller.locale_from_param.should eq(:en)
+    end
+    
+    it "should return nil if the param set was not" do
+      controller.params[:locale] = 'es'
+      controller.locale_from_param.should be_nil
+    end
+
+    it "should return nil if not locale was set" do
+      controller.locale_from_param.should be_nil
+    end
+  end
+  
+  describe '#locale_from_cookie' do
+    it "should return en if the param set was valid" do
+      controller.cookies[:locale] = 'en'
+      controller.locale_from_cookies.should eq(:en)
+    end
+    
+    it "should return nil if the param set was not" do
+      controller.cookies[:locale] = 'es'
+      controller.locale_from_cookies.should be_nil
+    end
+
+    it "should return nil if not locale was set" do
+      controller.locale_from_cookies.should be_nil
+    end
+  end  
+  
+  describe '#locale_from_request' do
+    it "should return en if the param set was valid" do
+      request.env['HTTP_ACCEPT_LANGUAGE'] = 'en-us,en-gb;q=0.8,en;q=0.6'
+      controller.locale_from_request.should eq(:en)
+    end
+    
+    it "should return nil if the param set was not" do
+      request.env['HTTP_ACCEPT_LANGUAGE'] = 'es'
+      controller.locale_from_request.should be_nil
+    end
+
+    it "should return nil if not locale was set" do
+      controller.locale_from_request.should be_nil
+    end
+  end  
+  
+  describe '#get_locale' do
+    it "should return nil if nothing is set" do
+      controller.get_locale.should eq(:en)
+    end
+
+    it "should return en if the params is set to en" do
+      controller.params[:locale] = "en"
+      controller.get_locale.should eq(:en)
+    end
+
+    it "should return fr if the cookie is set to fr" do
+      controller.cookies[:locale] = "fr"
+      controller.get_locale.should eq(:fr)
+    end
+
+    it "should return en if the request is set to en" do
+      request.env['HTTP_ACCEPT_LANGUAGE'] = 'en-us,en-gb;q=0.8,en;q=0.6'
+      controller.get_locale.should eq(:en)
+    end
+  end
+
+  describe '#set_locale' do
+    before :all do
+      controller.params[:locale] = "fr"
+      controller.set_locale
+    end
+    
+    it "should set the current locale to the locale param" do
+      I18n.locale.should eq(:fr)
+    end
+    
+    it "should set the language" do
+      controller.cookies[:locale].should eq(:fr)
+    end
+    
+    it "should set the default_url_options" do
+      controller.default_url_options[:locale].should eq(:fr)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'i18n'
+require 'active_support/core_ext'
+require 'action_dispatch/middleware/cookies'
+require 'timecop'
+
+require 'rails_locale_detection'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

data/spec/support/mock.rb

@@ -0,0 +1,21 @@
+class MockRequest
+  include HttpAcceptLanguage
+  
+  attr_accessor :env
+  
+  def initialize
+    @env = {'HTTP_ACCEPT_LANGUAGE' => ''}
+  end
+end
+
+class MockController
+  include Rails::LocaleDetection
+  
+  attr_accessor :request, :params, :cookies, :default_url_options
+  
+  def initialize(request)
+    @request = request
+    @cookies = ActionDispatch::Cookies::CookieJar.new
+    @default_url_options = @params = {}
+  end
+end

metadata

@@ -0,0 +1,216 @@
+--- !ruby/object:Gem::Specification 
+name: rails_locale_detection
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Mateo Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-16 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: http_accept_language
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :runtime
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  name: timecop
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id003
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 1
+        - 1
+        version: 3.1.1
+  prerelease: false
+  type: :development
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 1
+        - 1
+        version: 3.1.1
+  prerelease: false
+  type: :development
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  prerelease: false
+  type: :development
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  type: :development
+  requirement: *id007
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  version_requirements: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  prerelease: false
+  type: :development
+  requirement: *id008
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  version_requirements: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id009
+description: Sets the current locale of a request using a combination of params, cookies, and http headers
+email: mateo.murphy@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- .document
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/rails/locale_detection.rb
+- lib/rails_locale_detection.rb
+- rails_locale_detection.gemspec
+- spec/rails_locale_detection_spec.rb
+- spec/spec_helper.rb
+- spec/support/mock.rb
+has_rdoc: true
+homepage: http://github.com/mateomurphy/rails_locale_detection
+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.5.2
+signing_key: 
+specification_version: 3
+summary: locale setting for rails project
+test_files: []
+