rack-i18n_best_langs 0.2 → 0.3

data/README.md

@@ -6,7 +6,12 @@ understanding what are the best languages for a site visitor.
 
 If you manage a site that has content many languages and also localized URLs,
 you will find `rack-i18n_best_langs` very useful, especially when used in
-conjunction with `rack-i18n_routes`.
+conjunction with [`rack-i18n_routes`](https://github.com/gioele/rack-i18n_routes).
+
+Differently from other similar Rack middleware components,
+`rack-i18n_best_langs` returns a list of languages in order of guessed
+importance, not a single language. Also, it does not require Rails or
+the `i18n` gem.
 
 
 Features
@@ -22,10 +27,40 @@ All these clues are taken into account and evaluated against the list
 of languages available and their preferred order. It is possible to configure
 which of these clues is the most important.
 
-An additional clue is available when `AliasMapping` is used as the mapping
-function: the language in which the path is written. For
-example, `/articles/the-victory` is English, `/artículos/la-victoria`, is
-Spanish, `/articles/la-victoire` is French.
+An additional clue is available when `AliasMapping` (part of
+[rack-i18n_routes](http://rubydoc.info/gems/rack-i18n_routes)) is used as the
+mapping function: the language in which the path is written. For example,
+`/articles/the-victory` add preference of English, `/artículos/la-victoria`
+for Spanish and `/articles/la-victoire` for French.
+
+
+How it works
+------------
+
+Each request is analysed in search for possible clues that can expose what
+are the best languages to use in the content served in response. Each clue
+contributes part of the final score of each language; the score is amplified
+by the weight associated to the clue.
+
+For example, if a person requests the URL `/article/vittoria/ita` from
+a browser in a German internet point (thus sending `Accept-Language: de-DE`),
+their request would lead to the following scores:
+
+* `ita`: 315 = 0 (not in header) + 15 (partially language of URL) + 300 (path
+   ends in `/ita`);
+* `eng`: 15 = 0 (not in header) + 15 (partially language of URL) + 0 (path
+   does not end in `/eng`);
+* `ger`: 3 = 3 (in header) + 0 (not language of URL) + 0 (path does not end
+   in `/ger`).
+
+The downstream application will find the guessed languages in the
+`rack.i18n_best_langs` env variable, in order of importance.
+
+    env['rack.i18n_best_langs'] # => [ 'ita', 'eng', 'ger' ]
+
+At this point, it is up to the application to choose what to do, either change
+the locale using the `i18n` gem, set up its own locale management system or
+just keep track of this information.
 
 
 Examples
@@ -102,6 +137,7 @@ You can change these weight with the `:weights` option.
 
     use Rack::I18nBestLangs, FAVORITE_LANGUAGES, :weights => WEIGHTS
 
+To disable the use of any of the clues, set its weight to zero.
 
 ### Using `AliasMapping`
 

data/Rakefile

@@ -16,7 +16,7 @@ Bones {
 	email    'gioele@svario.it'
 	url      'https://github.com/gioele/rack-i18n_best_langs'
 
-	version  '0.2'
+	version  '0.3'
 
 	ignore_file  '.gitignore'
 

data/lib/rack/i18n_best_langs.rb

@@ -3,13 +3,19 @@
 # See the `COPYING` file or <http://creativecommons.org/publicdomain/zero/1.0/>
 # for more details.
 
+require 'rack'
 
 require 'rack/language_tag.rb'
 
-module Rack
+class Rack::I18nBestLangs
+	RACK_VARIABLE = 'rack.i18n_best_langs'.freeze
 
-class I18nBestLangs
-	RACK_VARIABLE = 'rack.i18n_best_langs'
+	DEFAULT_WEIGHTS = {
+		:header => 1,
+		:aliases_path => 2,
+		:path => 3,
+		:cookie => 4,
+	}.freeze
 
 	# Create a new I18nBestLangs middleware component.
 	#
@@ -31,16 +37,11 @@ class I18nBestLangs
 
 		score_base = avail_languages.length
 
-		weights = opts[:weights] || {}
-		weight_header       = weights[:header]       || 1
-		weight_aliases_path = weights[:aliases_path] || 2
-		weight_path         = weights[:path]         || 3
-		weight_cookie       = weights[:cookie]       || 4
-
-		@score_for_header       = score_base * (10 ** weight_header)
-		@score_for_aliases_path = score_base * (10 ** weight_aliases_path)
-		@score_for_path         = score_base * (10 ** weight_path)
-		@score_for_cookie       = score_base * (10 ** weight_cookie)
+		weights = opts[:weights] || DEFAULT_WEIGHTS
+		@score_for_header       = score_base * (10 ** weights[:header])
+		@score_for_aliases_path = score_base * (10 ** weights[:aliases_path])
+		@score_for_path         = score_base * (10 ** weights[:path])
+		@score_for_cookie       = score_base * (10 ** weights[:cookie])
 
 		@avail_languages = {}
 		avail_languages.each_with_index do |lang, i|
@@ -49,15 +50,17 @@ class I18nBestLangs
 
 			@avail_languages[code] = score
 		end
+		@avail_languages.freeze
 
-		@language_path_regex = regex_for_languages_in_path
+		@language_path_regex = regex_for_languages_in_path.freeze
 
 		@path_mapping_fn = opts[:path_mapping_fn]
 	end
 
 	def call(env)
 		lang_info = find_best_languages(env)
-		env[I18nBestLangs::RACK_VARIABLE] = lang_info[:languages]
+
+		env[RACK_VARIABLE] = lang_info[:languages]
 		env['PATH_INFO'] = lang_info[:path_info]
 
 		return @app.call(env)
@@ -89,16 +92,16 @@ class I18nBestLangs
 	def extract_language_header(env)
 		header = env['HTTP_ACCEPT_LANGUAGE']
 
-		if (header =~ HEADER_FORMAT)
-			return header
-		else
-			# FIXME: env.warn
-			return ""
+		if !(header =~ HEADER_FORMAT)
+			env["rack.errors"].puts("Warning: malformed Accept-Language header")
+			return nil
 		end
+
+		return header
 	end
 
 	def extract_language_cookie(env)
-		return Rack::Request.new(env).cookies[I18nBestLangs::RACK_VARIABLE]
+		return Rack::Request.new(env).cookies[RACK_VARIABLE]
 	end
 
 	def remove_language_from_path(path)
@@ -151,11 +154,11 @@ class I18nBestLangs
 	end
 
 	def add_score_for_aliases_path(path, langs)
-		if !@path_mapping_fn.respond_to?(:map_with_langs)
+		if !@path_mapping_fn.respond_to?(:path_analysis)
 			return
 		end
 
-		ph, aliases_langs = @path_mapping_fn.map_with_langs(path)
+		ph, translation, aliases_langs = @path_mapping_fn.path_analysis(path)
 		aliases_langs.map! { |tag| LanguageTag.parse(tag) }
 
 		lang_uses = aliases_langs.inject(Hash.new(0)) {|freq, lang| freq[lang] += 1; freq }
@@ -207,7 +210,5 @@ class I18nBestLangs
 		return Regexp.new("\\A#{lang}#{qvalue}?(, ?#{lang}#{qvalue}?)*\\Z")
 	end
 
-	HEADER_FORMAT = self.accept_language_format
-end
-
+	HEADER_FORMAT = self.accept_language_format.freeze
 end

data/spec/i18n-best-langs_spec.rb

@@ -29,7 +29,7 @@ describe Rack::I18nBestLangs do
 			i18n_opts << extra_opts
 		end
 
-		session = Rack::Test::Session.new(Rack::MockSession.new(app(*i18n_opts)))
+		session = Rack::Test::Session.new(app(*i18n_opts))
 	        session.request(path, env_opts)
 
         	return session.last_request
@@ -128,5 +128,15 @@ describe Rack::I18nBestLangs do
 			languages.first.should == 'fra'
 		end
 	end
+
+	context "with malformed headers" do
+		it "warns of malformed ACCEPT_LANGUAGE" do
+			env = request_with('/test', { 'HTTP_ACCEPT_LANGUAGE' => 'fobar/1a' }).env
+
+			# FIXME: simplify code, https://github.com/brynary/rack-test/issues/61
+			errors = env['rack.errors'].instance_variable_get(:@error).instance_variable_get(:@error).string
+			errors.should include('malformed Accept-Language')
+		end
+	end
 end
 

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rack-i18n_best_langs
 version: !ruby/object:Gem::Version 
-  hash: 15
+  hash: 13
   prerelease: 
   segments: 
   - 0
-  - 2
-  version: "0.2"
+  - 3
+  version: "0.3"
 platform: ruby
 authors: 
 - Gioele Barabucci
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-07 00:00:00 Z
+date: 2012-08-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rack
@@ -56,7 +56,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 959707343
+        hash: -701993856
         segments: 
         - 0
         - 3