rails_locale_detection 1.3.2 → 2.0.0.pre2

data/.gitignore

@@ -0,0 +1,50 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc
+
+/.rvmrc

data/Gemfile

@@ -1,15 +1,3 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
-gem 'activesupport', '~> 3.2.13'
-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.2.13'
-  gem "rspec", "~> 2.12.0"
-  gem "bundler", "~> 1.3.4"
-  gem "jeweler", "~> 1.8.4"
-end
+gemspec

data/Gemfile.lock

@@ -1,6 +1,16 @@
+PATH
+  remote: .
+  specs:
+    rails_locale_detection (2.0.0.pre1)
+      http_accept_language (~> 1.0.2)
+      rails (>= 3.2.13)
+
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
+    actionmailer (3.2.13)
+      actionpack (= 3.2.13)
+      mail (~> 2.5.3)
     actionpack (3.2.13)
       activemodel (= 3.2.13)
       activesupport (= 3.2.13)
@@ -14,57 +24,91 @@ GEM
     activemodel (3.2.13)
       activesupport (= 3.2.13)
       builder (~> 3.0.0)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
     activesupport (3.2.13)
       i18n (= 0.6.1)
       multi_json (~> 1.0)
+    arel (3.0.2)
     builder (3.0.4)
-    diff-lcs (1.1.3)
+    diff-lcs (1.2.1)
     erubis (2.7.0)
-    git (1.2.5)
+    gem-release (0.5.3)
     hike (1.2.1)
     http_accept_language (1.0.2)
     i18n (0.6.1)
-    jeweler (1.8.4)
-      bundler (~> 1.0)
-      git (>= 1.2.5)
-      rake
-      rdoc
     journey (1.0.4)
     json (1.7.7)
-    multi_json (1.7.1)
+    mail (2.5.3)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.21)
+    multi_json (1.7.2)
+    polyglot (0.3.3)
     rack (1.4.5)
     rack-cache (1.2)
       rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
     rack-test (0.6.2)
       rack (>= 1.0)
