url_locale 0.1.0 → 0.2.0

data/README.markdown

@@ -1,42 +1,47 @@
 # url_locale
 
-Add _content-language_ to your response header using Rack. The locale variable is parsed from the requested URL or if no locale can be detected then `I18n.default_locale` will be your fallback.
+Add _content-language_ to the response header using Rack. The locale variable is parsed from request URL, if no locale can be detected then `I18n.default_locale` will be your fallback.
 
 ## Rack
 
-Rack middleware parses the URL and sets the response header _content-language_ attribute accordingly. Since the header is passed on to the web server, inserting `<meta http-equiv="Content-Language" content="en"/>` in the response body will be superfluous. Please note that cached responses passing through Rack also will get the correct content-language header (can be tricky to configure the web server to this).
+Rack middleware parses the URL and sets the response header _content-language_ attribute accordingly. Since the header is passed on to the web server, inserting `<meta http-equiv="Content-Language" content="en"/>` in the response body is superfluous. Please note that cached responses passing through Rack also will get the correct content-language header (can be tricky to configure the web server to do this).
 
 ## Detect URL locale
 
-The gem will look for `I18n.available_locales` in `request.host` or `request.path`. In Path mode which is the default mode, `locale` will be parsed from the path. In Host mode `locale` will be parsed from the host string.
-
-### Path mode examples
-    
-    I18n.default_locale => :en
-    I18n.available_locales => [:sv, :pt]
-    
-    http://example.com                        => "en"
-    http://sv.example.com                     => "en"
-    http://www.example.com/about              => "en"
-    http://www.example.com/pt/em              => "pt"
-    http://example.com/sv/om                  => "sv"
-    http://example.com/fr/sur                 => "en" # fallback
-
-If a locale can't be detected, fallback will be `I18n.default_locale`
-
-### Host mode examples
-
-    I18n.default_locale => :en
-    I18n.available_locales => [:sv, :pt]
-    
-    http://example.com                        => "en"
-    http://sv.example.com                     => "sv"
-    http://www.example.com/pt/em              => "en"
-    http://fr.example.com/sur                 => "en" # fallback
-    http://example.com/sv/sur                 => "en"
-    http://sv.example.com/pt/em               => "sv" 
-    http://sv.mobile.example.com             => "sv"
-    http://modile.sv.example.com             => "en" # fallback
+The gem will parse `request.url` for `I18n.available_locales` in the following order:
+
+1. `request.url` listed in `config/url_locale.yml`?
+2. `request.path` starts with `I18n.available_locales`
+3. `I18n.default_locale`
+
+
+## Example
+
+```yml
+# config/url_locale.yml
+en:
+  - http://localehost:3000
+  - http://example.com
+sv:
+  - http://localehost:3001
+  - http://example.se
+```
+```
+I18n.default_locale => :en
+I18n.available_locales => [:en, :sv]
+
+http://example.com                        => "en"
+http://sv.example.com                     => "en" # fallback
+http://example.se/about                   => "sv"
+http://example.com/sv/om                  => "en"
+http://www.example.com/sv/om              => "sv" # parse path
+
+http://localhost:3000                     => "en"
+http://sv.localhost:3000                  => "en" # fallback
+http://localhost:3001/about               => "sv"
+http://localhost:3000/sv/om               => "en"
+http://localhost:3002/sv/om              => "sv" # parse path
+```
 
 If a locale can't be detected, fallback will be `I18n.default_locale`
 
@@ -46,10 +51,58 @@ If a locale can't be detected, fallback will be `I18n.default_locale`
 2. Notice the order of the middleware for each environment
 3. Add `gem 'url_locale'` to Gemfile
 4. Insert `UrlLocale::Middleware` as the first middleware in the Rack middleware stack
-5. (optional) Configure - Change to Host mode
+5. (optional) create `config/url_locale.yml`
 6. Add before filter in application to set locale
 
-### Rails 3 example
+### Rails 3.1 example
+
+    $ rake middleware RAILS_ENV=development
+    use ActionDispatch::Static
+    use Rack::Lock
+    use #<ActiveSupport::Cache::Strategy::LocalCache::Middleware:0x101fefef0>
+    use Rack::Runtime
+    use Rack::MethodOverride
+    use Rails::Rack::Logger
+    use ActionDispatch::ShowExceptions
+    use ActionDispatch::RemoteIp
+    use Rack::Sendfile
+    use ActionDispatch::Reloader
+    use ActionDispatch::Callbacks
+    use ActiveRecord::ConnectionAdapters::ConnectionManagement
+    use ActiveRecord::QueryCache
+    use ActionDispatch::Cookies
+    use ActionDispatch::Session::CookieStore
+    use ActionDispatch::Flash
+    use ActionDispatch::ParamsParser
+    use ActionDispatch::Head
+    use Rack::ConditionalGet
+    use Rack::ETag
+    use ActionDispatch::BestStandardsSupport
+    run Learning::Application.routes
+    
+    $ rake middleware RAILS_ENV=production
+    use Rack::Cache
+    use Rack::Lock
+    use #<ActiveSupport::Cache::Strategy::LocalCache::Middleware:0x101feeb68>
+    use Rack::Runtime
+    use Rack::MethodOverride
+    use Rails::Rack::Logger
+    use ActionDispatch::ShowExceptions
+    use ActionDispatch::RemoteIp
+    use Rack::Sendfile
+    use ActionDispatch::Callbacks
+    use ActiveRecord::ConnectionAdapters::ConnectionManagement
+    use ActiveRecord::QueryCache
+    use ActionDispatch::Cookies
+    use ActionDispatch::Session::CookieStore
+    use ActionDispatch::Flash
+    use ActionDispatch::ParamsParser
+    use ActionDispatch::Head
+    use Rack::ConditionalGet
+    use Rack::ETag
+    use ActionDispatch::BestStandardsSupport
+    run Learning::Application.routes
+    
 
     # Gemfile
     gem 'url_locale'
