utopia 1.0.11 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb9c01f8a43932f752a9588dd957deb2afec170c
-  data.tar.gz: 85654a0ecc710fb663616fd7afda1a3da995790e
+  metadata.gz: 965466abaa777fe6b33b71c24253718da3544bd1
+  data.tar.gz: 1a53312d2f58949a2a6027292dd5d6a66e0c56ab
 SHA512:
-  metadata.gz: 5a1de4ccb2fa9a111cefce7ff9c19c065b8551e1cbf6bf8a919d7db6c38a31b5b5b8c4edd7fe23fce192aa17635a74f0c170749c9cb03b78c068c872bf1db8fa
-  data.tar.gz: 6aa5e5815944530c84c53d14929993036cc09b3f0d4911ed68c6a7dbf2a1db495ec3d4eccb43edd2e9632d5003a262b58cd6c11e379407b27d8b86af8ae4537e
+  metadata.gz: a24b35e08ccdbb23e1a85236e25b5166235a39d04d08fa2b5d8b5f00f9feb7ae07a43956bf6629ef4e2e98eaf00ac32b95638efa5b5e8df5cb7eb9d33a1fc002
+  data.tar.gz: 56ec05c1856d72c0bf9305f6c0ce821348c83f9d8c2d90a4cc3c53586755533b67c2b89fb1d50c7a4b0fa865e747b25d0d8b94d64983e23210717766325ddb81

data/.rspec

@@ -0,0 +1,2 @@
+--color 
+--format documentation 

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+sudo: false
 rvm:
   - "2.0"
   - "2.1"

data/bin/utopia

@@ -37,7 +37,7 @@ Rake::TaskManager.record_task_metadata = true
 verbose(false)
 
 module Setup
-	BASE = File.expand_path("../../setup", __FILE__)
+	BASE = File.expand_path("../setup", __dir__)
 	
 	module Site
 		CONFIGURATION_FILES = ['config.ru', 'Gemfile', 'Rakefile']

data/lib/utopia/content.rb

@@ -28,7 +28,9 @@ require 'trenni/template'
 
 module Utopia
 	class Content
-		def initialize(app, options = {})
+		INDEX = 'index'.freeze
+		
+		def initialize(app, **options)
 			@app = app
 
 			@root = File.expand_path(options[:root] || Utopia::default_root)
@@ -57,7 +59,7 @@ module Utopia
 				return @tags[name]
 			end
 			
-			if String === name && name.index("/")
+			if String === name && name.index('/')
 				name = Path.create(name)
 			end
 			
@@ -77,7 +79,7 @@ module Utopia
 				end
 
 				if String === name_path
-					tag_path = File.join(root, dir.components, "_" + name_path)
+					tag_path = File.join(root, dir.components, '_' + name_path)
 
 					if File.exist? tag_path
 						return Node.new(self, dir + name, parent_path + name, tag_path)
@@ -112,9 +114,9 @@ module Utopia
 
 			# If the request for /foo/bar{extensions} is actually a directory, rewrite it to /foo/bar/index{extensions}:
 			if File.directory? directory_path
-				index_path = [basename.name, basename.rename("index")]
+				index_path = [basename.name, basename.rename(INDEX)]
 				
-				return [307, {"Location" => path.dirname.join(index_path).to_s}, []]
+				return [307, {HTTP::LOCATION => path.dirname.join(index_path).to_s}, []]
 			end
 
 			locale = env[Localization::CURRENT_LOCALE_KEY]
@@ -122,17 +124,13 @@ module Utopia
 				if link.path and node = lookup_node(link.path)
 					response = Rack::Response.new
 					
-					attributes = nil
-					
-					if request.respond_to?(:controller)
-						attributes = request.controller
-					end
+					attributes = request.env.fetch(VARIABLES_KEY, {}).to_hash
 					
-					node.process!(request, response, (attributes || {}).to_hash)
+					node.process!(request, response, attributes)
 					
 					return response.finish
 				elsif redirect_uri = link[:uri]
-					return [307, {"Location" => redirect_uri}, []]
+					return [307, {HTTP::LOCATION => redirect_uri}, []]
 				end
 			end
 			

data/lib/utopia/content/link.rb

@@ -38,7 +38,7 @@ module Utopia
 					@name, @variant = path.last.split('.', 2)
 					@path = path
 				when :directory
-					# raise ArgumentError unless path.last.start_with? 'index'
+					# raise ArgumentError unless path.last.start_with? INDEX
 					
 					@name = path.dirname.last
 					@variant = path.last.split('.', 2)[1]
@@ -85,7 +85,7 @@ module Utopia
 				@info.fetch(:title, @title)
 			end
 
-			def to_href(options = {})
+			def to_href(**options)
 				Trenni::Builder.fragment(options[:builder]) do |builder|
 					if href?
 						relative_href(options[:base])
@@ -101,19 +101,16 @@ module Utopia
 				end
 			end
 			
+			def to_s
+				"\#<#{self.class}(#{self.kind}) title=#{title.inspect} href=#{href.inspect}>"
+			end
+			
 			def eql? other
-				if other && self.class == other.class
-					return kind.eql?(other.kind) && 
-					       name.eql?(other.name) && 
-					       path.eql?(other.path) && 
-					       info.eql?(other.info)
-				else
-					return false
-				end
+				self.class.eql?(other.class) and kind.eql?(other.kind) and name.eql?(other.name) and path.eql?(other.path) and info.eql?(other.info)
 			end
 
 			def == other
-				return other && kind == other.kind && name == other.name && path == other.path
+				other and kind == other.kind and name == other.name and path == other.path
 			end
 			
 			def default_locale?

data/lib/utopia/content/links.rb

@@ -41,7 +41,7 @@ module Utopia
 				:display => :display,
 			}
 			
-			def self.index(root, path, options = {})
+			def self.index(root, path, **options)
 				options = DEFAULT_INDEX_OPTIONS.merge(options)
 				
 				ordered = self.new(root, path, options).ordered

data/lib/utopia/content/node.rb

@@ -134,7 +134,7 @@ module Utopia
 			
 			# A helper method for accessing controller variables from view:
 			def controller
-				@request.controller
+				@request.env[VARIABLES_KEY]
 			end
 
 			def parse_xml(xml_data)
@@ -315,8 +315,9 @@ module Utopia
 				@controller.lookup_node(path)
 			end
 
-			def local_path(path = ".", base = nil)
-				path = Path.create(path)
+			def local_path(path = '.', base = nil)
+				path = Path[path]
+				
 				root = Pathname.new(@controller.root)
 				
 				if path.absolute?
@@ -342,8 +343,8 @@ module Utopia
 				uri_path.dirname
 			end
 
-			def links(path = ".", options = {}, &block)
-				path = uri_path.dirname + Path.create(path)
+			def links(path = '.', **options, &block)
+				path = uri_path.dirname + Path[path]
 				links = Links.index(@controller.root, path, options)
 				
 				if block_given?
@@ -361,14 +362,14 @@ module Utopia
 			def siblings_path
 				name = @uri_path.last.split('.', 2).first
 				
-				if name == "index"
+				if name == INDEX
 					@uri_path.dirname(2)
 				else
 					@uri_path.dirname
 				end
 			end
 
-			def sibling_links(options = {})
+			def sibling_links(**options)
 				return Links.index(@controller.root, siblings_path, options)
 			end
 

data/lib/utopia/controller.rb

@@ -20,25 +20,32 @@
 
 require_relative 'path'
 
+require_relative 'middleware'
 require_relative 'controller/variables'
 require_relative 'controller/action'
 require_relative 'controller/base'
 
-class Rack::Request
-	def controller(&block)
-		if block_given?
-			env["utopia.controller"].instance_eval(&block)
-		else
-			env["utopia.controller"]
-		end
-	end
-end
+require_relative 'controller/rewrite'
 
 module Utopia
+	module Controllers
+		def self.class_name_for_controller(controller)
+			controller.uri_path.to_a.collect{|_| _.capitalize}.join + "_#{controller.object_id}"
+		end
+		
+		def self.define(klass)
+			self.const_set(
+				class_name_for_controller(klass),
+				klass,
+			)
+		end
+	end
+	
 	class Controller
-		CONTROLLER_RB = "controller.rb".freeze
-
-		def initialize(app, options = {})
+		CONTROLLER_RB = 'controller.rb'.freeze
+		PATH_INFO_KEY = 'PATH_INFO'.freeze
+		
+		def initialize(app, **options)
 			@app = app
 			@root = options[:root] || Utopia::default_root
 
@@ -77,11 +84,10 @@ module Utopia
 				
 				klass.const_set(:CONTROLLER, self)
 				
-				$LOAD_PATH.unshift(base_path)
-				
 				klass.class_eval(File.read(controller_path), controller_path)
 				
-				$LOAD_PATH.delete(base_path)
+				# Give the controller a useful name:
+				# Controllers.define(klass)
 				
 				return klass.new
 			else
@@ -89,45 +95,40 @@ module Utopia
 			end
 		end
 		
-		def invoke_controllers(variables, request, done = Set.new)
-			path = Path.create(request.path_info)
+		def invoke_controllers(request)
+			relative_path = Path[request.path_info]
 			controller_path = Path.new
+			variables = request.env[VARIABLES_KEY]
 			
-			path.descend do |controller_path|
-				# puts "Invoke controller: #{controller_path}"
+			while relative_path.components.any?
+				controller_path.components << relative_path.components.shift
+				
 				if controller = lookup_controller(controller_path)
-					# We only want to invoke controllers which have not already been invoked:
-					unless done.include? controller
-						# If we get throw :rewrite, location, the URL has been rewritten and we need to request again:
-						location = catch(:rewrite) do
-							# Invoke the controller and if it returns a result, send it back out:
-							if result = controller.process!(request, path)
-								return result
-							end
-						end
-						
-						if location
-							# Rewrite relative paths based on the controller's URI:
-							request.env['PATH_INFO'] = Path[location].expand(controller.class.uri_path).to_s
-							
-							return invoke_controllers(variables, request, done)
-						end
-						
-						done << controller
+					# Don't modify the original controller:
+					controller = controller.clone
+					
+					# Append the controller to the set of controller variables, updates the controller with all current instance variables.
+					variables << controller
+					
+					if result = controller.process!(request, relative_path)
+						return result
 					end
 				end
 			end
 			
+			# The controllers may have rewriten the path so we update the path info:
+			request.env[PATH_INFO_KEY] = controller_path.to_s
+			
 			# No controller gave a useful result:
 			return nil
 		end
 		
 		def call(env)
-			variables = (env["utopia.controller"] ||= Variables.new)
+			variables = (env[VARIABLES_KEY] ||= Variables.new)
 			
 			request = Rack::Request.new(env)
 			
-			if result = invoke_controllers(variables, request)
+			if result = invoke_controllers(request)
 				return result
 			end
 			

data/lib/utopia/controller/action.rb

@@ -21,8 +21,7 @@
 module Utopia
 	class Controller
 		class Action < Hash
-			attr_accessor :callback
-			attr_accessor :options
+			attr_accessor :path, :callback, :options
 			
 			def callback?
 				@callback != nil
@@ -33,15 +32,15 @@ module Utopia
 			end
 			
 			def eql? other
-				super and self.callback.eql? other.callback and self.options.eql? other.options
+				super and @callback.eql? other.callback and @options.eql? other.options and @path.eql? other.path 
 			end
 			
 			def hash
-				[super, callback, options].hash
+				[super, callback, options, path].hash
 			end
 			
 			def == other
-				super and (self.callback == other.callback) and (self.options == other.options)
+				super and @callback == other.callback and @options == other.options and @path == other.path
 			end
 			
 			protected
@@ -76,28 +75,31 @@ module Utopia
 			# relative_path = 2014/mr-potato
 			# actions => {:** => A}
 			def select(relative_path)
-				actions = []
-				
-				append(relative_path.reverse, 0, actions)
-				
-				return actions
+				selection = [].tap do |actions|
+					append(relative_path.reverse, 0, actions)
+				end
 			end
 			
-			def define(path, options = {}, &callback)
+			def define(path, **options, &callback)
 				current = self
 				
 				path.reverse.each do |name|
 					current = (current[name.to_sym] ||= Action.new)
 				end
 				
+				current.path = path
 				current.options = options
 				current.callback = callback
 				
 				return current
 			end
 			
+			def arity
+				@callback ? @callback.arity : 0
+			end
+			
 			def invoke!(controller, *arguments)
-				controller.instance_exec(*arguments, &@callback)
+				controller.instance_exec(*arguments, self, &@callback)
 			end
 			
 			def inspect

data/lib/utopia/controller/base.rb

@@ -22,6 +22,8 @@ require_relative '../http'
 
 module Utopia
 	class Controller
+		EMPTY_BODY = [].freeze
+		
 		class Base
 			def self.base_path
 				self.const_get(:BASE_PATH)
@@ -36,55 +38,56 @@ module Utopia
 			end
 			
 			class << self
-				def require_local(path)
-					require File.join(base_path, path)
-				end
-				
 				def direct?(path)
 					path.dirname == uri_path
 				end
 				
+				def patterns
+					@patterns ||= []
+				end
+				
+				def match(pattern, &block)
+					patterns << [pattern, block]
+				end
+				
 				def actions
 					@actions ||= Action.new
 				end
 				
-				def on(path, options = {}, &block)
-					if Symbol === path
-						path = ['**', path]
+				def on(first, *path, **options, &block)
+					if first.is_a? Symbol
+						first = ['**', first]
 					end
 					
-					actions.define(Path.create(path).components, options, &block)
+					actions.define(Path.split(first) + path, options, &block)
 				end
 				
 				def lookup(path)
-					possible_actions = actions.select((path - uri_path).components)
+					relative_path = (path - uri_path).to_a
+					
+					possible_actions = actions.select(relative_path)
 				end
 			end
 			
 			# Given a path, look up all matched actions.
-			def lookup(path)
+			def actions_for_request(request, path)
 				self.class.lookup(path)
 			end
 			
 			# Given a request, call associated actions if at least one exists.
 			def passthrough(request, path)
-				actions = lookup(path)
+				actions = actions_for_request(request, path)
 				
-				if actions.size > 0
-					variables = request.controller
-					controller_clone = self.clone
-					
-					variables << controller_clone
-					
+				unless actions.empty?
 					response = catch(:response) do
 						# By default give nothing - i.e. keep on processing:
 						actions.each do |action|
-							action.invoke!(controller_clone, request, path)
+							action.invoke!(self, request, path)
 						end and nil
 					end
 					
 					if response
-						return controller_clone.respond_with(*response)
+						return self.respond_with(*response)
 					end
 				end
 				
@@ -111,11 +114,7 @@ module Utopia
 			end
 
 			def redirect! (target, status = 302)
-				respond! :redirect => target.to_str, :status => status
-			end
-
-			def rewrite! location
-				throw :rewrite, location.to_str
+				respond! :redirect => target, :status => status
 			end
 
 			def fail!(error = :bad_request)
@@ -140,25 +139,26 @@ module Utopia
 					status = options[:status] || status
 				end
 
-				status = Utopia::HTTP::STATUS_CODES[status] || status
+				status = HTTP::STATUS_CODES[status] || status
 				headers = options[:headers] || {}
 
-				if options[:type]
-					headers['Content-Type'] ||= options[:type]
+				if type = options[:type]
+					headers[HTTP::CONTENT_TYPE] ||= type
 				end
 
-				if options[:redirect]
-					headers["Location"] = options[:redirect]
+				if redirect = options[:redirect]
+					headers[HTTP::LOCATION] = redirect.to_s
 					status = 302 if status < 300 || status >= 400
 				end
 
-				body = []
 				if options[:body]
 					body = options[:body]
 				elsif options[:content]
 					body = [options[:content]]
 				elsif status >= 300
-					body = [Utopia::HTTP::STATUS_DESCRIPTIONS[status] || "Status #{status}"]
+					body = [HTTP::STATUS_DESCRIPTIONS[status] || "Status #{status}"]
+				else
+					body = EMPTY_BODY
 				end
 
 				return [status, headers, body]
@@ -166,7 +166,6 @@ module Utopia
 			
 			# 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)
-				# puts "process! #{request} #{path}"
 				passthrough(request, path)
 			end
 		end