utopia 1.0.11 → 1.1.0

data/lib/utopia/controller/rewrite.rb

@@ -0,0 +1,104 @@
+# 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_relative '../http'
+require_relative '../path/matcher'
+
+module Utopia
+	class Controller
+		class RewriteError < ArgumentError
+		end
+		
+		module Rewrite
+			def self.prepended(base)
+				base.extend(ClassMethods)
+			end
+			
+			class Rule
+				def initialize(arguments, block)
+					@arguments = arguments
+					@block = block
+				end
+				
+				attr :arguments
+				attr :block
+				
+				def apply_match_to_context(match_data, context)
+					match_data.names.each do |name|
+						context.instance_variable_set("@#{name}", match_data[name])
+					end
+				end
+			end
+			
+			class ExtractPrefixRule < Rule
+				def apply(context, request, path)
+					@matcher ||= Path::Matcher.new(@arguments)
+					
+					if match_data = @matcher.match(path)
+						apply_match_to_context(match_data, context)
+						
+						if @block
+							context.instance_exec(request, path, match_data, &@block)
+						end
+						
+						return match_data.post_match
+					else
+						return path
+					end
+				end
+			end
+			
+			class Rewriter
+				def initialize
+					@rules = []
+				end
+				
+				def extract_prefix(**arguments, &block)
+					@rules << ExtractPrefixRule.new(arguments, block)
+				end
+				
+				def apply(context, request, path)
+					@rules.each do |rule|
+						path = rule.apply(context, request, path)
+					end
+					
+					return path
+				end
+				
+				def invoke!(context, request, path)
+					path.components = apply(context, request, path).components
+				end
+			end
+			
+			module ClassMethods
+				def rewrite
+					@rewriter ||= Rewriter.new
+				end
+			end
+			
+			# Rewrite the path before processing the request if possible.
+			def passthrough(request, path)
+				self.class.rewrite.invoke!(self, request, path)
+				
+				super
+			end
+		end
+	end
+end

data/lib/utopia/exception_handler.rb

@@ -42,7 +42,7 @@ module Utopia
 			body.puts "</body></html>"
 			body.rewind
 
-			return [400, {"Content-Type" => "text/html"}, body]
+			return [400, {HTTP::CONTENT_TYPE => "text/html"}, body]
 		end
 
 		def redirect(env, exception)

data/lib/utopia/extensions/rack.rb

@@ -20,29 +20,29 @@
 
 require 'rack'
 
-class Rack::Request
-	def url_with_path(path = "")
-		base_url << path
-	end
-end
-
-class Rack::Response
-	# Specifies that the content shouldn't be cached. Overrides `cache!` if already called.
-	def do_not_cache!
-		self["Cache-Control"] = "no-cache, must-revalidate"
-		self["Expires"] = Time.now.httpdate
+module Rack
+	unless defined? EXPIRES
+		EXPIRES = 'Expires'.freeze
 	end
 	
-	# Specify that the content should be cached.
-	def cache!(duration = 3600)
-		unless (self["Cache-Control"] || "").match(/no-cache/)
-			self["Cache-Control"] = "public, max-age=#{duration}"
-			self["Expires"] = (Time.now + duration).httpdate
+	class Response
+		# Specifies that the content shouldn't be cached. Overrides `cache!` if already called.
+		def do_not_cache!
+			headers[CACHE_CONTROL] = "no-cache, must-revalidate"
+			headers[EXPIRES] = Time.now.httpdate
+		end
+
+		# Specify that the content should be cached.
+		def cache!(duration = 3600)
+			unless headers[CACHE_CONTROL] =~ /no-cache/
+				headers[CACHE_CONTROL] = "public, 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
 		end
-	end
-	
-	# Specify the content type of the response data.
-	def content_type!(value)
-		self["Content-Type"] = value.to_s
 	end
 end

data/lib/utopia/http.rb