@@ -60,8 +113,13 @@ If a locale can't be detected, fallback will be `I18n.default_locale`
     # config/environments/production.rb
     config.middleware.insert_before "Rack::Cache", UrlLocale::Middleware
     
-    # config/initializers/url_locale.rb (optional configuration file)
-    UrlLocale.host_mode # comment out this line to run Path mode
+    # config/url_locale.yml (optional configuration file)
+    en:
+      - http://localehost:3000
+      - http://example.com
+    sv:
+      - http://localehost:3001
+      - http://example.se
     
     # app/controllers/application_controller.rb
     before_filter :set_locale
@@ -75,7 +133,6 @@ If a locale can't be detected, fallback will be `I18n.default_locale`
 There is room for improvement for this gem
 
 - Easier installation
-- Improved parsing modes
 - Other ideas?
 
 If url_locale gets more then 1000 downloads, further development might be worth the effort :)

data/Rakefile

@@ -18,7 +18,7 @@ Jeweler::Tasks.new do |gem|
   gem.homepage = "http://github.com/danbys/url_locale"
   gem.license = "MIT"
   gem.summary = %Q{Use Rack middleware to parse the URL and set content-lang response header}
-  gem.description = %Q{All html and xml responses passing through Rack will have content-lang header when reaching the webserver. The response body won't need a meta content-lang tag, not even when it's is cached response.}
+  gem.description = %Q{All HTML responses passing through Rack will have content-lang header when reaching the webserver. The response body won't need a meta content-lang tag, not even when it's is cached response.}
   gem.email = "dan.bystrom@gmail.com"
   gem.authors = ["Dan Byström"]
   # dependencies defined in Gemfile

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/lib/url_locale.rb

@@ -8,31 +8,45 @@ module UrlLocale
     end
 
     # Returns a Regexp to extract the locale from +request.host+
-    def subdomain_locales
-      @@subdomain_locales ||= Regexp.new "(^|\.)(#{translations*'|'})\."
-    end
+    # def subdomain_locales
+    #   @@subdomain_locales ||= Regexp.new "(^|\.)(#{translations*'|'})\."
+    # end
 
     # Returns a Regexp to extract the locale from +request.path+
     def path_locales
       @@path_locales ||= Regexp.new "^\/(#{translations*'|'})(\/|$)"
     end
     
-    def host_mode
-      @@mode = :host
-    end
+    # def host_mode
+    #   @@mode = :host
+    # end
+    # 
+    # def mode
+    #   @@mode ||= :path
+    # end
     
-    def mode
-      @@mode ||= :path
+    def host_locales
+      @@host_locales ||= begin
+        config_fpath = File.join Rails.root, 'config', 'url_locale.yml'
+        result = {}
+        if File.exist? config_fpath
+          YAML::load_file(config_fpath).each do |locale, hosts|
+            for host in hosts
+              result[host] = locale.underscore
+            end
+          end
+        end
+        result
+      end
     end
     
     def detect request
       if translations.present?
-        if mode == :path
-          path_locales.match(request.path).try :[], 1          
-        else
-          subdomain_locales.match(request.host).try :[], 2
-        end
-      end || I18n.default_locale.to_s
+        host_url = request.url.split(request.host_with_port).first + request.host_with_port
+        host_locales[host_url] ||
+          path_locales.match(request.path).try(:[], 1) || 
+          I18n.default_locale.to_s
+      end
     end
   end
 end

data/url_locale.gemspec

@@ -0,0 +1,63 @@
+# 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{url_locale}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dan Bystr\303\266m"]
+  s.date = %q{2011-07-25}
+  s.description = %q{All HTML responses passing through Rack will have content-lang header when reaching the webserver. The response body won't need a meta content-lang tag, not even when it's is cached response.}
+  s.email = %q{dan.bystrom@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.markdown"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.markdown",
+    "Rakefile",
+    "VERSION",
+    "lib/url_locale.rb",
+    "lib/url_locale/middleware.rb",
+    "test/helper.rb",
+    "test/test_url_locale.rb",
+    "url_locale.gemspec"
+  ]
+  s.homepage = %q{http://github.com/danbys/url_locale}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Use Rack middleware to parse the URL and set content-lang response header}
+
+  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_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.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<shoulda>, [">= 0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.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<shoulda>, [">= 0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.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
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: url_locale
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
+  - 2
   - 0
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Dan Bystr\xC3\xB6m"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-14 00:00:00 +02:00
+date: 2011-07-25 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -94,7 +94,7 @@ dependencies:
         version: "0"
   name: rcov
   version_requirements: *id005
-description: All html and xml responses passing through Rack will have content-lang header when reaching the webserver. The response body won't need a meta content-lang tag, not even when it's is cached response.
+description: All HTML responses passing through Rack will have content-lang header when reaching the webserver. The response body won't need a meta content-lang tag, not even when it's is cached response.
 email: dan.bystrom@gmail.com
 executables: []
 
@@ -115,6 +115,7 @@ files:
 - lib/url_locale/middleware.rb
 - test/helper.rb
 - test/test_url_locale.rb
+- url_locale.gemspec
 has_rdoc: true
 homepage: http://github.com/danbys/url_locale
 licenses: