utopia 1.1.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ba1d6de864b4c631f7eea25e878c6612ea5c83e
-  data.tar.gz: 8fce1f1e3820075e0c5b3bf20cbf32eb9e1cebcc
+  metadata.gz: 31ace1eb6c636da91d00f8eee84b9dcaf839f817
+  data.tar.gz: 27d8124f0df0d66189d9230cce119db1a39901cd
 SHA512:
-  metadata.gz: 353a709c2b9b2eefeb612f37e57e23e73a4991458cc623a8e611842e8da329ed225f919ae16560734ba4da3f0906c6a296acb0c5ec7dc1ecff6d376de5dfcc93
-  data.tar.gz: 898b1484f1369e06f289b91441d9d2d2152c1931e9a386ca7a0614fde2a8d4269211d1557ee2d6eaaf97b137e1a3b90d5b55bdf9a18dd7ca3ad5483b267a016b
+  metadata.gz: 1ccc85d249b116d20fcba8403244b8d466aecfe527cf0a13aa79b19ee78e162c6acd9e458a40bf5064dae17b2108c0b4bd851ca2e4fc06a7e84990db148abeac
+  data.tar.gz: 5e95784314d4c28253714caac80b9efec859f988bf908784da15d65c2d460623ee2607505a93b931b392558b7bbfe41c328814cd1631a6979a024016931dd062

data/lib/utopia/content/link.rb

@@ -23,6 +23,7 @@ require 'trenni/builder'
 
 require_relative '../content'
 require_relative '../path'
+require_relative '../locale'
 
 module Utopia
 	class Content
@@ -35,16 +36,16 @@ module Utopia
 
 				case @kind
 				when :file
-					@name, @variant = path.last.split('.', 2)
+					@name, @locale = path.last.split('.', 2)
 					@path = path
 				when :directory
 					# raise ArgumentError unless path.last.start_with? INDEX
 					
 					@name = path.dirname.last
-					@variant = path.last.split('.', 2)[1]
+					@locale = path.last.split('.', 2)[1]
 					@path = path
 				when :virtual
-					@name, @variant = path.to_s.split('.', 2)
+					@name, @locale = path.to_s.split('.', 2)
 					@path = @info[:path] ? Path.create(@info[:path]) : nil
 				else
 					raise ArgumentError.new("Unknown link kind #{@kind} with path #{path}")
@@ -67,7 +68,7 @@ module Utopia
 			attr :name
 			attr :path
 			attr :info
-			attr :variant
+			attr :locale
 
 			def href?
 				!!href

data/lib/utopia/content/links.rb

@@ -26,10 +26,10 @@ module Utopia
 		
 		# Links are essentially a static list of information relating to the structure of the content. They are formed from the `links.yaml` file and the actual files on disk. 
 		class Links
-			def self.for(root, path, variant = nil)
+			def self.for(root, path, locale = nil)
 				links = self.new(root, path.dirname)
 				
