rack-i18n_routes 0.2 → 0.3

data/README.md

@@ -6,7 +6,11 @@ that have been translated into untranslated or canonical URL.
 
 If you manage a site that has content many languages and also localized URLs,
 you will find `rack-i18n_routes` very useful, especially when used in
-conjunction with `rack-i18n_best_langs`.
+conjunction with [`rack-i18n_best_langs`](https://github.com/gioele/rack-i18n_best_langs).
+
+Differently from other similar Rack middleware components,
+`rack-i18n_routes` focuses only on path translation/normalization and does not
+require Rails or the `i18n` gem.
 
 
 Features
@@ -18,6 +22,8 @@ Path normalization rewrites the URI (actually the `PATH_INFO`) so that that the
 downstream applications will have to deal with the normalized path only, instead
 of a myriad of localized paths.
 
+The original path is saved in the `rack.i18n_routes_orig_PATH_INFO` variable.
+
 
 Examples
 --------
@@ -55,12 +61,13 @@ rack-i18n_routes works like any other Rack middleware component:
     use Rack::I18nRoutes, MAPPING_FN
     run MyApp
 
-Request to `/articulos/el-bloque`, `/articles/le-bloc` and even
+Requests to `/articulos/el-bloque`, `/articles/le-bloc` and even
 `/articulos/le-bloc` will all be sent to `/articles/the-block`.
 
 This component deals only with URL normalization. You can use
-`rack-i18n_best_langs` to automatically associate the translated URLs to their
-languages.
+[`rack-i18n_best_langs`](https://github.com/gioele/rack-i18n_best_langs)
+([documentation](http://rubydoc.info/gems/rack-i18n_best_langs)) to
+automatically associate the translated URLs to their languages.
 
 
 Requirements

data/Rakefile

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

data/lib/rack/i18n_routes.rb

@@ -46,6 +46,8 @@ require 'rack'
 
 class Rack::I18nRoutes
 
+	ORIG_PATH_INFO_VARIABLE = 'rack.i18n_routes_orig_PATH_INFO'
+
 	# Set up an i18n routing table.
 	#
 	# @overload initialize(app, url_mapper)
@@ -114,7 +116,7 @@ class Rack::I18nRoutes
 			@path_lookup[path]
 		end
 
-		env['rack.i18n-routes_PATH_INFO'] = path
+		env[ORIG_PATH_INFO_VARIABLE] = path
 		env['PATH_INFO'] = normalized_path
 
 		return @app.call(env)

data/lib/rack/i18n_routes/alias_mapping.rb

@@ -88,69 +88,107 @@ class Rack::I18nRoutes::AliasMapping
 	# @return [String]
 
 	def map(path)
-		normalized_path, found_langs = map_with_langs(path)
+		normalized_pieces, translated_pieces, found_langs = path_analysis(path)
+
+		normalized_path = normalized_pieces.join('/')
 
 		return normalized_path
 	end
 
-	# @return [(String, Array<Object>)]
+	# @return [String]
+
+	def translate_into(path, language)
+		normalized_pieces, translated_pieces, found_langs = path_analysis(path, language)
+
+		return translated_pieces.join('/')
+	end
 
-	def map_with_langs(path)
+	# @return [(Array<String>, Array<String>, Array<Object>)]
+
+	def path_analysis(path, replacement_language = :default)
 		orig_pieces = path.split('/')
 
 		normalized_pieces = []
+		translated_pieces = []
 		found_langs = []
 
-		normalized_pieces << orig_pieces.shift
-		found_langs << @default_lang
+		# PATH_INFO always starts with / in Rack, so we directly move
+		# the initial empty piece into the normalized ones
+
+		pre_slash = orig_pieces.shift
+		normalized_pieces << pre_slash
+		translated_pieces << pre_slash
 
 		aliases = @aliases
 
 		orig_pieces.each do |orig_piece|
-			normalized, lang = normalization_for(orig_piece, aliases)
+			normalized, translation, lang = normalization_for(orig_piece, aliases, replacement_language)
 			replacement = (normalized || orig_piece)
 
 			normalized_pieces << replacement
+			translated_pieces << translation
 			found_langs << lang
 
-			if !aliases.nil?
-				subaliases = aliases[replacement]
-				aliases = subaliases[:children] unless subaliases.nil?
+			if !aliases.nil? && aliases.has_key?(replacement)
+				aliases = aliases[replacement][:children]
+			else
+				aliases = nil
 			end
 		end
 
 		if path.end_with?('/')
 			normalized_pieces << ""
-			found_langs << @default_lang
+			translated_pieces << ""
 		end
 
-		normalized_path = normalized_pieces.join('/')
-
-		return normalized_path, found_langs
+		return normalized_pieces, translated_pieces, found_langs
 	end
 
 	# @return [(String, Object)]
+	#
+	# @api private
 
-	def normalization_for(piece, aliases)
+	def normalization_for(piece, aliases, replacement_language)
 		if aliases.nil?
-			return nil, @default_lang
+			return nil, piece, @default_lang
 		end
 
 		entities = aliases.keys
 		entities.each do |entity|
 			if piece == entity
-				return entity, @default_lang
+				translated_piece = piece_translation(piece, aliases[entity], replacement_language)
+				return entity, translated_piece, @default_lang
 			end
 
 			subentities = aliases[entity].values.reject { |e| e.is_a? Hash }
 			subentity = subentities.find { |s| Array(s).any? { |sube| piece == sube } }
 			if !subentity.nil?
-				return entity, aliases[entity].index(subentity)
+				lang = aliases[entity].index(subentity)
+				translated_piece = piece_translation(piece, aliases[entity], replacement_language)
+				return entity, translated_piece, lang
 			end
 		end
 
 		# the piece is not present in the aliases
 
-		return nil, @default_lang
+		return nil, piece, @default_lang
+	end
+
+	# @return [String]
+	#
+	# @api private
+
+	def piece_translation(piece, aliases, replacement_language)
+		if replacement_language == :default
+			return piece
+		end
+
+		translated_pieces = Array(aliases[replacement_language])
+
+		if translated_pieces.empty?
+			return piece
+		end
+
+		return translated_pieces.first
 	end
 end

data/lib/rack/i18n_routes/alias_mapping_updater.rb

@@ -54,20 +54,42 @@ class Rack::I18nRoutes::AliasMappingUpdater
 		@opts = opts
 	end
 
-	# @return [String]
+	# @see Rack::I18nRoutes::AliasMapping#map
+	#
+	# @return (see Rack::I18nRoutes::AliasMapping#map)
+	#
+	# @api private
 
 	def map(path)
-		normalized_path, found_langs = map_with_langs(path)
+		alias_mapping.map(path)
+	end
+
+	# @see Rack::I18nRoutes::AliasMapping#translate_into
+	#
+	# @return (see Rack::I18nRoutes::AliasMapping#translate_into)
+	#
+	# @api private
+
+	def translate_into(path, language)
+		alias_mapping.translated_into(path, language)
+	end
+
+	# @see Rack::I18nRoutes::AliasMapping#analysis
+	#
+	# @return (see Rack::I18nRoutes::AliasMapping#analysis)
+	#
+	# @api private
 
-		return normalized_path
+	def path_analysis(path, replacement_language = :default)
+		alias_mapping.analysis(path, replacement_language)
 	end
 
-	# @return [(String, Array<Object>)]
+	# @api private
 
-	def map_with_langs(path)
+	def alias_mapping
 		aliases = @new_aliases_fn[]
-		alias_mapping = Rack::I18nRoutes::AliasMapping.new(aliases, @opts)
+		mapping = Rack::I18nRoutes::AliasMapping.new(aliases, @opts)
 
-		return alias_mapping.map_with_langs(path)
+		return mapping
 	end
 end

data/spec/i18n_routes_spec.rb

@@ -28,7 +28,7 @@ TEST_ALIASES = {
 
 		:children => {
 			'gioconda' => {
-				'fra' => 'joconde',
+				'fra' => ['joconde', 'la-joconde'],
 			}
 		}
 	}
@@ -54,6 +54,24 @@ def request_with(path, mapping_fn)
 end
 
 describe Rack::I18nRoutes do
+	context "with a Proc mapping" do
+		let(:mapping) { Proc.new { |orig_path| orig_path + "_extra" } }
+
+		it "applies the mapping" do
+			env = request_with('/articles', mapping).env
+			path = env['PATH_INFO']
+
+			path.should == '/articles_extra'
+		end
+
+		it "saves the original path" do
+			env = request_with('/articles', mapping).env
+			orig_path = env[Rack::I18nRoutes::ORIG_PATH_INFO_VARIABLE]
+
+			orig_path.should == '/articles'
+		end
+	end
+
 	context "with an AliasMapping" do
 		let(:mapping) { Rack::I18nRoutes::AliasMapping.new(TEST_ALIASES) }
 
@@ -84,6 +102,13 @@ describe Rack::I18nRoutes do
 
 			path.should == '/foobar'
 		end
+
+		it "saves the original path" do
+			env = request_with('/articulos/le-bloc', mapping).env
+			orig_path = env[Rack::I18nRoutes::ORIG_PATH_INFO_VARIABLE]
+
+			orig_path.should == '/articulos/le-bloc'
+		end
 	end
 
 	context "with an AliasMappingUpdater" do
@@ -116,6 +141,13 @@ describe Rack::I18nRoutes do
 
 			path.should == '/foobar'
 		end
+
+		it "saves the original path" do
+			env = request_with('/articulos/le-bloc', mapping).env
+			orig_path = env[Rack::I18nRoutes::ORIG_PATH_INFO_VARIABLE]
+
+			orig_path.should == '/articulos/le-bloc'
+		end
 	end
 end
 
@@ -124,22 +156,44 @@ describe Rack::I18nRoutes::AliasMapping do
 	let(:mapping) { Rack::I18nRoutes::AliasMapping.new(TEST_ALIASES, :default => default_lang) }
 
 	context "with a :default option set" do
-		it "returns the default key for normalized paths" do
-			ph, found_langs = mapping.map_with_langs('/paintings/gioconda/')
+		describe "#path_analysis" do
+			it "returns the default key for normalized paths" do
+				ph, trans, found_langs = mapping.path_analysis('/paintings/gioconda/')
 
-			found_langs.should == [default_lang]*4
-		end
+				found_langs.should == [default_lang, default_lang]
+			end
 
-		it "returns the non-default key when set" do
-			ph, found_langs = mapping.map_with_langs('/articulos/la-victoire/')
+			it "returns the non-default key when set" do
+				ph, trans, found_langs = mapping.path_analysis('/articulos/la-victoire/')
 
-			found_langs.should == [default_lang, 'spa', 'fra', default_lang]
+				found_langs.should == ['spa', 'fra']
+			end
+
+			it "returns the default key for unknown paths" do
+				ph, trans, found_langs = mapping.path_analysis('/articulos/foobar/')
+
+				found_langs.should == ['spa', default_lang]
+			end
 		end
 
-		it "returns the default key for unknown paths" do
-			ph, found_langs = mapping.map_with_langs('/articulos/fancy/')
+		describe "#translate_into" do
+			it "translates a path" do
+				ph = mapping.translate_into('/pinturas/gioconda', 'fra')
+
+				ph.should == '/peintures/joconde'
+			end
+
+			it "translates a path with untranslated pieces" do
+				ph = mapping.translate_into('/paintings/gioconda', 'spa')
+
+				ph.should == '/pinturas/gioconda'
+			end
+
+			it "translates a path with unknown pieces" do
+				ph = mapping.translate_into('/pinturas/foobar/quux', 'fra')
 
-			found_langs.should == [default_lang, 'spa', default_lang, default_lang]
+				ph.should == '/peintures/foobar/quux'
+			end
 		end
 	end
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rack-i18n_routes
 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-05 00:00:00 Z
+date: 2012-08-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rack