@@ -18,6 +18,8 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'rack'
+
 module Utopia
 	module HTTP
 		STATUS_CODES = {
@@ -42,15 +44,18 @@ module Utopia
 		}
 	
 		STATUS_DESCRIPTIONS = {
-			400 => "Bad Request",
-			401 => "Permission Denied",
-			403 => "Access Forbidden",
-			404 => "Resource Not Found",
-			405 => "Unsupported Method",
-			416 => "Byte range unsatisfiable",
-			500 => "Internal Server Error",
-			501 => "Not Implemented",
-			503 => "Service Unavailable"
+			400 => 'Bad Request'.freeze,
+			401 => 'Permission Denied'.freeze,
+			403 => 'Access Forbidden'.freeze,
+			404 => 'Resource Not Found'.freeze,
+			405 => 'Unsupported Method'.freeze,
+			416 => 'Byte range unsatisfiable'.freeze,
+			500 => 'Internal Server Error'.freeze,
+			501 => 'Not Implemented'.freeze,
+			503 => 'Service Unavailable'.freeze
 		}
+		
+		CONTENT_TYPE = 'Content-Type'.freeze
+		LOCATION = 'Location'.freeze
 	end
 end

data/lib/utopia/localization.rb

@@ -49,7 +49,7 @@ module Utopia
 		LOCALIZATION_KEY = 'utopia.localization'.freeze
 		CURRENT_LOCALE_KEY = 'utopia.localization.current_locale'.freeze
 		
-		def initialize(app, options = {})
+		def initialize(app, **options)
 			@app = app
 
 			@default_locale = options[:default_locale] || "en"

data/lib/utopia/middleware.rb

@@ -30,6 +30,9 @@ module Utopia
 	
 	PAGES_PATH = 'pages'.freeze
 	
+	# This is used for shared controller variables which get consumed by the content middleware:
+	VARIABLES_KEY = 'utopia.variables'.freeze
+	
 	def self.default_root(subdirectory = PAGES_PATH, pwd = Dir.pwd)
 		File.expand_path(subdirectory, pwd)
 	end

data/lib/utopia/path.rb

@@ -66,14 +66,16 @@ module Utopia
 	end
 	
 	class Path
-		SEPARATOR = "/"
-
 		include Comparable
-
+		
+		SEPARATOR = '/'.freeze
+		
 		def initialize(components = [])
 			@components = components
 		end
 
+		attr :components, true
+
 		def freeze
 			@components.freeze
 			
@@ -103,6 +105,7 @@ module Utopia
 			self.class.shortest_path(self, root)
 		end
 