-				links.lookup(path.last, variant)
+				links.lookup(path.last, locale)
 			end
 			
 			DEFAULT_INDEX_OPTIONS = {
@@ -56,18 +56,18 @@ module Utopia
 					ordered.select!{|link| link.name[options[:name]]}
 				end
 				
-				if variant = options[:variant]
-					variants = {}
+				if locale = options[:locale]
+					locales = {}
 					
 					ordered.each do |link|
-						if link.variant == variant
-							variants[link.name] = link
-						elsif link.variant == nil
-							variants[link.name] ||= link
+						if link.locale == locale
+							locales[link.name] = link
+						elsif link.locale == nil
+							locales[link.name] ||= link
 						end
 					end
 					
-					ordered = variants.values
+					ordered = locales.values
 				end
 				
 				# Sort:
@@ -115,18 +115,18 @@ module Utopia
 			attr :ordered
 			attr :named
 			
-			def each(variant)
-				return to_enum(:each, variant) unless block_given?
+			def each(locale)
+				return to_enum(:each, locale) unless block_given?
 				
 				ordered.each do |links|
-					yield links.find{|link| link.variant == variant}
+					yield links.find{|link| link.locale == locale}
 				end
 			end
 			
-			def lookup(name, variant = nil)
-				# This allows generic links to serve any variant requested.
+			def lookup(name, locale = nil)
+				# This allows generic links to serve any locale requested.
 				if links = @named[name]
-					links.find{|link| link.variant == variant} || links.find{|link| link.variant == nil}
+					links.find{|link| link.locale == locale} || links.find{|link| link.locale == nil}
 				end
 			end
 			
@@ -145,7 +145,7 @@ module Utopia
 				links_path = File.join(path, LINKS_YAML)
 				
 				hash = if File.exist?(links_path)
-					YAML::load(File.read(links_path)) || {}
+					YAML::load_file(links_path) || {}
 				else
 					{}
 				end
@@ -171,9 +171,10 @@ module Utopia
 					directory_link = Link.new(:directory, @top + [name, index_name], index_metadata)
 					
 					# Merge metadata from foo.en into foo/index.en
-					if directory_link.variant
-						if variant_metadata = metadata.delete(directory_link.name + '.' + directory_link.variant)
-							directory_link.info.update(variant_metadata)
+					if directory_link.locale
+						localized_key = "#{directory_link.name}.#{directory_link.locale}"
+						if localized_metadata = metadata.delete(localized_key)
+							directory_link.info.update(localized_metadata)
 						end
 					end
 					

data/lib/utopia/content/transaction.rb

@@ -18,7 +18,6 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-require_relative 'processor'
 require_relative 'links'
 
 module Utopia
@@ -152,6 +151,10 @@ module Utopia
 				return current.attributes
 			end
 
+			def localization
+				@localization ||= Utopia::Localization[request]
+			end
+
 			def current
 				@begin_tags[-1]
 			end

data/lib/utopia/controller.rb

@@ -45,7 +45,6 @@ module Utopia
 	
 	class Controller
 		CONTROLLER_RB = 'controller.rb'.freeze
-		PATH_INFO_KEY = 'PATH_INFO'.freeze
 		
 		def initialize(app, **options)
 			@app = app
@@ -119,7 +118,7 @@ module Utopia
 			end
 			
 			# The controllers may have rewriten the path so we update the path info:
-			request.env[PATH_INFO_KEY] = controller_path.to_s
+			request.env[Rack::PATH_INFO] = controller_path.to_s
 			
 			# No controller gave a useful result:
 			return nil

data/lib/utopia/controller/base.rb

@@ -22,8 +22,6 @@ require_relative '../http'
 
 module Utopia
 	class Controller
-		EMPTY_BODY = [].freeze
-		
 		class Base
 			def self.base_path
 				self.const_get(:BASE_PATH)
@@ -75,13 +73,9 @@ module Utopia
 			end
 			
 			def catch_response
-				response = catch(:response) do
+				catch(:response) do
 					yield and nil
 				end
-				
-				if response
-					return self.respond_with(*response)
-				end
 			end
 			
 			# Given a request, call associated actions if at least one exists.
@@ -106,69 +100,65 @@ module Utopia
 				end
 			end
 
+			# Call into the next app as defined by rack.
 			def call(env)
 				self.class.controller.app.call(env)
 			end
-
-			def respond!(*args)
-				throw :response, args
+			
+			# This will cause the middleware to generate a response.
+			def respond!(response)
+				throw :response, response
 			end
 
+				# This will cause the controller middleware to pass on the request.
 			def ignore!
 				throw :response, nil
 			end
 
+			# Request relative redirect. Respond with a redirect to the given target.
 			def redirect! (target, status = 302)
-				respond! :redirect => target, :status => status
+				status = HTTP::Status.new(status, 300...400)
+				location = target.to_s
+				
+				respond! [status.to_i, {HTTP::LOCATION => location}, [status.to_s]]
 			end
-
-			def fail!(error = :bad_request)
-				respond! error
+			
+			# Controller relative redirect.
+			def goto!(target, status = 302)
+				redirect! self.class.uri_path + target
 			end
-
-			def success!(*args)
-				respond! :success, *args
+			
+			# Respond with an error which indiciates some kind of failure.
+			def fail!(error = 400, message = nil)
+				status = HTTP::Status.new(error, 400...600)
+				
+				message ||= status.to_s
+				respond! [status.to_i, {}, [message]]
 			end
 			
-			def respond_with(*args)
-				return args[0] if args[0] == nil || Array === args[0]
-
-				status = 200
-				options = nil
-
-				if Numeric === args[0] || Symbol === args[0]
-					status = args[0]
-					options = args[1] || {}
-				else
-					options = args[0]
-					status = options[:status] || status
-				end
-
-				status = HTTP::STATUS_CODES[status] || status
-				headers = options[:headers] || {}
-
-				if type = options[:type]
-					headers[HTTP::CONTENT_TYPE] ||= type
-				end
-
-				if redirect = options[:redirect]
-					headers[HTTP::LOCATION] = redirect.to_s
-					status = 302 if status < 300 || status >= 400
+			def succeed!(status: 200, headers: {}, **options)
+				status = HTTP::Status.new(status, 200...300)
+				
+				if options[:type]
+					headers[Rack::CONTENT_TYPE] = options[:type].to_s
 				end
-
-				if options[:body]
-					body = options[:body]
-				elsif options[:content]
-					body = [options[:content]]
-				elsif status >= 300
-					body = [HTTP::STATUS_DESCRIPTIONS[status] || "Status #{status}"]
-				else
-					body = EMPTY_BODY
+				
+				body = body_for(status, headers, options)
+				respond! [status.to_i, headers, body || []]
+			end
+			
+			# Generate the body for the given status, headers and options.
+			def body_for(status, headers, options)
+				if body = options[:body]
+					return body
+				elsif content = options[:content]
+					return [content]
 				end
-
-				return [status, headers, body]
 			end
 			
+			# Legacy method name:
+			alias success! succeed!
+			
 			# Return nil if this controller didn't do anything. Request will keep on processing. Return a valid rack response if the controller can do so.
 			def process!(request, path)
 				passthrough(request, path)

data/lib/utopia/exception_handler.rb

@@ -35,7 +35,7 @@ module Utopia
 
 			body.puts "<!DOCTYPE html><html><head><title>Fatal Error</title></head><body>"
 			body.puts "<h1>Fatal Error</h1>"
-			body.puts "<p>While requesting resource #{Trenni::Strings::to_html env['PATH_INFO']}, a fatal error occurred.</p>"
+			body.puts "<p>While requesting resource #{Trenni::Strings::to_html env[Rack::PATH_INFO]}, a fatal error occurred.</p>"
 			body.puts "<blockquote><strong>#{Trenni::Strings::to_html exception.class.name}</strong>: #{Trenni::Strings::to_html exception.to_s}</blockquote>"
 			body.puts "<p>There is nothing more we can do to fix the problem at this point.</p>"
 			body.puts "<p>We apologize for the inconvenience.</p>"
@@ -46,7 +46,7 @@ module Utopia
 		end
 
 		def redirect(env, exception)
-			response = @app.call(env.merge('PATH_INFO' => @location, 'REQUEST_METHOD' => 'GET'))
+			response = @app.call(env.merge(Rack::PATH_INFO => @location, Rack::REQUEST_METHOD => Rack::GET))
 			
 			return [500, response[1], response[2]]
 		end
@@ -65,7 +65,7 @@ module Utopia
 				end
 				
 				# If the error occurred while accessing the error handler, we finish with a fatal error:
-				if env['PATH_INFO'] == @location
+				if env[Rack::PATH_INFO] == @location
 					return fatal_error(env, exception)
 				else
 					# If redirection fails, we also finish with a fatal error:

data/lib/utopia/extensions/rack.rb

@@ -21,9 +21,9 @@
 require 'rack'
 
 module Rack
-	unless defined? EXPIRES
-		EXPIRES = 'Expires'.freeze
-	end
+	# Compatibility with older versions of rack:
+	EXPIRES = 'Expires'.freeze unless defined? EXPIRES
+	HTTP_HOST = 'HTTP_HOST'.freeze unless defined? HTTP_HOST
 	
 	class Response
 		# Specifies that the content shouldn't be cached. Overrides `cache!` if already called.
@@ -33,16 +33,24 @@ module Rack
 		end
 
 		# Specify that the content should be cached.
-		def cache!(duration = 3600)
+		def cache!(duration = 3600, access = "public")
 			unless headers[CACHE_CONTROL] =~ /no-cache/
-				headers[CACHE_CONTROL] = "public, max-age=#{duration}"
+				headers[CACHE_CONTROL] = "#{access}, max-age=#{duration}"
 				headers[EXPIRES] = (Time.now + duration).httpdate
 			end
 		end
 
 		# Specify the content type of the response data.
 		def content_type!(value)
-			headers[CONTENT_TYPE] = value.to_s
+			self.content_type = value
+		end
+		
+		def content_type= value
+			headers[CONTENT_TYPE] = value
+		end
+		
+		def content_type
+			headers[CONTENT_TYPE]
 		end
 	end
 end

data/lib/utopia/http.rb

@@ -35,6 +35,7 @@ module Utopia
 			:unauthorized => 401,
 			:forbidden => 403,
 			:not_found => 404,
+			:not_allowed => 405,
 			:unsupported_method => 405,
 			:gone => 410,
 			:teapot => 418,
@@ -42,13 +43,34 @@ module Utopia
 			:unimplemented => 501,
 			:unavailable => 503
 		}
