rails_locale_detection 1.3.2 → 2.0.0.pre2

data/lib/rails_locale_detection/locale_accessors.rb

@@ -0,0 +1,23 @@
+module RailsLocaleDetection
+  module LocaleAccessors
+    def alternate_locales
+      available_locales - [current_locale]
+    end
+
+    def available_locales
+      I18n.available_locales
+    end
+
+    def current_locale
+      I18n.locale
+    end
+    
+    def current_locale=(locale)
+      I18n.locale = locale
+    end
+
+    def default_locale
+      I18n.default_locale
+    end
+  end
+end

data/lib/rails_locale_detection/locale_detector.rb

@@ -0,0 +1,22 @@
+module RailsLocaleDetection
+  class LocaleDetector
+    include DetectionMethods
+    include LocaleAccessors
+    
+    attr_reader :controller
+    
+    delegate :cookies, :params, :request, :default_url_options, :user_locale, :to => :controller
+    
+    def initialize(controller = nil)
+      @controller = controller
+    end
+    
+    def locale_key
+      RailsLocaleDetection.locale_key
+    end
+    
+    def self.before(controller)
+      new(controller).set_locale
+    end
+  end
+end

data/lib/rails_locale_detection/railtie.rb

@@ -0,0 +1,13 @@
+module RailsLocaleDetection
+  class Railtie < Rails::Railtie
+    initializer "rails_locale_detection.append_before_filter" do
+      ActiveSupport.on_load(:action_controller) do
+        ActionController::Base.send :include, RailsLocaleDetection::ControllerMethods
+      end
+      
+      ActiveSupport.on_load(:action_view) do
+        ActionView::Base.send :include, Rails::LocaleDetection::LocaleAccessors
+      end      
+    end
+  end
+end

data/lib/rails_locale_detection/version.rb

@@ -0,0 +1,3 @@
+module RailsLocaleDetection
+  VERSION = "2.0.0.pre2"
+end

data/rails_locale_detection.gemspec

@@ -1,74 +1,29 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails_locale_detection/version'
 
