locale_setter 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2177a5b71ff691ac29241b327d2deaef3456e08e
-  data.tar.gz: 0fbf15da496596204083077d5c622441cd5dcf9c
+  metadata.gz: 78392b8ccf55802f8c105dc3c5bbcc3d3a0f3091
+  data.tar.gz: 8606c55302e4709c6d6f5627ebd186b8fa95d7a2
 SHA512:
-  metadata.gz: ed37ab8f9b5ec6ac8527c8a53ed535d1a4f6ac05b9fa9283c4d9ad67e02da60696fa32c7d3d968578d24523d9fb92ef97bd3c3f04cc6a173949786216efa4763
-  data.tar.gz: da77e1502788c59d1eb1713f0bdf53366795ef5a0f020057364b9383eb4f1be3b40470f407d7cd24a7a37e539c533bd5414fd3e10e007ead9fc161f75fc117cd
+  metadata.gz: a7a12f4611a7a7dccba46e757b13a5ce375d32554a8ee47223815285f7c29faafdc41728c120aa8521f11203a1c37c527ed7fb8c20b808eb82bd120fecc9b587
+  data.tar.gz: 69ef6e19e8cb639ea04663e6a1f411d0231b949d8668f80ebee39f2a149e35751169dd0926d3904e9eeac369025b370399dc31251a1278e4a2eb35a1347e8eb2

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+spec/dummy/log
+spec/dummy/db/*.sqlite3

data/.travis.yml

@@ -0,0 +1,19 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+env:
+  - "RAILS_VERSION=3.2"
+  - "RAILS_VERSION=master"
+matrix:
+  allow_failures:
+    - rvm: 2.0.0
+    - env: "RAILS_VERSION=master"
+  exclude:
+    - rvm: 1.8.7
+      env: "RAILS_VERSION=master"
+    - rvm: 1.9.2
+      env: "RAILS_VERSION=master"
+

data/Gemfile

@@ -3,4 +3,22 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in locale_setter.gemspec
 gemspec
 
-gem 'rspec'
+platforms :ruby do
+  gem "sqlite3"
+end
+
+platforms :jruby do
+  gem "minitest", ">= 3.0"
+  gem "activerecord-jdbcsqlite3-adapter"
+end
+
+version = ENV["RAILS_VERSION"] || "3.2"
+
+rails = case version
+when "master"
+  {:github => "rails/rails"}
+else
+  "~> #{version}.0"
+end
+
+gem "rails", rails

data/README.md

@@ -1,9 +1,14 @@
 # LocaleSetter
 
-`LocaleSetter` sets the locale for the current request in a Rails application.
+`LocaleSetter` sets the locale for the current request in a web application.
+Rails has automatic support, other applications can use LocaleSetter with a
+bit of configuration.
 
 ## Installation
 
+Currently, LocaleSetter only supports Rails 3.2 and up. If you want 3.0 or
+3\.1 support, please file an Issue and we can work it out.
+
 ### Gem Installation
 
 Add this line to your application's Gemfile:
@@ -20,17 +25,7 @@ $ bundle
 
 ### Rails Application Configuration
 
-Include the module in your `app/controllers/application_controller.rb`:
-
-```ruby
-class ApplicationController < ActionController::Base
-  protect_from_forgery
-
-  include LocaleSetter::Rails
-end
-```
-
-*Note:* If you have before filters or a module that handles user authentication, have that _above_ this new `include` so it happens first.
+There is none! Thanks, Railties!
 
 ### Non-Rails Applications
 
@@ -41,16 +36,17 @@ The library can be used outside of Rails by accessing `LocaleSetter::Generic` di
 request = {'HTTP_ACCEPT_LANGUAGE' = 'en,es;0.6'}
 params  = {:locale = 'en'}
 user    = User.first
-i18n    = I18n 
+i18n    = I18n
 
 # Set the .locale of I18n
 LocaleSetter::Generic.set_locale(i18n,
                                 {:env => request,
                                  :params => params,
-                                 :user => user})
+                                 :user => user,
+                                 :domain => domain})
 ```
 
-The `i18n.locale=` will be called with the local selected from the passed data. `:env`, `:params`, and `:user` are all optional.
+The `i18n.locale=` will be called with the local selected from the passed data. `:env`, `:params`, `:domain` and `:user` are all optional.
 
 ## How It Works
 
@@ -58,14 +54,31 @@ One of the challenges with internationalization is knowing which locale a user a
 
 1. URL Parameter
 2. User Preference
-3. HTTP Headers
-4. Default
+3. Domain Specific
+4. HTTP Headers
+5. Default
+
+### Configuration
+
+`LocaleSetter` can be configured via a block. Here are the defaults:
+
+```ruby
+LocaleSetter.configure do |config|
+  config.url_param           = :locale
+  config.user_locale_method  = :locale
+  config.localized_domains   = {}
+  config.current_user_method = :current_user
+end
+```
+
+So if you want to change the defaults then call this method any time after
+the library is loaded, like in a Rails initializer.
 
 ### URL Parameter
 
 As a developer or designer, it's incredibly handy to be able to manipulate the URL to change locales. You might even use this with CI to run your integration tests using each locale you support.
 
-If you're currently using the default locale for the application, generated URLs on your site will be untouched. 
+If you're currently using the default locale for the application, generated URLs on your site will be untouched.
 
 For example, say my default is `:en` for English and I am viewing in English, my URL might look like:
 
@@ -105,7 +118,7 @@ http://example.com/articles/1&locale=es
 
 #### Non-Supported Locales
 
-If the locale specified in the URL is not supported, `LocaleSetter` will revert to the default locale. 
+If the locale specified in the URL is not supported, `LocaleSetter` will revert to the default locale.
 
 Note that care has been taken to prevent a symbol-table-overflow denial of service attack. Unsupported locales are not symbolized, so there is no danger.
 
@@ -113,6 +126,8 @@ Note that care has been taken to prevent a symbol-table-overflow denial of servi
 
 If your system has authentication, then you likely use have a `current_user` helper method available. `LocaleSetter` will call `locale` on current user, expecting to get back a string response.
 
+Both method names(`current_user` & `locale`) can be changed via a config block.
+
 #### Storing a User Preference
 
 The easiest solution is to add a column to your users table:
@@ -132,18 +147,20 @@ Then, allow them to edit this preference wherever they edit other profile items
 
 Remember that you may need to modify the `user.rb` if you're filtering mass-assignment parameters.
 
-#### Using a Different Method / Column
-
-`LocaleSetter::User` can be configured to call a method other than `.locale` on the user.
+### Locale-per-domain
 
-Anytime after the library is loaded, like in a Rails initializer, use the `locale_method=` method:
+You could specify prefered locale according to the domain (or subdomain).
+Just specify domains hash via config block:
 
 ```ruby
-LocaleSetter::User.locale_method = :my_locale
+LocaleSetter.configure do |config|
+  config.localized_domains = {
+    "en.domain.com" => :en,
+    "es.domain.com" => :es
+  }
+end
 ```
 
-Subsequent calls to `LocaleSetter::User.for` will use the specified method.
-
 ### HTTP Headers
 
 Every request coming into your web server includes a ton of header information. One key/value pair looks like this:
@@ -176,4 +193,4 @@ Check out https://github.com/jcasimir/locale_setter_test for a simple Rails appl
 
 ## License
 
-Please see the included LICENSE.txt
+Please see the included LICENSE.txt

data/Rakefile

@@ -1,6 +1,69 @@
-require "bundler/gem_tasks"
-
+require 'rake'
+require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+def run_in_dummy_app(command)
+  success = system("cd spec/dummy && #{command}")
+  raise "#{command} failed" unless success
+end
+
+task "default" => "ci"
+
+desc "Run all tests for CI"
+task "ci" => "spec"
+
+desc "Run all specs"
+task "spec" => "spec:all"
+
+namespace "spec" do
+  task "all" => ["locale_setter", "requests"]
+
+  def spec_task(name)
+    desc "Run #{name} specs"
+    RSpec::Core::RakeTask.new(name) do |t|
+      t.pattern = "spec/#{name}/**/*_spec.rb"
+    end
+  end
+
+  spec_task "locale_setter"
+
+  desc "Run request specs"
+  task "requests" => ["db:setup", "requests:all"]
+
+  namespace "requests" do
+    task "all" => ["development", "production", "test"]
+
+    ["development", "production"].each do |environment|
+      task environment do
+        Rake::Task["spec:requests:run"].execute environment
+      end
+    end
+
+    task "run" do |t, environment|
+      puts "Running request specs in #{environment}"
+
+      ENV["RAILS_ENV"] = environment
+      success = system("rspec spec/requests")
+
+      raise "Integration specs failed in #{environment}" unless success
+    end
+
+    task "test" do
+      puts "Running rake in dummy app"
+      ENV["RAILS_ENV"] = "test"
+      run_in_dummy_app "rake"
+    end
+  end
+end
+
+namespace "db" do
+  desc "Set up databases for integration testing"
+  task "setup" do
+    puts "Setting up databases"
+    run_in_dummy_app "rm -f db/*.sqlite3"
+    run_in_dummy_app "RAILS_ENV=development rake db:schema:load db:seed"
+    run_in_dummy_app "RAILS_ENV=production rake db:schema:load db:seed"
+    run_in_dummy_app "RAILS_ENV=test rake db:schema:load"
+  end
+end
+