-    rake (10.0.3)
-    rdoc (4.0.0)
+    rails (3.2.13)
+      actionmailer (= 3.2.13)
+      actionpack (= 3.2.13)
+      activerecord (= 3.2.13)
+      activeresource (= 3.2.13)
+      activesupport (= 3.2.13)
+      bundler (~> 1.0)
+      railties (= 3.2.13)
+    railties (3.2.13)
+      actionpack (= 3.2.13)
+      activesupport (= 3.2.13)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.4)
+    rdoc (3.12.2)
       json (~> 1.4)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.2)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    rspec-rails (2.13.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
     sprockets (2.2.2)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
+    thor (0.18.1)
     tilt (1.3.6)
     timecop (0.6.1)
+    treetop (1.4.12)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  actionpack (~> 3.2.13)
-  activesupport (~> 3.2.13)
   bundler (~> 1.3.4)
-  http_accept_language
-  i18n
-  jeweler (~> 1.8.4)
-  rspec (~> 2.12.0)
-  timecop
+  gem-release (~> 0.5.3)
+  i18n (~> 0.6.1)
+  rails_locale_detection!
+  rake (~> 10.0.4)
+  rspec-rails (~> 2.13.0)
+  timecop (~> 0.6.1)

data/LICENSE

@@ -0,0 +1,21 @@
+MIT LICENSE
+
+Copyright (c) 2013 Mateo Murphy <mateo.murphy@gmail.com>
+
+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

@@ -3,50 +3,53 @@
 [![Build Status](https://travis-ci.org/mateomurphy/rails_locale_detection.png?branch=master)](https://travis-ci.org/mateomurphy/rails_locale_detection)
 [![Dependency Status](https://gemnasium.com/mateomurphy/rails_locale_detection.png)](https://gemnasium.com/mateomurphy/rails_locale_detection)
 
-Sets the current locale of a request using a combination of params, cookies, http headers, and an optional user object. 
+Sets the current locale of a request using a combination of params, cookies, http headers, and an optional user object.
 
-In turn, it checks the value of params[:locale], cookies[:locale] and 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. If a user_locale method
-is provided, the return value will be used, with preference over the other locale detection methods.
+In turn, it checks the value of `params[:locale]`, `cookies[:locale]` and `HTTP_ACCEPT_LANGUAGE` headers to find a locale that
+corresponds to the available locales, then stores the locale in a cookie for future requests. If a `user_locale` method
+is provided, any valid return value will be used, with preference over the other locale detection methods except for `params[:locale]`.
+
+
+## Changes to version 2
+
+* Rails 4 compatibility
+* Namespace has been changed from Rails::LocaleDetection to RailsLocaleDetection, 
+    although the previous namespace is still supported for legacy config files
+* Locale detection has been moved to a seperate object, to avoid polluting controllers with extra methods. 
+* Detection order has been changed to `param` first, as this make more sense in most contexts.
+* Shortcut locale accessors are now mixed into views as well
 
 ## Usage
 
-Include the gem in your Gemfile 
+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
 
 To support user locales, add a `user_locale` method
 
     class ApplicationController < ActionController::Base
-      before_filter :set_locale
-
       def user_locale
         current_user.locale if current_user
       end
-    
     end
 
+Methods for accessing `current_locale`, `available_locales`, and `alternate_locales` are available in controller and views
 
 ## Configuration
 
 Configuration is done via a block that can be added as an initializer:
 
-    Rails::LocaleDetection.config do |config|
-      config.locale_expiry = 3.months 
+    RailsLocaleDetection.config do |config|
+      config.locale_expiry = 3.months
       config.set_default_url_option = :always # valid values are true, false, :always, :never and :explicity
-      config.detection_order = [:user, :param, :cookie, :request] 
+      config.detection_order = [:param, :user, :cookie, :request]
+      config.automatically_detect = true
+      config.locale_key = :locale
     end
 
 The configuration options:
@@ -57,9 +60,12 @@ The configuration options:
   * `false` or `:never` never sets the option
   * `:explicity` sets the option only when a param[:locale] is present
 * `detection_order` set the order in which locale detection occurs. Omit values to skip those sources
+* `automatically_detect` configures automatic inclusion of the detection callback. 
+    You can set this to false and include the callback yourself by calling `detect_locale` in your controller as required.
+* `locale_key` configures the key used for `param` and `cookie` 
 
 ## 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

data/Rakefile

@@ -1,49 +1,6 @@
-# encoding: utf-8
+require 'bundler/gem_tasks'
 
-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 'rdoc/task'
-RDoc::Task.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+RSpec::Core::RakeTask.new(:spec)
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "rails_locale_detection #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+task :default => [:spec]

data/lib/rails_locale_detection.rb

@@ -1,5 +1,34 @@
+require 'rails'
+require 'i18n'
 require 'http_accept_language'
-require 'active_support/core_ext'
-require 'rails/locale_detection'
+require 'rails_locale_detection/detection_methods'
+require 'rails_locale_detection/locale_accessors'
+require 'rails_locale_detection/locale_detector'
+require 'rails_locale_detection/controller_methods'
 
-ActionController::Base.send :include, Rails::LocaleDetection if defined?(ActionController)
+module RailsLocaleDetection
+  require 'rails_locale_detection/railtie' if defined?(Rails)
+
+  mattr_accessor :locale_expiry
+  @@locale_expiry = 3.months
+
+  mattr_accessor :set_default_url_option
+  @@set_default_url_option = :always
+
+  mattr_accessor :detection_order
+  @@detection_order = [:param, :user, :cookie, :request]
+
+  mattr_accessor :automatically_detect
+  @@automatically_detect = true
+
+  mattr_accessor :locale_key
+  @@locale_key = :locale
+
+  def self.config
+    yield self
+  end
+end
+
+module Rails
+  LocaleDetection = ::RailsLocaleDetection
+end

data/lib/rails_locale_detection/controller_methods.rb

@@ -0,0 +1,20 @@
+module RailsLocaleDetection
+  module ControllerMethods
+    extend ActiveSupport::Concern
+    include LocaleAccessors
+
+    included do
+      detect_locale if RailsLocaleDetection.automatically_detect
+    end
+
+    module ClassMethods
+      def detect_locale
+        append_before_filter LocaleDetector
+      end
+    end
+
+    def user_locale
+      nil
+    end
+  end
+end

data/lib/rails_locale_detection/detection_methods.rb

@@ -0,0 +1,45 @@
+module RailsLocaleDetection
+  module DetectionMethods
+    # 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_key])
+    end
+
+    def locale_from_cookie
+      validate_locale(cookies[locale_key])
+    end
+
+    def locale_from_request
+      validate_locale(request.preferred_language_from(available_locales))
+    end
+
+    def locale_from_user
+      validate_locale(user_locale)
+    end
+
+    def locale_from(key)
+      send("locale_from_#{key}")
+    end
+
+    def detect_locale
+      RailsLocaleDetection.detection_order.inject(nil) { |result, source| result || locale_from(source) } || default_locale
+    end
+
+    # set I18n.locale, default_url_options[:locale] and cookies[:locale] to the value returned by
+    # detect_locale
+    def set_locale
+      self.current_locale = detect_locale
+      default_url_options[locale_key] = current_locale if set_default_url_option_for_request?
+      cookies[locale_key] = { :value => current_locale, :expires => RailsLocaleDetection.locale_expiry.from_now }
+    end
+
+    # returns true if the default url option should be set for this request
+    def set_default_url_option_for_request?
+      RailsLocaleDetection.set_default_url_option === true || RailsLocaleDetection.set_default_url_option == :always || RailsLocaleDetection.set_default_url_option == :explicitly && params[locale_key].present?
+    end 
+  end
+end