-	
+		
+		# For a more detailed description see https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
 		STATUS_DESCRIPTIONS = {
+			200 => 'OK'.freeze,
+			201 => 'Created'.freeze,
+			202 => 'Accepted'.freeze,
+			203 => 'Non-Authoritive Information'.freeze,
+			204 => 'No Content'.freeze,
+			205 => 'Reset Content'.freeze,
+			206 => 'Partial Content'.freeze,
+			300 => 'Multiple Choices'.freeze,
+			301 => 'Moved Permanently'.freeze,
+			302 => 'Found'.freeze,
+			303 => 'See Other'.freeze,
+			304 => 'Not Modified'.freeze,
+			305 => 'Use Proxy'.freeze,
+			307 => 'Temporary Redirect'.freeze,
+			308 => 'Permanent Redirect'.freeze,
 			400 => 'Bad Request'.freeze,
 			401 => 'Permission Denied'.freeze,
+			402 => 'Payment Required'.freeze,
 			403 => 'Access Forbidden'.freeze,
 			404 => 'Resource Not Found'.freeze,
 			405 => 'Unsupported Method'.freeze,
+			406 => 'Not Acceptable'.freeze,
+			408 => 'Request Timeout'.freeze,
+			409 => 'Request Conflict'.freeze,
+			410 => 'Resource Removed'.freeze,
 			416 => 'Byte range unsatisfiable'.freeze,
 			500 => 'Internal Server Error'.freeze,
 			501 => 'Not Implemented'.freeze,
@@ -57,5 +79,32 @@ module Utopia
 		
 		CONTENT_TYPE = 'Content-Type'.freeze
 		LOCATION = 'Location'.freeze
+		
+		class Status
+			def initialize(code, valid_range = 100...600)
+				if code.is_a? Symbol
+					code = STATUS_CODES[code]
+				end
+				
+				unless 100...600
+					raise ArgumentError.new("Status must be in range #{valid_range}, was given #{code}!")
+				end
+				
+				@code = code
+			end
+			
+			def to_i
+				@code
+			end
+			
+			def to_s
+				STATUS_DESCRIPTIONS[@code] || @code.to_s
+			end
+			
+			# Allow to be used for rack body:
+			def each
+				yield to_s
+			end
+		end
 	end
 end

data/lib/utopia/locale.rb

@@ -0,0 +1,43 @@
+# Copyright, 2015, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+module Utopia
+	class Locale < Struct.new(:language, :country, :variant)
+		def to_s
+			to_a.compact.join('-')
+		end
+		
+		def self.dump(instance)
+			if instance
+				instance.to_s
+			end
+		end
+		
+		def self.load(instance)
+			if instance.is_a? String
+				self.new(*instance.split('-', 3))
+			elsif instance.is_a? Array
+				return self.new(*instance)
+			elsif instance.is_a? self
+				return instance
+			end
+		end
+	end
+end

data/lib/utopia/localization.rb

@@ -20,64 +20,125 @@
 
 require_relative 'middleware'
 
-module Rack
-	class Request
-		def current_locale
-			env[Utopia::Localization::CURRENT_LOCALE_KEY]
-		end
-		
-		def default_locale
-			localization.default_locale
+module Utopia
+	# If you request a URL which has localized content, a localized redirect would be returned based on the content requested.
+	class Localization
+		# A wrapper to provide easy access to locale related data in the request.
+		class RequestWrapper
+			def initialize(request)
+				if request.is_a? Rack::Request
+					@env = request.env
+				else
+					@env = request
+				end
+			end
+			
+			def localization
+				@env[LOCALIZATION_KEY]
+			end
+			
+			# Returns the current locale or nil if not localized.
+			def current_locale
+				@env[CURRENT_LOCALE_KEY]
+			end
+			
+			# Returns the default locale or nil if not localized.
+			def default_locale
+				localization && localization.default_locale
+			end
+			
+			# Returns an empty array if not localized.
+			def all_locales
+				localization && localization.all_locales || []
+			end
 		end
 		
-		def all_locales
-			localization.all_locales
+		def self.[] request
+			RequestWrapper.new(request)
 		end
 		
-		def localization
-			env[Utopia::Localization::LOCALIZATION_KEY]
-		end
-	end
-end
-
-module Utopia
-	# If you request a URL which has localized content, a localized redirect would be returned based on the content requested.
-	class Localization
 		RESOURCE_NOT_FOUND = [400, {}, []].freeze
 		
 		HTTP_ACCEPT_LANGUAGE = 'HTTP_ACCEPT_LANGUAGE'.freeze
 		LOCALIZATION_KEY = 'utopia.localization'.freeze
 		CURRENT_LOCALE_KEY = 'utopia.localization.current_locale'.freeze
 		
+		DEFAULT_LOCALE = 'en'
+		
 		def initialize(app, **options)
 			@app = app
-
-			@default_locale = options[:default_locale] || "en"
-			@all_locales = options[:locales] || ["en"]
+			
+			@all_locales = options[:locales]
+			
+			# Locales here are represented as an array of strings, e.g. ['en', 'ja', 'cn', 'de'].
+			unless @default_locales = options[:default_locales] 
+				@default_locales = @all_locales + [nil]
+			end
+			
+			if @default_locale = options[:default_locale]
+				@default_locales.unshift(default_locale)
+			else
+				@default_locale = @default_locales.first
+			end
+			
+			@hosts = options[:hosts] || {}
 			
 			@nonlocalized = options.fetch(:nonlocalized, [])
+			
+			# puts "All:#{@all_locales.inspect} defaults:#{@default_locales.inspect} default:#{default_locale}"
 		end
 
 		attr :all_locales
 		attr :default_locale
 		
 		def preferred_locales(env)
-			request_preferred_locales(env) | browser_preferred_locales(env) | [@default_locale, nil]
+			return to_enum(:preferred_locales, env) unless block_given?
+			
+			# Keep track of what locales have been tried:
+			locales = Set.new
+			
+			host_preferred_locales(env).each do |locale|
+				yield env.merge(CURRENT_LOCALE_KEY => locale) if locales.add? locale
+			end
+			
+			request_preferred_locale(env) do |locale, path|
+				# We have extracted a locale from the path, so from this point on we should use the updated path:
+				env = env.merge(Rack::PATH_INFO => path.to_s)
+				
+				yield env.merge(CURRENT_LOCALE_KEY => locale) if locales.add? locale
+			end
+			
+			browser_preferred_locales(env).each do |locale|
+				yield env.merge(CURRENT_LOCALE_KEY => locale) if locales.add? locale
+			end
+			
+			@default_locales.each do |locale|
+				yield env.merge(CURRENT_LOCALE_KEY => locale) if locales.add? locale
+			end
+		end
+		
+		def host_preferred_locales(env)
+			http_host = env[Rack::HTTP_HOST]
+			
+			locales = []
+			
+			# Get a list of all hosts which match the incoming htt_host:
+			matching_hosts = @hosts.select{|host_pattern, locale| http_host =~ host_pattern}
+			
+			# Extract all the valid locales:
+			matching_hosts.flat_map{|host_pattern, locale| locale}
 		end
 		
-		def request_preferred_locales(env)
-			path = Path[env['PATH_INFO']]
+		def request_preferred_locale(env)
+			path = Path[env[Rack::PATH_INFO]]
 			
-			if all_locales.include? path.first
+			if @all_locales.include? path.first
 				request_locale = path.first
 				
-				# Remove the localization prefix.
+				# Remove the localization prefix:
 				path.delete_at(0)
-				env['PATH_INFO'] = path.to_s
 				
-				return [request_locale]
-			else
-				return []
+				yield request_locale, path
 			end
 		end
 		
@@ -86,17 +147,17 @@ module Utopia
 			
 			# No user prefered languages:
 			return [] unless accept_languages
-
+			
 			languages = accept_languages.split(',').map { |language|
 				language.split(';q=').tap{|x| x[1] = (x[1] || 1.0).to_f}
 			}.sort{|a, b| b[1] <=> a[1]}.collect(&:first)
 			
-			# Returns languages based on the order of the first argument
+			# Returns available languages based on the order of the first argument:
 			return languages & @all_locales
 		end
 		
 		def nonlocalized?(env)
-			path_info = env['PATH_INFO']
+			path_info = env[Rack::PATH_INFO]
 			
 			@nonlocalized.any? { |pattern| path_info[pattern] != nil }
 		end
@@ -115,13 +176,14 @@ module Utopia
 			# Althought this header is generally not supported, we supply it anyway as it is useful for debugging:
 			if locale = env[CURRENT_LOCALE_KEY]
 				# Set the Content-Location to point to the localized URI as requested:
-				headers['Content-Location'] = "/#{locale}" + env['PATH_INFO']
+				headers['Content-Location'] = "/#{locale}" + env[Rack::PATH_INFO]
 			end
 			
 			return response
 		end
 		
 		def call(env)
+			# Pass the request through with no localization if it is a nonlocalized path:
 			return @app.call(env) if nonlocalized?(env)
 			
 			env[LOCALIZATION_KEY] = self
@@ -129,8 +191,8 @@ module Utopia
 			response = nil
 			
 			# We have a non-localized request, but there might be a localized resource. We return the best localization possible:
-			preferred_locales(env).each do |locale|
-				env[CURRENT_LOCALE_KEY] = locale
+			preferred_locales(env) do |env|
+				# puts "Trying locale: #{env[CURRENT_LOCALE_KEY]}: #{env[Rack::PATH_INFO]}..."
 				
 				response = @app.call(env)
 				

data/lib/utopia/path.rb

@@ -52,7 +52,7 @@ module Utopia
 			@parts ||= @name.split('.')
 		end
 		
-		def variant
+		def locale
 			parts.last if parts.size > 1
 		end
 		
@@ -322,10 +322,10 @@ module Utopia
 		def == other
 			return false unless other
 			
-			if other.is_a? String
-				self.to_s == other
-			else
-				self.to_a == other.to_a
+			case other
+			when String then self.to_s == other
+			when Array then self.to_a == other
+			else other.is_a?(self.class) && @components == other.components
 			end
 		end
 		

data/lib/utopia/redirector.rb

@@ -117,7 +117,7 @@ module Utopia
 		end
 
 		def call(env)
-			base_path = env['PATH_INFO']
+			base_path = env[Rack::PATH_INFO]
 
 			if uri = @strings[base_path]
 				return redirect(@strings[base_path], base_path)
@@ -134,11 +134,11 @@ module Utopia
 			response = @app.call(env)
 
 			if @errors && response[0] >= 400 && uri = @errors[response[0]]
-				error_request = env.merge("PATH_INFO" => uri, "REQUEST_METHOD" => "GET")
+				error_request = env.merge(Rack::PATH_INFO => uri, Rack::REQUEST_METHOD => Rack::GET)
 				error_response = @app.call(error_request)
 
 				if error_response[0] >= 400
-					raise FailedRequestError.new(env['PATH_INFO'], response[0], uri, error_response[0])
+					raise FailedRequestError.new(env[Rack::PATH_INFO], response[0], uri, error_response[0])
 				else
 					# Feed the error code back with the error document
 					error_response[0] = response[0]

data/lib/utopia/session.rb

@@ -20,6 +20,6 @@
 
 module Utopia
 	module Session
-		RACK_SESSION = "rack.session"
+		RACK_SESSION = "rack.session".freeze
 	end
 end

data/lib/utopia/static.rb

@@ -221,7 +221,7 @@ module Utopia
 		attr :extensions
 
 		def call(env)
-			path_info = env['PATH_INFO']
+			path_info = env[Rack::PATH_INFO]
 			extension = File.extname(path_info)
 
 			if @extensions.key? extension.downcase

data/lib/utopia/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Utopia
-	VERSION = "1.1.4"
+	VERSION = "1.2.0"
 end

data/setup/site/pages/_page.xnode

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
 	<head>
-		<?r response.content_type! "text/html; charset=utf-8" ?>
+		<?r response.content_type = "text/html; charset=utf-8" ?>
 		<?r response.cache! ?>
 		
 		<?r if title = (attributes["title"] || @title) ?>

data/spec/utopia/content/links_spec.rb

@@ -60,7 +60,7 @@ module Utopia::Content::LinksSpec
 			links = Utopia::Content::Links.index(root, Utopia::Path.create("/foo"))
 			expect(links.size).to be == 2
 			
-			links = Utopia::Content::Links.index(root, Utopia::Path.create("/foo"), variant: 'en')
+			links = Utopia::Content::Links.index(root, Utopia::Path.create("/foo"), locale: 'en')
 			expect(links.size).to be == 1
 		end
 		
@@ -68,7 +68,7 @@ module Utopia::Content::LinksSpec
 			root = File.expand_path("localized", __dir__)
 			
 			# Select both test links
-			links = Utopia::Content::Links.index(root, Utopia::Path.create("/"), variant: 'en')
+			links = Utopia::Content::Links.index(root, Utopia::Path.create("/"), locale: 'en')
 			
 			expect(links.collect(&:title)).to be == ['One', 'Two', 'Three', 'Four', 'Five']
 		end
@@ -77,7 +77,7 @@ module Utopia::Content::LinksSpec
 			root = File.expand_path("localized", __dir__)
 			
 			# Select both test links
-			links = Utopia::Content::Links.index(root, Utopia::Path.create("/"), variant: 'zh')
+			links = Utopia::Content::Links.index(root, Utopia::Path.create("/"), locale: 'zh')
 			
 			expect(links.collect(&:title)).to be == ['One', 'Two', 'Three', '四']
 		end

data/spec/utopia/content/node_spec.rb

@@ -52,10 +52,10 @@ module Utopia::ContentSpec
 			
 			expect(links.size).to be == 2
 			expect(links[0].name).to be == 'foo'
-			expect(links[0].variant).to be == 'en'
+			expect(links[0].locale).to be == 'en'
 			
 			expect(links[1].name).to be == 'foo'
-			expect(links[1].variant).to be == 'ja'
+			expect(links[1].locale).to be == 'ja'
 		end
 	end
 end

data/spec/utopia/locale_spec.rb

@@ -0,0 +1,48 @@
+#!/usr/bin/env rspec
+# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'utopia/locale'
+
+module Utopia::LocaleSpec
+	describe Utopia::Locale do
+		it "should load from string" do
+			locale = Utopia::Locale.load('en-US')
+			
+			expect(locale.language).to be == 'en'
+			expect(locale.country).to be == 'US'
+			expect(locale.variant).to be == nil
+		end
+		
+		it "should load from nil and return nil" do
+			expect(Utopia::Locale.load(nil)).to be == nil
+		end
+		
+		it "should dump nil and give nil" do
+			expect(Utopia::Locale.dump(nil)).to be == nil
+		end
+		
+		it "should dump locale and give string" do
+			locale = Utopia::Locale.new('en', 'US')
+			
+			expect(Utopia::Locale.dump(locale)).to be == 'en-US'
+		end
+	end
+end

data/spec/utopia/localization_spec.rb

@@ -24,6 +24,7 @@ require 'rack/test'
 
 require 'utopia/static'
 require 'utopia/content'
+require 'utopia/controller'
 require 'utopia/localization'
 
 module Utopia::StaticSpec
@@ -38,21 +39,52 @@ module Utopia::StaticSpec
 			expect(last_response.body).to be == 'localized.en.txt'
 		end
 		
-		it "should respond with the requested localization" do
+		it "should localize request based on path" do
 			get '/en/localized.txt'
 			expect(last_response.body).to be == 'localized.en.txt'
-
+			
 			get '/de/localized.txt'
 			expect(last_response.body).to be == 'localized.de.txt'
-
-			get '/jp/localized.txt'
-			expect(last_response.body).to be == 'localized.jp.txt'
+			
+			get '/ja/localized.txt'
+			expect(last_response.body).to be == 'localized.ja.txt'
+		end
+		
+		it "should localize request based on domain name" do
+			get '/localized.txt', {}, 'HTTP_HOST' => 'foobar.com'
+			expect(last_response.body).to be == 'localized.en.txt'
+			
+			get '/localized.txt', {}, 'HTTP_HOST' => 'foobar.de'
+			expect(last_response.body).to be == 'localized.de.txt'
+			
+			get '/localized.txt', {}, 'HTTP_HOST' => 'foobar.co.jp'
+			expect(last_response.body).to be == 'localized.ja.txt'
+		end
+		
+		it "should get a non-localized resource" do
+			get "/en/test.txt"
+			expect(last_response.body).to be == 'Hello World!'
 		end
 		
 		it "should respond with accepted language localization" do
-			get '/localized.txt', {}, 'HTTP_ACCEPT_LANGUAGE' => 'jp,en'
+			get '/localized.txt', {}, 'HTTP_ACCEPT_LANGUAGE' => 'ja,en'
 			
-			expect(last_response.body).to be == 'localized.jp.txt'
+			expect(last_response.body).to be == 'localized.ja.txt'
+		end
+		
+		it "should get a list of all localizations" do
+			get '/all_locales'
+			expect(last_response.body).to be == 'en,ja,de'
+		end
+		
+		it "should get the default locale" do
+			get '/default_locale'
+			expect(last_response.body).to be == 'en'
+		end
+		
+		it "should get the current locale (german)" do
+			get '/current_locale', {}, 'HTTP_HOST' => 'foobar.de'
+			expect(last_response.body).to be == 'de'
 		end
 	end
 end

data/spec/utopia/localization_spec.ru

@@ -1,11 +1,14 @@
 
+localization_spec_root = File.expand_path('localization_spec', __dir__)
+
 use Utopia::Localization,
-	locales: ['en', 'jp', 'de']
+	locales: ['en', 'ja', 'de'],
+	hosts: {/foobar\.com$/ => 'en', /foobar\.co\.jp$/ => 'ja', /foobar\.de$/ => 'de'}
 
-use Utopia::Static,
-	root: File.expand_path('../pages', __FILE__)
+use Utopia::Controller,
+	root: localization_spec_root
 
-use Utopia::Content,
-	root: File.expand_path('../pages', __FILE__)
+use Utopia::Static,
+	root: localization_spec_root
 
 run lambda { |env| [404, {}, []] }

data/spec/utopia/localization_spec/controller.rb

@@ -0,0 +1,18 @@
+
+on 'all_locales' do |request, path|
+	wrapper = Utopia::Localization[request]
+	
+	succeed! content: wrapper.all_locales.join(',')
+end
+
+on 'default_locale' do |request, path|
+	wrapper = Utopia::Localization[request]
+	
+	succeed! content: wrapper.default_locale
+end
+
+on 'current_locale' do |request, path|
+	wrapper = Utopia::Localization[request]
+	
+	succeed! content: wrapper.current_locale
+end

data/spec/utopia/localization_spec/localized.ja.txt

@@ -0,0 +1 @@
+localized.ja.txt

data/spec/utopia/localization_spec/test.txt

@@ -0,0 +1 @@
+Hello World!

data/spec/utopia/path_spec.rb

@@ -102,16 +102,16 @@ module Utopia::PathSpec
 			expect{path[0] = 'bob'}.to raise_exception(RuntimeError)
 		end
 		
-		it "should give the correct variant" do
+		it "should give the correct locale" do
 			path = Utopia::Path["foo.en"]
 			
-			expect(path.basename.variant).to be == 'en'
+			expect(path.basename.locale).to be == 'en'
 		end
 		
-		it "should give no variant" do
+		it "should give no locale" do
 			path = Utopia::Path["foo"]
 			
-			expect(path.basename.variant).to be == nil
+			expect(path.basename.locale).to be == nil
 		end
 		
 		it "should expand relative paths" do

data/spec/utopia/session_spec.ru

@@ -4,15 +4,15 @@ use Utopia::Session::EncryptedCookie, secret: "97111cabf4c1a5e85b8029cf7c61aa444
 run lambda { |env|
 	request = Rack::Request.new(env)
 	
-	if env['PATH_INFO'] =~ /login/
+	if env[Rack::PATH_INFO] =~ /login/
 		env['rack.session']['login'] = 'true'
 		
 		[200, {}, []]
-	elsif env['PATH_INFO'] =~ /session-set/
+	elsif env[Rack::PATH_INFO] =~ /session-set/
 		env['rack.session'][request[:key]] = request[:value]
 		
 		[200, {}, []]
-	elsif env['PATH_INFO'] =~ /session-get/
+	elsif env[Rack::PATH_INFO] =~ /session-get/
 		[200, {}, [env['rack.session'][request[:key]]]]
 	else
 		[404, {}, []]

data/utopia.gemspec

@@ -4,10 +4,10 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'utopia/version'
 
 Gem::Specification.new do |spec|
-	spec.name          = "utopia"
+	spec.name          = 'utopia'
 	spec.version       = Utopia::VERSION
-	spec.authors       = ["Samuel Williams"]
-	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
+	spec.authors       = ['Samuel Williams']
+	spec.email         = ['samuel.williams@oriontransfer.co.nz']
 	spec.description   = <<-EOF
 		Utopia is a website generation framework which provides a robust set of tools
 		to build highly complex dynamic websites. It uses the filesystem heavily for
@@ -15,25 +15,27 @@ Gem::Specification.new do |spec|
 		structure representing the website.
 	EOF
 	spec.summary       = %q{Utopia is a framework for building dynamic content-driven websites.}
-	spec.homepage      = "https://github.com/ioquatix/utopia"
+	spec.homepage      = 'https://github.com/ioquatix/utopia'
 
 	spec.files         = `git ls-files`.split($/)
 	spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
 	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-	spec.require_paths = ["lib"]
+	spec.require_paths = ['lib']
 	
-	spec.add_dependency "trenni", "~> 1.4.1"
-	spec.add_dependency "mime-types", "~> 2.0"
+	spec.required_ruby_version = '~> 2.0'
 	
-	spec.add_dependency "rack", "~> 1.6"
-	spec.add_dependency "rack-cache", "~> 1.2.0"
+	spec.add_dependency 'trenni', '~> 1.4.1'
+	spec.add_dependency 'mime-types', '~> 2.0'
 	
-	spec.add_dependency "mail", "~> 2.6.1"
+	spec.add_dependency 'rack', '~> 1.6'
+	spec.add_dependency 'rack-cache', '~> 1.2.0'
 	
-	spec.add_dependency "concurrent-ruby", "~> 1.0.0"
+	spec.add_dependency 'mail', '~> 2.6.1'
 	
-	spec.add_development_dependency "bundler", "~> 1.3"
-	spec.add_development_dependency "rspec", "~> 3.1.0"
-	spec.add_development_dependency "puma"
-	spec.add_development_dependency "rake"
+	spec.add_dependency 'concurrent-ruby', '~> 1.0.0'
+	
+	spec.add_development_dependency 'bundler', '~> 1.3'
+	spec.add_development_dependency 'rspec', '~> 3.4.0'
+	spec.add_development_dependency 'puma'
+	spec.add_development_dependency 'rake'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: utopia
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-03 00:00:00.000000000 Z
+date: 2015-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trenni
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: puma
   requirement: !ruby/object:Gem::Requirement
@@ -187,6 +187,7 @@ files:
 - lib/utopia/extensions/date.rb
 - lib/utopia/extensions/rack.rb
 - lib/utopia/http.rb
+- lib/utopia/locale.rb
 - lib/utopia/localization.rb
 - lib/utopia/mail_exceptions.rb
 - lib/utopia/middleware.rb
@@ -263,17 +264,20 @@ files:
 - spec/utopia/exception_handler_spec.ru
 - spec/utopia/exception_handler_spec/controller.rb
 - spec/utopia/extensions_spec.rb
+- spec/utopia/locale_spec.rb
 - spec/utopia/localization_spec.rb
 - spec/utopia/localization_spec.ru
+- spec/utopia/localization_spec/controller.rb
+- spec/utopia/localization_spec/localized.de.txt
+- spec/utopia/localization_spec/localized.en.txt
+- spec/utopia/localization_spec/localized.ja.txt
+- spec/utopia/localization_spec/test.txt
 - spec/utopia/middleware_spec.rb
 - spec/utopia/pages/_heading.xnode
 - spec/utopia/pages/content/_show-value.xnode
 - spec/utopia/pages/content/links.yaml
 - spec/utopia/pages/content/test-partial.xnode
 - spec/utopia/pages/index.xnode
-- spec/utopia/pages/localized.de.txt
-- spec/utopia/pages/localized.en.txt
-- spec/utopia/pages/localized.jp.txt
 - spec/utopia/pages/node/index.xnode
 - spec/utopia/pages/test.txt
 - spec/utopia/path/matcher_spec.rb
@@ -293,9 +297,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -348,17 +352,20 @@ test_files:
 - spec/utopia/exception_handler_spec.ru
 - spec/utopia/exception_handler_spec/controller.rb
 - spec/utopia/extensions_spec.rb
+- spec/utopia/locale_spec.rb
 - spec/utopia/localization_spec.rb
 - spec/utopia/localization_spec.ru
+- spec/utopia/localization_spec/controller.rb
+- spec/utopia/localization_spec/localized.de.txt
+- spec/utopia/localization_spec/localized.en.txt
+- spec/utopia/localization_spec/localized.ja.txt
+- spec/utopia/localization_spec/test.txt
 - spec/utopia/middleware_spec.rb
 - spec/utopia/pages/_heading.xnode
 - spec/utopia/pages/content/_show-value.xnode
 - spec/utopia/pages/content/links.yaml
 - spec/utopia/pages/content/test-partial.xnode
 - spec/utopia/pages/index.xnode
-- spec/utopia/pages/localized.de.txt
-- spec/utopia/pages/localized.en.txt
-- spec/utopia/pages/localized.jp.txt
 - spec/utopia/pages/node/index.xnode
 - spec/utopia/pages/test.txt
 - spec/utopia/path/matcher_spec.rb

data/spec/utopia/pages/localized.jp.txt

@@ -1 +0,0 @@
-localized.jp.txt