-Gem::Specification.new do |s|
-  s.name = "rails_locale_detection"
-  s.version = "1.3.2"
+Gem::Specification.new do |gem|
+  gem.name          = "rails_locale_detection"
+  gem.version       = RailsLocaleDetection::VERSION
+  gem.authors       = ["Mateo Murphy"]
+  gem.email         = ["mateo.murphy@gmail.com"]
+  gem.description   = "Sets the current locale of a request using a combination of params, cookies, and http headers"
+  gem.summary       = "Locale setting for rails project"
+  gem.homepage      = "https://github.com/mateomurphy/rails_locale_detection"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Mateo Murphy"]
-  s.date = "2013-03-19"
-  s.description = "Sets the current locale of a request using a combination of params, cookies, and http headers"
-  s.email = "mateo.murphy@gmail.com"
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.md"
-  ]
-  s.files = [
-    ".document",
-    ".rspec",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.md",
-    "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 = "http://github.com/mateomurphy/rails_locale_detection"
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.25"
-  s.summary = "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<activesupport>, ["~> 3.2.13"])
-      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.2.13"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.12.0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.3.4"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.4"])
-    else
-      s.add_dependency(%q<activesupport>, ["~> 3.2.13"])
-      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.2.13"])
-      s.add_dependency(%q<rspec>, ["~> 2.12.0"])
-      s.add_dependency(%q<bundler>, ["~> 1.3.4"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
-    end
-  else
-    s.add_dependency(%q<activesupport>, ["~> 3.2.13"])
-    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.2.13"])
-    s.add_dependency(%q<rspec>, ["~> 2.12.0"])
-    s.add_dependency(%q<bundler>, ["~> 1.3.4"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.4"])
-  end
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+  
+  gem.add_dependency('rails', '>= 3.2.13')  
+  gem.add_dependency('http_accept_language', '~> 1.0.2')
+  
+  gem.add_development_dependency('i18n', '~> 0.6.1')
+  gem.add_development_dependency('timecop', '~> 0.6.1')
+  gem.add_development_dependency('rspec-rails', '~> 2.13.0')
+  gem.add_development_dependency('bundler', '~> 1.3.4')
+  gem.add_development_dependency('gem-release', '~> 0.5.3')  
+  gem.add_development_dependency('rake', '~> 10.0.4')  
 end
-

data/spec/controllers/callback_tests_controller_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe CallbackTestsController do
+  
+  it "should automatically include the callback" do
+    subject.class.ancestors.should include(RailsLocaleDetection::ControllerMethods)
+  end
+  
+  it "should correctly detect the user locale" do
+    get :show
+    
+    response.body.should eq('fr')
+  end
+  
+end

data/spec/rails_locale_detection/config_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe RailsLocaleDetection do
+  describe 'backwards compatility' do
+    it 'should be possible to configure using the previous module name' do
+      Rails::LocaleDetection.should respond_to(:config)
+    end
+  end
+  
+  describe '.locale_expiry' do
+    it "is set to 3 months by default" do
+      RailsLocaleDetection.config do |c|
+        c.locale_expiry.should eq(3.months)
+      end
+    end
+  end
+end

data/spec/rails_locale_detection/controller_methods_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe RailsLocaleDetection::ControllerMethods do
+  let(:request) { MockRequest.new }
+  subject(:controller) { MockController.new(request) }
+
+  it 'provides a blank user locale method' do
+    controller.user_locale.should be_nil
+  end
+  
+  it 'should provide a detect locale method' do
+    controller.class.should respond_to(:detect_locale)
+  end 
+  
+  it 'should add a before filter' do
+    controller.class.before_filters.should eq([[RailsLocaleDetection::LocaleDetector]])
+  end
+  
+end

data/spec/rails_locale_detection/locale_accessors_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+class AccessorTest
+  include RailsLocaleDetection::LocaleAccessors
+end
+
+describe RailsLocaleDetection::LocaleAccessors do
+  subject :object do
+    AccessorTest.new
+  end
+  
+  describe '#alternate_locales' do
+    it "returns all available locales minus the current one" do
+      object.current_locale = :en
+      object.alternate_locales.should eq([:fr])
+    end
+  end
+
+  describe '#available_locales' do
+    it "shadows I18n.available_locales" do
+      object.available_locales.should eq([:en, :fr])
+    end
+  end
+
+  describe '#default_locale' do
+    it "shadows I18n.default locale"  do
+      object.default_locale.should eq(:en)
+    end
+  end
+end

data/spec/{rails_locale_detection_spec.rb → rails_locale_detection/locale_detector_spec.rb}

@@ -1,331 +1,328 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 
-I18n.default_locale = :en
-I18n.available_locales = [:en, :fr]
-Timecop.freeze
-
-describe Rails::LocaleDetection do
+describe RailsLocaleDetection::LocaleDetector do
   let(:request) { MockRequest.new }
   let(:controller) { MockController.new(request) }
-  
-  describe '.locale_expiry' do
-    it "is set to 3 months by default" do
-      Rails::LocaleDetection.config do |c|
-        c.locale_expiry.should eq(3.months)
-      end
-    end
-  end
-  
+  subject(:locale_detector) { RailsLocaleDetection::LocaleDetector.new(controller) }
+
   describe '#available_locales' do
     it "shadows I18n.available_locales" do
-      controller.available_locales.should eq([:en, :fr])
+      locale_detector.available_locales.should eq([:en, :fr])
     end
   end
-  
+
   describe '#default_locale' do
     it "shadows I18n.default locale"  do
-      controller.default_locale.should eq(:en)
+      locale_detector.default_locale.should eq(:en)
+    end
+  end
+
+  describe '#current_locale' do
+    it "shadows I18n.locale"  do
+      controller.params[:locale] = 'fr'
+      locale_detector.set_locale
+      controller.current_locale.should eq(:fr)
     end
   end
-  
+
   describe '#validate_locale' do
     it "returns the passed locale if it's valid" do
-      controller.validate_locale(:en).should eq(:en)
+      locale_detector.validate_locale(:en).should eq(:en)
     end
-    
+
     it "returns nil if the passed locale isn't valid" do
-      controller.validate_locale(:es).should be_nil
+      locale_detector.validate_locale(:es).should be_nil
     end
-    
+
     it "returns nil if nil is passed" do
-      controller.validate_locale(nil).should be_nil
+      locale_detector.validate_locale(nil).should be_nil
     end
   end
-  
+
   describe '#locale_from_param' do
     it "returns en if the param set was valid" do
       controller.params[:locale] = 'en'
-      controller.locale_from_param.should eq(:en)
+      locale_detector.locale_from_param.should eq(:en)
     end
-    
+
     it "returns nil if the param set was not" do
       controller.params[:locale] = 'es'
-      controller.locale_from_param.should be_nil
+      locale_detector.locale_from_param.should be_nil
     end
 
     it "returns nil if not locale was set" do
-      controller.locale_from_param.should be_nil
+      locale_detector.locale_from_param.should be_nil
     end
   end
-  
+
   describe '#locale_from_cookie' do
     it "returns en if the param set was valid" do
       controller.cookies[:locale] = 'en'
-      controller.locale_from_cookie.should eq(:en)
+      locale_detector.locale_from_cookie.should eq(:en)
     end
-    
+
     it "returns nil if the param set was not" do
       controller.cookies[:locale] = 'es'
-      controller.locale_from_cookie.should be_nil
+      locale_detector.locale_from_cookie.should be_nil
     end
 
     it "returns nil if not locale was set" do
-      controller.locale_from_cookie.should be_nil
+      locale_detector.locale_from_cookie.should be_nil
     end
-  end  
-  
+  end
+
   describe '#locale_from_request' do
     it "returns 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)
+      locale_detector.locale_from_request.should eq(:en)
     end
-    
+
     it "returns nil if the param set was not" do
       request.env['HTTP_ACCEPT_LANGUAGE'] = 'es'
-      controller.locale_from_request.should be_nil
+      locale_detector.locale_from_request.should be_nil
     end
 
     it "returns nil if not locale was set" do
-      controller.locale_from_request.should be_nil
+      locale_detector.locale_from_request.should be_nil
     end
   end
-  
+
   describe '#locale_from_user' do
     it "returns the locale of the user if it's valid" do
       controller.user = MockUser.new(:en)
-      controller.locale_from_user.should eq(:en)
+      locale_detector.locale_from_user.should eq(:en)
     end
-    
+
     it "returns nil if the locale of the use isn't valid" do
       controller.user = MockUser.new(:es)
-      controller.locale_from_user.should be_nil
+      locale_detector.locale_from_user.should be_nil
     end
   end
-  
+
   describe '#locale_from' do
-    before :all do
-      controller.params[:locale] = 'en'      
+    before :each do
+      controller.params[:locale] = 'en'
       controller.cookies[:locale] = 'fr'
     end
-    
+
     it "returns the locale set in the param" do
-      controller.locale_from(:param).should eq(:en)
+      locale_detector.locale_from(:param).should eq(:en)
     end
-    
+
     it "return the locale set in the cookie" do
-      controller.locale_from(:cookie).should eq(:fr)
+      locale_detector.locale_from(:cookie).should eq(:fr)
     end
   end
-  
-  describe '#get_locale' do
+
+  describe '#detect_locale' do
     context "with default detection order" do
-      before :all do
-        Rails::LocaleDetection.detection_order = [:user, :param, :cookie, :request]
-      end      
-      
+      before :each do
+        RailsLocaleDetection.detection_order = [:user, :param, :cookie, :request]
+      end
+
       it "returns default if nothing is set" do
-        controller.get_locale.should eq(:en)
+        locale_detector.detect_locale.should eq(:en)
       end
 
       it "returns en if the params is set to en" do
         controller.params[:locale] = "en"
-        controller.get_locale.should eq(:en)
+        locale_detector.detect_locale.should eq(:en)
       end
 
       it "returns fr if the cookie is set to fr" do
         controller.cookies[:locale] = "fr"
-        controller.get_locale.should eq(:fr)
+        locale_detector.detect_locale.should eq(:fr)
       end
 
       it "returns 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)
+        locale_detector.detect_locale.should eq(:en)
       end
-      
+
       it "return fr if the user locale was set to fr" do
         controller.user = MockUser.new(:en)
-        controller.get_locale.should eq(:en)
+        locale_detector.detect_locale.should eq(:en)
       end
-      
+
     end
-    
+
     context "with a custom detection order" do
-      before :all do
-        Rails::LocaleDetection.detection_order = [:user, :param, :request]
+      before :each do
+        RailsLocaleDetection.detection_order = [:user, :param, :request]
       end
-      
+
       it "returns return default if nothing is set" do
-        controller.get_locale.should eq(:en)
+        locale_detector.detect_locale.should eq(:en)
       end
 
       it "returns en if the params is set to en" do
         controller.params[:locale] = "en"
-        controller.get_locale.should eq(:en)
+        locale_detector.detect_locale.should eq(:en)
       end
 
       it "skips cookie" do
         controller.cookies[:locale] = "fr"
-        controller.get_locale.should eq(:en)
+        locale_detector.detect_locale.should eq(:en)
       end
 
       it "returns 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      
-      
+        locale_detector.detect_locale.should eq(:en)
+      end
+
     end
-    
+
   end
 
   describe '#set_default_url_option_for_request?' do
     context 'with a locale param' do
-      before :all do
-        controller.params[:locale] = "fr"      
+      before :each do
+        controller.params[:locale] = "fr"
       end
-      
+
       it 'return true when set_default_url_option is true' do
-        Rails::LocaleDetection.set_default_url_option = true
-        controller.should be_set_default_url_option_for_request
+        RailsLocaleDetection.set_default_url_option = true
+        locale_detector.should be_set_default_url_option_for_request
       end
-      
+
       it 'return false when set_default_url_option is fale' do
-        Rails::LocaleDetection.set_default_url_option = false
-        controller.should_not be_set_default_url_option_for_request
+        RailsLocaleDetection.set_default_url_option = false
+        locale_detector.should_not be_set_default_url_option_for_request
       end
-      
+
       it 'return false when set_default_url_option is :never' do
-        Rails::LocaleDetection.set_default_url_option = :never
-        controller.should_not be_set_default_url_option_for_request
+        RailsLocaleDetection.set_default_url_option = :never
+        locale_detector.should_not be_set_default_url_option_for_request
       end
-      
+
       it 'return true when set_default_url_option is :always' do
-        Rails::LocaleDetection.set_default_url_option = :always
-        controller.should be_set_default_url_option_for_request
+        RailsLocaleDetection.set_default_url_option = :always
+        locale_detector.should be_set_default_url_option_for_request
       end
-      
+
       it 'return true when set_default_url_option is :explicitly' do
-        Rails::LocaleDetection.set_default_url_option = :explicitly
-        controller.should be_set_default_url_option_for_request
-      end                        
+        RailsLocaleDetection.set_default_url_option = :explicitly
+        locale_detector.should be_set_default_url_option_for_request
+      end
     end
-    
+
     context 'without a locale param' do
-      before :all do
+      before :each do
         controller.params[:locale] = nil
-      end      
-      
+      end
+
       it 'return true when set_default_url_option is true' do
-        Rails::LocaleDetection.set_default_url_option = true
-        controller.should be_set_default_url_option_for_request
+        RailsLocaleDetection.set_default_url_option = true
+        locale_detector.should be_set_default_url_option_for_request
       end
-      
+
       it 'return false when set_default_url_option is false' do
-        Rails::LocaleDetection.set_default_url_option = false
-        controller.should_not be_set_default_url_option_for_request
+        RailsLocaleDetection.set_default_url_option = false
+        locale_detector.should_not be_set_default_url_option_for_request
       end
-      
+
       it 'return false when set_default_url_option is :never' do
-        Rails::LocaleDetection.set_default_url_option = :never
-        controller.should_not be_set_default_url_option_for_request
+        RailsLocaleDetection.set_default_url_option = :never
+        locale_detector.should_not be_set_default_url_option_for_request
       end
-      
+
       it 'return true when set_default_url_option is :always' do
-        Rails::LocaleDetection.set_default_url_option = :always
-        controller.should be_set_default_url_option_for_request
+        RailsLocaleDetection.set_default_url_option = :always
+        locale_detector.should be_set_default_url_option_for_request
       end
-      
+
       it 'return false when set_default_url_option is :explicitly' do
-        Rails::LocaleDetection.set_default_url_option = :explicitly
-        controller.should_not be_set_default_url_option_for_request
-      end      
+        RailsLocaleDetection.set_default_url_option = :explicitly
+        locale_detector.should_not be_set_default_url_option_for_request
+      end
     end
-    
+
   end
 
   describe '#set_locale' do
     context "with set default_url_option :always" do
-      before :all do
-        Rails::LocaleDetection.set_default_url_option = :always
+      before :each do
+        RailsLocaleDetection.set_default_url_option = :always
         controller.params[:locale] = "fr"
-        controller.set_locale
+        locale_detector.set_locale
       end
-    
+
       it "sets the current locale to the locale param" do
         I18n.locale.should eq(:fr)
       end
-    
+
       it "sets the language" do
         controller.cookies[:locale].should eq(:fr)
       end
-    
+
       it "sets the default_url_options" do
         controller.default_url_options[:locale].to_s.should eq('fr')
       end
     end
-    
+
     context "with set default_url_option :never" do
-      before :all do
-        Rails::LocaleDetection.set_default_url_option = :never
+      before :each do
+        RailsLocaleDetection.set_default_url_option = :never
         controller.default_url_options = {}
         controller.params[:locale] = "fr"
-        controller.set_locale
+        locale_detector.set_locale
       end
-    
+
       it "sets the current locale to the locale param" do
         I18n.locale.should eq(:fr)
       end
-    
+
       it "sets the cookier locale" do
         controller.cookies[:locale].should eq(:fr)
       end
-    
+
       it "doesn't set the default_url_options" do
         controller.default_url_options[:locale].should be_nil
       end
-    end  
-    
+    end
+
     context "with set default_url_option :explicit and no locale param" do
-      before :all do
-        Rails::LocaleDetection.set_default_url_option = :explicitly
+      before :each do
+        RailsLocaleDetection.set_default_url_option = :explicitly
         controller.default_url_options = {}
         controller.params[:locale] = nil
-        controller.set_locale
+        locale_detector.set_locale
       end
-    
+
       it "sets the current locale to the default param" do
         I18n.locale.should eq(:en)
       end
-    
+
       it "sets the cookie locale" do
         controller.cookies[:locale].should eq(:en)
       end
-    
+
       it "doesn't set the default_url_options" do
         controller.default_url_options[:locale].should be_nil
       end
-    end    
-      
+    end
+
     context "with set default_url_option :explicit and a locale param" do
-      before :all do
-        Rails::LocaleDetection.set_default_url_option = :explicitly
+      before :each do
+        RailsLocaleDetection.set_default_url_option = :explicitly
         controller.default_url_options = {}
         controller.params[:locale] = :fr
-        controller.set_locale
+        locale_detector.set_locale
       end
-    
+
       it "sets the current locale to the default param" do
         I18n.locale.should eq(:fr)
       end
-    
+
       it "sets the cookie locale" do
         controller.cookies[:locale].should eq(:fr)
       end
-    
+
       it "doesn't set the default_url_options" do
         controller.default_url_options[:locale].should eq(:fr)
       end
-    end       
-      
+    end
+
   end
 
 end