url_locale 0.1.0

data/.document

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

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "yard", "~> 0.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,22 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.9.2)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+    yard (0.6.8)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  rcov
+  shoulda
+  yard (~> 0.6.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Dan Byström
+
+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.markdown

@@ -0,0 +1,87 @@
+# 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.
+
+## 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).
+
+## 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
+
+If a locale can't be detected, fallback will be `I18n.default_locale`
+
+## Installation and configuration
+
+1. Run `rake middleware RAILS_ENV=development` and `rake middleware RAILS_ENV=production`
+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
+6. Add before filter in application to set locale
+
+### Rails 3 example
+
+    # Gemfile
+    gem 'url_locale'
+    
+    # config/environments/development.rb
+    config.middleware.insert_before "ActionDispatch::Static", UrlLocale::Middleware
+    
+    # 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
+    
+    # app/controllers/application_controller.rb
+    before_filter :set_locale
+
+    def set_locale
+      I18n.locale = UrlLocale.detect request
+    end
+
+## Development
+
+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 :)
+
+## Copyright
+
+Copyright (c) 2011 Dan Byström. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,46 @@
+# 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 = "url_locale"
+  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.email = "dan.bystrom@gmail.com"
+  gem.authors = ["Dan Byström"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/url_locale/middleware.rb

@@ -0,0 +1,18 @@
+module UrlLocale
+  class Middleware
+
+    def initialize app
+      @app = app
+    end
+
+    def call env
+      status, headers, body = @app.call env
+      request = ::Rack::Request.new env
+      mime_types = env["action_dispatch.request.formats"] || []
+      if mime_types.find(&:html?).present?
+        env['rack.locale'] = headers['Content-Language'] = UrlLocale.detect(request)
+      end
+      [status, headers, body]
+    end
+  end
+end

data/lib/url_locale.rb

@@ -0,0 +1,38 @@
+require "url_locale/middleware"
+module UrlLocale  
+  
+  class << self
+    # Returns an <tt>I18n.available_locales - I18n.default_locale</tt>
+    def translations
+      @@translations ||= (I18n.available_locales - [I18n.default_locale]).map &:to_s
+    end
+
+    # Returns a Regexp to extract the locale from +request.host+
+    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 mode
+      @@mode ||= :path
+    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
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'url_locale'
+
+class Test::Unit::TestCase
+end

data/test/test_url_locale.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestUrlLocale < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification 
+name: url_locale
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Dan Bystr\xC3\xB6m"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-14 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  name: shoulda
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  name: yard
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  name: bundler
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 6
+        - 4
+        version: 1.6.4
+  name: jeweler
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  type: :development
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        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.
+email: dan.bystrom@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.markdown
+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
+has_rdoc: true
+homepage: http://github.com/danbys/url_locale
+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.6.2
+signing_key: 
+specification_version: 3
+summary: Use Rack middleware to parse the URL and set content-lang response header
+test_files: []
+