data/lib/locale_setter.rb

@@ -1,8 +1,11 @@
 require "locale_setter/version"
+require "locale_setter/configuration"
 require "locale_setter/matcher"
-require "locale_setter/rails"
+require "locale_setter/controller"
+require "locale_setter/railtie" if defined?(Rails)
 require "locale_setter/http"
 require "locale_setter/user"
+require "locale_setter/domain"
 require "locale_setter/param"
 require "locale_setter/generic"
 
@@ -10,4 +13,28 @@ module LocaleSetter
   HTTP_HEADER = 'HTTP_ACCEPT_LANGUAGE'
   URL_PARAM   = :locale
   USER_METHOD = :locale
+  CURRENT_USER_METHOD = :current_user
+
+  class << self
+    attr_accessor :configuration
+
+    def config
+      self.configuration ||= Configuration.new(default_params)
+    end
+
+    def configure
+      yield(config)
+    end
+
+    private
+
+    def default_params
+      {
+        :url_param => URL_PARAM,
+        :user_locale_method => USER_METHOD,
+        :localized_domains => {},
+        :current_user_method => CURRENT_USER_METHOD
+      }
+    end
+  end
 end

data/lib/locale_setter/configuration.rb

@@ -0,0 +1,8 @@
+class Configuration
+  attr_accessor :url_param, :user_locale_method, :localized_domains,
+    :http_header, :current_user_method
+
+  def initialize(options)
+    options.each_pair { |k, v| send(:"#{k}=", v) }
+  end
+end

data/lib/locale_setter/{rails.rb → controller.rb}

@@ -1,5 +1,5 @@
 module LocaleSetter
-  module Rails
+  module Controller
     def self.included(controller)
       controller.before_filter :set_locale
     end
@@ -8,7 +8,7 @@ module LocaleSetter
       if i18n.locale == i18n.default_locale
         options
       else
-        {URL_PARAM => i18n.locale}.merge(options)
+        {LocaleSetter.config.url_param => i18n.locale}.merge(options)
       end
     end
 
@@ -17,18 +17,18 @@ module LocaleSetter
         i18n,
         {:params => params,
          :user   => locale_user,
+         :domain => request.domain,
          :env    => request.env}
       )
     end
 
     def locale_user
-      if respond_to?(:current_user) && current_user
-        current_user
-      end
+      current_user_method = LocaleSetter.config.current_user_method.to_sym
+      send(current_user_method) if respond_to?(current_user_method)
     end
 
     def i18n
       I18n
     end
   end
-end
+end

data/lib/locale_setter/domain.rb

@@ -0,0 +1,17 @@
+module LocaleSetter
+  module Domain
+
+    def self.for(domain, available)
+      LocaleSetter::Matcher.match get_domain(domain), available
+    end
+
+    def self.get_domain(domain)
+      LocaleSetter.config.localized_domains[domain]
+    end
+
+    def self.localized_domains=(domains)
+      warn "Deprecation warning. You should use a new block syntax for configuration."
+      LocaleSetter.config.localized_domains = domains
+    end
+  end
+end

data/lib/locale_setter/generic.rb

@@ -3,11 +3,13 @@ module LocaleSetter
 
     def self.set_locale(i18n, options = {:params => nil,
                                          :user   => nil,
+                                         :domain => nil,
                                          :env    => nil})
 
-      i18n.locale = from_params(options[:params], available(i18n))    ||
-                    from_user(options[:user], available(i18n))        ||
-                    from_http(options[:env], available(i18n)) ||
+      i18n.locale = from_params(options[:params], available(i18n)) ||
+                    from_user(options[:user], available(i18n))     ||
+                    from_domain(options[:domain], available(i18n)) ||
+                    from_http(options[:env], available(i18n))      ||
                     i18n.default_locale
     end
 
@@ -25,9 +27,13 @@ module LocaleSetter
       end
     end
 
+    def self.from_domain(domain, available)
+      LocaleSetter::Domain.for(domain, available)
+    end
+
     def self.from_params(params, available)
-      if params && params[URL_PARAM]
-        LocaleSetter::Param.for(params[URL_PARAM], available)
+      if params && params[LocaleSetter.config.url_param]
+        LocaleSetter::Param.for(params[LocaleSetter.config.url_param], available)
       end
     end
   end

data/lib/locale_setter/railtie.rb

@@ -0,0 +1,17 @@
+require 'rails/railtie'
+
+module LocaleSetter
+  class Railtie < Rails::Railtie
+    config.after_initialize do |app|
+      # I would prefer to do this in an initializer block, but it's important
+      # that we do this _before_ any of the user's authentication stuff
+      # happens. So this is the best we can get for now.
+      ApplicationController.send(:include, LocaleSetter::Controller)
+    end
+  end
+  module Rails
+    def self.included(controller)
+      ActiveSupport::Deprecation.warn("You don't need to include LocaleSetter::Rails any more. There's a Railtie for That (tm).")
+    end
+  end
+end

data/lib/locale_setter/user.rb

@@ -1,20 +1,29 @@
+# this is primarily for 1.8.7 support
+# see http://www.ruby-doc.org/core-2.0/Symbol.html#method-i-empty-3F
+unless :locale.respond_to? :empty?
+  class Symbol
+    def empty?
+      self.to_s.empty?
+    end
+  end
+end
+
 module LocaleSetter
   module User
-    @@user_locale_method = :locale
-
     def self.for(user, available)
-      if user && user.respond_to?(locale_method) && 
+      if user && user.respond_to?(locale_method) &&
          user.send(locale_method) && !user.send(locale_method).empty?
         LocaleSetter::Matcher.match user.send(locale_method), available
       end
     end
 
     def self.locale_method
-      @@user_locale_method
+      LocaleSetter.config.user_locale_method
     end
 
     def self.locale_method=(method_name)
-      @@user_locale_method = method_name
+      warn "Deprecation warning. You should use a new block syntax for configuration."
+      LocaleSetter.config.user_locale_method = method_name
     end
   end
-end
+end