+		# Converts '+' into whitespace and hex encoded characters into their equivalent characters.
 		def self.unescape(string)
 			string.tr('+', ' ').gsub(/((?:%[0-9a-fA-F]{2})+)/n) {
 				[$1.delete('%')].pack('H*')
@@ -112,7 +115,32 @@ module Utopia
 		def self.[] path
 			self.create(path)
 		end
-
+		
+		# Expand a relative path relative to a root.
+		def self.expand(path, root)
+			case path
+			when Path
+				return path.expand(root)
+			when String
+				return path if path.start_with?('/')
+			end
+			
+			Path[path].expand(root)
+		end
+		
+		def self.split(path)
+			case path
+			when Path
+				return path.to_a
+			when Array
+				return path
+			when String
+				create(path).to_a
+			else
+				[path]
+			end
+		end
+		
 		def self.create(path)
 			case path
 			when Path
@@ -121,39 +149,45 @@ module Utopia
 				return self.new(path)
 			when String
 				return self.new(unescape(path).split(SEPARATOR, -1))
-			when Symbol
+			else
 				return self.new([path])
 			end
 		end
 
-		attr :components
-
+		def include?(*args)
+			@components.include?(*args)
+		end
+		
 		def directory?
-			return @components.last == ""
+			return @components.last == ''
 		end
 
 		def to_directory
 			if directory?
 				return self
 			else
-				return join([""])
+				return join([''])
 			end
 		end
 
+		def relative?
+			@components.first != ''
+		end
+
 		def absolute?
-			return @components.first == ""
+			@components.first == ''
 		end
 
 		def to_absolute
 			if absolute?
 				return self
 			else
-				return self.class.new([""] + @components)
+				return self.class.new([''] + @components)
 			end
 		end
 
 		def to_str
-			if @components == [""]
+			if @components == ['']
 				SEPARATOR
 			else
 				@components.join(SEPARATOR)
@@ -163,6 +197,18 @@ module Utopia
 		def to_s
 			to_str
 		end
+		
+		def match(pattern)
+			to_str.match(pattern)
+		end
+		
+		def =~ (pattern)
+			to_str =~ pattern
+		end
+		
+		def to_a
+			@components
+		end
 
 		def join(other)
 			self.class.new(@components + other).simplify
@@ -186,6 +232,10 @@ module Utopia
 			end
 		end
 
+		def with_prefix(*args)
+			self.class.create(*args) + self
+		end
+
 		# Computes the difference of the path.
 		# /a/b/c - /a/b -> c
 		# a/b/c - a/b -> c
@@ -202,17 +252,17 @@ module Utopia
 		end
 
 		def simplify
-			result = absolute? ? [""] : []
+			result = absolute? ? [''] : []
 
 			@components.each do |bit|
 				if bit == ".."
 					result.pop
-				elsif bit != "." && bit != ""
+				elsif bit != "." && bit != ''
 					result << bit
 				end
 			end
 
-			result << "" if directory?
+			result << '' if directory?
 			
 			return self.class.new(result)
 		end
@@ -242,7 +292,7 @@ module Utopia
 				yield self.class.new(parent_path.dup)
 			end
 		end
-
+		
 		def ascend(&block)
 			return to_enum(:ascend) unless block_given?
 			
@@ -278,13 +328,23 @@ module Utopia
 		end
 
 		def eql? other
-			if self.class == other.class
-				return @components.eql?(other.components)
+			self.class.eql?(other.class) and @components.eql?(other.components)
+		end
+		
+		def hash
+			@components.hash
+		end
+		
+		def == other
+			return false unless other
+			
+			if other.is_a? String
+				self.to_s == other
 			else
-				return false
+				self.to_a == other.to_a
 			end
 		end
-
+		
 		def start_with? other
 			other.components.each_with_index do |part, index|
 				return false if @components[index] != part
@@ -293,10 +353,6 @@ module Utopia
 			return true
 		end
 		
-		def hash
-			@components.hash
-		end
-		
 		def [] index
 			return @components[component_offset(index)]
 		end
@@ -352,7 +408,7 @@ module Utopia
 		end
 	end
 	
-	def Path(path)
+	def self.Path(path)
 		Path.create(path)
 	end
 end

data/lib/utopia/path/matcher.rb

@@ -0,0 +1,94 @@
+# 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.
+
+require_relative '../path'
+
+module Utopia
+	class Path
+		class Matcher
+			class MatchData
+				def initialize(named_parts, post_match)
+					@named_parts = named_parts
+					@post_match = Path[post_match]
+				end
+				
+				attr :named_parts
+				attr :post_match
+				
+				def [] key
+					@named_parts[key]
+				end
+				
+				def names
+					@named_parts.keys
+				end
+			end
+			
+			# patterns = {key: /\d+/, 'foo', }
+			def initialize(patterns = [])
+				@patterns = patterns
+			end
+			
+			def self.[](patterns)
+				self.new(patterns)
+			end
+			
+			def coerce(klass, value)
+				if klass == Integer
+					Integer(value) rescue nil
+				elsif klass == Float
+					Float(value) rescue nil
+				elsif klass == String
+					value.to_s
+				else
+					klass.new(value)
+				end
+			end
+			
+			# This is a path prefix matching algorithm. The pattern is an array of String, Symbol, Regexp, or nil. The components is an array of String.
+			# As long as the components match the patterns, 
+			def match(path)
+				components = path.to_a
+				
+				return nil if components.size < @patterns.size
+				
+				named_parts = {}
+				
+				@patterns.each_with_index do |(key, matcher), index|
+					component = components[index]
+					
+					if matcher.is_a? Class
+						return nil unless value = coerce(matcher, component)
+						
+						named_parts[key] = value
+					elsif matcher
+						return nil unless matcher === component
+						
+						named_parts[key] = component
+					else
+						named_parts[key] = component
+					end
+				end
+				
+				return MatchData.new(named_parts, components[@patterns.size..-1])
+			end
+		end
+	end
+end